vraa / textree

Generate textual tree representation of given folder in command line.

Build

Install

npm install -g textree

Usage

In command line, cd into the directory for which you want to generate the tree structure, and run

textree

and you will get the below output (example):

🗁 src
  |--🗁 js
  |  `--🗎 textree.js
  |--🗁 scss
  |  `--🗎 main.scss
  |--🗎 cli.js
  `--🗎 main.js

By default, it will process the current directory. You can also pass a different folder.

textree D:/workspace/textree

🗁 textree
  |--🗀 .git
  |--🗀 node_modules
  |--🗁 resources
  |  `--🗁 js
  |  |  `--🗎 bundle.js
  |--🗁 src
  |  |--🗁 js
  |  |  `--🗎 textree.js
  |  |--🗁 scss
  |  |  `--🗎 main.scss
  |  |--🗎 cli.js
  |  `--🗎 main.js
  |--🗎 .gitignore
  |--🗎 index.html
  |--🗎 LICENSE
  |--🗎 npm-debug.log
  |--🗎 package.json
  |--🗎 README.md
  |--🗎 textree.iml
  `--🗎 webpack.config.js

Note

It will not process the following folders, as they tend to be deeper than the Mariana Trench.

• .git
• node_modules
• .sass-cache