



Index
News
C++ Version
18 September 2021

The Linux version of btop++ is complete. Released as version 1.0.0
Get it at https://github.com/aristocratos/btop
The development plan right now:
- 1.1.0 Mac OsX support
- 1.2.0 FreeBSD support
- 1.3.0 Support for GPU monitoring
- 1.X.0 Other platforms and features...
2 May 2021
I've started work on the third iteration of bashtop->bpytop.
It's being written in C++ and will simply be called btop
.
I'm aiming at releasing a beta version around August this year and will publish the repo when I've got the core functionality and structure ready for anybody that wanna help out.
This project is gonna take some time until it has complete feature parity with bpytop, since all system information gathering will likely have to be written from scratch without any external libraries.
And will need some help in the form of code contributions to get complete support for BSD and OSX.
If you got suggestions of C++ libraries that are multi-platform and are as extensive as psutil are for python, feel free to open up a new thread in Discussions, it could help speed up the development a lot.
Will post any updates about this project here until the repo is made available.
Documents
Description
Resource monitor that shows usage and stats for processor, memory, disks, network and processes.
Python port and continuation of bashtop.
Features
- Easy to use, with a game inspired menu system.
- Full mouse support, all buttons with a highlighted key is clickable and mouse scroll works in process list and menu boxes.
- Fast and responsive UI with UP, DOWN keys process selection.
- Function for showing detailed stats for selected process.
- Ability to filter processes, multiple filters can be entered.
- Easy switching between sorting options.
- Send SIGTERM, SIGKILL, SIGINT to selected process.
- UI menu for changing all config file options.
- Auto scaling graph for network usage.
- Shows message in menu if new version is available
- Shows current read and write speeds for disks
Themes
Bpytop uses the same theme files as bashtop so any theme made for bashtop will work.
See themes folder for available themes.
The make install
command places the default themes in /usr/local/share/bpytop/themes
.
If installed with pip3
the themes will be located in a folder called bpytop-themes
in the python3 site-packages folder.
User created themes should be placed in $HOME/.config/bpytop/themes
.
Let me know if you want to contribute with new themes.
Support and funding
You can sponsor this project through github, see my sponsors page for options.
Or donate through paypal or ko-fi.
Any support is greatly appreciated!
Prerequisites
Mac Os X
Will not display correctly in the standard terminal (unless truecolor is set to False)!
Recommended alternative iTerm2
Will also need to be run as superuser to display stats for processes not owned by user.
OsX on Apple Silicon (arm) requires psutil version 5.8.0 to work and currently has no temperature monitoring.
Upgrade psutil with sudo pip3 install psutil --upgrade
Linux, Mac Os X and FreeBSD
For correct display, a terminal with support for:
- 24-bit truecolor (See list of terminals with truecolor support)
- 256-color terminals are supported through 24-bit to 256-color conversion when setting "truecolor" to False in the options or with "-lc/--low-color" argument.
- Wide characters (Are sometimes problematic in web-based terminals)
Also needs a UTF8 locale and a font that covers:
- Unicode Block “Braille Patterns” U+2800 - U+28FF
- Unicode Block “Geometric Shapes” U+25A0 - U+25FF
- Unicode Block "Box Drawing" and "Block Elements" U+2500 - U+259F
Notice (Text rendering issues)
If you are having problems with the characters in the graphs not looking like they do in the screenshots,
it's likely a problem with your systems configured fallback font not having support for braille characters.
See Terminess Powerline for an example of a font that includes the braille symbols.
See comments by @sgleizes link and @XenHat link in issue #100 for possible solutions.
If text are misaligned and you are using Konsole or Yakuake, turning off "Bi-Directional text rendering" is a possible fix.
Characters clipping in to each other or text/border misalignments is not bugs caused by bpytop, but most likely a fontconfig or terminal problem where the braille characters making up the graphs aren't rendered correctly.
Look to the creators of the terminal emulator you use to fix these issues if the previous mentioned fixes don't work for you.
Notice (SSH)
Dropbear seems to not be able to set correct locale. So if accessing bpytop over ssh, OpenSSH is recommended.
Dependencies
Python3 (v3.7 or later)
psutil module (v5.7.0 or later)
Optionals for additional stats
(Optional OSX) coretemp (recommended), or osx-cpu-temp (less accurate) needed to show CPU temperatures.
Screenshots
Main UI showing details for a selected process.

Main UI in mini mode.

Main menu.

Options menu.

Installation
I only maintain the PyPi package, so will not take responsibility for issues caused by any other install method!
PyPi (will always have latest version)
Install or update to latest version
pip3 install bpytop --upgrade
Mac OsX
Install with Homebrew
brew install bpytop
Optional coretemp (Shows temperatures for cpu cores)
brew install hacker1024/hacker1024/coretemp
Alternatively install with MacPorts
port install bpytop
OsX on Apple Silicon (arm) requires psutil version 5.8.0 to work and currently has no temperature monitoring.
Upgrade psutil with sudo pip3 install psutil --upgrade
Arch Linux
Available in the Arch Linux [community] repository as bpytop
Installation
sudo pacman -S bpytop
Debian based
Available in official Debian repository since Debian 11
Installation
sudo apt install bpytop
Available for debian/ubuntu from Azlux's repository
FreeBSD package
Available in FreeBSD ports
Install pre-built package
sudo pkg install bpytop
Fedora/CentOS 8 package
Available in the Fedora and EPEL-8 repository.
Installation
sudo dnf install bpytop
Gentoo / Calculate Linux
Available from adrien-overlay
Installation
sudo emerge -av sys-process/bpytop
Mageia Cauldron (Mageia 8)
Available in Mageia Cauldron and then Mageia 8 when it is released.
Installation
sudo urpmi bpytop
sudo dnf install bpytop
MX Linux
Available in the MX Test Repo as bpytop
Please use MX Package Installer MX Test Repo tab to install.
http://mxrepo.com/mx/testrepo/pool/test/b/bpytop/
Void Linux
Available in void repo and void-packages ports tree
Installation
sudo xbps-install bpytop
Snap package
(Note! There is some issues caused by the snap sandboxing)
by @kz6fittycent
https://github.com/kz6fittycent/bpytop-snap
Install the package
sudo snap install bpytop
The config folder will be located in ~/snap/bpytop/current/.config/bpytop
Manual installation
Dependencies installation Linux
Install python3 and git with a package manager of you choice
Install psutil python module (sudo might be required)
python3 -m pip install psutil
Dependencies installation OSX
Install homebrew if not already installed
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
Install python3 if not already installed
brew install python3 git
Install psutil python module
python3 -m pip install psutil
Install optional dependency coretemp (recommended), or osx-cpu-temp (less accurate)
brew install hacker1024/hacker1024/coretemp
brew install osx-cpu-temp
Dependencies installation FreeBSD
Install with pkg and pip
sudo pkg install git python3 py37-psutil
Manual installation Linux, OSX and FreeBSD
Clone and install
git clone https://github.com/aristocratos/bpytop.git
cd bpytop
sudo make install
to uninstall it
sudo make uninstall
Configurability
All options changeable from within UI.
Config files stored in "$HOME/.config/bpytop" folder
bpytop.cfg: (auto generated if not found)
"/etc/bpytop.conf" will be used as default seed for config file creation if it exists. ("/usr/local/etc/bpytop.conf" on BSD)
color_theme="monokai"
theme_background=False
truecolor=True
shown_boxes="cpu mem net proc"
update_ms=2000
proc_update_mult=2
proc_sorting="cpu lazy"
proc_reversed=False
proc_tree=False
tree_depth=3
proc_colors=True
proc_gradient=True
proc_per_core=False
proc_mem_bytes=True
cpu_graph_upper="total"
cpu_graph_lower="total"
cpu_invert_lower=True
cpu_single_graph=False
show_uptime=True
check_temp=True
cpu_sensor=Auto
show_coretemp=True
temp_scale="celsius"
show_cpu_freq=True
draw_clock="%H:%M"
background_update=True
custom_cpu_name=""
disks_filter="exclude=/boot"
mem_graphs=True
show_swap=True
swap_disk=True
show_disks=True
only_physical=True
use_fstab=True
show_io_stat=True
io_mode=False
io_graph_combined=False
io_graph_speeds=""
net_download="100Mbit"
net_upload="100Mbit"
net_auto=True
net_sync=False
net_color_fixed=False
net_iface="br0"
show_battery=True
show_init=False
update_check=True
log_level=DEBUG
Command line options:
usage: bpytop.py [-h] [-b BOXES] [-lc] [-v] [--debug]
optional arguments:
-h, --help show this help message and exit
-b BOXES, --boxes BOXES
which boxes to show at start, example: -b "cpu mem net proc"
-lc, --low-color disable truecolor, converts 24-bit colors to 256-color
-v, --version show version info and exit
--debug start with loglevel set to DEBUG overriding value set in config
LICENSE
Apache License 2.0