@nx/powerpack-shared-fs-cache

This package is part of the Nx Powerpack extensions for Nx.

This plugin provides a Nx cache which can be shared through the filesystem.

Usage

Use of this package is governed by the following LICENSE. Please be sure to read through the license carefully before using this plugin. This license is also included in the package in a LICENSE file.

Use Cases

This plugin is useful when Nx Cloud is not a viable solution. Nx Cloud is the ideal recommended method of sharing a cache between multiple machines using Nx.

If Nx Cloud, is not a viable solution, there are also other Nx Powerpack plugins which allow sharing a cache via more robust methods:

• @nx/powerpack-s3-cache - A Nx Powerpack plugin to share a Nx Cache via your own Amazon S3 Bucket.

If none of the above are a viable solution, this plugin can be used to share a Nx Cache via the filesystem.

This would enable situations like the following:

Restoring a Nx Cache Locally from a Remote Cache provided by a CI Provider

Many CI providers allow users to restore files and directories from their cache. If you are using such a mechanism to restore the default Nx Cache, Nx will not have metadata pertaining about those restored artifacts. By default, Nx will not be able to restore the artifacts which were restored. This plugin adds the ability to also keep track of metadata about the cache artifacts so that they can be restored.

Sharing a Nx Cache With a Network Drive

It is also possible to share a Nx Cache by storing it on a mounted network drive. If you do so, Nx will not have metadata pertaining about some those restored artifacts. By default, Nx will not be able to restore the artifacts which did not originate from the machine it is being run on. This plugin adds the ability to track metadata about artifacts from multiple machines on a mounted network drive.

Adding this plugin to your Nx workspace

Use nx add @nx/powerpack-shared-fs-cache to install and setup this plugin in your Nx workspace.

Configuring where the cache is stored

The location where the cache is stored can be configured in several ways.

Environment Variable

You can set the NX_CACHE_DIRECTORY environment variable to the location where the Nx cache should be stored. This overrides the nx.json setting.

nx.json

The cacheDirectory property in nx.json dictates the location where the Nx cache should be stored.