https://github.com/clementtsang/bottom
Yet another cross-platform graphical process/system monitor.
https://github.com/clementtsang/bottom
bottom btm cli cross-platform monitoring rust terminal top tui
Last synced: 9 days ago
JSON representation
Yet another cross-platform graphical process/system monitor.
- Host: GitHub
- URL: https://github.com/clementtsang/bottom
- Owner: ClementTsang
- License: mit
- Created: 2019-08-28T23:43:30.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-04-29T22:14:26.000Z (11 days ago)
- Last Synced: 2025-05-01T00:57:27.107Z (10 days ago)
- Topics: bottom, btm, cli, cross-platform, monitoring, rust, terminal, top, tui
- Language: Rust
- Homepage: https://bottom.pages.dev
- Size: 72.6 MB
- Stars: 11,202
- Watchers: 50
- Forks: 280
- Open Issues: 113
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
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%main)
[
](https://crates.io/crates/bottom)
[
](https://clementtsang.github.io/bottom/stable)
[
](https://clementtsang.github.io/bottom/nightly)
## Table of contents
- [Features](#features)
- [Support](#support)
- [Official](#official)
- [Unofficial](#unofficial)
- [Installation](#installation)
- [Cargo](#cargo)
- [Alpine](#alpine)
- [Arch Linux](#arch-linux)
- [Debian / Ubuntu](#debian--ubuntu)
- [Exherbo Linux](#exherbo-linux)
- [Fedora / CentOS / AlmaLinux / Rocky Linux](#fedora--centos--almalinux--rocky-linux)
- [Gentoo](#gentoo)
- [Nix](#nix)
- [openSUSE](#opensuse)
- [Snap](#snap)
- [Solus](#solus)
- [Void](#void)
- [Homebrew](#homebrew)
- [MacPorts](#macports)
- [Chocolatey](#chocolatey)
- [Scoop](#scoop)
- [winget](#winget)
- [Windows installer](#windows-installer)
- [Conda](#conda)
- [Pre-built binaries](#pre-built-binaries)
- [Auto-completion](#auto-completion)
- [Usage](#usage)
- [Configuration](#configuration)
- [Troubleshooting](#troubleshooting)
- [Contribution](#contribution)
- [Contributors](#contributors)
- [Thanks](#thanks)
## 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](https://clementtsang.github.io/bottom/nightly/usage/widgets/process/#process-termination)
- [Tree mode](https://clementtsang.github.io/bottom/nightly/usage/widgets/process/#tree-mode)
- [Cross-platform support](https://github.com/ClementTsang/bottom#support) for Linux, macOS, and Windows, with more planned in the future.
- [Customizable behaviour](https://clementtsang.github.io/bottom/nightly/configuration/command-line-options/) that can be controlled with command-line options or a config file, such as:
- Custom and built-in colour themes
- Customizing widget behaviour
- Changing the layout of widgets
- Filtering out entries in some widgets
- And more:
- [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
### 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 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](https://clementtsang.github.io/bottom/nightly/support/official/).
### 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](./.github/workflows/ci.yml) 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](https://clementtsang.github.io/bottom/nightly/support/unofficial/).
## Installation
### Cargo
Installation via `cargo` can be done by installing the [`bottom`](https://crates.io/crates/bottom) crate:
```bash
# You might need to update the stable version of Rust first.
# Other versions might work, but this is not guaranteed.
rustup update stable
# Install the binary from crates.io.
cargo install bottom --locked
# If you use another channel by default, you can specify
# the what channel to use 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
```
Alternatively, you can use `cargo install` using the repo as the source.
```bash
# You might need to update the stable version of Rust first.
# Other versions might work, but this is not guaranteed.
rustup update stable
# Option 1 - Download an archive from releases and install
curl -LO https://github.com/ClementTsang/bottom/archive/0.10.2.tar.gz
tar -xzvf 0.10.2.tar.gz
cargo install --path . --locked
# Option 2 - Manually clone the repo and install
git clone https://github.com/ClementTsang/bottom
cd bottom
cargo install --path . --locked
# Option 3 - Install using cargo with the repo as the source
cargo install --git https://github.com/ClementTsang/bottom --locked
# You can also pass in the target-cpu=native flag to try to
# use better CPU-specific optimizations. For example:
RUSTFLAGS="-C target-cpu=native" cargo install --path . --locked
```
### Alpine
bottom is available as a [package](https://pkgs.alpinelinux.org/packages?name=bottom&branch=edge&repo=&arch=&origin=&flagged=&maintainer=) for Alpine Linux via `apk`:
```bash
apk add bottom
```
Packages for documentation ([`bottom-doc`](https://pkgs.alpinelinux.org/packages?name=bottom-doc&branch=edge&repo=&arch=&origin=&flagged=&maintainer=)) and completions for Bash ([`bottom-bash-completion`](https://pkgs.alpinelinux.org/packages?name=bottom-bash-completion&branch=edge&repo=&arch=&origin=&flagged=&maintainer=)), Fish ([`bottom-fish-completion`](https://pkgs.alpinelinux.org/packages?name=bottom-fish-completion&branch=edge&repo=&arch=&origin=&flagged=&maintainer=)), and Zsh ([`bottom-zsh-completion`](https://pkgs.alpinelinux.org/packages?name=bottom-zsh-completion&branch=edge&repo=&arch=&origin=&flagged=&maintainer=)) are also available.
### Arch Linux
bottom is available as an [official package](https://archlinux.org/packages/extra/x86_64/bottom/) that can be installed with `pacman`:
```bash
sudo pacman -S bottom
```
If you want the latest changes that are not yet stable, you can also install `bottom-git` [from the AUR](https://aur.archlinux.org/packages/bottom-git):
```bash
# Using paru
paru -S bottom-git
# Using yay
yay -S bottom-git
```
### Debian / Ubuntu
A `.deb` file is provided on each [stable release](https://github.com/ClementTsang/bottom/releases/latest) and
[nightly builds](https://github.com/ClementTsang/bottom/releases/tag/nightly) for x86, aarch64, and armv7.
Some examples of installing it this way:
```bash
# x86-64
curl -LO https://github.com/ClementTsang/bottom/releases/download/0.10.2/bottom_0.10.2-1_amd64.deb
sudo dpkg -i bottom_0.10.2-1_amd64.deb
# ARM64
curl -LO https://github.com/ClementTsang/bottom/releases/download/0.10.2/bottom_0.10.2-1_arm64.deb
sudo dpkg -i bottom_0.10.2-1_arm64.deb
# ARM
curl -LO https://github.com/ClementTsang/bottom/releases/download/0.10.2/bottom_0.10.2-1_armhf.deb
sudo dpkg -i bottom_0.10.2-1_armhf.deb
# musl-based
curl -LO https://github.com/ClementTsang/bottom/releases/download/0.10.2/bottom-musl_0.10.2-1_amd64.deb
sudo dpkg -i bottom-musl_0.10.2-1_amd64.deb
```
### Exherbo Linux
bottom is available as a [rust package](https://gitlab.exherbo.org/exherbo/rust/-/tree/master/packages/sys-process/bottom) that can be installed with `cave`:
```bash
cave resolve -x repository/rust
cave resolve -x bottom
```
### Fedora / CentOS / AlmaLinux / Rocky Linux
bottom is available on [COPR](https://copr.fedorainfracloud.org/coprs/atim/bottom/):
```bash
sudo dnf copr enable atim/bottom -y
sudo dnf install bottom
```
bottom is also available via [Terra](https://terra.fyralabs.com/):
```bash
sudo dnf install --repofrompath 'terra,https://repos.fyralabs.com/terra$releasever' --setopt='terra.gpgkey=https://repos.fyralabs.com/terra$releasever/key.asc' terra-release
sudo dnf install bottom
```
`.rpm` files are also generated for x86 in the [releases](https://github.com/ClementTsang/bottom/releases) page.
For example:
```bash
curl -LO https://github.com/ClementTsang/bottom/releases/download/0.10.2/bottom-0.10.2-1.x86_64.rpm
sudo rpm -i bottom-0.10.2-1.x86_64.rpm
```
### Gentoo
Available in the [official Gentoo repo](https://packages.gentoo.org/packages/sys-process/bottom):
```bash
sudo emerge --ask sys-process/bottom
```
### Nix
Available [in Nixpkgs](https://search.nixos.org/packages?channel=unstable&show=bottom&from=0&size=1&sort=relevance&type=packages) as `bottom`:
```bash
nix profile install nixpkgs#bottom
```
`bottom` can also be installed and configured through the [home-manager](https://nix-community.github.io/home-manager) module:
```nix
{
programs.bottom.enable = true;
}
```
### openSUSE
Available in openSUSE Tumbleweed:
```bash
zypper in bottom
```
### Snap
bottom is available as a [snap](https://snapcraft.io/install/bottom/ubuntu):
```bash
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
```
### Solus
Available [in the Solus repos](https://dev.getsol.us/source/bottom/):
```bash
sudo eopkg it bottom
```
### Void
Available [in the void-packages repo](https://github.com/void-linux/void-packages/tree/master/srcpkgs/bottom):
```bash
sudo xbps-install bottom
```
### Homebrew
Formula available [here](https://formulae.brew.sh/formula/bottom):
```bash
brew install bottom
```
### MacPorts
Available [here](https://ports.macports.org/port/bottom/):
```bash
sudo port selfupdate
sudo port install bottom
```
### Chocolatey
Chocolatey packages are located [here](https://chocolatey.org/packages/bottom):
```bash
choco install bottom
```
### Scoop
Available in the [Main bucket](https://github.com/ScoopInstaller/Main):
```bash
scoop install bottom
```
### winget
The winget package can be found [here](https://github.com/microsoft/winget-pkgs/tree/master/manifests/c/Clement/bottom):
```bash
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](https://github.com/ClementTsang/bottom/releases/latest)
and installing via the `.msi` file.
### Conda
You can install bottom using `conda` with [this conda-smithy repository](https://github.com/conda-forge/bottom-feedstock):
```bash
# Add the channel
conda config --add channels conda-forge
conda config --set channel_priority strict
# Install
conda install bottom
```
### Pre-built binaries
You can also use the pre-built release binaries:
- [Latest stable release](https://github.com/ClementTsang/bottom/releases/latest), built using the release branch
- [Latest nightly release](https://github.com/ClementTsang/bottom/releases/tag/nightly), built using the `main` branch at 00:00 UTC daily
To use, download and extract the binary that matches your system. You can then run by doing:
```bash
./btm
```
or by installing to your system following the procedures for installing binaries to your system.
#### Auto-completion
The release binaries in [the releases page](https://github.com/ClementTsang/bottom/releases) are packaged with
shell auto-completion files for Bash, Zsh, fish, Powershell, Elvish, Fig, and Nushell. To install them:
- For Bash, move `btm.bash` to `$XDG_CONFIG_HOME/bash_completion or /etc/bash_completion.d/`.
- For Zsh, move `_btm` to one of your `$fpath` directories.
- For fish, move `btm.fish` to `$HOME/.config/fish/completions/`.
- For PowerShell, add `_btm.ps1` to your PowerShell [profile]().
- For Elvish, the completion file is `btm.elv`.
- For Fig, the completion file is `btm.ts`.
- For Nushell, source `btm.nu`.
The individual auto-completion files are also included in the stable/nightly releases as `completion.tar.gz` if needed.
## 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 page](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 can be changed.
More details on configuration can be found [in the documentation](https://clementtsang.github.io/bottom/nightly/configuration/config-file/).
## Troubleshooting
If some things aren't working, give the [troubleshooting page](https://clementtsang.github.io/bottom/nightly/troubleshooting)
a look. If things still aren't working, then consider asking [a question](https://github.com/ClementTsang/bottom/discussions)
or filing a [bug report](https://github.com/ClementTsang/bottom/issues/new/choose) if you think it's a bug.
## 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
π»
Brian Di Palma
π
Lasha Kanteladze
π
Herby Gillot
π
Greg Brown
π»
TotalCaesar659
π
George Rawlinson
π π¦
adiabatic
π
Randy Barlow
π»
Patrick Jackson
π€ π
Mateusz MikuΕa
π»
Guillaume Gomez
π»
shura
π»
Wesley Moore
π»
xgdgsc
π
ViridiCanis
π»
Justin Martin
π» π
Diana
π»
Hervy Qurrotul Ainur Rozi
π
Mike Rivnak
π
lroobrou
π»
database64128
π»
Chon Sou
π»
DrSheppard
π
RareΘ Constantin
π»
felipesuri
π
spital
π»
Michael Bikovitsky
π»
Dmitry Valter
π»
Grace Stok
π»
Yuxuan Shui
π»
Wenqing Zong
π»
Gabriele Belluardo
π»
Zeb Piasecki
π»
wzy
π» π
john-s-lin
π
Lee Wonjoon
π» π
David Legrand
π
Michal BryxΓ
π
Raphael Erik Hviding
π»
CosmicHorror
π»
Ben Woods
π
Stephen Huan
π»
Jason Gwartz
π
llc0930
π»
Ada Ahmed
π»
Wateir
π
Andrey Alekseenko
π»
Fotis Gimian
π» π
Fernando Rodrigues
π
Matthew Toohey
π»
Julius Enriquez
π
Ben Brown
π»
Yuri Astrakhan
π» π
## 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](https://github.com/ClementTsang/bottom/blob/main/Cargo.toml),
[_many_ libraries](https://github.com/ClementTsang/bottom/blob/main/Cargo.lock), as well as many services and
programs, all built on top of the work of many talented people. bottom would not exist without all of this.
- And of course, thank you again to all contributors and package maintainers!
- I also really appreciate anyone who has used bottom, and those
who go out of their way to report bugs or suggest ways to improve things. I hope
it's been a useful tool for others.
- To those who support my work financially via donations, thank you so much.
- Also thanks to JetBrains for providing access to tools that I use to develop bottom
as part of their [open source support program](https://jb.gg/OpenSourceSupport).
