ctop README

The project's README from github.com/bcicen/ctop. As one markdown file: README.md.

ctop

release homebrew macports scoop

Top-like interface for container metrics

ctop provides a concise and condensed overview of real-time metrics for multiple containers:

ctop

as well as a single container view for inspecting a specific container.

ctop comes with built-in support for Docker and runC; connectors for other container and cluster systems are planned for future releases.

Install

Fetch the latest release for your platform:

Debian/Ubuntu

Maintained by a third party

sudo apt-get install ca-certificates curl gnupg lsb-release
curl -fsSL https://azlux.fr/repo.gpg.key | sudo gpg --dearmor -o /usr/share/keyrings/azlux-archive-keyring.gpg
echo \
  "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/azlux-archive-keyring.gpg] http://packages.azlux.fr/debian \
  $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/azlux.list >/dev/null
sudo apt-get update
sudo apt-get install docker-ctop

Arch

sudo pacman -S ctop

ctop is also available for Arch in the AUR

Linux (Generic)

sudo wget https://github.com/bcicen/ctop/releases/download/v0.7.7/ctop-0.7.7-linux-amd64 -O /usr/local/bin/ctop
sudo chmod +x /usr/local/bin/ctop

OS X

brew install ctop

or

sudo port install ctop

or

sudo curl -Lo /usr/local/bin/ctop https://github.com/bcicen/ctop/releases/download/v0.7.7/ctop-0.7.7-darwin-amd64
sudo chmod +x /usr/local/bin/ctop

Windows

ctop is available in scoop:

scoop install ctop

Docker

docker run --rm -ti \
  --name=ctop \
  --volume /var/run/docker.sock:/var/run/docker.sock:ro \
  quay.io/vektorlab/ctop:latest

Building

Build steps can be found here.

Usage

ctop requires no arguments and uses Docker host variables by default. See connectors for further configuration options.

Config file

While running, use S to save the current filters, sort field, and other options to a default config path (~/.config/ctop/config on XDG systems, else ~/.ctop).

Config file values will be loaded and applied the next time ctop is started.

Options

Option Description
-a show active containers only
-f <string> set an initial filter string
-h display help dialog
-i invert default colors
-r reverse container sort order
-s select initial container sort field
-v output version information and exit

Keybindings

Key Action
<ENTER> Open container menu
a Toggle display of all (running and non-running) containers
f Filter displayed containers (esc to clear when open)
H Toggle ctop header
h Open help dialog
s Select container sort field
r Reverse container sort order
o Open single view
l View container logs (t to toggle timestamp when open)
e Exec Shell
c Configure columns
S Save current configuration to file
q Quit ctop

Alternatives

See Awesome Docker list for similar tools to work with Docker.

ctop (bcicen/ctop)

Searching Database…

17.8K ·GitHub
Ctop
What is this?ctop is a terminal tool that shows a top-like, real-time overview of metrics for all your running containers, plus a detailed single-container view.
Is this a GUI app or a terminal tool?It's a terminal UI (TUI) application you run from the command line, not a GUI program.
How do I install and run it?Fetch the prebuilt release binary for your platform (Debian/Ubuntu, Arch AUR, generic Linux, macOS via Homebrew/MacPorts, Windows via scoop, or Docker), then just run ctop with no arguments.
Do I need Docker installed for it to work?Yes, ctop connects to your Docker host by default and has built-in support for Docker and runC.
Does it support other container systems besides Docker and runC?Not yet — connectors for other container and cluster systems are only planned for future releases.
Which platforms are supported?Binaries and packages are provided for Linux (Debian/Ubuntu, Arch, generic), macOS (Homebrew/MacPorts), and Windows (scoop), plus a Docker image.
How do I configure ctop's view?Press 'S' while running to save the current filters, sort field, and other display options to a config file (~/.config/ctop/config on XDG systems, else ~/.ctop), which is reloaded on next start.
Can I filter or sort the container list?Yes, press 'f' to filter displayed containers and 's' to select the sort field, with 'r' to reverse the order; CLI flags -f and -s set these at startup too.
Can I interact with a container directly from ctop?Yes, pressing Enter opens a container menu, 'l' shows logs (with timestamp toggle), and 'e' lets you exec a shell inside the container.
Is there a single-container detail view?Yes, pressing 'o' opens a single container view for inspecting metrics of one specific container in detail.
What are similar projects?k9s, telegraf, sampler, witr, bottom, glances, lazydocker, nodelume
Which topics is it in?commandline, system-monitor, infrastructure, containers, tui, sysadmin, observability, golang, dashboard, monitoring, command-line, devops
Creator
bcicen
Size
3.5 MB
Stars
17.8K
Updated
CommitAug 01Releasev0.7.7Mar 22
Age
9y
Commits · 90 Days