rush-lib.irushcommandlineparameter.md

hide_title	true
custom_edit_url
pagination_prev
pagination_next

Home > @microsoft/rush-lib > IRushCommandLineParameter

IRushCommandLineParameter interface

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Information about the available parameters associated with a Rush action

Signature:

export interface IRushCommandLineParameter 

Properties

Property	Modifiers	Type	Description
description	readonly	string	(BETA) Documentation for the parameter that will be shown when invoking the tool with "--help"
environmentVariable?	readonly	string	(BETA) (Optional) If provided, this parameter can also be provided by an environment variable with the specified name.
kind	readonly	keyof typeof CommandLineParameterKind	(BETA) The corresponding string representation of CliParameterKind
longName	readonly	string	(BETA) The long name of the flag including double dashes, e.g. "--do-something"
required?	readonly	boolean	(BETA) (Optional) If true, then an error occurs if the parameter was not included on the command-line.
shortName?	readonly	string	(BETA) (Optional) An optional short name for the flag including the dash, e.g. "-d"