ctop/README.md

95 lines
2.6 KiB
Markdown
Raw Normal View History

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-06-14 12:30:03 +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-08-05 11:28:20 +00:00
as well as an [single container view][single_view] for inspecting a specific container.
2017-03-08 23:36:37 +00:00
2017-06-14 12:17:44 +00: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-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
2018-01-11 18:32:34 +00:00
sudo wget https://github.com/bcicen/ctop/releases/download/v0.7/ctop-0.7-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
2018-01-11 18:32:34 +00:00
sudo curl -Lo /usr/local/bin/ctop https://github.com/bcicen/ctop/releases/download/v0.7/ctop-0.7-darwin-amd64
2017-03-07 01:15:05 +00:00
sudo chmod +x /usr/local/bin/ctop
```
2017-06-14 12:17:44 +00:00
#### Docker
2017-03-10 09:00:00 +00:00
```bash
2017-06-14 12:17:44 +00:00
docker run --rm -ti \
--name=ctop \
-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-07 01:15:05 +00:00
## Usage
2017-01-27 01:00:05 +00:00
2017-06-14 12:17:44 +00:00
`ctop` requires no arguments and uses Docker host variables by default. See [connectors][connectors] for further configuration options.
2017-02-13 03:01:30 +00:00
2018-01-11 18:32:34 +00:00
### 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.
2017-03-14 22:41:45 +00:00
### Options
Option | Description
--- | ---
-a | show active containers only
2018-01-11 18:58:37 +00:00
-f \<string\> | set an initial filter string
2017-03-14 22:41:45 +00:00
-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
2018-01-11 18:32:34 +00:00
-scale-cpu | show cpu as % of system total
2017-03-14 22:41:45 +00:00
-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
--- | ---
2018-01-11 18:58:37 +00:00
\<enter\> | Open container menu
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
o | Open single view
l | View container logs (`t` to toggle timestamp when open)
S | Save current configuration to file
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-06-14 12:17:44 +00:00
[connectors]: _docs/connectors.md
2017-08-05 11:28:20 +00:00
[single_view]: _docs/single.md
2017-06-14 12:30:03 +00:00
[release]: https://img.shields.io/github/release/bcicen/ctop.svg "ctop"
[homebrew]: https://img.shields.io/homebrew/v/ctop.svg "ctop"