Repository files navigation

_{Demo using theGruvbox theme (--theme gruvbox), along withIBM Plex Mono andKitty}

• Features
• Support
  • Official
  • Unofficial
• Installation
  • Cargo
  • Alpine
  • Arch Linux
  • Debian / Ubuntu
  • Exherbo Linux
  • Fedora / CentOS / AlmaLinux / Rocky Linux
  • Gentoo
  • Nix
  • openSUSE
  • Snap
  • Solus
  • Void
  • gah
  • Homebrew
  • MacPorts
  • Chocolatey
  • Scoop
  • winget
  • Windows installer
  • Conda
  • Pre-built binaries
    • Auto-completion
• Usage
• Configuration
• Troubleshooting
• Contribution
  • Contributors
• Thanks

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

• And more!

You can find more details inthe documentation.

bottomofficially 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 outthe documentation.

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 (seehere 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 outthe documentation.

Installation viacargo can be done by installing thebottom crate:

# 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 usecargo install using the repo as the source.

# 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 installcurl -LO https://github.com/ClementTsang/bottom/archive/0.11.2.tar.gztar -xzvf 0.11.2.tar.gzcargo install --path. --locked# Option 2 - Manually clone the repo and installgit clone https://github.com/ClementTsang/bottomcd bottomcargo install --path. --locked# Option 3 - Install using cargo with the repo as the sourcecargo 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

bottom is available as apackage for Alpine Linux viaapk:

apk add bottom

Packages for documentation (bottom-doc) and completions for Bash (bottom-bash-completion), Fish (bottom-fish-completion), and Zsh (bottom-zsh-completion) are also available.

bottom is available as anofficial package that can be installed withpacman:

sudo pacman -S bottom

If you want the latest changes that are not yet stable, you can also installbottom-gitfrom the AUR:

# Using paruparu -S bottom-git# Using yayyay -S bottom-git

A.deb file is provided on eachstable release andnightly builds for x86, aarch64, and armv7.Some examples of installing it this way:

# x86-64curl -LO https://github.com/ClementTsang/bottom/releases/download/0.11.2/bottom_0.11.2-1_amd64.debsudo dpkg -i bottom_0.11.2-1_amd64.deb# ARM64curl -LO https://github.com/ClementTsang/bottom/releases/download/0.11.2/bottom_0.11.2-1_arm64.debsudo dpkg -i bottom_0.11.2-1_arm64.deb# ARMcurl -LO https://github.com/ClementTsang/bottom/releases/download/0.11.2/bottom_0.11.2-1_armhf.debsudo dpkg -i bottom_0.11.2-1_armhf.deb# musl-basedcurl -LO https://github.com/ClementTsang/bottom/releases/download/0.11.2/bottom-musl_0.11.2-1_amd64.debsudo dpkg -i bottom-musl_0.11.2-1_amd64.deb

bottom is available as arust package that can be installed withcave:

cave resolve -x repository/rustcave resolve -x bottom

bottom is available onCOPR:

sudo dnf coprenable atim/bottom -ysudo dnf install bottom

bottom is also available viaTerra:

sudo dnf install --repofrompath'terra,https://repos.fyralabs.com/terra$releasever' --setopt='terra.gpgkey=https://repos.fyralabs.com/terra$releasever/key.asc' terra-releasesudo dnf install bottom

.rpm files are also generated for x86 in thereleases page.For example:

curl -LO https://github.com/ClementTsang/bottom/releases/download/0.11.2/bottom-0.11.2-1.x86_64.rpmsudo rpm -i bottom-0.11.2-1.x86_64.rpm

Available in theofficial Gentoo repo:

sudo emerge --ask sys-process/bottom

Availablein Nixpkgs asbottom:

nix profile install nixpkgs#bottom

bottom can also be installed and configured through thehome-manager module:

{programs.bottom.enable=true;}

Available in openSUSE Tumbleweed:

zypperin bottom

bottom is available as asnap:

sudo snap install bottom# To allow the program to run as intendedsudo snap connect bottom:mount-observesudo snap connect bottom:hardware-observesudo snap connect bottom:system-observesudo snap connect bottom:process-control

Availablein the Solus repos:

sudo eopkg it bottom

Availablein the void-packages repo:

sudo xbps-install bottom

bottom can also be installed on Linux or macOS usinggah:

gah install bottom

Formula availablehere:

brew install bottom

Availablehere:

sudo port selfupdatesudo port install bottom

Chocolatey packages are locatedhere:

choco install bottom

Available in theMain bucket:

scoop install bottom

The winget package can be foundhere:

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

You can uninstall via Control Panel, Options, orwinget --uninstall bottom.

You can also manually install bottom as a Windows program by going to thelatest releaseand installing via the.msi file.

You can install bottom usingconda withthis conda-smithy repository:

# Add the channelconda config --add channels conda-forgeconda config --set channel_priority strict# Installconda install bottom

You can also use the pre-built release binaries:

• Latest stable release, built using the release branch
• Latest nightly release, built using themain branch at 00:00 UTC daily

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 the procedures for installing binaries to your system.

The release binaries inthe releases page are packaged withshell auto-completion files for Bash, Zsh, fish, Powershell, Elvish, Fig, and Nushell. To install them:

• For Bash, movebtm.bash to$XDG_CONFIG_HOME/bash_completion or /etc/bash_completion.d/.
• For Zsh, move_btm to one of your$fpath directories.
• For fish, movebtm.fish to$HOME/.config/fish/completions/.
• For PowerShell, add_btm.ps1 to your PowerShellprofile.
• For Elvish, the completion file isbtm.elv.
• For Fig, the completion file isbtm.ts.
• For Nushell, sourcebtm.nu.

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

You can run bottom usingbtm.

• For help on flags, usebtm -h for a quick overview orbtm --help for more details.
• For info on key and mouse bindings, press? inside bottom or refer to thedocumentation page.

You can find more information on usage in thedocumentation.

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 foundin the documentation.

If some things aren't working, give thetroubleshooting pagea look. If things still aren't working, then consider askinga questionor filing abug report if you think it's a bug.

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

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 💻📖	Kenichi Kamiya 💻	yahlia 💻	Bucket-Bucket-Bucket 💻	Marek Sierociński 📖

• This project is very much inspired bygotop,gtop, andhtop.

• This application was written withmany,many libraries, as well as many services andprograms, 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 thosewho go out of their way to report bugs or suggest ways to improve things. I hopeit'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 bottomas part of theiropen source support program.