Top-like interface for container metrics
Go to file
Bradley Cicenas e1a52a314d
v0.7.4, update docs
2020-10-25 16:55:44 +00:00
.circleci v0.7.4, update docs 2020-10-25 16:55:44 +00:00
_docs v0.7.4, update docs 2020-10-25 16:55:44 +00:00
config init column config menu 2020-01-02 23:02:53 +00:00
connector update go version, deps for runc v1.0.0-rc92 2020-10-25 14:22:47 +00:00
container init column config menu 2020-01-02 23:02:53 +00:00
cwidgets fix byte format for compact view (short) 2020-10-25 16:02:31 +00:00
logging depend on io.WriteCloser instead of net.Conn 2018-10-25 22:22:04 +02:00
models handle single kv pair given to NewMeta 2020-01-03 12:07:21 +00:00
widgets add optional tooltip to menu widget 2020-01-03 12:53:25 +00:00
.gitignore add vendor directory to gitignore 2018-10-25 22:04:40 +02:00
Dockerfile update to go 1.13 2020-01-03 13:18:01 +00:00
LICENSE add LICENSE 2017-03-09 10:41:32 +11:00
Makefile update go version, deps for runc v1.0.0-rc92 2020-10-25 14:22:47 +00:00
README.md v0.7.4, update docs 2020-10-25 16:55:44 +00:00
VERSION v0.7.4, update docs 2020-10-25 16:55:44 +00:00
colors.go remove ignore of variable (unneeded when only index is needed) 2018-10-25 22:25:36 +02:00
cursor.go refactor connectors for retry logic, add error view 2019-05-22 16:58:55 +00:00
debug.go add runtimestats, stack logging to debug 2017-06-28 09:12:24 -03:00
go.mod update go version, deps for runc v1.0.0-rc92 2020-10-25 14:22:47 +00:00
go.sum update go version, deps for runc v1.0.0-rc92 2020-10-25 14:22:47 +00:00
grid.go init column config menu 2020-01-02 23:02:53 +00: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 refactor connectors for retry logic, add error view 2019-05-22 16:58:55 +00:00
menus.go add column config key to help menu 2020-10-25 10:31:51 -04:00

README.md

ctop

release homebrew

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:

Linux

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

OS X

brew install ctop

or

sudo curl -Lo /usr/local/bin/ctop https://github.com/bcicen/ctop/releases/download/v0.7.4/ctop-0.7.4-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

ctop is also available for Arch in the AUR

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
-scale-cpu show cpu as % of system total
-v output version information and exit
-shell specify shell (default: sh)

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