EnokiUN / Kusa

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

Kusa is a simple CLI which displays GitHub contribution graphs right from the comfort of your shell

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 on your machine put your GitHub Personal Access Token as the "GITHUB_ACCESS_TOKEN" variable (src/main.rs, line 9), your token does not need any scopes.

static GITHUB_ACCESS_TOKEN : &str = "GITHUB_ACCESS_TOKEN";

then run this

$ cargo run <github user name>

How To Generate A Github Access Token

Go to github developer settings.

Set the expiration date to "No Expiration".

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

Known Issues

• 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