gh-skyline
Visualize your GitHub profile's contribution graph
TLDR
Generate a skyline STL file for the current year and authenticated user
Generate a skyline for a specific user and year
Generate a skyline for a range of years
Generate a full skyline (from the user's join year to the current year)
Enable debug logging
Generate a skyline and specify the output file path
Open the GitHub profile for a specific user
Display help
SYNOPSIS
gh skyline [username] [flags]
PARAMETERS
username
The GitHub username to visualize. If omitted, it defaults to the currently authenticated user.
--year year
The year to visualize.
--height height
The max height of the skyline.
--width width
The width of the skyline.
--show-weekdays
Show week days in the skyline.
--show-quarters
Show quarters in the skyline.
DESCRIPTION
gh-skyline
is a command-line tool that visualizes your GitHub contribution activity as an ASCII art skyline directly in your terminal. It fetches your contribution data from GitHub using the GitHub CLI (gh
) and presents it as a histogram, where the height of each bar represents the number of contributions made on a particular day. This allows you to quickly identify periods of high or low activity.
The tool provides a visually appealing and informative representation of your coding habits and project involvement on GitHub. While it provides insights into your activity, it's important to note that it relies on the GitHub API and is therefore subject to rate limits and API changes. Properly configuring gh
with authentication is essential for the command to function correctly.
CAVEATS
Requires the GitHub CLI (gh
) to be installed and configured with authentication. GitHub API rate limits may apply. Incorrect usernames will result in errors.
DEPENDENCIES
This command requires the gh
cli to be installed and correctly setup to access github resources.
ERROR HANDLING
The command handles common errors, such as invalid usernames or GitHub API issues, but it's always a good idea to check the output and error messages to understand any problems that may occur.