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: 2 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 (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-25T20:55:51.000Z (7 months ago)
- Last Synced: 2024-12-25T21:23:57.951Z (7 months ago)
- Topics: cli, command-line, contribution-graph, font, gh-extension, github, terminal
- Language: Shell
- Homepage:
- Size: 8.02 MB
- Stars: 51
- Watchers: 1
- Forks: 2
- 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
- awesome-gh-cli-extensions - **contribs** - Show Github contribution graph via cli (Fun)
README
# gh-contribs
Render your contribution graph to the terminal.
connects directly via github api / no third party service is used
[![Stargazers][shield_stars]][url_git-remote-stars]
[![Contributors][shield_contributors]][url_git-remote-contributors]
[![Forks][shield_forks]][url_git-remote-forks]
[![Issues][shield_issues]][url_git-remote-issues]
[![License][shield_license]][url_git-remote-license]
## Contents
## ✨ Features
- [X] contribution count (NEW)
- [X] other user arg
- [X] Color schemes
- [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
- [ ] months legend
- [ ] Configuration file
- [ ] optimize performance
- [ ] advanced animations
- [ ] User defined characters(styles)
- [ ] include update notifier
- [ ] add version arg
- [ ] isolated per-repo graph
## 📦 Installation
### install
``` bash
gh extension install mintarchit/gh-contribs
```
Manage Installation
#### list installed extensions
``` bash
gh extension list
```
#### upgrade
``` bash
gh extensions upgrade gh-contribs
```
#### uninstall
``` bash
gh extension remove gh-contribs
```
## ⚡️ Usage
``` bash
gh contribs
```
### display help with a list of all possible arguments
``` bash
gh contribs --help
```
``` text
Usage: gh contribs [-h] [-s ] [-g ] [-u ] [-w ] [-x] [-y] [-d] [-l] [-t] [-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 Print labels
-t | --total Print total contributions
-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_original gh_contrast vibrant blackAwhite dracula north gold sunset mint
```
## Color Schemes [--scheme \]
``` text
Schemes:
gh_contrast vibrant blackAwhite dracula north gold sunset mint
```
## Character Glyphs [--glyph \]
``` text
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][url_git-remote-contributing]
## 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)
[url_git-remote-issues]: https://github.com/MintArchit/gh-contribs/issues
[url_git-remote-contributors]: https://github.com/MintArchit/gh-contribs/graphs/contributors
[url_git-remote-forks]: https://github.com/MintArchit/gh-contribs/network/members
[url_git-remote-stars]: https://github.com/MintArchit/gh-contribs/stargazers
[url_git-remote-contributing]: docs/CONTRIBUTING.md
[url_git-remote-license]: https://github.com/MintArchit/gh-contribs/LICENSE.txt
[shield_contributors]: https://img.shields.io/github/contributors/MintArchit/gh-contribs.svg?style=for-the-badge
[shield_forks]: https://img.shields.io/github/forks/MintArchit/gh-contribs.svg?style=for-the-badge&color=purple
[shield_issues]: https://img.shields.io/github/issues/MintArchit/gh-contribs.svg?style=for-the-badge
[shield_stars]: https://img.shields.io/github/stars/MintArchit/gh-contribs.svg?style=for-the-badge
[shield_license]: https://img.shields.io/github/license/MintArchit/gh-contribs.svg?style=for-the-badge&color=black