Rush StackShopBlogEvents
Skip to main content

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

ICommandLineParserOptions interface

Options for the CommandLineParser constructor.

Signature:

export interface ICommandLineParserOptions 

Properties

PropertyModifiersTypeDescription
enableTabCompletionAction?boolean(Optional) Set to true to auto-define a tab completion action. False by default.
toolDescriptionstringGeneral documentation that is included in the "--help" main page
toolEpilog?string(Optional) An optional string to append at the end of the "--help" main page. If not provided, an epilog will be automatically generated based on the toolFilename.
toolFilenamestringThe name of your tool when invoked from the command line