The Package Manager maintains a global cache for registry data and uncompressed packages. The global cache includes subsidiary caches, each serving a different purpose. The Package Manager stores the global caches in a default location, which you can override.
You might want to override the cache location for several reasons:
By default, the Package Manager uses the following folder structure for the global cache:
<global-cache-root>
├── npm
│ └── <registry data (package metadata and tarballs)>
├── packages
│ └── <uncompressed contents of package tarballs>
└── git-lfs (if enabled)
└── <downloaded Git LFS files>
For information on the default location of the global cache root, see global cache.
Note: The Package Manager maintains separate caches for the global cache and the Asset StoreA growing library of free and commercial assets created by Unity and members of the community. Offers a wide variety of assets, from textures, models and animations to whole project examples, tutorials and Editor extensions. More info
See in Glossary package cache. For information on overriding the default location for the Asset Store cache, see Customize the Asset Store cache location.
To override the default location of the global cache root, you can use the following methods:
cacheRoot
property in a user configuration file. If you want to set the configuration file manually, see Using a configuration file.UPM_CACHE_ROOT
environment variable and the cacheRoot
property, Package Manager uses the location in the UPM_CACHE_ROOT
environment variable.UPM_NPM_CACHE_PATH
), the uncompressed packages cache (UPM_CACHE_PATH
), or the Git LFS cache (UPM_GIT_LFS_CACHE_PATH
), Package Manager uses the location specified by the environment variable, regardless of where the global cache root is.UPM_ENABLE_GIT_LFS_CACHE
) without explicitly setting its path (UPM_GIT_LFS_CACHE_PATH
), Package Manager uses the git-lfs
folder under the global cache root as its location.To use the Preferences window to override the default location of the global cache, follow these steps.
Use one of the following methods to open the Preferences window:
Select the Package Manager category.
Under Packages, open the menu beside Cache Location .
Choose Change Location.
Choose a new location for the global cache.
You can manually edit the same configuration file that the Preferences window sets to override the location of the global cache root:
Locate the .upmconfig.toml
user configuration file. To find the file location, see Configuration files. If the file doesn’t exist, create an empty text file.
Add the cacheRoot
key and set its value as an absolute path to a custom location. Important: When setting Windows paths in TOML files, use forward slashes (/
) or double backslashes (\\
). Don’t use single backslashes (\
) because they’re special characters which mark escape sequences and can cause TOML parsing errors.
Windows example
cacheRoot = "E:\\Unity\\cache"
macOS and Linux example
cacheRoot = "/dev/external/shared/Unity/cache"
You don’t need to restart the Unity Editor or the Hub after setting the cacheRoot
key for the change to take effect.
In scenarios that involve automation or continuous integration, it’s less practical and more error prone to configure settings in a configuration file or a preferences window. In such scenarios, you might consider using environment variables to configure settings for the global cache and its subsidiary caches. The following environment variables are available:
Environment variable: | Description: |
---|---|
UPM_CACHE_ROOT |
Specify the location of the global cache (the root folder containing the registry data and uncompressed packages caches). |
UPM_NPM_CACHE_PATH |
Specify the absolute path to the location where you want Package Manager to store package metadata and tarballs. By default, this is the npm subdirectory under the global cache root. |
UPM_CACHE_PATH |
Specify the absolute path to the location where you want Package Manager to store the uncompressed contents of package tarballs. By default, this is the packages subdirectory under the global cache root. |
UPM_ENABLE_GIT_LFS_CACHE |
Specify any value except empty ("") to enable the Git LFS cache. By default, Package Manager uses the git-lfs subdirectory under the global cache root, unless you specify a different path using the UPM_GIT_LFS_CACHE_PATH environment variable. |
UPM_GIT_LFS_CACHE_PATH |
Specify the absolute path to the location where you want Package Manager to store the Git LFS cache. By setting this path, you automatically enable the Git LFS cache. |
Important: Follow these guidelines when you use this method:
For information on setting environment variables, refer to the documentation for your operating system. For an introduction to environment variables, see https://en.wikipedia.org/wiki/Environment_variable.