A terminal-based GitHub profile dashboard.
GitFetch is a lightweight terminal application that displays GitHub user profiles and their top repositories in a clean, configurable Textual UI.
- π€ Display GitHub user information
- β Show top repositories sorted by stars
- π Automatically refresh profile data
- π¨ Customize label and value colors
- π₯οΈ Optional ASCII greyscale mode
- π Optional GitHub Personal Access Token (PAT)
- βοΈ Interactive configuration UI
- πͺ Windows installer
- π Run globally from any directory
Download the latest GitFetch-Setup.exe from the Releases page.
Run the installer, then open a new terminal.
GitFetch will be available globally:
gitfetch <username>
For example:
gitfetch octocat
gitfetch <username>
Example:
gitfetch torvalds
gitfetch --config
The configuration interface lets you customize:
- ASCII greyscale mode
- Label color
- Value color
- GitHub Personal Access Token
- Display refresh rate
A GitHub Personal Access Token is optional.
Without a PAT, GitFetch uses GitHub's unauthenticated API, which has a more limited rate limit.
You can add a PAT through:
gitfetch --config
If no token is configured, GitFetch displays:
None (limited)
A PAT is not required to display public GitHub profiles.
GitFetch stores its configuration locally at:
~/.gitfetch/config.json
Example configuration:
{
"ascii-greyscale": false,
"label-color": "cyan",
"value-color": "white",
"pat-key": null,
"refresh-rate": 60
}You can modify these settings interactively with:
gitfetch --config
- Python 3.11+
- Git
- PyInstaller
git clone https://github.com/arrntwzz/gitfetch.git
cd gitfetchpy -m pip install -r requirements.txt
py -m PyInstaller --onefile --name gitfetch build_launcher.py
The executable will be created at:
dist/gitfetch.exe
First, build gitfetch.exe, then run:
py -m PyInstaller --onefile --name GitFetch-1.0.0-Setup --add-binary "dist\gitfetch.exe;." installer\installer.pyThe installer will be created at:
dist/GitFetch-1.0.0-Setup.exe
gitfetch/
βββ src/
β βββ gitfetch/
β βββ __init__.py
β βββ __main__.py
β βββ main.py
β βββ config.py
β βββ config_ui.py
β βββ display.py
β βββ github_api.py
β
βββ installer/
β βββ installer.py
β
βββ scripts/
β βββ build_launcher .py
βββ pyproject.toml
βββ README.md
βββ LICENSE
βββ .gitignore
GitFetch is licensed under the MIT License.
See LICENSE for details.