2017-03-08 23:40:35 +00:00
|
|
|
<p align="center"><img width="200px" src="/_docs/img/logo.png" alt="ctop"/></p>
|
2017-03-15 12:54:23 +00:00
|
|
|
|
2017-03-07 09:10:19 +00:00
|
|
|
#
|
2016-11-06 05:23:31 +00:00
|
|
|
|
2017-05-28 21:03:18 +00:00
|
|
|
![release][release] ![homebrew][homebrew]
|
|
|
|
|
|
2017-01-27 01:00:05 +00:00
|
|
|
Top-like interface for container metrics
|
|
|
|
|
|
2017-03-09 22:23:05 +00:00
|
|
|
`ctop` provides a concise and condensed overview of real-time metrics for multiple containers:
|
2017-03-08 23:40:35 +00:00
|
|
|
<p align="center"><img src="_docs/img/grid.gif" alt="ctop"/></p>
|
2017-03-07 03:48:44 +00:00
|
|
|
|
2017-03-08 23:36:37 +00:00
|
|
|
as well as an [expanded view][expanded_view] for inspecting a specific container.
|
|
|
|
|
|
2017-03-09 22:23:05 +00:00
|
|
|
`ctop` currently comes with built-in support for Docker; connectors for other container and cluster systems are planned for future releases.
|
2017-03-08 23:25:29 +00:00
|
|
|
|
2017-03-07 01:15:05 +00:00
|
|
|
## Install
|
|
|
|
|
|
|
|
|
|
Fetch the [latest release](https://github.com/bcicen/ctop/releases) for your platform:
|
|
|
|
|
|
|
|
|
|
#### Linux
|
|
|
|
|
|
|
|
|
|
```bash
|
2017-03-15 19:22:08 +00:00
|
|
|
sudo wget https://github.com/bcicen/ctop/releases/download/v0.5/ctop-0.5-linux-amd64 -O /usr/local/bin/ctop
|
2017-03-07 01:15:05 +00:00
|
|
|
sudo chmod +x /usr/local/bin/ctop
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
#### OS X
|
|
|
|
|
|
2017-03-15 09:45:41 +00:00
|
|
|
```bash
|
2017-03-15 10:14:00 +00:00
|
|
|
brew install ctop
|
2017-03-15 09:45:41 +00:00
|
|
|
```
|
|
|
|
|
or
|
2017-03-07 01:15:05 +00:00
|
|
|
```bash
|
2017-03-15 19:22:08 +00:00
|
|
|
sudo curl -Lo /usr/local/bin/ctop https://github.com/bcicen/ctop/releases/download/v0.5/ctop-0.5-darwin-amd64
|
2017-03-07 01:15:05 +00:00
|
|
|
sudo chmod +x /usr/local/bin/ctop
|
|
|
|
|
```
|
|
|
|
|
|
2017-03-10 09:00:00 +00:00
|
|
|
or run via Docker:
|
|
|
|
|
```bash
|
2017-03-13 08:31:15 +00:00
|
|
|
docker run -ti --name ctop --rm -v /var/run/docker.sock:/var/run/docker.sock quay.io/vektorlab/ctop:latest
|
2017-03-10 09:00:00 +00:00
|
|
|
```
|
|
|
|
|
|
2017-03-15 02:49:42 +00:00
|
|
|
`ctop` is also available for Arch in the [AUR](https://aur.archlinux.org/packages/ctop-bin/)
|
2017-03-09 22:23:05 +00:00
|
|
|
|
2017-03-12 03:15:21 +00:00
|
|
|
## Building
|
|
|
|
|
|
2017-03-19 22:39:57 +00:00
|
|
|
Build steps can be found [here][build].
|
2017-03-16 18:53:45 +00:00
|
|
|
|
2017-03-07 01:15:05 +00:00
|
|
|
## Usage
|
2017-01-27 01:00:05 +00:00
|
|
|
|
2017-03-09 22:23:05 +00:00
|
|
|
`ctop` requires no arguments and will configure itself using the `DOCKER_HOST` environment variable
|
2017-01-27 01:00:05 +00:00
|
|
|
```bash
|
2017-03-07 01:15:05 +00:00
|
|
|
export DOCKER_HOST=tcp://127.0.0.1:4243
|
|
|
|
|
ctop
|
2017-01-27 01:00:05 +00:00
|
|
|
```
|
2017-02-13 03:01:30 +00:00
|
|
|
|
2017-03-14 22:41:45 +00:00
|
|
|
### Options
|
|
|
|
|
|
|
|
|
|
Option | Description
|
|
|
|
|
--- | ---
|
|
|
|
|
-a | show active containers only
|
|
|
|
|
-f <string> | set an initial filter string
|
|
|
|
|
-h | display help dialog
|
2017-03-15 00:08:26 +00:00
|
|
|
-i | invert default colors
|
2017-03-14 22:41:45 +00:00
|
|
|
-r | reverse container sort order
|
|
|
|
|
-s | select initial container sort field
|
|
|
|
|
-v | output version information and exit
|
|
|
|
|
|
2017-03-07 01:15:05 +00:00
|
|
|
### Keybindings
|
2017-02-13 03:01:30 +00:00
|
|
|
|
|
|
|
|
Key | Action
|
|
|
|
|
--- | ---
|
2017-03-07 01:17:09 +00:00
|
|
|
a | Toggle display of all (running and non-running) containers
|
2017-03-15 02:00:40 +00:00
|
|
|
f | Filter displayed containers (`esc` to clear when open)
|
2017-03-08 23:40:35 +00:00
|
|
|
H | Toggle ctop header
|
2017-02-13 03:01:30 +00:00
|
|
|
h | Open help dialog
|
|
|
|
|
s | Select container sort field
|
|
|
|
|
r | Reverse container sort order
|
2017-03-08 23:40:35 +00:00
|
|
|
q | Quit ctop
|
2017-03-07 03:48:44 +00:00
|
|
|
|
2017-03-19 22:39:57 +00:00
|
|
|
[build]: _docs/build.md
|
2017-03-08 23:25:29 +00:00
|
|
|
[expanded_view]: _docs/expanded.md
|
2017-05-28 21:03:18 +00:00
|
|
|
[release]: https://img.shields.io/github/release/bcicen/ctop.svg "ctop"
|
|
|
|
|
[homebrew]: https://img.shields.io/homebrew/v/ctop.svg "ctop"
|
