the complete solution for node.js command-line programs. 

the complete solution for node.js command-line programs

tjholowaychuk

abetomo

somekittens

shadowspawn

commander

vanesyan

zhiyelee

  "description": "the complete solution for node.js command-line programs",

  "author": "TJ Holowaychuk <tj@vision-media.ca>",

    "url": "https://github.com/tj/commander.js.git"

    "lint": "npm run lint:javascript && npm run lint:typescript",

    "lint:javascript": "eslint index.js esm.mjs \"lib/*.js\" \"tests/**/*.js\"",

    "lint:typescript": "eslint typings/*.ts tests/*.ts",

    "test": "jest && npm run test-typings",

    "test-esm": "node --experimental-modules ./tests/esm-imports-test.mjs",

    "typescript-checkJS": "tsc --allowJS --checkJS index.js lib/*.js --noEmit",

    "test-all": "npm run test && npm run lint && npm run typescript-checkJS && npm run test-esm"

    "@typescript-eslint/eslint-plugin": "^4.33.0",

    "@typescript-eslint/parser": "^4.27.0",

    "eslint-config-standard-with-typescript": "^21.0.1",

[![Build Status](https://github.com/tj/commander.js/workflows/build/badge.svg)](https://github.com/tj/commander.js/actions?query=workflow%3A%22build%22)

[![NPM Version](http://img.shields.io/npm/v/commander.svg?style=flat)](https://www.npmjs.org/package/commander)

[![NPM Downloads](https://img.shields.io/npm/dm/commander.svg?style=flat)](https://npmcharts.com/compare/commander?minimal=true)

[![Install Size](https://packagephobia.now.sh/badge?p=commander)](https://packagephobia.now.sh/result?p=commander)

The complete solution for [node.js](http://nodejs.org) command-line interfaces.

Read this in other languages: English | [简体中文](./Readme_zh-CN.md)

  - [Declaring _program_ variable](#declaring-program-variable)

    - [Common option types, boolean and value](#common-option-types-boolean-and-value)

    - [Default option value](#default-option-value)

    - [Other option types, negatable boolean and boolean|value](#other-option-types-negatable-boolean-and-booleanvalue)

    - [Required option](#required-option)

    - [Variadic option](#variadic-option)

    - [More configuration](#more-configuration)

    - [Custom option processing](#custom-option-processing)

    - [Command-arguments](#command-arguments)

      - [More configuration](#more-configuration-1)

      - [Custom argument processing](#custom-argument-processing)

    - [Stand-alone executable (sub)commands](#stand-alone-executable-subcommands)

    - [Life cycle hooks](#life-cycle-hooks)

    - [Display help after errors](#display-help-after-errors)

    - [Display help from code](#display-help-from-code)

    - [.helpOption(flags, description)](#helpoptionflags-description)

    - [.addHelpCommand()](#addhelpcommand)

    - [More configuration](#more-configuration-2)

  - [Custom event listeners](#custom-event-listeners)

    - [.parse() and .parseAsync()](#parse-and-parseasync)

    - [Parsing Configuration](#parsing-configuration)

    - [Legacy options as properties](#legacy-options-as-properties)

    - [Node options such as `--harmony`](#node-options-such-as---harmony)

    - [Debugging stand-alone executable subcommands](#debugging-stand-alone-executable-subcommands)

    - [Override exit and output handling](#override-exit-and-output-handling)

    - [Additional documentation](#additional-documentation)

    - [Commander for enterprise](#commander-for-enterprise)

For information about terms used in this document see: [terminology](./docs/terminology.md)

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](./examples/split.js)

const { program } = require('commander');

const limit = options.first ? 1 : undefined;

console.log(program.args[0].split(options.separator, limit));

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](./examples/string-util.js)

program.exit('Password must be longer than four characters');

program.exit('Custom processing has failed', { exitCode: 2, code: 'my.custom.error' });

program.error('Password must be longer than four characters');

program.error('Custom processing has failed', { exitCode: 2, code: 'my.custom.error' });

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.

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](./examples/configure-output.js)

  // Add ANSI escape codes to display text in red.

    // Visibly override write routines as example!

    writeOut: (str) => process.stdout.write(`[OUT] ${str}`),

    writeErr: (str) => process.stdout.write(`[ERR] ${str}`),

    outputError: (str, write) => write(errorColor(str))

There is more information available about:

- [deprecated](./docs/deprecated.md) features still supported for backwards compatibility

- [options taking varying arguments](./docs/options-taking-varying-arguments.md)

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](https://github.com/tj/commander.js/issues) on GitHub.

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.](https://tidelift.com/subscription/pkg/npm-commander?utm_source=npm-commander&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)

		{
		"name": "commander",
		"version": "9.0.0-1",
		"version": "9.0.0",
		"description": "the complete solution for node.js command-line programs",
		@@ -5,0 +5,0 @@ "keywords": [

Fixed alerts

Improved metrics

		@@ -1015,4 +1015,4 @@ # Commander.js
		```js
		program.exit('Password must be longer than four characters');
		program.exit('Custom processing has failed', { exitCode: 2, code: 'my.custom.error' });
		program.error('Password must be longer than four characters');
		program.error('Custom processing has failed', { exitCode: 2, code: 'my.custom.error' });
		```
		@@ -1019,0 +1019,0 @@