README.md

Linux	FreeBSD	AppImage

CPU-X is a Free software that gathers information on CPU, motherboard and more.
CPU-X is a system profiling and monitoring application (similar to CPU-Z for Windows), but CPU-X is a Free and Open Source software designed for GNU/Linux and FreeBSD.
This software is written in C++ and built with CMake tool.
It can be used in graphical mode by using GTK or in text-based mode by using NCurses. A dump mode is present from command line.

⚠️ There are no milestones for this project, read this announcement for more details.

---

Table of contents

• Table of contents
  • Dependencies
    • Build-only dependencies
    • Test dependencies
    • Build and run dependencies
  • Download and install
    • From repositories
    • From GitHub releases
    • From Flathub
    • Manual build
  • Usage
  • Wiki
  • Bugs/Improvements/Request features
  • Translate CPU-X

---

Dependencies

Build-only dependencies

These dependencies are needed to build CPU-X:

• A C++ compiler (GCC or Clang)
• CMake
• Pkg-Config / Pkgconf
• NASM (for x86 CPUs only)

Test dependencies

These dependencies are optional to test CPU-X:

• Grep
• GNU Awk¹
• Mawk¹
• One true awk¹

¹At least on Awk is required, e.g. the default Awk on the system.

Build and run dependencies

These dependencies are needed to build² and run CPU-X:

• Gtkmm3 (versions 3.12 to 3.24 are supported)
• NCurses
• Libcpuid (version 0.7.0 or newer is needed)
• Pciutils
• GLFW (version 3.3 or newer is needed), with OpenGL
• Vulkan
• OpenCL (version 1.2 or newer is needed), disabled by default (enable with -DWITH_OPENCL=1 during CMake invocation)
• Procps-ng (Linux) / Libstatgrab (*BSD)

²On some GNU/Linux distributions, the appropriate -dev or -devel package is needed.

Download and install

From repositories

In alphabetical order:

• Debian (since version 11 "Bullseye"): apt install cpu-x
• Fedora (since version 30): dnf install cpu-x
• FreeBSD (since version 11): pkg install cpu-x
• OpenMandriva Lx (since version 4.0 "Nitrogen"): dnf install cpu-x
• openSUSE Leap (since version 15.2 from utilities project): zypper install cpu-x
• Solus: eopkg install cpu-x
• Ubuntu (since version 20.04 "Focal Fossa") : apt install cpu-x

All packages:

From GitHub releases

Look for Assets here for portable binary (AppImage).

From Flathub

CPU-X is available as Flatpak on Flathub since v5.0.2.

Manual build

For step-by-step guide, please read this page on the Wiki.

Usage

Application is available in menu (System Tools category). If you start the daemon, it will allow CPU-X to access some special devices, which provides more information and avoid empty labels.
The CPU-X daemon requires root privileges, and uses Polkit for privileges escalation.

You can use cpu-x from command line, some options are available, like:

• --gtk: to start the graphical user interface (default)
• --ncurses: to start the text-based user interface
• --dump: to get a summary of data

Use --help to see all arguments.

Wiki

More informations are available on Wiki, like screenshots, troubleshooting and tips. You can access the Wiki by using this link.

Bugs/Improvements/Request features

Please open a new issue and fill the appropriate template. Note that text between <!-- ... --> is not displayed.
⚠️ Incomplete reports may be closed without justification.

Translate CPU-X

If you want to translate CPU-X in your native tongue, please visit the Weblate page.
POT file is updated on each changes thanks to Update POT file workflow.