RoadmapShopEvents
Skip to main content

Home > @microsoft/rush-lib > EnvironmentVariableNames

EnvironmentVariableNames enum

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.

Signature:
export declare enum EnvironmentVariableNames

Enumeration Members

MemberValueDescription
RUSH_ABSOLUTE_SYMLINKS"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"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"RUSH_ALLOW_WARNINGS_IN_SUCCESSFUL_BUILD"(BETA) Setting this environment variable overrides the value of allowWarningsInSuccessfulBuild in the command-line.json configuration file. Specify 1 to allow warnings in a successful build, or 0 to disallow them. (See the comments in the command-line.json file for more information).
RUSH_BUILD_CACHE_CREDENTIAL"RUSH_BUILD_CACHE_CREDENTIAL"(BETA) Provides a credential for a remote build cache, if configured. Setting this environment variable overrides whatever credential has been saved in the local cloud cache credentials using rush update-cloud-credentials.
RUSH_BUILD_CACHE_ENABLED"RUSH_BUILD_CACHE_ENABLED"(BETA) Setting this environment variable overrides the value of buildCacheEnabled in the build-cache.json configuration file. Specify 1 to enable the build cache or 0 to disable it. If set to 0, this is equivalent to passing the --disable-build-cache flag.
RUSH_BUILD_CACHE_WRITE_ALLOWED"RUSH_BUILD_CACHE_WRITE_ALLOWED"(BETA) Setting this environment variable overrides the value of isCacheWriteAllowed in the build-cache.json configuration file. Specify 1 to allow cache write and 0 to disable it.
RUSH_DEPLOY_TARGET_FOLDER"RUSH_DEPLOY_TARGET_FOLDER"(BETA) This environment variable can be used to specify the --target-folder parameter for the "rush deploy" command.
RUSH_GIT_BINARY_PATH"RUSH_GIT_BINARY_PATH"(BETA) Allows the git binary path to be explicitly specified.
RUSH_GLOBAL_FOLDER"RUSH_GLOBAL_FOLDER"(BETA) Overrides the location of the ~/.rush global folder where Rush stores temporary files.
RUSH_INVOKED_FOLDER"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_INVOKED_FOLDER environment variable, in case it is needed by the script.
RUSH_PARALLELISM"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 --parallelism parameter for "rush build".
RUSH_PNPM_STORE_PATH"RUSH_PNPM_STORE_PATH"(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_PREVIEW_VERSION"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"RUSH_TAR_BINARY_PATH"(BETA) Allows the tar binary path to be explicitly specified.
RUSH_TEMP_FOLDER"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"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 --variant parameter and this article: https://rushjs.io/pages/advanced/installation\_variants/