Co-authored-by: Katerina Skroumpelou <mandarini@users.noreply.github.com> Co-authored-by: Colum Ferry <cferry09@gmail.com> Co-authored-by: Emily Xiong <xiongemi@gmail.com> Co-authored-by: Nicholas Cunningham <ndcunningham@gmail.com> Co-authored-by: Jason Jean <jasonjean1993@gmail.com> Co-authored-by: Victor Savkin <mail@vsavkin.com> Co-authored-by: Jack Hsu <jack.hsu@gmail.com>
34 lines
1.3 KiB
Markdown
34 lines
1.3 KiB
Markdown
# Connect to Nx Cloud
|
|
|
|
Create an account on [nx.app](https://nx.app). There are several ways to connect your repository to Nx Cloud.
|
|
|
|
#### Connect Directly Through GitHub
|
|
|
|
If your repository is hosted on GitHub, we recommend you create an Nx Cloud organization based on your GitHub organization.
|
|
|
|

|
|
|
|
After that, connect you repository.
|
|
|
|

|
|
|
|
This will send a pull request to your repository that will add the `nxCloudAccessToken` property to `nx.json`.
|
|
|
|

|
|
|
|
This wires up all the CI for you and configures access. Folks who can see your repository can see your workspace on nx.app.
|
|
|
|
## Manually Connect Your Workspace
|
|
|
|
If your repository is hosted on a different source control provider, you can also connect to Nx Cloud manually. You'll need to add a source control integration later to enable [Nx Agents](/ci/features/distribute-task-execution).
|
|
|
|
Run the following command in your repository:
|
|
|
|
```shell
|
|
pnpm nx connect
|
|
```
|
|
|
|
Click the link in the terminal to claim your workspace on [nx.app](https://nx.app).
|
|
|
|
The command generates an `nxCloudAccessToken` property inside of `nx.json`. This is a read-only token that should be committed to the repository.
|