bottom (btm)

A customizable cross-platform graphical process/system monitor for the terminal.
Supports Linux, macOS, and Windows. Inspired by gtop, gotop, and htop.

[

](https://github.com/ClementTsang/bottom/actions?query=branch%3Amaster) [

](https://app.codecov.io/gh/ClementTsang/bottom) [ crates.io link

](https://crates.io/crates/bottom) [

](https://clementtsang.github.io/bottom/nightly) [

](https://clementtsang.github.io/bottom/stable)

Quick demo recording showing off bottom's searching, expanding, and process killing.

Demo GIF using the Gruvbox theme (--color gruvbox), along with IBM Plex Mono and Kitty

## Features As (yet another) process/system visualization and management application, bottom supports the typical features: - Graphical visualization widgets for: - [CPU usage](https://clementtsang.github.io/bottom/nightly/usage/widgets/cpu/) over time, at an average and per-core level - [RAM and swap usage](https://clementtsang.github.io/bottom/nightly/usage/widgets/memory/) over time - [Network I/O usage](https://clementtsang.github.io/bottom/nightly/usage/widgets/network/) over time with support for zooming in/out the current time interval displayed. - Widgets for displaying info about: - [Disk capacity/usage](https://clementtsang.github.io/bottom/nightly/usage/widgets/disk/) - [Temperature sensors](https://clementtsang.github.io/bottom/nightly/usage/widgets/temperature/) - [Battery usage](https://clementtsang.github.io/bottom/nightly/usage/widgets/battery/) - [A process widget](https://clementtsang.github.io/bottom/nightly/usage/widgets/process/) for displaying, sorting, and searching info about processes, as well as support for: - Kill signals - Tree mode - Cross-platform support for Linux, macOS, and Windows, with more planned in the future. - [Customizable behaviour](https://clementtsang.github.io/bottom/nightly/configuration/command-line-flags/) that can be controlled with command-line flags or a config file, such as: - Custom and pre-built colour themes - Changing the default behaviour of some widgets - Changing the layout of widgets - Filtering out entries in disk and temperature widgets - Some other nice stuff, like: - [An htop-inspired basic mode](https://clementtsang.github.io/bottom/nightly/usage/basic-mode/) - [Expansion, which focuses on just one widget](https://clementtsang.github.io/bottom/nightly/usage/general-usage/#expansion) - And more! You can find more details in [the documentation](https://clementtsang.github.io/bottom/nightly/usage/general-usage/). ## Support bottom _officially_ supports the following operating systems and corresponding architectures: - macOS (`x86_64`) - Linux (`x86_64`, `i686`, `aarch64`) - Windows (`x86_64`, `i686`) These platforms are tested to work for the most part and issues on these platforms will be fixed if possible. Furthermore, binaries are expected to be built and tested using the most recent version of stable Rust. For more details on known problems and unsupported platforms, feel free to check out [the documentation page on support](https://clementtsang.github.io/bottom/nightly/support/official/). ## Installation ### Cargo Installation via cargo is done by installing the `bottom` crate: ```bash # If required, update Rust on the stable channel rustup update stable cargo install bottom # Alternatively, --locked may be required due to how cargo install works cargo install bottom --locked ``` ### Arch Linux There is an official package that can be installed with `pacman`: ```bash sudo pacman -Syu bottom ``` ### Debian/Ubuntu A `.deb` file is provided on each [release](https://github.com/ClementTsang/bottom/releases/latest): ```bash curl -LO https://github.com/ClementTsang/bottom/releases/download/0.6.8/bottom_0.6.8_amd64.deb sudo dpkg -i bottom_0.6.8_amd64.deb ``` ### Fedora/CentOS Available in [COPR](https://copr.fedorainfracloud.org/coprs/atim/bottom/): ```bash sudo dnf copr enable atim/bottom -y sudo dnf install bottom ``` ### Gentoo Available in [GURU](https://wiki.gentoo.org/wiki/Project:GURU) and [dm9pZCAq](https://github.com/gentoo-mirror/dm9pZCAq) overlays: ```bash sudo eselect repository enable guru sudo emerge --sync guru echo "sys-process/bottom" | sudo tee /etc/portage/package.accept_keywords/10-guru sudo emerge sys-process/bottom::guru ``` or ```bash sudo eselect repository enable dm9pZCAq sudo emerge --sync dm9pZCAq sudo emerge sys-process/bottom::dm9pZCAq ``` ### Nix ```bash nix-env -i bottom ``` ### Solus ``` sudo eopkg it bottom ``` ### Homebrew ```bash brew install bottom ``` ### MacPorts ```bash sudo port selfupdate sudo port install bottom ``` ### Scoop ```bash scoop install bottom ``` ### Chocolatey Choco package located [here](https://chocolatey.org/packages/bottom). Since validation of the package takes time, it may take a while to become available after a release. ```bash choco install bottom # The version number may be required for newer releases during the approval process: choco install bottom --version=0.6.8 ``` ### winget You can find the packages [here](https://github.com/microsoft/winget-pkgs/tree/master/manifests/Clement/bottom). Since validation of the package takes time, it may take a while to become available after a release. ```bash winget install bottom # Alternatively winget install Clement.bottom ``` You can also manually do the same thing by going to the [latest release](https://github.com/ClementTsang/bottom/releases/latest) and installing via the `.msi` file. You can uninstall via Control Panel, Options, or `winget --uninstall bottom`. ### Manually There are a few ways to go about doing this manually. Note that you probably want to do so using the most recent version of stable Rust, which is how the binaries are built: ```bash # If required, update Rust on the stable channel first rustup update stable # Option 1 - Download from releases and install curl -LO https://github.com/ClementTsang/bottom/archive/0.6.8.tar.gz tar -xzvf 0.6.8.tar.gz cargo install --path . # Option 2 - Clone from master and install manually git clone https://github.com/ClementTsang/bottom cd bottom cargo install --path . # Option 3 - Clone and install directly from the repo all via Cargo cargo install --git https://github.com/ClementTsang/bottom ``` ### Binaries You can also try to use the generated release binaries and manually install on your system: - [Latest stable release](https://github.com/ClementTsang/bottom/releases/latest), generated off of the release branch - [Latest nightly release](https://github.com/ClementTsang/bottom/releases/tag/nightly), generated daily off of the master branch at 00:00 UTC #### Auto-completion The release binaries are packaged with shell auto-completion files for bash, fish, zsh, and Powershell. To install them: - For bash, move `btm.bash` to `$XDG_CONFIG_HOME/bash_completion or /etc/bash_completion.d/`. - For fish, move `btm.fish` to `$HOME/.config/fish/completions/`. - For zsh, move `_btm` to one of your `$fpath` directories. - For PowerShell, add `. _btm.ps1` to your PowerShell [profile](). ## Usage You can run bottom using `btm`. - For help on flags, use `btm -h` for a quick overview or `btm --help` for more details. - For info on key and mouse bindings, press `?` inside bottom or refer to the [documentation](https://clementtsang.github.io/bottom/nightly/). You can find more information on usage in the [documentation](https://clementtsang.github.io/bottom/nightly/). ## Configuration bottom accepts a number of command-line arguments to change the behaviour of the application as desired. Additionally, bottom will automatically generate a configuration file on the first launch, which one can change as appropriate. More details on configuration can be found [in the documentation](https://clementtsang.github.io/bottom/nightly/configuration/config-file/default-config/). ## Contribution Whether it's reporting bugs, suggesting features, maintaining packages, or submitting a PR, contribution is always welcome! Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for details on how to contribute to bottom. ### Contributors Thanks to all contributors:

_{Marcin Wojnarowski} 💻 📦	_{Mahmoud Al-Qudsi} 💻	_Andy 💻	_{Kim Brose} 💻	_{Sven-Hendrik Haase} 📖	_{Artem Polishchuk} 📦 📖	_{Trung Lê} 📦 🚇
_dm9pZCAq 📦 📖	_{Lukas Rysavy} 💻	_{Erlend Hamberg} 💻	_{Frederick Zhang} 💻	_pvanheus 💻	_{Zeb Piasecki} 💻	_georgybog 📖
_{Brian Di Palma} 📖	_{Lasha Kanteladze} 📖	_{Herby Gillot} 📖	_{Greg Brown} 💻	_{TotalCaesar659} 📖	_{George Rawlinson} 📖 📦	_adiabatic 📖
_{Randy Barlow} 💻	_{Patrick Jackson} 🤔 📖	_{Mateusz Mikuła} 💻	_{Guillaume Gomez} 💻

## Thanks - This project is very much inspired by [gotop](https://github.com/xxxserxxx/gotop), [gtop](https://github.com/aksakalli/gtop), and [htop](https://github.com/htop-dev/htop/). - This application was written with many, _many_ libraries, and built on the work of many talented people. This application would be impossible without their work. I used to thank them all individually but the list got too large... - And of course, another round of thanks to all contributors and package maintainers!