Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

gh-skyline: add page #15110

Merged
merged 2 commits into from
Dec 11, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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:

Check failure on line 11 in pages/common/gh-skyline.md

View workflow job for this annotation

GitHub Actions / build

ser ==> set

`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:

Check failure on line 27 in pages/common/gh-skyline.md

View workflow job for this annotation

GitHub Actions / build

utput ==> output

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

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

Check failure on line 31 in pages/common/gh-skyline.md

View workflow job for this annotation

GitHub Actions / build

ser ==> set

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

- Display [h]elp:

`gh skyline --help`
Loading