Skip to main content

IndexHelpProps

Hierarchy

Index

Properties

Properties

optionalbanner

banner?: string

A large banner to appear at the top of the index help interface.

bin

bin: string

The name of the binary consumers enter on the command line. Must be in kebab-case.

optionalchildren

children?: ReactNode

optionaldelimiter

delimiter?: string

The character(s) displayed before command line usage examples.

optionalfooter

footer?: string

A string of text to display at the bottom of the index help interface.

optionalheader

header?: string

A string of text to display at the top of the index help interface, below the banner (if present).

name

name: string

A human readable name for your program.

version

version: string

Current version of your CLI program. Typically the version found in your package.json. This is output when --version is passed.