No description
Find a file
ClementTsang d7536faf10 other: bump codecov to 30%
Since codecov is just used as a basic overview of test metrics,
I just set the threshold to something somewhat high.

Also removed codecov from README as it's not really representative of
much.
2022-06-24 17:08:45 -04:00
.cargo other: Comment out cross ARM targets (#376) 2020-12-26 16:24:06 -05:00
.cargo-husky/hooks other: add fmt to husky hook (#731) 2022-05-16 21:26:20 -04:00
.github docs: some small updates to README and issue templates 2022-06-05 18:29:14 -04:00
assets docs: migrate documentation over to mkdocs (#506) 2021-06-21 01:40:58 -04:00
deployment ci: add extra field to choco template 2022-02-02 23:31:35 -05:00
docs docs: bump mkdocs-material to 8.3.5 (#751) 2022-06-15 03:46:48 -04:00
sample_configs other: update default config file (#561) 2021-07-25 20:17:03 -04:00
src docs: re-enable lib docs for development purposes (#750) 2022-06-14 18:31:32 -04:00
tests other: add test for battery flag if battery feature is off 2022-05-01 17:15:54 -04:00
.all-contributorsrc docs: add shurizzle as a contributor for code (#677) 2022-02-22 06:29:48 -05:00
.gitignore docs: Fix some missing text in docs 2021-06-21 02:03:10 -04:00
.markdownlint.json docs: Touch up some photos (#511) 2021-06-21 22:35:19 -04:00
build.rs deployment: add aarch64/armv7 gnu .deb generation (#739) 2022-05-28 16:14:25 -04:00
Cargo.lock deps: migrate to starship-battery (#724) 2022-05-06 17:16:57 -04:00
Cargo.toml docs: re-enable lib docs for development purposes (#750) 2022-06-14 18:31:32 -04:00
CHANGELOG.md bug: fix choosing an out of list bounds selecting the last entry (#717) 2022-04-28 22:39:33 -04:00
clippy.toml refactor: rewrite column algorithm (#227) 2020-09-09 21:51:52 -04:00
codecov.yml other: bump codecov to 30% 2022-06-24 17:08:45 -04:00
CONTRIBUTING.md docs: revert CFP for now (#633) 2021-12-19 15:42:22 -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: bump codecov to 30% 2022-06-24 17:08:45 -04:00
rustfmt.toml other: remove redundant line in rustfmt 2021-10-02 21:32:27 -04: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 GIF 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

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

Installation via cargo is done by installing the bottom crate:

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

cargo install bottom --locked

# Alternatively, --locked may be omitted if you wish to not used locked dependencies:
cargo install bottom

Arch Linux

There is an official package that can be installed with pacman:

sudo pacman -Syu bottom

Debian/Ubuntu

A .deb file is provided on each release (currently only for x86-64):

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

For ARM (aarch64 and armv7), .deb builds are currently available for the 0.6.8 release and nightly builds.

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

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 install 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.8

winget

You can find the packages here:

winget install bottom

# Alternatively
winget install Clement.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.

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.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:

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.

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 asking a question by 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

💻 📦

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

💻

shura

💻

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!