Home > @rushstack/ts-command-line > ICommandLineActionOptions
ICommandLineActionOptions interface
Options for the CommandLineAction constructor.
Signature:
export interface ICommandLineActionOptions
Properties
| Property | Type | Description |
|---|---|---|
| actionName | string |
The name of the action. For example, if the tool is called “example”, then the “build” action might be invoked as: “example build -q –some-other-option” |
| documentation | string |
A detailed description that is shown on the action help page, which is displayed by the command “example build –help”, e.g. for actionName=”build”. |
| summary | string |
A quick summary that is shown on the main help page, which is displayed by the command “example –help” |