Top-like interface for container metrics
Go to file
Bradley Cicenas da09b95d29
prevent panic on container IDs < 12 chars
2022-01-06 22:12:35 +00:00
.circleci v0.7.4, update docs 2020-10-25 16:55:44 +00:00
_docs logging: log to file 2020-11-19 20:11:46 +02:00
config Merge remote-tracking branch 'remotes/stokito/uptime' 2021-06-10 22:01:45 -04:00
connector Fix cpu count estimation (#281) 2021-12-29 11:56:22 -05:00
container prevent panic on container IDs < 12 chars 2022-01-06 22:12:35 +00:00
cwidgets Merge pull request #236 from stokito/status_unicode 2021-06-10 22:06:40 -04:00
logging logging: log to file 2020-11-19 20:11:46 +02:00
models #207 Replace scaleCpu option with dedicated column CPU Scaled 2020-11-20 23:08:19 +02:00
widgets Use runewidth to increment x in TextView 2021-05-29 19:48:02 +09:00
.gitignore logging: log to file 2020-11-19 20:11:46 +02:00
Dockerfile update dockerfile to go 1.15 2020-11-28 20:30:02 +00:00
LICENSE add LICENSE 2017-03-09 10:41:32 +11:00
Makefile match release tag to title 2021-07-01 19:32:32 +00:00
README.md Update README.md 2021-06-13 16:07:58 +02:00
VERSION v0.7.6 2021-06-11 01:23:43 +00:00
colors.go remove ignore of variable (unneeded when only index is needed) 2018-10-25 22:25:36 +02:00
cursor.go Revert "shows total memory usage" 2020-10-25 10:31:51 -04:00
debug.go logging: skip timer events e.g. /timer/1s 2020-11-18 11:25:20 +02:00
go.mod Merge remote-tracking branch 'stokito/browser' 2021-10-24 10:40:43 -04:00
go.sum Merge remote-tracking branch 'stokito/browser' 2021-10-24 10:40:43 -04:00
grid.go Open in browser 2020-12-12 21:21:53 +02:00
install.sh add requirement check to install script 2018-06-13 09:20:05 +00:00
keys.go include <escape> in exit keygroup 2017-06-08 09:47:30 -03:00
main.go #207 Replace scaleCpu option with dedicated column CPU Scaled 2020-11-20 23:08:19 +02:00
menus.go Open in browser: show menu item only if web port is published 2020-12-12 21:50:08 +02:00

README.md

ctop

release homebrew macports

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

echo "deb http://packages.azlux.fr/debian/ buster main" | sudo tee /etc/apt/sources.list.d/azlux.list
wget -qO - https://azlux.fr/repo.gpg.key | sudo apt-key add -
sudo apt update
sudo apt install docker-ctop

Arch

ctop is available for Arch in the AUR

Linux (Generic)

sudo wget https://github.com/bcicen/ctop/releases/download/0.7.6/ctop-0.7.6-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/0.7.6/ctop-0.7.6-darwin-amd64
sudo chmod +x /usr/local/bin/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.