Yet another cross-platform graphical process/system monitor.
Go to file
Clement Tsang ecb6faa089
refactor: restructure canvas file folder structure (#1368)
* refactor: group together some canvas files

* rename file

* more shuffling around

* fmt

* more shuffling

Going to flatten widgets in another PR.

* some docs

* naming

* fmt
2024-01-01 05:19:52 -05:00
.cargo feature: support default selection of average CPU graph (#1353) 2023-12-10 15:21:35 -05:00
.cargo-husky/hooks other: update cargo husky pre-push hook 2022-11-13 01:59:32 -05:00
.github ci: downgrade to checkout v3 when building releases in non-GH containers (#1352) 2023-12-06 17:36:39 -05:00
assets docs: update gif for 0.8.0 (#998) 2023-01-22 03:55:14 -05:00
desktop ci: add .desktop file (#1296) 2023-09-06 19:12:28 -04:00
docs feature: support default selection of average CPU graph (#1353) 2023-12-10 15:21:35 -05:00
sample_configs feature: support default selection of average CPU graph (#1353) 2023-12-10 15:21:35 -05:00
scripts other: master -> main (#1349) 2023-12-06 00:16:26 -05:00
src refactor: restructure canvas file folder structure (#1368) 2024-01-01 05:19:52 -05:00
tests refactor: restructure canvas file folder structure (#1368) 2024-01-01 05:19:52 -05:00
.all-contributorsrc docs: add zebp as a contributor for code (#1266) 2023-07-27 03:58:52 -04:00
.cirrus.yml other: master -> main (#1349) 2023-12-06 00:16:26 -05:00
.gitignore refactor: add fast branch for ascii-only string truncate (#1330) 2023-11-23 23:45:03 -05:00
.markdownlint.json ci: automatically create and get build artifacts from Cirrus CI (#854) 2022-10-27 06:27:04 -04:00
build.rs chore: Minor cleanup - remove un-needed ident qualifiers (#1307) 2023-10-22 22:29:03 -04:00
Cargo.lock deps: bump anyhow, clap, and thiserror (#1365) 2023-12-27 23:13:07 -05:00
Cargo.toml deps: bump anyhow, clap, and thiserror (#1365) 2023-12-27 23:13:07 -05:00
CHANGELOG.md other: if in a non-D0 state, short-circuit further logic (#1355) 2023-12-20 01:36:08 -05:00
clippy.toml refactor: tables V2 (#749) 2022-10-12 16:25:38 -04:00
codecov.yml other: bump codecov to 30% 2022-06-24 17:08:45 -04:00
CONTRIBUTING.md other: master -> main (#1349) 2023-12-06 00:16:26 -05:00
Cross.toml deployment: add aarch64/armv7 gnu .deb generation (#739) 2022-05-28 16:14:25 -04:00
LICENSE Initial commit 2019-08-28 19:43:30 -04:00
README.md other: master -> main (#1349) 2023-12-06 00:16:26 -05:00
rustfmt.toml refactor: restructure canvas file folder structure (#1368) 2024-01-01 05:19:52 -05:00

bottom

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

CI status crates.io link Stable documentation Nightly documentation

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

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

Table of contents

Features

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

You can find more details in the documentation.

Support

Official

bottom officially supports the following operating systems and corresponding architectures:

  • macOS (x86_64, aarch64)
  • 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 at the time.

For more details on supported platforms and known problems, check out the documentation.

Unofficial

bottom may work on a number of platforms that aren't officially supported. Note that unsupported platforms:

  • Might not be tested in CI to build or pass tests (see here for checked platforms).
  • Might not be properly tested by maintainers prior to a stable release.
  • May only receive limited support, such as missing features or bugs that may not be fixed.

Note that some unsupported platforms may eventually be officially supported (e.g., FreeBSD).

A non-comprehensive list of some currently unofficially supported platforms that may compile/work include:

  • FreeBSD (x86_64)
  • Linux (armv6, armv7, powerpc64le, riscv64gc)
  • Android (arm64)

For more details on unsupported platforms and known problems, check out the documentation.

Installation

Cargo

Installation via cargo can be done by installing the bottom crate:

# If required, update Rust to the stable channel first:
rustup update stable

# Install
cargo install bottom --locked

# If you use another channel by default, you can specify
# the stable channel like so:
cargo +stable install bottom --locked

# --locked may be omitted if you wish to not use the
# locked crate versions in Cargo.lock. However, be
# aware that this may cause problems with dependencies.
cargo install bottom

Arch Linux

bottom is available as an official package that can be installed with pacman:

sudo pacman -S bottom

Debian / Ubuntu

A .deb file is provided on each stable release and nightly builds for x86, aarch64, and armv7 (note stable ARM builds are only available for 0.6.8 and later). An example of installing this way:

# x86-64
curl -LO https://github.com/ClementTsang/bottom/releases/download/0.9.6/bottom_0.9.6_amd64.deb
sudo dpkg -i bottom_0.9.6_amd64.deb

# ARM64
curl -LO https://github.com/ClementTsang/bottom/releases/download/0.9.6/bottom_0.9.6_arm64.deb
sudo dpkg -i bottom_0.9.6_arm64.deb

# ARM
curl -LO https://github.com/ClementTsang/bottom/releases/download/0.9.6/bottom_0.9.6_armhf.deb
sudo dpkg -i bottom_0.9.6_armhf.deb

Snap

bottom is available as a snap:

sudo snap install bottom

# To allow the program to run as intended
sudo snap connect bottom:mount-observe
sudo snap connect bottom:hardware-observe
sudo snap connect bottom:system-observe
sudo snap connect bottom:process-control

Fedora / CentOS / AlmaLinux / Rocky Linux

bottom is available in COPR:

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

.rpm files are also generated (starting from 0.9.3) for x86. If you wish to install this way, then you can do something like:

# x86-64
curl -LO https://github.com/ClementTsang/bottom/releases/download/0.9.6/bottom-0.9.6-1.x86_64.rpm
sudo rpm -i bottom-0.9.6-1.x86_64.rpm

# Nightly x86-64
curl -LO https://github.com/ClementTsang/bottom/releases/download/nightly/bottom-0.9.6-1.x86_64.rpm
sudo rpm -i bottom-0.9.6-1.x86_64.rpm

Gentoo

Available in the official Gentoo repo:

sudo emerge --ask sys-process/bottom

Nix

Available in the nix-community repo:

nix-env -i bottom

Solus

Available in the Solus repos:

sudo eopkg it bottom

Void

Available in the void-packages repo:

sudo xbps-install bottom

Homebrew

Formula available here:

brew install bottom

MacPorts

Available here:

sudo port selfupdate
sudo port install bottom

Scoop

Available in the Main bucket:

scoop install bottom

Chocolatey

Chocolatey packages are located here:

choco install bottom

winget

The winget package can be found here:

winget install bottom

# If you need a more specific app id:
winget install Clement.bottom

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

Windows installer

You can also manually install bottom as a Windows program by going to the latest release and installing via the .msi file.

Manual installation

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:

# 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.9.6.tar.gz
tar -xzvf 0.9.6.tar.gz
cargo install --path . --locked

# Option 2 - Clone the repo and install manually
git clone https://github.com/ClementTsang/bottom
cd bottom
cargo install --path . --locked

# Option 3 - Clone and install directly from the repo all via Cargo
cargo install --git https://github.com/ClementTsang/bottom --locked

# You can also pass in the target-cpu=native flag for
# better CPU-specific optimizations. For example:
RUSTFLAGS="-C target-cpu=native" cargo install --path . --locked

Binaries

You can also use the pre-built release binaries manually:

To use, download and extract the binary that matches your system. You can then run by doing:

./btm

or by installing to your system following whatever the procedure is for installing a binary to your system.

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.

The individual auto-completion files are also included in the stable/nightly releases as completion.tar.gz.

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.

You can 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.

Troubleshooting

If some things aren't working, give the troubleshooting page a look. If things still aren't working, then consider opening a question or filing a bug report.

Contribution

Whether it's reporting bugs, suggesting features, maintaining packages, or submitting a PR, contribution is always welcome! Please read CONTRIBUTING.md for details on how to contribute to bottom.

Contributors

Thanks to all contributors:

Marcin Wojnarowski
Marcin Wojnarowski

💻 📦
Mahmoud Al-Qudsi
Mahmoud Al-Qudsi

💻
Andy
Andy

💻
Kim Brose
Kim Brose

💻
Sven-Hendrik Haase
Sven-Hendrik Haase

📖
Artem Polishchuk
Artem Polishchuk

📦 📖
Trung Lê
Trung Lê

📦 🚇
dm9pZCAq
dm9pZCAq

📦 📖
Lukas Rysavy
Lukas Rysavy

💻
Erlend Hamberg
Erlend Hamberg

💻
Frederick Zhang
Frederick Zhang

💻
pvanheus
pvanheus

💻
Zeb Piasecki
Zeb Piasecki

💻
Brian Di Palma
Brian Di Palma

📖
Lasha Kanteladze
Lasha Kanteladze

📖
Herby Gillot
Herby Gillot

📖
Greg Brown
Greg Brown

💻
TotalCaesar659
TotalCaesar659

📖
George Rawlinson
George Rawlinson

📖 📦
adiabatic
adiabatic

📖
Randy Barlow
Randy Barlow

💻
Patrick Jackson
Patrick Jackson

🤔 📖
Mateusz Mikuła
Mateusz Mikuła

💻
Guillaume Gomez
Guillaume Gomez

💻
shura
shura

💻
Wesley Moore
Wesley Moore

💻
xgdgsc
xgdgsc

📖
ViridiCanis
ViridiCanis

💻
Justin Martin
Justin Martin

💻 📖
Diana
Diana

💻
Hervy Qurrotul Ainur Rozi
Hervy Qurrotul Ainur Rozi

📖
Mike Rivnak
Mike Rivnak

📖
lroobrou
lroobrou

💻
database64128
database64128

💻
Chon Sou
Chon Sou

💻
DrSheppard
DrSheppard

📖
Rareș Constantin
Rareș Constantin

💻
felipesuri
felipesuri

📖
spital
spital

💻
Michael Bikovitsky
Michael Bikovitsky

💻
Dmitry Valter
Dmitry Valter

💻
Twan Stok
Twan Stok

💻
Yuxuan Shui
Yuxuan Shui

💻
Wenqing Zong
Wenqing Zong

💻
Gabriele Belluardo
Gabriele Belluardo

💻
Zeb Piasecki
Zeb Piasecki

💻

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 the contributors and package maintainers!