diff --git a/docs/nx-cloud/reference/nx-cloud-cli.md b/docs/nx-cloud/reference/nx-cloud-cli.md index 954723b0abfcd..671e5bb9d1ffe 100644 --- a/docs/nx-cloud/reference/nx-cloud-cli.md +++ b/docs/nx-cloud/reference/nx-cloud-cli.md @@ -6,9 +6,10 @@ At the beginning of your main job, invoke `npx nx-cloud start-ci-run`. This tell command correspond to the same CI run. {% callout type="warning" title="Do not run start-ci-run locally" %} -`nx-cloud start-ci-run` is designed to run in CI. If you run the command locally, it can cause your local Nx repo to think it's a part of a CI run. This can cause strange behavior like Nx commands timing out or throwing unexpected errors. +`nx-cloud start-ci-run` generates a temporary marker file that can cause a local Nx repo to behave as if it is a part of a CI run. This can cause strange behavior like Nx commands timing out or throwing unexpected errors. +To discourage this from happening, this command will run a check to see if it is running in a CI environment. You can bypass this check with `nx-cloud start-ci-run --force`. -If you accidentally run the command locally, you can remove your system's temp files to reset your local system. Typically restarting your system is enough to fix this issue. +If you accidentally run this command locally, remove all generated marker files with `nx-cloud cleanup`. {% /callout %} You can configure your CI run by passing the following flags: