gh-skyline

Generate a skyline STL file for the current year and authenticated user

$ gh skyline

$ gh skyline [[-u|--user]] [username] [[-y|--year]] [year]

$ gh skyline [[-u|--user]] [username] [[-y|--year]] [first_year]-[last_year]

$ gh skyline [[-u|--user]] [username] [[-f|--full]]

$ gh skyline [[-d|--debug]]

$ gh skyline [[-o|--output]] [path/to/output_file.stl]

$ gh skyline [[-u|--user]] [username] [[-w|--web]]

$ gh skyline [[-h|--help]]

gh skyline [
--user <username>
] [
--year <year>
] [
--theme <theme>
] [
--output <file.gif>
] [
--verbose
] [
--version
] [
--help
]

--user
    Specify the GitHub username whose contributions will be visualized. Defaults to the authenticated user.

--year
    Define the calendar year for which contributions should be displayed. Defaults to the current year.

--theme
    Set the color scheme for the 3D graph. Examples include light, dark, halloween, desert, ocean, arctic, and dracula.

--output
    Export the generated 3D animation as an animated GIF file. Requires ffmpeg to be installed.

--verbose
    Enable verbose output, showing more detailed information during execution.

--version
    Display the version information for the gh-skyline extension.

--help
    Show the help message and available options for the command.

The gh-skyline command is a
GitHub CLI extension designed to transform a user's GitHub contribution history into an interactive 3D "skyline" visualization.
It fetches contribution data for a specified user and year, then renders it directly in your terminal as a dynamic 3D graph.
This visualization mimics the aesthetic of GitHub's own contribution skyline feature, offering a unique perspective on activity levels.
Users can specify a target username, a particular year, and choose from various color themes to customize the appearance of the graph.
Additionally, it supports exporting the animated 3D view into a GIF file, making it easy to share your contribution insights.

gh-skyline is a GitHub CLI extension and requires the
GitHub CLI (gh)
to be installed and authenticated on your system.
Exporting the visualization to a GIF file using the
--output
option depends on the
ffmpeg
utility being installed and accessible via your system's PATH.
The quality and appearance of the 3D graph rendered directly in the terminal can vary based on your terminal emulator's capabilities and font support.

To install the gh-skyline extension, use the following command:
gh extension install mskian/gh-skyline
Ensure you have
GitHub CLI
installed and configured before attempting installation.

When run without the
--output
option,
gh-skyline
renders an interactive 3D visualization directly in your terminal.
You can typically rotate and zoom the view using keyboard controls (e.g., arrow keys, 'w'/'s' for zoom), providing a dynamic exploration of your contribution history.

The
gh-skyline
command emerged as part of the growing ecosystem of
GitHub CLI extensions
.
GitHub CLI
was introduced to bring GitHub functionality directly to the terminal, and its extension framework allows the community to build and share custom commands.
gh-skyline
leverages this framework to provide a novel and engaging way to visualize contribution data, a feature inspired by the 3D skyline graphs sometimes shown on GitHub's own website during special events or user achievements.
Its development reflects a desire to make personal contribution tracking more interactive and visually appealing within the command-line environment.

gh(1), git-log(1), curl(1)