The current version of broot works on linux, mac and windows (win 10+).

Note

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 the new PowerShell terminal and not the old cmd.exe which isn't supported.

Note

If you use cargo and there's a compilation error, it usually means you have an old version of the compiler, and you should update it (for example with rustup update).

From precompiled binaries

Binaries are made available at every release in download.

Direct links:

Target Files
Linux x86_64-linux
Linux/musl x86_64-unknown-linux-musl
Raspberry armv7-unknown-linux-gnueabihf
Windows 10+ x86_64-pc-windows-gnu
Shell completion completion/

You may download previous releases 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.

From crates.io

You'll need to have the Rust development environment installed.

Once it's installed, use cargo to install broot:

cargo install broot

From source

You'll need to have the Rust development environment installed.

Fetch the Canop/broot repository, move to the broot directory, then run

cargo install --path .

If you want a custom compilation, have a look at the optional features documentation.

Homebrew

If you're using homebrew, you can use the brew install command:

brew install broot

note: the brew formula is maintained by a third party and may be less up to date.

APT / Deb

Ubuntu and Debian users may use this apt repository: https://packages.azlux.fr/

note: this repository is also maintained by a third party.


Now you should install the br shell function.