dono-cli

Crates.iodono-cli
lib.rsdono-cli
version0.1.0
sourcesrc
created_at2023-01-13 17:48:05.586337
updated_at2023-01-13 17:48:05.586337
descriptionA CLI tool to show your GitHub contributions
homepage
repositoryhttps://github.com/jervw/dono
max_upload_size
id758083
size910,611
Jere Vuola (jervw)

documentation

README

Dono

GitHub Workflow Status GitHub Crates.io

A customizable CLI tool to show your GitHub contributions graph in your terminal

Installation

Cargo package

cargo install dono-cli

Build from source

git clone https://github.com/jervw/dono
cd dono
cargo build --release
cargo run

Generating a personal access token

Navigate to your GitHub developer settings. Click the Personal access tokens menu, then click Generate new token (classic).

Scopes are not required.

GitHub will display the personal access token once. Copy the token into dono.toml configuration file.

Configuration

After installing dono, edit the example configuration to your liking. The location is $XDG_CONFIG_HOME/dono/dono.toml.

Usage

dono --help

A CLI tool to show your GitHub contributions

Usage: dono <user_name>

Arguments:
  <user_name>  GitHub user name

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

Features/Bugs

Please create an issue :)

TODOs

  • Week starts on monday setting

  • Display stats (e.g. streaks, highest contributions)

  • Custom queries

License

This project is licensed under the MIT. See the LICENSE file for details.

Commit count: 37

cargo fmt