Skip to content

Latest commit

 

History

History
160 lines (123 loc) · 5.92 KB

README.md

File metadata and controls

160 lines (123 loc) · 5.92 KB

Simple yet fancy CPU architecture fetching tool

cpufetch is a command-line tool written in C that displays the CPU information in a clean and beautiful way

Table of contents

1. Support

OS x86_64 / x86 ARM PowerPC
GNU / Linux ✔️ ✔️ ✔️
Windows ✔️
Android ✔️ ✔️
macOS ✔️ ✔️
FreeBSD ✔️

NOTES:

  • Colors will be used in Windows only if the terminal supports it.
  • Support in macOS ARM is limited to Apple M1 only

2. Installation

2.1 Installing from a package

Choose the right package for your operating system:

Packaging status

If there is no available package for your OS, you can download the cpufetch binary from the releases page, or build cpufetch from source (see below).

2.2 Building from source

You will need a C compiler (e.g, gcc) and make to compile cpufetch. Just clone the repo and run make:

git clone https://github.com/Dr-Noob/cpufetch
cd cpufetch
make
./cpufetch

2.3 Android

  1. Install termux app (terminal emulator)
  2. Run pkg install -y git make clang inside termux.
  3. Build from source normally:

3. Examples

3.1 x86_64

AMD EPYC HPC server

Intel Xeon HPC server

3.2 ARM

 

Samsung Galaxy S8 (left) Xiaomi Redmi Note 7 (right)

3.3 PowerPC

Talos II

4. Colors

By default, cpufetch will print the CPU logo with the system colorscheme. However, you can set a custom color scheme in two different ways:

4.1 Specifying a name

By specifying a name, cpufetch will use the specific colors of each manufacture. Valid values are:

  • intel
  • intel-new
  • amd
  • ibm
  • arm
./cpufetch --color intel (default color for Intel)

4.2 Specifying the colors in RGB format

5 colors must be given in RGB with the format: [R,G,B:R,G,B:R,G,B:R,G,B:R,G,B]. These colors correspond to the CPU logo color (first 3 colors) and for the text colors (following 2).

./cpufetch --color 239,90,45:210,200,200:0,0,0:100,200,45:0,200,200

5. Implementation

See cpufetch programming documentation.

6. Bugs or improvements

See cpufetch contributing guidelines.

7. Acknowledgements

Thanks to the fellow contributors and interested people in the project. Special thanks to:

  • Gonzalocl, OdnetninI: Tested cpufetch in the earlier versions of the project in many different CPUs.
  • Kyngo: Tested cpufetch in the Apple M1 CPU.
  • avollmerhaus: Gave me ssh acess to a PowerPC machine, allowing me to develop the PowerPC port.
  • bbonev, stephan-cr: Reviewed the source code.

8. cpufetch for GPUs (gpufetch)

See gpufetch project!