Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
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: 7 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 (about 5 years ago)
Default Branch: main
Last Pushed: 2024-04-13T22:26:33.000Z (7 months ago)
Last Synced: 2024-04-13T23:09:46.354Z (7 months ago)
Topics: bottom, btm, cli, cross-platform, monitoring, rust, terminal, top, tui
Language: Rust
Homepage: https://clementtsang.github.io/bottom
Size: 66.7 MB
Stars: 8,784
Watchers: 38
Forks: 210
Open Issues: 92
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)





  

  

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

  



## Table of contents 

- [Features](#features)

- [Support](#support)

  - [Official](#official)

  - [Unofficial](#unofficial)

- [Installation](#installation)

  - [Cargo](#cargo)

  - [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)

  - [Snap](#snap)

  - [Solus](#solus)

  - [Void](#void)

  - [Homebrew](#homebrew)

  - [MacPorts](#macports)

  - [Chocolatey](#chocolatey)

  - [Scoop](#scoop)

  - [winget](#winget)

  - [Windows installer](#windows-installer)

  - [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, if 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 for

# better CPU-specific optimizations. For example:

RUSTFLAGS="-C target-cpu=native" cargo install --path . --locked

```

### 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

sudo paru -S bottom-git

# Using yay

sudo 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 the nix-community repo](https://github.com/nix-community/home-manager/blob/master/modules/programs/bottom.nix):

```bash

nix-env -i 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.

### 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 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](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 one can change as appropriate.

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 opening [a question](https://github.com/ClementTsang/bottom/discussions)

or filing a [bug report](https://github.com/ClementTsang/bottom/issues/new/choose).

## 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
💻

      
_{Zeb Piasecki}
💻

      
_{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}
💻

      
_{Twan 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
💻

    

  

## 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, _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!