xmtop/README.md

78 lines
2.6 KiB
Markdown
Raw Normal View History

2018-04-12 01:51:51 +08:00
<div align="center">
<img src="https://github.com/cjbassi/gotop/blob/master/media/logo.png" width="20%" height="20%" />
<br><br>
</div>
2018-02-19 15:25:02 +08:00
2018-03-05 13:19:31 +08:00
Another TUI graphical activity monitor, inspired by [gtop](https://github.com/aksakalli/gtop) and [vtop](https://github.com/MrRio/vtop), this time written in [Go](https://golang.org/)!
2018-04-11 11:12:51 +08:00
Built with [gopsutil](https://github.com/shirou/gopsutil), [drawille-go](https://github.com/exrook/drawille-go), and a [fork](https://github.com/cjbassi/termui) of [termui](https://github.com/gizak/termui).
2018-02-19 15:25:02 +08:00
2018-03-23 07:35:16 +08:00
<img src="https://github.com/cjbassi/gotop/blob/master/media/demo.gif" />
<img src="https://github.com/cjbassi/gotop/blob/master/media/minimal.png" />
2018-03-05 13:19:31 +08:00
2018-02-19 15:25:02 +08:00
## Installation
2018-04-11 11:25:14 +08:00
Go programs compile to a single binary and there are currently prebuilt ones for 32/64bit Linux and 32/64bit OSX. Either clone the repo and run [download.sh](https://github.com/cjbassi/gotop/blob/master/download.sh) to download the correct binary, use the AUR if you're on Arch Linux, or build from source.
2018-02-21 11:38:59 +08:00
### Using Git
2018-02-19 15:25:02 +08:00
```
git clone --depth 1 https://github.com/cjbassi/gotop.git /tmp/gotop
/tmp/gotop/download.sh
```
2018-02-19 15:25:02 +08:00
2018-02-26 14:51:51 +08:00
Then move `gotop` into your $PATH somewhere.
2018-02-19 15:25:02 +08:00
### Arch Linux
Install the `gotop-bin` package from the AUR.
2018-02-19 15:25:02 +08:00
2018-02-21 11:38:59 +08:00
### Source
```
go get github.com/cjbassi/gotop
```
2018-02-21 11:38:59 +08:00
2018-02-19 15:25:02 +08:00
2018-02-21 10:57:18 +08:00
## Usage
### Keybinds
2018-02-19 15:25:02 +08:00
* Quit: `q` or `<C-c>`
2018-03-10 08:29:05 +08:00
* Process Navigation:
2018-02-19 15:25:02 +08:00
* `<up>`/`<down>` and `j`/`k`: up and down
* `<C-d>` and `<C-u>`: up and down half a page
* `<C-f>` and `<C-b>`: up and down a full page
2018-02-19 15:25:02 +08:00
* `gg` and `G`: jump to top and bottom
* Process Sorting:
* `c`: CPU
* `m`: Mem
* `p`: PID
* `<tab>`: toggle process grouping
* `dd`: kill the selected process or process group
2018-03-10 08:29:05 +08:00
* `h` and `l`: zoom in and out of CPU and Mem graphs
2018-02-19 15:25:02 +08:00
* `?`: toggles keybind help menu
2018-02-21 11:03:53 +08:00
### Mouse
2018-02-19 15:25:02 +08:00
* click to select process
2018-02-26 14:51:51 +08:00
* mouse wheel to scroll through processes
2018-02-19 15:25:02 +08:00
2018-03-10 05:36:54 +08:00
### Colorschemes
2018-02-19 15:25:02 +08:00
2018-02-20 03:54:04 +08:00
A different Colorscheme can be set with the `-c` flag followed its name. You can find them in the `colorschemes` folder.
2018-02-21 15:57:27 +08:00
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/colorschemes/template.go) and see the default colorscheme as an example [here](https://github.com/cjbassi/gotop/blob/master/colorschemes/default.go).
2018-03-10 05:36:54 +08:00
### CLI Options
`-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].
2018-04-10 10:15:25 +08:00
## Stargazers over time
[![Stargazers over time](https://starcharts.herokuapp.com/cjbassi/gotop.svg)](https://starcharts.herokuapp.com/cjbassi/gotop)