2401e583fb
This consolidates all the time graph drawing to one main location, as well as some small improvements. This is helpful in that I don't have to reimplement the same thing across three locations if I have to make one change that in theory should affect them all. In particular, the CPU graph, memory graph, and network graph are all now using the same, generic implementation for drawing, which we call (for now) a component. Note this only affects drawing - it accepts some parameters affecting style and labels, as well as data points, and draw similarly to how it used to before. Widget-specific actions, or things affecting widget state, should all be handled by the widget-specific code instead. For example, our current implementation of x-axis autohide is still controlled by the widget, not the component, even if some of the code is shared. Components are, again, only responsible for drawing (at least for now). For that matter, the graph component does not have mutable access to any form of state outside of tui-rs' `Frame`. Note this *might* change in the future, where we might give the component state. Note that while functionally, the graph behaviour for now is basically the same, a few changes were made internally other than the move to components. The big change is that rather than using tui-rs' `Chart` for the underlying drawing, we now use a tweaked custom `TimeChart` tui-rs widget, which also handles all interpolation steps and some extra customization. Personally, I don't like having to deviate from the library's implementation, but this gives us more flexibility and allows greater control. For example, this allows me to move away from the old hacks required to do interpolation (where I had to mutate the existing list to avoid having to reallocate an extra vector just to insert one extra interpolated point). I can also finally allow customizable legends (which will be added in the future). |
||
---|---|---|
.cargo | ||
.cargo-husky/hooks | ||
.github | ||
assets | ||
deployment | ||
docs | ||
sample_configs | ||
src | ||
tests | ||
.all-contributorsrc | ||
.gitignore | ||
.markdownlint.json | ||
build.rs | ||
Cargo.lock | ||
Cargo.toml | ||
CHANGELOG.md | ||
clippy.toml | ||
codecov.yml | ||
CONTRIBUTING.md | ||
LICENSE | ||
README.md | ||
rustfmt.toml |
bottom
A customizable cross-platform graphical process/system monitor for the terminal.
Supports Linux, macOS, and Windows. Inspired by gtop, gotop, and htop.
Demo GIF using the Gruvbox theme (--color gruvbox
), along with IBM Plex Mono and Kitty
Features
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:
-
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 flags or a config file, such as:
- Custom and pre-built colour themes
- Changing the default behaviour of some widgets
- Changing the layout of widgets
- Filtering out entries in disk and temperature widgets
-
Some other nice stuff, like:
-
And more!
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:
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
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. Since validation of the package takes time, it may take a while to become available after a release.
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
.
Manually
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:
- Latest stable release, generated off of the release branch
- Latest nightly release, generated daily off of the master branch at 00:00 UTC
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 orbtm --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.
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:
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!