Quick Start

This guide provides the fastest way to get nvtop running on your system.

Method 1: Using a Package Manager (Recommended)

The easiest way to get started is by installing nvtop from your distribution's official package repository.

1. Install nvtop:

   Open a terminal and run the command for your distribution.

   For Debian/Ubuntu:

   sudo apt update && sudo apt install nvtop

   For Fedora/RHEL/CentOS:

   # First, ensure the EPEL repository is enabled on RHEL/CentOS
   # sudo dnf install epel-release
   
   sudo dnf install nvtop

   For Arch Linux:

   sudo pacman -S nvtop

2. Run nvtop:

   Simply type the command in your terminal:

   nvtop

That's it! You should now see the nvtop interface monitoring your GPU(s).

Method 2: Using Docker

If you prefer a containerized environment or if nvtop is not available in your package manager, Docker is an excellent alternative. This requires Docker and the NVIDIA Container Toolkit to be installed.

1. Clone the Repository:

   git clone https://github.com/Syllo/nvtop.git
   cd nvtop

2. Build the Docker Image:

   sudo docker build --tag nvtop .

3. Run the nvtop Container:

   sudo docker run -it --rm --gpus=all --pid=host nvtop

   • The --gpus=all flag exposes your GPUs to the container.
   • The --pid=host flag is crucial as it allows nvtop inside the container to see and monitor processes running on your host machine.

For more detailed installation options, please see the Installation Guide.