Skip to content

akshaykhoje/procfetch

 
 

Repository files navigation

procfetch

codecov

procfetch is a command-line tool to fetch system information and display it on the screen.

It is written in C++.

Project inspiration : neofetch - a command line system information tool

Information displayed by procfetch

Static characteristics

  • Host (User)
  • CPU
  • Kernel
  • OS
  • Shell
  • Desktop Enviroment
  • Resolution
  • Theme
  • Icons
  • GPU (Integrated & Dedicated)
  • Package count

Dynamic characteristics

  • RAM
  • Uptime
  • Temperature

Prerequisites

The following versions or newer are required.

for building

  • GNU getopt - 2.37.2
  • GNU Make - 4.3
  • GCC - 13.2.0 or Clang - 15.0.0

for macOS, You can install gnu-getopt by runnning the following command.

$ brew install gnu-getopt

for generating API documents

  • Doxygen - 1.9.1
  • Graphviz -2.43.0

for contributing

  • ClangFormat - 14.0.0

for generating gif

  • vhs - 0.2.0

Documentation

See the documentation

Installation

For Debian, Ubuntu, Mint etc..

Download .deb packages from release page.

Brew

$ brew tap TanmayPatil105/tap
$ brew install procfetch

Manually

$ git clone https://github.com/TanmayPatil105/procfetch.git; cd procfetch
$ ./configure
$ sudo make install

Uninstallation

$ sudo make uninstall

Usage

  • -v to show version
$ procfetch -v
  • -a to change color of ascii_art
$ procfetch -a cyan
  • -d to change print ascii_art of different distros
$ procfetch -d Manjaro
  • -b to display battery percentage
$ procfetch -b

Customise

Add the following lines to your .bash_profile, .bashrc or .zshrc to customise procfetch

# print default ascii art of Manjaro
alias procfetch="procfetch -d Manjaro"
# print default ascii art of Kali with color cyan
alias procfetch="procfetch -d Kali -a cyan"
# print battery percentage
alias procfetch="procfetch -b"

Docker

Define environment variable PROCFETCH in the actual project home directory.

$ PROCFETCH=$HOME/procfetch

Build Docker image

$ docker build -t procfetch .

Build with Docker container

$ docker run --rm -v $PROCFETCH:/procfetch -w /procfetch procfetch make

Run with Docker container

$ docker run --rm -v $PROCFETCH:/procfetch -w /procfetch procfetch make run

Test with Docker container

$ docker run --rm -v $PROCFETCH:/procfetch -w /procfetch procfetch make check

Contributing

Make sure reading Contributing.md before Contributing

About

Linux command-line utility

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C++ 90.0%
  • Makefile 5.2%
  • Shell 2.1%
  • C 1.7%
  • Dockerfile 1.0%