@botpress/adk-cli 1.19.0-beta.3 → 1.19.0-beta.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (81) hide show
  1. package/assets/ui-dist/assets/{index-CSTz-oTK.js → index-B3b7PPgV.js} +4 -4
  2. package/{dist/index-DNqXHLNi-27nvpkee.js → assets/ui-dist/assets/index-BESZeTO5.js} +2 -2
  3. package/{dist/index-DAztRXeA-vr85xnxs.css → assets/ui-dist/assets/index-DIFGtVmI.css} +1 -1
  4. package/{dist/index-DfjXY3Oo-szsanhnt.js → assets/ui-dist/assets/index-a3ZL0_Jr.js} +2 -2
  5. package/assets/ui-dist/index.html +2 -2
  6. package/dist/{README-wjb7z7f0.md → README-824wa4jj.md} +1 -1
  7. package/dist/SKILL-75ym6tcj.md +257 -0
  8. package/dist/SKILL-chnwzmt1.md +548 -0
  9. package/dist/SKILL-d4bs53y3.md +244 -0
  10. package/dist/SKILL-h4b2f1n9.md +114 -0
  11. package/dist/SKILL-hbw5nt95.md +111 -0
  12. package/dist/actions-h7hxxvxr.md +823 -0
  13. package/dist/adk-build-emhwd0tg.md +39 -0
  14. package/dist/adk-debug-yrrdtpmb.md +23 -0
  15. package/dist/adk-dev-console-7z9rtjpy.md +17 -0
  16. package/dist/adk-document-ras6zzzh.md +68 -0
  17. package/dist/adk-eval-vx76dwq0.md +17 -0
  18. package/dist/adk-explain-fcsaw852.md +22 -0
  19. package/dist/adk-init-9kmxmbbe.md +30 -0
  20. package/dist/adk-ship-dybzn884.md +29 -0
  21. package/dist/adk-test-xq67savs.md +27 -0
  22. package/dist/adk-validate-1p4skv4m.md +31 -0
  23. package/dist/advanced-patterns-z86m9h1a.md +669 -0
  24. package/dist/agent-config-1aqvkrgf.md +450 -0
  25. package/dist/agent-steps-zj4c1n9t.md +115 -0
  26. package/dist/agent0-assets/skills/adk/SKILL.md +5 -5
  27. package/dist/agent0-assets/skills/adk/references/cli.md +265 -24
  28. package/dist/agent0-assets/skills/adk-debugger/SKILL.md +5 -5
  29. package/dist/agent0-assets/skills/adk-debugger/references/common-failures.md +1 -1
  30. package/dist/agent0-assets/skills/adk-debugger/references/debug-workflow.md +3 -3
  31. package/dist/agent0-assets/skills/adk-debugger/references/traces-and-logs.md +15 -7
  32. package/dist/assets-q7jt8r2q.md +237 -0
  33. package/dist/autonomous-execution-fymc12e5.md +747 -0
  34. package/dist/cli-c31e06yr.md +1334 -0
  35. package/dist/cli.js +963 -548
  36. package/dist/commands.json +24 -3
  37. package/dist/common-failures-ht29w2db.md +231 -0
  38. package/dist/component-registry-bbpw0see.md +43 -0
  39. package/dist/context-api-760cvh0h.md +461 -0
  40. package/dist/conversation-analysis-8ka4nrm4.md +420 -0
  41. package/dist/conversation-lifecycle-4seqqjc1.md +311 -0
  42. package/dist/conversations-gwfvxaee.md +1111 -0
  43. package/dist/custom-components-y5wdgpey.md +167 -0
  44. package/dist/debug-workflow-vz84q80v.md +239 -0
  45. package/dist/desk-k54ktvsd.md +852 -0
  46. package/dist/doc-standards-ck6ax2jd.md +124 -0
  47. package/dist/eval-format-7n9brja4.md +354 -0
  48. package/dist/evals-y1zcr1mc.md +11 -0
  49. package/dist/explain-config-1yaq3zzd.md +424 -0
  50. package/dist/files-dzt0wxn3.md +918 -0
  51. package/dist/{index-gqxgqnyz.html → index-3t354nbw.html} +2 -2
  52. package/dist/{index-CSTz-oTK-mdfh47r8.js → index-B3b7PPgV-zetkb01w.js} +4 -4
  53. package/{assets/ui-dist/assets/index-DNqXHLNi.js → dist/index-BESZeTO5-2rpmcefa.js} +2 -2
  54. package/{assets/ui-dist/assets/index-DAztRXeA.css → dist/index-DIFGtVmI-d4dhjg97.css} +1 -1
  55. package/{assets/ui-dist/assets/index-DfjXY3Oo.js → dist/index-a3ZL0_Jr-q145h35p.js} +2 -2
  56. package/dist/integration-actions-xang7tma.md +659 -0
  57. package/dist/integrations-k5ss07f4.md +266 -0
  58. package/dist/interfaces-6t0bpxs4.md +97 -0
  59. package/dist/knowledge-bases-20rg8p5c.md +456 -0
  60. package/dist/llm-debugging-76ng8rzm.md +209 -0
  61. package/dist/mcp-server-n1asyzhv.md +112 -0
  62. package/dist/messages-gkkg0b54.md +769 -0
  63. package/dist/model-configuration-f273kgd0.md +201 -0
  64. package/dist/multi-agent-dashboard-1mdfjdts.md +70 -0
  65. package/dist/pages-xn18xn73.md +273 -0
  66. package/dist/patterns-mistakes-5vb99dhf.md +469 -0
  67. package/dist/plugins-ttnx8f49.md +280 -0
  68. package/dist/tables-x45t36dd.md +1136 -0
  69. package/dist/tags-46td3qrg.md +516 -0
  70. package/dist/test-patterns-hj47w4nc.md +355 -0
  71. package/dist/testing-workflow-2vkp932f.md +225 -0
  72. package/dist/tools-wk7bq24z.md +581 -0
  73. package/dist/trace-summarization-hdyx1c2e.md +313 -0
  74. package/dist/traces-and-logs-f2kjfh19.md +203 -0
  75. package/dist/triggers-4j2cc86x.md +719 -0
  76. package/dist/ui-server-entry.js +977 -162
  77. package/dist/workflow-steps-mrdrf1c5.md +851 -0
  78. package/dist/workflows-gadx3s69.md +1408 -0
  79. package/dist/zai-agent-reference-e6644aad.md +454 -0
  80. package/dist/zai-complete-guide-mnna5d6f.md +1408 -0
  81. package/package.json +4 -4
@@ -16,8 +16,8 @@ cd my-bot
16
16
  # 3. Link explicitly when you know the IDs
17
17
  adk link --workspace ws_123 --bot bot_456
18
18
 
19
- # 4. Start development
20
- adk dev --logs --no-open
19
+ # 4. Start development (CI/agent mode: NDJSON events, no TUI)
20
+ adk dev --non-interactive
21
21
 
22
22
  # 5. Deploy
23
23
  adk deploy --yes
@@ -129,6 +129,24 @@ adk profiles list # List all profiles
129
129
  adk profiles set staging # Switch profile
130
130
  ```
131
131
 
132
+ ### adk logout
133
+
134
+ Remove ADK credentials for the current or a named profile.
135
+
136
+ ```bash
137
+ adk logout [options]
138
+ ```
139
+
140
+ **Options:**
141
+
142
+ - `--profile <profile>` - Profile to remove (defaults to the active profile)
143
+ - `--format <format>` - Output format (`json`)
144
+
145
+ ```bash
146
+ adk logout
147
+ adk logout --profile staging
148
+ ```
149
+
132
150
  ### adk dev
133
151
 
134
152
  Start development mode with hot reloading.
@@ -141,8 +159,10 @@ adk dev [options]
141
159
 
142
160
  - `-p, --port <port>` - Bot port (default: 3000)
143
161
  - `--port-console <port>` - UI console port (default: 3001)
144
- - `-l, --logs` - Stream logs to stderr (no TUI)
145
- - `--no-open` - Do not auto-open the dev console in a browser
162
+ - `--non-interactive` - Emit structured NDJSON events to stdout without the Ink/TUI (CI/agent-friendly)
163
+ - `-v, --verbose` - Show additional details (project path, log file)
164
+ - `--otlp` - Enable OTLP trace export to an external collector (default port 4318)
165
+ - `--port-otlp <port>` - Port for the OTLP collector endpoint (Jaeger, otel-tui, etc.)
146
166
 
147
167
  **What it does:**
148
168
 
@@ -161,16 +181,18 @@ Running `adk dev` in multiple project directories registers each agent with the
161
181
  ```bash
162
182
  adk dev
163
183
 
164
- # CI mode (no TUI)
165
- adk dev --logs
184
+ # CI / agent mode — NDJSON events to stdout, no TUI
185
+ adk dev --non-interactive
166
186
 
167
- # CI mode without opening a browser
168
- adk dev --logs --no-open
187
+ # Custom ports in non-interactive mode
188
+ adk dev --non-interactive --port 4000 --port-console 4001
169
189
  ```
170
190
 
191
+ In `--non-interactive` mode the `lifecycle.ready` event includes `serverPort`, `botPort`, `agentPath`, `healthUrl`, and `botUrl`, so scripts don't need to parse log lines to find them. To discover an already-running Dev Console from a separate process, read `~/.adk/console.port` or run `adk dashboard --no-browser --format json` / `adk ps --format json`.
192
+
171
193
  **Automation notes:**
172
194
 
173
- - `--logs` is the most AI-friendly mode, but `adk dev` is not fully headless.
195
+ - `--non-interactive` is the most AI-friendly mode, but `adk dev` is not fully headless.
174
196
  - Dev can still hit interactive flows such as preflight, knowledge-base sync, or config prompts depending on project state.
175
197
  - Treat `adk dev` as CI-friendly rather than guaranteed prompt-free.
176
198
  - Event-driven integrations are not always perfectly mirrored in local dev; if an event flow behaves strangely, verify it against a deployed bot too.
@@ -186,7 +208,10 @@ adk deploy [options]
186
208
  **Options:**
187
209
 
188
210
  - `-e, --env <environment>` - Target environment (default: "production")
189
- - `-y, --yes` - Auto-approve preflight changes without prompting
211
+ - `-y, --yes` - Auto-approve non-destructive deploy-plan changes without prompting
212
+ - `--confirm-storage-changes` - Explicitly confirm destructive table/KB/asset deletions
213
+ - `--dry-run` - Compute the deploy plan without applying changes
214
+ - `--format <format>` - Output format (`json`; requires `--yes` or `--dry-run`)
190
215
 
191
216
  **What it does:**
192
217
 
@@ -196,6 +221,7 @@ adk deploy [options]
196
221
  4. Deploys bot to Botpress Cloud
197
222
  5. Syncs knowledge bases
198
223
  6. Syncs tables
224
+ 7. Syncs assets
199
225
 
200
226
  **Requires:**
201
227
 
@@ -207,13 +233,19 @@ adk deploy [options]
207
233
  ```bash
208
234
  adk deploy
209
235
 
210
- # Auto-approve preflight changes
236
+ # Auto-approve non-destructive deploy-plan changes
211
237
  adk deploy --yes
238
+
239
+ # Preview deploy plan without applying it
240
+ adk deploy --dry-run
241
+ adk deploy --dry-run --format json
212
242
  ```
213
243
 
214
244
  **Automation notes:**
215
245
 
216
- - `--yes` only auto-approves preflight changes.
246
+ - `--yes` auto-approves non-destructive deploy-plan changes.
247
+ - Destructive table, KB, or asset deletions still require `--confirm-storage-changes`.
248
+ - JSON output requires either `--yes` or `--dry-run`.
217
249
  - Deploy still validates configuration and may require interaction if config values are missing.
218
250
  - Do not assume `adk deploy --yes` is fully non-interactive.
219
251
 
@@ -270,14 +302,27 @@ Chat with your **local development bot**.
270
302
  > ⚠️ `adk chat` (and `adk chat --single`) targets the linked dev bot — the one started by `adk dev` and identified by `devId`. It does **not** hit the deployed production bot. Never use it as a post-deploy smoke test or as any kind of "did the deploy work?" verification: a `--single` round-trip can pass against the dev bot while production is broken. For deployed bots, use `adk status --format json` for metadata and direct the user to the Dev Console for live verification.
271
303
 
272
304
  ```bash
273
- adk chat # interactive
274
- adk chat --single "<message>" # one-shot
305
+ adk chat [options]
306
+ ```
307
+
308
+ **Options:**
309
+
310
+ - `--single <message>` - Send one message, print the response, and exit
311
+ - `--format <format>` - Output format (`json`)
312
+ - `--conversation-id <id>` - Continue an existing conversation (use `--format json` to capture the ID from a prior turn)
313
+ - `--timeout <duration>` - Max wait duration: `500ms`, `30s`, `1m`, `5m` (default: `60s`)
314
+
315
+ ```bash
316
+ adk chat # interactive
317
+ adk chat --single "<message>" # one-shot
275
318
  adk chat --single "<message>" --format json
319
+ adk chat --single "Run the full analysis" --timeout 30s
320
+ adk chat --single "Follow up" --conversation-id <id>
276
321
  ```
277
322
 
278
323
  **Requires:**
279
324
 
280
- - `adk dev` run at least once (creates devId)
325
+ - `adk dev` running (also creates the `devId` on first run). Conversation continuation requires the dev server to be running — the user token is persisted automatically.
281
326
 
282
327
  **Example:**
283
328
 
@@ -332,14 +377,16 @@ adk ps [options]
332
377
 
333
378
  - `--watch [seconds]` - Continuous refresh (default interval: 2s, not supported with `--format json`)
334
379
  - `--cloud` - Include Cloud Dev Console prod selections in the listing
380
+ - `--wide` - Show all columns (runtime, both PIDs, path)
335
381
  - `--format <format>` - `text` (default) or `json`
336
382
 
337
- Shows PID, status, uptime, and ports for each process.
383
+ Shows PID, status, uptime, and ports for each process. If none is running, it prints a friendly empty result instead of starting one.
338
384
 
339
385
  **Example:**
340
386
 
341
387
  ```bash
342
388
  adk ps
389
+ adk ps --wide
343
390
  adk ps --watch
344
391
  adk ps --format json
345
392
  ```
@@ -349,11 +396,22 @@ adk ps --format json
349
396
  Open the Dev Console in standalone mode — no agent project required.
350
397
 
351
398
  ```bash
352
- adk dashboard
399
+ adk dashboard [options]
353
400
  ```
354
401
 
355
402
  Starts the Dev Console UI server and opens the browser. Useful for connecting to Cloud bots or waiting for agents to register. The standalone Dev Console stays alive even with an empty agent registry.
356
403
 
404
+ **Options:**
405
+
406
+ - `--port-console <port>` - Starting port for the console server (default: 3001)
407
+ - `--no-browser` - Do not open the dashboard in a browser (ensures the singleton is running and prints the URL)
408
+ - `--format <format>` - Output format (`json`) — emits `{ port, url, wasSpawned }`
409
+
410
+ ```bash
411
+ adk dashboard # open in browser
412
+ adk dashboard --no-browser --format json # script-friendly: discover the running URL
413
+ ```
414
+
357
415
  ### adk kill
358
416
 
359
417
  Gracefully stop agents or the entire Dev Console.
@@ -406,24 +464,146 @@ adk logs warning since=1h # last hour of warnings
406
464
 
407
465
  ### adk traces
408
466
 
409
- Read execution traces — tool calls, action invocations, LLM steps, error context — for understanding *what happened* during a turn, beyond what `adk logs` reports.
467
+ Read execution traces — tool calls, action invocations, LLM steps, error context — for understanding *what happened* during a turn, beyond what `adk logs` reports. Reads from the local SQLite trace store under `.adk/`.
410
468
 
411
469
  ```bash
412
- adk traces [options]
470
+ adk traces [tokens...] [options]
413
471
  ```
414
472
 
473
+ **Filter tokens** (positional, space-separated):
474
+
475
+ - `error` — only traces that contain errors
476
+ - `workflow=<name>` — filter by workflow name (comma-separated for multiple)
477
+ - `action=<name>` — filter by action/tool name
478
+ - `trigger=<name>` — filter by trigger name
479
+ - `conversation=<id>` — filter by conversation id
480
+ - `trace=<id>` — drill into a specific trace (shows the full span tree)
481
+ - `since=<duration>` / `until=<duration>` — e.g. `30s`, `5m`, `1h`, `2d`, `1w`
482
+ - `limit=<n>` — max traces to show (default: 20)
483
+
415
484
  **Options:**
416
485
 
417
- - `--format <format>` - `text` or `json`
418
- - `--conversation-id <id>` - Filter to a specific conversation
486
+ - `-f, --follow` — stream new traces as they complete
487
+ - `--include-llm` — include LLM instructions, code, and tools in drill-in mode
488
+ - `--format <format>` — `json` only (omit for default text output)
489
+
490
+ **Examples:**
491
+
492
+ ```bash
493
+ adk traces # recent traces
494
+ adk traces error # error traces only
495
+ adk traces workflow=onboarding # traces for a workflow
496
+ adk traces conversation=<id> --format json
497
+ adk traces trace=<id> --include-llm # drill into one trace with LLM content
498
+ adk traces since=1h limit=50 --format json
499
+ adk traces error --follow # stream errors live
500
+ ```
501
+
502
+ ### adk workflows
503
+
504
+ Inspect workflow definitions and runs on the linked dev bot. All `adk workflows ...` commands target the dev bot (same credentials path as `adk dev`) and only accept `--format json` — any other `--format` value is rejected.
505
+
506
+ **Subcommands:**
507
+
508
+ - `adk workflows` / `adk workflows list` — list discovered workflow definitions
509
+ - `adk workflows inspect <name>` — show one workflow's schema and metadata (input schema, schedule, timeout)
510
+ - `adk workflows run <name> [payload]` — kick off a run, optionally waiting for it to finish
511
+ - `adk workflows runs [tokens...|<wrkflow_id>]` — list runs with filters, or dump status + state + steps for one run by id
512
+
513
+ #### adk workflows list
514
+
515
+ ```bash
516
+ adk workflows # list (default)
517
+ adk workflows list --format json
518
+ ```
519
+
520
+ #### adk workflows inspect
521
+
522
+ ```bash
523
+ adk workflows inspect <name> [--format json]
524
+ ```
525
+
526
+ Prints the workflow's input schema, description, schedule (if any), and timeout. Use this before `adk workflows run` to see what payload shape it expects.
527
+
528
+ #### adk workflows run
529
+
530
+ ```bash
531
+ adk workflows run <name> [payload] [--wait] [--timeout <duration>] [--format json]
532
+ ```
533
+
534
+ **Options:**
535
+
536
+ - `[payload]` — JSON string, or pipe via stdin (`echo '{...}' | adk workflows run …`)
537
+ - `--wait` — block until the run reaches a terminal state
538
+ - `--timeout <duration>` — `500ms`, `30s`, `1m`, `5m`; implies `--wait`
539
+ - `--format <format>` — only `json` is accepted; any other value is rejected (defaults to `json` if omitted, unlike sibling commands which default to text)
540
+
541
+ **Examples:**
542
+
543
+ ```bash
544
+ adk workflows run onboarding '{"userId":"123"}'
545
+ adk workflows run onboarding '{"userId":"123"}' --wait --timeout 30s
546
+ echo '{"userId":"123"}' | adk workflows run onboarding --wait
547
+ ```
548
+
549
+ #### adk workflows runs
550
+
551
+ Diagnose durable workflows beyond what `adk logs` and `adk traces` show — list recent runs with filters, or pull the full status + `workflowState` + `workflowSteps` payloads for one run by id.
552
+
553
+ ```bash
554
+ adk workflows runs [tokens...|<wrkflow_id>] [--format json]
555
+ ```
556
+
557
+ **List filters** (passed as `key=value` tokens):
558
+
559
+ - `name=<workflowName>` — filter by workflow definition name
560
+ - `status=<s1[,s2,...]>` — `pending`, `in_progress`, `failed`, `completed`, `listening`, `paused`, `timedout`, `cancelled`
561
+ - `limit=<n>` — cap returned rows
562
+ - `nextToken=<token>` — fetch the next page
563
+
564
+ **Show mode:** pass a workflow instance id (starts with `wrkflow_`) to print one run's metadata plus its `workflowState` and `workflowSteps` payloads. File-swapped payloads are resolved automatically.
565
+
566
+ **Examples:**
567
+
568
+ ```bash
569
+ adk workflows runs # recent runs
570
+ adk workflows runs name=onboarding # filter by definition name
571
+ adk workflows runs status=failed limit=5 # latest 5 failed runs
572
+ adk workflows runs nextToken=<token> # next page
573
+ adk workflows runs wrkflow_01KSF... # one run (status + state + steps)
574
+ ```
575
+
576
+ ### adk conversations
577
+
578
+ List and inspect conversations from the local trace store. Use this to find a conversation id before drilling into it with `adk traces` or `adk conversations show`.
579
+
580
+ ```bash
581
+ adk conversations [list] [tokens...] [--format json]
582
+ adk conversations show <id> [--include-llm] [--format json]
583
+ ```
584
+
585
+ **`list`** (default subcommand) — recent conversations, filtered by positional `key=value` tokens:
586
+
587
+ - `limit=<n>` - max conversations to show (default: 20)
588
+ - `since=<duration>` - only conversations newer than a duration (e.g. `30s`, `5m`, `1h`, `2d`)
589
+
590
+ **`show <id>`** — full timeline and details for one conversation:
591
+
592
+ - `--include-llm` - include LLM reasoning spans
593
+ - `--format <format>` - output format (`json`)
419
594
 
420
595
  **Examples:**
421
596
 
422
597
  ```bash
423
- adk traces --format json
424
- adk traces --conversation-id <id> --format json
598
+ adk conversations # recent conversations (list is default)
599
+ adk conversations list limit=5
600
+ adk conversations list since=1h --format json
601
+ adk conversations show <id> # full timeline
602
+ adk conversations show <id> --include-llm --format json
425
603
  ```
426
604
 
605
+ **Requires:** `adk dev` run at least once (populates the local trace store).
606
+
427
607
  ### adk evals
428
608
 
429
609
  Run automated conversation tests defined under `evals/`.
@@ -634,7 +814,9 @@ adk kb sync [options]
634
814
  - `--prod` - Sync with production bot (required: must use --dev or --prod)
635
815
  - `--dry-run` - Preview changes without applying them
636
816
  - `-y, --yes` - Skip confirmation prompts
817
+ - `--confirm-storage-changes` - Confirm destructive storage changes (KB deletions)
637
818
  - `--force` - Force re-sync all knowledge bases
819
+ - `--format <format>` - Output format (`json`; requires `--yes`)
638
820
 
639
821
  **What it does:**
640
822
 
@@ -654,6 +836,7 @@ adk kb sync --prod
654
836
 
655
837
  # Auto-confirm sync
656
838
  adk kb sync --dev -y
839
+ adk kb sync --dev -y --format json
657
840
 
658
841
  # Preview changes without applying
659
842
  adk kb sync --dev --dry-run
@@ -684,6 +867,7 @@ adk assets sync [options]
684
867
  - `-y, --yes` - Skip confirmation
685
868
  - `--bail-on-failure` - Stop on first error
686
869
  - `--force` - Force re-upload all files
870
+ - `--format <format>` - Output format (`json`; requires `--yes`)
687
871
 
688
872
  **Example:**
689
873
 
@@ -693,6 +877,7 @@ adk assets sync
693
877
 
694
878
  # Auto-confirm
695
879
  adk assets sync -y
880
+ adk assets sync -y --format json
696
881
  ```
697
882
 
698
883
  **Other asset commands:**
@@ -715,13 +900,14 @@ adk assets list [options]
715
900
 
716
901
  - `--local` - Show only local assets
717
902
  - `--remote` - Show only remote assets
903
+ - `--format <format>` - Output format (`json`)
718
904
 
719
905
  ### adk assets status
720
906
 
721
907
  Show asset synchronization status.
722
908
 
723
909
  ```bash
724
- adk assets status
910
+ adk assets status [--format json]
725
911
  ```
726
912
 
727
913
  ### adk assets pull
@@ -826,6 +1012,38 @@ adk config:get botId --prod
826
1012
 
827
1013
  **Note:** This replaces the legacy `adk agent` command.
828
1014
 
1015
+ ### adk secret
1016
+
1017
+ Manage the bot's secrets in the local store. `adk secret` (no subcommand) shows the declared secrets and whether each is set.
1018
+
1019
+ ```bash
1020
+ adk secret [options] # show declared secrets + status
1021
+ adk secret:set <key> <value> [options] # set a secret value
1022
+ adk secret:delete <key> [options] # delete a secret
1023
+ ```
1024
+
1025
+ **Options (all three):**
1026
+
1027
+ - `--prod` - Target the production bot (default: dev)
1028
+ - `--format <format>` - Output format (`json`)
1029
+
1030
+ `<key>` is `SCREAMING_SNAKE_CASE`. `secret:set` never echoes the value back.
1031
+
1032
+ ```bash
1033
+ adk secret # list declared secrets and set/unset status
1034
+ adk secret --prod --format json
1035
+ adk secret:set OPENAI_API_KEY sk-... # set on the dev bot
1036
+ adk secret:delete OPENAI_API_KEY --prod # delete on the prod bot
1037
+ ```
1038
+
1039
+ ### adk models
1040
+
1041
+ List the Cognitive models available to the current bot, grouped by integration (including aliases like `fast` and `best`). Useful when configuring model selection or diagnosing a model-not-found error.
1042
+
1043
+ ```bash
1044
+ adk models [--format json]
1045
+ ```
1046
+
829
1047
  ### adk telemetry
830
1048
 
831
1049
  Manage telemetry preferences.
@@ -1029,6 +1247,18 @@ adk ps # List running agents and processes
1029
1247
  adk dashboard # Open Dev Console standalone (no agent needed)
1030
1248
  adk kill --all # Stop all agents + Dev Console
1031
1249
 
1250
+ # Diagnostics (local trace store)
1251
+ adk logs # Recent log entries
1252
+ adk traces # Execution traces
1253
+ adk conversations # List recent conversations
1254
+ adk conversations show <id> # Inspect one conversation timeline
1255
+
1256
+ # Workflows
1257
+ adk workflows # List discovered workflows
1258
+ adk workflows inspect <name> # Inspect workflow schema
1259
+ adk workflows run <name> # Start a workflow
1260
+ adk workflows runs # List or inspect workflow runs
1261
+
1032
1262
  # Dependencies (integrations, plugins, interfaces)
1033
1263
  adk integrations search <query> # Search for integrations
1034
1264
  adk integrations list # List installed dependencies
@@ -1067,11 +1297,22 @@ adk telemetry # Manage telemetry preferences
1067
1297
  # Authentication
1068
1298
  adk profiles list # List profiles
1069
1299
  adk profiles set # Switch profile
1300
+ adk logout # Remove credentials for a profile
1070
1301
 
1071
1302
  # Configuration
1072
1303
  adk config # Configure agent settings
1073
1304
  adk config:get <key> # Get config value
1074
1305
  adk config:set <key> <value> # Set config value
1306
+ adk secret # Show declared secrets + status
1307
+ adk secret:set <k> <v> # Set a secret
1308
+ adk models # List available Cognitive models
1309
+
1310
+ # Workflows (dev bot only; --format json only)
1311
+ adk workflows # List workflow definitions
1312
+ adk workflows inspect <name> # Show one workflow's schema + metadata
1313
+ adk workflows run <name> [json] # Run a workflow (add --wait to block)
1314
+ adk workflows runs # List recent workflow runs
1315
+ adk workflows runs <wrkflow_id> # Inspect one run (status + state + steps)
1075
1316
 
1076
1317
  # Knowledge Bases
1077
1318
  adk kb sync --dev # Sync KB to development bot
@@ -10,7 +10,7 @@ license: MIT
10
10
 
11
11
  Every ADK agent records its behavior as traces and logs — every conversation turn, tool call, LLM reasoning step, and error. These are the source of truth for understanding what your agent did and why.
12
12
 
13
- The ADK CLI provides all the tools you need to debug. All commands support `--format json` for structured output, which you should always use when consuming output programmatically.
13
+ The ADK CLI provides the tools you need to debug. Most diagnostic commands support `--format json`; use it for programmatic output. The exception is `adk dev`, which has no `--format` flag and uses `adk dev --non-interactive` for structured NDJSON output.
14
14
 
15
15
  ## When to Use This Skill
16
16
 
@@ -78,16 +78,16 @@ Use this skill when the developer asks about:
78
78
  symptom → validate (adk check) → reproduce (adk chat) → logs (adk logs) → traces (adk traces) → root cause → fix → verify
79
79
  ```
80
80
 
81
- ### CLI Commands (always use `--format json`)
81
+ ### CLI Commands (prefer structured output)
82
82
 
83
83
  ```bash
84
84
  adk check --format json # offline validation
85
85
  adk logs error --format json # recent errors
86
86
  adk logs --follow --format json # stream live
87
87
  adk traces --format json # recent traces
88
- adk traces --conversation-id <id> --format json # specific conversation
88
+ adk traces conversation=<id> --format json # specific conversation
89
89
  adk chat --single "msg" --format json # test message
90
- adk dev --non-interactive --format json # structured dev output
90
+ adk dev --non-interactive # structured NDJSON dev output (no TUI)
91
91
  adk conversations --format json # list recent conversations
92
92
  adk conversations show <id> --format json # conversation timeline
93
93
  adk conversations show <id> --include-llm --format json # timeline with LLM reasoning
@@ -109,7 +109,7 @@ adk conversations show <id> --include-llm --format json # timeline with LLM rea
109
109
  Before debugging, verify:
110
110
 
111
111
  - [ ] **Project valid?** Run `adk check --format json` — fix any reported issues first
112
- - [ ] **Dev server running?** `adk dev` (or `adk dev --non-interactive --format json` for structured output)
112
+ - [ ] **Dev server running?** `adk dev` (or `adk dev --non-interactive` for structured NDJSON output)
113
113
  - [ ] **Bot linked?** `agent.json` exists with `botId` and `workspaceId` (created by `adk link`)
114
114
  - [ ] **Dev bot created?** `agent.local.json` has `devId` (set automatically by the first `adk dev` run)
115
115
  - [ ] **Integration configured?** Check Dev Console at localhost:3001 for unconfigured integrations
@@ -2,7 +2,7 @@
2
2
 
3
3
  Each pattern follows: **Symptom → How to Check → Root Cause → Fix**.
4
4
 
5
- Always use `--format json` on CLI commands for structured, parseable output.
5
+ Use `--format json` on diagnostic CLI commands that support it for structured, parseable output.
6
6
 
7
7
  ---
8
8
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  A step-by-step process for diagnosing and fixing issues in ADK agents. Follow these steps in order — each step narrows the problem space.
4
4
 
5
- All CLI commands use `--format json` for structured, parseable output. Make sure `adk dev` is running in the background, once the project is validated.
5
+ Most diagnostic CLI commands use `--format json` for structured, parseable output. Make sure `adk dev` is running in the background, once the project is validated.
6
6
 
7
7
  ---
8
8
 
@@ -95,7 +95,7 @@ Traces show everything the agent did during a conversation turn.
95
95
  adk traces --format json
96
96
 
97
97
  # For a specific conversation
98
- adk traces --conversation-id <id> --format json
98
+ adk traces conversation=<id> --format json
99
99
  ```
100
100
 
101
101
  **Read spans in order.** Look for:
@@ -225,7 +225,7 @@ adk check --format json > check-output.json
225
225
  adk logs error --format json > error-logs.json
226
226
 
227
227
  # Traces from the failing conversation
228
- adk traces --conversation-id <id> --format json > traces.json
228
+ adk traces conversation=<id> --format json > traces.json
229
229
  ```
230
230
 
231
231
  Include:
@@ -4,15 +4,16 @@ Traces and logs are the primary debugging interface for ADK agents. Every conver
4
4
 
5
5
  ## CLI Debugging Tools
6
6
 
7
- All commands support `--format json` for structured output. **Always use `--format json`** when consuming output programmatically.
7
+ Most commands support `--format json` for structured output — **always use it** when consuming output programmatically. The exception is `adk dev`, which has no `--format` flag: use `adk dev --non-interactive` to get a structured NDJSON event stream instead.
8
8
 
9
- | Command | Purpose | Additional Flags |
9
+ | Command | Purpose | Options / tokens |
10
10
  |---------|---------|-----------------|
11
11
  | `adk check --format json` | Offline project validation — catches config/schema issues before runtime | — |
12
12
  | `adk logs --format json` | Browse or stream log entries | `--follow`, `--summary`, level filters (`error`, `warning`) |
13
- | `adk traces --format json` | Query conversation traces with span details | `--conversation-id` |
13
+ | `adk traces --format json` | Query traces with span details — filter by workflow, action, trigger, conversation, error, time | `workflow=`, `action=`, `trigger=`, `conversation=`, `trace=`, `error`, `since=`, `until=`, `limit=`, `--follow`, `--include-llm` |
14
+ | `adk workflows runs --format json` | List or inspect durable workflow runs by id, name, or status | `name=`, `status=`, `limit=`, `nextToken=`, `<wrkflow_id>` |
14
15
  | `adk chat --single "msg" --format json` | Send a test message and get structured response | `--conversation-id` |
15
- | `adk dev --non-interactive --format json` | Start dev server with structured NDJSON event stream (no TUI) | — |
16
+ | `adk dev --non-interactive` | Start dev server with structured NDJSON event stream (no TUI) | — |
16
17
 
17
18
  ## Querying Logs
18
19
 
@@ -35,13 +36,20 @@ adk logs --summary --format json # single snapshot summary
35
36
 
36
37
  ## Querying Traces
37
38
 
38
- Traces provide the full picture of a conversation turn: every span in order.
39
+ Traces provide the full picture of a conversation turn: every span in order. The command takes positional filter tokens (not flags) for slicing the trace store.
39
40
 
40
41
  ```bash
41
- adk traces --format json # recent traces
42
- adk traces --conversation-id <id> --format json # traces for a specific conversation
42
+ adk traces --format json # recent traces (default limit 20)
43
+ adk traces error --format json # error traces only
44
+ adk traces workflow=<name> --format json # traces for a workflow
45
+ adk traces conversation=<id> --format json # traces for a conversation
46
+ adk traces trace=<id> --include-llm --format json # drill into one trace with LLM content
47
+ adk traces since=1h limit=50 --format json # last hour, up to 50
48
+ adk traces error --follow --format json # stream errors live (NDJSON)
43
49
  ```
44
50
 
51
+ Combine tokens freely (`adk traces error workflow=onboarding since=1h`). `--format` only accepts `json`; omit it for the default text output.
52
+
45
53
  ### Trace Structure
46
54
 
47
55
  A trace represents one unit of agent activity. Each trace contains: