mhulse / node-boilerplate-cli

A simple boilerplate starting point for Node.js command line projects.
Apache License 2.0
18 stars 9 forks source link

Improve docs on how to run NOT as a global module #20

Open mhulse opened 5 years ago

mhulse commented 5 years ago

This could be useful to document for those that don't want to run npm link:

# Use as a global module:
$ npm link
$ boilerplate -d path/to/a/directory/

# Otherwise:
$ npm install
$ node . -d path/to/a/directory/

Also good to note, maybe, that there is npm start which returns the help by default. One could modify this to run node . and then npm start -- -d path/to/a/directory/; this is a bit more syntax than the “otherwise” listed above.