dirtree
Tools
HTML
Dirtree
Dirtree visualizes an list of file paths into a tree graph, printed as HTML page, it can be useful in visualizing a whole project you’re working on to start cleanup or organizing your code or spotting large directories or unneeded files.
Tree template
Flame Graph template
Circles template
Treemap template
Installation
$ gem install dirtree
Usage
Usage: dirtree [options]... [file]...
To get autocompletion functionality
run: dirtree completion >> ~/.bashrc
Or, dirtree completion > /usr/local/etc/bash_completion.d/dirtree
-v, --version Print version
-h, --help Show this help text
-l, --local-dependencies Use saved JavaScript libraries instead of downloading them
-s, --screenshot Get an image screenshot of the directory tree
-o, --output=File.html Specify a path to write HTML output
-t, --template=TemplateName Specify the template name, available templates ["tree", "circles", "flame", "treemap"]
Examples
Visualize current directory recursively
$ dirtree -o output.html **/* *
make sure you have globstar
on
$ shopt -s globstar
Visualize files from git ls
$ git ls-files | dirtree -o output.html
Dirtree prints to standard output if no –output option specified so you can redirect it
$ git ls-files | dirtree > output.html
visualize only files that include specific word
$ git ls-files | grep keyword | dirtree > output.html
works with find
visualize all files that ends with rb
$ find ~ -name *rb | dirtree > output.html
With ag:silver searcher
$ ag -l | dirtree -o output.html
Conjunctions
- lsgh Draw a tree for a github user/org and open pull requests.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/emad-elsaid/dirtree.
License
The gem is available as open source under the terms of the MIT License.