nodmix 2026.5.25

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 (827) hide show
  1. package/CHANGELOG.md +11573 -0
  2. package/LICENSE +21 -0
  3. package/README.md +486 -0
  4. package/docs/.i18n/README.md +81 -0
  5. package/docs/.i18n/ar-navigation.json +18 -0
  6. package/docs/.i18n/de-navigation.json +18 -0
  7. package/docs/.i18n/es-navigation.json +18 -0
  8. package/docs/.i18n/fr-navigation.json +18 -0
  9. package/docs/.i18n/glossary.ar.json +78 -0
  10. package/docs/.i18n/glossary.de.json +78 -0
  11. package/docs/.i18n/glossary.es.json +78 -0
  12. package/docs/.i18n/glossary.fa.json +78 -0
  13. package/docs/.i18n/glossary.fr.json +78 -0
  14. package/docs/.i18n/glossary.id.json +78 -0
  15. package/docs/.i18n/glossary.it.json +78 -0
  16. package/docs/.i18n/glossary.ja-JP.json +98 -0
  17. package/docs/.i18n/glossary.ko.json +78 -0
  18. package/docs/.i18n/glossary.nl.json +78 -0
  19. package/docs/.i18n/glossary.pl.json +78 -0
  20. package/docs/.i18n/glossary.pt-BR.json +78 -0
  21. package/docs/.i18n/glossary.th.json +78 -0
  22. package/docs/.i18n/glossary.tr.json +78 -0
  23. package/docs/.i18n/glossary.uk.json +78 -0
  24. package/docs/.i18n/glossary.vi.json +78 -0
  25. package/docs/.i18n/glossary.zh-CN.json +1002 -0
  26. package/docs/.i18n/glossary.zh-TW.json +78 -0
  27. package/docs/.i18n/id-navigation.json +18 -0
  28. package/docs/.i18n/it-navigation.json +18 -0
  29. package/docs/.i18n/ja-navigation.json +18 -0
  30. package/docs/.i18n/ko-navigation.json +18 -0
  31. package/docs/.i18n/pl-navigation.json +18 -0
  32. package/docs/.i18n/pt-BR-navigation.json +18 -0
  33. package/docs/.i18n/tr-navigation.json +18 -0
  34. package/docs/.i18n/translation-workflow.md +111 -0
  35. package/docs/.i18n/zh-Hans-navigation.json +542 -0
  36. package/docs/AGENTS.md +36 -0
  37. package/docs/announcements/bluebubbles-imessage.md +79 -0
  38. package/docs/assets/install-script.svg +1 -0
  39. package/docs/assets/macos-onboarding/01-macos-warning.jpeg +0 -0
  40. package/docs/assets/macos-onboarding/02-local-networks.jpeg +0 -0
  41. package/docs/assets/macos-onboarding/03-security-notice.png +0 -0
  42. package/docs/assets/macos-onboarding/04-choose-gateway.png +0 -0
  43. package/docs/assets/macos-onboarding/05-permissions.png +0 -0
  44. package/docs/assets/openclaw-logo-text-dark.png +0 -0
  45. package/docs/assets/openclaw-logo-text-dark.svg +418 -0
  46. package/docs/assets/openclaw-logo-text.png +0 -0
  47. package/docs/assets/openclaw-logo-text.svg +418 -0
  48. package/docs/assets/pixel-lobster.svg +60 -0
  49. package/docs/assets/pr/quick-settings-browser-tools.png +0 -0
  50. package/docs/assets/showcase/agents-ui.jpg +0 -0
  51. package/docs/assets/showcase/bambu-cli.png +0 -0
  52. package/docs/assets/showcase/codexmonitor.png +0 -0
  53. package/docs/assets/showcase/gohome-grafana.png +0 -0
  54. package/docs/assets/showcase/ios-testflight.jpg +0 -0
  55. package/docs/assets/showcase/oura-health.png +0 -0
  56. package/docs/assets/showcase/padel-cli.svg +11 -0
  57. package/docs/assets/showcase/padel-screenshot.jpg +0 -0
  58. package/docs/assets/showcase/papla-tts.jpg +0 -0
  59. package/docs/assets/showcase/pr-review-telegram.jpg +0 -0
  60. package/docs/assets/showcase/roborock-screenshot.jpg +0 -0
  61. package/docs/assets/showcase/roborock-status.svg +13 -0
  62. package/docs/assets/showcase/roof-camera-sky.jpg +0 -0
  63. package/docs/assets/showcase/snag.png +0 -0
  64. package/docs/assets/showcase/tesco-shop.jpg +0 -0
  65. package/docs/assets/showcase/wienerlinien.png +0 -0
  66. package/docs/assets/showcase/wine-cellar-skill.jpg +0 -0
  67. package/docs/assets/showcase/winix-air-purifier.jpg +0 -0
  68. package/docs/assets/showcase/xuezh-pronunciation.jpeg +0 -0
  69. package/docs/assets/sponsors/blacksmith-light.svg +14 -0
  70. package/docs/assets/sponsors/blacksmith.svg +14 -0
  71. package/docs/assets/sponsors/convex-light.svg +16 -0
  72. package/docs/assets/sponsors/convex.svg +16 -0
  73. package/docs/assets/sponsors/github-light.svg +3 -0
  74. package/docs/assets/sponsors/github.svg +3 -0
  75. package/docs/assets/sponsors/nvidia-dark.svg +9 -0
  76. package/docs/assets/sponsors/nvidia.svg +9 -0
  77. package/docs/assets/sponsors/openai-light.svg +3 -0
  78. package/docs/assets/sponsors/openai.svg +3 -0
  79. package/docs/assets/sponsors/vercel-light.svg +5 -0
  80. package/docs/assets/sponsors/vercel.svg +5 -0
  81. package/docs/auth-credential-semantics.md +124 -0
  82. package/docs/automation/auth-monitoring.md +11 -0
  83. package/docs/automation/clawflow.md +12 -0
  84. package/docs/automation/cron-jobs.md +500 -0
  85. package/docs/automation/cron-vs-heartbeat.md +11 -0
  86. package/docs/automation/gmail-pubsub.md +11 -0
  87. package/docs/automation/hooks.md +365 -0
  88. package/docs/automation/index.md +135 -0
  89. package/docs/automation/poll.md +12 -0
  90. package/docs/automation/standing-orders.md +250 -0
  91. package/docs/automation/taskflow.md +155 -0
  92. package/docs/automation/tasks.md +374 -0
  93. package/docs/automation/troubleshooting.md +12 -0
  94. package/docs/automation/webhook.md +12 -0
  95. package/docs/brave-search.md +11 -0
  96. package/docs/channels/access-groups.md +201 -0
  97. package/docs/channels/ambient-room-events.md +214 -0
  98. package/docs/channels/bot-loop-protection.md +131 -0
  99. package/docs/channels/broadcast-groups.md +472 -0
  100. package/docs/channels/channel-routing.md +162 -0
  101. package/docs/channels/clickclack.md +138 -0
  102. package/docs/channels/discord.md +1762 -0
  103. package/docs/channels/feishu.md +502 -0
  104. package/docs/channels/googlechat.md +284 -0
  105. package/docs/channels/group-messages.md +95 -0
  106. package/docs/channels/groups.md +519 -0
  107. package/docs/channels/imessage-from-bluebubbles.md +259 -0
  108. package/docs/channels/imessage.md +813 -0
  109. package/docs/channels/index.md +64 -0
  110. package/docs/channels/irc.md +253 -0
  111. package/docs/channels/line.md +243 -0
  112. package/docs/channels/location.md +71 -0
  113. package/docs/channels/matrix-migration.md +370 -0
  114. package/docs/channels/matrix-presentation.md +77 -0
  115. package/docs/channels/matrix-push-rules.md +150 -0
  116. package/docs/channels/matrix.md +921 -0
  117. package/docs/channels/mattermost.md +542 -0
  118. package/docs/channels/msteams.md +1042 -0
  119. package/docs/channels/nextcloud-talk.md +176 -0
  120. package/docs/channels/nostr.md +253 -0
  121. package/docs/channels/pairing.md +214 -0
  122. package/docs/channels/qqbot.md +309 -0
  123. package/docs/channels/signal.md +400 -0
  124. package/docs/channels/slack.md +1564 -0
  125. package/docs/channels/synology-chat.md +187 -0
  126. package/docs/channels/telegram.md +1107 -0
  127. package/docs/channels/tlon.md +296 -0
  128. package/docs/channels/troubleshooting.md +161 -0
  129. package/docs/channels/twitch.md +431 -0
  130. package/docs/channels/wechat.md +171 -0
  131. package/docs/channels/whatsapp.md +739 -0
  132. package/docs/channels/yuanbao.md +416 -0
  133. package/docs/channels/zalo.md +253 -0
  134. package/docs/channels/zalouser.md +199 -0
  135. package/docs/ci.md +612 -0
  136. package/docs/clawhub/publishing.md +96 -0
  137. package/docs/cli/acp.md +370 -0
  138. package/docs/cli/agent.md +103 -0
  139. package/docs/cli/agents.md +232 -0
  140. package/docs/cli/approvals.md +190 -0
  141. package/docs/cli/backup.md +97 -0
  142. package/docs/cli/browser.md +307 -0
  143. package/docs/cli/channels.md +154 -0
  144. package/docs/cli/clawbot.md +25 -0
  145. package/docs/cli/commitments.md +90 -0
  146. package/docs/cli/completion.md +39 -0
  147. package/docs/cli/config.md +504 -0
  148. package/docs/cli/configure.md +77 -0
  149. package/docs/cli/crestodian.md +332 -0
  150. package/docs/cli/cron.md +281 -0
  151. package/docs/cli/daemon.md +67 -0
  152. package/docs/cli/dashboard.md +33 -0
  153. package/docs/cli/devices.md +204 -0
  154. package/docs/cli/directory.md +68 -0
  155. package/docs/cli/dns.md +53 -0
  156. package/docs/cli/docs.md +73 -0
  157. package/docs/cli/doctor.md +237 -0
  158. package/docs/cli/flows.md +52 -0
  159. package/docs/cli/gateway.md +567 -0
  160. package/docs/cli/health.md +43 -0
  161. package/docs/cli/hooks.md +345 -0
  162. package/docs/cli/index.md +396 -0
  163. package/docs/cli/infer.md +364 -0
  164. package/docs/cli/logs.md +65 -0
  165. package/docs/cli/mcp.md +529 -0
  166. package/docs/cli/memory.md +183 -0
  167. package/docs/cli/message.md +317 -0
  168. package/docs/cli/migrate.md +290 -0
  169. package/docs/cli/models.md +224 -0
  170. package/docs/cli/node.md +177 -0
  171. package/docs/cli/nodes.md +76 -0
  172. package/docs/cli/onboard.md +245 -0
  173. package/docs/cli/pairing.md +77 -0
  174. package/docs/cli/path.md +502 -0
  175. package/docs/cli/plugins.md +454 -0
  176. package/docs/cli/policy.md +418 -0
  177. package/docs/cli/proxy.md +89 -0
  178. package/docs/cli/qr.md +56 -0
  179. package/docs/cli/reset.md +39 -0
  180. package/docs/cli/sandbox.md +208 -0
  181. package/docs/cli/secrets.md +202 -0
  182. package/docs/cli/security.md +124 -0
  183. package/docs/cli/sessions.md +164 -0
  184. package/docs/cli/setup.md +59 -0
  185. package/docs/cli/skills.md +102 -0
  186. package/docs/cli/status.md +45 -0
  187. package/docs/cli/system.md +89 -0
  188. package/docs/cli/tasks.md +111 -0
  189. package/docs/cli/tui.md +89 -0
  190. package/docs/cli/uninstall.md +44 -0
  191. package/docs/cli/update.md +242 -0
  192. package/docs/cli/voicecall.md +204 -0
  193. package/docs/cli/webhooks.md +117 -0
  194. package/docs/cli/wiki.md +256 -0
  195. package/docs/concepts/active-memory.md +856 -0
  196. package/docs/concepts/agent-loop.md +185 -0
  197. package/docs/concepts/agent-runtimes.md +243 -0
  198. package/docs/concepts/agent-workspace.md +230 -0
  199. package/docs/concepts/agent.md +136 -0
  200. package/docs/concepts/architecture.md +154 -0
  201. package/docs/concepts/channel-docking.md +145 -0
  202. package/docs/concepts/commitments.md +150 -0
  203. package/docs/concepts/compaction.md +203 -0
  204. package/docs/concepts/context-engine.md +306 -0
  205. package/docs/concepts/context.md +199 -0
  206. package/docs/concepts/delegate-architecture.md +319 -0
  207. package/docs/concepts/dreaming.md +261 -0
  208. package/docs/concepts/experimental-features.md +108 -0
  209. package/docs/concepts/features.md +91 -0
  210. package/docs/concepts/mantis-slack-desktop-runbook.md +202 -0
  211. package/docs/concepts/mantis.md +740 -0
  212. package/docs/concepts/markdown-formatting.md +139 -0
  213. package/docs/concepts/memory-builtin.md +146 -0
  214. package/docs/concepts/memory-honcho.md +144 -0
  215. package/docs/concepts/memory-qmd.md +271 -0
  216. package/docs/concepts/memory-search.md +166 -0
  217. package/docs/concepts/memory.md +258 -0
  218. package/docs/concepts/message-lifecycle-refactor.md +1128 -0
  219. package/docs/concepts/messages.md +214 -0
  220. package/docs/concepts/model-failover.md +385 -0
  221. package/docs/concepts/model-providers.md +715 -0
  222. package/docs/concepts/models.md +370 -0
  223. package/docs/concepts/multi-agent.md +619 -0
  224. package/docs/concepts/oauth.md +198 -0
  225. package/docs/concepts/openclaw-sdk.md +323 -0
  226. package/docs/concepts/parallel-specialist-lanes.md +127 -0
  227. package/docs/concepts/personal-agent-benchmark-pack.md +74 -0
  228. package/docs/concepts/presence.md +117 -0
  229. package/docs/concepts/progress-drafts.md +362 -0
  230. package/docs/concepts/qa-e2e-automation.md +820 -0
  231. package/docs/concepts/qa-matrix.md +139 -0
  232. package/docs/concepts/queue-steering.md +90 -0
  233. package/docs/concepts/queue.md +122 -0
  234. package/docs/concepts/retry.md +86 -0
  235. package/docs/concepts/session-pruning.md +104 -0
  236. package/docs/concepts/session-tool.md +190 -0
  237. package/docs/concepts/session.md +164 -0
  238. package/docs/concepts/soul.md +116 -0
  239. package/docs/concepts/streaming.md +251 -0
  240. package/docs/concepts/system-prompt.md +310 -0
  241. package/docs/concepts/timezone.md +47 -0
  242. package/docs/concepts/typebox.md +309 -0
  243. package/docs/concepts/typing-indicators.md +88 -0
  244. package/docs/concepts/usage-tracking.md +66 -0
  245. package/docs/date-time.md +126 -0
  246. package/docs/debug/node-issue.md +90 -0
  247. package/docs/diagnostics/flags.md +138 -0
  248. package/docs/docs.json +1832 -0
  249. package/docs/gateway/authentication.md +239 -0
  250. package/docs/gateway/background-process.md +147 -0
  251. package/docs/gateway/bonjour.md +303 -0
  252. package/docs/gateway/bridge-protocol.md +94 -0
  253. package/docs/gateway/cli-backends.md +420 -0
  254. package/docs/gateway/config-agents.md +1514 -0
  255. package/docs/gateway/config-channels.md +945 -0
  256. package/docs/gateway/config-tools.md +769 -0
  257. package/docs/gateway/configuration-examples.md +705 -0
  258. package/docs/gateway/configuration-reference.md +1393 -0
  259. package/docs/gateway/configuration.md +737 -0
  260. package/docs/gateway/diagnostics.md +213 -0
  261. package/docs/gateway/discovery.md +154 -0
  262. package/docs/gateway/doctor.md +574 -0
  263. package/docs/gateway/gateway-lock.md +37 -0
  264. package/docs/gateway/health.md +73 -0
  265. package/docs/gateway/heartbeat.md +493 -0
  266. package/docs/gateway/index.md +383 -0
  267. package/docs/gateway/local-model-services.md +205 -0
  268. package/docs/gateway/local-models.md +355 -0
  269. package/docs/gateway/logging.md +149 -0
  270. package/docs/gateway/multiple-gateways.md +178 -0
  271. package/docs/gateway/network-model.md +15 -0
  272. package/docs/gateway/openai-http-api.md +350 -0
  273. package/docs/gateway/openresponses-http-api.md +347 -0
  274. package/docs/gateway/openshell.md +316 -0
  275. package/docs/gateway/opentelemetry.md +404 -0
  276. package/docs/gateway/operator-scopes.md +111 -0
  277. package/docs/gateway/pairing.md +207 -0
  278. package/docs/gateway/prometheus.md +230 -0
  279. package/docs/gateway/protocol.md +803 -0
  280. package/docs/gateway/remote-gateway-readme.md +169 -0
  281. package/docs/gateway/remote.md +280 -0
  282. package/docs/gateway/sandbox-vs-tool-policy-vs-elevated.md +146 -0
  283. package/docs/gateway/sandboxing.md +545 -0
  284. package/docs/gateway/secrets-plan-contract.md +114 -0
  285. package/docs/gateway/secrets.md +609 -0
  286. package/docs/gateway/security/audit-checks.md +127 -0
  287. package/docs/gateway/security/index.md +1326 -0
  288. package/docs/gateway/security/secure-file-operations.md +76 -0
  289. package/docs/gateway/tailscale.md +156 -0
  290. package/docs/gateway/tools-invoke-http-api.md +169 -0
  291. package/docs/gateway/troubleshooting.md +772 -0
  292. package/docs/gateway/trusted-proxy-auth.md +451 -0
  293. package/docs/help/debugging.md +344 -0
  294. package/docs/help/environment.md +214 -0
  295. package/docs/help/faq-first-run.md +867 -0
  296. package/docs/help/faq-models.md +553 -0
  297. package/docs/help/faq.md +1975 -0
  298. package/docs/help/gpt55-codex-agentic-parity-maintainers.md +196 -0
  299. package/docs/help/gpt55-codex-agentic-parity.md +230 -0
  300. package/docs/help/index.md +39 -0
  301. package/docs/help/scripts.md +56 -0
  302. package/docs/help/testing-live.md +580 -0
  303. package/docs/help/testing-updates-plugins.md +291 -0
  304. package/docs/help/testing.md +928 -0
  305. package/docs/help/troubleshooting.md +424 -0
  306. package/docs/images/configure-model-picker-unsearchable.png +0 -0
  307. package/docs/images/feishu-get-group-id.png +0 -0
  308. package/docs/images/groups-flow.svg +52 -0
  309. package/docs/images/mobile-ui-screenshot.png +0 -0
  310. package/docs/index.md +196 -0
  311. package/docs/install/ansible.md +233 -0
  312. package/docs/install/azure.md +315 -0
  313. package/docs/install/bun.md +59 -0
  314. package/docs/install/clawdock.md +112 -0
  315. package/docs/install/development-channels.md +135 -0
  316. package/docs/install/digitalocean.md +174 -0
  317. package/docs/install/docker-vm-runtime.md +154 -0
  318. package/docs/install/docker.md +562 -0
  319. package/docs/install/exe-dev.md +201 -0
  320. package/docs/install/fly.md +524 -0
  321. package/docs/install/gcp.md +418 -0
  322. package/docs/install/hetzner.md +285 -0
  323. package/docs/install/hostinger.md +98 -0
  324. package/docs/install/index.md +221 -0
  325. package/docs/install/installer.md +455 -0
  326. package/docs/install/kubernetes.md +196 -0
  327. package/docs/install/macos-vm.md +281 -0
  328. package/docs/install/migrating-claude.md +165 -0
  329. package/docs/install/migrating-hermes.md +177 -0
  330. package/docs/install/migrating.md +137 -0
  331. package/docs/install/nix.md +112 -0
  332. package/docs/install/node.md +142 -0
  333. package/docs/install/northflank.mdx +44 -0
  334. package/docs/install/oracle.md +218 -0
  335. package/docs/install/podman.md +210 -0
  336. package/docs/install/railway.mdx +92 -0
  337. package/docs/install/raspberry-pi.md +234 -0
  338. package/docs/install/render.mdx +167 -0
  339. package/docs/install/uninstall.md +131 -0
  340. package/docs/install/updating.md +280 -0
  341. package/docs/logging.md +318 -0
  342. package/docs/nav-tabs-underline.js +100 -0
  343. package/docs/network.md +72 -0
  344. package/docs/nodes/audio.md +215 -0
  345. package/docs/nodes/camera.md +166 -0
  346. package/docs/nodes/images.md +77 -0
  347. package/docs/nodes/index.md +439 -0
  348. package/docs/nodes/location-command.md +102 -0
  349. package/docs/nodes/media-understanding.md +469 -0
  350. package/docs/nodes/talk.md +154 -0
  351. package/docs/nodes/troubleshooting.md +123 -0
  352. package/docs/nodes/voicewake.md +93 -0
  353. package/docs/perplexity.md +11 -0
  354. package/docs/pi-dev.md +82 -0
  355. package/docs/pi.md +573 -0
  356. package/docs/plan/codex-context-engine-harness.md +624 -0
  357. package/docs/plan/ui-channels.md +284 -0
  358. package/docs/platforms/android.md +285 -0
  359. package/docs/platforms/digitalocean.md +12 -0
  360. package/docs/platforms/index.md +60 -0
  361. package/docs/platforms/ios.md +283 -0
  362. package/docs/platforms/linux.md +141 -0
  363. package/docs/platforms/mac/bundled-gateway.md +79 -0
  364. package/docs/platforms/mac/canvas.md +128 -0
  365. package/docs/platforms/mac/child-process.md +72 -0
  366. package/docs/platforms/mac/dev-setup.md +112 -0
  367. package/docs/platforms/mac/health.md +39 -0
  368. package/docs/platforms/mac/icon.md +36 -0
  369. package/docs/platforms/mac/logging.md +62 -0
  370. package/docs/platforms/mac/menu-bar.md +93 -0
  371. package/docs/platforms/mac/peekaboo.md +92 -0
  372. package/docs/platforms/mac/permissions.md +53 -0
  373. package/docs/platforms/mac/remote.md +123 -0
  374. package/docs/platforms/mac/signing.md +52 -0
  375. package/docs/platforms/mac/skills.md +43 -0
  376. package/docs/platforms/mac/voice-overlay.md +66 -0
  377. package/docs/platforms/mac/voicewake.md +73 -0
  378. package/docs/platforms/mac/webchat.md +54 -0
  379. package/docs/platforms/mac/xpc.md +66 -0
  380. package/docs/platforms/macos.md +226 -0
  381. package/docs/platforms/oracle.md +12 -0
  382. package/docs/platforms/raspberry-pi.md +13 -0
  383. package/docs/platforms/windows.md +286 -0
  384. package/docs/plugins/adding-capabilities.md +133 -0
  385. package/docs/plugins/admin-http-rpc.md +216 -0
  386. package/docs/plugins/agent-tools.md +13 -0
  387. package/docs/plugins/architecture-internals.md +1195 -0
  388. package/docs/plugins/architecture.md +481 -0
  389. package/docs/plugins/building-extensions.md +13 -0
  390. package/docs/plugins/building-plugins.md +330 -0
  391. package/docs/plugins/bundles.md +310 -0
  392. package/docs/plugins/cli-backend-plugins.md +310 -0
  393. package/docs/plugins/codex-computer-use.md +293 -0
  394. package/docs/plugins/codex-harness-reference.md +409 -0
  395. package/docs/plugins/codex-harness-runtime.md +247 -0
  396. package/docs/plugins/codex-harness.md +746 -0
  397. package/docs/plugins/codex-native-plugins.md +276 -0
  398. package/docs/plugins/community.md +77 -0
  399. package/docs/plugins/compatibility.md +164 -0
  400. package/docs/plugins/dependency-resolution.md +143 -0
  401. package/docs/plugins/google-meet.md +1737 -0
  402. package/docs/plugins/hooks.md +459 -0
  403. package/docs/plugins/install-overrides.md +80 -0
  404. package/docs/plugins/manage-plugins.md +210 -0
  405. package/docs/plugins/manifest.md +1359 -0
  406. package/docs/plugins/memory-lancedb.md +385 -0
  407. package/docs/plugins/memory-wiki.md +529 -0
  408. package/docs/plugins/message-presentation.md +473 -0
  409. package/docs/plugins/oc-path.md +166 -0
  410. package/docs/plugins/plugin-inventory.md +182 -0
  411. package/docs/plugins/reference/acpx.md +23 -0
  412. package/docs/plugins/reference/admin-http-rpc.md +23 -0
  413. package/docs/plugins/reference/alibaba.md +23 -0
  414. package/docs/plugins/reference/amazon-bedrock-mantle.md +23 -0
  415. package/docs/plugins/reference/amazon-bedrock.md +23 -0
  416. package/docs/plugins/reference/anthropic-vertex.md +19 -0
  417. package/docs/plugins/reference/anthropic.md +23 -0
  418. package/docs/plugins/reference/arcee.md +23 -0
  419. package/docs/plugins/reference/azure-speech.md +23 -0
  420. package/docs/plugins/reference/bonjour.md +19 -0
  421. package/docs/plugins/reference/brave.md +23 -0
  422. package/docs/plugins/reference/browser.md +23 -0
  423. package/docs/plugins/reference/byteplus.md +19 -0
  424. package/docs/plugins/reference/canvas.md +19 -0
  425. package/docs/plugins/reference/cerebras.md +23 -0
  426. package/docs/plugins/reference/chutes.md +23 -0
  427. package/docs/plugins/reference/clickclack.md +23 -0
  428. package/docs/plugins/reference/cloudflare-ai-gateway.md +23 -0
  429. package/docs/plugins/reference/codex.md +23 -0
  430. package/docs/plugins/reference/comfy.md +23 -0
  431. package/docs/plugins/reference/copilot-proxy.md +19 -0
  432. package/docs/plugins/reference/deepgram.md +23 -0
  433. package/docs/plugins/reference/deepinfra.md +23 -0
  434. package/docs/plugins/reference/deepseek.md +23 -0
  435. package/docs/plugins/reference/diagnostics-otel.md +19 -0
  436. package/docs/plugins/reference/diagnostics-prometheus.md +19 -0
  437. package/docs/plugins/reference/diffs.md +19 -0
  438. package/docs/plugins/reference/discord.md +23 -0
  439. package/docs/plugins/reference/document-extract.md +23 -0
  440. package/docs/plugins/reference/duckduckgo.md +23 -0
  441. package/docs/plugins/reference/elevenlabs.md +23 -0
  442. package/docs/plugins/reference/exa.md +23 -0
  443. package/docs/plugins/reference/fal.md +23 -0
  444. package/docs/plugins/reference/feishu.md +23 -0
  445. package/docs/plugins/reference/file-transfer.md +19 -0
  446. package/docs/plugins/reference/firecrawl.md +23 -0
  447. package/docs/plugins/reference/fireworks.md +23 -0
  448. package/docs/plugins/reference/github-copilot.md +23 -0
  449. package/docs/plugins/reference/google-meet.md +23 -0
  450. package/docs/plugins/reference/google.md +23 -0
  451. package/docs/plugins/reference/googlechat.md +23 -0
  452. package/docs/plugins/reference/gradium.md +23 -0
  453. package/docs/plugins/reference/groq.md +23 -0
  454. package/docs/plugins/reference/huggingface.md +23 -0
  455. package/docs/plugins/reference/imessage.md +23 -0
  456. package/docs/plugins/reference/inworld.md +23 -0
  457. package/docs/plugins/reference/irc.md +23 -0
  458. package/docs/plugins/reference/kilocode.md +23 -0
  459. package/docs/plugins/reference/kimi.md +23 -0
  460. package/docs/plugins/reference/line.md +23 -0
  461. package/docs/plugins/reference/litellm.md +23 -0
  462. package/docs/plugins/reference/llm-task.md +19 -0
  463. package/docs/plugins/reference/lmstudio.md +23 -0
  464. package/docs/plugins/reference/lobster.md +19 -0
  465. package/docs/plugins/reference/matrix.md +23 -0
  466. package/docs/plugins/reference/mattermost.md +23 -0
  467. package/docs/plugins/reference/memory-core.md +19 -0
  468. package/docs/plugins/reference/memory-lancedb.md +23 -0
  469. package/docs/plugins/reference/memory-wiki.md +23 -0
  470. package/docs/plugins/reference/microsoft-foundry.md +19 -0
  471. package/docs/plugins/reference/microsoft.md +19 -0
  472. package/docs/plugins/reference/migrate-claude.md +19 -0
  473. package/docs/plugins/reference/migrate-hermes.md +19 -0
  474. package/docs/plugins/reference/minimax.md +23 -0
  475. package/docs/plugins/reference/mistral.md +23 -0
  476. package/docs/plugins/reference/moonshot.md +23 -0
  477. package/docs/plugins/reference/msteams.md +23 -0
  478. package/docs/plugins/reference/nextcloud-talk.md +23 -0
  479. package/docs/plugins/reference/nostr.md +23 -0
  480. package/docs/plugins/reference/nvidia.md +23 -0
  481. package/docs/plugins/reference/oc-path.md +23 -0
  482. package/docs/plugins/reference/ollama.md +23 -0
  483. package/docs/plugins/reference/open-prose.md +19 -0
  484. package/docs/plugins/reference/openai.md +23 -0
  485. package/docs/plugins/reference/opencode-go.md +23 -0
  486. package/docs/plugins/reference/opencode.md +23 -0
  487. package/docs/plugins/reference/openrouter.md +23 -0
  488. package/docs/plugins/reference/openshell.md +19 -0
  489. package/docs/plugins/reference/perplexity.md +23 -0
  490. package/docs/plugins/reference/policy.md +23 -0
  491. package/docs/plugins/reference/qa-channel.md +23 -0
  492. package/docs/plugins/reference/qa-lab.md +19 -0
  493. package/docs/plugins/reference/qa-matrix.md +19 -0
  494. package/docs/plugins/reference/qianfan.md +23 -0
  495. package/docs/plugins/reference/qqbot.md +23 -0
  496. package/docs/plugins/reference/qwen.md +23 -0
  497. package/docs/plugins/reference/runway.md +23 -0
  498. package/docs/plugins/reference/searxng.md +19 -0
  499. package/docs/plugins/reference/senseaudio.md +23 -0
  500. package/docs/plugins/reference/sglang.md +23 -0
  501. package/docs/plugins/reference/signal.md +23 -0
  502. package/docs/plugins/reference/skill-workshop.md +23 -0
  503. package/docs/plugins/reference/slack.md +23 -0
  504. package/docs/plugins/reference/stepfun.md +23 -0
  505. package/docs/plugins/reference/synology-chat.md +23 -0
  506. package/docs/plugins/reference/synthetic.md +23 -0
  507. package/docs/plugins/reference/tavily.md +23 -0
  508. package/docs/plugins/reference/telegram.md +23 -0
  509. package/docs/plugins/reference/tencent.md +23 -0
  510. package/docs/plugins/reference/tlon.md +23 -0
  511. package/docs/plugins/reference/together.md +23 -0
  512. package/docs/plugins/reference/tokenjuice.md +23 -0
  513. package/docs/plugins/reference/tts-local-cli.md +19 -0
  514. package/docs/plugins/reference/twitch.md +23 -0
  515. package/docs/plugins/reference/venice.md +23 -0
  516. package/docs/plugins/reference/vercel-ai-gateway.md +23 -0
  517. package/docs/plugins/reference/vllm.md +23 -0
  518. package/docs/plugins/reference/voice-call.md +23 -0
  519. package/docs/plugins/reference/volcengine.md +23 -0
  520. package/docs/plugins/reference/voyage.md +19 -0
  521. package/docs/plugins/reference/vydra.md +23 -0
  522. package/docs/plugins/reference/web-readability.md +19 -0
  523. package/docs/plugins/reference/webhooks.md +23 -0
  524. package/docs/plugins/reference/whatsapp.md +23 -0
  525. package/docs/plugins/reference/xai.md +23 -0
  526. package/docs/plugins/reference/xiaomi.md +23 -0
  527. package/docs/plugins/reference/zai.md +23 -0
  528. package/docs/plugins/reference/zalo.md +23 -0
  529. package/docs/plugins/reference/zalouser.md +24 -0
  530. package/docs/plugins/reference.md +138 -0
  531. package/docs/plugins/sdk-agent-harness.md +339 -0
  532. package/docs/plugins/sdk-channel-ingress.md +137 -0
  533. package/docs/plugins/sdk-channel-message.md +458 -0
  534. package/docs/plugins/sdk-channel-plugins.md +762 -0
  535. package/docs/plugins/sdk-channel-turn.md +580 -0
  536. package/docs/plugins/sdk-entrypoints.md +333 -0
  537. package/docs/plugins/sdk-migration.md +949 -0
  538. package/docs/plugins/sdk-overview.md +501 -0
  539. package/docs/plugins/sdk-provider-plugins.md +807 -0
  540. package/docs/plugins/sdk-runtime.md +676 -0
  541. package/docs/plugins/sdk-setup.md +550 -0
  542. package/docs/plugins/sdk-subpaths.md +396 -0
  543. package/docs/plugins/sdk-testing.md +401 -0
  544. package/docs/plugins/skill-workshop.md +713 -0
  545. package/docs/plugins/tool-plugins.md +411 -0
  546. package/docs/plugins/voice-call.md +943 -0
  547. package/docs/plugins/webhooks.md +192 -0
  548. package/docs/plugins/zalouser.md +86 -0
  549. package/docs/prose.md +137 -0
  550. package/docs/providers/alibaba.md +158 -0
  551. package/docs/providers/anthropic.md +344 -0
  552. package/docs/providers/arcee.md +144 -0
  553. package/docs/providers/azure-speech.md +119 -0
  554. package/docs/providers/bedrock-mantle.md +211 -0
  555. package/docs/providers/bedrock.md +414 -0
  556. package/docs/providers/cerebras.md +130 -0
  557. package/docs/providers/chutes.md +153 -0
  558. package/docs/providers/claude-max-api-proxy.md +188 -0
  559. package/docs/providers/cloudflare-ai-gateway.md +119 -0
  560. package/docs/providers/comfy.md +362 -0
  561. package/docs/providers/deepgram.md +184 -0
  562. package/docs/providers/deepinfra.md +87 -0
  563. package/docs/providers/deepseek.md +146 -0
  564. package/docs/providers/ds4.md +309 -0
  565. package/docs/providers/elevenlabs.md +130 -0
  566. package/docs/providers/fal.md +204 -0
  567. package/docs/providers/fireworks.md +144 -0
  568. package/docs/providers/github-copilot.md +225 -0
  569. package/docs/providers/glm.md +137 -0
  570. package/docs/providers/google.md +472 -0
  571. package/docs/providers/gradium.md +123 -0
  572. package/docs/providers/groq.md +180 -0
  573. package/docs/providers/huggingface.md +235 -0
  574. package/docs/providers/index.md +102 -0
  575. package/docs/providers/inferrs.md +272 -0
  576. package/docs/providers/inworld.md +120 -0
  577. package/docs/providers/kilocode.md +135 -0
  578. package/docs/providers/litellm.md +234 -0
  579. package/docs/providers/lmstudio.md +224 -0
  580. package/docs/providers/minimax.md +505 -0
  581. package/docs/providers/mistral.md +235 -0
  582. package/docs/providers/models.md +65 -0
  583. package/docs/providers/moonshot.md +413 -0
  584. package/docs/providers/nvidia.md +140 -0
  585. package/docs/providers/ollama.md +1180 -0
  586. package/docs/providers/openai.md +1057 -0
  587. package/docs/providers/opencode-go.md +123 -0
  588. package/docs/providers/opencode.md +149 -0
  589. package/docs/providers/openrouter.md +349 -0
  590. package/docs/providers/perplexity-provider.md +123 -0
  591. package/docs/providers/qianfan.md +132 -0
  592. package/docs/providers/qwen.md +332 -0
  593. package/docs/providers/runway.md +103 -0
  594. package/docs/providers/senseaudio.md +68 -0
  595. package/docs/providers/sglang.md +161 -0
  596. package/docs/providers/stepfun.md +229 -0
  597. package/docs/providers/synthetic.md +154 -0
  598. package/docs/providers/tencent.md +130 -0
  599. package/docs/providers/together.md +141 -0
  600. package/docs/providers/venice.md +315 -0
  601. package/docs/providers/vercel-ai-gateway.md +128 -0
  602. package/docs/providers/vllm.md +383 -0
  603. package/docs/providers/volcengine.md +199 -0
  604. package/docs/providers/vydra.md +180 -0
  605. package/docs/providers/xai.md +560 -0
  606. package/docs/providers/xiaomi.md +188 -0
  607. package/docs/providers/zai.md +203 -0
  608. package/docs/refactor/access.md +9 -0
  609. package/docs/refactor/acp.md +298 -0
  610. package/docs/refactor/canvas.md +131 -0
  611. package/docs/refactor/ingress-core.md +341 -0
  612. package/docs/reference/AGENTS.default.md +129 -0
  613. package/docs/reference/RELEASING.md +767 -0
  614. package/docs/reference/api-usage-costs.md +202 -0
  615. package/docs/reference/application-modernization-plan.md +208 -0
  616. package/docs/reference/code-mode.md +757 -0
  617. package/docs/reference/credits.md +33 -0
  618. package/docs/reference/device-models.md +50 -0
  619. package/docs/reference/full-release-validation.md +202 -0
  620. package/docs/reference/memory-config.md +630 -0
  621. package/docs/reference/openclaw-sdk-api-design.md +390 -0
  622. package/docs/reference/prompt-caching.md +358 -0
  623. package/docs/reference/rich-output-protocol.md +79 -0
  624. package/docs/reference/rpc.md +43 -0
  625. package/docs/reference/secretref-credential-surface.md +159 -0
  626. package/docs/reference/secretref-user-supplied-credentials-matrix.json +663 -0
  627. package/docs/reference/session-management-compaction.md +461 -0
  628. package/docs/reference/templates/AGENTS.dev.md +89 -0
  629. package/docs/reference/templates/AGENTS.md +225 -0
  630. package/docs/reference/templates/BOOT.md +16 -0
  631. package/docs/reference/templates/BOOTSTRAP.md +66 -0
  632. package/docs/reference/templates/HEARTBEAT.md +16 -0
  633. package/docs/reference/templates/IDENTITY.dev.md +52 -0
  634. package/docs/reference/templates/IDENTITY.md +34 -0
  635. package/docs/reference/templates/SOUL.dev.md +82 -0
  636. package/docs/reference/templates/SOUL.md +49 -0
  637. package/docs/reference/templates/TOOLS.dev.md +29 -0
  638. package/docs/reference/templates/TOOLS.md +51 -0
  639. package/docs/reference/templates/USER.dev.md +23 -0
  640. package/docs/reference/templates/USER.md +28 -0
  641. package/docs/reference/test.md +239 -0
  642. package/docs/reference/token-use.md +233 -0
  643. package/docs/reference/transcript-hygiene.md +214 -0
  644. package/docs/reference/wizard.md +252 -0
  645. package/docs/security/CONTRIBUTING-THREAT-MODEL.md +101 -0
  646. package/docs/security/THREAT-MODEL-ATLAS.md +611 -0
  647. package/docs/security/formal-verification.md +170 -0
  648. package/docs/security/incident-response.md +59 -0
  649. package/docs/security/network-proxy.md +268 -0
  650. package/docs/snippets/plugin-publish/minimal-openclaw.plugin.json +12 -0
  651. package/docs/snippets/plugin-publish/minimal-package.json +16 -0
  652. package/docs/start/bootstrapping.md +49 -0
  653. package/docs/start/docs-directory.md +69 -0
  654. package/docs/start/getting-started.md +152 -0
  655. package/docs/start/hubs.md +201 -0
  656. package/docs/start/lore.md +223 -0
  657. package/docs/start/onboarding-overview.md +72 -0
  658. package/docs/start/onboarding.md +95 -0
  659. package/docs/start/openclaw.md +244 -0
  660. package/docs/start/quickstart.md +25 -0
  661. package/docs/start/setup.md +178 -0
  662. package/docs/start/showcase.md +383 -0
  663. package/docs/start/wizard-cli-automation.md +232 -0
  664. package/docs/start/wizard-cli-reference.md +331 -0
  665. package/docs/start/wizard.md +141 -0
  666. package/docs/style.css +184 -0
  667. package/docs/superpowers/specs/2026-04-22-tweakcn-custom-theme-import-design.md +316 -0
  668. package/docs/tools/acp-agents-setup.md +352 -0
  669. package/docs/tools/acp-agents.md +847 -0
  670. package/docs/tools/agent-send.md +112 -0
  671. package/docs/tools/apply-patch.md +64 -0
  672. package/docs/tools/brave-search.md +139 -0
  673. package/docs/tools/browser-control.md +391 -0
  674. package/docs/tools/browser-linux-troubleshooting.md +173 -0
  675. package/docs/tools/browser-login.md +77 -0
  676. package/docs/tools/browser-wsl2-windows-remote-cdp-troubleshooting.md +219 -0
  677. package/docs/tools/browser.md +769 -0
  678. package/docs/tools/btw.md +159 -0
  679. package/docs/tools/capability-cookbook.md +12 -0
  680. package/docs/tools/clawhub.md +5 -0
  681. package/docs/tools/code-execution.md +173 -0
  682. package/docs/tools/creating-skills.md +120 -0
  683. package/docs/tools/diffs.md +506 -0
  684. package/docs/tools/duckduckgo-search.md +109 -0
  685. package/docs/tools/elevated.md +128 -0
  686. package/docs/tools/exa-search.md +152 -0
  687. package/docs/tools/exec-approvals-advanced.md +360 -0
  688. package/docs/tools/exec-approvals.md +474 -0
  689. package/docs/tools/exec.md +282 -0
  690. package/docs/tools/firecrawl.md +155 -0
  691. package/docs/tools/gemini-search.md +114 -0
  692. package/docs/tools/grok-search.md +113 -0
  693. package/docs/tools/image-generation.md +433 -0
  694. package/docs/tools/index.md +178 -0
  695. package/docs/tools/kimi-search.md +105 -0
  696. package/docs/tools/llm-task.md +137 -0
  697. package/docs/tools/lobster.md +365 -0
  698. package/docs/tools/loop-detection.md +154 -0
  699. package/docs/tools/media-overview.md +157 -0
  700. package/docs/tools/minimax-search.md +102 -0
  701. package/docs/tools/multi-agent-sandbox-tools.md +409 -0
  702. package/docs/tools/music-generation.md +371 -0
  703. package/docs/tools/ollama-search.md +153 -0
  704. package/docs/tools/pdf.md +195 -0
  705. package/docs/tools/perplexity-search.md +220 -0
  706. package/docs/tools/plugin.md +327 -0
  707. package/docs/tools/reactions.md +100 -0
  708. package/docs/tools/searxng-search.md +141 -0
  709. package/docs/tools/skills-config.md +195 -0
  710. package/docs/tools/skills.md +535 -0
  711. package/docs/tools/slash-commands.md +488 -0
  712. package/docs/tools/steer.md +84 -0
  713. package/docs/tools/subagents.md +650 -0
  714. package/docs/tools/tavily.md +162 -0
  715. package/docs/tools/thinking.md +140 -0
  716. package/docs/tools/tokenjuice.md +81 -0
  717. package/docs/tools/tool-search.md +269 -0
  718. package/docs/tools/trajectory.md +229 -0
  719. package/docs/tools/tts.md +1004 -0
  720. package/docs/tools/video-generation.md +552 -0
  721. package/docs/tools/web-fetch.md +195 -0
  722. package/docs/tools/web.md +459 -0
  723. package/docs/tts.md +11 -0
  724. package/docs/vps.md +139 -0
  725. package/docs/web/control-ui.md +503 -0
  726. package/docs/web/dashboard.md +107 -0
  727. package/docs/web/index.md +133 -0
  728. package/docs/web/tui.md +246 -0
  729. package/docs/web/webchat.md +99 -0
  730. package/docs/whatsapp-openclaw-ai-zh.jpg +0 -0
  731. package/docs/whatsapp-openclaw.jpg +0 -0
  732. package/nodmix.mjs +487 -0
  733. package/package.json +1852 -0
  734. package/patches/.gitkeep +0 -0
  735. package/patches/@agentclientprotocol__claude-agent-acp@0.36.1.patch +41 -0
  736. package/pnpm-workspace.yaml +63 -0
  737. package/scripts/crabbox-wrapper.mjs +353 -0
  738. package/scripts/lib/official-external-channel-catalog.json +559 -0
  739. package/scripts/lib/official-external-plugin-catalog.json +192 -0
  740. package/scripts/lib/official-external-provider-catalog.json +117 -0
  741. package/scripts/lib/package-dist-imports.mjs +171 -0
  742. package/scripts/npm-runner.mjs +91 -0
  743. package/scripts/postinstall-bundled-plugins.mjs +978 -0
  744. package/scripts/preinstall-package-manager-warning.mjs +64 -0
  745. package/scripts/windows-cmd-helpers.mjs +20 -0
  746. package/skills/1password/SKILL.md +70 -0
  747. package/skills/1password/references/cli-examples.md +29 -0
  748. package/skills/1password/references/get-started.md +17 -0
  749. package/skills/apple-notes/SKILL.md +77 -0
  750. package/skills/apple-reminders/SKILL.md +118 -0
  751. package/skills/bear-notes/SKILL.md +107 -0
  752. package/skills/blogwatcher/SKILL.md +69 -0
  753. package/skills/blucli/SKILL.md +47 -0
  754. package/skills/camsnap/SKILL.md +45 -0
  755. package/skills/canvas/SKILL.md +78 -0
  756. package/skills/clawhub/SKILL.md +77 -0
  757. package/skills/coding-agent/SKILL.md +149 -0
  758. package/skills/diagram-maker/SKILL.md +53 -0
  759. package/skills/diagram-maker/references/excalidraw-patterns.md +85 -0
  760. package/skills/diagram-maker/references/svg-template.md +112 -0
  761. package/skills/discord/SKILL.md +136 -0
  762. package/skills/eightctl/SKILL.md +50 -0
  763. package/skills/gemini/SKILL.md +47 -0
  764. package/skills/gh-issues/SKILL.md +213 -0
  765. package/skills/gifgrep/SKILL.md +85 -0
  766. package/skills/github/SKILL.md +84 -0
  767. package/skills/gog/SKILL.md +116 -0
  768. package/skills/goplaces/SKILL.md +52 -0
  769. package/skills/healthcheck/SKILL.md +105 -0
  770. package/skills/himalaya/SKILL.md +80 -0
  771. package/skills/himalaya/references/configuration.md +184 -0
  772. package/skills/himalaya/references/message-composition.md +199 -0
  773. package/skills/imsg/SKILL.md +122 -0
  774. package/skills/mcporter/SKILL.md +61 -0
  775. package/skills/meme-maker/SKILL.md +42 -0
  776. package/skills/meme-maker/references/templates.json +358 -0
  777. package/skills/meme-maker/scripts/meme.mjs +398 -0
  778. package/skills/model-usage/SKILL.md +69 -0
  779. package/skills/model-usage/references/codexbar-cli.md +33 -0
  780. package/skills/model-usage/scripts/model_usage.py +319 -0
  781. package/skills/model-usage/scripts/test_model_usage.py +40 -0
  782. package/skills/nano-pdf/SKILL.md +38 -0
  783. package/skills/node-connect/SKILL.md +142 -0
  784. package/skills/node-inspect-debugger/SKILL.md +85 -0
  785. package/skills/notion/SKILL.md +150 -0
  786. package/skills/obsidian/SKILL.md +119 -0
  787. package/skills/openai-whisper/SKILL.md +38 -0
  788. package/skills/openai-whisper-api/SKILL.md +71 -0
  789. package/skills/openai-whisper-api/scripts/transcribe.sh +154 -0
  790. package/skills/openhue/SKILL.md +112 -0
  791. package/skills/oracle/SKILL.md +126 -0
  792. package/skills/ordercli/SKILL.md +78 -0
  793. package/skills/peekaboo/SKILL.md +190 -0
  794. package/skills/pyproject.toml +10 -0
  795. package/skills/python-debugpy/SKILL.md +73 -0
  796. package/skills/sag/SKILL.md +87 -0
  797. package/skills/session-logs/SKILL.md +151 -0
  798. package/skills/sherpa-onnx-tts/SKILL.md +109 -0
  799. package/skills/sherpa-onnx-tts/bin/sherpa-onnx-tts +178 -0
  800. package/skills/skill-creator/SKILL.md +78 -0
  801. package/skills/skill-creator/license.txt +202 -0
  802. package/skills/skill-creator/scripts/init_skill.py +378 -0
  803. package/skills/skill-creator/scripts/package_skill.py +139 -0
  804. package/skills/skill-creator/scripts/quick_validate.py +169 -0
  805. package/skills/skill-creator/scripts/test_package_skill.py +161 -0
  806. package/skills/skill-creator/scripts/test_quick_validate.py +116 -0
  807. package/skills/slack/SKILL.md +78 -0
  808. package/skills/songsee/SKILL.md +49 -0
  809. package/skills/sonoscli/SKILL.md +65 -0
  810. package/skills/spike/SKILL.md +51 -0
  811. package/skills/spotify-player/SKILL.md +64 -0
  812. package/skills/summarize/SKILL.md +87 -0
  813. package/skills/taskflow/SKILL.md +149 -0
  814. package/skills/taskflow/examples/inbox-triage.lobster +33 -0
  815. package/skills/taskflow/examples/pr-intake.lobster +32 -0
  816. package/skills/taskflow-inbox-triage/SKILL.md +119 -0
  817. package/skills/things-mac/SKILL.md +86 -0
  818. package/skills/tmux/SKILL.md +91 -0
  819. package/skills/tmux/scripts/find-sessions.sh +112 -0
  820. package/skills/tmux/scripts/wait-for-text.sh +83 -0
  821. package/skills/trello/SKILL.md +108 -0
  822. package/skills/video-frames/SKILL.md +46 -0
  823. package/skills/video-frames/scripts/frame.sh +81 -0
  824. package/skills/voice-call/SKILL.md +45 -0
  825. package/skills/wacli/SKILL.md +72 -0
  826. package/skills/weather/SKILL.md +64 -0
  827. package/skills/xurl/SKILL.md +120 -0
@@ -0,0 +1,928 @@
1
+ ---
2
+ summary: "Testing kit: unit/e2e/live suites, Docker runners, and what each test covers"
3
+ read_when:
4
+ - Running tests locally or in CI
5
+ - Adding regressions for model/provider bugs
6
+ - Debugging gateway + agent behavior
7
+ title: "Testing"
8
+ ---
9
+
10
+ Nodmix has three Vitest suites (unit/integration, e2e, live) and a small set
11
+ of Docker runners. This doc is a "how we test" guide:
12
+
13
+ - What each suite covers (and what it deliberately does _not_ cover).
14
+ - Which commands to run for common workflows (local, pre-push, debugging).
15
+ - How live tests discover credentials and select models/providers.
16
+ - How to add regressions for real-world model/provider issues.
17
+
18
+ <Note>
19
+ **QA stack (qa-lab, qa-channel, live transport lanes)** is documented separately:
20
+
21
+ - [QA overview](/concepts/qa-e2e-automation) - architecture, command surface, scenario authoring.
22
+ - [Matrix QA](/concepts/qa-matrix) - reference for `pnpm nodmix qa matrix`.
23
+ - [QA channel](/channels/qa-channel) - the synthetic transport plugin used by repo-backed scenarios.
24
+
25
+ This page covers running the regular test suites and Docker/Parallels runners. The QA-specific runners section below ([QA-specific runners](#qa-specific-runners)) lists the concrete `qa` invocations and points back at the references above.
26
+ </Note>
27
+
28
+ ## Quick start
29
+
30
+ Most days:
31
+
32
+ - Full gate (expected before push): `pnpm build && pnpm check && pnpm check:test-types && pnpm test`
33
+ - Faster local full-suite run on a roomy machine: `pnpm test:max`
34
+ - Direct Vitest watch loop: `pnpm test:watch`
35
+ - Direct file targeting now routes extension/channel paths too: `pnpm test extensions/discord/src/monitor/message-handler.preflight.test.ts`
36
+ - Prefer targeted runs first when you are iterating on a single failure.
37
+ - Docker-backed QA site: `pnpm qa:lab:up`
38
+ - Linux VM-backed QA lane: `pnpm nodmix qa suite --runner multipass --scenario channel-chat-baseline`
39
+
40
+ When you touch tests or want extra confidence:
41
+
42
+ - Coverage gate: `pnpm test:coverage`
43
+ - E2E suite: `pnpm test:e2e`
44
+
45
+ When debugging real providers/models (requires real creds):
46
+
47
+ - Live suite (models + gateway tool/image probes): `pnpm test:live`
48
+ - Target one live file quietly: `pnpm test:live -- src/agents/models.profiles.live.test.ts`
49
+ - Runtime performance reports: dispatch `Nodmix Performance` with
50
+ `live_openai_candidate=true` for a real `openai/gpt-5.5` agent turn or
51
+ `deep_profile=true` for Kova CPU/heap/trace artifacts. Daily scheduled runs
52
+ publish mock-provider, deep-profile, and GPT 5.5 lane artifacts to
53
+ `nodmix/clawgrit-reports` when `CLAWGRIT_REPORTS_TOKEN` is configured. The
54
+ mock-provider report also includes source-level gateway boot, memory,
55
+ plugin-pressure, repeated fake-model hello-loop, and CLI startup numbers.
56
+ - Docker live model sweep: `pnpm test:docker:live-models`
57
+ - Each selected model now runs a text turn plus a small file-read-style probe.
58
+ Models whose metadata advertises `image` input also run a tiny image turn.
59
+ Disable the extra probes with `NODMIX_LIVE_MODEL_FILE_PROBE=0` or
60
+ `NODMIX_LIVE_MODEL_IMAGE_PROBE=0` when isolating provider failures.
61
+ - CI coverage: daily `Nodmix Scheduled Live And E2E Checks` and manual
62
+ `Nodmix Release Checks` both call the reusable live/E2E workflow with
63
+ `include_live_suites: true`, which includes separate Docker live model
64
+ matrix jobs sharded by provider.
65
+ - For focused CI reruns, dispatch `Nodmix Live And E2E Checks (Reusable)`
66
+ with `include_live_suites: true` and `live_models_only: true`.
67
+ - Add new high-signal provider secrets to `scripts/ci-hydrate-live-auth.sh`
68
+ plus `.github/workflows/nodmix-live-and-e2e-checks-reusable.yml` and its
69
+ scheduled/release callers.
70
+ - Native Codex bound-chat smoke: `pnpm test:docker:live-codex-bind`
71
+ - Runs a Docker live lane against the Codex app-server path, binds a synthetic
72
+ Slack DM with `/codex bind`, exercises `/codex fast` and
73
+ `/codex permissions`, then verifies a plain reply and an image attachment
74
+ route through the native plugin binding instead of ACP.
75
+ - Codex app-server harness smoke: `pnpm test:docker:live-codex-harness`
76
+ - Runs gateway agent turns through the plugin-owned Codex app-server harness,
77
+ verifies `/codex status` and `/codex models`, and by default exercises image,
78
+ cron MCP, sub-agent, and Guardian probes. Disable the sub-agent probe with
79
+ `NODMIX_LIVE_CODEX_HARNESS_SUBAGENT_PROBE=0` when isolating other Codex
80
+ app-server failures. For a focused sub-agent check, disable the other probes:
81
+ `NODMIX_LIVE_CODEX_HARNESS_IMAGE_PROBE=0 NODMIX_LIVE_CODEX_HARNESS_MCP_PROBE=0 NODMIX_LIVE_CODEX_HARNESS_GUARDIAN_PROBE=0 NODMIX_LIVE_CODEX_HARNESS_SUBAGENT_PROBE=1 pnpm test:docker:live-codex-harness`.
82
+ This exits after the sub-agent probe unless
83
+ `NODMIX_LIVE_CODEX_HARNESS_SUBAGENT_ONLY=0` is set.
84
+ - Codex on-demand install smoke: `pnpm test:docker:codex-on-demand`
85
+ - Installs the packaged Nodmix tarball in Docker, runs OpenAI API-key
86
+ onboarding, and verifies the Codex plugin plus `@openai/codex` dependency
87
+ were downloaded into the managed npm root on demand.
88
+ - Live plugin tool dependency smoke: `pnpm test:docker:live-plugin-tool`
89
+ - Packs a fixture plugin with a real `slugify` dependency, installs it through
90
+ `npm-pack:`, verifies the dependency under the managed npm root, then asks a
91
+ live OpenAI model to call the plugin tool and return the hidden slug.
92
+ - Crestodian rescue command smoke: `pnpm test:live:crestodian-rescue-channel`
93
+ - Opt-in belt-and-suspenders check for the message-channel rescue command
94
+ surface. It exercises `/crestodian status`, queues a persistent model
95
+ change, replies `/crestodian yes`, and verifies the audit/config write path.
96
+ - Crestodian planner Docker smoke: `pnpm test:docker:crestodian-planner`
97
+ - Runs Crestodian in a configless container with a fake Claude CLI on `PATH`
98
+ and verifies the fuzzy planner fallback translates into an audited typed
99
+ config write.
100
+ - Crestodian first-run Docker smoke: `pnpm test:docker:crestodian-first-run`
101
+ - Starts from an empty Nodmix state dir, routes bare `nodmix` to
102
+ Crestodian, applies setup/model/agent/Discord plugin + SecretRef writes,
103
+ validates config, and verifies audit entries. The same Ring 0 setup path is
104
+ also covered in QA Lab by
105
+ `pnpm nodmix qa suite --scenario crestodian-ring-zero-setup`.
106
+ - Moonshot/Kimi cost smoke: with `MOONSHOT_API_KEY` set, run
107
+ `nodmix models list --provider moonshot --json`, then run an isolated
108
+ `nodmix agent --local --session-id live-kimi-cost --message 'Reply exactly: KIMI_LIVE_OK' --thinking off --json`
109
+ against `moonshot/kimi-k2.6`. Verify the JSON reports Moonshot/K2.6 and the
110
+ assistant transcript stores normalized `usage.cost`.
111
+
112
+ <Tip>
113
+ When you only need one failing case, prefer narrowing live tests via the allowlist env vars described below.
114
+ </Tip>
115
+
116
+ ## QA-specific runners
117
+
118
+ These commands sit beside the main test suites when you need QA-lab realism:
119
+
120
+ CI runs QA Lab in dedicated workflows. Agentic parity is nested under
121
+ `QA-Lab - All Lanes` and release validation, not a standalone PR workflow.
122
+ Broad validation should use `Full Release Validation` with
123
+ `rerun_group=qa-parity` or the release-checks QA group. Stable/default release
124
+ checks keep exhaustive live/Docker soak behind `run_release_soak=true`; the
125
+ `full` profile forces soak on. `QA-Lab - All Lanes`
126
+ runs nightly on `main` and from manual dispatch with the mock parity lane, live
127
+ Matrix lane, Convex-managed live Telegram lane, and Convex-managed live Discord
128
+ lane as parallel jobs. Scheduled QA and release checks pass Matrix
129
+ `--profile fast` explicitly, while the Matrix CLI and manual workflow input
130
+ default remain `all`; manual dispatch can shard `all` into `transport`,
131
+ `media`, `e2ee-smoke`, `e2ee-deep`, and `e2ee-cli` jobs. `Nodmix Release
132
+ Checks` runs parity plus the fast Matrix and Telegram lanes before release
133
+ approval, using `mock-openai/gpt-5.5` for release transport checks so they stay
134
+ deterministic and avoid normal provider-plugin startup. These live transport
135
+ gateways disable memory search; memory behavior stays covered by the QA parity
136
+ suites.
137
+
138
+ Full release live media shards use
139
+ `ghcr.io/nodmix/nodmix-live-media-runner:ubuntu-24.04`, which already has
140
+ `ffmpeg` and `ffprobe`. Docker live model/backend shards use the shared
141
+ `ghcr.io/nodmix/nodmix-live-test:<sha>` image built once per selected
142
+ commit, then pull it with `NODMIX_SKIP_DOCKER_BUILD=1` instead of rebuilding
143
+ inside every shard.
144
+
145
+ - `pnpm nodmix qa suite`
146
+ - Runs repo-backed QA scenarios directly on the host.
147
+ - Runs multiple selected scenarios in parallel by default with isolated
148
+ gateway workers. `qa-channel` defaults to concurrency 4 (bounded by the
149
+ selected scenario count). Use `--concurrency <count>` to tune the worker
150
+ count, or `--concurrency 1` for the older serial lane.
151
+ - Exits non-zero when any scenario fails. Use `--allow-failures` when you
152
+ want artifacts without a failing exit code.
153
+ - Supports provider modes `live-frontier`, `mock-openai`, and `aimock`.
154
+ `aimock` starts a local AIMock-backed provider server for experimental
155
+ fixture and protocol-mock coverage without replacing the scenario-aware
156
+ `mock-openai` lane.
157
+ - `pnpm test:plugins:kitchen-sink-live`
158
+ - Runs the live OpenAI Kitchen Sink plugin gauntlet through QA Lab. It
159
+ installs the external Kitchen Sink package, verifies the plugin SDK surface
160
+ inventory, probes `/healthz` and `/readyz`, records gateway CPU/RSS
161
+ evidence, runs a live OpenAI turn, and checks adversarial diagnostics.
162
+ Requires live OpenAI auth such as `OPENAI_API_KEY`. In hydrated Testbox
163
+ sessions it automatically sources the Testbox live-auth profile when the
164
+ `nodmix-testbox-env` helper is present.
165
+ - `pnpm test:gateway:cpu-scenarios`
166
+ - Runs the gateway startup bench plus a small mock QA Lab scenario pack
167
+ (`channel-chat-baseline`, `memory-failure-fallback`,
168
+ `gateway-restart-inflight-run`) and writes a combined CPU observation
169
+ summary under `.artifacts/gateway-cpu-scenarios/`.
170
+ - Flags only sustained hot CPU observations by default (`--cpu-core-warn`
171
+ plus `--hot-wall-warn-ms`), so short startup bursts are recorded as metrics
172
+ without looking like the minutes-long gateway peg regression.
173
+ - Uses built `dist` artifacts; run a build first when the checkout does not
174
+ already have fresh runtime output.
175
+ - `pnpm nodmix qa suite --runner multipass`
176
+ - Runs the same QA suite inside a disposable Multipass Linux VM.
177
+ - Keeps the same scenario-selection behavior as `qa suite` on the host.
178
+ - Reuses the same provider/model selection flags as `qa suite`.
179
+ - Live runs forward the supported QA auth inputs that are practical for the guest:
180
+ env-based provider keys, the QA live provider config path, and `CODEX_HOME`
181
+ when present.
182
+ - Output dirs must stay under the repo root so the guest can write back through
183
+ the mounted workspace.
184
+ - Writes the normal QA report + summary plus Multipass logs under
185
+ `.artifacts/qa-e2e/...`.
186
+ - `pnpm qa:lab:up`
187
+ - Starts the Docker-backed QA site for operator-style QA work.
188
+ - `pnpm test:docker:npm-onboard-channel-agent`
189
+ - Builds an npm tarball from the current checkout, installs it globally in
190
+ Docker, runs non-interactive OpenAI API-key onboarding, configures Telegram
191
+ by default, verifies the packaged plugin runtime loads without startup
192
+ dependency repair, runs doctor, and runs one local agent turn against a
193
+ mocked OpenAI endpoint.
194
+ - Use `NODMIX_NPM_ONBOARD_CHANNEL=discord` to run the same packaged-install
195
+ lane with Discord.
196
+ - `pnpm test:docker:session-runtime-context`
197
+ - Runs a deterministic built-app Docker smoke for embedded runtime context
198
+ transcripts. It verifies hidden Nodmix runtime context is persisted as a
199
+ non-display custom message instead of leaking into the visible user turn,
200
+ then seeds an affected broken session JSONL and verifies
201
+ `nodmix doctor --fix` rewrites it to the active branch with a backup.
202
+ - `pnpm test:docker:npm-telegram-live`
203
+ - Installs an Nodmix package candidate in Docker, runs installed-package
204
+ onboarding, configures Telegram through the installed CLI, then reuses the
205
+ live Telegram QA lane with that installed package as the SUT Gateway.
206
+ - The wrapper mounts only the `qa-lab` harness source from the checkout; the
207
+ installed package owns `dist`, `nodmix/plugin-sdk`, and bundled plugin
208
+ runtime so the lane does not mix current checkout plugins into the package
209
+ under test.
210
+ - Defaults to `NODMIX_NPM_TELEGRAM_PACKAGE_SPEC=nodmix@beta`; set
211
+ `NODMIX_NPM_TELEGRAM_PACKAGE_TGZ=/path/to/nodmix-current.tgz` or
212
+ `NODMIX_CURRENT_PACKAGE_TGZ` to test a resolved local tarball instead of
213
+ installing from the registry.
214
+ - Uses the same Telegram env credentials or Convex credential source as
215
+ `pnpm nodmix qa telegram`. For CI/release automation, set
216
+ `NODMIX_NPM_TELEGRAM_CREDENTIAL_SOURCE=convex` plus
217
+ `NODMIX_QA_CONVEX_SITE_URL` and the role secret. If
218
+ `NODMIX_QA_CONVEX_SITE_URL` and a Convex role secret are present in CI,
219
+ the Docker wrapper selects Convex automatically.
220
+ - The wrapper validates Telegram or Convex credential env on the host before
221
+ Docker build/install work. Set `NODMIX_NPM_TELEGRAM_SKIP_CREDENTIAL_PREFLIGHT=1`
222
+ only when deliberately debugging pre-credential setup.
223
+ - `NODMIX_NPM_TELEGRAM_CREDENTIAL_ROLE=ci|maintainer` overrides the shared
224
+ `NODMIX_QA_CREDENTIAL_ROLE` for this lane only.
225
+ - GitHub Actions exposes this lane as the manual maintainer workflow
226
+ `NPM Telegram Beta E2E`. It does not run on merge. The workflow uses the
227
+ `qa-live-shared` environment and Convex CI credential leases.
228
+ - GitHub Actions also exposes `Package Acceptance` for side-run product proof
229
+ against one candidate package. It accepts a trusted ref, published npm spec,
230
+ HTTPS tarball URL plus SHA-256, or tarball artifact from another run, uploads
231
+ the normalized `nodmix-current.tgz` as `package-under-test`, then runs the
232
+ existing Docker E2E scheduler with smoke, package, product, full, or custom
233
+ lane profiles. Set `telegram_mode=mock-openai` or `live-frontier` to run the
234
+ Telegram QA workflow against the same `package-under-test` artifact.
235
+ - Latest beta product proof:
236
+
237
+ ```bash
238
+ gh workflow run package-acceptance.yml --ref main \
239
+ -f source=npm \
240
+ -f package_spec=nodmix@beta \
241
+ -f suite_profile=product \
242
+ -f telegram_mode=mock-openai
243
+ ```
244
+
245
+ - Exact tarball URL proof requires a digest:
246
+
247
+ ```bash
248
+ gh workflow run package-acceptance.yml --ref main \
249
+ -f source=url \
250
+ -f package_url=https://registry.npmjs.org/nodmix/-/nodmix-VERSION.tgz \
251
+ -f package_sha256=<sha256> \
252
+ -f suite_profile=package
253
+ ```
254
+
255
+ - Artifact proof downloads a tarball artifact from another Actions run:
256
+
257
+ ```bash
258
+ gh workflow run package-acceptance.yml --ref main \
259
+ -f source=artifact \
260
+ -f artifact_run_id=<run-id> \
261
+ -f artifact_name=<artifact-name> \
262
+ -f suite_profile=smoke
263
+ ```
264
+
265
+ - `pnpm test:docker:plugins`
266
+ - Packs and installs the current Nodmix build in Docker, starts the Gateway
267
+ with OpenAI configured, then enables bundled channel/plugins via config
268
+ edits.
269
+ - Verifies setup discovery leaves unconfigured downloadable plugins absent,
270
+ the first configured doctor repair installs each missing downloadable
271
+ plugin explicitly, and a second restart does not run hidden dependency
272
+ repair.
273
+ - Also installs a known older npm baseline, enables Telegram before running
274
+ `nodmix update --tag <candidate>`, and verifies the candidate's
275
+ post-update doctor cleans legacy plugin dependency debris without a
276
+ harness-side postinstall repair.
277
+ - `pnpm test:parallels:npm-update`
278
+ - Runs the native packaged-install update smoke across Parallels guests. Each
279
+ selected platform first installs the requested baseline package, then runs
280
+ the installed `nodmix update` command in the same guest and verifies the
281
+ installed version, update status, gateway readiness, and one local agent
282
+ turn.
283
+ - Use `--platform macos`, `--platform windows`, or `--platform linux` while
284
+ iterating on one guest. Use `--json` for the summary artifact path and
285
+ per-lane status.
286
+ - The OpenAI lane uses `openai/gpt-5.5` for the live agent-turn proof by
287
+ default. Pass `--model <provider/model>` or set
288
+ `NODMIX_PARALLELS_OPENAI_MODEL` when deliberately validating another
289
+ OpenAI model.
290
+ - Wrap long local runs in a host timeout so Parallels transport stalls cannot
291
+ consume the rest of the testing window:
292
+
293
+ ```bash
294
+ timeout --foreground 150m pnpm test:parallels:npm-update -- --json
295
+ timeout --foreground 90m pnpm test:parallels:npm-update -- --platform windows --json
296
+ ```
297
+
298
+ - The script writes nested lane logs under `/tmp/nodmix-parallels-npm-update.*`.
299
+ Inspect `windows-update.log`, `macos-update.log`, or `linux-update.log`
300
+ before assuming the outer wrapper is hung.
301
+ - Windows update can spend 10 to 15 minutes in post-update doctor and package
302
+ update work on a cold guest; that is still healthy when the nested npm
303
+ debug log is advancing.
304
+ - Do not run this aggregate wrapper in parallel with individual Parallels
305
+ macOS, Windows, or Linux smoke lanes. They share VM state and can collide on
306
+ snapshot restore, package serving, or guest gateway state.
307
+ - The post-update proof runs the normal bundled plugin surface because
308
+ capability facades such as speech, image generation, and media
309
+ understanding are loaded through bundled runtime APIs even when the agent
310
+ turn itself only checks a simple text response.
311
+
312
+ - `pnpm nodmix qa aimock`
313
+ - Starts only the local AIMock provider server for direct protocol smoke
314
+ testing.
315
+ - `pnpm nodmix qa matrix`
316
+ - Runs the Matrix live QA lane against a disposable Docker-backed Tuwunel homeserver. Source-checkout only - packaged installs do not ship `qa-lab`.
317
+ - Full CLI, profile/scenario catalog, env vars, and artifact layout: [Matrix QA](/concepts/qa-matrix).
318
+ - `pnpm nodmix qa telegram`
319
+ - Runs the Telegram live QA lane against a real private group using the driver and SUT bot tokens from env.
320
+ - Requires `NODMIX_QA_TELEGRAM_GROUP_ID`, `NODMIX_QA_TELEGRAM_DRIVER_BOT_TOKEN`, and `NODMIX_QA_TELEGRAM_SUT_BOT_TOKEN`. The group id must be the numeric Telegram chat id.
321
+ - Supports `--credential-source convex` for shared pooled credentials. Use env mode by default, or set `NODMIX_QA_CREDENTIAL_SOURCE=convex` to opt into pooled leases.
322
+ - Defaults cover canary, mention gating, command addressing, `/status`, bot-to-bot mentioned replies, and core native command replies. `mock-openai` defaults also cover deterministic reply-chain and Telegram final-message streaming regressions. Use `--list-scenarios` for optional probes such as `session_status`.
323
+ - Exits non-zero when any scenario fails. Use `--allow-failures` when you
324
+ want artifacts without a failing exit code.
325
+ - Requires two distinct bots in the same private group, with the SUT bot exposing a Telegram username.
326
+ - For stable bot-to-bot observation, enable Bot-to-Bot Communication Mode in `@BotFather` for both bots and ensure the driver bot can observe group bot traffic.
327
+ - Writes a Telegram QA report, summary, and observed-messages artifact under `.artifacts/qa-e2e/...`. Replying scenarios include RTT from driver send request to observed SUT reply.
328
+
329
+ `Mantis Telegram Live` is the PR-evidence wrapper around this lane. It runs the
330
+ candidate ref with Convex-leased Telegram credentials, renders the redacted
331
+ observed-message transcript in a Crabbox desktop browser, records MP4 evidence,
332
+ generates a motion-trimmed GIF, uploads the artifact bundle, and posts inline PR
333
+ evidence through the Mantis GitHub App when `pr_number` is set. Maintainers can
334
+ start it from the Actions UI through `Mantis Scenario` (`scenario_id:
335
+ telegram-live`) or directly from a pull request comment:
336
+
337
+ ```text
338
+ @nodmix-mantis telegram
339
+ @nodmix-mantis telegram scenario=telegram-status-command
340
+ @nodmix-mantis telegram scenarios=telegram-status-command,telegram-mentioned-message-reply
341
+ ```
342
+
343
+ `Mantis Telegram Desktop Proof` is the agentic native Telegram Desktop
344
+ before/after wrapper for PR visual proof. Start it from the Actions UI with
345
+ freeform `instructions`, through `Mantis Scenario` (`scenario_id:
346
+ telegram-desktop-proof`), or from a PR comment:
347
+
348
+ ```text
349
+ @nodmix-mantis telegram desktop proof
350
+ ```
351
+
352
+ The Mantis agent reads the PR, decides what Telegram-visible behavior proves the
353
+ change, runs the real-user Crabbox Telegram Desktop proof lane on baseline and
354
+ candidate refs, iterates until the native GIFs are useful, writes a paired
355
+ `motionPreview` manifest, and posts the same 2-column GIF table through the
356
+ Mantis GitHub App when `pr_number` is set.
357
+
358
+ - `pnpm nodmix qa mantis telegram-desktop-builder`
359
+ - Leases or reuses a Crabbox Linux desktop, installs native Telegram Desktop, configures Nodmix with a leased Telegram SUT bot token, starts the gateway, and records screenshot/MP4 evidence from the visible VNC desktop.
360
+ - Defaults to `--credential-source convex` so workflows only need the Convex broker secret. Use `--credential-source env` with the same `NODMIX_QA_TELEGRAM_*` variables as `pnpm nodmix qa telegram`.
361
+ - Telegram Desktop still needs a user login/profile. The bot token configures Nodmix only. Use `--telegram-profile-archive-env <name>` for a base64 `.tgz` profile archive, or use `--keep-lease` and log in manually through VNC once.
362
+ - Writes `mantis-telegram-desktop-builder-report.md`, `mantis-telegram-desktop-builder-summary.json`, `telegram-desktop-builder.png`, and `telegram-desktop-builder.mp4` under the output directory.
363
+
364
+ Live transport lanes share one standard contract so new transports do not drift; the per-lane coverage matrix lives in [QA overview → Live transport coverage](/concepts/qa-e2e-automation#live-transport-coverage). `qa-channel` is the broad synthetic suite and is not part of that matrix.
365
+
366
+ ### Shared Telegram credentials via Convex (v1)
367
+
368
+ When `--credential-source convex` (or `NODMIX_QA_CREDENTIAL_SOURCE=convex`) is enabled for
369
+ live transport QA, QA lab acquires an exclusive lease from a Convex-backed pool, heartbeats that
370
+ lease while the lane is running, and releases the lease on shutdown. The section name predates
371
+ Discord, Slack, and WhatsApp support; the lease contract is shared across kinds.
372
+
373
+ Reference Convex project scaffold:
374
+
375
+ - `qa/convex-credential-broker/`
376
+
377
+ Required env vars:
378
+
379
+ - `NODMIX_QA_CONVEX_SITE_URL` (for example `https://your-deployment.convex.site`)
380
+ - One secret for the selected role:
381
+ - `NODMIX_QA_CONVEX_SECRET_MAINTAINER` for `maintainer`
382
+ - `NODMIX_QA_CONVEX_SECRET_CI` for `ci`
383
+ - Credential role selection:
384
+ - CLI: `--credential-role maintainer|ci`
385
+ - Env default: `NODMIX_QA_CREDENTIAL_ROLE` (defaults to `ci` in CI, `maintainer` otherwise)
386
+
387
+ Optional env vars:
388
+
389
+ - `NODMIX_QA_CREDENTIAL_LEASE_TTL_MS` (default `1200000`)
390
+ - `NODMIX_QA_CREDENTIAL_HEARTBEAT_INTERVAL_MS` (default `30000`)
391
+ - `NODMIX_QA_CREDENTIAL_ACQUIRE_TIMEOUT_MS` (default `90000`)
392
+ - `NODMIX_QA_CREDENTIAL_HTTP_TIMEOUT_MS` (default `15000`)
393
+ - `NODMIX_QA_CONVEX_ENDPOINT_PREFIX` (default `/qa-credentials/v1`)
394
+ - `NODMIX_QA_CREDENTIAL_OWNER_ID` (optional trace id)
395
+ - `NODMIX_QA_ALLOW_INSECURE_HTTP=1` allows loopback `http://` Convex URLs for local-only development.
396
+
397
+ `NODMIX_QA_CONVEX_SITE_URL` should use `https://` in normal operation.
398
+
399
+ Maintainer admin commands (pool add/remove/list) require
400
+ `NODMIX_QA_CONVEX_SECRET_MAINTAINER` specifically.
401
+
402
+ CLI helpers for maintainers:
403
+
404
+ ```bash
405
+ pnpm nodmix qa credentials doctor
406
+ pnpm nodmix qa credentials add --kind telegram --payload-file qa/telegram-credential.json
407
+ pnpm nodmix qa credentials list --kind telegram
408
+ pnpm nodmix qa credentials remove --credential-id <credential-id>
409
+ ```
410
+
411
+ Use `doctor` before live runs to check the Convex site URL, broker secrets,
412
+ endpoint prefix, HTTP timeout, and admin/list reachability without printing
413
+ secret values. Use `--json` for machine-readable output in scripts and CI
414
+ utilities.
415
+
416
+ Default endpoint contract (`NODMIX_QA_CONVEX_SITE_URL` + `/qa-credentials/v1`):
417
+
418
+ - `POST /acquire`
419
+ - Request: `{ kind, ownerId, actorRole, leaseTtlMs, heartbeatIntervalMs }`
420
+ - Success: `{ status: "ok", credentialId, leaseToken, payload, leaseTtlMs?, heartbeatIntervalMs? }`
421
+ - Exhausted/retryable: `{ status: "error", code: "POOL_EXHAUSTED" | "NO_CREDENTIAL_AVAILABLE", ... }`
422
+ - `POST /payload-chunk`
423
+ - Request: `{ kind, ownerId, actorRole, credentialId, leaseToken, index }`
424
+ - Success: `{ status: "ok", index, data }`
425
+ - `POST /heartbeat`
426
+ - Request: `{ kind, ownerId, actorRole, credentialId, leaseToken, leaseTtlMs }`
427
+ - Success: `{ status: "ok" }` (or empty `2xx`)
428
+ - `POST /release`
429
+ - Request: `{ kind, ownerId, actorRole, credentialId, leaseToken }`
430
+ - Success: `{ status: "ok" }` (or empty `2xx`)
431
+ - `POST /admin/add` (maintainer secret only)
432
+ - Request: `{ kind, actorId, payload, note?, status? }`
433
+ - Success: `{ status: "ok", credential }`
434
+ - `POST /admin/remove` (maintainer secret only)
435
+ - Request: `{ credentialId, actorId }`
436
+ - Success: `{ status: "ok", changed, credential }`
437
+ - Active lease guard: `{ status: "error", code: "LEASE_ACTIVE", ... }`
438
+ - `POST /admin/list` (maintainer secret only)
439
+ - Request: `{ kind?, status?, includePayload?, limit? }`
440
+ - Success: `{ status: "ok", credentials, count }`
441
+
442
+ Payload shape for Telegram kind:
443
+
444
+ - `{ groupId: string, driverToken: string, sutToken: string }`
445
+ - `groupId` must be a numeric Telegram chat id string.
446
+ - `admin/add` validates this shape for `kind: "telegram"` and rejects malformed payloads.
447
+
448
+ Payload shape for Telegram real-user kind:
449
+
450
+ - `{ groupId: string, sutToken: string, testerUserId: string, testerUsername: string, telegramApiId: string, telegramApiHash: string, tdlibDatabaseEncryptionKey: string, tdlibArchiveBase64: string, tdlibArchiveSha256: string, desktopTdataArchiveBase64: string, desktopTdataArchiveSha256: string }`
451
+ - `groupId`, `testerUserId`, and `telegramApiId` must be numeric strings.
452
+ - `tdlibArchiveSha256` and `desktopTdataArchiveSha256` must be SHA-256 hex strings.
453
+ - `kind: "telegram-user"` is reserved for the Mantis Telegram Desktop proof workflow. Generic QA Lab lanes must not acquire it.
454
+
455
+ Broker-validated multi-channel payloads:
456
+
457
+ - Discord: `{ guildId: string, channelId: string, driverBotToken: string, sutBotToken: string, sutApplicationId: string, voiceChannelId?: string }`
458
+ - WhatsApp: `{ driverPhoneE164: string, sutPhoneE164: string, driverAuthArchiveBase64: string, sutAuthArchiveBase64: string, groupJid?: string }`
459
+
460
+ Slack lanes can also lease from the pool, but Slack payload validation currently
461
+ lives in the Slack QA runner rather than the broker. Use
462
+ `{ channelId: string, driverBotToken: string, sutBotToken: string, sutAppToken: string }`
463
+ for Slack rows.
464
+
465
+ ### Adding a channel to QA
466
+
467
+ The architecture and scenario-helper names for new channel adapters live in [QA overview → Adding a channel](/concepts/qa-e2e-automation#adding-a-channel). The minimum bar: implement the transport runner on the shared `qa-lab` host seam, declare `qaRunners` in the plugin manifest, mount as `nodmix qa <runner>`, and author scenarios under `qa/scenarios/`.
468
+
469
+ ## Test suites (what runs where)
470
+
471
+ Think of the suites as "increasing realism" (and increasing flakiness/cost):
472
+
473
+ ### Unit / integration (default)
474
+
475
+ - Command: `pnpm test`
476
+ - Config: untargeted runs use the `vitest.full-*.config.ts` shard set and may expand multi-project shards into per-project configs for parallel scheduling
477
+ - Files: core/unit inventories under `src/**/*.test.ts`, `packages/**/*.test.ts`, and `test/**/*.test.ts`; UI unit tests run in the dedicated `unit-ui` shard
478
+ - Scope:
479
+ - Pure unit tests
480
+ - In-process integration tests (gateway auth, routing, tooling, parsing, config)
481
+ - Deterministic regressions for known bugs
482
+ - Expectations:
483
+ - Runs in CI
484
+ - No real keys required
485
+ - Should be fast and stable
486
+ - Resolver and public-surface loader tests must prove broad `api.js` and
487
+ `runtime-api.js` fallback behavior with generated tiny plugin fixtures, not
488
+ real bundled plugin source APIs. Real plugin API loads belong in
489
+ plugin-owned contract/integration suites.
490
+
491
+ Native dependency policy:
492
+
493
+ - Default test installs skip optional native Discord opus builds. Discord voice receive uses the pure-JS `opusscript` decoder, and `@discordjs/opus` stays disabled in `allowBuilds` so local tests and Testbox lanes do not compile the native addon.
494
+ - Use a dedicated Discord voice performance or live lane if you intentionally need to compare a native opus build. Do not set `@discordjs/opus` to `true` in the default `allowBuilds`; that makes unrelated install/test loops compile native code.
495
+
496
+ <AccordionGroup>
497
+ <Accordion title="Projects, shards, and scoped lanes">
498
+
499
+ - Untargeted `pnpm test` runs twelve smaller shard configs (`core-unit-fast`, `core-unit-src`, `core-unit-security`, `core-unit-ui`, `core-unit-support`, `core-support-boundary`, `core-contracts`, `core-bundled`, `core-runtime`, `agentic`, `auto-reply`, `extensions`) instead of one giant native root-project process. This cuts peak RSS on loaded machines and avoids auto-reply/extension work starving unrelated suites.
500
+ - `pnpm test --watch` still uses the native root `vitest.config.ts` project graph, because a multi-shard watch loop is not practical.
501
+ - `pnpm test`, `pnpm test:watch`, and `pnpm test:perf:imports` route explicit file/directory targets through scoped lanes first, so `pnpm test extensions/discord/src/monitor/message-handler.preflight.test.ts` avoids paying the full root project startup tax.
502
+ - `pnpm test:changed` expands changed git paths into cheap scoped lanes by default: direct test edits, sibling `*.test.ts` files, explicit source mappings, and local import-graph dependents. Config/setup/package edits do not broad-run tests unless you explicitly use `NODMIX_TEST_CHANGED_BROAD=1 pnpm test:changed`.
503
+ - `pnpm check:changed` is the normal smart local check gate for narrow work. It classifies the diff into core, core tests, extensions, extension tests, apps, docs, release metadata, live Docker tooling, and tooling, then runs the matching typecheck, lint, and guard commands. It does not run Vitest tests; call `pnpm test:changed` or explicit `pnpm test <target>` for test proof. Release metadata-only version bumps run targeted version/config/root-dependency checks, with a guard that rejects package changes outside the top-level version field.
504
+ - Live Docker ACP harness edits run focused checks: shell syntax for the live Docker auth scripts and a live Docker scheduler dry-run. `package.json` changes are included only when the diff is limited to `scripts["test:docker:live-*"]`; dependency, export, version, and other package-surface edits still use the broader guards.
505
+ - Import-light unit tests from agents, commands, plugins, auto-reply helpers, `plugin-sdk`, and similar pure utility areas route through the `unit-fast` lane, which skips `test/setup-nodmix-runtime.ts`; stateful/runtime-heavy files stay on the existing lanes.
506
+ - Selected `plugin-sdk` and `commands` helper source files also map changed-mode runs to explicit sibling tests in those light lanes, so helper edits avoid rerunning the full heavy suite for that directory.
507
+ - `auto-reply` has dedicated buckets for top-level core helpers, top-level `reply.*` integration tests, and the `src/auto-reply/reply/**` subtree. CI further splits the reply subtree into agent-runner, dispatch, and commands/state-routing shards so one import-heavy bucket does not own the full Node tail.
508
+ - Normal PR/main CI intentionally skips the extension batch sweep and release-only `agentic-plugins` shard. Full Release Validation dispatches the separate `Plugin Prerelease` child workflow for those plugin/extension-heavy suites on release candidates.
509
+
510
+ </Accordion>
511
+
512
+ <Accordion title="Embedded runner coverage">
513
+
514
+ - When you change message-tool discovery inputs or compaction runtime
515
+ context, keep both levels of coverage.
516
+ - Add focused helper regressions for pure routing and normalization
517
+ boundaries.
518
+ - Keep the embedded runner integration suites healthy:
519
+ `src/agents/pi-embedded-runner/compact.hooks.test.ts`,
520
+ `src/agents/pi-embedded-runner/run.overflow-compaction.test.ts`, and
521
+ `src/agents/pi-embedded-runner/run.overflow-compaction.loop.test.ts`.
522
+ - Those suites verify that scoped ids and compaction behavior still flow
523
+ through the real `run.ts` / `compact.ts` paths; helper-only tests are
524
+ not a sufficient substitute for those integration paths.
525
+
526
+ </Accordion>
527
+
528
+ <Accordion title="Vitest pool and isolation defaults">
529
+
530
+ - Base Vitest config defaults to `threads`.
531
+ - The shared Vitest config fixes `isolate: false` and uses the
532
+ non-isolated runner across the root projects, e2e, and live configs.
533
+ - The root UI lane keeps its `jsdom` setup and optimizer, but runs on the
534
+ shared non-isolated runner too.
535
+ - Each `pnpm test` shard inherits the same `threads` + `isolate: false`
536
+ defaults from the shared Vitest config.
537
+ - `scripts/run-vitest.mjs` adds `--no-maglev` for Vitest child Node
538
+ processes by default to reduce V8 compile churn during big local runs.
539
+ Set `NODMIX_VITEST_ENABLE_MAGLEV=1` to compare against stock V8
540
+ behavior.
541
+
542
+ </Accordion>
543
+
544
+ <Accordion title="Fast local iteration">
545
+
546
+ - `pnpm changed:lanes` shows which architectural lanes a diff triggers.
547
+ - The pre-commit hook is formatting-only. It restages formatted files and
548
+ does not run lint, typecheck, or tests.
549
+ - Run `pnpm check:changed` explicitly before handoff or push when you
550
+ need the smart local check gate.
551
+ - `pnpm test:changed` routes through cheap scoped lanes by default. Use
552
+ `NODMIX_TEST_CHANGED_BROAD=1 pnpm test:changed` only when the agent
553
+ decides a harness, config, package, or contract edit really needs broader
554
+ Vitest coverage.
555
+ - `pnpm test:max` and `pnpm test:changed:max` keep the same routing
556
+ behavior, just with a higher worker cap.
557
+ - Local worker auto-scaling is intentionally conservative and backs off
558
+ when the host load average is already high, so multiple concurrent
559
+ Vitest runs do less damage by default.
560
+ - The base Vitest config marks the projects/config files as
561
+ `forceRerunTriggers` so changed-mode reruns stay correct when test
562
+ wiring changes.
563
+ - The config keeps `NODMIX_VITEST_FS_MODULE_CACHE` enabled on supported
564
+ hosts; set `NODMIX_VITEST_FS_MODULE_CACHE_PATH=/abs/path` if you want
565
+ one explicit cache location for direct profiling.
566
+
567
+ </Accordion>
568
+
569
+ <Accordion title="Perf debugging">
570
+
571
+ - `pnpm test:perf:imports` enables Vitest import-duration reporting plus
572
+ import-breakdown output.
573
+ - `pnpm test:perf:imports:changed` scopes the same profiling view to
574
+ files changed since `origin/main`.
575
+ - Shard timing data is written to `.artifacts/vitest-shard-timings.json`.
576
+ Whole-config runs use the config path as the key; include-pattern CI
577
+ shards append the shard name so filtered shards can be tracked
578
+ separately.
579
+ - When one hot test still spends most of its time in startup imports,
580
+ keep heavy dependencies behind a narrow local `*.runtime.ts` seam and
581
+ mock that seam directly instead of deep-importing runtime helpers just
582
+ to pass them through `vi.mock(...)`.
583
+ - `pnpm test:perf:changed:bench -- --ref <git-ref>` compares routed
584
+ `test:changed` against the native root-project path for that committed
585
+ diff and prints wall time plus macOS max RSS.
586
+ - `pnpm test:perf:changed:bench -- --worktree` benchmarks the current
587
+ dirty tree by routing the changed file list through
588
+ `scripts/test-projects.mjs` and the root Vitest config.
589
+ - `pnpm test:perf:profile:main` writes a main-thread CPU profile for
590
+ Vitest/Vite startup and transform overhead.
591
+ - `pnpm test:perf:profile:runner` writes runner CPU+heap profiles for the
592
+ unit suite with file parallelism disabled.
593
+
594
+ </Accordion>
595
+ </AccordionGroup>
596
+
597
+ ### Stability (gateway)
598
+
599
+ - Command: `pnpm test:stability:gateway`
600
+ - Config: `vitest.gateway.config.ts`, forced to one worker
601
+ - Scope:
602
+ - Starts a real loopback Gateway with diagnostics enabled by default
603
+ - Drives synthetic gateway message, memory, and large-payload churn through the diagnostic event path
604
+ - Queries `diagnostics.stability` over the Gateway WS RPC
605
+ - Covers diagnostic stability bundle persistence helpers
606
+ - Asserts the recorder remains bounded, synthetic RSS samples stay under the pressure budget, and per-session queue depths drain back to zero
607
+ - Expectations:
608
+ - CI-safe and keyless
609
+ - Narrow lane for stability-regression follow-up, not a substitute for the full Gateway suite
610
+
611
+ ### E2E (gateway smoke)
612
+
613
+ - Command: `pnpm test:e2e`
614
+ - Config: `vitest.e2e.config.ts`
615
+ - Files: `src/**/*.e2e.test.ts`, `test/**/*.e2e.test.ts`, and bundled-plugin E2E tests under `extensions/`
616
+ - Runtime defaults:
617
+ - Uses Vitest `threads` with `isolate: false`, matching the rest of the repo.
618
+ - Uses adaptive workers (CI: up to 2, local: 1 by default).
619
+ - Runs in silent mode by default to reduce console I/O overhead.
620
+ - Useful overrides:
621
+ - `NODMIX_E2E_WORKERS=<n>` to force worker count (capped at 16).
622
+ - `NODMIX_E2E_VERBOSE=1` to re-enable verbose console output.
623
+ - Scope:
624
+ - Multi-instance gateway end-to-end behavior
625
+ - WebSocket/HTTP surfaces, node pairing, and heavier networking
626
+ - Expectations:
627
+ - Runs in CI (when enabled in the pipeline)
628
+ - No real keys required
629
+ - More moving parts than unit tests (can be slower)
630
+
631
+ ### E2E: OpenShell backend smoke
632
+
633
+ - Command: `pnpm test:e2e:openshell`
634
+ - File: `extensions/openshell/src/backend.e2e.test.ts`
635
+ - Scope:
636
+ - Starts an isolated OpenShell gateway on the host via Docker
637
+ - Creates a sandbox from a temporary local Dockerfile
638
+ - Exercises Nodmix's OpenShell backend over real `sandbox ssh-config` + SSH exec
639
+ - Verifies remote-canonical filesystem behavior through the sandbox fs bridge
640
+ - Expectations:
641
+ - Opt-in only; not part of the default `pnpm test:e2e` run
642
+ - Requires a local `openshell` CLI plus a working Docker daemon
643
+ - Uses isolated `HOME` / `XDG_CONFIG_HOME`, then destroys the test gateway and sandbox
644
+ - Useful overrides:
645
+ - `NODMIX_E2E_OPENSHELL=1` to enable the test when running the broader e2e suite manually
646
+ - `NODMIX_E2E_OPENSHELL_COMMAND=/path/to/openshell` to point at a non-default CLI binary or wrapper script
647
+
648
+ ### Live (real providers + real models)
649
+
650
+ - Command: `pnpm test:live`
651
+ - Config: `vitest.live.config.ts`
652
+ - Files: `src/**/*.live.test.ts`, `test/**/*.live.test.ts`, and bundled-plugin live tests under `extensions/`
653
+ - Default: **enabled** by `pnpm test:live` (sets `NODMIX_LIVE_TEST=1`)
654
+ - Scope:
655
+ - "Does this provider/model actually work _today_ with real creds?"
656
+ - Catch provider format changes, tool-calling quirks, auth issues, and rate limit behavior
657
+ - Expectations:
658
+ - Not CI-stable by design (real networks, real provider policies, quotas, outages)
659
+ - Costs money / uses rate limits
660
+ - Prefer running narrowed subsets instead of "everything"
661
+ - Live runs use already-exported API keys and staged auth profiles.
662
+ - By default, live runs still isolate `HOME` and copy config/auth material into a temp test home so unit fixtures cannot mutate your real `~/.nodmix`.
663
+ - Set `NODMIX_LIVE_USE_REAL_HOME=1` only when you intentionally need live tests to use your real home directory.
664
+ - `pnpm test:live` defaults to a quieter mode: it keeps `[live] ...` progress output and mutes gateway bootstrap logs/Bonjour chatter. Set `NODMIX_LIVE_TEST_QUIET=0` if you want the full startup logs back.
665
+ - API key rotation (provider-specific): set `*_API_KEYS` with comma/semicolon format or `*_API_KEY_1`, `*_API_KEY_2` (for example `OPENAI_API_KEYS`, `ANTHROPIC_API_KEYS`, `GEMINI_API_KEYS`) or per-live override via `NODMIX_LIVE_*_KEY`; tests retry on rate limit responses.
666
+ - Progress/heartbeat output:
667
+ - Live suites now emit progress lines to stderr so long provider calls are visibly active even when Vitest console capture is quiet.
668
+ - `vitest.live.config.ts` disables Vitest console interception so provider/gateway progress lines stream immediately during live runs.
669
+ - Tune direct-model heartbeats with `NODMIX_LIVE_HEARTBEAT_MS`.
670
+ - Tune gateway/probe heartbeats with `NODMIX_LIVE_GATEWAY_HEARTBEAT_MS`.
671
+
672
+ ## Which suite should I run?
673
+
674
+ Use this decision table:
675
+
676
+ - Editing logic/tests: run `pnpm test` (and `pnpm test:coverage` if you changed a lot)
677
+ - Touching gateway networking / WS protocol / pairing: add `pnpm test:e2e`
678
+ - Debugging "my bot is down" / provider-specific failures / tool calling: run a narrowed `pnpm test:live`
679
+
680
+ ## Live (network-touching) tests
681
+
682
+ For the live model matrix, CLI backend smokes, ACP smokes, Codex app-server
683
+ harness, and all media-provider live tests (Deepgram, BytePlus, ComfyUI, image,
684
+ music, video, media harness) - plus credential handling for live runs - see
685
+ [Testing live suites](/help/testing-live). For the dedicated update and
686
+ plugin validation checklist, see
687
+ [Testing updates and plugins](/help/testing-updates-plugins).
688
+
689
+ ## Docker runners (optional "works in Linux" checks)
690
+
691
+ These Docker runners split into two buckets:
692
+
693
+ - Live-model runners: `test:docker:live-models` and `test:docker:live-gateway` run only their matching profile-key live file inside the repo Docker image (`src/agents/models.profiles.live.test.ts` and `src/gateway/gateway-models.profiles.live.test.ts`), mounting your local config dir, workspace, and optional profile env file. The matching local entrypoints are `test:live:models-profiles` and `test:live:gateway-profiles`.
694
+ - Docker live runners default to a smaller smoke cap so a full Docker sweep stays practical:
695
+ `test:docker:live-models` defaults to `NODMIX_LIVE_MAX_MODELS=12`, and
696
+ `test:docker:live-gateway` defaults to `NODMIX_LIVE_GATEWAY_SMOKE=1`,
697
+ `NODMIX_LIVE_GATEWAY_MAX_MODELS=8`,
698
+ `NODMIX_LIVE_GATEWAY_STEP_TIMEOUT_MS=45000`, and
699
+ `NODMIX_LIVE_GATEWAY_MODEL_TIMEOUT_MS=90000`. Override those env vars when you
700
+ explicitly want the larger exhaustive scan.
701
+ - `test:docker:all` builds the live Docker image once via `test:docker:live-build`, packs Nodmix once as an npm tarball through `scripts/package-nodmix-for-docker.mjs`, then builds/reuses two `scripts/e2e/Dockerfile` images. The bare image is only the Node/Git runner for install/update/plugin-dependency lanes; those lanes mount the prebuilt tarball. The functional image installs the same tarball into `/app` for built-app functionality lanes. Docker lane definitions live in `scripts/lib/docker-e2e-scenarios.mjs`; planner logic lives in `scripts/lib/docker-e2e-plan.mjs`; `scripts/test-docker-all.mjs` executes the selected plan. The aggregate uses a weighted local scheduler: `NODMIX_DOCKER_ALL_PARALLELISM` controls process slots, while resource caps keep heavy live, npm-install, and multi-service lanes from all starting at once. If a single lane is heavier than the active caps, the scheduler can still start it when the pool is empty and then keeps it running alone until capacity is available again. Defaults are 10 slots, `NODMIX_DOCKER_ALL_LIVE_LIMIT=9`, `NODMIX_DOCKER_ALL_NPM_LIMIT=10`, and `NODMIX_DOCKER_ALL_SERVICE_LIMIT=7`; tune `NODMIX_DOCKER_ALL_WEIGHT_LIMIT` or `NODMIX_DOCKER_ALL_DOCKER_LIMIT` only when the Docker host has more headroom. The runner performs a Docker preflight by default, removes stale Nodmix E2E containers, prints status every 30 seconds, stores successful lane timings in `.artifacts/docker-tests/lane-timings.json`, and uses those timings to start longer lanes first on later runs. Use `NODMIX_DOCKER_ALL_DRY_RUN=1` to print the weighted lane manifest without building or running Docker, or `node scripts/test-docker-all.mjs --plan-json` to print the CI plan for selected lanes, package/image needs, and credentials.
702
+ - `Package Acceptance` is the GitHub-native package gate for "does this installable tarball work as a product?" It resolves one candidate package from `source=npm`, `source=ref`, `source=url`, or `source=artifact`, uploads it as `package-under-test`, then runs the reusable Docker E2E lanes against that exact tarball instead of repacking the selected ref. Profiles are ordered by breadth: `smoke`, `package`, `product`, and `full`. See [Testing updates and plugins](/help/testing-updates-plugins) for the package/update/plugin contract, published-upgrade survivor matrix, release defaults, and failure triage.
703
+ - Build and release checks run `scripts/check-cli-bootstrap-imports.mjs` after tsdown. The guard walks the static built graph from `dist/entry.js` and `dist/cli/run-main.js` and fails if pre-dispatch startup imports package dependencies such as Commander, prompt UI, undici, or logging before command dispatch; it also keeps the bundled gateway run chunk under budget and rejects static imports of known cold gateway paths. Packaged CLI smoke also covers root help, onboard help, doctor help, status, config schema, and a model-list command.
704
+ - Package Acceptance legacy compatibility is capped at `2026.4.25` (`2026.4.25-beta.*` included). Through that cutoff, the harness tolerates only shipped-package metadata gaps: omitted private QA inventory entries, missing `gateway install --wrapper`, missing patch files in the tarball-derived git fixture, missing persisted `update.channel`, legacy plugin install-record locations, missing marketplace install-record persistence, and config metadata migration during `plugins update`. For packages after `2026.4.25`, those paths are strict failures.
705
+ - Container smoke runners: `test:docker:openwebui`, `test:docker:onboard`, `test:docker:npm-onboard-channel-agent`, `test:docker:release-user-journey`, `test:docker:release-typed-onboarding`, `test:docker:release-media-memory`, `test:docker:release-upgrade-user-journey`, `test:docker:release-plugin-marketplace`, `test:docker:skill-install`, `test:docker:update-channel-switch`, `test:docker:upgrade-survivor`, `test:docker:published-upgrade-survivor`, `test:docker:session-runtime-context`, `test:docker:agents-delete-shared-workspace`, `test:docker:gateway-network`, `test:docker:browser-cdp-snapshot`, `test:docker:mcp-channels`, `test:docker:pi-bundle-mcp-tools`, `test:docker:cron-mcp-cleanup`, `test:docker:plugins`, `test:docker:plugin-update`, `test:docker:plugin-lifecycle-matrix`, and `test:docker:config-reload` boot one or more real containers and verify higher-level integration paths.
706
+
707
+ The live-model Docker runners also bind-mount only the needed CLI auth homes (or all supported ones when the run is not narrowed), then copy them into the container home before the run so external-CLI OAuth can refresh tokens without mutating the host auth store:
708
+
709
+ - Direct models: `pnpm test:docker:live-models` (script: `scripts/test-live-models-docker.sh`)
710
+ - ACP bind smoke: `pnpm test:docker:live-acp-bind` (script: `scripts/test-live-acp-bind-docker.sh`; covers Claude, Codex, and Gemini by default, with strict Droid/OpenCode coverage via `pnpm test:docker:live-acp-bind:droid` and `pnpm test:docker:live-acp-bind:opencode`)
711
+ - CLI backend smoke: `pnpm test:docker:live-cli-backend` (script: `scripts/test-live-cli-backend-docker.sh`)
712
+ - Codex app-server harness smoke: `pnpm test:docker:live-codex-harness` (script: `scripts/test-live-codex-harness-docker.sh`)
713
+ - Gateway + dev agent: `pnpm test:docker:live-gateway` (script: `scripts/test-live-gateway-models-docker.sh`)
714
+ - Observability smoke: `pnpm qa:otel:smoke` is a private QA source-checkout lane. It is intentionally not part of package Docker release lanes because the npm tarball omits QA Lab.
715
+ - Open WebUI live smoke: `pnpm test:docker:openwebui` (script: `scripts/e2e/openwebui-docker.sh`)
716
+ - Onboarding wizard (TTY, full scaffolding): `pnpm test:docker:onboard` (script: `scripts/e2e/onboard-docker.sh`)
717
+ - Npm tarball onboarding/channel/agent smoke: `pnpm test:docker:npm-onboard-channel-agent` installs the packed Nodmix tarball globally in Docker, configures OpenAI via env-ref onboarding plus Telegram by default, runs doctor, and runs one mocked OpenAI agent turn. Reuse a prebuilt tarball with `NODMIX_CURRENT_PACKAGE_TGZ=/path/to/nodmix-*.tgz`, skip the host rebuild with `NODMIX_NPM_ONBOARD_HOST_BUILD=0`, or switch channel with `NODMIX_NPM_ONBOARD_CHANNEL=discord` or `NODMIX_NPM_ONBOARD_CHANNEL=slack`.
718
+
719
+ - Release user journey smoke: `pnpm test:docker:release-user-journey` installs the packed Nodmix tarball globally in a clean Docker home, runs onboarding, configures a mocked OpenAI provider, runs an agent turn, installs/uninstalls external plugins, configures ClickClack against a local fixture, verifies outbound/inbound messaging, restarts Gateway, and runs doctor.
720
+ - Release typed onboarding smoke: `pnpm test:docker:release-typed-onboarding` installs the packed tarball, drives `nodmix onboard` through a real TTY, configures OpenAI as an env-ref provider, verifies no raw key persistence, and runs a mocked agent turn.
721
+ - Release media/memory smoke: `pnpm test:docker:release-media-memory` installs the packed tarball, verifies image understanding from a PNG attachment, OpenAI-compatible image generation output, memory search recall, and recall survival across Gateway restart.
722
+ - Release upgrade user journey smoke: `pnpm test:docker:release-upgrade-user-journey` installs `nodmix@latest` by default, configures provider/plugin/ClickClack state on the published package, upgrades to the candidate tarball, then reruns the core agent/plugin/channel journey. Override the baseline with `NODMIX_RELEASE_UPGRADE_BASELINE_SPEC=nodmix@<version>`.
723
+ - Release plugin marketplace smoke: `pnpm test:docker:release-plugin-marketplace` installs from a local fixture marketplace, updates the installed plugin, uninstalls it, and verifies the plugin CLI disappears with install metadata pruned.
724
+ - Skill install smoke: `pnpm test:docker:skill-install` installs the packed Nodmix tarball globally in Docker, disables uploaded archive installs in config, resolves the current live ClawHub skill slug from search, installs it with `nodmix skills install`, and verifies the installed skill plus `.clawhub` origin/lock metadata.
725
+ - Update channel switch smoke: `pnpm test:docker:update-channel-switch` installs the packed Nodmix tarball globally in Docker, switches from package `stable` to git `dev`, verifies the persisted channel and plugin post-update work, then switches back to package `stable` and checks update status.
726
+ - Upgrade survivor smoke: `pnpm test:docker:upgrade-survivor` installs the packed Nodmix tarball over a dirty old-user fixture with agents, channel config, plugin allowlists, stale plugin dependency state, and existing workspace/session files. It runs package update plus non-interactive doctor without live provider or channel keys, then starts a loopback Gateway and checks config/state preservation plus startup/status budgets.
727
+ - Published upgrade survivor smoke: `pnpm test:docker:published-upgrade-survivor` installs `nodmix@latest` by default, seeds realistic existing-user files, configures that baseline with a baked command recipe, validates the resulting config, updates that published install to the candidate tarball, runs non-interactive doctor, writes `.artifacts/upgrade-survivor/summary.json`, then starts a loopback Gateway and checks configured intents, state preservation, startup, `/healthz`, `/readyz`, and RPC status budgets. Override one baseline with `NODMIX_UPGRADE_SURVIVOR_BASELINE_SPEC`, ask the aggregate scheduler to expand exact local baselines with `NODMIX_UPGRADE_SURVIVOR_BASELINE_SPECS` such as `nodmix@2026.5.2 nodmix@2026.4.23 nodmix@2026.4.15`, and expand issue-shaped fixtures with `NODMIX_UPGRADE_SURVIVOR_SCENARIOS` such as `reported-issues`; the reported-issues set includes `configured-plugin-installs` for automatic external Nodmix plugin install repair. Package Acceptance exposes those as `published_upgrade_survivor_baseline`, `published_upgrade_survivor_baselines`, and `published_upgrade_survivor_scenarios`, resolves meta baseline tokens such as `last-stable-4` or `all-since-2026.4.23`, and Full Release Validation expands the release-soak package gate to `last-stable-4 2026.4.23 2026.5.2 2026.4.15` plus `reported-issues`.
728
+ - Session runtime context smoke: `pnpm test:docker:session-runtime-context` verifies hidden runtime context transcript persistence plus doctor repair of affected duplicated prompt-rewrite branches.
729
+ - Bun global install smoke: `bash scripts/e2e/bun-global-install-smoke.sh` packs the current tree, installs it with `bun install -g` in an isolated home, and verifies `nodmix infer image providers --json` returns bundled image providers instead of hanging. Reuse a prebuilt tarball with `NODMIX_BUN_GLOBAL_SMOKE_PACKAGE_TGZ=/path/to/nodmix-*.tgz`, skip the host build with `NODMIX_BUN_GLOBAL_SMOKE_HOST_BUILD=0`, or copy `dist/` from a built Docker image with `NODMIX_BUN_GLOBAL_SMOKE_DIST_IMAGE=nodmix-dockerfile-smoke:local`.
730
+ - Installer Docker smoke: `bash scripts/test-install-sh-docker.sh` shares one npm cache across its root, update, and direct-npm containers. Update smoke defaults to npm `latest` as the stable baseline before upgrading to the candidate tarball. Override with `NODMIX_INSTALL_SMOKE_UPDATE_BASELINE=2026.4.22` locally, or with the Install Smoke workflow's `update_baseline_version` input on GitHub. Non-root installer checks keep an isolated npm cache so root-owned cache entries do not mask user-local install behavior. Set `NODMIX_INSTALL_SMOKE_NPM_CACHE_DIR=/path/to/cache` to reuse the root/update/direct-npm cache across local reruns.
731
+ - Install Smoke CI skips the duplicate direct-npm global update with `NODMIX_INSTALL_SMOKE_SKIP_NPM_GLOBAL=1`; run the script locally without that env when direct `npm install -g` coverage is needed.
732
+ - Agents delete shared workspace CLI smoke: `pnpm test:docker:agents-delete-shared-workspace` (script: `scripts/e2e/agents-delete-shared-workspace-docker.sh`) builds the root Dockerfile image by default, seeds two agents with one workspace in an isolated container home, runs `agents delete --json`, and verifies valid JSON plus retained workspace behavior. Reuse the install-smoke image with `NODMIX_AGENTS_DELETE_SHARED_WORKSPACE_E2E_IMAGE=nodmix-dockerfile-smoke:local NODMIX_AGENTS_DELETE_SHARED_WORKSPACE_E2E_SKIP_BUILD=1`.
733
+ - Gateway networking (two containers, WS auth + health): `pnpm test:docker:gateway-network` (script: `scripts/e2e/gateway-network-docker.sh`)
734
+ - Browser CDP snapshot smoke: `pnpm test:docker:browser-cdp-snapshot` (script: `scripts/e2e/browser-cdp-snapshot-docker.sh`) builds the source E2E image plus a Chromium layer, starts Chromium with raw CDP, runs `browser doctor --deep`, and verifies CDP role snapshots cover link URLs, cursor-promoted clickables, iframe refs, and frame metadata.
735
+ - OpenAI Responses web_search minimal reasoning regression: `pnpm test:docker:openai-web-search-minimal` (script: `scripts/e2e/openai-web-search-minimal-docker.sh`) runs a mocked OpenAI server through Gateway, verifies `web_search` raises `reasoning.effort` from `minimal` to `low`, then forces the provider schema reject and checks the raw detail appears in Gateway logs.
736
+ - MCP channel bridge (seeded Gateway + stdio bridge + raw Claude notification-frame smoke): `pnpm test:docker:mcp-channels` (script: `scripts/e2e/mcp-channels-docker.sh`)
737
+ - Pi bundle MCP tools (real stdio MCP server + embedded Pi profile allow/deny smoke): `pnpm test:docker:pi-bundle-mcp-tools` (script: `scripts/e2e/pi-bundle-mcp-tools-docker.sh`)
738
+ - Cron/subagent MCP cleanup (real Gateway + stdio MCP child teardown after isolated cron and one-shot subagent runs): `pnpm test:docker:cron-mcp-cleanup` (script: `scripts/e2e/cron-mcp-cleanup-docker.sh`)
739
+ - Plugins (install/update smoke for local path, `file:`, npm registry with hoisted dependencies, malformed npm package metadata, git moving refs, ClawHub kitchen-sink, marketplace updates, and Claude-bundle enable/inspect): `pnpm test:docker:plugins` (script: `scripts/e2e/plugins-docker.sh`)
740
+ Set `NODMIX_PLUGINS_E2E_CLAWHUB=0` to skip the ClawHub block, or override the default kitchen-sink package/runtime pair with `NODMIX_PLUGINS_E2E_CLAWHUB_SPEC` and `NODMIX_PLUGINS_E2E_CLAWHUB_ID`. Without `NODMIX_CLAWHUB_URL`/`CLAWHUB_URL`, the test uses a hermetic local ClawHub fixture server.
741
+ - Plugin update unchanged smoke: `pnpm test:docker:plugin-update` (script: `scripts/e2e/plugin-update-unchanged-docker.sh`)
742
+ - Plugin lifecycle matrix smoke: `pnpm test:docker:plugin-lifecycle-matrix` installs the packed Nodmix tarball in a bare container, installs an npm plugin, toggles enable/disable, upgrades and downgrades it through a local npm registry, deletes the installed code, then verifies uninstall still removes stale state while logging RSS/CPU metrics for each lifecycle phase.
743
+ - Config reload metadata smoke: `pnpm test:docker:config-reload` (script: `scripts/e2e/config-reload-source-docker.sh`)
744
+ - Plugins: `pnpm test:docker:plugins` covers install/update smoke for local path, `file:`, npm registry with hoisted dependencies, git moving refs, ClawHub fixtures, marketplace updates, and Claude-bundle enable/inspect. `pnpm test:docker:plugin-update` covers unchanged update behavior for installed plugins. `pnpm test:docker:plugin-lifecycle-matrix` covers resource-tracked npm plugin install, enable, disable, upgrade, downgrade, and missing-code uninstall.
745
+
746
+ To prebuild and reuse the shared functional image manually:
747
+
748
+ ```bash
749
+ NODMIX_DOCKER_E2E_IMAGE=nodmix-docker-e2e-functional:local pnpm test:docker:e2e-build
750
+ NODMIX_DOCKER_E2E_IMAGE=nodmix-docker-e2e-functional:local NODMIX_SKIP_DOCKER_BUILD=1 pnpm test:docker:mcp-channels
751
+ ```
752
+
753
+ Suite-specific image overrides such as `NODMIX_GATEWAY_NETWORK_E2E_IMAGE` still win when set. When `NODMIX_SKIP_DOCKER_BUILD=1` points at a remote shared image, the scripts pull it if it is not already local. The QR and installer Docker tests keep their own Dockerfiles because they validate package/install behavior rather than the shared built-app runtime.
754
+
755
+ The live-model Docker runners also bind-mount the current checkout read-only and
756
+ stage it into a temporary workdir inside the container. This keeps the runtime
757
+ image slim while still running Vitest against your exact local source/config.
758
+ The staging step skips large local-only caches and app build outputs such as
759
+ `.pnpm-store`, `.worktrees`, `__nodmix_vitest__`, and app-local `.build` or
760
+ Gradle output directories so Docker live runs do not spend minutes copying
761
+ machine-specific artifacts.
762
+ They also set `NODMIX_SKIP_CHANNELS=1` so gateway live probes do not start
763
+ real Telegram/Discord/etc. channel workers inside the container.
764
+ `test:docker:live-models` still runs `pnpm test:live`, so pass through
765
+ `NODMIX_LIVE_GATEWAY_*` as well when you need to narrow or exclude gateway
766
+ live coverage from that Docker lane.
767
+ `test:docker:openwebui` is a higher-level compatibility smoke: it starts an
768
+ Nodmix gateway container with the OpenAI-compatible HTTP endpoints enabled,
769
+ starts a pinned Open WebUI container against that gateway, signs in through
770
+ Open WebUI, verifies `/api/models` exposes `nodmix/default`, then sends a
771
+ real chat request through Open WebUI's `/api/chat/completions` proxy.
772
+ Set `OPENWEBUI_SMOKE_MODE=models` for release-path CI checks that should stop
773
+ after Open WebUI sign-in and model discovery, without waiting on a live model
774
+ completion.
775
+ The first run can be noticeably slower because Docker may need to pull the
776
+ Open WebUI image and Open WebUI may need to finish its own cold-start setup.
777
+ This lane expects a usable live model key. Provide it through the process
778
+ environment, staged auth profiles, or an explicit `NODMIX_PROFILE_FILE`.
779
+ Successful runs print a small JSON payload like `{ "ok": true, "model":
780
+ "nodmix/default", ... }`.
781
+ `test:docker:mcp-channels` is intentionally deterministic and does not need a
782
+ real Telegram, Discord, or iMessage account. It boots a seeded Gateway
783
+ container, starts a second container that spawns `nodmix mcp serve`, then
784
+ verifies routed conversation discovery, transcript reads, attachment metadata,
785
+ live event queue behavior, outbound send routing, and Claude-style channel +
786
+ permission notifications over the real stdio MCP bridge. The notification check
787
+ inspects the raw stdio MCP frames directly so the smoke validates what the
788
+ bridge actually emits, not just what a specific client SDK happens to surface.
789
+ `test:docker:pi-bundle-mcp-tools` is deterministic and does not need a live
790
+ model key. It builds the repo Docker image, starts a real stdio MCP probe server
791
+ inside the container, materializes that server through the embedded Pi bundle
792
+ MCP runtime, executes the tool, then verifies `coding` and `messaging` keep
793
+ `bundle-mcp` tools while `minimal` and `tools.deny: ["bundle-mcp"]` filter them.
794
+ `test:docker:cron-mcp-cleanup` is deterministic and does not need a live model
795
+ key. It starts a seeded Gateway with a real stdio MCP probe server, runs an
796
+ isolated cron turn and a `/subagents spawn` one-shot child turn, then verifies
797
+ the MCP child process exits after each run.
798
+
799
+ Manual ACP plain-language thread smoke (not CI):
800
+
801
+ - `bun scripts/dev/discord-acp-plain-language-smoke.ts --channel <discord-channel-id> ...`
802
+ - Keep this script for regression/debug workflows. It may be needed again for ACP thread routing validation, so do not delete it.
803
+
804
+ Useful env vars:
805
+
806
+ - `NODMIX_CONFIG_DIR=...` (default: `~/.nodmix`) mounted to `/home/node/.nodmix`
807
+ - `NODMIX_WORKSPACE_DIR=...` (default: `~/.nodmix/workspace`) mounted to `/home/node/.nodmix/workspace`
808
+ - `NODMIX_PROFILE_FILE=...` mounted and sourced before running tests
809
+ - `NODMIX_DOCKER_PROFILE_ENV_ONLY=1` to verify only env vars sourced from `NODMIX_PROFILE_FILE`, using temporary config/workspace dirs and no external CLI auth mounts
810
+ - `NODMIX_DOCKER_CLI_TOOLS_DIR=...` (default: `~/.cache/nodmix/docker-cli-tools`) mounted to `/home/node/.npm-global` for cached CLI installs inside Docker
811
+ - External CLI auth dirs/files under `$HOME` are mounted read-only under `/host-auth...`, then copied into `/home/node/...` before tests start
812
+ - Default dirs: `.minimax`
813
+ - Default files: `~/.codex/auth.json`, `~/.codex/config.toml`, `.claude.json`, `~/.claude/.credentials.json`, `~/.claude/settings.json`, `~/.claude/settings.local.json`
814
+ - Narrowed provider runs mount only the needed dirs/files inferred from `NODMIX_LIVE_PROVIDERS` / `NODMIX_LIVE_GATEWAY_PROVIDERS`
815
+ - Override manually with `NODMIX_DOCKER_AUTH_DIRS=all`, `NODMIX_DOCKER_AUTH_DIRS=none`, or a comma list like `NODMIX_DOCKER_AUTH_DIRS=.claude,.codex`
816
+ - `NODMIX_LIVE_GATEWAY_MODELS=...` / `NODMIX_LIVE_MODELS=...` to narrow the run
817
+ - `NODMIX_LIVE_GATEWAY_PROVIDERS=...` / `NODMIX_LIVE_PROVIDERS=...` to filter providers in-container
818
+ - `NODMIX_SKIP_DOCKER_BUILD=1` to reuse an existing `nodmix:local-live` image for reruns that do not need a rebuild
819
+ - `NODMIX_LIVE_REQUIRE_PROFILE_KEYS=1` to ensure creds come from the profile store (not env)
820
+ - `NODMIX_OPENWEBUI_MODEL=...` to choose the model exposed by the gateway for the Open WebUI smoke
821
+ - `NODMIX_OPENWEBUI_PROMPT=...` to override the nonce-check prompt used by the Open WebUI smoke
822
+ - `OPENWEBUI_IMAGE=...` to override the pinned Open WebUI image tag
823
+
824
+ ## Docs sanity
825
+
826
+ Run docs checks after doc edits: `pnpm check:docs`.
827
+ Run full Mintlify anchor validation when you need in-page heading checks too: `pnpm docs:check-links:anchors`.
828
+
829
+ ## Offline regression (CI-safe)
830
+
831
+ These are "real pipeline" regressions without real providers:
832
+
833
+ - Gateway tool calling (mock OpenAI, real gateway + agent loop): `src/gateway/gateway.test.ts` (case: "runs a mock OpenAI tool call end-to-end via gateway agent loop")
834
+ - Gateway wizard (WS `wizard.start`/`wizard.next`, writes config + auth enforced): `src/gateway/gateway.test.ts` (case: "runs wizard over ws and writes auth token config")
835
+
836
+ ## Agent reliability evals (skills)
837
+
838
+ We already have a few CI-safe tests that behave like "agent reliability evals":
839
+
840
+ - Mock tool-calling through the real gateway + agent loop (`src/gateway/gateway.test.ts`).
841
+ - End-to-end wizard flows that validate session wiring and config effects (`src/gateway/gateway.test.ts`).
842
+
843
+ What's still missing for skills (see [Skills](/tools/skills)):
844
+
845
+ - **Decisioning:** when skills are listed in the prompt, does the agent pick the right skill (or avoid irrelevant ones)?
846
+ - **Compliance:** does the agent read `SKILL.md` before use and follow required steps/args?
847
+ - **Workflow contracts:** multi-turn scenarios that assert tool order, session history carryover, and sandbox boundaries.
848
+
849
+ Future evals should stay deterministic first:
850
+
851
+ - A scenario runner using mock providers to assert tool calls + order, skill file reads, and session wiring.
852
+ - A small suite of skill-focused scenarios (use vs avoid, gating, prompt injection).
853
+ - Optional live evals (opt-in, env-gated) only after the CI-safe suite is in place.
854
+
855
+ ## Contract tests (plugin and channel shape)
856
+
857
+ Contract tests verify that every registered plugin and channel conforms to its
858
+ interface contract. They iterate over all discovered plugins and run a suite of
859
+ shape and behavior assertions. The default `pnpm test` unit lane intentionally
860
+ skips these shared seam and smoke files; run the contract commands explicitly
861
+ when you touch shared channel or provider surfaces.
862
+
863
+ ### Commands
864
+
865
+ - All contracts: `pnpm test:contracts`
866
+ - Channel contracts only: `pnpm test:contracts:channels`
867
+ - Provider contracts only: `pnpm test:contracts:plugins`
868
+
869
+ ### Channel contracts
870
+
871
+ Located in `src/channels/plugins/contracts/*.contract.test.ts`:
872
+
873
+ - **plugin** - Basic plugin shape (id, name, capabilities)
874
+ - **setup** - Setup wizard contract
875
+ - **session-binding** - Session binding behavior
876
+ - **outbound-payload** - Message payload structure
877
+ - **inbound** - Inbound message handling
878
+ - **actions** - Channel action handlers
879
+ - **threading** - Thread ID handling
880
+ - **directory** - Directory/roster API
881
+ - **group-policy** - Group policy enforcement
882
+
883
+ ### Provider status contracts
884
+
885
+ Located in `src/plugins/contracts/*.contract.test.ts`.
886
+
887
+ - **status** - Channel status probes
888
+ - **registry** - Plugin registry shape
889
+
890
+ ### Provider contracts
891
+
892
+ Located in `src/plugins/contracts/*.contract.test.ts`:
893
+
894
+ - **auth** - Auth flow contract
895
+ - **auth-choice** - Auth choice/selection
896
+ - **catalog** - Model catalog API
897
+ - **discovery** - Plugin discovery
898
+ - **loader** - Plugin loading
899
+ - **runtime** - Provider runtime
900
+ - **shape** - Plugin shape/interface
901
+ - **wizard** - Setup wizard
902
+
903
+ ### When to run
904
+
905
+ - After changing plugin-sdk exports or subpaths
906
+ - After adding or modifying a channel or provider plugin
907
+ - After refactoring plugin registration or discovery
908
+
909
+ Contract tests run in CI and do not require real API keys.
910
+
911
+ ## Adding regressions (guidance)
912
+
913
+ When you fix a provider/model issue discovered in live:
914
+
915
+ - Add a CI-safe regression if possible (mock/stub provider, or capture the exact request-shape transformation)
916
+ - If it's inherently live-only (rate limits, auth policies), keep the live test narrow and opt-in via env vars
917
+ - Prefer targeting the smallest layer that catches the bug:
918
+ - provider request conversion/replay bug → direct models test
919
+ - gateway session/history/tool pipeline bug → gateway live smoke or CI-safe gateway mock test
920
+ - SecretRef traversal guardrail:
921
+ - `src/secrets/exec-secret-ref-id-parity.test.ts` derives one sampled target per SecretRef class from registry metadata (`listSecretTargetRegistryEntries()`), then asserts traversal-segment exec ids are rejected.
922
+ - If you add a new `includeInPlan` SecretRef target family in `src/secrets/target-registry-data.ts`, update `classifyTargetClass` in that test. The test intentionally fails on unclassified target ids so new classes cannot be skipped silently.
923
+
924
+ ## Related
925
+
926
+ - [Testing live](/help/testing-live)
927
+ - [Testing updates and plugins](/help/testing-updates-plugins)
928
+ - [CI](/ci)