LK/xmtop
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Update README

Browse Source
This commit is contained in:
Caleb Bassi 2018-08-16 16:29:31 -07:00
parent 8de8367084
commit 9f7e5cef4f
1 changed files with 32 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

73
README.md
View File

@ -10,11 +10,9 @@ Another terminal based graphical activity monitor, inspired by [gtop](https://gi
</div> </div>
## Installation ## Installation
Working and tested on Linux and OSX, with Windows support being worked on. Working and tested on Linux and OSX. Windows support is planned.
### Using Git ### Using Git
@ -27,12 +25,10 @@ git clone --depth 1 https://github.com/cjbassi/gotop /tmp/gotop
Then move `gotop` into your $PATH somewhere. Then move `gotop` into your $PATH somewhere.
### Arch Linux ### Arch Linux
Install the `gotop-bin` package from the AUR. Install the `gotop-bin` package from the AUR.
### Homebrew ### Homebrew
``` ```
@ -40,71 +36,62 @@ brew tap cjbassi/gotop
brew install gotop brew install gotop
``` ```
### Source ### Source
```sh ```sh
go get github.com/cjbassi/gotop go get github.com/cjbassi/gotop
``` ```
## Usage ## Usage
### Keybinds ### Keybinds
* Quit: `q` or `<C-c>` - Quit: `q` or `<C-c>`
* Process Navigation: - Process Navigation:
* `<up>`/`<down>` and `j`/`k`: up and down - `<up>`/`<down>` and `j`/`k`: up and down
* `<C-d>` and `<C-u>`: up and down half a page - `<C-d>` and `<C-u>`: up and down half a page
* `<C-f>` and `<C-b>`: up and down a full page - `<C-f>` and `<C-b>`: up and down a full page
* `gg` and `G`: jump to top and bottom - `gg` and `G`: jump to top and bottom
* Process Sorting: - Process Sorting:
* `c`: CPU - `c`: CPU
* `m`: Mem - `m`: Mem
* `p`: PID - `p`: PID
* `<tab>`: toggle process grouping - `<tab>`: toggle process grouping
* `dd`: kill the selected process or process group - `dd`: kill the selected process or process group
* `h` and `l`: zoom in and out of CPU and Mem graphs - `h` and `l`: zoom in and out of CPU and Mem graphs
* `?`: toggles keybind help menu - `?`: toggles keybind help menu
### Mouse ### Mouse
* click to select process - click to select process
* mouse wheel to scroll through processes - mouse wheel to scroll through processes
### Colorschemes ### Colorschemes
A different Colorscheme can be set with the `-c` flag followed its name. gotop ships with a few colorschemes which can be set with the `-c` flag followed by the name of one.
You can find different ones in [src/colorschemes](https://github.com/cjbassi/gotop/tree/master/src/colorschemes). You can find all the colorschemes in [src/colorschemes](https://github.com/cjbassi/gotop/tree/master/src/colorschemes) and you can make your own by checking out the [template](https://github.com/cjbassi/gotop/blob/master/src/colorschemes/template.go). Colorschemes PR's are welcome!
Feel free to add a new one.
You can use 256 colors, bold, underline, and reverse.
You can see the template and get more info [here](https://github.com/cjbassi/gotop/blob/master/src/colorschemes/template.go)
and see the default colorscheme as an example [here](https://github.com/cjbassi/gotop/blob/master/src/colorschemes/default.go).
### CLI Options ### CLI Options
`-c`, `--color=NAME` Set a colorscheme.
`-m`, `--minimal` Only show CPU, Mem and Process widgets. `-m`, `--minimal` Only show CPU, Mem and Process widgets.
`-r`, `--rate=RATE` Number of times per second to update CPU and Mem widgets [default: 1]. `-r`, `--rate=RATE` Number of times per second to update CPU and Mem widgets [default: 1].
`-v`, `--version` Show version.
`-c`, `--percpu` Show each CPU in the CPU widget.
`-a`, `--averagecpu` Show average CPU in the CPU widget.
## Credits ## Credits
* [mdnazmulhasan27771](https://github.com/mdnazmulhasan27771) for the [logo](https://github.com/cjbassi/gotop/blob/master/assets/logo.png) - [mdnazmulhasan27771](https://github.com/mdnazmulhasan27771) for the [logo](https://github.com/cjbassi/gotop/blob/master/assets/logo.png)
* [f1337](https://github.com/f1337) for helping port gotop to OSX - [f1337](https://github.com/f1337) for helping port gotop to OSX
## Built With ## Built With
* [My termui fork](https://github.com/cjbassi/termui) - [cjbassi/termui](https://github.com/cjbassi/termui)
* [drawille-go](https://github.com/exrook/drawille-go) - [drawille-go](https://github.com/exrook/drawille-go)
* [termbox](https://github.com/nsf/termbox-go) - [termbox](https://github.com/nsf/termbox-go)
* [gopsutil](https://github.com/shirou/gopsutil) - [gopsutil](https://github.com/shirou/gopsutil)
* [goreleaser](https://github.com/goreleaser/goreleaser) - [goreleaser](https://github.com/goreleaser/goreleaser)
## Stargazers over time ## Stargazers over time