Index ME!

Like tree command, but more format.

Installtion

npm install indexme -g

TL;DR

# run after install
indexme

# or run with npx
npx indexme

Useage

➔ indexme --help

  Usage: indexme [options] path


  Options:

    -V, --version         output the version number
    -i, --ignore [globs]  A ignore list
    -m, --mode [value]    markdown[default], pure, tree
    -d, --deep [n]        >=1, default=2
    -h, --help            output usage information

Recipes

In terminal, quick open files.

➔ indexme -i node_modules,.git
# Then click your file path, quick open your file.

Index your markdown notes.

➔ indexme notes -i README.md > notes/README.md

Tree your node.js project.

➔ indexme -i _*,.*,node_modules -m tree

Enjoy! ❤️