Home Reference Source Test Repository


Parses command line arguments passed to node.js.

Note that this package is still under heavy development.


Run npm install [--save[-dev]] @ls-age/args-parser to install this module.


Basic usage:

import parseArgs from '@ls-age/parse-args';

const args = parseArgs(
  ['non-option', '--number', '13', '--bool'],
    options: {
      number: { type: 'number' },
      bool: 'Description of "bool" option'

console.log(args._); // logs ['non-option']
console.log(args.number); // logs `13`
console.log(args.test); // logs `true`

Look at the docs and tests for more detailed usage examples.