broot works on linux, mac and windows (win 10+).
Current version: download
Windows users
broot may need additional rights at first use in order to write its configuration file. Some users on Windows also report problems with the colon; remember that a space can be used instead of a colon. You should also use a modern terminal, for example the new Microsoft one
Precompiled binaries
Binaries are made available at every release in download.
The archives there contain precompiled binaries, as well as the licenses and other files.
You may also directly download the executable files below, depending on your system:
| Target | Details | Clipboard | Download |
|---|---|---|---|
| x86-64 Linux | Intel/AMD, needs a recent enough linux | yes | x86_64-linux |
| x86-64 Linux old glibc | Intel/AMD, compatible with older glibc | no | x86_64-unknown-linux-gnu |
| x86-64 Linux musl | Intel/AMD, very compatible | no | x86_64-unknown-linux-musl |
| ARM32 Linux | no | armv7-unknown-linux-gnueabihf | |
| ARM32 Linux musl | no | armv7-unknown-linux-musleabi | |
| ARM64 Linux | no | aarch64-unknown-linux-gnu | |
| ARM64 Linux musl | no | aarch64-unknown-linux-musl | |
| Windows | Intel/AMD 64 Windows 10+ | yes | x86_64-pc-windows-gnu |
Shell completion scripts: completion
All releases are also available on GitHub releases.
When you download executable files, you'll have to ensure the shell can find them. An easy solution on linux is for example to put them in /usr/local/bin. You may also have to set them executable using chmod +x broot.
As I can't compile myself for all possible systems, you'll need to compile broot yourself or use a third-party repository (see below) if your system isn't in the list above.
From crates.io
Dependencies
You'll need to have the Rust development environment installed and up to date.
The main cause of compilation error is an outdated rust compiler. Try updating it with rustup update.
You may also have problems compiling if you're missing dependencies. Here's how to install them on several distributions:
Debian, Ubuntu:
sudo apt install build-essential libxcb1-dev libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev -y
Fedora, Centos, Red Hat:
sudo dnf install libxcb -y
openSUSE:
sudo zypper --non-interactive install xorg-x11-util-devel libxcb-composite0 libxcb-render0 libxcb-shape0 libxcb-xfixes0
Arch Linux:
sudo pacman -Syu --noconfirm libxcb
Broot installation
Once you have rust and dependencies installed, use cargo to install broot:
cargo install --locked broot
or, for clipboard support:
cargo install --locked --features clipboard broot
From source
As for installing from crates.io, you'll need rust and other dependencies first.
Fetch the Canop/broot repository, move to the broot directory, then run
cargo install --locked --path .
If you want a custom compilation, have a look at the optional features documentation. The most common feature is the "clipboard" one:
cargo install --locked --features clipboard --path .
Third party repositories
Those packages are maintained by third parties and may be less up to date.
Homebrew
brew install broot
MacPorts
sudo port selfupdate
sudo port install broot
Scoop
scoop install broot
Alpine Linux
apk add broot
note: broot package is available in Alpine 3.13 and newer
APT / Deb
Ubuntu and Debian users may use this apt repository: https://packages.azlux.fr/
NetBSD
pkgin install broot
Gentoo Linux
emerge broot
Reinstall
To reinstall, just change the executable.
It's always been compatible with the previous configuration files but if your previous installation is old (especially if it's pre 1.14), you might want to get the new configuration files which have more relevant sections.
The simplest solution is to remove your old configuration directory (or rename if you want to keep things) so that broot recreates it.
After installation
Now you should
- install the br shell function
- have a look at the verbs.hjson configuration file, and especially setup the editor of your choice