@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
@@ -1,6 +1,6 @@
1
1
  {
2
- "version": "1.19.0-beta.3",
3
- "generatedAt": "2026-05-28T20:26:30.899Z",
2
+ "version": "1.19.0-beta.5",
3
+ "generatedAt": "2026-05-29T03:58:08.885Z",
4
4
  "cliName": "adk",
5
5
  "globalOptions": [
6
6
  {
@@ -34,10 +34,31 @@
34
34
  }
35
35
  ]
36
36
  },
37
+ {
38
+ "name": "agent0",
39
+ "fullName": "agent0",
40
+ "description": "Manage Agent(0)",
41
+ "aliases": [],
42
+ "arguments": [],
43
+ "options": []
44
+ },
45
+ {
46
+ "name": "upgrade",
47
+ "fullName": "agent0 upgrade",
48
+ "description": "Create or update the project Agent(0) capability bundle",
49
+ "aliases": [],
50
+ "arguments": [],
51
+ "options": [
52
+ {
53
+ "flags": "--format <format>",
54
+ "description": "output format (json)"
55
+ }
56
+ ]
57
+ },
37
58
  {
38
59
  "name": "ai-upgrade",
39
60
  "fullName": "ai-upgrade",
40
- "description": "Update ADK skills and slash commands from the botpress/skills repository",
61
+ "description": "Update ADK skills and slash commands for external coding agents",
41
62
  "aliases": [],
42
63
  "arguments": [],
43
64
  "options": [
@@ -0,0 +1,231 @@
1
+ # Common Failure Patterns
2
+
3
+ Each pattern follows: **Symptom → How to Check → Root Cause → Fix**.
4
+
5
+ Use `--format json` on diagnostic CLI commands that support it for structured, parseable output.
6
+
7
+ ---
8
+
9
+ ## 1. Project Won't Validate
10
+
11
+ **Symptom:** `adk check --format json` reports errors before you even run the bot.
12
+
13
+ **How to check:**
14
+
15
+ ```bash
16
+ adk check --format json
17
+ ```
18
+
19
+ **Common causes:**
20
+
21
+ - Missing or invalid `agent.config.ts` fields
22
+ - Schema mismatch between action/tool input and output definitions
23
+ - Invalid entity names (too long or contains invalid characters)
24
+ - Missing dependency (integration not added with `adk add`)
25
+ - Import from wrong source (e.g., importing from `@botpress/sdk` instead of `@botpress/runtime`)
26
+ - Invalid table schema definitions
27
+
28
+ **Fix:** Read the `adk check` output — it reports the exact file, field, and error. Fix each reported issue and re-run.
29
+
30
+ **Note:** It does not run full TypeScript type-checking, formatting or linting; that is project specific.
31
+
32
+ ---
33
+
34
+ ## 2. Bot Not Responding
35
+
36
+ **Symptom:** You send a message but get no reply.
37
+
38
+ **How to check:**
39
+
40
+ ```bash
41
+ # Is the dev server running?
42
+ adk logs --format json
43
+
44
+ # Any startup errors?
45
+ adk logs error --format json
46
+
47
+ # Try sending a test message
48
+ adk chat --single "Hello" --format json
49
+ ```
50
+
51
+ **Common causes:**
52
+
53
+ | Cause | How to Verify |
54
+ |-------|--------------|
55
+ | No dev bot created | Check that `agent.local.json` has `devId` (set automatically on the first `adk dev` run, or manually via `adk link --local`). If missing, run `adk dev` at least once to create the dev bot. |
56
+ | Integration not configured | Check Dev Console at localhost:3001 — look for unconfigured integrations |
57
+
58
+ **Fix:** Work through the checklist top to bottom. Most "bot not responding" issues are missing config or a stopped dev server.
59
+
60
+ ---
61
+
62
+ ## 3. Tool Call Errors
63
+
64
+ **Symptom:** The bot tries to use a tool but it fails, or returns unexpected results.
65
+
66
+ **How to check:**
67
+
68
+ ```bash
69
+ adk traces --format json
70
+ ```
71
+
72
+ Look for `tool_call` spans with `success: false`. Some tools could be workflows or actions wrapped as tools: follow the money and find the real source.
73
+
74
+ **Common causes:**
75
+
76
+ | Cause | Trace Evidence |
77
+ |-------|---------------|
78
+ | Handler throws an error | `error` field has the exception message |
79
+ | Input schema mismatch | `error` mentions validation or type error |
80
+ | Integration auth expired | `error` mentions 401, unauthorized, or token expired |
81
+ | Missing integration config | `error` mentions missing configuration or credentials |
82
+
83
+ **Fix:**
84
+
85
+ - **Handler error:** Read the error message, fix the handler code
86
+ - **Schema mismatch:** Compare `input` in the trace against the tool's input schema definition
87
+ - **Auth expired:** Reconfigure the integration in the Dev Console (localhost:3001) which must be done interactively
88
+ - **Missing config:** Run `adk info <integration> --format json` to see required config, then configure in Dev Console which must also be done interactively
89
+
90
+ ---
91
+
92
+ ## 4. Workflow Stuck
93
+
94
+ **Symptom:** A workflow starts but never completes, or a step doesn't execute.
95
+
96
+ **How to check:**
97
+
98
+ ```bash
99
+ adk traces --format json
100
+ ```
101
+
102
+ Look for workflow-related traces that start but have no completion.
103
+
104
+ **Common causes:**
105
+
106
+ - **Step not resuming:** The workflow is waiting for a step that depends on an external event or trigger that hasn't fired
107
+ - **`step.sleep()` still waiting:** A sleep step hasn't expired yet — check the duration
108
+ - **Missing trigger to continue:** A multi-step workflow needs a trigger (e.g., user message, webhook) to resume after a pause
109
+ - **Error in step handler:** A step threw an error silently — check for `code_execution_exception` spans
110
+ - **State lost:** Workflow state wasn't persisted correctly between steps
111
+
112
+ **Fix:** Identify which step the workflow is stuck on, then check that step's handler, triggers, and dependencies.
113
+
114
+ ---
115
+
116
+ ## 5. Integration Failures
117
+
118
+ **Symptom:** Integration actions fail, events don't fire, or channels don't work.
119
+
120
+ **How to check:**
121
+
122
+ ```bash
123
+ # Check logs for integration errors
124
+ adk logs error --format json
125
+
126
+ # Check traces for failed integration calls
127
+ adk traces --format json
128
+ ```
129
+
130
+ Also check the Dev Console at localhost:3001 for integration status.
131
+
132
+ **Common causes:**
133
+
134
+ | Cause | How to Identify |
135
+ |-------|----------------|
136
+ | Auth expired or missing | Error mentions 401, unauthorized, or token |
137
+ | Rate limited | Error mentions 429 or rate limit |
138
+ | Wrong config values | Integration actions fail with config-related errors |
139
+ | Events not registered in dev mode | Events work in production but not locally — re-run `adk dev` |
140
+ | Channel routing misconfigured | Messages arrive but aren't routed to the right conversation handler |
141
+
142
+ **Fix:**
143
+
144
+ - **Auth:** Reconfigure the integration in Dev Console
145
+ - **Rate limits:** Add retry logic or reduce request frequency
146
+ - **Config:** Run `adk info <integration> --format json` to verify required fields, update in Dev Console
147
+ - **Events in dev:** Restart `adk dev` — event registration sometimes needs a fresh start
148
+
149
+ ---
150
+
151
+ ## 6. Build and Deploy Errors
152
+
153
+ **Symptom:** `adk deploy` or `adk build` fails.
154
+
155
+ **How to check:**
156
+
157
+ ```bash
158
+ # Always validate offline first
159
+ adk check --format json
160
+ ```
161
+
162
+ **Common causes:**
163
+
164
+ - **Import from wrong source:** Using `@botpress/sdk` where `@botpress/runtime` is needed (or vice versa)
165
+ - **Schema mismatch:** Action/tool input or output schema doesn't match the handler's actual types
166
+ - **Missing dependency:** Integration referenced in code but not added with `adk add`
167
+ - **Type errors in generated code:** Usually caused by stale generated types — run `adk build` or re-run `adk dev` to regenerate
168
+
169
+ **Fix:** Start with `adk check --format json` — it catches most issues offline. For type errors, try deleting `.adk/` and running `adk build` or re-running `adk dev` to regenerate.
170
+
171
+ ---
172
+
173
+ ## 7. Code Execution Exceptions
174
+
175
+ **Symptom:** The LLMz sandbox throws an error during code execution.
176
+
177
+ **How to check:**
178
+
179
+ ```bash
180
+ adk traces --format json
181
+ ```
182
+
183
+ Look for spans with type `code_execution_exception`.
184
+
185
+ **Key fields:**
186
+
187
+ - `message` — the error message
188
+ - `stackTrace` — full stack trace pointing to the failing line
189
+
190
+ **Common causes:**
191
+
192
+ - Undefined variable or function in the generated code
193
+ - Async operation that wasn't awaited
194
+ - Tool output shape doesn't match what the LLM expected
195
+ - Runtime exception in user-defined code called from the sandbox
196
+
197
+ **Fix:** Read the stack trace. Correlate the line numbers with the generated code or your source. Fix the underlying issue — often a tool's output schema or a missing null check.
198
+
199
+ ---
200
+
201
+ ## 8. Config Confusion: agent.json vs agent.local.json
202
+
203
+ **Symptom:** Bot connects to the wrong workspace, wrong bot ID, or `adk dev`/`adk chat`/`adk deploy` commands fail unexpectedly.
204
+
205
+ ### How the files work
206
+
207
+ | File | Purpose | Git Status | Created By |
208
+ |------|---------|-----------|-----------|
209
+ | `agent.json` | Primary config: `botId`, `workspaceId`, `apiUrl` | Committed | `adk link` |
210
+ | `agent.local.json` | Local overrides: `botId`, `workspaceId`, `apiUrl`, `devId` | Gitignored | `adk dev` or `adk link --local` (sets `devId`), manual edits |
211
+
212
+ **`agent.local.json` fields take precedence over `agent.json` fields.** If both files define `botId`, the local one wins.
213
+
214
+ ### Common issues
215
+
216
+ | Issue | Cause | Fix |
217
+ |-------|-------|-----|
218
+ | Wrong bot ID used | `agent.local.json` overrides `agent.json` botId | Check both files, remove or update the local override |
219
+ | `adk chat` fails with "no devId" | `adk dev` hasn't been run yet (devId not set) | Run `adk dev` at least once to create the dev bot |
220
+ | Different behavior on teammate's machine | They have different `agent.local.json` | Expected — local overrides are per-developer |
221
+ | Deploy targets wrong bot | `agent.json` has wrong botId | Update `agent.json` via `adk link` or `adk config:set` |
222
+
223
+ ### Checking your config
224
+
225
+ ```bash
226
+ # See what's in agent.json
227
+ cat agent.json
228
+
229
+ # See local overrides (if any)
230
+ cat agent.local.json
231
+ ```
@@ -0,0 +1,43 @@
1
+ # Component Registry
2
+
3
+ The Components page (`/components`) lets developers browse, inspect, and install custom webchat components — UI elements the LLM can yield during conversations.
4
+
5
+ Accessed from the **Components** tab group. Available in both dev and production modes.
6
+
7
+ ## Two-Tab Interface
8
+
9
+ ### Installed Tab
10
+
11
+ Shows components currently present in the agent's `src/components/` directory.
12
+
13
+ - Masonry card layout with live component preview (rendered in shadow DOM for style isolation)
14
+ - Click a card to expand an overlay with full component details
15
+ - Reflects hot-reload changes — components update as source files are modified
16
+ - Empty state: "No components installed yet" with guidance to add under `src/components` or pull from the registry
17
+
18
+ ### Registry Tab
19
+
20
+ Shows available components from the external component registry.
21
+
22
+ - Same masonry layout as the Installed tab
23
+ - Click a card to expand an overlay with installation instructions and metadata
24
+ - Empty state: "Registry is empty"
25
+
26
+ ## What Drives the UI
27
+
28
+ The dev console reads component metadata to render previews:
29
+
30
+ - **description** — shown alongside the component card
31
+ - **props** (Zod schema) — drives the props playground form
32
+ - **exampleValues** — seed the preview with realistic data
33
+
34
+ Components without metadata still appear in the Installed tab but have no preview or props form.
35
+
36
+ For how to create components, register metadata, and use them in conversations, see the **custom-components** reference in the ADK skill.
37
+
38
+ ## UI Features
39
+
40
+ - **Shadow DOM previews** — component previews render in isolated shadow DOM to prevent style leaking
41
+ - **Loading skeletons** — placeholder cards while fetching components
42
+ - **Error states** — red alerts if components fail to load or registry fetch fails
43
+ - **Live reload** — listens for component change events and refreshes the gallery