2024-12-11 17:33:13 +01:00
|
|
|
# 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`
|
|
|
|
|
2025-03-28 05:26:23 +02:00
|
|
|
- Generate a skyline for a specific user and year:
|
2024-12-11 17:33:13 +01:00
|
|
|
|
2025-03-28 05:26:23 +02:00
|
|
|
`gh skyline {{[-u|--user]}} {{username}} {{[-y|--year]}} {{year}}`
|
2024-12-11 17:33:13 +01:00
|
|
|
|
2025-03-28 05:26:23 +02:00
|
|
|
- Generate a skyline for a range of years:
|
2024-12-11 17:33:13 +01:00
|
|
|
|
2025-03-28 05:26:23 +02:00
|
|
|
`gh skyline {{[-u|--user]}} {{username}} {{[-y|--year]}} {{first_year}}-{{last_year}}`
|
2024-12-11 17:33:13 +01:00
|
|
|
|
2025-03-28 05:26:23 +02:00
|
|
|
- Generate a full skyline (from the user's join year to the current year):
|
2024-12-11 17:33:13 +01:00
|
|
|
|
2025-03-28 05:26:23 +02:00
|
|
|
`gh skyline {{[-u|--user]}} {{username}} {{[-f|--full]}}`
|
2024-12-11 17:33:13 +01:00
|
|
|
|
2025-03-28 05:26:23 +02:00
|
|
|
- Enable debug logging:
|
2024-12-11 17:33:13 +01:00
|
|
|
|
2025-03-28 05:26:23 +02:00
|
|
|
`gh skyline {{[-d|--debug]}}`
|
2024-12-11 17:33:13 +01:00
|
|
|
|
2025-03-28 05:26:23 +02:00
|
|
|
- Generate a skyline and specify the output file path:
|
2024-12-11 17:33:13 +01:00
|
|
|
|
2025-03-28 05:26:23 +02:00
|
|
|
`gh skyline {{[-o|--output]}} {{path/to/output_file.stl}}`
|
2024-12-11 17:33:13 +01:00
|
|
|
|
2025-03-28 05:26:23 +02:00
|
|
|
- Open the GitHub profile for a specific user:
|
2024-12-11 17:33:13 +01:00
|
|
|
|
2025-03-28 05:26:23 +02:00
|
|
|
`gh skyline {{[-u|--user]}} {{username}} {{[-w|--web]}}`
|
2024-12-11 17:33:13 +01:00
|
|
|
|
2025-03-28 05:26:23 +02:00
|
|
|
- Display help:
|
2024-12-11 17:33:13 +01:00
|
|
|
|
2025-03-28 05:26:23 +02:00
|
|
|
`gh skyline {{[-h|--help]}}`
|