Skip to main content

Home > @rushstack/ts-command-line > ICommandLineActionOptions

ICommandLineActionOptions interface

Options for the CommandLineAction constructor.

Signature:
export interface ICommandLineActionOptions 

Properties

PropertyTypeDescription
actionNamestringThe 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"
documentationstringA detailed description that is shown on the action help page, which is displayed by the command "example build --help", e.g. for actionName="build".
summarystringA quick summary that is shown on the main help page, which is displayed by the command "example --help"