Categorygithub.com/psyb0t/ctop
modulepackage
0.7.1
Repository: https://github.com/psyb0t/ctop.git
Documentation: pkg.go.dev

# README

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/ctop-0.7-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/ctop-0.7-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

OptionDescription
-ashow active containers only
-f <string>set an initial filter string
-hdisplay help dialog
-iinvert default colors
-rreverse container sort order
-sselect initial container sort field
-scale-cpushow cpu as % of system total
-voutput version information and exit

Keybindings

KeyAction
<enter>Open container menu
aToggle display of all (running and non-running) containers
fFilter displayed containers (esc to clear when open)
HToggle ctop header
hOpen help dialog
sSelect container sort field
rReverse container sort order
oOpen single view
lView container logs (t to toggle timestamp when open)
SSave current configuration to file
qQuit ctop

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

Create a confirmation dialog with a given description string and func to perform if confirmed.
No description provided by the author
No description provided by the author
No description provided by the author
Apply a common handler function to all given keys.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

No description provided by the author

# Structs

No description provided by the author

# Type aliases

MenuFn executes a menu window, returning the next menu or nil.