tree - ディレクトリ構造の表示
フォルダやファイルの構造を確認したい時、エクスプローラーで一つずつフォルダを開いていくのは手間がかかります。
treeコマンドを使用すると、ディレクトリの階層構造を視覚的に分かりやすく表示できます。
プロジェクトの構造を確認したり、ドキュメント化したりする際に非常に便利なコマンドです。
tree コマンドとは
treeコマンドは、指定したディレクトリの階層構造をツリー形式で表示するコマンドです。
サブフォルダやファイルの関係が一目で分かるため、以下のような場面で活用できます:
- プロジェクトのフォルダ構成を確認する
- ドキュメントや README ファイルにディレクトリ構造を記載する
- バックアップ前にフォルダ構造を記録する
- サブフォルダの存在を素早く確認する
基本的な使い方
treeコマンドの基本的な構文は以下の通りです。
tree [ドライブ:][パス] [/F] [/A]
最も基本的な使い方は、オプションなしでtreeコマンドを実行することです。
このように実行すると、カレントディレクトリの階層構造がツリー形式で表示されます。
特定のディレクトリを指定
特定のディレクトリのツリー構造を表示したい場合は、パスを指定します。
ルートディレクトリから表示
ドライブのルートからすべてのディレクトリ構造を表示することもできます。
ルートディレクトリから実行すると、システム全体のディレクトリ構造が表示されるため、出力が非常に長くなります。 特定のディレクトリを指定することをおすすめします。
tree コマンドのオプション
treeコマンドには、以下の主要なオプションがあります。
| オプション | 説明 |
|---|---|
/F | 各ディレクトリ内のファイル名も表示します |
/A | 罫線文字の代わりに ASCII 文字を使用します |
/? | ヘルプを表示します |
/Fオプション - ファイルも表示
デフォルトではディレクトリ(フォルダ)のみが表示されますが、/Fオプションを使用するとファイル名も表示されます。
/Fオプションを使用すると、プロジェクト全体の構造(フォルダとファイル)が一覧表示されるため、
READMEファイルや設計書にプロジェクト構造を記載する際に便利です。
/Aオプション - ASCII 文字を使用
デフォルトでは罫線文字(─、├、└ など)を使用しますが、/Aオプションを指定すると、ASCII 文字(+、|、\など)を使用します。
一部のテキストエディタや環境では、罫線文字が正しく表示されない場合があります。
そのような場合に/Aオプションを使用すると、互換性の高いASCII文字で表示されます。
オプションの組み合わせ
複数のオプションを組み合わせることもできます。
応用例
出力結果をファイルに保存
treeコマンドの出力をファイルに保存することで、ディレクトリ構造を記録できます。
これにより、directory_structure.txtというファイルにディレクトリ構造が保存されます。
プロジェクトの開始時や重要な変更前にディレクトリ構造を記録しておくと、 後で構成を確認したい時や、元の状態に戻したい時に役立ちます。
一画面ずつ表示
出力が長い場合、moreコマンドと組み合わせて一画面ずつ表示できます。
これにより、一画面分表示されるたびに一時停止し、Enterキーで次の画面に進むことができます。
特定のプロジェクトフォルダの構造確認
開発プロジェクトのフォルダ構造を確認する例:
USB ドライブの内容確認
USB メモリなどの外部ドライブの構造を確認する例:
実用例: プロジェクト構造のドキュメント化
GitHub の README ファイルなどでプロジェクト構造を説明する際、treeコマンドの出力が役立ちます。
出力されたファイルの内容を Markdown のコードブロックにコピーすることで、 プロジェクトの構造を視覚的に分かりやすく説明できます。
Project
+---src
| | index.js
| | app.js
| \---utils
| helper.js
+---docs
| README.md
| API.md
\---tests
test.js
dirコマンドとの違い
treeコマンドとdirコマンドは、どちらもディレクトリの内容を表示しますが、以下のような違いがあります:
| 項目 | tree | dir |
|---|---|---|
| 表示形式 | ツリー構造(階層を視覚化) | リスト形式 |
| サブフォルダ | デフォルトで再帰的に表示 | /Sオプションで再帰表示 |
| ファイル情報 | 名前のみ | サイズ、日付、属性なども表示可能 |
| 用途 | 構造の把握、ドキュメント化 | 詳細な情報確認、ファイル操作 |
まとめ
この記事では、treeコマンドを使用したディレクトリ構造の表示方法について解説しました。
主なポイント:
treeコマンドでディレクトリの階層構造を視覚的に表示できる/Fオプションでファイル名も表示される/Aオプションで ASCII 文字を使用した互換性の高い表示が可能- 出力をファイルに保存してドキュメント化できる
- プロジェクトの構造確認やドキュメント作成に便利
ディレクトリ構造を視覚的に把握することで、プロジェクトの理解が深まり、効率的なファイル管理が可能になります。
関連コマンド
ディレクトリ操作に関連する他のコマンドについても、以下の記事で詳しく解説しています。