@bryoung/oak v1.0.2

🌳 Oak - A CLI tool for visualizing directories with lots of color

Install the package globally with either yarn or npm:

yarn global add @bryoung/oak

or

npm install -g @bryoung/oak

To use the package, simply call oak and pass a directory as well as any of the optional commands.

Usage: oak [options] <directory>

Print a colorful tree representation of the structure of a given directory

Options:
  -V, --version      output the version number
  -e, --exclude <s>  Exclude folders matching the given pattern
  -d, --depth <n>    Maximum depth to print
  -s, --size <n>     Maximum size directory to print
  -c, --color        Colorize output with random color scheme
  -a, --all          Print all files and directories
  -h, --help         display help for command
Example:
  $ oak ./my-folder

Sample Output:

Options

Use --color to colorize the output of your directory structure with random colors:

Use --exclude=<file> to exclude all folders/files matching a given pattern:

Use --depth <number> and pass an integer to only print the directory to n levels of depth (starting from 0). Example in the same directory as previous snippets: