Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(core): updates for login/logout #27838

Merged
merged 1 commit into from
Sep 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/nx-cloud/tutorial/circle.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ And make sure you pull the latest changes locally:
git pull
```

You should now have an `nxCloudAccessToken` property specified in the `nx.json` file.
You should now have an `nxCloudId` property specified in the `nx.json` file.

## Understand Remote Caching

Expand Down
2 changes: 1 addition & 1 deletion docs/nx-cloud/tutorial/github-actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ And make sure you pull the latest changes locally:
git pull
```

You should now have an `nxCloudAccessToken` property specified in the `nx.json` file.
You should now have an `nxCloudId` property specified in the `nx.json` file.

## Understand Remote Caching

Expand Down
2 changes: 1 addition & 1 deletion docs/shared/migration/adding-to-existing-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@ And make sure you pull the latest changes locally:
git pull
```

You should now have an `nxCloudAccessToken` property specified in the `nx.json` file.
You should now have an `nxCloudId` property specified in the `nx.json` file.

### Create a CI Workflow {% highlightColor="green" %}

Expand Down
2 changes: 1 addition & 1 deletion docs/shared/migration/adding-to-monorepo.md
Original file line number Diff line number Diff line change
Expand Up @@ -344,7 +344,7 @@ And make sure you pull the latest changes locally:
git pull
```

You should now have an `nxCloudAccessToken` property specified in the `nx.json` file.
You should now have an `nxCloudId` property specified in the `nx.json` file.

### Create a CI Workflow {% highlightColor="green" %}

Expand Down
2 changes: 1 addition & 1 deletion docs/shared/migration/from-turborepo.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Creating the equivalent configuration with Nx yields the following files:
"cache": true
}
},
"nxCloudAccessToken": "..."
"nxCloudId": "..."
}
```

Expand Down
2 changes: 1 addition & 1 deletion docs/shared/migration/migration-angular.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ And make sure you pull the latest changes locally:
git pull
```

You should now have an `nxCloudAccessToken` property specified in the `nx.json` file.
You should now have an `nxCloudId` property specified in the `nx.json` file.

### Create a CI Workflow

Expand Down
55 changes: 42 additions & 13 deletions docs/shared/reference/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ The Nx CLI provides many commands. They are organized here into commands that:
- [Modify Code](#modify-code)
- [Run Tasks](#run-tasks)
- [Display Information](#display-information)
- [Integrate with Nx Cloud](#integrate-with-nx-cloud)

There is also a section for separate commands that can [create a new Nx workspace](#create-commands) for you.

Expand Down Expand Up @@ -97,19 +98,6 @@ nx repair
{% link-card title="nx repair" type="API Reference" url="/nx-api/nx/documents/repair" /%}
{% /cards %}

### connect

Connect an Nx workspace to Nx Cloud

```shell
nx connect
```

{% cards %}
{% link-card title="nx connect" type="API Reference" url="/nx-api/nx/documents/connect-to-nx-cloud" /%}
{% link-card title="Connect to Nx Cloud" type="Feature" url="/ci/intro/connect-to-nx-cloud" /%}
{% /cards %}

### format

Overwrite un-formatted files or check for un-formatted files
Expand Down Expand Up @@ -292,6 +280,47 @@ nx daemon
{% link-card title="Nx Daemon" type="Concept" url="/concepts/nx-daemon" /%}
{% /cards %}

## Integrate with Nx Cloud

### connect

Connect an Nx workspace to Nx Cloud

```shell
nx connect
```

{% cards %}
{% link-card title="nx connect" type="API Reference" url="/nx-api/nx/documents/connect-to-nx-cloud" /%}
{% link-card title="Connect to Nx Cloud" type="Feature" url="/ci/intro/connect-to-nx-cloud" /%}
{% /cards %}

### login

Connect an Nx workspace to Nx Cloud

```shell
nx login
```

{% cards %}
{% link-card title="nx login" type="API Reference" url="/nx-api/nx/documents/login" /%}
{% link-card title="Personal Access Tokens" type="Recipe" url="/ci/recipes/security/personal-access-tokens" /%}
{% /cards %}

### logout

Connect an Nx workspace to Nx Cloud

```shell
nx logout
```

{% cards %}
{% link-card title="nx logout" type="API Reference" url="/nx-api/nx/documents/logout" /%}
{% link-card title="Personal Access Tokens" type="Recipe" url="/ci/recipes/security/personal-access-tokens" /%}
{% /cards %}

## Create Commands

### create-nx-workspace
Expand Down
4 changes: 2 additions & 2 deletions docs/shared/reference/nx-json.md
Original file line number Diff line number Diff line change
Expand Up @@ -528,11 +528,11 @@ Some presets use the `extends` property to hide some default options in a separa

## 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:
There are also options for [Nx Cloud](https://nx.app) that are set in the `nx.json` file. For instance, you connect to the Nx Cloud service using an `nxCloudId` like this:

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

Expand Down
2 changes: 1 addition & 1 deletion docs/shared/tutorials/gradle.md
Original file line number Diff line number Diff line change
Expand Up @@ -310,7 +310,7 @@ And make sure you pull the latest changes locally:
git pull
```

You should now have an `nxCloudAccessToken` property specified in the `nx.json` file.
You should now have an `nxCloudId` property specified in the `nx.json` file.

### Create a CI Workflow {% highlightColor="green" %}

Expand Down
2 changes: 1 addition & 1 deletion docs/shared/tutorials/npm-workspaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -405,7 +405,7 @@ And make sure you pull the latest changes locally:
git pull
```

You should now have an `nxCloudAccessToken` property specified in the `nx.json` file.
You should now have an `nxCloudId` property specified in the `nx.json` file.

### Create a CI Workflow {% highlightColor="green" %}

Expand Down
2 changes: 1 addition & 1 deletion docs/shared/tutorials/react-standalone.md
Original file line number Diff line number Diff line change
Expand Up @@ -1023,7 +1023,7 @@ And make sure you pull the latest changes locally:
git pull
```

You should now have an `nxCloudAccessToken` property specified in the `nx.json` file.
You should now have an `nxCloudId` property specified in the `nx.json` file.

### Create a CI Workflow {% highlightColor="green" %}

Expand Down
2 changes: 1 addition & 1 deletion docs/shared/tutorials/vue-standalone.md
Original file line number Diff line number Diff line change
Expand Up @@ -1071,7 +1071,7 @@ And make sure you pull the latest changes locally:
git pull
```

You should now have an `nxCloudAccessToken` property specified in the `nx.json` file.
You should now have an `nxCloudId` property specified in the `nx.json` file.

### Create a CI Workflow {% highlightColor="green" %}

Expand Down