Generate an index for a given directory
[](http://commitizen.github.io/cz-cli/) [](https://github.com/semantic-release/semantic-release)
This module generates a tree view of a given directory.
Usage
CLI API
Usage: indexifier [options] <dir>
Options:
-h, --help output usage information
-V, --version output the version number
-e, --extensions <list> The extensions to take into account (defaults to .htm,.html)
-I, --include <regexp> Include files and directories that are matched by this regular expression (defaults to all)
-E, --exclude <regexp> Exclude files and directories that are matched by this regular expression (defaults to none)
-H, --html Enable to generate HTML output
-L, --no-link-folders Do not link folders when in HTML output mode
-F, --no-empty-directories Do not include empty directories
#### Install
npm install -g indexifier
#### Examples
indexifier ./ --extensions .html,.htm
would generate something like this:
A ├─┬ B │ └── c.html ├── d.html └── e.html
There is also an HTML flag that would generate the above output as linked HTML:
indexifier --extensions .html --html .
<a href="./"A</a<br/ ├─┬ <a href="./B"B</a<br/ │ └── <a href="./B/c.html"c.html</a<br/ ├── <a href="./d.html"a.html</a<br/ └── <a href="./e.html"b.html</a<br/ <!-- ... --
> The links are always relative to the given directory.
### Node API
indexifier(String directory [, opts={ fileTypes: Array.<String, include=undefined: Regexp, exclude=undefined: Regexp, isHtml=false: Boolean, linkFolders=true: Boolean, emptyFolders=true: Boolean, maxDepth=Infinity: Number, }]);