https://github.com/SafarSoFar/ghfetch
A neofetch-like utility to fetch GitHub info right in terminals.
https://github.com/SafarSoFar/ghfetch
Last synced: about 1 month ago
JSON representation
A neofetch-like utility to fetch GitHub info right in terminals.
- Host: GitHub
- URL: https://github.com/SafarSoFar/ghfetch
- Owner: SafarSoFar
- License: mit
- Created: 2024-11-12T10:07:58.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-01-03T14:56:42.000Z (6 months ago)
- Last Synced: 2025-01-03T15:40:51.745Z (6 months ago)
- Language: Rust
- Homepage:
- Size: 577 KB
- Stars: 14
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-fetch - ghfetch - A neofetch-like utility to fetch GitHub info right in terminals. `Rust` (Repository / Other)
README
# ghfetch
ghfetch - is an utility to fetch information from GitHub profiles right in terminals.
# Example
# Build
Build with cargo
```
cargo build
```
The executable will be stored in target/debug
# Usage
```
./ghfetch [GITHUB_LOGIN] [GITHUB_TOKEN]
```
1. Provide GitHub login as a first argument for user info.
2. Provide GitHub token as a second argument for repo, activity info.
Using GitHub token with only 'read:user, user:follow' is strongly adviced.
3. You can save login and token in the config file when using the utility.
You will be asked 'Save arguments to the config file?'. Type 'y' to confirm or any other
key to deny.
# Notes
The config file is stored in the utility directory. And I do not collect
any data from it.
# Requirements
For full information fetch you need to provide GitHub token, that is how GitHub API works.
# Known issues
Rust's 'Termion' crate gives 'Terminal Cursor Time Out' exception when using squeezed Kitty terminal emulator window.