ghfetch

The previous video has as examples the commands:

• ghfetch ghfetch - (An organization)
• ghfetch icutum - (A user)
• ghfetch nullgaro - (A user)
• ghfetch torvalds/linux - (A repo)

Description

A nice way to display CLI user / organization / repo info inspired in Neofetch

ghfetch is a CLI information tool written in Python >= 3.5 that displays info about any user/org/repo you pass as argument.

Upon execution, the script displays on the terminal relevant information, like the profile picture, public repos, stars, followers, etc.

Additionally, in this project, we've used Github Actions to be able to create a new release each time we merge to main, thanks to this, the build for AUR is easier.

Installation

Package manager

apt:
Firstly you have to add the repository with "add-apt-repository":

add-apt-repository "deb https://ppa.launchpadcontent.net/ghfetch/ghfetch/ubuntu/ mantic main"
apt-get update

If you don't have "add-apt-repository", you can install it with:

apt-get install software-properties-common python3-launchpadlib

For troubleshooting see here.

And then you can install ghfetch

apt-get install ghfetch

Arch Linux:
Use your favorite AUR helper, i.e:

yay -Syu ghfetch

Snap:

snap install ghfetch

PIP:

pip install --upgrade pip
pip install ghfetch-pip

For troubleshooting see here.

Manual installation

git clone https://github.com/ghfetch/ghfetch.git
cd ghfetch
pip install .

Usage

ghfetch <user or organization>

ghfetch <user>/<repo>

Example usage

User:

ghfetch nullgaro
ghfetch icutum

Organization:

ghfetch ghfetch
ghfetch confugiradores

Repo:

ghfetch torvalds/linux
ghfetch ghfetch/ghfetch

To-do's 📋

Code 💻

• Private API key for access to private repositories

Package upload 📦

• AUR
• Apt
• Pip
• Snap
• DNF/Yum
• Brew
• Windows
• Zypper
• DPKG

Wishlist 🥺

• Pacman

Troubleshooting 🛠️

Warn: WARNING: The scripts ghfetch-pip is installed in '/home/USERNAME/.local/bin' which is not on PATH.

If you are installing ghfetch using PIP, and you get a similar warning to this:

The solution is to add export PATH=/home/user/.local/bin:$PATH to your .bashrc, where /home/user/.local/bin would be the path that the warning is telling you, and reboot.

Updating ghfetch using yay doesn't update it

This issue happens because the yay's cache is interfering with the update. The solution is to clear the cache of yay with yay -Sc --aur.

When adding the repository to apt gets some pythonic error

This issue happens because apt-add-repository is missing python3-launchpadlib. The solution is to install it with apt-get install python3-launchpadlib.

People 👨‍💻

This project was developed with ❤️ by Nullgaro and Icutum.

Support ❤️

If you find our ghfetch script helpful and want to contribute to its development and maintenance, consider buying us a coffee! ☕
Your support means a lot!