docs(nx-cloud): improve remote caching page with more details

This commit is contained in:
Juri 2023-11-29 11:27:33 +01:00 committed by Juri Strumpflohner
parent 642327334d
commit 434dee2417
2 changed files with 14 additions and 9 deletions

View File

@ -1,19 +1,21 @@
# Use Remote Caching
By default Nx [caches task computations locally](/core-features/cache-task-results). However, to benefit from the cache across your team and in particular on CI, the computation cache can also be distributed across multiple machines. Nx Cloud is an app that provides a fast and zero-config implementation of distributed caching. It's completely free for OSS projects and for most closed-sourced projects ([read more here](https://nx.app/pricing)).
By default Nx [caches task computations locally](/core-features/cache-task-results). However, to benefit from the cache across your team and in particular on CI, the computation cache can also be distributed across multiple machines. Nx Cloud is an app that provides a fast and zero-config implementation of distributed caching. It is a commercial add-on to Nx, is completely free for OSS projects and comes with generous plans for startups and dedicated offerings for enterprise customers ([read more here](https://nx.app/pricing)).
![Diagram showing Teika sharing his cache with CI, Kimiko and James](/shared/images/dte/distributed-caching.svg)
In this diagram, Teika runs the build once on his machine, then CI, Kimiko and James can use the cached artifact from Teika instead of re-executing the same work.
## Connecting Your Workspace to Your Nx Cloud Account
## Setup Remote Caching with Nx Cloud
You can connect your workspace to Nx Cloud by running:
To enable remote caching for your Nx workspace run the following command:
```shell
npx nx connect
```
This connects your workspace with Nx Cloud's remote caching service. It will also allow you to benefit from other Nx Cloud features such as [distributed task execution](/nx-cloud/features/distribute-task-execution).
To see the remote cache in action, run:
```{% command="nx build header && nx reset && nx build header"%}
@ -64,7 +66,7 @@ created dist in 786ms
## Claim your Nx Cloud Workspace
After you have enabled Nx Cloud in your workspace, you will see the following:
During the setup process you might have seen a link to claim your Nx Cloud connected workspace.
```plaintext
> NX NOTE Nx Cloud has been enabled
@ -77,13 +79,16 @@ After you have enabled Nx Cloud in your workspace, you will see the following:
(You can do this later.)
```
Click on this link to associate the workspace with your Nx Cloud account. If you don't have an Nx Cloud account, you can
create one on the spot.
Click on this link to associate the workspace with your Nx Cloud account. If you don't have an Nx Cloud account, you can create one on the spot.
After you claim your workspace, you will be able to manage permissions, create access tokens, set up billing, and so
forth.
![Nx Cloud Workspace Dashboard](/shared/images/nx-cloud/nx-cloud-workspace-overview.png)
**You will also see an interactive tutorial helping you explore distributed caching and the Nx Cloud user interface.**
Claiming your workspace allows you to
- see stats about your CI runs, cache hits number of agents used for distributing tasks
- enable [source control integrations](/nx-cloud/recipes/source-control-integration) to get information embedded in your GitHub, Bitbucket or GitLab PRs
- manage and create access tokens and [adjust access and permission](/nx-cloud/concepts/scenarios)
- manage your organization & user permissions for your Nx Cloud workspace
**If you lose this link, you can still connect your workspace to Nx Cloud**. Go to [nx.app](https://nx.app), create an account, and connect your workspace using the access token from `nx.json`.

Binary file not shown.

After

Width:  |  Height:  |  Size: 358 KiB