Skip to content

Commit d661280

Browse files
docs(site): align CLI command descriptions with actual help output (#797)
1 parent 6a05326 commit d661280

1 file changed

Lines changed: 15 additions & 15 deletions

File tree

site/src/content/docs/setup/cli.mdx

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -154,23 +154,23 @@ Options:
154154

155155
### `disable [path]`
156156

157-
Set `queueStatus` to `disabled` (or `paused`) on every matched ADO definition.
157+
Set `queueStatus` to `disabled` (or `paused`) on every matched ADO definition. Disabled definitions reject all queue requests; paused definitions queue scheduled runs but hold them without executing.
158158

159159
Options:
160160

161-
- `--paused` -- use `queueStatus: paused` instead of `disabled`; paused definitions still queue scheduled runs but hold the queue, while disabled definitions reject all queue requests
161+
- `--paused` -- set `queueStatus` to `paused` instead of `disabled`
162162
- `--org`, `--project`, `--pat` -- same as `enable`
163-
- `--dry-run` -- print the planned transitions without calling the ADO API
163+
- `--dry-run` -- preview the planned transitions without calling the ADO API
164164

165165
### `remove [path]`
166166

167167
**Destructive.** Delete every matched ADO build definition. Bulk deletes (more than one match) require `--yes`; a single match on a tty prompts interactively.
168168

169169
Options:
170170

171-
- `--yes` -- required for bulk deletes and for any delete in a non-tty context
171+
- `--yes` -- required for bulk deletes (more than one match) and for any delete in a non-tty context
172172
- `--org`, `--project`, `--pat` -- same as `enable`
173-
- `--dry-run` -- print the planned deletions without calling the ADO API
173+
- `--dry-run` -- preview the planned deletions without calling the ADO API
174174

175175
### `list [path]`
176176

@@ -202,32 +202,32 @@ ado-aw run [path] [--wait] [--parameters key=value]
202202
Options:
203203

204204
- `--branch <ref>` -- source branch to queue (defaults to the definition's `defaultBranch`)
205-
- `--parameters <k=v>` -- ADO `templateParameters` as `key=value` pairs; repeatable and/or comma-separated. Values must not contain commas — use one `--parameters` flag per pair when values contain commas.
206-
- `--wait` -- poll each queued build to completion before exiting
207-
- `--poll-interval <secs>` -- polling interval when `--wait` is set (default: `10`)
208-
- `--timeout <secs>` -- maximum wait time when `--wait` is set (default: `1800`)
205+
- `--parameters <k=v>` -- ADO `templateParameters` as `key=value` pairs; repeatable and/or comma-separated. Values must not contain commas — use one `--parameters` flag per pair when values contain commas
206+
- `--wait` -- poll each queued build to completion before exiting; aggregate result determines the exit code
207+
- `--poll-interval <secs>` -- seconds between polls when `--wait` is set (default: `10`)
208+
- `--timeout <secs>` -- maximum seconds to wait when `--wait` is set (default: `1800`)
209209
- `--org`, `--project`, `--pat` -- same as `enable`
210-
- `--dry-run` -- print the planned queue body without calling the ADO API
210+
- `--dry-run` -- preview the planned queue body without calling the ADO API
211211

212212
## Internal / pipeline runtime commands
213213

214214
These commands are used by the compiled pipeline itself and are not typically called by users directly.
215215

216216
### `mcp <output_directory> <bounding_directory>`
217217

218-
Run SafeOutputs as a stdio MCP server (used by Stage 1).
218+
Run SafeOutputs as a stdio MCP server (used by Stage 1). The `<bounding_directory>` guards against directory traversal attacks by ensuring the agent cannot influence folders outside this path.
219219

220220
```bash
221221
ado-aw mcp <output_directory> <bounding_directory> [--enabled-tools <name>]
222222
```
223223

224224
Options:
225225

226-
- `--enabled-tools <name>` -- limit the server to specific tools; repeat to allow more than one
226+
- `--enabled-tools <name>` -- only expose these safe output tools; repeat to allow more than one. If omitted, all tools are exposed
227227

228228
### `mcp-http <output_directory> <bounding_directory>`
229229

230-
Run SafeOutputs as an HTTP MCP server (for MCPG integration).
230+
Run SafeOutputs as an HTTP MCP server (for MCPG integration). The `<bounding_directory>` guards against directory traversal attacks.
231231

232232
```bash
233233
ado-aw mcp-http <output_directory> <bounding_directory> [options]
@@ -236,8 +236,8 @@ ado-aw mcp-http <output_directory> <bounding_directory> [options]
236236
Options:
237237

238238
- `--port <port>` -- port to listen on (default: `8100`)
239-
- `--api-key <key>` -- API key for authentication (auto-generated if not provided)
240-
- `--enabled-tools <name>` -- limit the server to specific tools; repeat to allow more than one
239+
- `--api-key <key>` -- API key for authentication (if not provided, one is generated)
240+
- `--enabled-tools <name>` -- only expose these safe output tools; repeat to allow more than one. If omitted, all tools are exposed
241241

242242
### `execute`
243243

0 commit comments

Comments
 (0)