Home > @rushstack/ts-command-line > IBaseCommandLineDefinitionWithArgument > argumentName

IBaseCommandLineDefinitionWithArgument.argumentName property

The name of the argument, which will be shown in the command-line help.

Signature:

argumentName: string;

Remarks

For example, if the parameter name is '--count" and the argument name is "NUMBER", then the command-line help would display "--count NUMBER". The argument name must be comprised of upper-case letters, numbers, and underscores. It should be kept short.