Home > @microsoft/rush-lib > EnvironmentVariableNames
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Names of environment variables used by Rush.
export declare enum EnvironmentVariableNames
|RUSH_ABSOLUTE_SYMLINKS||(BETA) If this variable is set to "1", Rush will create symlinks with absolute paths instead of relative paths. This can be necessary when a repository is moved during a build or if parts of a repository are moved into a sandbox.|
|RUSH_ALLOW_UNSUPPORTED_NODEJS||(BETA) If this variable is set to "1", Rush will not fail the build when running a version of Node that does not match the criteria specified in the "nodeSupportedVersionRange" field from rush.json.|
|RUSH_ALLOW_WARNINGS_IN_SUCCESSFUL_BUILD||(BETA) Setting this environment variable overrides the value of |
|RUSH_BUILD_CACHE_CREDENTIAL||(BETA) Provides a credential for a remote build cache, if configured. This credential overrides any cached credentials.|
|RUSH_BUILD_CACHE_ENABLED||(BETA) Setting this environment variable overrides the value of |
|RUSH_BUILD_CACHE_WRITE_ALLOWED||(BETA) Overrides the value of |
|RUSH_DEPLOY_TARGET_FOLDER||(BETA) This environment variable can be used to specify the |
|RUSH_GIT_BINARY_PATH||(BETA) Explicitly specifies the path for the Git binary that is invoked by certain Rush operations.|
|RUSH_GLOBAL_FOLDER||(BETA) Overrides the location of the |
|RUSH_INVOKED_FOLDER||(BETA) When Rush executes shell scripts, it sometimes changes the working directory to be a project folder or the repository root folder. The original working directory (where the Rush command was invoked) is assigned to the the child process's |
|RUSH_PARALLELISM||(BETA) Specifies the maximum number of concurrent processes to launch during a build. For more information, see the command-line help for the |
(BETA) When using PNPM as the package manager, this variable can be used to configure the path that PNPM will use as the store directory.
If a relative path is used, then the store path will be resolved relative to the process's current working directory. An absolute path is recommended.
|RUSH_PNPM_VERIFY_STORE_INTEGRITY||(BETA) When using PNPM as the package manager, this variable can be used to control whether or not PNPM validates the integrity of the PNPM store during installation. The value of this environment variable must be |
|RUSH_PREVIEW_VERSION||(BETA) This variable overrides the version of Rush that will be installed by the version selector. The default value is determined by the "rushVersion" field from rush.json.|
|RUSH_TAR_BINARY_PATH||(BETA) Explicitly specifies the path for the |
|RUSH_TEMP_FOLDER||(BETA) This variable overrides the temporary folder used by Rush. The default value is "common/temp" under the repository root.|
|RUSH_VARIANT||(BETA) This variable selects a specific installation variant for Rush to use when installing and linking package dependencies. For more information, see the command-line help for the |