はじめに

この資料は Rust 製のコマンドラインツール broot について紹介するものです。

Rustの環境構築やツールのインストール方法については以下を参照してください

broot について

brootはディレクトリツリーの表示や移動、プレビューなどができるツールです。マウス操作もサポートしています。

GitHub - Canop/broot: A new way to see and navigate directory trees : https://dystroy.org/broot

broot のインストールは次のようになります。

% cargo install --locked broot

ドキュメント

br ヘルプメッセージ

% br --help
broot 1.18.0
dystroy <[email protected]>
A tree explorer and a customizable launcher

Complete documentation lives at <https://dystroy.org/broot>"

USAGE:
    broot [OPTIONS] [FILE]

ARGS:
    <FILE>
            Root Directory

OPTIONS:
    -c, --cmd <CMD>
            Semicolon separated commands to execute

        --color <COLOR>
            Whether to have styles and colors (auto is default and usually OK)

            [default: auto]
            [possible values: auto, yes, no]

        --conf <CONF>
            Semicolon separated paths to specific config files"),

    -d, --dates
            Show the last modified date of files and directories"

    -D, --no-dates
            Don't show the last modified date"

    -f, --only-folders
            Only show folders

    -F, --no-only-folders
            Show folders and files alike

    -g, --show-git-info
            Show git statuses on files and stats on repo

    -G, --no-show-git-info
            Don't show git statuses on files and stats on repo

        --get-root
            Ask for the current root of the remote broot

        --git-status
            Only show files having an interesting git status, including hidden ones

    -h, --hidden
            Show hidden files

    -H, --no-hidden
            Don't show hidden files

        --height <HEIGHT>
            Height (if you don't want to fill the screen or for file export)

        --help
            Print help information

    -i, --git-ignored
            Show git ignored files

    -I, --no-git-ignored
            Don't show git ignored files

        --install
            Install or reinstall the br shell function

        --listen <LISTEN>
            A socket to listen to for commands

        --no-sort
            Don't sort

        --outcmd <OUTCMD>
            Where to write the produced cmd (if any)

    -p, --permissions
            Show permissions

    -P, --no-permissions
            Don't show permissions

        --print-shell-function <PRINT_SHELL_FUNCTION>
            Print to stdout the br function for a given shell

    -s, --sizes
            Show the size of files and directories

    -S, --no-sizes
            Don't show sizes

        --send <SEND>
            A socket that broot sends commands to before quitting

        --set-install-state <SET_INSTALL_STATE>
            Where to write the produced cmd (if any)

            [possible values: undefined, refused, installed]

        --show-root-fs
            Show filesystem info on top

        --sort-by-count
            Sort by count (only show one level of the tree)

        --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

        --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)

    -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

    -V, --version
            Print version information

    -w, --whale-spotting
            Sort by size, show ignored and hidden files

        --write-default-conf <WRITE_DEFAULT_CONF>
            Write default conf files in given directory

公式ドキュメント

Broot

はじめに

broot について

ドキュメント

ライセンス