The Wayback Machine - https://web.archive.org/web/20190605133953/https://github.com/bcicen/ctop
Skip to content
Top-like interface for container metrics
Branch: master
Clone or download
Latest commit c8ac331 May 22, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci remove deprecated -e option Aug 19, 2017
_docs Update status.md Jan 24, 2019
config Merge branch 'fr05t1k-exec' May 12, 2019
connector add multi-line scrolling support, timestamps to error view May 22, 2019
container Merge branch 'fr05t1k-exec' May 12, 2019
cwidgets Fix function comments based on best practices from Effective Go Mar 7, 2019
logging depend on io.WriteCloser instead of net.Conn Oct 25, 2018
models add container log struct to models, collectors Jul 4, 2017
widgets add multi-line scrolling support, timestamps to error view May 22, 2019
.gitignore add vendor directory to gitignore Oct 25, 2018
Dockerfile move to go module Dec 1, 2018
LICENSE add LICENSE Mar 8, 2017
Makefile move to go module Dec 1, 2018
README.md Merge branch 'exec' of https://github.com/fr05t1k/ctop into fr05t1k-exec May 12, 2019
VERSION v0.7.2 Jan 24, 2019
colors.go remove ignore of variable (unneeded when only index is needed) Oct 25, 2018
cursor.go refactor connectors for retry logic, add error view May 22, 2019
debug.go add runtimestats, stack logging to debug Jun 28, 2017
go.mod refactor connectors for retry logic, add error view May 22, 2019
grid.go fix timer May 22, 2019
install.sh add requirement check to install script Jun 13, 2018
keys.go include <escape> in exit keygroup Jun 8, 2017
main.go refactor connectors for retry logic, add error view May 22, 2019
menus.go Enable cursor May 13, 2019

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 an 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.2/ctop-0.7.2-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.2/ctop-0.7.2-darwin-amd64
sudo chmod +x /usr/local/bin/ctop

Docker

docker run --rm -ti \
  --name=ctop \
  -v /var/run/docker.sock:/var/run/docker.sock \
  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. These settings 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
S Save current configuration to file
q Quit ctop
You can’t perform that action at this time.