bottom/README.md

bottom

A cross-platform graphical process/system monitor with a customizable interface and a multitude of features. Supports Linux, macOS, and Windows. Inspired by gtop, gotop, and htop.

Gruvbox theme (--color gruvbox) with IBM Plex Mono running on Kitty

Features

As (yet another) process/system visualization and management application, bottom supports the typical features:

• Graphical visualization widgets for:

  • CPU usage over time, at an average and per-core level
  • RAM and swap usage over time
  • Network I/O usage over time

  with support for zooming in/out the current time interval displayed.

• Widgets for displaying info about:

  • Disk capacity/usage
  • Temperature sensors
  • Battery usage

• A process widget 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 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
  • Expansion, which focuses on just one widget

• And more!

You can find more details in the documentation.

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.

Installation

Cargo

# If required, update Rust on the stable channel
rustup update stable

cargo install bottom

# OR, --locked may be required due to how cargo install works
cargo install bottom --locked

AUR

The normal package can be found here, while the binary package found here:

yay -S bottom

# If you instead want a pre-built binary:
yay -S bottom-bin

Debian/Ubuntu

A .deb file is provided on each release:

curl -LO https://github.com/ClementTsang/bottom/releases/download/0.6.2/bottom_0.6.2_amd64.deb
sudo dpkg -i bottom_0.6.2_amd64.deb

Fedora/CentOS

Available in COPR:

sudo dnf copr enable atim/bottom -y
sudo dnf install bottom

Gentoo

Available in GURU and dm9pZCAq overlays:

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

sudo eselect repository enable dm9pZCAq
sudo emerge --sync dm9pZCAq
sudo emerge sys-process/bottom::dm9pZCAq

Nix

nix-env -i bottom

Solus

sudo eopkg it bottom

Homebrew

brew tap clementtsang/bottom
brew install bottom

# If you need to be more specific, use:
brew install clementtsang/bottom/bottom

MacPorts

sudo port selfupdate
sudo port install bottom

Scoop

scoop install bottom

Chocolatey

Choco package located here. Since validation of the package takes time, it may take a while to become available after a release.

choco install bottom

# The version number may be required for newer releases during the approval process:
choco install bottom --version=0.6.2

winget

You can find the packages here. Since validation of the package takes time, it may take a while to become available after a release.

winget install bottom

You can also manually do the same thing by going to the latest release and installing via the .msi file.

You can uninstall via Control Panel, Options, or winget --uninstall bottom.

Building

There are a few ways to go about doing this manually. Note that in all cases, you would want to build using the most recent version of stable Rust:

# If required, update Rust on the stable channel
rustup update stable

# Download from releases and install
curl -LO https://github.com/ClementTsang/bottom/archive/0.6.2.tar.gz
tar -xzvf 0.6.2.tar.gz
cargo install --path .

# Clone from master and install manually
git clone https://github.com/ClementTsang/bottom
cd bottom
cargo install --path .

# Clone and install the newest master version 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 them:

• Latest stable release, generated off of the release branch
• Latest nightly version, which is 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, refer to the documentation or press ? inside bottom.

You can generally find more information on usage in the documentation.

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.

Contribution

Whether it's reporting problems, documentation, or code, contribution is always welcome! Please read CONTRIBUTING.md for details on how to contribute to bottom.

Contributors

Thanks to all contributors (emoji key):

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 💻

Thanks

• This project is very much inspired by gotop, gtop, and 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!