ctop/README.md

54 lines
1.2 KiB
Markdown
Raw Normal View History

2016-11-06 06:23:31 +01:00
# ctop
2017-01-27 02:00:05 +01:00
Top-like interface for container metrics
2017-03-07 04:48:44 +01:00
ctop provides a concise and condensed overview of real-time metrics for multiple containers:
![compact][compact]
as well as an expanded view for examining a specific container:
2017-03-07 04:52:28 +01:00
<p align="center">
<img src="http://i.imgur.com/nYjQMhd.gif" alt="cTop"/>
</p>
2017-03-07 04:48:44 +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
wget https://github.com/bcicen/ctop/releases/download/v0.1/ctop-0.1-linux-amd64 -O ctop
sudo mv ctop /usr/local/bin/
sudo chmod +x /usr/local/bin/ctop
```
#### OS X
```bash
curl -Lo ctop https://github.com/bcicen/ctop/releases/download/v0.1/ctop-0.1-darwin-amd64
sudo mv ctop /usr/local/bin/
sudo chmod +x /usr/local/bin/ctop
```
## Usage
2017-01-27 02:00:05 +01:00
2017-03-07 02:15:05 +01:00
cTop requires no arguments and will configure itself using the `DOCKER_HOST` environment variable
2017-01-27 02:00:05 +01:00
```bash
2017-03-07 02:15:05 +01:00
export DOCKER_HOST=tcp://127.0.0.1:4243
ctop
2017-01-27 02:00:05 +01:00
```
2017-02-13 04:01:30 +01:00
2017-03-07 02:15:05 +01:00
### Keybindings
2017-02-13 04:01:30 +01:00
Key | Action
--- | ---
2017-03-07 02:17:09 +01:00
a | Toggle display of all (running and non-running) containers
f | Filter displayed containers
H | Toggle cTop header
2017-02-13 04:01:30 +01:00
h | Open help dialog
s | Select container sort field
r | Reverse container sort order
2017-03-07 02:17:09 +01:00
q | Quit cTop
2017-03-07 04:48:44 +01:00
[compact]: http://i.imgur.com/uDUq33N.gif "cTop"