Whether this Program has subcommands or not.

Whether this Program has any global arguments or not.

The max length - in characters - of all arguments (both global and subcommand-local). Useful for lining everything up neatly :P

The name of the program. This is taken from the name field of your package.json automatically.

Type: string

The version of the program. This is taken from the version field of your package.json automatically.

Type: string

The name of the author that wrote the program. Appears on the second printed line of the help. This is taken from the author field of your package.json automatically.

Type: string

The description that appears next to the progrram name on the first line. This is taken from the description field in your package.json automatically.

Type: string

The extended description that appears below the author name.

Type: string

Global argument definitions.

Type: Array<Argument>

Subcommand definitions.

Type: Array<Subcommand>

The name of the currently selected subcommand.

Type: string

Extra args we found while parsing.

Type: Array<string>

Specifies the name of the program - defaults to the name from your package.json

Specifies the description of the program - defaults to the description from your package.json

Specifies the extended description of the program. This will be shown directly above the "Usage:` section. Defaults to an empty string (which means that it isn't shown).

Sets the name of the author of the program.

let cli = new Program("path/to/package.json");
cli.set_author("Bob");

Adds an argument to the program.

A string argument

let program = new Program("path/to/package.json");
program.argument("food", "Specifies the food to find.", "apple");
program.parse(process.argv.slice(2)); // Might return { food: "banana" }

A boolean argument

let program = new Program("path/to/package.json");
program.argument("with-lemonade", "Whether to include lemonade with your order", false, "boolean");
program.parse(process.argv.slice(2)); // Might return { with_lemonade: true }

Multiple integers

let program = new Program("path/to/package.json");
program.argument("package-number", "The number of the package(s) to ship. Maybe specified multiple times.", null, "integer_multi");
program.parse(process.argv.slice(2)); // Might return { package_number: [ 4, 5, 6 ] }

Using a custom function

let program = new Program("path/to/package.json");
program.argument("items", "A comma-separated list of items to put in the box.", null, (value) => {
	return value.split(",").map((item) => item.trim());
});
program.parse(process.argv.slice(2)); // Might return { items: [ "banana", "orange", "raspberry" ] }

Adds a subcommand to the program.

Parses the given argument set. Note that the returned object will also include all the default values of all relevant arguments (i.e. argument specific to the subcommand specified, but not other subcommands).

let program = new Program("path/to/package.json");
// ....
program.parse(process.argv.slice(2)); // Strip the first 2 argument, since they are the path to the Node.js binary and the script being executed respectively

Writes the program version to the standard output and then exits.

Displays auto-generated help text and then terminates the Node.js process

The name that this argument should have in the final output object. Useful to make argument names more easily accessible (e.g. min-value → min_value).

Whether this argument supports multiple values or not.

Sets the type of this argument.

Sets a custom function for parsing values.

Parses a value according to the type of this argument.

Whether this Subcommand instance has any arguments or not.

The name of this subcommand.

Type: string

The human-readable description of this subcommand.

Type: string

Adds a new argument to this Subcommand instance. Note that the new argument will be specific to this subcommand - and will not work globally (only when this subcommand is called). For that, you probably want Program.argument() instead.