Home

Documentation

Get started by looking at the API documentation. There are two things you need to learn - the commandLineArgs function (exported by this module) and the OptionDefinition object it accepts as input.

• API reference
  • commandLineArgs(optionDefinitions, [options])
  • OptionDefinition
• Notation rules
• Validation
• Usage guide generator
• How to use with native ECMAScript modules
• How to use with rollup

To try out command-line-args, follow the instructions in Typical usage.

Parse options

More detail and examples regarding the options you can pass to commandLineArgs.

• partial
• stopAtFirstUnknown
  • Terminate parsing at the -- arg
  • Implement command parsing (git-style).
  • Implement multiple command parsing (docker-style).
• camelCase

Option definition features

Examples of various option definition features.

• Multiples
  • multiple
  • lazyMultiple
  • Avoiding ambiguity
• type: using custom option types

Other usage examples

Miscellaneous other examples.

• Typical usage
• Usage in a mocha test script
• How to implement a negating flag (e.g. --no-something)