Rush StackShopBlogEvents
Skip to main content

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

IAliasCommandLineActionOptions interface

Options for the AliasCommandLineAction constructor.

Signature:

export interface IAliasCommandLineActionOptions 

Properties

PropertyModifiersTypeDescription
aliasNamestringThe name of the alias. For example, if the tool is called "example", then the "build" alias might be invoked as: "example build -q --some-other-option"
defaultParameters?string[](Optional) A list of default parameters to pass to the target action.
targetActionCommandLineActionThe action that this alias invokes.
toolFilenamestringThe name of your tool when invoked from the command line. Used for generating help text.