Upgraders, please read the release notes

command-line-args

A mature, feature-complete library to parse command-line options.

Synopsis

You can set options using the main notation standards (learn more). These commands are all equivalent, setting the same values:

$ example --verbose --timeout=1000 --src one.js --src two.js
$ example --verbose --timeout 1000 --src one.js two.js
$ example -vt 1000 --src one.js two.js
$ example -vt 1000 one.js two.js

To access the values, first create a list of option definitions describing the options your application accepts. The type property is a setter function (the value supplied is passed through this), giving you full control over the value received.

const optionDefinitions = [
  { name: 'verbose', alias: 'v', type: Boolean },
  { name: 'src', type: String, multiple: true, defaultOption: true },
  { name: 'timeout', alias: 't', type: Number }
]

Next, parse the options using commandLineArgs():

const commandLineArgs = require('command-line-args')
const options = commandLineArgs(optionDefinitions)

options now looks like this:

{
  src: [
    'one.js',
    'two.js'
  ],
  verbose: true,
  timeout: 1000
}

Advanced usage

Beside the above typical usage, you can configure command-line-args to accept more advanced syntax forms.

Command-based syntax (git style) in the form:

$ executable <command> [options]

For example.

$ git commit --squash -m "This is my commit message"

Command and sub-command syntax (docker style) in the form:

$ executable <command> [options] <sub-command> [options]

For example.

$ docker run --detached --image centos bash -c yum install -y httpd

Usage guide generation

A usage guide (typically printed when --help is set) can be generated using command-line-usage. See the examples below and read the documentation for instructions how to create them.

A typical usage guide example.

usage

The polymer-cli usage guide is a good real-life example.

usage

Install

$ npm install command-line-args --save

Current Tags

5.2.1 ... latest (3 years ago)

73 Versions

5.2.1 ... 3 years ago
5.2.0 ... 3 years ago
5.1.3 ... 3 years ago
5.1.2 ... 3 years ago
5.1.1 ... 6 years ago
5.1.0 ... 6 years ago
6.0.0-preview.1 ... 6 years ago
5.0.2 ... 7 years ago
5.0.1 ... 7 years ago
5.0.0 ... 7 years ago
5.0.0-alpha.2 ... 7 years ago
5.0.0-alpha.1 ... 7 years ago
5.0.0-alpha.0 ... 7 years ago
4.0.7 ... 7 years ago
4.0.6 ... 8 years ago
4.0.5 ... 8 years ago
4.0.4 ... 8 years ago
4.0.3 ... 8 years ago
4.0.2 ... 8 years ago
4.0.1 ... 8 years ago
4.0.0 ... 8 years ago
4.0.0-1 ... 8 years ago
4.0.0-0 ... 8 years ago
3.0.5 ... 8 years ago
3.0.4 ... 8 years ago
3.0.3 ... 8 years ago
3.0.3-0 ... 8 years ago
3.0.2 ... 8 years ago
3.0.1 ... 8 years ago
3.0.0 ... 9 years ago
2.1.6 ... 9 years ago
2.1.5 ... 9 years ago
2.1.4 ... 9 years ago
2.1.3 ... 9 years ago
2.1.2 ... 9 years ago
2.1.1 ... 9 years ago
2.1.0 ... 9 years ago
2.0.4 ... 9 years ago
2.0.3 ... 9 years ago
2.0.2 ... 9 years ago
2.0.1 ... 9 years ago
2.0.0 ... 9 years ago
1.0.2 ... 9 years ago
1.0.1 ... 9 years ago
1.0.0 ... 9 years ago
1.1.0-1 ... 9 years ago
1.1.0-0 ... 9 years ago
1.0.0-3 ... 9 years ago
1.0.0-2 ... 9 years ago
1.0.0-1 ... 9 years ago
1.0.0-0 ... 9 years ago
0.5.9 ... 10 years ago
0.5.8 ... 10 years ago
0.5.7 ... 10 years ago
0.5.6 ... 10 years ago
0.5.5 ... 10 years ago
0.5.4 ... 10 years ago
0.5.3 ... 10 years ago
0.5.2 ... 10 years ago
0.5.1 ... 10 years ago
0.5.0 ... 10 years ago
0.4.0 ... 10 years ago
0.3.1 ... 10 years ago
0.3.0 ... 10 years ago
0.2.4 ... 10 years ago
0.2.3 ... 10 years ago
0.2.2 ... 10 years ago
0.2.1 ... 10 years ago
0.2.0 ... 11 years ago
0.1.0 ... 11 years ago
0.0.2 ... 11 years ago
0.0.1 ... 11 years ago
0.0.0 ... 11 years ago