ディレクトリ表示や移動をインタラクティブに実行できるコマンドツール「Broot」

はじめに

Linuxで端末を使っている時にディレクトリ構造をざっくり確認したり各ディレクトリにどのようなファイルが入っているかを確認したりしたい場合があると思います。treeコマンドを使用するとディレクトリ構造を表示できますが、そこから目的のディレクトリに移動したりはできません。Brootはtreeコマンドのようにディレクトリ構造を表示しつつさらにそこから各ディレクトリに移動したりファイルを検索したりできるコマンドラインツールです。この記事ではBrootのインストール手順と簡単な使い方をまとめます。

Brootについて

Brootのコマンドであるbrコマンドを使用すると、以下のようにディレクトリ構造を各ディレクトリ内のファイルを表示してくれます。

そして上記の画面の状態で方向キーで移動して指定したディレクトリに移動したり、指定した文字列を含むディレクトリやファイルを検索することもできます。 以下がBrootの公式リポジトリです。

前提と環境

この記事ではUbuntu18.04にBrootをインストールしました。

• OS : Ubuntu18.04

以降の手順は公式ドキュメントに従った方法になります。

Brootをインストールする

Brootをインストールする方法はいくつかあります。RuntのパッケージマネージャであるCargoを使う方法やコンパイルされたバイナリファイルをダウンロードして使用する方法です。それぞれ説明します。

Cargo使ってBrootをインストールする

もしCargoが使える状況であれば、以下のコマンドでインストールできます。私はCargoを使用しました。

$ cargo install broot

実行すると以下のように表示されます。

$ cargo install broot

// 省略

 Compiling broot v0.11.9
   Compiling thiserror v1.0.9
   Compiling termimad v0.8.10
    Finished release [optimized] target(s) in 3m 01s
  Installing /home/username/.cargo/bin/broot
   Installed package `broot v0.11.9` (executable `broot`)

これで完了です。続いてパスを設定します。

バイナリファイルをダウンロードしてBrootをインストールする

私自身はこの方法を実施していませんが、公式ドキュメントに記載の手順を以下に載せておきます。 まず、公式ドキュメントにアクセスし、以下のようにLinux用のバイナリファイルをダウンロードします。

ダウンロードしたbrootというファイルを好きなところに置きます。ここでは/usr/local/binに置きます。そしてそれに実行権限を付与します。

$ sudo chmod +x /usr/local/bin/broot

これで準備完了です。続いてパスを設定します。

macOSにインストールする場合

macOSにインストールしたい場合は、HomeBrewかMacPortsを使用できます。詳しくは以下の公式ドキュメントを見てみてください。

パスを設定する

上記のいずれかの方法を実行後、以下のコマンドを実行してBrootのパス設定をしてインストール完了です。

$ broot --install
You requested a clean (re)install.
Writing br shell function in /home/username/.local/share/broot/launcher/bash/1.
Creating link from /home/username/.config/broot/launcher/bash/br to /home/username/.local/share/broot/launcher/bash/1.
/home/username/.bashrc successfully patched, you can make the function immediately available with
source /home/username/.bashrc

The br function has been installed.
You may have to restart your shell or source your shell init files.
Afterwards, you should start broot with br in order to use its full power.

上記に記載されているように、Broot用にパスが追加されたのでこれを反映するために以下を実行します。

$ source /home/username/.bashrc

これでbrコマンドでBrootを実行できるようになります。

$ br

Brootの使い方

主に使用するキーは以下です。

後は適当に何か入力すると、入力内容でフィルタをかけて表示してくれます。

まとめ

Brootのインストール手順と簡単な使い方をまとめました。