Interface: Command<Options>
Command interface.
Type Parameters
| Type Parameter | Default type |
|---|---|
Options extends ArgOptions | ArgOptions |
Properties
| Property | Type | Description |
|---|---|---|
description? | string | Command description. It's used to describe the command in usage and it's recommended to specify. |
examples? | string | Command examples. examples of how to use the command. |
name? | string | Command name. It's used to find command line arguments to execute from sub commands, and it's recommended to specify. |
options? | Options | Command options. Each option can include a description property to describe the option in usage. |
resource? | CommandResourceFetcher<Options, ArgValues<Options>> | Command resource fetcher. |
run | CommandRunner<Options> | Command runner. it's the command to be executed |