cliclopts
Command line options helper and usage printer, works well with minimist, inspired by nomnom
usage
Define the allowed options in an array and pass it to 'cliclopts'
var cliclopts = var options = name: 'verbose' abbr: 'v' alias: 'loud' boolean: true help: 'be verbose' name: 'path' abbr: 'p' default: './dat.json' help: 'path to file' var cliOpts =
cliclopts(options)
options is an array of objects with the following possible keys:
name
primary name of optionabbr
one character alias of the optionalias
other options treated as aliasboolean
if true the option is seen as a boolean flaghelp
usage string for the optiondefault
default value of the option
cliOpts.usage()
Returns the usage information as string:
--verbose, -v be verbose
--path, -p path to file (default: "dat.json")
cliOpts.print()
Prints the usage information.
cliOpts.boolean()
Returns Array of all command names that are specified as boolean.
cliOpts.alias()
Returns Object with command names as keys and alias list as value (including abbr)
cliOpts.default()
Returns Object with command names as keys and default values as values.
cliOpts.options()
Returns
alias: cliOpts boolean: cliOpts default: cliOpts
minimist
Example usage with var allowedOptions = name: 'verbose' abbr: 'v' alias: 'cry-at-me' boolean: true help: 'be verbose' name: 'path' abbr: 'p' help: 'path to the file' name: 'help' abbr: 'h' help: 'show help' boolean: true var cliOpts = allowedOptions var argv = processargv cliOptsoptions if argvhelp console cliOpts process