Skip to content

HelpOptions

Options for customising help output.

Signatures

ts
interface HelpOptions {}

Members

Properties

binName

Binary/program name shown in the usage line. Defaults to command name.

ts
binName?: string;

isDefaultHelp

Whether this usage line is being rendered as merged root/default help.

ts
isDefaultHelp?: boolean;

width

Maximum line width (columns). Defaults to 80.

ts
width?: number;

See Also

Released under the MIT License.