Need help with broot?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

6.2K Stars 151 Forks MIT License 1.2K Commits 84 Opened issues


A new way to see and navigate directory trees :

Services available


Need anything else?

Contributors list


CI MIT Latest Version Chat on Miaou

A better way to navigate directories

Installation Instructions

Get an overview of a directory, even a big one

br -s


Notice the unlisted?

That's what makes it usable where the old

command would produce pages of output.

files are properly dealt with to put unwanted files out of your way (you can ignore them though, see documentation).

Find a directory then
to it

type a few letters


Hit altenter and you're back to the terminal in the desired location.

This way, you can navigate to a directory with the minimum amount of keystrokes, even if you don't exactly remember where it is.

broot is fast and doesn't block (any keystroke interrupts the current search to start the next one).

Most useful keys for this:

  • the letters of what you're looking for
  • enter on the root line to go up to the parent (staying in broot)
  • enter to focus a directory (staying in broot)
  • esc to get back to the previous state or clear your search
  • and may be used to move the selection
  • altenter to get back to the shell having
    to the selected directory
  • :q
    if you just want to quit (you can use ctrlq if you prefer)

Never lose track of file hierarchy while you search


broot tries to select the most relevant file. You can still go from one match to another one using tab or arrow keys.

You may also search with a regular expression. To do this, add a

before the pattern.

And you have other types of searches, for example searching on file content (start with


content search

You may also apply logical operators or combine patterns, for example searching

in all files except json ones could be
and searching
both in file names and file contents would be

Once the file you want is selected you can

  • hit enter (or double-click) to open it in your system's default program
  • hit altenter to open it in your system's default program and close broot
  • hit ctrl to preview it (and then a second time to go inside the preview)
  • type a verb. For example
    opens the file in your preferred editor (which may be a terminal one)

blog: a broot content search workflow

Manipulate your files


Most often you move your files in the blind. You do a few

before, then your manipulation, and maybe you check after.

You can instead do it without losing the view of the file hierarchy.

Move, copy, rm, mkdir, are built in and you can add your own shortcuts.

Manage files with panels

When a directory is selected, do ctrl and you open another panel (you may open other ones, or navigate between them, with ctrl and ctrl).

custom colors tree

(yes, colors are fully customizable)

Using two panels, you can for example copy or move elements between them:


If you like you may do it Norton Commander style by binding

to F5 and
to F6.

Preview files

Hit ctrl when a file is selected and the preview panel appears.



The preview panel stays synchronized with the selection in tree panels.

If your terminal is kitty, then the image preview is high definition:

kitty preview

Apply a standard or personal shortcut to a file


Just find the file you want to edit with a few keystrokes, type

, then enter.

You can add verbs or configure the existing ones; see documentation.

And you can add shortcuts, for example a ctrl sequence or a function key

(and its clones):

If you want to display sizes, dates and permissions, do

br -sdp
which gets you this:

replace ls

You may also toggle options with a few keystrokes while inside broot. For example hitting a space, a

then enter shows you the dates. Or a space, then
then enter and you see hidden files.

Sort, see what takes space:

You may sort by launching broot with

. Or you may, inside broot, type a space, then
, and enter and you toggled the

When sorting, the whole content of directories is taken into account. So if you want to find on Monday morning the most recently modified files, launch

br --sort-by-date ~

If you start broot with the

option (or its shortcut
), you get a mode tailored to "whale spotting" navigation, making it easy to determine what files or folders take space.


And you keep all broot tools, like filtering or the ability to delete or open files and directories.

If you hit

, you can check the usage of all filesystems, so that you focus on cleaning the full ones.


Sizes, dates, files counts, are computed in the background, you don't have to wait for them when you navigate.

check git statuses:



to display the statuses of files (what are the new ones, the modified ones, etc.), the current branch name and the change statistics.

And if you want to see only the files which would be displayed by the

git status
command, do
. From there it's easy to edit, or diff, selected files.

blog: use broot and meld to diff before commit

Further Reading

See Broot's web site for instructions regarding installation and usage.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.