Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Ryu0118/Kusa

Kusa is a CLI tool that works on any platform and displays GitHub contribution graphs.
https://github.com/Ryu0118/Kusa

Last synced: 5 days ago
JSON representation

Kusa is a CLI tool that works on any platform and displays GitHub contribution graphs.

Awesome Lists containing this project

README

        


image

#### Kusa is a simple CLI tool that works on any platform and displays GitHub contribution graphs.

![Language:Rust](https://img.shields.io/static/v1?label=Language&message=Rust&color=green&style=flat-square)
![License:MIT](https://img.shields.io/static/v1?label=License&message=MIT&color=blue&style=flat-square)
[![Latest Release](https://img.shields.io/github/v/release/Ryu0118/Kusa?style=flat-square)](https://github.com/Ryu0118/Kusa/releases/latest)
![Platform Compatibility](https://img.shields.io/badge/Platform%20Compatibility-macos%20%7C%20linux%20%7C%20windows-orange)
[![Twitter](https://img.shields.io/twitter/follow/ryu_hu03?style=social)](https://twitter.com/ryu_hu03)

## Installation
### Homebrew (only macOS)

```sh
$ brew tap Ryu0118/Kusa
$ brew install kusa
```
or download the appropriate file for your device from [releases](https://github.com/Ryu0118/Kusa/releases/tag/0.0.2)

### 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.

```sh
static GITHUB_ACCESS_TOKEN : &str = "GITHUB_ACCESS_TOKEN";
```
then run this

```sh
$ cargo run
```

## How To Generate A Github Access Token

Go to [github developer settings](https://github.com/settings/tokens).

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 [OPTIONS]

ARGS:

OPTIONS:
-h, --help Print help information
-s, --hide-streak
-V, --version Print version information
```

### `kusa Ryu0118`

image