Skip to content

Commit

Permalink
gh-skyline: add page (#15110)
Browse files Browse the repository at this point in the history
  • Loading branch information
spageektti authored Dec 11, 2024
1 parent c6c1f86 commit 9a51987
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions pages/common/gh-skyline.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# gh skyline

> Generate a 3D model of your GitHub contribution history.
> By default, it will create a `{username}-{year}-github-skyline.stl` file in the current directory.
> More information: <https://github.com/github/gh-skyline>.
- Generate a skyline STL file for the current year and authenticated user:

`gh skyline`

- Generate a skyline for a specific [u]ser and [y]ear:

`gh skyline --user {{username}} --year {{year}}`

- Generate a skyline for a range of [y]ears:

`gh skyline --user {{username}} --year {{first_year}}-{{last_year}}`

- Generate a [f]ull skyline (from the user's join year to the current year):

`gh skyline --user {{username}} --full`

- Enable [d]ebug logging:

`gh skyline --debug`

- Generate a skyline and specify the [o]utput file path:

`gh skyline --output {{path/to/output_file.stl}}`

- Open the GitHub profile for a specific [u]ser:

`gh skyline --user {{username}} --web`

- Display [h]elp:

`gh skyline --help`

0 comments on commit 9a51987

Please sign in to comment.