You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/uipath/docs/cli/index.md
+89Lines changed: 89 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -308,3 +308,92 @@ Processing: uipath.json
308
308
File 'uipath.json' is up to date
309
309
✓ Project pulled successfully
310
310
```
311
+
---
312
+
313
+
::: mkdocs-click
314
+
:module: uipath._cli
315
+
:command: debug
316
+
:depth: 1
317
+
:style: table
318
+
319
+
Runs your agent under the debug runtime, with a debug bridge attached. Locally, the bridge is the interactive **console** (read commands from stdin, stop at breakpoints). In the cloud, the bridge is **SignalR** (driven by Studio Web / Orchestrator). The `--attach` flag lets you override that default, including `none` for executors that need the debug command's surrounding behavior (bindings fetch, state streaming) but cannot speak the interactive debug protocol.
320
+
321
+
### Attach modes
322
+
323
+
| Mode | When to use |
324
+
|------|-------------|
325
+
|`signalr`| Remote runs driven by Studio Web / Orchestrator. Default when `job_id` is set. |
326
+
|`console`| Local interactive debugging from the terminal. Default when no `job_id`. |
327
+
|`none`| Run under the debug command without attaching a debugger. No wait-for-start gate, no breakpoints, no step mode. |
328
+
329
+
/// info
330
+
`--attach` selects the **debug bridge**. It's unrelated to `--debug`, which starts a `debugpy` server for Python-level breakpoints in your IDE. The two can be combined.
331
+
///
332
+
333
+
<!-- termynal -->
334
+
335
+
```shell
336
+
> uipath debug main '{"message": "test"}'
337
+
Debug Mode Commands
338
+
c, continue Continue until next breakpoint
339
+
s, step Step to next node
340
+
b <node> Set breakpoint at <node>
341
+
l, list List all breakpoints
342
+
r <node> Remove breakpoint at <node>
343
+
h, help Show help
344
+
q, quit Exit debugger
345
+
▶ START
346
+
> b analyze_sentiment
347
+
✓ Breakpoint set at: analyze_sentiment
348
+
> c
349
+
────────────────────────────────────────
350
+
■ BREAKPOINT analyze_sentiment (before)
351
+
Next: analyze_sentiment
352
+
────────────────────────────────────────
353
+
> s
354
+
● analyze_sentiment
355
+
> c
356
+
✓ Execution completed
357
+
```
358
+
---
359
+
360
+
::: mkdocs-click
361
+
:module: uipath._cli
362
+
:command: eval
363
+
:depth: 1
364
+
:style: table
365
+
366
+
Runs an evaluation set against your agent. Entry point and evalset are auto-discovered from the project if not passed explicitly. Evaluations run in parallel (see `--workers`) and, unless `--no-report` is passed, results are reported back to Studio Web when `UIPATH_PROJECT_ID` is set.
367
+
368
+
### Common flags
369
+
370
+
| Flag | Purpose |
371
+
|------|---------|
372
+
|`--eval-ids`| Run only a subset of evaluations by id. |
373
+
|`--workers`| Parallel workers for running evaluations (default 1). |
374
+
|`--no-report`| Skip reporting results back to UiPath. |
375
+
|`--enable-mocker-cache`| Cache LLM mocker responses across runs. |
376
+
|`--input-overrides`| Per-eval input overrides, merged into the eval's input. |
377
+
| `--trace-file` | Write OpenTelemetry traces to a JSONL file for offline inspection. |
378
+
| `--resume` | Resume evaluation from a previous suspended state. |
0 commit comments