peterzam / Kusa

Kusa is a cli tool that displays the Github Contributions Graph.

Kusa is a cli tool that displays the Github Contributions Graph.

Installation

Homebrew (only macOS)

$ brew tap Ryu0118/Kusa
$ brew install kusa

or download the appropriate file for your device from releases

Building From Source

To build and run Kusa in your own environment, Assign your Github Personal Access Token with "read:user" in environment variable as

GITHUB_TOKEN="<your_github_token>"

then run this

$ cargo run <github_user_name>

or run directly with

$ GITHUB_TOKEN=<your_github_token> cargo run <github_user_name>

How To Generate A Github Access Token

Go to github developer settings.

Set the expiration date to "No Expiration".

No scopes are required for this application.

Click "Generate Token" and then copy the token it generates.

Known Issue

Terminal.app on macOS does not support 24-bit color, so colors are not displayed. Therefore, use iTerm2, Hyper, Warp or other terminals to display colors correctly.

Usage

kusa --help

USAGE:
    kusa <github_user_name>

ARGS:
    <github_user_name>

OPTIONS:
    -h, --help       Print help information
    -V, --version    Print version information

kusa Ryu0118