https://github.com/jervw/dono
A CLI tool to show your GitHub contributions
https://github.com/jervw/dono
contribution-graph github rust
Last synced: 6 months ago
JSON representation
A CLI tool to show your GitHub contributions
- Host: GitHub
- URL: https://github.com/jervw/dono
- Owner: jervw
- License: mit
- Created: 2022-09-14T20:36:53.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-13T11:13:28.000Z (about 1 year ago)
- Last Synced: 2025-07-06T08:17:37.565Z (7 months ago)
- Topics: contribution-graph, github, rust
- Language: Rust
- Homepage:
- Size: 282 KB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: .github/README.md
- License: LICENSE
Awesome Lists containing this project
README
Dono
A customizable CLI tool to show your GitHub contributions graph in your terminal
## Installation
### Cargo package
```
cargo install dono-cli
```
### Build from source
```sh
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](https://github.com/settings/tokens). 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](https://raw.githubusercontent.com/jervw/dono/main/dono.toml) 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
Arguments:
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](LICENSE) file for details.