{"id":15116851,"url":"https://github.com/FabricSoul/gitfetch","last_synced_at":"2025-09-27T22:31:24.482Z","repository":{"id":250555578,"uuid":"834653915","full_name":"FabricSoul/gitfetch","owner":"FabricSoul","description":"A command-line GitHub contribution visualization tool written in Rust inspired by Neofetch","archived":false,"fork":false,"pushed_at":"2024-08-26T23:23:51.000Z","size":123,"stargazers_count":28,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-17T12:32:42.752Z","etag":null,"topics":["cargo","cli","command-line","command-line-tool","rust","rust-lang","screenshot"],"latest_commit_sha":null,"homepage":"https://crates.io/crates/gitfetch","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FabricSoul.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-28T00:03:34.000Z","updated_at":"2025-06-27T17:33:30.000Z","dependencies_parsed_at":"2024-07-31T01:29:40.834Z","dependency_job_id":"b3f3bea9-11db-4d09-a236-55e2fe24b9cd","html_url":"https://github.com/FabricSoul/gitfetch","commit_stats":null,"previous_names":["fabricsoul/gitfetch"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/FabricSoul/gitfetch","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FabricSoul%2Fgitfetch","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FabricSoul%2Fgitfetch/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FabricSoul%2Fgitfetch/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FabricSoul%2Fgitfetch/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FabricSoul","download_url":"https://codeload.github.com/FabricSoul/gitfetch/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FabricSoul%2Fgitfetch/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":276634000,"owners_count":25677206,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-23T02:00:09.130Z","response_time":73,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cargo","cli","command-line","command-line-tool","rust","rust-lang","screenshot"],"created_at":"2024-09-26T01:45:21.342Z","updated_at":"2025-09-27T22:31:24.198Z","avatar_url":"https://github.com/FabricSoul.png","language":"Rust","readme":"# Gitfetch\n\nGitfetch is a command-line information tool written in Rust, inspired by [Neofetch](https://github.com/dylanaraps/neofetch). It provides a visually appealing way to display Git contribution information.\n![Image](image.png)\n\n## Table of Contents\n\n- [Features](#features)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Configuration](#configuration)\n- [Troubleshooting](#troubleshooting)\n- [Roadmap](#roadmap)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Features\n\n- Prints out contribution information similar to how Neofetch displays system information\n- Automatically detects the global Git user\n- Allows specifying any user and year for contribution data\n- Customizable contribution graph and output color\n\n## Installation\n\n### Prerequisites\n\n- Git (optional, for global user detection)\n\n### Arch Linux\n\n```bash\nyay -S gitfetch\n```\n\nor\n\n```bash\nparu -S gitfetch\n```\n\n### MacOS\n\n```bash\nbrew tap fabricsoul/gitfetch https://github.com/FabricSoul/gitfetch\nbrew install gitfetch\n```\n\n### Installing from crates.io\n\nInstall Gitfetch directly from crates.io using Cargo:\n\n```bash\ncargo install --locked gitfetch\n```\n\n## Usage\n\n1. Generate a new [GitHub Token](https://github.com/settings/tokens) with the `read:user` scope to fetch data from GitHub.\n\n2. Add your token to Gitfetch:\n\n   ```bash\n   gitfetch add-token \u003cyour-token-here\u003e\n   ```\n\n3. Run Gitfetch:\n\n   ```bash\n   gitfetch\n   ```\n\n### Optional Arguments\n\n- `-u` or `--user`: Specify a GitHub username\n- `-y` or `--year`: Specify a year for contribution data\n\nExample:\n\n```bash\ngitfetch -u FabricSoul -y 2023\n```\n\n## Configuration\n\nGitfetch can be customized using a configuration file located at `~/.config/gitfetch/config.toml`. This file allows you to personalize the appearance and behavior of Gitfetch.\n\n### Configuration File Structure\n\nThe `config.toml` file is divided into three main sections:\n\n1. `[graph_colors]`: Defines the colors for different contribution levels in the graph.\n2. `[text_colors]`: Sets the color for informational text.\n3. `[graph_data]`: Configures the thresholds for contribution levels.\n\n### Detailed Configuration Options\n\n#### [graph_colors]\n\nThis section defines the colors for the contribution graph. Colors are specified in RGB format.\n\n```toml\n[graph_colors]\nlevel1 = \"39,168,68\"   # Light green for low contributions\nlevel2 = \"45,135,67\"   # Medium green\nlevel3 = \"31,97,51\"    # Dark green\nlevel4 = \"23,70,38\"    # Very dark green for high contributions\n```\n\n- Each level represents a different intensity of contributions.\n- Values should be comma-separated RGB values (0-255 for each component).\n\n#### [text_colors]\n\nThis section sets the color for the informational text displayed alongside the graph.\n\n```toml\n[text_colors]\ninfo_color = \"86,182,194\"  # Light blue for info text\n```\n\n- Specified as comma-separated RGB values.\n\n#### [graph_data]\n\nThis section defines the thresholds for each contribution level in the graph.\n\n```toml\n[graph_data]\npercentiles = [30, 60, 80, 100]\n```\n\n- The `percentiles` array contains four values representing the breakpoints for each contribution level.\n- Values are percentiles of the user's contribution range.\n- In this example:\n  - 0-30th percentile: level1 color\n  - 31-60th percentile: level2 color\n  - 61-80th percentile: level3 color\n  - 81-100th percentile: level4 color\n\n### Example Configuration\n\nHere's a complete example of a `config.toml` file:\n\n```toml\n[graph_colors]\nlevel1 = \"39,168,68\"\nlevel2 = \"45,135,67\"\nlevel3 = \"31,97,51\"\nlevel4 = \"23,70,38\"\n\n[text_colors]\ninfo_color = \"86,182,194\"\n\n[graph_data]\npercentiles = [30, 60, 80, 100]\n```\n\n### Applying Configuration Changes\n\nAfter modifying the `config.toml` file:\n\n1. Save the changes.\n2. Run Gitfetch again. The new configuration will be automatically applied.\n\n### Resetting to Default Configuration\n\nTo reset to the default configuration:\n\n1. Delete the `config.toml` file.\n2. Run Gitfetch. A new `config.toml` file with default values will be created.\n\n## Troubleshooting\n\nIf you encounter issues with your configuration:\n\n- Ensure all RGB values are within the 0-255 range.\n- Check that the `percentiles` array has exactly four values.\n- Verify that the `config.toml` file is properly formatted TOML.\n\nIf problems persist, you can temporarily rename or remove the `config.toml` file to use the default configuration while troubleshooting.\n\n[... rest of the README unchanged ...]\n\n## Roadmap\n\n- [x] Customize the graph color\n- [x] Customize output text color\n- [x] Customize graph display\n- [x] Use `git` to get username\n- [x] Specify a user\n- [x] Specify a year\n- [x] Display highest contribution\n- [x] Display longest streak\n- [x] Display current streak\n- [ ] Add support for other Git hosting platforms\n\n## Contributing\n\nWe welcome contributions to Gitfetch! Here's how you can help:\n\n1. Fork the project\n2. Create your feature branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the branch (`git push origin feature/AmazingFeature`)\n5. Open a pull request\n\n## License\n\nThis project is licensed under the GPL-3.0 License - see the [LICENSE](LICENSE) file for details.\n\n---\n\n**Note:** Gitfetch is under active development. Features and documentation may be incomplete or subject to change. We appreciate your feedback and contributions!\n","funding_links":[],"categories":["Repository","Command Line Tools"],"sub_categories":["Other"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFabricSoul%2Fgitfetch","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FFabricSoul%2Fgitfetch","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFabricSoul%2Fgitfetch/lists"}