Package - command-line-tool

command-line-tool

Some conventional operations used in command-line tools.

Example

const tool = require('command-line-tool')

Print the supplied messages then stop the process (no exit code).

Kind: static method of command-line-tool

Param	Type	Description
[message]	`string` \| `Array.<string>`	One or more messages to be written to stderr before exiting. May contain `ansi.format` markup.

Prints one or more strings in red to stderr.

Kind: static method of command-line-tool

Param	Type	Description
message	`string` \| `Array.<string>`	input message(s)

Prints one or more strings to stdout. Catches unwanted EPIPE error.

Kind: static method of command-line-tool

Param	Type	Description
message	`string` \| `Array.<string>`	input message(s)

Stop the process with an error message.

Kind: static method of command-line-tool

Parse the command-line options.

Kind: static method of command-line-tool

Param	Type	Description
definitions	`Array.<OptionDefinitions>`	to be passed to command-line-args
[usageSections]	`Array.<section>`	to be passed to command-line-usage
[argv]	`Array.<string>`	If supplied, this `argv` array is parsed instead of `process.argv`.