broot(1)

📦
version 1.62.0 · 8 versions
, in arch rolling

💖 broot(1) — the broot manual page, but make it make sense 💖

okay bestie, welcome to the broot manpage, aka the broot manpage. yes that's the manual name, we're keeping it, don't come for me. this is the whole thing, every flag, every default, every warning — just with actual personality. pull up a chair. 🎀

✨ NAME ✨

broot — Tree view, file manager, configurable launcher</p>. that's the whole vibe. it's giving "file explorer but make it fashion". 💅

🌸 SYNOPSIS 🌸

broot [flags] [options] [path]
br [flags] [options] [path]

two ways in, same energy. broot is the main character, br is the cool nickname you actually use. 🦋

💜 DESCRIPTION 💜

broot lets you explore file hierarchies with a tree-like view, manipulate files, launch actions, and define your own shortcuts. like, literally all of it. your filesystem but it's a whole aesthetic. 🌈

okay so this is the important bit 👇 broot is best launched as br: that shell function gives you access to more commands, especially cd. the way that cd just works?? iconic. and the br shell function is interactively installed on first broot launch — so it just shows up and asks you nicely. no cap. 🫶

Flags and options can be classically passed on launch but also written in the configuration file. and here's the slay part: each flag has a counter-flag so you can cancel, at the command line, a flag which has been set in the configuration file. so if your config says yes but today you say no? you win. periodt. 👑

⭐ FLAGS ⭐

💀 FLAGS 💀

okay there's a lot, but they're all here, I promise. no skipping, we don't do that here. 💖

  • -d, --dates — show the last modified date of files and directories. timestamps are lowkey everything. 🕐
  • -D, --no-dates — don't show the last modified date. the counter-flag of the above, bestie.
  • -f, --only-folders — only show folders. files? not invited to this party. 🙈
  • -F, --no-only-folders — show folders and files alike. everyone's welcome again.
  • --show-root-fs — show filesystem info on top. lil info bar, cute.
  • -g, --show-git-info — show git statuses on files and stats on repo. git girlies rise. 🔥
  • -G, --no-show-git-info — don't show git statuses on files and stats on repo. the off switch, fr fr.
  • --git-status — only show files having an interesting git status, including hidden ones. note that "interesting" — it's a whole vibe check for your working tree.
  • --help — print help information. the original "help me help you". 💀
  • -h, --hidden — show hidden files. the dotfiles are coming out tonight. 👀
  • -H, --no-hidden — don't show hidden files.
  • -i, --git-ignored — show git ignored files. yes, the ones in .gitignore. we're being brave today.
  • -I, --no-git-ignored — don't show git ignored files.
  • -p, --permissions — show permissions. rwxr-xr-x my beloved. 🔐
  • -P, --no-permissions — don't show permissions.
  • -s, --sizes — show the size of files and directories.
  • -S, --no-sizes — don't show sizes.
  • --sort-by-count — sort by count (only show one level of the tree). one level only, we're keeping it shallow. 🌊
  • --sort-by-date — sort by date (only show one level of the tree).
  • --sort-by-size — sort by size (only show one level of the tree).
  • --sort-by-type — same as --sort-by-type-dirs-first. an alias, a shortcut, a lil treat. 🎀
  • --sort-by-type-dirs-first — sort by type, directories first (only show one level of the tree).
  • --sort-by-type-dirs-last — sort by type, directories last (only show one level of the tree).
  • -w, --whale-spotting — sort by size, show ignored and hidden files. big files get the spotlight, ignored and hidden ones included. 🐋 iconic name, honestly.
  • --no-sort — don't sort.
  • -t, --trim-root — trim the root too and don't show a scrollbar.
  • -T, --no-trim-root — don't trim the root level, show a scrollbar.
  • *--outcmd=OUTCMD* — where to write the produced cmd (if any).
  • *-c, --cmd=CMD* — semicolon separated commands to execute.
  • --color=COLOR [default: auto] — whether to have styles and colors (default is usually OK). possible values: auto, yes, no. leave it alone and it's usually fine ✨
  • *--conf=CONF* — semicolon separated paths to specific config files.
  • *--height=HEIGHT* — height (if you don't want to fill the screen or for file export).
  • --install — install or reinstall the br shell function.
  • *--set-install-state=SET_INSTALL_STATE* — where to write the produced cmd (if any). possible values: undefined, refused, installed. yes, that's exactly what the manpage says it does. we report, we don't explain. 🙈
  • *--print-shell-function=PRINT_SHELL_FUNCTION* — print to stdout the br function for a given shell.
  • *--listen=LISTEN* — a socket to listen to for commands.
  • --get-root — ask for the current root of the remote broot.
  • *--write-default-conf=WRITE_DEFAULT_CONF* — write default conf files in given directory.
  • *--send=SEND* — a socket that broot sends commands to before quitting.
  • -V, --version — print version. hiii what version are you 👋

🦋 BUGS 🦋

gn, some real talk. 🫶

broot is known to be slow on most Windows installations. not a vibe, but it's true and we're saying it.

On unix and mac platforms, most problems you may encounter are related to some terminals or terminal multiplexers which either intercepts some standard TTY instructions or break buffering or size querying. so it's not you, it's the terminal, but also kind of the terminal. 😭 the list of shortcuts you can define in the config file is thus dependent of your system. important! iykyk.

🌸 AUTHOR 🌸

broot is free and open-source and is written by denys.seguret@gmail.com. the source code and documentation are available at https://dystroy.org/broot. go say hi, go read the docs, go be a main character. 👑

<div align="center">🎀 ✨ 🎀</div>

and that's the whole page bestie, no cap, every single flag accounted for. this was the broot manpage, version 1.62.0, served fresh in the broot(1) section of your friendly neighbourhood manual. mwah. 💖💅🦋

📦 where this page comes from