README
¶
Top-like interface for container metrics
ctop provides a concise and condensed overview of real-time metrics for multiple containers:
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 (Generic)
sudo wget https://github.com/lordoverlord/ctop/releases/download/v0.1.9/ctop-linux-amd64 -O /usr/local/bin/ctop
sudo chmod +x /usr/local/bin/ctop
OS X
sudo curl -Lo /usr/local/bin/ctop https://github.com/lordoverlord/ctop/releases/download/v0.1.9/ctop-darwin-amd64
sudo chmod +x /usr/local/bin/ctop
Windows
Work in progress to provide a distribution via Scoop. or winget.
'```powershell ctop-windows-amd64.exe
#### Docker
```bash
docker run --rm -ti --name=ctop --volume /var/run/docker.sock:/var/run/docker.sock:ro ghcr.io/lordoverlord/ctop:latest
You can also use the tag dev, if youre interested in the latest development version.
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.
Documentation
¶
There is no documentation for this package.
Source Files
Directories