こんにちは！Takuya.B（@TB_IQ）です。

プログラミング関係の記事を書いていると、前提としてディレクトリ構造を紹介する必要がでてきます。

その際に箇条書きなどで表しても良いのですが、とにかく見栄えが思ってたのと何か違う。。

そんなときに使えるのが tree というコマンドです。

このコマンドはWindowsではデフォルトで使えるらしいのですが、Macにはそもそも入っていません。

そこで、本日は tree コマンドのインストールの方法、そして tree コマンドの使い方について解説します！

HomebrewでTreeコマンドをインストールする

まず、Treeコマンドのインストール方法です。

インストールにはHomebrewを使用します。

$ brew install tree

たったのこれだけです！

Homebrewのインストール方法はこちらの記事で解説しています。Homebrewが入っていない方は参考にしてください。

Treeコマンドの使い方

Treeコマンドの書式

Treeコマンドの書式は以下です。

$ tree <オプション> <ディレクトリ名>

サンプル

これから実際にtreeコマンドの使い方の紹介をしますが、以下をサンプルのディレクトリ構造とします。

# サンプル
.
├── child1
│   ├── jirou.txt
│   ├── saburou.txt
│   └── tarou.txt
└── child2
    ├── grandChild
    │   ├── mago1.txt
    │   ├── mago2.txt
    │   └── mago3.txt
    └── hanako.txt

基本

まずはオプション等を指定しない基本的なコマンドのみの場合です。

# カレントディレクトリ(今いる階層)以下のディレクトリ・ファイルを全てツリー表示
$ tree

この場合、前項のサンプルで示したツリーが表示されます。

指定したディレクトリ以下を表示する場合

# 指定したディレクトリ以下を表示する場合
$ tree dirname

以下、具体例です。child2 を指定すると以下のように出力されます。

# 例
$ tree child2

# 出力結果
child2
├── grandChild
│   ├── mago1.txt
│   ├── mago2.txt
│   └── mago3.txt
└── hanako.txt

ディレクトリのみを表示したい場合

ディレクトリのみを表示したい場合は、以下のように -d オプションを指定します。

# ディレクトリのみ表示する場合
$ tree -d

# 出力結果
.
├── child1
└── child2
    └── grandChild

ツリー表示の継ぎ目をなめらかにする

これは見せかけのテクニックですが、-A オプションを使用すると、ツリー表示の線がなめらかになり、継ぎ目が見えなくなります。

# ツリーを表す線をなめらかに表示する(=継ぎ目が見えないようにする)
$ tree -A

キャプチャを撮るときなどに使えそうですね！

あとがき

プログラミング関係の記事を書いたり、wikiなどテキストベースで情報をまとめる際に、treeコマンドを使用することでディレクトリ構造などを視覚的に伝えることができます。

是非、皆様も試してみてください！

というわけで、次回もよしなに！