在寫代碼文檔的時候,常常會用到展現項目架構,這時候若是能夠有命令直接打印出目錄樹那就再好不過了,免的截圖了。node
網上找了下,果真是有這種工具的,Mac - tree命令。python
Mac默認是沒有tree
命令的,須要手工安裝下:shell
brew install tree
安裝好以後,看下幫助文檔:架構
$ tree --help usage: tree [-acdfghilnpqrstuvxACDFJQNSUX] [-H baseHREF] [-T title ] [-L level [-R]] [-P pattern] [-I pattern] [-o filename] [--version] [--help] [--inodes] [--device] [--noreport] [--nolinks] [--dirsfirst] [--charset charset] [--filelimit[=]#] [--si] [--timefmt[=]<f>] [--sort[=]<name>] [--matchdirs] [--ignore-case] [--fromfile] [--] [<directory list>] ------- Listing options ------- -a All files are listed. -d List directories only. -l Follow symbolic links like directories. -f Print the full path prefix for each file. -x Stay on current filesystem only. -L level Descend only level directories deep. -R Rerun tree when max dir level reached. -P pattern List only those files that match the pattern given. -I pattern Do not list files that match the given pattern. --ignore-case Ignore case when pattern matching. --matchdirs Include directory names in -P pattern matching. --noreport Turn off file/directory count at end of tree listing. --charset X Use charset X for terminal/HTML and indentation line output. --filelimit # Do not descend dirs with more than # files in them. --timefmt <f> Print and format time according to the format <f>. -o filename Output to file instead of stdout. ------- File options ------- -q Print non-printable characters as '?'. -N Print non-printable characters as is. -Q Quote filenames with double quotes. -p Print the protections for each file. -u Displays file owner or UID number. -g Displays file group owner or GID number. -s Print the size in bytes of each file. -h Print the size in a more human readable way. --si Like -h, but use in SI units (powers of 1000). -D Print the date of last modification or (-c) status change. -F Appends '/', '=', '*', '@', '|' or '>' as per ls -F. --inodes Print inode number of each file. --device Print device ID number to which each file belongs. ------- Sorting options ------- -v Sort files alphanumerically by version. -t Sort files by last modification time. -c Sort files by last status change time. -U Leave files unsorted. -r Reverse the order of the sort. --dirsfirst List directories before files (-U disables). --sort X Select sort: name,version,size,mtime,ctime. ------- Graphics options ------- -i Don't print indentation lines. -A Print ANSI lines graphic indentation lines. -S Print with CP437 (console) graphics indentation lines. -n Turn colorization off always (-C overrides). -C Turn colorization on always. ------- XML/HTML/JSON options ------- -X Prints out an XML representation of the tree. -J Prints out an JSON representation of the tree. -H baseHREF Prints out HTML format with baseHREF as top directory. -T string Replace the default HTML title and H1 header with string. --nolinks Turn off hyperlinks in HTML output. ------- Input options ------- --fromfile Reads paths from files (.=stdin) ------- Miscellaneous options ------- --version Print version and exit. --help Print usage and this help message and exit. -- Options processing terminator.
能夠添加的參數不少,那麼該用那些呢?app
在一個python
項目中,先只加文件夾名看下:ide
$ tree app app ├── __init__.py ├── __pycache__ │ └── __init__.cpython-37.pyc ├── main │ ├── __init__.py │ ├── __pycache__ │ │ ├── __init__.cpython-37.pyc │ │ ├── functions.cpython-37.pyc │ │ └── views.cpython-37.pyc │ ├── functions.py │ └── views.py └── module ├── __init__.py ├── __pycache__ │ ├── __init__.cpython-37.pyc │ ├── functions.cpython-37.pyc │ └── views.cpython-37.pyc ├── functions.py └── views.py 5 directories, 14 files
pyc
是編譯的臨時文件,咱們要把刪掉,看下說明,能夠用-I
來:工具
$ tree -I *.pyc app app ├── __init__.py ├── __pycache__ ├── main │ ├── __init__.py │ ├── __pycache__ │ ├── functions.py │ └── views.py └── module ├── __init__.py ├── __pycache__ ├── functions.py └── views.py 5 directories, 7 files
__pycache__
也是臨時文件,也把刪掉:this
tree -I *.pyc -I __pycache__ app app ├── __init__.py ├── main │ ├── __init__.py │ ├── functions.py │ └── views.py └── module ├── __init__.py ├── functions.py └── views.py 2 directories, 7 files
能夠看出-I
是能夠加多個的,每一個-I
後面加一個pattern
。命令行
在上面的例子中,其實全部的.pyc
文件都在__pychache__
文件夾下,能夠直接忽略該文件夾便可:code
$ tree -I __pycache__ app app ├── __init__.py ├── main │ ├── __init__.py │ ├── functions.py │ └── views.py └── module ├── __init__.py ├── functions.py └── views.py 2 directories, 7 files
那麼若是隻要文件夾的結構呢?-d
參數
$ tree -d app app ├── __pycache__ ├── main │ └── __pycache__ └── module └── __pycache__ 5 directories
忽略__pycache__
文件夾:
$ tree -d -I __pycache__ app app ├── main └── module 2 directories
經過brew
安裝tree
工具以後,便可在命令行中使用tree
命令展現文件文件夾目錄樹:
直接加對應的文件夾來展現某文件夾範圍內的文件樹
$ tree app
使用-I
參數來忽略不展現的文件或子文件夾,可添加多個-I
$ tree -I *.pyc -I __pycache__ app
使用-d
來僅展現文件夾樹
$ tree -d app
多參數能夠混合使用
$ tree -d -I __pycache__ app
更多的參數使用,能夠在有須要的時候參考--help
內容
$ tree --help