1 unstable release
0.1.1 |
|
---|---|
0.1.0 | Jul 30, 2024 |
#549 in Development tools
24 downloads per month
32KB
621 lines
Gitfetch
Gitfetch is a command-line information tool written in Rust, inspired by Neofetch. It provides a visually appealing way to display Git contribution information.
Table of Contents
Features
- Prints out contribution information similar to how Neofetch displays system information
- Automatically detects the global Git user
- Allows specifying any user and year for contribution data
- Customizable contribution graph and output color
Installation
Prerequisites
- Git (optional, for global user detection)
Arch Linux
sudo pacman -S gitfetch
Homebrew
brew install gitfetch
Installing from crates.io
Install Gitfetch directly from crates.io using Cargo:
cargo install --locked gitfetch
Usage
-
Generate a new GitHub Token with the
read:user
scope to fetch data from GitHub. -
Add your token to Gitfetch:
gitfetch add-token <your-token-here>
-
Run Gitfetch:
gitfetch
Optional Arguments
-u
or--user
: Specify a GitHub username-y
or--year
: Specify a year for contribution data
Example:
gitfetch -u FabricSoul -y 2023
Configuration
Configuration path is ~/.config/gitfetch/config.toml
[graph_colors]
level1
: "r,g,b"
level2
: "r,g,b"
level3
: "r,g,b"
level4
: "r,g,b"
[text_colors]
info_color
: "r,g,b"
[graph_data]
percentiles
: [usize,uszie,uszie,uszie]
Roadmap
- Customize the graph color
- Customize output text color
- Customize graph display
- Use
git
to get username - Specify a user
- Specify a year
- Display highest contribution
- Display longest streak
- Display current streak
- Add support for other Git hosting platforms
Contributing
We welcome contributions to Gitfetch! Here's how you can help:
- Fork the project
- Create your feature branch (
git checkout -b feature/AmazingFeature
) - Commit your changes (
git commit -m 'Add some AmazingFeature'
) - Push to the branch (
git push origin feature/AmazingFeature
) - Open a pull request
License
This project is licensed under the GPL-3.0 License - see the LICENSE file for details.
Note: Gitfetch is under active development. Features and documentation may be incomplete or subject to change. We appreciate your feedback and contributions!
Dependencies
~13–24MB
~360K SLoC