MintArchit / gh-contribs

GitHub Contribution Graph CLI

gh-contribs

Render your contribution graph to the terminal.

connects directly via github api / no third party service is used

Contents

✨ Features

• other user arg (NEW)
• Color schemes (NEW)
• Orientation Portrait/Landscape
• Diffrent Character Glyphs
• Day labels
• Specify weeks
• Automatic Resizing
• Improved help
• More control over ouput with gap arguments
• 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 <scheme>] [-g <glyph>] [-u <user>] [-w <weeks>] [-x] [-y] [-d] [-l] [-p] [-D] [-W]

Arguments:

  -h | --help                 Displays this help.
  -s | --scheme <name>        Color Scheme
  -g | --glyph <char>         Change Character
  -u | --user <user>          Show graph for other users
  -w | --weeks <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 <name>]

Schemes:
gh_contrast vibrant blackAwhite dracula north gold sunset mint

Character Glyphs [--glyph <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

Credits

gh-contribs is currently maintained by MintArchit

Forked from Mizlav/gh-contrib

See file CONTRIBUTORS