Skip to content

Commit 66a437a

Browse files
jaysooclaude
andauthored
docs(misc): add nx-cloud start-agent command to CLI reference (#33250)
This PR adds the `nx-cloud start-agent` command used for manual DTEs to the reference page. Also update table code elements such that they don't wrap. <img width="872" height="584" alt="image" src="https://github.com/user-attachments/assets/b73a038d-e0de-421a-b430-2d76c0ec4345" /> Closes DOC-273, DOC-310 Co-authored-by: Claude <[email protected]>
1 parent 7712d2a commit 66a437a

File tree

2 files changed

+27
-1
lines changed

2 files changed

+27
-1
lines changed

astro-docs/src/content/docs/reference/nx-cloud-cli.mdoc

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -332,6 +332,32 @@ nx affected -t build --no-dte
332332
{% /tabitem %}
333333
{% /tabs %}
334334

335+
### `nx-cloud start-agent`
336+
337+
Starts an agent process for [manual distributed task execution](/docs/guides/nx-cloud/manual-dte). The agent waits for Nx Cloud to assign tasks that have been distributed by the main CI job via `start-ci-run`. For automatic agent management, use [Nx Agents](/docs/features/ci-features/distribute-task-execution) instead.
338+
339+
**Usage:**
340+
341+
```shell
342+
npx nx-cloud start-agent
343+
```
344+
345+
#### Options
346+
347+
| Option | Type | Description | Default |
348+
| ----------- | ------- | ------------------------------------ | ------- |
349+
| `--verbose` | boolean | Enable verbose logging for debugging | `false` |
350+
351+
#### Environment Variables
352+
353+
Use the `NX_AGENT_NAME` environment variable to assign a name to the agent for identification in logs and the Nx Cloud UI:
354+
355+
```shell
356+
NX_AGENT_NAME=agent-1 npx nx-cloud start-agent
357+
```
358+
359+
For complete examples across different CI providers, see the [Manual Distributed Task Execution guide](/docs/guides/nx-cloud/manual-dte).
360+
335361
### `nx-cloud stop-all-agents`
336362

337363
Same as `npx nx-cloud complete-ci-run`.

astro-docs/src/styles/global.css

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -416,7 +416,7 @@ iframe[src*='youtube'] {
416416
}
417417

418418
table code {
419-
word-wrap: break-word;
419+
white-space: nowrap;
420420
}
421421

422422
[role='tablist'] {

0 commit comments

Comments
 (0)