https://github.com/sheepla/gh-graph
🟩 a wrapper command for https://github.com/kawarimidoll/deno-github-contributions-api that can also be used as an extension of GitHub CLI
https://github.com/sheepla/gh-graph
api-client cli github
Last synced: 3 months ago
JSON representation
🟩 a wrapper command for https://github.com/kawarimidoll/deno-github-contributions-api that can also be used as an extension of GitHub CLI
- Host: GitHub
- URL: https://github.com/sheepla/gh-graph
- Owner: sheepla
- License: mit
- Created: 2021-08-28T12:09:54.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-09-07T10:58:29.000Z (over 4 years ago)
- Last Synced: 2024-05-17T00:27:47.680Z (over 1 year ago)
- Topics: api-client, cli, github
- Language: Shell
- Homepage:
- Size: 242 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🟩 gh-graph
**gh-graph** is a wrapper command for [kawarimidoll/deno-github-contributions-api](https://github.com/kawarimidoll/deno-github-contributions-api).
Let's draw contribution graph on your terminal! 🌳
## Screenshot
## Demo on asciinema.org
> [gh-graph-cli - asciinema.org](https://asciinema.org/a/432861)
## Usage
```
gh-graph -- a github-contribution-api wrapper command
USAGE
gh-graph MODE USERNAME [PARAMS...]
gh-graph --help|--version
* MODE: output mode
t, term print data as a colored pixels graph
j, json print data as a JSON
x, text print data as a table-styled text
s, svg print data as a SVG image
* USERNAME: username on GitHub
* PARAMS:
parameters for the API
syntax is
name1=value1 name2=value2 ...
to know parameters, run
curl https://github-contributions-api.deno.dev/{{USERNAME}}
EXAMPLES
gh-graph term sheepla scheme=pink
gh-graph json sheepla flat=true
THANKS
This tool utilises this API. Thanks!
https://github.com/kawarimidoll/deno-github-contributions-api
```
## Install as an Command
Requires `curl`
Just download and add executable permission
```bash
curl -O https://raw.githubusercontent.com/sheepla/gh-graph/master/gh-graph && chmod +x gh-graph
```
## Install as an Extension for GitHub CLI
Requires `curl` and GitHub CLI v2.0.0+
> [cli/cli - GitHub](https://github.com/cli/cli)
```bash
gh extension install sheepla/gh-graph
```
## Thanks
This command utilises this API. Thanks!✨
> [kawarimidoll/deno-github-contributions-api](https://github.com/kawarimidoll/deno-github-contributions-api)
## Development
Issue and PR is welcome!