Simple Command line interface (CLI) application example in NodeJS.
This is a simple example that shows how you can natively play around with the NodeJS command arguments. If you want a complete solution for building NodeJS CLI applications, I'd suggest you go for the Commander library π».
-
Clone the repository.
-
Stay in the parent folder of the project.
-
Execute the application:
node nodejs-cli
this will automatically execute the index.js
file inside the nodejs-cli
folder.
Output: No options provided.
- Execute with some flags:
- Help flag:
--help
node nodejs-cli --help
Output: This is an example cli app with nodeJS..
- Help flag alias:
-h
node nodejs-cli -h
Output: This is an example cli app with nodeJS..
- Name flag with parameter:
--name
or-n
node nodejs-cli --name Ambratolm
Output: Hello, Ambratolm! Welcome! :D
- Execute command options through flags (arguments prefixed with "--") with aliases (arguments shorthands prefixed with "-").
- If flags are duplicate or merged with their aliases it executes the associated command one time only.
- Prompts unknown flags.
- To add a new option flag, just add a method in the
actions/@methods.js
file. - To add an alias for a flag, just add an entry in
actions/@aliases.js
file with the name of the targeted method as the key and an array of aliases as the value.
Licensed under MIT.