https://github.com/tueduong05/trexanh
GitHub Contribution Graph TUI
https://github.com/tueduong05/trexanh
contribution-graph github ratatui rust
Last synced: about 2 months ago
JSON representation
GitHub Contribution Graph TUI
- Host: GitHub
- URL: https://github.com/tueduong05/trexanh
- Owner: tueduong05
- License: mit
- Created: 2025-10-26T09:57:25.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-10-28T01:07:27.000Z (8 months ago)
- Last Synced: 2025-10-28T03:09:40.691Z (8 months ago)
- Topics: contribution-graph, github, ratatui, rust
- Language: Rust
- Homepage:
- Size: 66.4 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# trexanh
> trexanh is a GitHub contribution graph TUI, written in 🦀 Rust :))
## Installation & Usage
### 1. Download the binary
Download the latest release of `trexanh` for your platform
### 2. Make it executable
```bash
chmod +x trexanh
```
### 3. Get a GitHub fine-grained personal access token
1. Go to [GitHub Settings > Developer settings > Personal access tokens > Fine-grained tokens]
2. Click "Generate new token"
3. Give your token a name and set an expiration date
4. Under "Repository access", select **Public repositories**
5. Click "Generate token" and copy it
### 4. Run
#### Basic usage
```bash
./trexanh
```
and input your GitHub username and token
#### With flags
```bash
./trexanh --cached
```
this flag will instantly display the cached contributions while fetching new data for the next run in the background
```bash
./trexanh --width
```
this flag will let you set custom width for single mode (Minimum: 30)
```bash
./trexanh --watch
```
this flag will continuously fetch and update contributions (**DO NOT** use very short intervals to avoid hammering the GitHub API)
```bash
./trexanh --reset
```
this flag will prompt you to update your stored username and token
> You can optionally input a different username to see their contributions
## Roadmap
- [x] Add argument to get other username's contribution graph
- [x] Add async cache with background fetch (fork) to display cached data instantly and refresh in the background (cached mode)
- [x] Add watch mode to refresh graph at intervals
- [x] Add TUI for username and token input