CheatPress

broot Tree navigator

Version 1.61.0 · source

broot, Postcard, light preview Light · Postcard 102 × 152 mm · PDF broot, Postcard, dark preview Dark · Postcard 102 × 152 mm · PDF broot, Postcard, ink saver preview Ink saver · Postcard 102 × 152 mm · PDF
broot, A5, light preview Light · A5 148 × 210 mm · PDF broot, A5, dark preview Dark · A5 148 × 210 mm · PDF broot, A5, ink saver preview Ink saver · A5 148 × 210 mm · PDF
broot, A4, light preview Light · A4 210 × 297 mm · PDF broot, A4, dark preview Dark · A4 210 × 297 mm · PDF broot, A4, ink saver preview Ink saver · A4 210 × 297 mm · PDF
broot, A4 landscape, light preview Light · A4 landscape 297 × 210 mm · PDF broot, A4 landscape, dark preview Dark · A4 landscape 297 × 210 mm · PDF broot, A4 landscape, ink saver preview Ink saver · A4 landscape 297 × 210 mm · PDF
broot, A3, light preview Light · A3 297 × 420 mm · PDF broot, A3, dark preview Dark · A3 297 × 420 mm · PDF broot, A3, ink saver preview Ink saver · A3 297 × 420 mm · PDF
broot, A3 landscape, light preview Light · A3 landscape 420 × 297 mm · PDF broot, A3 landscape, dark preview Dark · A3 landscape 420 × 297 mm · PDF broot, A3 landscape, ink saver preview Ink saver · A3 landscape 420 × 297 mm · PDF
broot, Letter, light preview Light · Letter 8.5 × 11 in · PDF broot, Letter, dark preview Dark · Letter 8.5 × 11 in · PDF broot, Letter, ink saver preview Ink saver · Letter 8.5 × 11 in · PDF
broot, Tabloid, light preview Light · Tabloid 11 × 17 in · PDF broot, Tabloid, dark preview Dark · Tabloid 11 × 17 in · PDF broot, Tabloid, ink saver preview Ink saver · Tabloid 11 × 17 in · PDF

Start here

br
Start broot (shell function)
<letters>
Fuzzy-filter the tree
Enter
Open file / focus directory
Alt+Enter
Leave and cd to directory
Esc
Clear filter / go back
?
Open the help screen
:cp <path>
Copy the selection
Ctrl+q
Quit

Concepts

  1. Pattern letters, /regex, c/text
  2. Tree selected line
  3. Verb :cp, :rm, :e
  4. Selection file or staged set
Every keystroke in the input is one of these

Launch

br
Start broot in the current directory
br <path>
Start in another directory, or preview a file
br -s
Show sizes
br -h
Show hidden files
br -i
Show git-ignored files
br -d
Show last-modified dates
br -p
Show permissions, owner and group
br -sdp
Use as an ls replacement
Flags combine; an uppercase flag (-S, -H, -I) turns the setting off.
br -w
Whale mode: find what eats disk space
br -f
Show folders only
br -g
Show git status of files
br -gg
Only files with a git status
br -c "<cmds>"
Run commands as if typed, separated by ;
broot --install
(Re)install the br shell function
Arrows
Move the selection
Enter
Open file / make directory the root
Alt+Enter
Leave broot, cd the shell to the directory
Needs the br function. On a file it leaves broot and opens the file.
Esc
Clear input / return to previous state / quit
?
Show help and config file location
Ctrl+q
Quit
:parent
Focus the parent directory
:focus <path>
Make a directory the root
:focus ~
Jump to your home directory
Ctrl+s
Search the whole tree / restore last pattern
Alt+h
Toggle hidden files
Alt+i
Toggle git-ignored files
<letters>
Fuzzy match on sub-path from the root
n/<text>
Fuzzy match on file name only
e/<text>
Exact match on file name
/<regex>
Regex on file name
/<regex>/i
Case-insensitive regex
c/<text>
Files containing text
rc/<regex>
Files whose content matches regex
!<pattern>
Negate a pattern
<a>&<b>
Both patterns must match
<a>|<b>
Either pattern matches

View

:sort
Cycle sort: date, count, size, type
Press Tab after :sort to rotate through the options.
:size
Toggle sizes
:dates
Toggle dates
:perm
Toggle permissions
:gf
Toggle git status per file
:gs
Show only files git sees as changed
:gd
Diff the selected file
:fs
Show filesystems and disk usage

Files

:e
Edit file in your editor
Opens at the matching line after a content search.
:cp <path>
Copy the selection
:mv <path>
Move the selection
:rm
Delete the selection
:trash
Send the selection to the trash
:rename
Rename (F2), pre-filled with current name
:md <name>
Create a directory (slashes allowed)
:restore_trashed_file
Put a trashed file back

Panels and staging

Ctrl+Right
Open or focus the panel on the right
Alt+Right on macOS. Right on a file focuses its preview.
Ctrl+Left
Open or focus the left panel
Ctrl+w
Close the current panel
:focus! <path>
Open a directory in a new panel
A trailing or leading ! sends any verb's result to a new panel.
:cpp
Copy selection to the other panel
:mvp
Move selection to the other panel
Ctrl+g
Stage or unstage the selection
Ctrl+a
Stage all files of the left panel
:cls
Clear the staging area
:preview_diff
Preview the git diff of a file

Output and config

:pt
Print the tree to stdout and quit
:print_path
Print the selected path and quit
br --cmd ":pt" > <file>
Export the tree to a file
conf.hjson
Config file in ~/.config/broot
TOML works too (conf.toml). Press ? in broot to see the exact path.
default_flags: "-gh"
Always start with these launch flags

Recipes

Open a file in nvim from broot
# conf.hjsonverbs: [  {    invocation: edit    key: Enter    shortcut: e    external: "nvim +{line} {file}"    apply_to: text_file    leave_broot: false  }]
Deep cd with a pattern
# bash/zsh, in your rc filefunction dcd { br --only-folders --cmd "$1;:cd"; }dcd <pattern>
Replace tree
function tree { br -c :pt "$@"; }tree -s ~/projects
Review a repo's changes
br -ghc :gs# select a file, then# :gd to see its diff# Esc to return to the full tree