{
"name": "broot",
"description": "Broot lets you explore file hierarchies with a tree-like view, manipulate files, launch actions, and define your own shortcuts. broot is best launched as br: this shell function gives you access to mo",
"options": [
{
"names": [
"--dates",
"-d"
],
"description": "Show the last modified date of files and directories"
},
{
"names": [
"--no-dates",
"-D"
],
"description": "Don't show the last modified date"
},
{
"names": [
"--only-folders",
"-f"
],
"description": "Only show folders"
},
{
"names": [
"--no-only-folders",
"-F"
],
"description": "Show folders and files alike"
},
{
"names": [
"--show-root-fs"
],
"description": "Show filesystem info on top"
},
{
"names": [
"--show-git-info",
"-g"
],
"description": "Show git statuses on files and stats of repository"
},
{
"names": [
"--no-show-git-info",
"-G"
],
"description": "Don't show git statuses on files nor stats"
},
{
"names": [
"--git-status"
],
"description": "Only show files having an interesting git status, including hidden ones"
},
{
"names": [
"--hidden",
"-h"
],
"description": "Show hidden files"
},
{
"names": [
"--no-hidden",
"-H"
],
"description": "Don't show hidden files"
},
{
"names": [
"--show-gitignored",
"-i"
],
"description": "Show files which should be ignored according to git"
},
{
"names": [
"--no-show-gitignored",
"-I"
],
"description": "Don't show gitignored files"
},
{
"names": [
"--permissions",
"-p"
],
"description": "Show permissions with owner and group"
},
{
"names": [
"--no-permissions",
"-P"
],
"description": "Don't show permissions"
},
{
"names": [
"--sizes",
"-s"
],
"description": "Show the sizes of files and directories. When this mode is on, children aren't shown so that the biggest entries at the selected level can be sorted first"
},
{
"names": [
"--no-sizes",
"-S"
],
"description": "Don't show sizes"
},
{
"names": [
"--sort-by-count"
],
"description": "Sort by count (only show one level of the tree)"
},
{
"names": [
"--sort-by-date"
],
"description": "Sort by date (only show one level of the tree)"
},
{
"names": [
"--sort-by-size"
],
"description": "Sort by size (only show one level of the tree)"
},
{
"names": [
"--whale-spotting",
"-w"
],
"description": "Sort by size, show ignored and hidden files"
},
{
"names": [
"--no-sort"
],
"description": "Don't sort"
},
{
"names": [
"--trim-root",
"-t"
],
"description": "Trim the root: remove elements which would exceed the screen size. This removes the scrollbar"
},
{
"names": [
"--no-trim-root",
"-T"
],
"description": "Don't trim the root (still trim the deeper levels). A scrollbar may be used when there are too many elements to show on screen"
},
{
"names": [
"--install"
],
"description": "Install or reinstall the br shell function"
},
{
"names": [
"--get-root"
],
"description": "Ask for the current root of the remote broot"
},
{
"names": [
"--color"
],
"description": "Controls styling of the output (default: auto). If set to auto, all styling is removed when output is piped",
"takes_arg": true,
"arg": {
"suggestions": [
"yes",
"no",
"auto"
]
}
},
{
"names": [
"--help"
],
"description": "Prints a help page, with more or less the same content as this man page"
},
{
"names": [
"--version",
"-v"
],
"description": "Prints the version of broot"
},
{
"names": [
"--outcmd"
],
"description": "Where to write a command if broot produces one",
"takes_arg": true,
"arg": {
"name": "cmd-export-path"
}
},
{
"names": [
"--cmd",
"-c"
],
"description": "Semicolon separated commands to execute on start of broot",
"takes_arg": true,
"arg": {
"name": "commands"
}
},
{
"names": [
"--conf"
],
"description": "Semicolon separated paths to specific config files",
"takes_arg": true,
"arg": {
"name": "conf"
}
},
{
"names": [
"--height"
],
"description": "Height to use if you don't want to fill the screen or for file export (by default the terminal height is used)",
"takes_arg": true,
"arg": {
"name": "height"
}
},
{
"names": [
"--out",
"-o"
],
"description": "Where to write the produced path, if any",
"takes_arg": true,
"arg": {
"name": "file-export-path",
"template": "filepaths"
}
},
{
"names": [
"--set-install-state"
],
"description": "Set the installation state. This is mostly useful in installation scripts to override the normal installation process",
"takes_arg": true,
"arg": {
"name": "state",
"suggestions": [
"undefined",
"refused",
"installed"
]
}
},
{
"names": [
"--print-shell-function"
],
"description": "Print to stdout the br function for the given shell. This can be used in your own installation process overriden the standard one",
"takes_arg": true,
"arg": {
"name": "shell",
"suggestions": [
"bash",
"fish",
"zsh"
]
}
},
{
"names": [
"--listen"
],
"description": "Listen for commands",
"takes_arg": true,
"arg": {
"name": "listen"
}
},
{
"names": [
"--send"
],
"description": "Send commands to a remote broot then quits",
"takes_arg": true,
"arg": {
"name": "send"
}
}
],
"args": [
{
"name": "ROOT",
"description": "Sets the root directory"
}
]
}