Mirrored_Repos/ctop
1
0
Fork 0
mirror of https://github.com/bcicen/ctop.git synced 2024-08-30 18:23:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

add install, usage to readme

Browse Source
This commit is contained in:
Bradley Cicenas 2017-03-07 01:15:05 +00:00
parent aaf98a77dc
commit b9f5bcea92
1 changed files with 25 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -1,19 +1,36 @@
# ctop
**NOTE** *This project, while largely usable, is a work in progress! This message will be removed upon initial stable release*
Top-like interface for container metrics
## Quickstart
## Install
Fetch the [latest release](https://github.com/bcicen/ctop/releases) for your platform:
#### Linux
To build and run ctop:
```bash
git clone https://github.com/bcicen/ctop.git
cd ctop
go build && ./ctop
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
```
## Keybindings
#### 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
cTop requires no arguments and will configure itself using the `DOCKER_HOST` environment variable
```bash
export DOCKER_HOST=tcp://127.0.0.1:4243
ctop
```
### Keybindings
Key | Action
--- | ---