2019-09-17 04:54:39 +02:00
# bottom
2019-09-04 05:27:25 +02:00
2019-09-18 20:52:18 +02:00
[](https://travis-ci.com/ClementTsang/bottom) [](https://crates.io/crates/bottom)
2019-09-15 04:29:40 +02:00
2020-01-03 05:42:44 +01:00
A graphical top clone, written in Rust. Inspired by both [gtop ](https://github.com/aksakalli/gtop ) and [gotop ](https://github.com/cjbassi/gotop )
2019-09-04 05:27:25 +02:00
2019-09-17 03:45:48 +02:00
2020-01-13 00:45:11 +01:00
## Features
Features of bottom include:
- CPU widget to show a visual representation of per-core usage. Average CPU display also exists.
- Memory widget to show a visual representation of both RAM and SWAP usage.
- Networks widget to show a log-based visual representation of network usage.
- Sortable and searchable process widget. Searching supports regex, and you can search by PID and process name.
- Disks widget to display usage and I/O per second.
- Temperature widget to monitor detected sensors in your system.
The compatibility of each widget and operating systems are, as of version 0.1.0, as follows:
2020-01-19 08:02:44 +01:00
| OS/Widget | CPU | Memory | Disks | Temperature | Processes | Networks |
| ------------------------------ | -------- | -------- | -------- | --------------------- | --------- | --------------------------------------------- |
| Linux (tested on Arch Linux) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| Windows (tested on Windows 10) | ✓ | ✓ | ✓ | Currently not working | ✓ | Partially supported (total RX/TX unavailable) |
| macOS | Untested | Untested | Untested | Untested | Untested | Untested |
2020-01-13 00:45:11 +01:00
2019-09-09 06:09:58 +02:00
## Installation
2019-09-06 00:28:54 +02:00
2020-01-21 02:09:39 +01:00
In all cases you can install the in-development version by cloning and using `cargo build --release` . Note this is built and tested with Rust Stable (1.40.0 as of writing). You can also get release versions using `cargo install bottom` , or manually building from the [Releases ](https://github.com/ClementTsang/bottom/releases ) page by downloading and building.
2020-01-19 08:02:44 +01:00
2019-09-09 06:09:58 +02:00
### Linux
2020-01-19 08:02:44 +01:00
Other installation methods based on distros are as follows:
2020-01-10 04:31:49 +01:00
#### Arch Linux
2020-01-12 20:25:47 +01:00
You can get the release versions from the AUR by installing `bottom` .
2020-01-05 01:20:54 +01:00
2019-09-09 06:09:58 +02:00
### Windows
2020-01-19 08:02:44 +01:00
You may need to install a font like [FreeMono ](https://fonts2u.com/free-monospaced.font ) and use a terminal like cmder for font support to work properly, unfortunately.
2019-09-09 06:09:58 +02:00
2019-12-17 08:11:16 +01:00
### macOS
2019-09-09 06:09:58 +02:00
2020-01-19 08:02:44 +01:00
macOS support will hopefully come soon< sup > TM< / sup > . I've had reports of it working already, but I cannot personally confirm whether things are working until then.
2019-09-08 07:28:03 +02:00
2020-01-03 02:31:58 +01:00
## Usage
2019-10-11 00:05:26 +02:00
2020-01-10 05:36:24 +01:00
Run using `btm` .
2019-09-17 04:39:57 +02:00
### Command line options
2019-12-16 08:40:35 +01:00
- `-h` , `--help` shows the help screen and exits.
2019-09-17 04:39:57 +02:00
2019-12-16 08:40:35 +01:00
- `-a` , `--avgcpu` enables also showing the average CPU usage in addition to per-core CPU usage.
2019-09-25 07:54:38 +02:00
2019-12-16 08:40:35 +01:00
- `-m` , `--dot-marker` uses a dot marker instead of the default braille marker.
2019-09-17 04:39:57 +02:00
2019-09-25 07:34:33 +02:00
- `-c` , `--celsius` displays the temperature type in Celsius. This is the default.
2019-09-17 04:39:57 +02:00
2019-12-16 08:40:35 +01:00
- `-f` , `--fahrenheit` displays the temperature type in Fahrenheit.
2019-09-17 04:39:57 +02:00
2019-12-16 08:40:35 +01:00
- `-k` , `--kelvin` displays the temperature type in Kelvin.
2019-09-17 04:39:57 +02:00
2019-09-25 07:34:33 +02:00
- `-v` , `--version` displays the version number and exits.
2019-09-17 04:39:57 +02:00
2019-12-13 05:03:34 +01:00
- `-d` , `--debug` enables debug logging.
2019-12-26 01:00:24 +01:00
- `-r <RATE>` , `--rate <RATE>` will set the refresh rate in _milliseconds_ . Lowest it can go is 250ms, the highest it can go is 2< sup > 128</ sup > - 1. Defaults to 1000ms, and lower values may take more resources due to more frequent polling of data, and may be less accurate in some circumstances.
2019-09-17 04:39:57 +02:00
2019-12-28 07:21:49 +01:00
- `-l` , `--left_legend` will move external table legends to the left side rather than the right side. Right side is default.
2020-01-03 05:42:44 +01:00
- `-u` , `--current_usage` will make a process' CPU usage be based on the current total CPU usage, rather than assuming 100% CPU usage. Only affects Linux for now.
2020-01-01 04:24:54 +01:00
2020-01-18 01:59:01 +01:00
- `-g` , `--group` will group together processes with the same name by default (equivalent to pressing `Tab` ).
2020-02-01 02:49:30 +01:00
- `-i` , `--case_insensitive` will default to not matching case when searching processes.
2020-01-09 04:54:14 +01:00
2019-12-22 23:37:07 +01:00
### Keybindings
2019-09-17 03:45:48 +02:00
#### General
2020-01-12 21:41:27 +01:00
- `q` , `Ctrl-c` to quit. Note if you are currently in the search widget, `q` will not work so you can still type.
2019-10-11 00:01:23 +02:00
- `Ctrl-r` to reset the screen and reset all collected data.
2019-09-17 03:45:48 +02:00
2019-10-10 04:50:36 +02:00
- `f` to freeze the screen from updating with new data. Press `f` again to unfreeze. Note that monitoring will still continue in the background.
2019-10-10 04:34:09 +02:00
2020-01-12 20:25:47 +01:00
- `Ctrl-Up` or `Ctrl-k` , `Ctrl-Down` or `Ctrl-j` , `Ctrl-Left` or `Ctrl-h` , `Ctrl-Right` or `Ctrl-l` to navigate between widgets.
2019-09-25 22:43:13 +02:00
2019-10-10 04:42:50 +02:00
- `Esc` to close a dialog window.
2019-10-10 04:00:10 +02:00
2019-10-10 04:50:36 +02:00
- `?` to get a help screen explaining the controls. Note all controls except `Esc` to close the dialog will be disabled while this is open.
2019-09-17 03:45:48 +02:00
2020-01-03 06:00:05 +01:00
#### Scrollable Tables
2020-01-12 20:25:47 +01:00
- `Up` or `k` and `Down` or `j` scrolls through the list if the widget is a table (Temperature, Disks, Processes).
2020-01-03 06:00:05 +01:00
2020-01-05 01:41:32 +01:00
- `gg` or `Home` to jump to the first entry of the current table.
2020-01-03 06:00:05 +01:00
2020-01-12 19:15:35 +01:00
- `G` (`Shift-g`) or `End` to jump to the last entry of the current table.
2020-01-03 06:00:05 +01:00
#### Processes
2019-09-17 03:45:48 +02:00
2019-12-31 03:05:39 +01:00
- `dd` to kill the selected process
2019-09-17 03:45:48 +02:00
2019-09-25 07:34:33 +02:00
- `c` to sort by CPU usage. Sorts in descending order by default. Press again to reverse sorting order.
2019-09-17 03:45:48 +02:00
2019-09-25 07:34:33 +02:00
- `m` to sort by memory usage. Sorts in descending order by default. Press again to reverse sorting order.
2019-09-17 03:45:48 +02:00
2019-09-25 07:34:33 +02:00
- `p` to sort by PID. Sorts in ascending order by default. Press again to reverse sorting order.
2019-09-17 03:45:48 +02:00
2019-09-25 07:34:33 +02:00
- `n` to sort by process name. Sorts in ascending order by default. Press again to reverse sorting order.
2019-09-17 03:45:48 +02:00
2020-01-09 04:54:14 +01:00
- `Tab` to group together processes with the same name. Disables PID sorting. `dd` will now kill all processes covered by that name.
2020-01-13 00:45:11 +01:00
- `Ctrl-f` or `/` to open the search widget.
#### Search Widget
- `Ctrl-p` or `Ctrl-n` to switch between searching for PID and name respectively.
2020-01-18 01:59:01 +01:00
- `Ctrl-s` to toggle between a simple search and a regex search.
- `Ctrl-a` and `Ctrl-e` to jump to the start and end of the search bar respectively.
2020-01-13 00:45:11 +01:00
- `Esc` or `Ctrl-f` to close.
2020-01-22 01:28:39 +01:00
- `Left` and `Right` arrow keys to move the cursor within the search bar.
2020-01-13 00:45:11 +01:00
Note that `q` is disabled while in the search widget.
2020-01-12 20:25:47 +01:00
2019-12-17 08:11:16 +01:00
### Mouse actions
2019-09-17 03:45:48 +02:00
2020-01-22 01:28:39 +01:00
- Scrolling with the mouse will scroll through the currently selected list if the widget is a scrollable table.
2019-12-31 03:05:39 +01:00
2019-12-17 08:11:16 +01:00
## Thanks, kudos, and all the like
2019-09-04 05:27:25 +02:00
2020-01-22 01:28:39 +01:00
- This project is very much inspired by both [gotop ](https://github.com/cjbassi/gotop ) and [gtop ](https://github.com/aksakalli/gtop ).
2019-09-25 07:34:33 +02:00
- This application was written with the following libraries:
- [chrono ](https://github.com/chronotope/chrono )
- [clap ](https://github.com/clap-rs/clap )
- [crossterm ](https://github.com/TimonPost/crossterm )
- [failure ](https://github.com/rust-lang-nursery/failure )
- [fern ](https://github.com/daboross/fern )
- [futures-rs ](https://github.com/rust-lang-nursery/futures-rs )
- [futures-timer ](https://github.com/rustasync/futures-timer )
- [heim ](https://github.com/heim-rs/heim )
- [log ](https://github.com/rust-lang-nursery/log )
- [sysinfo ](https://github.com/GuillaumeGomez/sysinfo )
- [tokio ](https://github.com/tokio-rs/tokio )
2019-12-13 05:03:34 +01:00
- [tui-rs ](https://github.com/fdehau/tui-rs )
2019-09-25 07:34:33 +02:00
- [winapi ](https://github.com/retep998/winapi-rs )
2020-01-03 04:54:39 +01:00
- [lazy_static ](https://github.com/rust-lang-nursery/lazy-static.rs )
