Commander.js

node.js command-line interfaces made easy

CLI
tj/commander.jscommander

README

Commander.js

Build Status NPM Version NPM Downloads Install Size

The complete solution for node.js command-line interfaces.

Read this in other languages: English | 简体中文

- Commander.js
  - Installation
  - Quick Start
  - Declaring _program_ variable
  - Options
    - Common option types, boolean and value
    - Default option value
    - Other option types, negatable boolean and boolean|value
    - Required option
    - Variadic option
    - Version option
    - More configuration
    - Custom option processing
  - Commands
    - Command-arguments
      - More configuration
      - Custom argument processing
    - Action handler
    - Stand-alone executable (sub)commands
    - Life cycle hooks
  - Automated help
    - Custom help
    - Display help after errors
    - Display help from code
    - .name
    - .usage
    - .description and .summary
    - .helpOption(flags, description)
    - .addHelpCommand()
    - More configuration
  - Custom event listeners
  - Bits and pieces
    - .parse() and .parseAsync()
    - Parsing Configuration
    - Legacy options as properties
    - TypeScript
    - createCommand()
    - [Node options such as --harmony](#node-options-such-as---harmony)
    - Debugging stand-alone executable subcommands
    - Display error
    - Override exit and output handling
    - Additional documentation
  - Support
    - Commander for enterprise

For information about terms used in this document see: terminology

Installation


  1. ```sh
  2. npm install commander
  3. ```

Quick Start


You write code to describe your command line interface.
Commander looks after parsing the arguments into options and command-arguments,
displays usage errors for problems, and implements a help system.

Commander is strict and displays an error for unrecognised options.
The two most used option types are a boolean option, and an option which takes its value from the following argument.

Example file: split.js

  1. ```js
  2. const { program } = require('commander');

  4. program
  5.   .option('--first')
  6.   .option('-s, --separator <char>');

  8. program.parse();

  10. const options = program.opts();
  11. const limit = options.first ? 1 : undefined;
  12. console.log(program.args[0].split(options.separator, limit));
  13. ```

  1. ```console
  2. $ node split.js -s / --fits a/b/c
  3. error: unknown option '--fits'
  4. (Did you mean --first?)
  5. $ node split.js -s / --first a/b/c
  6. [ 'a' ]
  7. ```

Here is a more complete program using a subcommand and with descriptions for the help. In a multi-command program, you have an action handler for each command (or stand-alone executables for the commands).

Example file: string-util.js

  1. ```js
  2. const { Command } = require('commander');
  3. const program = new Command();

  5. program
  6.   .name('string-util')
  7.   .description('CLI to some JavaScript string utilities')
  8.   .version('0.8.0');

  10. program.command('split')
  11.   .description('Split a string into substrings and display as an array')
  12.   .argument('<string>', 'string to split')
  13.   .option('--first', 'display just the first substring')
  14.   .option('-s, --separator <char>', 'separator character', ',')
  15.   .action((str, options) => {
  16.     const limit = options.first ? 1 : undefined;
  17.     console.log(str.split(options.separator, limit));
  18.   });

  20. program.parse();
  21. ```

  1. ```console
  2. $ node string-util.js help split
  3. Usage: string-util split [options] <string>

  5. Split a string into substrings and display as an array.

  7. Arguments:
  8.   string                  string to split

  10. Options:
  11.   --first                 display just the first substring
  12.   -s, --separator <char>  separator character (default: ",")
  13.   -h, --help              display help for command

  15. $ node string-util.js split --separator=/ a/b/c
  16. [ 'a', 'b', 'c' ]
  17. ```

More samples can be found in the examples directory.

Declaring _program_ variable


Commander exports a global object which is convenient for quick programs.
This is used in the examples in this README for brevity.

  1. ```js
  2. // CommonJS (.cjs)
  3. const { program } = require('commander');
  4. ```

For larger programs which may use commander in multiple ways, including unit testing, it is better to create a local Command object to use.

  1. ```js
  2. // CommonJS (.cjs)
  3. const { Command } = require('commander');
  4. const program = new Command();
  5. ```

  1. ```js
  2. // ECMAScript (.mjs)
  3. import { Command } from 'commander';
  4. const program = new Command();
  5. ```

  1. ```ts
  2. // TypeScript (.ts)
  3. import { Command } from 'commander';
  4. const program = new Command();
  5. ```

Options


Options are defined with the .option() method, also serving as documentation for the options. Each option can have a short flag (single character) and a long name, separated by a comma or space or vertical bar ('|').

The parsed options can be accessed by calling .opts() on a Command object, and are passed to the action handler.

Multi-word options such as "--template-engine" are camel-cased, becoming program.opts().templateEngine etc.

An option and its option-argument can be separated by a space, or combined into the same argument. The option-argument can follow the short option directly or follow an = for a long option.

  1. ```sh
  2. serve -p 80
  3. serve -p80
  4. serve --port 80
  5. serve --port=80
  6. ```

You can use -- to indicate the end of the options, and any remaining arguments will be used without being interpreted.

By default options on the command line are not positional, and can be specified before or after other arguments.

There are additional related routines for when .opts() is not enough:

- .optsWithGlobals() returns merged local and global option values
- .getOptionValue() and .setOptionValue() work with a single option value
- .getOptionValueSource() and .setOptionValueWithSource() include where the option value came from

Common option types, boolean and value


The two most used option types are a boolean option, and an option which takes its value
from the following argument (declared with angle brackets like `--expect `). Both are `undefined` unless specified on command line.

Example file: options-common.js

  1. ```js
  2. program
  3.   .option('-d, --debug', 'output extra debugging')
  4.   .option('-s, --small', 'small pizza size')
  5.   .option('-p, --pizza-type <type>', 'flavour of pizza');

  7. program.parse(process.argv);

  9. const options = program.opts();
  10. if (options.debug) console.log(options);
  11. console.log('pizza details:');
  12. if (options.small) console.log('- small pizza size');
  13. if (options.pizzaType) console.log(`- ${options.pizzaType}`);
  14. ```

  1. ```console
  2. $ pizza-options -p
  3. error: option '-p, --pizza-type <type>' argument missing
  4. $ pizza-options -d -s -p vegetarian
  5. { debug: true, small: true, pizzaType: 'vegetarian' }
  6. pizza details:
  7. - small pizza size
  8. - vegetarian
  9. $ pizza-options --pizza-type=cheese
  10. pizza details:
  11. - cheese
  12. ```

Multiple boolean short options may be combined together following the dash, and may be followed by a single short option taking a value.
For example -d -s -p cheese may be written as -ds -p cheese or even -dsp cheese.

Options with an expected option-argument are greedy and will consume the following argument whatever the value.
So --id -xyz reads -xyz as the option-argument.

program.parse(arguments) processes the arguments, leaving any args not consumed by the program options in the program.args array. The parameter is optional and defaults to process.argv.

Default option value


You can specify a default value for an option.

Example file: options-defaults.js

  1. ```js
  2. program
  3.   .option('-c, --cheese <type>', 'add the specified type of cheese', 'blue');

  5. program.parse();

  7. console.log(`cheese: ${program.opts().cheese}`);
  8. ```

  1. ```console
  2. $ pizza-options
  3. cheese: blue
  4. $ pizza-options --cheese stilton
  5. cheese: stilton
  6. ```

Other option types, negatable boolean and boolean|value


You can define a boolean option long name with a leading no- to set the option value to false when used.
Defined alone this also makes the option true by default.

If you define --foo first, adding --no-foo does not change the default value from what it would
otherwise be.

Example file: options-negatable.js

  1. ```js
  2. program
  3.   .option('--no-sauce', 'Remove sauce')
  4.   .option('--cheese <flavour>', 'cheese flavour', 'mozzarella')
  5.   .option('--no-cheese', 'plain with no cheese')
  6.   .parse();

  8. const options = program.opts();
  9. const sauceStr = options.sauce ? 'sauce' : 'no sauce';
  10. const cheeseStr = (options.cheese === false) ? 'no cheese' : `${options.cheese} cheese`;
  11. console.log(`You ordered a pizza with ${sauceStr} and ${cheeseStr}`);
  12. ```

  1. ```console
  2. $ pizza-options
  3. You ordered a pizza with sauce and mozzarella cheese
  4. $ pizza-options --sauce
  5. error: unknown option '--sauce'
  6. $ pizza-options --cheese=blue
  7. You ordered a pizza with sauce and blue cheese
  8. $ pizza-options --no-sauce --no-cheese
  9. You ordered a pizza with no sauce and no cheese
  10. ```

You can specify an option which may be used as a boolean option but may optionally take an option-argument
(declared with square brackets like --optional [value]).

Example file: options-boolean-or-value.js

  1. ```js
  2. program
  3.   .option('-c, --cheese [type]', 'Add cheese with optional type');

  5. program.parse(process.argv);

  7. const options = program.opts();
  8. if (options.cheese === undefined) console.log('no cheese');
  9. else if (options.cheese === true) console.log('add cheese');
  10. else console.log(`add cheese type ${options.cheese}`);
  11. ```

  1. ```console
  2. $ pizza-options
  3. no cheese
  4. $ pizza-options --cheese
  5. add cheese
  6. $ pizza-options --cheese mozzarella
  7. add cheese type mozzarella
  8. ```

Options with an optional option-argument are not greedy and will ignore arguments starting with a dash.
So id behaves as a boolean option for --id -5, but you can use a combined form if needed like --id=-5.

For information about possible ambiguous cases, see options taking varying arguments.

Required option


You may specify a required (mandatory) option using .requiredOption(). The option must have a value after parsing, usually specified on the command line, or perhaps from a default value (say from environment). The method is otherwise the same as .option() in format, taking flags and description, and optional default value or custom processing.

Example file: options-required.js

  1. ```js
  2. program
  3.   .requiredOption('-c, --cheese <type>', 'pizza must have cheese');

  5. program.parse();
  6. ```

  1. ```console
  2. $ pizza
  3. error: required option '-c, --cheese <type>' not specified
  4. ```

Variadic option


You may make an option variadic by appending ... to the value placeholder when declaring the option. On the command line you
can then specify multiple option-arguments, and the parsed option value will be an array. The extra arguments
are read until the first argument starting with a dash. The special argument -- stops option processing entirely. If a value
is specified in the same argument as the option then no further values are read.

Example file: options-variadic.js

  1. ```js
  2. program
  3.   .option('-n, --number <numbers...>', 'specify numbers')
  4.   .option('-l, --letter [letters...]', 'specify letters');

  6. program.parse();

  8. console.log('Options: ', program.opts());
  9. console.log('Remaining arguments: ', program.args);
  10. ```

  1. ```console
  2. $ collect -n 1 2 3 --letter a b c
  3. Options:  { number: [ '1', '2', '3' ], letter: [ 'a', 'b', 'c' ] }
  4. Remaining arguments:  []
  5. $ collect --letter=A -n80 operand
  6. Options:  { number: [ '80' ], letter: [ 'A' ] }
  7. Remaining arguments:  [ 'operand' ]
  8. $ collect --letter -n 1 -n 2 3 -- operand
  9. Options:  { number: [ '1', '2', '3' ], letter: true }
  10. Remaining arguments:  [ 'operand' ]
  11. ```

For information about possible ambiguous cases, see options taking varying arguments.

Version option


The optional version method adds handling for displaying the command version. The default option flags are -V and --version, and when present the command prints the version number and exits.

  1. ```js
  2. program.version('0.0.1');
  3. ```

  1. ```console
  2. $ ./examples/pizza -V
  3. 0.0.1
  4. ```

You may change the flags and description by passing additional parameters to the version method, using
the same syntax for flags as the option method.

  1. ```js
  2. program.version('0.0.1', '-v, --vers', 'output the current version');
  3. ```

More configuration


You can add most options using the .option() method, but there are some additional features available
by constructing an Option explicitly for less common cases.

Example files: options-extra.js, options-env.js, options-conflicts.js, options-implies.js

  1. ```js
  2. program
  3.   .addOption(new Option('-s, --secret').hideHelp())
  4.   .addOption(new Option('-t, --timeout <delay>', 'timeout in seconds').default(60, 'one minute'))
  5.   .addOption(new Option('-d, --drink <size>', 'drink size').choices(['small', 'medium', 'large']))
  6.   .addOption(new Option('-p, --port <number>', 'port number').env('PORT'))
  7.   .addOption(new Option('--donate [amount]', 'optional donation in dollars').preset('20').argParser(parseFloat))
  8.   .addOption(new Option('--disable-server', 'disables the server').conflicts('port'))
  9.   .addOption(new Option('--free-drink', 'small drink included free ').implies({ drink: 'small' }));
  10. ```

  1. ```console
  2. $ extra --help
  3. Usage: help [options]

  5. Options:
  6.   -t, --timeout <delay>  timeout in seconds (default: one minute)
  7.   -d, --drink <size>     drink cup size (choices: "small", "medium", "large")
  8.   -p, --port <number>    port number (env: PORT)
  9.   --donate [amount]      optional donation in dollars (preset: "20")
  10.   --disable-server       disables the server
  11.   --free-drink           small drink included free
  12.   -h, --help             display help for command

  14. $ extra --drink huge
  15. error: option '-d, --drink <size>' argument 'huge' is invalid. Allowed choices are small, medium, large.

  17. $ PORT=80 extra --donate --free-drink
  18. Options:  { timeout: 60, donate: 20, port: '80', freeDrink: true, drink: 'small' }

  20. $ extra --disable-server --port 8000
  21. error: option '--disable-server' cannot be used with option '-p, --port <number>'
  22. ```

Specify a required (mandatory) option using the Option method .makeOptionMandatory(). This matches the Command method .requiredOption().

Custom option processing


You may specify a function to do custom processing of option-arguments. The callback function receives two parameters,
the user specified option-argument and the previous value for the option. It returns the new value for the option.

This allows you to coerce the option-argument to the desired type, or accumulate values, or do entirely custom processing.

You can optionally specify the default/starting value for the option after the function parameter.

Example file: options-custom-processing.js

  1. ```js
  2. function myParseInt(value, dummyPrevious) {
  3.   // parseInt takes a string and a radix
  4.   const parsedValue = parseInt(value, 10);
  5.   if (isNaN(parsedValue)) {
  6.     throw new commander.InvalidArgumentError('Not a number.');
  7.   }
  8.   return parsedValue;
  9. }

  11. function increaseVerbosity(dummyValue, previous) {
  12.   return previous + 1;
  13. }

  15. function collect(value, previous) {
  16.   return previous.concat([value]);
  17. }

  19. function commaSeparatedList(value, dummyPrevious) {
  20.   return value.split(',');
  21. }

  23. program
  24.   .option('-f, --float <number>', 'float argument', parseFloat)
  25.   .option('-i, --integer <number>', 'integer argument', myParseInt)
  26.   .option('-v, --verbose', 'verbosity that can be increased', increaseVerbosity, 0)
  27.   .option('-c, --collect <value>', 'repeatable value', collect, [])
  28.   .option('-l, --list <items>', 'comma separated list', commaSeparatedList)
  29. ;

  31. program.parse();

  33. const options = program.opts();
  34. if (options.float !== undefined) console.log(`float: ${options.float}`);
  35. if (options.integer !== undefined) console.log(`integer: ${options.integer}`);
  36. if (options.verbose > 0) console.log(`verbosity: ${options.verbose}`);
  37. if (options.collect.length > 0) console.log(options.collect);
  38. if (options.list !== undefined) console.log(options.list);
  39. ```

  1. ```console
  2. $ custom -f 1e2
  3. float: 100
  4. $ custom --integer 2
  5. integer: 2
  6. $ custom -v -v -v
  7. verbose: 3
  8. $ custom -c a -c b -c c
  9. [ 'a', 'b', 'c' ]
  10. $ custom --list x,y,z
  11. [ 'x', 'y', 'z' ]
  12. ```

Commands


You can specify (sub)commands using .command() or .addCommand(). There are two ways these can be implemented: using an action handler attached to the command, or as a stand-alone executable file (described in more detail later). The subcommands may be nested (example).

In the first parameter to `.command()` you specify the command name. You may append the command-arguments after the command name, or specify them separately using `.argument()`. The arguments may be `` or `[optional]`, and the last argument may also be `variadic...`.

You can use .addCommand() to add an already configured subcommand to the program.

For example:

  1. ```js
  2. // Command implemented using action handler (description is supplied separately to `.command`)
  3. // Returns new command for configuring.
  4. program
  5.   .command('clone <source> [destination]')
  6.   .description('clone a repository into a newly created directory')
  7.   .action((source, destination) => {
  8.     console.log('clone command called');
  9.   });

  11. // Command implemented using stand-alone executable file, indicated by adding description as second parameter to `.command`.
  12. // Returns `this` for adding more commands.
  13. program
  14.   .command('start <service>', 'start named service')
  15.   .command('stop [service]', 'stop named service, or all if no name supplied');

  17. // Command prepared separately.
  18. // Returns `this` for adding more commands.
  19. program
  20.   .addCommand(build.makeBuildCommand());
  21. ```

Configuration options can be passed with the call to .command() and .addCommand(). Specifying hidden: true will
remove the command from the generated help output. Specifying isDefault: true will run the subcommand if no other
subcommand is specified (example).

For safety, .addCommand() does not automatically copy the inherited settings from the parent command. There is a helper routine .copyInheritedSettings() for copying the settings when they are wanted.

Command-arguments


For subcommands, you can specify the argument syntax in the call to .command() (as shown above). This
is the only method usable for subcommands implemented using a stand-alone executable, but for other subcommands
you can instead use the following method.

To configure a command, you can use .argument() to specify each expected command-argument.
You supply the argument name and an optional description. The argument may be `` or `[optional]`.
You can specify a default value for an optional command-argument.

Example file: argument.js

  1. ```js
  2. program
  3.   .version('0.1.0')
  4.   .argument('<username>', 'user to login')
  5.   .argument('[password]', 'password for user, if required', 'no password given')
  6.   .action((username, password) => {
  7.     console.log('username:', username);
  8.     console.log('password:', password);
  9.   });
  10. ```

The last argument of a command can be variadic, and only the last argument.  To make an argument variadic you
append ... to the argument name. A variadic argument is passed to the action handler as an array. For example:

  1. ```js
  2. program
  3.   .version('0.1.0')
  4.   .command('rmdir')
  5.   .argument('<dirs...>')
  6.   .action(function (dirs) {
  7.     dirs.forEach((dir) => {
  8.       console.log('rmdir %s', dir);
  9.     });
  10.   });
  11. ```

There is a convenience method to add multiple arguments at once, but without descriptions:

  1. ```js
  2. program
  3.   .arguments('<username> <password>');
  4. ```

More configuration


There are some additional features available by constructing an Argument explicitly for less common cases.

Example file: arguments-extra.js

  1. ```js
  2. program
  3.   .addArgument(new commander.Argument('<drink-size>', 'drink cup size').choices(['small', 'medium', 'large']))
  4.   .addArgument(new commander.Argument('[timeout]', 'timeout in seconds').default(60, 'one minute'))
  5. ```

Custom argument processing


You may specify a function to do custom processing of command-arguments (like for option-arguments).
The callback function receives two parameters, the user specified command-argument and the previous value for the argument.
It returns the new value for the argument.

The processed argument values are passed to the action handler, and saved as .processedArgs.

You can optionally specify the default/starting value for the argument after the function parameter.

Example file: arguments-custom-processing.js

  1. ```js
  2. program
  3.   .command('add')
  4.   .argument('<first>', 'integer argument', myParseInt)
  5.   .argument('[second]', 'integer argument', myParseInt, 1000)
  6.   .action((first, second) => {
  7.     console.log(`${first} + ${second} = ${first + second}`);
  8.   })
  9. ;
  10. ```

Action handler


The action handler gets passed a parameter for each command-argument you declared, and two additional parameters
which are the parsed options and the command object itself.

Example file: thank.js

  1. ```js
  2. program
  3.   .argument('<name>')
  4.   .option('-t, --title <honorific>', 'title to use before name')
  5.   .option('-d, --debug', 'display some debugging')
  6.   .action((name, options, command) => {
  7.     if (options.debug) {
  8.       console.error('Called %s with options %o', command.name(), options);
  9.     }
  10.     const title = options.title ? `${options.title} ` : '';
  11.     console.log(`Thank-you ${title}${name}`);
  12.   });
  13. ```

If you prefer, you can work with the command directly and skip declaring the parameters for the action handler. The this keyword is set to the running command and can be used from a function expression (but not from an arrow function).

Example file: action-this.js

  1. ```js
  2. program
  3.   .command('serve')
  4.   .argument('<script>')
  5.   .option('-p, --port <number>', 'port number', 80)
  6.   .action(function() {
  7.     console.error('Run script %s on port %s', this.args[0], this.opts().port);
  8.   });
  9. ```

You may supply an async action handler, in which case you call .parseAsync rather than .parse.

  1. ```js
  2. async function run() { /* code goes here */ }

  4. async function main() {
  5.   program
  6.     .command('run')
  7.     .action(run);
  8.   await program.parseAsync(process.argv);
  9. }
  10. ```

A command's options and arguments on the command line are validated when the command is used. Any unknown options or missing arguments will be reported as an error. You can suppress the unknown option checks with .allowUnknownOption(). By default it is not an error to
pass more arguments than declared, but you can make this an error with .allowExcessArguments(false).

Stand-alone executable (sub)commands


When .command() is invoked with a description argument, this tells Commander that you're going to use stand-alone executables for subcommands.
Commander will search the files in the directory of the entry script for a file with the name combination command-subcommand, like pm-install or pm-search in the example below. The search includes trying common file extensions, like .js.
You may specify a custom name (and path) with the executableFile configuration option.
You may specify a custom search directory for subcommands with .executableDir().

You handle the options for an executable (sub)command in the executable, and don't declare them at the top-level.

Example file: pm

  1. ```js
  2. program
  3.   .name('pm')
  4.   .version('0.1.0')
  5.   .command('install [name]', 'install one or more packages')
  6.   .command('search [query]', 'search with optional query')
  7.   .command('update', 'update installed packages', { executableFile: 'myUpdateSubCommand' })
  8.   .command('list', 'list packages installed', { isDefault: true });

  10. program.parse(process.argv);
  11. ```

If the program is designed to be installed globally, make sure the executables have proper modes, like 755.

Life cycle hooks


You can add callback hooks to a command for life cycle events.

Example file: hook.js

  1. ```js
  2. program
  3.   .option('-t, --trace', 'display trace statements for commands')
  4.   .hook('preAction', (thisCommand, actionCommand) => {
  5.     if (thisCommand.opts().trace) {
  6.       console.log(`About to call action handler for subcommand: ${actionCommand.name()}`);
  7.       console.log('arguments: %O', actionCommand.args);
  8.       console.log('options: %o', actionCommand.opts());
  9.     }
  10.   });
  11. ```

The callback hook can be async, in which case you call .parseAsync rather than .parse. You can add multiple hooks per event.

The supported events are:

| event name | when hook called | callback parameters |
| :-- | :-- | :-- |
| preAction, postAction |  before/after action handler for this command and its nested subcommands |   (thisCommand, actionCommand) |
| preSubcommand | before parsing direct subcommand  | (thisCommand, subcommand) |

Automated help


The help information is auto-generated based on the information commander already knows about your program. The default
help option is -h,--help.

Example file: pizza

  1. ```console
  2. $ node ./examples/pizza --help
  3. Usage: pizza [options]

  5. An application for pizza ordering

  7. Options:
  8.   -p, --peppers        Add peppers
  9.   -c, --cheese <type>  Add the specified type of cheese (default: "marble")
  10.   -C, --no-cheese      You do not want any cheese
  11.   -h, --help           display help for command
  12. ```

A help command is added by default if your command has subcommands. It can be used alone, or with a subcommand name to show
further help for the subcommand. These are effectively the same if the shell program has implicit help:

  1. ```sh
  2. shell help
  3. shell --help

  5. shell help spawn
  6. shell spawn --help
  7. ```

Custom help


You can add extra text to be displayed along with the built-in help.

Example file: custom-help

  1. ```js
  2. program
  3.   .option('-f, --foo', 'enable some foo');

  5. program.addHelpText('after', `

  7. Example call:
  8.   $ custom-help --help`);
  9. ```

Yields the following help output:

  1. ```Text
  2. Usage: custom-help [options]

  4. Options:
  5.   -f, --foo   enable some foo
  6.   -h, --help  display help for command

  8. Example call:
  9.   $ custom-help --help
  10. ```

The positions in order displayed are:

- beforeAll: add to the program for a global banner or header
- before: display extra information before built-in help
- after: display extra information after built-in help
- afterAll: add to the program for a global footer (epilog)

The positions "beforeAll" and "afterAll" apply to the command and all its subcommands.

The second parameter can be a string, or a function returning a string. The function is passed a context object for your convenience. The properties are:

- error: a boolean for whether the help is being displayed due to a usage error
- command: the Command which is displaying the help

Display help after errors


The default behaviour for usage errors is to just display a short error message.
You can change the behaviour to show the full help or a custom help message after an error.

  1. ```js
  2. program.showHelpAfterError();
  3. // or
  4. program.showHelpAfterError('(add --help for additional information)');
  5. ```

  1. ```console
  2. $ pizza --unknown
  3. error: unknown option '--unknown'
  4. (add --help for additional information)
  5. ```

The default behaviour is to suggest correct spelling after an error for an unknown command or option. You
can disable this.

  1. ```js
  2. program.showSuggestionAfterError(false);
  3. ```

  1. ```console
  2. $ pizza --hepl
  3. error: unknown option '--hepl'
  4. (Did you mean --help?)
  5. ```

Display help from code


.help(): display help information and exit immediately. You can optionally pass { error: true } to display on stderr and exit with an error status.

.outputHelp(): output help information without exiting. You can optionally pass { error: true } to display on stderr.

.helpInformation(): get the built-in command help information as a string for processing or displaying yourself.

.name


The command name appears in the help, and is also used for locating stand-alone executable subcommands.

You may specify the program name using .name() or in the Command constructor. For the program, Commander will
fallback to using the script name from the full arguments passed into .parse(). However, the script name varies
depending on how your program is launched so you may wish to specify it explicitly.

  1. ```js
  2. program.name('pizza');
  3. const pm = new Command('pm');
  4. ```

Subcommands get a name when specified using .command(). If you create the subcommand yourself to use with .addCommand(),
then set the name using .name() or in the Command constructor.

.usage


This allows you to customise the usage description in the first line of the help. Given:

  1. ```js
  2. program
  3.   .name("my-command")
  4.   .usage("[global options] command")
  5. ```

The help will start with:

  1. ```Text
  2. Usage: my-command [global options] command
  3. ```

.description and .summary


The description appears in the help for the command. You can optionally supply a shorter
summary to use when listed as a subcommand of the program.

  1. ```js
  2. program
  3.   .command("duplicate")
  4.   .summary("make a copy")
  5.   .description(`Make a copy of the current project.
  6. This may require additional disk space.
  7.   `);
  8. ```

.helpOption(flags, description)


By default every command has a help option. You may change the default help flags and description. Pass false to disable the built-in help option.

  1. ```js
  2. program
  3.   .helpOption('-e, --HELP', 'read more information');
  4. ```

.addHelpCommand()


A help command is added by default if your command has subcommands. You can explicitly turn on or off the implicit help command with .addHelpCommand() and .addHelpCommand(false).

You can both turn on and customise the help command by supplying the name and description:

  1. ```js
  2. program.addHelpCommand('assist [command]', 'show assistance');
  3. ```

More configuration


The built-in help is formatted using the Help class.
You can configure the Help behaviour by modifying data properties and methods using .configureHelp(), or by subclassing using .createHelp() if you prefer.

The data properties are:

- helpWidth: specify the wrap width, useful for unit tests
- sortSubcommands: sort the subcommands alphabetically
- sortOptions: sort the options alphabetically

There are methods getting the visible lists of arguments, options, and subcommands. There are methods for formatting the items in the lists, with each item having a _term_ and _description_. Take a look at .formatHelp() to see how they are used.

Example file: configure-help.js

  1. ```js
  2. program.configureHelp({
  3.   sortSubcommands: true,
  4.   subcommandTerm: (cmd) => cmd.name() // Just show the name, instead of short usage.
  5. });
  6. ```

Custom event listeners


You can execute custom actions by listening to command and option events.

  1. ```js
  2. program.on('option:verbose', function () {
  3.   process.env.VERBOSE = this.opts().verbose;
  4. });
  5. ```

Bits and pieces


.parse() and .parseAsync()


The first argument to .parse is the array of strings to parse. You may omit the parameter to implicitly use process.argv.

If the arguments follow different conventions than node you can pass a from option in the second parameter:

- 'node': default, argv[0] is the application and argv[1] is the script being run, with user parameters after that
- 'electron': argv[1] varies depending on whether the electron application is packaged
- 'user': all of the arguments from the user

For example:

  1. ```js
  2. program.parse(process.argv); // Explicit, node conventions
  3. program.parse(); // Implicit, and auto-detect electron
  4. program.parse(['-f', 'filename'], { from: 'user' });
  5. ```

Parsing Configuration


If the default parsing does not suit your needs, there are some behaviours to support other usage patterns.

By default program options are recognised before and after subcommands. To only look for program options before subcommands, use .enablePositionalOptions(). This lets you use
an option for a different purpose in subcommands.

Example file: positional-options.js

With positional options, the -b is a program option in the first line and a subcommand option in the second line:

  1. ```sh
  2. program -b subcommand
  3. program subcommand -b
  4. ```

By default options are recognised before and after command-arguments. To only process options that come
before the command-arguments, use .passThroughOptions(). This lets you pass the  arguments and following options through to another program
without needing to use -- to end the option processing.
To use pass through options in a subcommand, the program needs to enable positional options.

Example file: pass-through-options.js

With pass through options, the --port=80 is a program option in the first line and passed through as a command-argument in the second line:

  1. ```sh
  2. program --port=80 arg
  3. program arg --port=80
  4. ```

By default the option processing shows an error for an unknown option. To have an unknown option treated as an ordinary command-argument and continue looking for options, use .allowUnknownOption(). This lets you mix known and unknown options.

By default the argument processing does not display an error for more command-arguments than expected.
To display an error for excess arguments, use.allowExcessArguments(false).

Legacy options as properties


Before Commander 7, the option values were stored as properties on the command.
This was convenient to code but the downside was possible clashes with
existing properties of Command. You can revert to the old behaviour to run unmodified legacy code by using .storeOptionsAsProperties().

  1. ```js
  2. program
  3.   .storeOptionsAsProperties()
  4.   .option('-d, --debug')
  5.   .action((commandAndOptions) => {
  6.     if (commandAndOptions.debug) {
  7.       console.error(`Called ${commandAndOptions.name()}`);
  8.     }
  9.   });
  10. ```

TypeScript


extra-typings: There is an optional project to infer extra type information from the option and argument definitions.
This adds strong typing to the options returned by .opts() and the parameters to .action().
See commander-js/extra-typings for more.

  1. ```
  2. import { Command } from '@commander-js/extra-typings';
  3. ```

ts-node: If you use ts-node and  stand-alone executable subcommands written as .ts files, you need to call your program through node to get the subcommands called correctly. e.g.

  1. ```sh
  2. node -r ts-node/register pm.ts
  3. ```

createCommand()


This factory function creates a new command. It is exported and may be used instead of using new, like:

  1. ```js
  2. const { createCommand } = require('commander');
  3. const program = createCommand();
  4. ```

createCommand is also a method of the Command object, and creates a new command rather than a subcommand. This gets used internally
when creating subcommands using .command(), and you may override it to
customise the new subcommand (example file custom-command-class.js).

Node options such as --harmony


You can enable --harmony option in two ways:

- Use #! /usr/bin/env node --harmony in the subcommands scripts. (Note Windows does not support this pattern.)
- Use the --harmony option when call the command, like node --harmony examples/pm publish. The --harmony option will be preserved when spawning subcommand process.

Debugging stand-alone executable subcommands


An executable subcommand is launched as a separate child process.

If you are using the node inspector for debugging executable subcommands usingnode --inspect et al,
the inspector port is incremented by 1 for the spawned subcommand.

If you are using VSCode to debug executable subcommands you need to set the "autoAttachChildProcesses": true flag in your launch.json configuration.

Display error


This routine is available to invoke the Commander error handling for your own error conditions. (See also the next section about exit handling.)

As well as the error message, you can optionally specify the exitCode (used with process.exit)
and code (used with CommanderError).

  1. ```js
  2. program.error('Password must be longer than four characters');
  3. program.error('Custom processing has failed', { exitCode: 2, code: 'my.custom.error' });
  4. ```

Override exit and output handling


By default Commander calls process.exit when it detects errors, or after displaying the help or version. You can override
this behaviour and optionally supply a callback. The default override throws a CommanderError.

The override callback is passed a CommanderError with properties exitCode number, code string, and message. The default override behaviour is to throw the error, except for async handling of executable subcommand completion which carries on. The normal display of error messages or version or help
is not affected by the override which is called after the display.

  1. ```js
  2. program.exitOverride();

  4. try {
  5.   program.parse(process.argv);
  6. } catch (err) {
  7.   // custom processing...
  8. }
  9. ```

By default Commander is configured for a command-line application and writes to stdout and stderr.
You can modify this behaviour for custom applications. In addition, you can modify the display of error messages.

Example file: configure-output.js

  1. ```js
  2. function errorColor(str) {
  3.   // Add ANSI escape codes to display text in red.
  4.   return `\x1b[31m${str}\x1b[0m`;
  5. }

  7. program
  8.   .configureOutput({
  9.     // Visibly override write routines as example!
  10.     writeOut: (str) => process.stdout.write(`[OUT] ${str}`),
  11.     writeErr: (str) => process.stdout.write(`[ERR] ${str}`),
  12.     // Highlight errors in color.
  13.     outputError: (str, write) => write(errorColor(str))
  14.   });
  15. ```

Additional documentation


There is more information available about:

- deprecated features still supported for backwards compatibility
- options taking varying arguments

Support


The current version of Commander is fully supported on Long Term Support versions of Node.js, and requires at least v12.20.0.
(For older versions of Node.js, use an older version of Commander.)

The main forum for free and community support is the project Issues on GitHub.

Commander for enterprise


Available as part of the Tidelift Subscription

The maintainers of Commander and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.