https://github.com/TanmayPatil105/procfetch
🎨 Yet another command-line system information utility written in C++
https://github.com/TanmayPatil105/procfetch
cli command-line distro fetch hacktoberfest linux open-source
Last synced: 11 months ago
JSON representation
🎨 Yet another command-line system information utility written in C++
- Host: GitHub
- URL: https://github.com/TanmayPatil105/procfetch
- Owner: TanmayPatil105
- License: gpl-3.0
- Archived: true
- Created: 2022-07-19T11:49:30.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-02T16:08:10.000Z (over 1 year ago)
- Last Synced: 2025-05-02T23:35:57.041Z (12 months ago)
- Topics: cli, command-line, distro, fetch, hacktoberfest, linux, open-source
- Language: C++
- Homepage: https://tanmaypatil105.github.io/procfetch/
- Size: 3.74 MB
- Stars: 23
- Watchers: 1
- Forks: 11
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-fetch - procfetch - A command-line system information utility. `C++` (Operation System / GNU/Linux Only)
README
# procfetch
[](https://codecov.io/gh/TanmayPatil105/procfetch)
#### 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.
```bash
$ 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](https://tanmaypatil105.github.io/procfetch/)
## Installation
### For Debian, Ubuntu, Mint etc..
Download .deb packages from [release](https://github.com/TanmayPatil105/procfetch/releases/latest) page.
### Brew
```
$ brew tap TanmayPatil105/tap
```
```
$ brew install procfetch
```
### Manually
```bash
$ git clone https://github.com/TanmayPatil105/procfetch.git; cd procfetch
```
```bash
$ ./configure
```
```bash
$ sudo make install
```
## Uninstallation
```bash
$ sudo make uninstall
```
## Usage
- `-v` to show version
```bash
$ procfetch -v
```
- `-a` to change color of ascii_art
```bash
$ procfetch -a cyan
```
- `-d` to change print ascii_art of different distros
```bash
$ procfetch -d Manjaro
```
- `-b` to display battery percentage
```bash
$ procfetch -b
```
## Customise
Add the following lines to your `.bash_profile`, `.bashrc` or `.zshrc` to customise `procfetch`
```bash
# print default ascii art of Manjaro
alias procfetch="procfetch -d Manjaro"
```
```bash
# print default ascii art of Kali with color cyan
alias procfetch="procfetch -d Kali -a cyan"
```
```bash
# print battery percentage
alias procfetch="procfetch -b"
```
## Docker
Define environment variable `PROCFETCH` in the actual project home directory.
```sh
$ PROCFETCH=$HOME/procfetch
```
Build Docker image
```sh
$ docker build -t procfetch .
```
Build with Docker container
```sh
$ docker run --rm -v $PROCFETCH:/procfetch -w /procfetch procfetch make
```
Run with Docker container
```sh
$ docker run --rm -v $PROCFETCH:/procfetch -w /procfetch procfetch make run
```
Test with Docker container
```sh
$ docker run --rm -v $PROCFETCH:/procfetch -w /procfetch procfetch make check
```
### Contributing
Make sure reading [Contributing.md](https://github.com/TanmayPatil105/procfetch/blob/main/CONTRIBUTING.md) before Contributing