Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/MintArchit/gh-contribs
GitHub Contribution Graph CLI
https://github.com/MintArchit/gh-contribs
cli command-line contribution-graph font gh-extension github terminal
Last synced: 3 months ago
JSON representation
GitHub Contribution Graph CLI
- Host: GitHub
- URL: https://github.com/MintArchit/gh-contribs
- Owner: MintArchit
- License: unlicense
- Created: 2023-01-24T15:49:34.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-18T05:33:07.000Z (over 1 year ago)
- Last Synced: 2024-08-03T21:02:51.799Z (3 months ago)
- Topics: cli, command-line, contribution-graph, font, gh-extension, github, terminal
- Language: Shell
- Homepage:
- Size: 8.02 MB
- Stars: 48
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# gh-contribs
Render your contribution graph to the terminal.
connects directly via github api / no third party service is used
## Contents
## ✨ Features
- [X] other user arg (NEW)
- [X] Color schemes (NEW)
- [X] Orientation Portrait/Landscape
- [X] Diffrent Character Glyphs
- [X] Day labels
- [X] Specify weeks
- [X] Automatic Resizing
- [X] Improved help
- [X] More control over ouput with gap arguments
- [X] Doubling █ -> ██
Todo
- [ ] Configuration file
- [ ] advanced animations
- [ ] User defined characters(styles)
- [ ] optimize performance
- [ ] include update notifier
- [ ] add version arg
- [ ] isolated per-repo graph
- [ ] Show legend, month, and contribution count—separate flags for each
## 📦 Installation
#### install
```
$ gh extension install mintarchit/gh-contribs
```
Manage Installation
#### list installed extensions
```
$ gh extension list
```
#### upgrade
```
$ gh extensions upgrade gh-contribs
```
#### uninstall
```
$ gh extension remove gh-contribs
```
## ⚡️ Usage
```
$ gh contribs
```
#### display help with a list of all possible arguments
```
gh contribs --help
```
```
Usage: gh contribs [-h] [-s ] [-g ] [-u ] [-w ] [-x] [-y] [-d] [-l] [-p] [-D] [-W]
Arguments:
-h | --help Displays this help.
-s | --scheme Color Scheme
-g | --glyph Change Character
-u | --user Show graph for other users
-w | --weeks Set range of weeks to be displayed
-x | --xgap Remove Gap between each Column
-y | --ygap Put a Gap between each Row
-d | --double Enable Doubling Glyph
-l | --labels Enable Labels
-p | --portrait Set Output Orientation
-D | --Debug Enable additional debug output
-W | --Warning Disable warning output
glyphs:
square dot fisheye diamond plus block
Schemes:
gh_contrast vibrant blackAwhite dracula north gold sunset mint
```
## Color Schemes [--scheme \]
```
Schemes:
gh_contrast vibrant blackAwhite dracula north gold sunset mint
```
## Character Glyphs [--glyph \]
```
Chars:
square dot fisheye diamond plus block
```
## Limitations
Resizing Terminal font-size can temporarily mess up the display of old graph outputs
## Contributing
All contributions are greatly appreciated!
If you have a suggestion that would make gh-contribs better,
please fork the repo and create a pull request or open an issue.
See file [CONTRIBUTION.md](https://github.com/MintArchit/gh-contribs/CONTRIBUTION.md)
## Credits
gh-contribs is currently maintained by [MintArchit](https://github.com/MintArchit)
Forked from [Mizlav](https://github.com/mislav)/[gh-contrib](https://github.com/mislav/gh-contrib)
See file [CONTRIBUTORS](https://github.com/MintArchit/gh-contribs/CONTRIBUTORS)