Skip to content

Commit

Permalink
docs(core): various references to Nx Cloud (nrwl#22237)
Browse files Browse the repository at this point in the history
  • Loading branch information
isaacplmann authored Mar 8, 2024
1 parent ac949d6 commit f98b18d
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/shared/features/cache-task-results.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ The cache is stored in `.nx/cache` by default. You can also [change where the ca

## Enable Remote Caching

You can enable remote caching by connecting to [Nx Cloud](/ci/features/remote-cache). To connect Nx to Nx Cloud run the following command:
You can enable remote caching (Nx Replay) by connecting to [Nx Cloud](/ci/features/remote-cache). To connect Nx to Nx Cloud run the following command:

```shell
npx nx connect
Expand Down
2 changes: 1 addition & 1 deletion docs/shared/reference/environment-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ Nx will set the following environment variables so they can be accessible within
| NX_DRY_RUN | boolean | Set to `true` during dry runs of generators. Use this to avoid side effects during generators. |
| NX_INTERACTIVE | boolean | Set to `false` when running generators with `--interactive=false`. Use this to prevent prompting during generators |

When using remote caching, [Nx Cloud Environment Variables](/ci/reference/env-vars) are also available.
[Nx Cloud Environment Variables](/ci/reference/env-vars) are listed on a dedicated page.
12 changes: 12 additions & 0 deletions docs/shared/reference/nx-json.md
Original file line number Diff line number Diff line change
Expand Up @@ -461,3 +461,15 @@ pass `--buildable=true` when creating new libraries with the `@nx/js` plugin.
## Extends

Some presets use the `extends` property to hide some default options in a separate json file. The json file specified in the `extends` property is located in your `node_modules` folder. The Nx preset files are specified in [the `nx` package](https://github.com/nrwl/nx/tree/master/packages/nx/presets).

## Nx Cloud

There are also options for [Nx Cloud](https://nx.app) that are set in the `nx.json` file. For instance, you authenticate with the Nx Cloud service using an `nxCloudAccessToken` like this:

```json {% fileName="nx.json" %}
{
"nxCloudAccessToken": "SOMETOKEN"
}
```

For more details on configuring Nx Cloud, see the [Nx Cloud Configuration Options page](/ci/reference/config).

0 comments on commit f98b18d

Please sign in to comment.