2017-03-09 00:40:35 +01:00
< p align = "center" > < img width = "200px" src = "/_docs/img/logo.png" alt = "ctop" / > < / p >
2017-03-15 13:54:23 +01:00
2017-03-07 10:10:19 +01:00
#
2016-11-06 06:23:31 +01:00
2017-06-14 14:30:03 +02:00
![release][release] ![homebrew][homebrew]
2017-01-27 02:00:05 +01:00
Top-like interface for container metrics
2017-03-09 23:23:05 +01:00
`ctop` provides a concise and condensed overview of real-time metrics for multiple containers:
2017-03-09 00:40:35 +01:00
< p align = "center" > < img src = "_docs/img/grid.gif" alt = "ctop" / > < / p >
2017-03-07 04:48:44 +01:00
2020-07-30 16:11:33 +02:00
as well as a [single container view][single_view] for inspecting a specific container.
2017-03-09 00:36:37 +01:00
2017-06-14 14:17:44 +02:00
`ctop` comes with built-in support for Docker and runC; connectors for other container and cluster systems are planned for future releases.
2017-03-09 00:25:29 +01:00
2017-03-07 02:15:05 +01:00
## Install
Fetch the [latest release ](https://github.com/bcicen/ctop/releases ) for your platform:
#### Linux
```bash
2020-10-25 17:55:44 +01:00
sudo wget https://github.com/bcicen/ctop/releases/download/v0.7.4/ctop-0.7.4-linux-amd64 -O /usr/local/bin/ctop
2017-03-07 02:15:05 +01:00
sudo chmod +x /usr/local/bin/ctop
```
#### OS X
2017-03-15 10:45:41 +01:00
```bash
2017-03-15 11:14:00 +01:00
brew install ctop
2017-03-15 10:45:41 +01:00
```
or
2017-03-07 02:15:05 +01:00
```bash
2020-10-25 17:55:44 +01:00
sudo curl -Lo /usr/local/bin/ctop https://github.com/bcicen/ctop/releases/download/v0.7.4/ctop-0.7.4-darwin-amd64
2017-03-07 02:15:05 +01:00
sudo chmod +x /usr/local/bin/ctop
```
2017-06-14 14:17:44 +02:00
#### Docker
2017-03-10 10:00:00 +01:00
```bash
2017-06-14 14:17:44 +02:00
docker run --rm -ti \
--name=ctop \
2019-04-16 21:13:15 +02:00
--volume /var/run/docker.sock:/var/run/docker.sock:ro \
2017-06-14 14:17:44 +02:00
quay.io/vektorlab/ctop:latest
2017-03-10 10:00:00 +01:00
```
2017-03-15 03:49:42 +01:00
`ctop` is also available for Arch in the [AUR ](https://aur.archlinux.org/packages/ctop-bin/ )
2017-03-09 23:23:05 +01:00
2017-03-12 04:15:21 +01:00
## Building
2017-03-19 23:39:57 +01:00
Build steps can be found [here][build].
2017-03-16 19:53:45 +01:00
2017-03-07 02:15:05 +01:00
## Usage
2017-01-27 02:00:05 +01:00
2017-06-14 14:17:44 +02:00
`ctop` requires no arguments and uses Docker host variables by default. See [connectors][connectors] for further configuration options.
2017-02-13 04:01:30 +01:00
2018-01-11 19:32:34 +01:00
### Config file
2020-10-25 17:55:44 +01:00
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.
2018-01-11 19:32:34 +01:00
2017-03-14 23:41:45 +01:00
### Options
Option | Description
--- | ---
2019-11-21 17:34:53 +01:00
`-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
2020-10-26 12:38:17 +01:00
`-shell` | exec shell to use (default: sh)
2017-03-14 23:41:45 +01:00
2017-03-07 02:15:05 +01:00
### Keybindings
2017-02-13 04:01:30 +01:00
2020-07-30 16:11:33 +02:00
| Key | Action |
| :----------------------: | ---------------------------------------------------------- |
| < kbd > < ENTER> < / kbd > | Open container menu |
| < kbd > a< / kbd > | Toggle display of all (running and non-running) containers |
| < kbd > f< / kbd > | Filter displayed containers (`esc` to clear when open) |
| < kbd > H< / kbd > | Toggle ctop header |
| < kbd > h< / kbd > | Open help dialog |
| < kbd > s< / kbd > | Select container sort field |
| < kbd > r< / kbd > | Reverse container sort order |
| < kbd > o< / kbd > | Open single view |
| < kbd > l< / kbd > | View container logs (`t` to toggle timestamp when open) |
| < kbd > e< / kbd > | Exec Shell |
2020-10-25 17:55:44 +01:00
| < kbd > c< / kbd > | Configure columns |
2020-07-30 16:11:33 +02:00
| < kbd > S< / kbd > | Save current configuration to file |
| < kbd > q< / kbd > | Quit ctop |
2017-03-07 04:48:44 +01:00
2017-03-19 23:39:57 +01:00
[build]: _docs/build.md
2017-06-14 14:17:44 +02:00
[connectors]: _docs/connectors.md
2017-08-05 13:28:20 +02:00
[single_view]: _docs/single.md
2017-06-14 14:30:03 +02:00
[release]: https://img.shields.io/github/release/bcicen/ctop.svg "ctop"
[homebrew]: https://img.shields.io/homebrew/v/ctop.svg "ctop"