vilvona 1.0.0

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 (812) hide show
  1. package/CHANGELOG.md +12331 -0
  2. package/LICENSE +24 -0
  3. package/README.md +314 -0
  4. package/THIRD_PARTY_NOTICES.md +37 -0
  5. package/docs/.i18n/README.md +81 -0
  6. package/docs/.i18n/ar-navigation.json +18 -0
  7. package/docs/.i18n/de-navigation.json +18 -0
  8. package/docs/.i18n/es-navigation.json +18 -0
  9. package/docs/.i18n/fr-navigation.json +18 -0
  10. package/docs/.i18n/glossary.ar.json +82 -0
  11. package/docs/.i18n/glossary.de.json +82 -0
  12. package/docs/.i18n/glossary.es.json +82 -0
  13. package/docs/.i18n/glossary.fa.json +82 -0
  14. package/docs/.i18n/glossary.fr.json +82 -0
  15. package/docs/.i18n/glossary.id.json +82 -0
  16. package/docs/.i18n/glossary.it.json +82 -0
  17. package/docs/.i18n/glossary.ja-JP.json +102 -0
  18. package/docs/.i18n/glossary.ko.json +82 -0
  19. package/docs/.i18n/glossary.nl.json +82 -0
  20. package/docs/.i18n/glossary.pl.json +82 -0
  21. package/docs/.i18n/glossary.pt-BR.json +82 -0
  22. package/docs/.i18n/glossary.th.json +82 -0
  23. package/docs/.i18n/glossary.tr.json +82 -0
  24. package/docs/.i18n/glossary.uk.json +82 -0
  25. package/docs/.i18n/glossary.vi.json +82 -0
  26. package/docs/.i18n/glossary.zh-CN.json +1182 -0
  27. package/docs/.i18n/glossary.zh-TW.json +162 -0
  28. package/docs/.i18n/id-navigation.json +18 -0
  29. package/docs/.i18n/it-navigation.json +18 -0
  30. package/docs/.i18n/ja-navigation.json +18 -0
  31. package/docs/.i18n/ko-navigation.json +18 -0
  32. package/docs/.i18n/pl-navigation.json +18 -0
  33. package/docs/.i18n/pt-BR-navigation.json +18 -0
  34. package/docs/.i18n/tr-navigation.json +18 -0
  35. package/docs/.i18n/translation-workflow.md +111 -0
  36. package/docs/.i18n/zh-Hans-navigation.json +552 -0
  37. package/docs/AGENTS.md +36 -0
  38. package/docs/agent-runtime-architecture.md +48 -0
  39. package/docs/announcements/bluebubbles-imessage.md +79 -0
  40. package/docs/auth-credential-semantics.md +124 -0
  41. package/docs/automation/auth-monitoring.md +11 -0
  42. package/docs/automation/clawflow.md +12 -0
  43. package/docs/automation/cron-jobs.md +569 -0
  44. package/docs/automation/cron-vs-heartbeat.md +11 -0
  45. package/docs/automation/gmail-pubsub.md +11 -0
  46. package/docs/automation/hooks.md +387 -0
  47. package/docs/automation/index.md +135 -0
  48. package/docs/automation/poll.md +12 -0
  49. package/docs/automation/standing-orders.md +250 -0
  50. package/docs/automation/taskflow.md +155 -0
  51. package/docs/automation/tasks.md +374 -0
  52. package/docs/automation/troubleshooting.md +12 -0
  53. package/docs/automation/webhook.md +12 -0
  54. package/docs/brave-search.md +11 -0
  55. package/docs/channels/access-groups.md +201 -0
  56. package/docs/channels/ambient-room-events.md +214 -0
  57. package/docs/channels/bot-loop-protection.md +131 -0
  58. package/docs/channels/broadcast-groups.md +472 -0
  59. package/docs/channels/channel-routing.md +162 -0
  60. package/docs/channels/clickclack.md +146 -0
  61. package/docs/channels/discord.md +1758 -0
  62. package/docs/channels/feishu.md +654 -0
  63. package/docs/channels/googlechat.md +286 -0
  64. package/docs/channels/group-messages.md +95 -0
  65. package/docs/channels/groups.md +610 -0
  66. package/docs/channels/imessage-from-bluebubbles.md +259 -0
  67. package/docs/channels/imessage.md +864 -0
  68. package/docs/channels/index.md +65 -0
  69. package/docs/channels/irc.md +253 -0
  70. package/docs/channels/line.md +243 -0
  71. package/docs/channels/location.md +71 -0
  72. package/docs/channels/matrix-migration.md +375 -0
  73. package/docs/channels/matrix-presentation.md +77 -0
  74. package/docs/channels/matrix-push-rules.md +150 -0
  75. package/docs/channels/matrix.md +935 -0
  76. package/docs/channels/mattermost.md +542 -0
  77. package/docs/channels/msteams.md +1097 -0
  78. package/docs/channels/nextcloud-talk.md +176 -0
  79. package/docs/channels/nostr.md +253 -0
  80. package/docs/channels/pairing.md +214 -0
  81. package/docs/channels/qqbot.md +317 -0
  82. package/docs/channels/signal.md +417 -0
  83. package/docs/channels/slack.md +1623 -0
  84. package/docs/channels/sms.md +380 -0
  85. package/docs/channels/synology-chat.md +187 -0
  86. package/docs/channels/telegram.md +1121 -0
  87. package/docs/channels/tlon.md +296 -0
  88. package/docs/channels/troubleshooting.md +162 -0
  89. package/docs/channels/twitch.md +431 -0
  90. package/docs/channels/wechat.md +171 -0
  91. package/docs/channels/whatsapp.md +796 -0
  92. package/docs/channels/yuanbao.md +416 -0
  93. package/docs/channels/zalo.md +253 -0
  94. package/docs/channels/zalouser.md +217 -0
  95. package/docs/ci.md +665 -0
  96. package/docs/clawhub/cli.md +82 -0
  97. package/docs/clawhub/publishing.md +96 -0
  98. package/docs/cli/acp.md +370 -0
  99. package/docs/cli/agent.md +109 -0
  100. package/docs/cli/agents.md +253 -0
  101. package/docs/cli/approvals.md +193 -0
  102. package/docs/cli/backup.md +98 -0
  103. package/docs/cli/browser.md +322 -0
  104. package/docs/cli/channels.md +154 -0
  105. package/docs/cli/clawbot.md +25 -0
  106. package/docs/cli/commitments.md +90 -0
  107. package/docs/cli/completion.md +39 -0
  108. package/docs/cli/config.md +504 -0
  109. package/docs/cli/configure.md +77 -0
  110. package/docs/cli/crestodian.md +337 -0
  111. package/docs/cli/cron.md +344 -0
  112. package/docs/cli/daemon.md +67 -0
  113. package/docs/cli/dashboard.md +33 -0
  114. package/docs/cli/devices.md +240 -0
  115. package/docs/cli/directory.md +68 -0
  116. package/docs/cli/dns.md +53 -0
  117. package/docs/cli/docs.md +63 -0
  118. package/docs/cli/doctor.md +254 -0
  119. package/docs/cli/flows.md +52 -0
  120. package/docs/cli/gateway.md +572 -0
  121. package/docs/cli/health.md +43 -0
  122. package/docs/cli/hooks.md +345 -0
  123. package/docs/cli/index.md +406 -0
  124. package/docs/cli/infer.md +364 -0
  125. package/docs/cli/logs.md +68 -0
  126. package/docs/cli/mcp.md +851 -0
  127. package/docs/cli/memory.md +183 -0
  128. package/docs/cli/message.md +317 -0
  129. package/docs/cli/migrate.md +334 -0
  130. package/docs/cli/models.md +239 -0
  131. package/docs/cli/node.md +178 -0
  132. package/docs/cli/nodes.md +76 -0
  133. package/docs/cli/onboard.md +251 -0
  134. package/docs/cli/pairing.md +77 -0
  135. package/docs/cli/path.md +511 -0
  136. package/docs/cli/plugins.md +480 -0
  137. package/docs/cli/policy.md +929 -0
  138. package/docs/cli/proxy.md +89 -0
  139. package/docs/cli/qr.md +56 -0
  140. package/docs/cli/reset.md +39 -0
  141. package/docs/cli/sandbox.md +208 -0
  142. package/docs/cli/secrets.md +202 -0
  143. package/docs/cli/security.md +135 -0
  144. package/docs/cli/sessions.md +178 -0
  145. package/docs/cli/setup.md +60 -0
  146. package/docs/cli/skills.md +156 -0
  147. package/docs/cli/status.md +45 -0
  148. package/docs/cli/system.md +89 -0
  149. package/docs/cli/tasks.md +111 -0
  150. package/docs/cli/transcripts.md +151 -0
  151. package/docs/cli/tui.md +92 -0
  152. package/docs/cli/uninstall.md +45 -0
  153. package/docs/cli/update.md +283 -0
  154. package/docs/cli/voicecall.md +204 -0
  155. package/docs/cli/webhooks.md +117 -0
  156. package/docs/cli/wiki.md +256 -0
  157. package/docs/cli/workboard.md +228 -0
  158. package/docs/concepts/active-memory.md +856 -0
  159. package/docs/concepts/agent-loop.md +185 -0
  160. package/docs/concepts/agent-runtimes.md +276 -0
  161. package/docs/concepts/agent-workspace.md +230 -0
  162. package/docs/concepts/agent.md +142 -0
  163. package/docs/concepts/architecture.md +154 -0
  164. package/docs/concepts/channel-docking.md +145 -0
  165. package/docs/concepts/commitments.md +150 -0
  166. package/docs/concepts/compaction.md +203 -0
  167. package/docs/concepts/context-engine.md +347 -0
  168. package/docs/concepts/context.md +199 -0
  169. package/docs/concepts/delegate-architecture.md +319 -0
  170. package/docs/concepts/dreaming.md +279 -0
  171. package/docs/concepts/experimental-features.md +111 -0
  172. package/docs/concepts/features.md +91 -0
  173. package/docs/concepts/mantis-slack-desktop-runbook.md +231 -0
  174. package/docs/concepts/mantis.md +744 -0
  175. package/docs/concepts/markdown-formatting.md +139 -0
  176. package/docs/concepts/memory-builtin.md +151 -0
  177. package/docs/concepts/memory-honcho.md +144 -0
  178. package/docs/concepts/memory-qmd.md +277 -0
  179. package/docs/concepts/memory-search.md +175 -0
  180. package/docs/concepts/memory.md +299 -0
  181. package/docs/concepts/message-lifecycle-refactor.md +1126 -0
  182. package/docs/concepts/messages.md +216 -0
  183. package/docs/concepts/model-failover.md +405 -0
  184. package/docs/concepts/model-providers.md +719 -0
  185. package/docs/concepts/models.md +371 -0
  186. package/docs/concepts/multi-agent.md +625 -0
  187. package/docs/concepts/oauth.md +218 -0
  188. package/docs/concepts/parallel-specialist-lanes.md +127 -0
  189. package/docs/concepts/personal-agent-benchmark-pack.md +74 -0
  190. package/docs/concepts/presence.md +117 -0
  191. package/docs/concepts/progress-drafts.md +406 -0
  192. package/docs/concepts/qa-e2e-automation.md +979 -0
  193. package/docs/concepts/qa-matrix.md +139 -0
  194. package/docs/concepts/queue-steering.md +90 -0
  195. package/docs/concepts/queue.md +136 -0
  196. package/docs/concepts/retry.md +86 -0
  197. package/docs/concepts/session-pruning.md +104 -0
  198. package/docs/concepts/session-tool.md +201 -0
  199. package/docs/concepts/session.md +164 -0
  200. package/docs/concepts/soul.md +116 -0
  201. package/docs/concepts/streaming.md +258 -0
  202. package/docs/concepts/system-prompt.md +330 -0
  203. package/docs/concepts/timezone.md +47 -0
  204. package/docs/concepts/typebox.md +309 -0
  205. package/docs/concepts/typing-indicators.md +88 -0
  206. package/docs/concepts/usage-tracking.md +72 -0
  207. package/docs/date-time.md +126 -0
  208. package/docs/debug/node-issue.md +90 -0
  209. package/docs/diagnostics/flags.md +182 -0
  210. package/docs/docs.json +1885 -0
  211. package/docs/gateway/authentication.md +286 -0
  212. package/docs/gateway/background-process.md +147 -0
  213. package/docs/gateway/bonjour.md +303 -0
  214. package/docs/gateway/bridge-protocol.md +97 -0
  215. package/docs/gateway/cli-backends.md +463 -0
  216. package/docs/gateway/config-agents.md +1525 -0
  217. package/docs/gateway/config-channels.md +942 -0
  218. package/docs/gateway/config-tools.md +806 -0
  219. package/docs/gateway/configuration-examples.md +706 -0
  220. package/docs/gateway/configuration-reference.md +1449 -0
  221. package/docs/gateway/configuration.md +748 -0
  222. package/docs/gateway/diagnostics.md +213 -0
  223. package/docs/gateway/discovery.md +154 -0
  224. package/docs/gateway/doctor.md +576 -0
  225. package/docs/gateway/external-apps.md +86 -0
  226. package/docs/gateway/gateway-lock.md +37 -0
  227. package/docs/gateway/health.md +73 -0
  228. package/docs/gateway/heartbeat.md +498 -0
  229. package/docs/gateway/index.md +385 -0
  230. package/docs/gateway/local-model-services.md +205 -0
  231. package/docs/gateway/local-models.md +355 -0
  232. package/docs/gateway/logging.md +149 -0
  233. package/docs/gateway/multiple-gateways.md +178 -0
  234. package/docs/gateway/network-model.md +15 -0
  235. package/docs/gateway/openai-http-api.md +379 -0
  236. package/docs/gateway/openresponses-http-api.md +349 -0
  237. package/docs/gateway/openshell.md +316 -0
  238. package/docs/gateway/opentelemetry.md +440 -0
  239. package/docs/gateway/operator-scopes.md +119 -0
  240. package/docs/gateway/pairing.md +207 -0
  241. package/docs/gateway/prometheus.md +249 -0
  242. package/docs/gateway/protocol.md +839 -0
  243. package/docs/gateway/remote-gateway-readme.md +169 -0
  244. package/docs/gateway/remote.md +280 -0
  245. package/docs/gateway/sandbox-vs-tool-policy-vs-elevated.md +148 -0
  246. package/docs/gateway/sandboxing.md +546 -0
  247. package/docs/gateway/secrets-plan-contract.md +159 -0
  248. package/docs/gateway/secrets.md +805 -0
  249. package/docs/gateway/security/audit-checks.md +127 -0
  250. package/docs/gateway/security/exposure-runbook.md +212 -0
  251. package/docs/gateway/security/index.md +1344 -0
  252. package/docs/gateway/security/secure-file-operations.md +76 -0
  253. package/docs/gateway/security/shrinkwrap.md +111 -0
  254. package/docs/gateway/tailscale.md +180 -0
  255. package/docs/gateway/tools-invoke-http-api.md +175 -0
  256. package/docs/gateway/troubleshooting.md +881 -0
  257. package/docs/gateway/trusted-proxy-auth.md +483 -0
  258. package/docs/help/debugging.md +341 -0
  259. package/docs/help/environment.md +240 -0
  260. package/docs/help/faq-first-run.md +872 -0
  261. package/docs/help/faq-models.md +557 -0
  262. package/docs/help/faq.md +2115 -0
  263. package/docs/help/index.md +39 -0
  264. package/docs/help/scripts.md +56 -0
  265. package/docs/help/testing-live.md +592 -0
  266. package/docs/help/testing-updates-plugins.md +299 -0
  267. package/docs/help/testing.md +977 -0
  268. package/docs/help/troubleshooting.md +500 -0
  269. package/docs/index.md +196 -0
  270. package/docs/install/ansible.md +233 -0
  271. package/docs/install/azure.md +315 -0
  272. package/docs/install/bun.md +59 -0
  273. package/docs/install/clawdock.md +112 -0
  274. package/docs/install/development-channels.md +148 -0
  275. package/docs/install/digitalocean.md +174 -0
  276. package/docs/install/docker-vm-runtime.md +154 -0
  277. package/docs/install/docker.md +564 -0
  278. package/docs/install/exe-dev.md +201 -0
  279. package/docs/install/fly.md +524 -0
  280. package/docs/install/gcp.md +418 -0
  281. package/docs/install/hetzner.md +285 -0
  282. package/docs/install/hostinger.md +98 -0
  283. package/docs/install/index.md +236 -0
  284. package/docs/install/installer.md +447 -0
  285. package/docs/install/kubernetes.md +196 -0
  286. package/docs/install/macos-vm.md +281 -0
  287. package/docs/install/migrating-claude.md +165 -0
  288. package/docs/install/migrating-hermes.md +178 -0
  289. package/docs/install/migrating.md +137 -0
  290. package/docs/install/nix.md +112 -0
  291. package/docs/install/node.md +142 -0
  292. package/docs/install/northflank.mdx +44 -0
  293. package/docs/install/oracle.md +218 -0
  294. package/docs/install/podman.md +216 -0
  295. package/docs/install/railway.mdx +92 -0
  296. package/docs/install/raspberry-pi.md +234 -0
  297. package/docs/install/render.mdx +167 -0
  298. package/docs/install/uninstall.md +140 -0
  299. package/docs/install/updating.md +284 -0
  300. package/docs/install/upstash.md +96 -0
  301. package/docs/logging.md +322 -0
  302. package/docs/maturity-scores.yaml +5361 -0
  303. package/docs/nav-tabs-underline.js +104 -0
  304. package/docs/network.md +72 -0
  305. package/docs/nodes/audio.md +216 -0
  306. package/docs/nodes/camera.md +166 -0
  307. package/docs/nodes/images.md +77 -0
  308. package/docs/nodes/index.md +444 -0
  309. package/docs/nodes/location-command.md +102 -0
  310. package/docs/nodes/media-understanding.md +495 -0
  311. package/docs/nodes/talk.md +160 -0
  312. package/docs/nodes/troubleshooting.md +123 -0
  313. package/docs/nodes/voicewake.md +93 -0
  314. package/docs/openclaw-agent-runtime.md +82 -0
  315. package/docs/perplexity.md +11 -0
  316. package/docs/plan/codex-context-engine-harness.md +624 -0
  317. package/docs/plan/ui-channels.md +284 -0
  318. package/docs/platforms/android.md +286 -0
  319. package/docs/platforms/digitalocean.md +12 -0
  320. package/docs/platforms/easyrunner.md +109 -0
  321. package/docs/platforms/index.md +65 -0
  322. package/docs/platforms/ios.md +287 -0
  323. package/docs/platforms/linux.md +141 -0
  324. package/docs/platforms/mac/bundled-gateway.md +79 -0
  325. package/docs/platforms/mac/canvas.md +128 -0
  326. package/docs/platforms/mac/child-process.md +72 -0
  327. package/docs/platforms/mac/dev-setup.md +112 -0
  328. package/docs/platforms/mac/health.md +39 -0
  329. package/docs/platforms/mac/icon.md +36 -0
  330. package/docs/platforms/mac/logging.md +62 -0
  331. package/docs/platforms/mac/menu-bar.md +93 -0
  332. package/docs/platforms/mac/peekaboo.md +96 -0
  333. package/docs/platforms/mac/permissions.md +73 -0
  334. package/docs/platforms/mac/remote.md +123 -0
  335. package/docs/platforms/mac/signing.md +52 -0
  336. package/docs/platforms/mac/skills.md +45 -0
  337. package/docs/platforms/mac/voice-overlay.md +66 -0
  338. package/docs/platforms/mac/voicewake.md +79 -0
  339. package/docs/platforms/mac/webchat.md +54 -0
  340. package/docs/platforms/mac/xpc.md +66 -0
  341. package/docs/platforms/macos.md +228 -0
  342. package/docs/platforms/oracle.md +12 -0
  343. package/docs/platforms/raspberry-pi.md +13 -0
  344. package/docs/platforms/windows.md +304 -0
  345. package/docs/plugins/adding-capabilities.md +146 -0
  346. package/docs/plugins/admin-http-rpc.md +216 -0
  347. package/docs/plugins/agent-tools.md +13 -0
  348. package/docs/plugins/architecture-internals.md +1203 -0
  349. package/docs/plugins/architecture.md +483 -0
  350. package/docs/plugins/building-extensions.md +13 -0
  351. package/docs/plugins/building-plugins.md +343 -0
  352. package/docs/plugins/bundles.md +310 -0
  353. package/docs/plugins/cli-backend-plugins.md +328 -0
  354. package/docs/plugins/codex-computer-use.md +297 -0
  355. package/docs/plugins/codex-harness-reference.md +480 -0
  356. package/docs/plugins/codex-harness-runtime.md +268 -0
  357. package/docs/plugins/codex-harness.md +800 -0
  358. package/docs/plugins/codex-native-plugins.md +280 -0
  359. package/docs/plugins/community.md +77 -0
  360. package/docs/plugins/compatibility.md +198 -0
  361. package/docs/plugins/copilot.md +355 -0
  362. package/docs/plugins/dependency-resolution.md +176 -0
  363. package/docs/plugins/google-meet.md +1737 -0
  364. package/docs/plugins/hooks.md +525 -0
  365. package/docs/plugins/install-overrides.md +80 -0
  366. package/docs/plugins/llama-cpp.md +58 -0
  367. package/docs/plugins/manage-plugins.md +214 -0
  368. package/docs/plugins/manifest.md +1468 -0
  369. package/docs/plugins/memory-lancedb.md +385 -0
  370. package/docs/plugins/memory-wiki.md +529 -0
  371. package/docs/plugins/message-presentation.md +487 -0
  372. package/docs/plugins/oc-path.md +166 -0
  373. package/docs/plugins/plugin-inventory.md +318 -0
  374. package/docs/plugins/plugin-permission-requests.md +193 -0
  375. package/docs/plugins/reference/acpx.md +23 -0
  376. package/docs/plugins/reference/admin-http-rpc.md +23 -0
  377. package/docs/plugins/reference/alibaba.md +23 -0
  378. package/docs/plugins/reference/amazon-bedrock-mantle.md +23 -0
  379. package/docs/plugins/reference/amazon-bedrock.md +23 -0
  380. package/docs/plugins/reference/anthropic-vertex.md +29 -0
  381. package/docs/plugins/reference/anthropic.md +23 -0
  382. package/docs/plugins/reference/arcee.md +23 -0
  383. package/docs/plugins/reference/azure-speech.md +23 -0
  384. package/docs/plugins/reference/bonjour.md +19 -0
  385. package/docs/plugins/reference/brave.md +23 -0
  386. package/docs/plugins/reference/browser.md +23 -0
  387. package/docs/plugins/reference/byteplus.md +19 -0
  388. package/docs/plugins/reference/canvas.md +19 -0
  389. package/docs/plugins/reference/cerebras.md +23 -0
  390. package/docs/plugins/reference/chutes.md +23 -0
  391. package/docs/plugins/reference/clickclack.md +23 -0
  392. package/docs/plugins/reference/cloudflare-ai-gateway.md +23 -0
  393. package/docs/plugins/reference/codex-supervisor.md +27 -0
  394. package/docs/plugins/reference/codex.md +23 -0
  395. package/docs/plugins/reference/comfy.md +23 -0
  396. package/docs/plugins/reference/copilot-proxy.md +19 -0
  397. package/docs/plugins/reference/copilot.md +23 -0
  398. package/docs/plugins/reference/deepgram.md +23 -0
  399. package/docs/plugins/reference/deepinfra.md +23 -0
  400. package/docs/plugins/reference/deepseek.md +23 -0
  401. package/docs/plugins/reference/diagnostics-otel.md +19 -0
  402. package/docs/plugins/reference/diagnostics-prometheus.md +19 -0
  403. package/docs/plugins/reference/diffs-language-pack.md +31 -0
  404. package/docs/plugins/reference/diffs.md +19 -0
  405. package/docs/plugins/reference/discord.md +23 -0
  406. package/docs/plugins/reference/document-extract.md +23 -0
  407. package/docs/plugins/reference/duckduckgo.md +23 -0
  408. package/docs/plugins/reference/elevenlabs.md +23 -0
  409. package/docs/plugins/reference/exa.md +23 -0
  410. package/docs/plugins/reference/fal.md +23 -0
  411. package/docs/plugins/reference/feishu.md +23 -0
  412. package/docs/plugins/reference/file-transfer.md +19 -0
  413. package/docs/plugins/reference/firecrawl.md +23 -0
  414. package/docs/plugins/reference/fireworks.md +23 -0
  415. package/docs/plugins/reference/github-copilot.md +23 -0
  416. package/docs/plugins/reference/gmi.md +23 -0
  417. package/docs/plugins/reference/google-meet.md +23 -0
  418. package/docs/plugins/reference/google.md +23 -0
  419. package/docs/plugins/reference/googlechat.md +23 -0
  420. package/docs/plugins/reference/gradium.md +23 -0
  421. package/docs/plugins/reference/groq.md +23 -0
  422. package/docs/plugins/reference/huggingface.md +23 -0
  423. package/docs/plugins/reference/imessage.md +23 -0
  424. package/docs/plugins/reference/inworld.md +23 -0
  425. package/docs/plugins/reference/irc.md +23 -0
  426. package/docs/plugins/reference/kilocode.md +23 -0
  427. package/docs/plugins/reference/kimi.md +23 -0
  428. package/docs/plugins/reference/line.md +23 -0
  429. package/docs/plugins/reference/litellm.md +23 -0
  430. package/docs/plugins/reference/llama-cpp.md +23 -0
  431. package/docs/plugins/reference/llm-task.md +19 -0
  432. package/docs/plugins/reference/lmstudio.md +23 -0
  433. package/docs/plugins/reference/lobster.md +19 -0
  434. package/docs/plugins/reference/matrix.md +23 -0
  435. package/docs/plugins/reference/mattermost.md +23 -0
  436. package/docs/plugins/reference/memory-core.md +19 -0
  437. package/docs/plugins/reference/memory-lancedb.md +23 -0
  438. package/docs/plugins/reference/memory-wiki.md +23 -0
  439. package/docs/plugins/reference/microsoft-foundry.md +113 -0
  440. package/docs/plugins/reference/microsoft.md +19 -0
  441. package/docs/plugins/reference/migrate-claude.md +19 -0
  442. package/docs/plugins/reference/migrate-hermes.md +19 -0
  443. package/docs/plugins/reference/minimax.md +23 -0
  444. package/docs/plugins/reference/mistral.md +23 -0
  445. package/docs/plugins/reference/moonshot.md +23 -0
  446. package/docs/plugins/reference/msteams.md +23 -0
  447. package/docs/plugins/reference/nextcloud-talk.md +23 -0
  448. package/docs/plugins/reference/nostr.md +23 -0
  449. package/docs/plugins/reference/novita.md +23 -0
  450. package/docs/plugins/reference/nvidia.md +23 -0
  451. package/docs/plugins/reference/oc-path.md +23 -0
  452. package/docs/plugins/reference/ollama.md +24 -0
  453. package/docs/plugins/reference/open-prose.md +19 -0
  454. package/docs/plugins/reference/openai.md +23 -0
  455. package/docs/plugins/reference/opencode-go.md +23 -0
  456. package/docs/plugins/reference/opencode.md +23 -0
  457. package/docs/plugins/reference/openrouter.md +23 -0
  458. package/docs/plugins/reference/openshell.md +19 -0
  459. package/docs/plugins/reference/perplexity.md +23 -0
  460. package/docs/plugins/reference/pixverse.md +23 -0
  461. package/docs/plugins/reference/policy.md +79 -0
  462. package/docs/plugins/reference/qa-channel.md +23 -0
  463. package/docs/plugins/reference/qa-lab.md +19 -0
  464. package/docs/plugins/reference/qa-matrix.md +19 -0
  465. package/docs/plugins/reference/qianfan.md +23 -0
  466. package/docs/plugins/reference/qqbot.md +23 -0
  467. package/docs/plugins/reference/qwen.md +24 -0
  468. package/docs/plugins/reference/runway.md +23 -0
  469. package/docs/plugins/reference/searxng.md +19 -0
  470. package/docs/plugins/reference/senseaudio.md +23 -0
  471. package/docs/plugins/reference/sglang.md +23 -0
  472. package/docs/plugins/reference/signal.md +23 -0
  473. package/docs/plugins/reference/slack.md +23 -0
  474. package/docs/plugins/reference/sms.md +23 -0
  475. package/docs/plugins/reference/stepfun.md +23 -0
  476. package/docs/plugins/reference/synology-chat.md +23 -0
  477. package/docs/plugins/reference/synthetic.md +23 -0
  478. package/docs/plugins/reference/tavily.md +23 -0
  479. package/docs/plugins/reference/telegram.md +23 -0
  480. package/docs/plugins/reference/tencent.md +23 -0
  481. package/docs/plugins/reference/tlon.md +23 -0
  482. package/docs/plugins/reference/together.md +23 -0
  483. package/docs/plugins/reference/tokenjuice.md +23 -0
  484. package/docs/plugins/reference/tts-local-cli.md +19 -0
  485. package/docs/plugins/reference/twitch.md +23 -0
  486. package/docs/plugins/reference/venice.md +23 -0
  487. package/docs/plugins/reference/vercel-ai-gateway.md +23 -0
  488. package/docs/plugins/reference/vllm.md +23 -0
  489. package/docs/plugins/reference/voice-call.md +23 -0
  490. package/docs/plugins/reference/volcengine.md +23 -0
  491. package/docs/plugins/reference/voyage.md +19 -0
  492. package/docs/plugins/reference/vydra.md +23 -0
  493. package/docs/plugins/reference/web-readability.md +19 -0
  494. package/docs/plugins/reference/webhooks.md +23 -0
  495. package/docs/plugins/reference/whatsapp.md +23 -0
  496. package/docs/plugins/reference/workboard.md +23 -0
  497. package/docs/plugins/reference/xai.md +23 -0
  498. package/docs/plugins/reference/xiaomi.md +23 -0
  499. package/docs/plugins/reference/zai.md +23 -0
  500. package/docs/plugins/reference/zalo.md +23 -0
  501. package/docs/plugins/reference/zalouser.md +24 -0
  502. package/docs/plugins/reference.md +19 -0
  503. package/docs/plugins/sdk-agent-harness.md +339 -0
  504. package/docs/plugins/sdk-channel-inbound.md +70 -0
  505. package/docs/plugins/sdk-channel-ingress.md +137 -0
  506. package/docs/plugins/sdk-channel-message.md +18 -0
  507. package/docs/plugins/sdk-channel-outbound.md +113 -0
  508. package/docs/plugins/sdk-channel-plugins.md +770 -0
  509. package/docs/plugins/sdk-channel-turn.md +9 -0
  510. package/docs/plugins/sdk-entrypoints.md +344 -0
  511. package/docs/plugins/sdk-migration.md +1011 -0
  512. package/docs/plugins/sdk-overview.md +525 -0
  513. package/docs/plugins/sdk-provider-plugins.md +1019 -0
  514. package/docs/plugins/sdk-runtime.md +683 -0
  515. package/docs/plugins/sdk-setup.md +550 -0
  516. package/docs/plugins/sdk-subpaths.md +401 -0
  517. package/docs/plugins/sdk-testing.md +403 -0
  518. package/docs/plugins/tool-plugins.md +411 -0
  519. package/docs/plugins/voice-call.md +942 -0
  520. package/docs/plugins/webhooks.md +192 -0
  521. package/docs/plugins/workboard.md +402 -0
  522. package/docs/plugins/zalouser.md +86 -0
  523. package/docs/prose.md +191 -0
  524. package/docs/providers/alibaba.md +158 -0
  525. package/docs/providers/anthropic.md +386 -0
  526. package/docs/providers/arcee.md +144 -0
  527. package/docs/providers/azure-speech.md +119 -0
  528. package/docs/providers/bedrock-mantle.md +224 -0
  529. package/docs/providers/bedrock.md +433 -0
  530. package/docs/providers/cerebras.md +130 -0
  531. package/docs/providers/chutes.md +153 -0
  532. package/docs/providers/claude-max-api-proxy.md +191 -0
  533. package/docs/providers/cloudflare-ai-gateway.md +119 -0
  534. package/docs/providers/comfy.md +362 -0
  535. package/docs/providers/deepgram.md +184 -0
  536. package/docs/providers/deepinfra.md +92 -0
  537. package/docs/providers/deepseek.md +146 -0
  538. package/docs/providers/ds4.md +309 -0
  539. package/docs/providers/elevenlabs.md +130 -0
  540. package/docs/providers/fal.md +240 -0
  541. package/docs/providers/fireworks.md +144 -0
  542. package/docs/providers/github-copilot.md +257 -0
  543. package/docs/providers/gmi.md +92 -0
  544. package/docs/providers/google.md +472 -0
  545. package/docs/providers/gradium.md +123 -0
  546. package/docs/providers/groq.md +171 -0
  547. package/docs/providers/huggingface.md +235 -0
  548. package/docs/providers/index.md +105 -0
  549. package/docs/providers/inferrs.md +272 -0
  550. package/docs/providers/inworld.md +120 -0
  551. package/docs/providers/kilocode.md +135 -0
  552. package/docs/providers/litellm.md +234 -0
  553. package/docs/providers/lmstudio.md +224 -0
  554. package/docs/providers/minimax.md +518 -0
  555. package/docs/providers/mistral.md +235 -0
  556. package/docs/providers/models.md +64 -0
  557. package/docs/providers/moonshot.md +413 -0
  558. package/docs/providers/novita.md +92 -0
  559. package/docs/providers/nvidia.md +208 -0
  560. package/docs/providers/ollama-cloud.md +115 -0
  561. package/docs/providers/ollama.md +1225 -0
  562. package/docs/providers/openai.md +1091 -0
  563. package/docs/providers/opencode-go.md +123 -0
  564. package/docs/providers/opencode.md +149 -0
  565. package/docs/providers/openrouter.md +390 -0
  566. package/docs/providers/perplexity-provider.md +123 -0
  567. package/docs/providers/pixverse.md +165 -0
  568. package/docs/providers/qianfan.md +132 -0
  569. package/docs/providers/qwen-oauth.md +115 -0
  570. package/docs/providers/qwen.md +364 -0
  571. package/docs/providers/runway.md +103 -0
  572. package/docs/providers/senseaudio.md +68 -0
  573. package/docs/providers/sglang.md +161 -0
  574. package/docs/providers/stepfun.md +229 -0
  575. package/docs/providers/synthetic.md +154 -0
  576. package/docs/providers/tencent.md +130 -0
  577. package/docs/providers/together.md +140 -0
  578. package/docs/providers/venice.md +312 -0
  579. package/docs/providers/vercel-ai-gateway.md +128 -0
  580. package/docs/providers/vllm.md +407 -0
  581. package/docs/providers/volcengine.md +199 -0
  582. package/docs/providers/vydra.md +180 -0
  583. package/docs/providers/xai.md +571 -0
  584. package/docs/providers/xiaomi.md +286 -0
  585. package/docs/providers/zai.md +224 -0
  586. package/docs/refactor/access.md +9 -0
  587. package/docs/refactor/acp.md +298 -0
  588. package/docs/refactor/canvas.md +131 -0
  589. package/docs/refactor/database-first.md +2263 -0
  590. package/docs/refactor/ingress-core.md +341 -0
  591. package/docs/reference/AGENTS.default.md +131 -0
  592. package/docs/reference/RELEASING.md +844 -0
  593. package/docs/reference/api-usage-costs.md +208 -0
  594. package/docs/reference/application-modernization-plan.md +208 -0
  595. package/docs/reference/code-mode.md +1058 -0
  596. package/docs/reference/credits.md +33 -0
  597. package/docs/reference/device-models.md +50 -0
  598. package/docs/reference/full-release-validation.md +206 -0
  599. package/docs/reference/memory-config.md +630 -0
  600. package/docs/reference/prompt-caching.md +358 -0
  601. package/docs/reference/release-performance-sweep.md +347 -0
  602. package/docs/reference/rich-output-protocol.md +93 -0
  603. package/docs/reference/rpc.md +43 -0
  604. package/docs/reference/secret-placeholder-conventions.md +33 -0
  605. package/docs/reference/secretref-credential-surface.md +163 -0
  606. package/docs/reference/secretref-user-supplied-credentials-matrix.json +691 -0
  607. package/docs/reference/session-management-compaction.md +474 -0
  608. package/docs/reference/templates/AGENTS.dev.md +90 -0
  609. package/docs/reference/templates/AGENTS.md +227 -0
  610. package/docs/reference/templates/BOOT.md +16 -0
  611. package/docs/reference/templates/BOOTSTRAP.md +66 -0
  612. package/docs/reference/templates/HEARTBEAT.md +24 -0
  613. package/docs/reference/templates/IDENTITY.dev.md +52 -0
  614. package/docs/reference/templates/IDENTITY.md +34 -0
  615. package/docs/reference/templates/SOUL.dev.md +82 -0
  616. package/docs/reference/templates/SOUL.md +49 -0
  617. package/docs/reference/templates/TOOLS.dev.md +29 -0
  618. package/docs/reference/templates/TOOLS.md +51 -0
  619. package/docs/reference/templates/USER.dev.md +23 -0
  620. package/docs/reference/templates/USER.md +28 -0
  621. package/docs/reference/test.md +248 -0
  622. package/docs/reference/token-use.md +246 -0
  623. package/docs/reference/transcript-hygiene.md +226 -0
  624. package/docs/reference/wizard.md +252 -0
  625. package/docs/security/CONTRIBUTING-THREAT-MODEL.md +101 -0
  626. package/docs/security/THREAT-MODEL-ATLAS.md +611 -0
  627. package/docs/security/formal-verification.md +170 -0
  628. package/docs/security/incident-response.md +59 -0
  629. package/docs/security/network-proxy.md +268 -0
  630. package/docs/snippets/plugin-publish/minimal-openclaw.plugin.json +12 -0
  631. package/docs/snippets/plugin-publish/minimal-package.json +16 -0
  632. package/docs/specs/claw-supervisor.md +247 -0
  633. package/docs/start/bootstrapping.md +49 -0
  634. package/docs/start/docs-directory.md +69 -0
  635. package/docs/start/getting-started.md +152 -0
  636. package/docs/start/hubs.md +201 -0
  637. package/docs/start/lore.md +223 -0
  638. package/docs/start/onboarding-overview.md +72 -0
  639. package/docs/start/onboarding.md +98 -0
  640. package/docs/start/openclaw.md +246 -0
  641. package/docs/start/quickstart.md +25 -0
  642. package/docs/start/setup.md +178 -0
  643. package/docs/start/showcase.md +371 -0
  644. package/docs/start/wizard-cli-automation.md +232 -0
  645. package/docs/start/wizard-cli-reference.md +331 -0
  646. package/docs/start/wizard.md +142 -0
  647. package/docs/style.css +137 -0
  648. package/docs/tools/acp-agents-setup.md +356 -0
  649. package/docs/tools/acp-agents.md +865 -0
  650. package/docs/tools/agent-send.md +130 -0
  651. package/docs/tools/apply-patch.md +64 -0
  652. package/docs/tools/brave-search.md +139 -0
  653. package/docs/tools/browser-control.md +405 -0
  654. package/docs/tools/browser-linux-troubleshooting.md +173 -0
  655. package/docs/tools/browser-login.md +77 -0
  656. package/docs/tools/browser-wsl2-windows-remote-cdp-troubleshooting.md +219 -0
  657. package/docs/tools/browser.md +866 -0
  658. package/docs/tools/btw.md +159 -0
  659. package/docs/tools/capability-cookbook.md +12 -0
  660. package/docs/tools/clawhub.md +5 -0
  661. package/docs/tools/code-execution.md +173 -0
  662. package/docs/tools/creating-skills.md +271 -0
  663. package/docs/tools/diffs.md +527 -0
  664. package/docs/tools/duckduckgo-search.md +109 -0
  665. package/docs/tools/elevated.md +128 -0
  666. package/docs/tools/exa-search.md +152 -0
  667. package/docs/tools/exec-approvals-advanced.md +457 -0
  668. package/docs/tools/exec-approvals.md +520 -0
  669. package/docs/tools/exec.md +294 -0
  670. package/docs/tools/firecrawl.md +155 -0
  671. package/docs/tools/gemini-search.md +114 -0
  672. package/docs/tools/goal.md +217 -0
  673. package/docs/tools/grok-search.md +129 -0
  674. package/docs/tools/image-generation.md +538 -0
  675. package/docs/tools/index.md +176 -0
  676. package/docs/tools/kimi-search.md +105 -0
  677. package/docs/tools/llm-task.md +137 -0
  678. package/docs/tools/lobster.md +365 -0
  679. package/docs/tools/loop-detection.md +154 -0
  680. package/docs/tools/media-overview.md +161 -0
  681. package/docs/tools/minimax-search.md +102 -0
  682. package/docs/tools/multi-agent-sandbox-tools.md +409 -0
  683. package/docs/tools/music-generation.md +372 -0
  684. package/docs/tools/ollama-search.md +153 -0
  685. package/docs/tools/parallel-search.md +154 -0
  686. package/docs/tools/pdf.md +213 -0
  687. package/docs/tools/permission-modes.md +111 -0
  688. package/docs/tools/perplexity-search.md +220 -0
  689. package/docs/tools/plugin.md +378 -0
  690. package/docs/tools/reactions.md +100 -0
  691. package/docs/tools/searxng-search.md +141 -0
  692. package/docs/tools/skill-workshop.md +283 -0
  693. package/docs/tools/skills-config.md +457 -0
  694. package/docs/tools/skills.md +591 -0
  695. package/docs/tools/slash-commands.md +518 -0
  696. package/docs/tools/steer.md +77 -0
  697. package/docs/tools/subagents.md +652 -0
  698. package/docs/tools/tavily.md +162 -0
  699. package/docs/tools/thinking.md +142 -0
  700. package/docs/tools/tokenjuice.md +84 -0
  701. package/docs/tools/tool-search.md +269 -0
  702. package/docs/tools/trajectory.md +229 -0
  703. package/docs/tools/tts.md +1013 -0
  704. package/docs/tools/video-generation.md +555 -0
  705. package/docs/tools/web-fetch.md +210 -0
  706. package/docs/tools/web.md +476 -0
  707. package/docs/tts.md +11 -0
  708. package/docs/vps.md +139 -0
  709. package/docs/web/control-ui.md +530 -0
  710. package/docs/web/dashboard.md +107 -0
  711. package/docs/web/index.md +133 -0
  712. package/docs/web/tui.md +258 -0
  713. package/docs/web/webchat.md +102 -0
  714. package/npm-shrinkwrap.json +3485 -0
  715. package/openclaw.mjs +661 -0
  716. package/package.json +1971 -0
  717. package/patches/.gitkeep +0 -0
  718. package/patches/@agentclientprotocol__claude-agent-acp@0.39.0.patch +40 -0
  719. package/pnpm-workspace.yaml +124 -0
  720. package/scripts/crabbox-wrapper.mjs +2470 -0
  721. package/scripts/lib/official-external-channel-catalog.json +570 -0
  722. package/scripts/lib/official-external-plugin-catalog.json +284 -0
  723. package/scripts/lib/official-external-provider-catalog.json +158 -0
  724. package/scripts/lib/package-dist-imports.mjs +174 -0
  725. package/scripts/npm-runner.mjs +95 -0
  726. package/scripts/postinstall-bundled-plugins.mjs +978 -0
  727. package/scripts/preinstall-package-manager-warning.mjs +74 -0
  728. package/scripts/prepare-git-hooks.mjs +73 -0
  729. package/scripts/windows-cmd-helpers.mjs +29 -0
  730. package/skills/1password/SKILL.md +70 -0
  731. package/skills/1password/references/cli-examples.md +29 -0
  732. package/skills/1password/references/get-started.md +17 -0
  733. package/skills/apple-notes/SKILL.md +77 -0
  734. package/skills/apple-reminders/SKILL.md +118 -0
  735. package/skills/bear-notes/SKILL.md +107 -0
  736. package/skills/blogwatcher/SKILL.md +69 -0
  737. package/skills/blucli/SKILL.md +47 -0
  738. package/skills/camsnap/SKILL.md +45 -0
  739. package/skills/canvas/SKILL.md +78 -0
  740. package/skills/clawhub/SKILL.md +77 -0
  741. package/skills/coding-agent/SKILL.md +143 -0
  742. package/skills/diagram-maker/SKILL.md +53 -0
  743. package/skills/diagram-maker/references/excalidraw-patterns.md +85 -0
  744. package/skills/diagram-maker/references/svg-template.md +112 -0
  745. package/skills/discord/SKILL.md +136 -0
  746. package/skills/eightctl/SKILL.md +50 -0
  747. package/skills/gemini/SKILL.md +47 -0
  748. package/skills/gh-issues/SKILL.md +213 -0
  749. package/skills/gifgrep/SKILL.md +85 -0
  750. package/skills/github/SKILL.md +84 -0
  751. package/skills/gog/SKILL.md +116 -0
  752. package/skills/goplaces/SKILL.md +52 -0
  753. package/skills/healthcheck/SKILL.md +105 -0
  754. package/skills/himalaya/SKILL.md +80 -0
  755. package/skills/himalaya/references/configuration.md +184 -0
  756. package/skills/himalaya/references/message-composition.md +199 -0
  757. package/skills/imsg/SKILL.md +122 -0
  758. package/skills/mcporter/SKILL.md +61 -0
  759. package/skills/meme-maker/SKILL.md +42 -0
  760. package/skills/meme-maker/references/templates.json +358 -0
  761. package/skills/meme-maker/scripts/meme.mjs +398 -0
  762. package/skills/model-usage/SKILL.md +71 -0
  763. package/skills/model-usage/references/codexbar-cli.md +33 -0
  764. package/skills/model-usage/scripts/model_usage.py +319 -0
  765. package/skills/model-usage/scripts/test_model_usage.py +40 -0
  766. package/skills/nano-pdf/SKILL.md +38 -0
  767. package/skills/node-connect/SKILL.md +143 -0
  768. package/skills/node-inspect-debugger/SKILL.md +85 -0
  769. package/skills/notion/SKILL.md +150 -0
  770. package/skills/obsidian/SKILL.md +119 -0
  771. package/skills/openai-whisper/SKILL.md +38 -0
  772. package/skills/openai-whisper-api/SKILL.md +71 -0
  773. package/skills/openai-whisper-api/scripts/transcribe.sh +154 -0
  774. package/skills/openhue/SKILL.md +112 -0
  775. package/skills/oracle/SKILL.md +126 -0
  776. package/skills/ordercli/SKILL.md +78 -0
  777. package/skills/peekaboo/SKILL.md +198 -0
  778. package/skills/pyproject.toml +10 -0
  779. package/skills/python-debugpy/SKILL.md +73 -0
  780. package/skills/sag/SKILL.md +87 -0
  781. package/skills/session-logs/SKILL.md +151 -0
  782. package/skills/sherpa-onnx-tts/SKILL.md +109 -0
  783. package/skills/sherpa-onnx-tts/bin/sherpa-onnx-tts +178 -0
  784. package/skills/skill-creator/SKILL.md +78 -0
  785. package/skills/skill-creator/license.txt +202 -0
  786. package/skills/skill-creator/scripts/init_skill.py +378 -0
  787. package/skills/skill-creator/scripts/package_skill.py +144 -0
  788. package/skills/skill-creator/scripts/quick_validate.py +169 -0
  789. package/skills/skill-creator/scripts/test_package_skill.py +199 -0
  790. package/skills/skill-creator/scripts/test_quick_validate.py +116 -0
  791. package/skills/slack/SKILL.md +78 -0
  792. package/skills/songsee/SKILL.md +49 -0
  793. package/skills/sonoscli/SKILL.md +65 -0
  794. package/skills/spike/SKILL.md +51 -0
  795. package/skills/spotify-player/SKILL.md +64 -0
  796. package/skills/summarize/SKILL.md +87 -0
  797. package/skills/taskflow/SKILL.md +149 -0
  798. package/skills/taskflow/examples/inbox-triage.lobster +33 -0
  799. package/skills/taskflow/examples/pr-intake.lobster +32 -0
  800. package/skills/taskflow-inbox-triage/SKILL.md +119 -0
  801. package/skills/things-mac/SKILL.md +86 -0
  802. package/skills/tmux/SKILL.md +91 -0
  803. package/skills/tmux/scripts/find-sessions.sh +112 -0
  804. package/skills/tmux/scripts/wait-for-text.sh +83 -0
  805. package/skills/trello/SKILL.md +108 -0
  806. package/skills/video-frames/SKILL.md +46 -0
  807. package/skills/video-frames/scripts/frame.sh +81 -0
  808. package/skills/voice-call/SKILL.md +45 -0
  809. package/skills/wacli/SKILL.md +72 -0
  810. package/skills/weather/SKILL.md +87 -0
  811. package/skills/xurl/SKILL.md +120 -0
  812. package/src/agents/templates/HEARTBEAT.md +5 -0
@@ -0,0 +1,328 @@
1
+ ---
2
+ summary: "Build a plugin that registers a local AI CLI backend"
3
+ title: "Building CLI backend plugins"
4
+ sidebarTitle: "CLI backend plugins"
5
+ read_when:
6
+ - You are building a local AI CLI backend plugin
7
+ - You want to register a backend for model refs such as acme-cli/model
8
+ - You need to map a third-party CLI into OpenClaw's text fallback runner
9
+ ---
10
+
11
+ CLI backend plugins let OpenClaw call a local AI CLI as a text inference
12
+ backend. The backend appears as a provider prefix in model refs:
13
+
14
+ ```text
15
+ acme-cli/acme-large
16
+ ```
17
+
18
+ Use a CLI backend when the upstream integration is already exposed as a local
19
+ command, when the CLI owns local login state, or when the CLI is a useful
20
+ fallback if API providers are unavailable.
21
+
22
+ <Info>
23
+ If the upstream service exposes a normal HTTP model API, write a
24
+ [provider plugin](/plugins/sdk-provider-plugins) instead. If the upstream
25
+ runtime owns complete agent sessions, tool events, compaction, or background
26
+ task state, use an [agent harness](/plugins/sdk-agent-harness).
27
+ </Info>
28
+
29
+ ## What the plugin owns
30
+
31
+ A CLI backend plugin has three contracts:
32
+
33
+ | Contract | File | Purpose |
34
+ | -------------------- | ---------------------- | --------------------------------------------------------- |
35
+ | Package entry | `package.json` | Points OpenClaw at the plugin runtime module |
36
+ | Manifest ownership | `openclaw.plugin.json` | Declares the backend id before runtime loads |
37
+ | Runtime registration | `index.ts` | Calls `api.registerCliBackend(...)` with command defaults |
38
+
39
+ The manifest is discovery metadata. It does not execute the CLI and does not
40
+ register runtime behavior. Runtime behavior starts when the plugin entry calls
41
+ `api.registerCliBackend(...)`.
42
+
43
+ ## Minimal backend plugin
44
+
45
+ <Steps>
46
+ <Step title="Create package metadata">
47
+ ```json package.json
48
+ {
49
+ "name": "@acme/openclaw-acme-cli",
50
+ "version": "1.0.0",
51
+ "type": "module",
52
+ "openclaw": {
53
+ "extensions": ["./index.ts"],
54
+ "compat": {
55
+ "pluginApi": ">=2026.3.24-beta.2",
56
+ "minGatewayVersion": "2026.3.24-beta.2"
57
+ },
58
+ "build": {
59
+ "openclawVersion": "2026.3.24-beta.2",
60
+ "pluginSdkVersion": "2026.3.24-beta.2"
61
+ }
62
+ },
63
+ "dependencies": {
64
+ "openclaw": "^2026.3.24"
65
+ },
66
+ "devDependencies": {
67
+ "typescript": "^5.9.0"
68
+ }
69
+ }
70
+ ```
71
+
72
+ Published packages must ship built JavaScript runtime files. If your source
73
+ entry is `./src/index.ts`, add `openclaw.runtimeExtensions` that points at
74
+ the built JavaScript peer. See [Entry points](/plugins/sdk-entrypoints).
75
+
76
+ </Step>
77
+
78
+ <Step title="Declare backend ownership">
79
+ ```json openclaw.plugin.json
80
+ {
81
+ "id": "acme-cli",
82
+ "name": "Acme CLI",
83
+ "description": "Run Acme's local AI CLI through OpenClaw",
84
+ "cliBackends": ["acme-cli"],
85
+ "setup": {
86
+ "cliBackends": ["acme-cli"],
87
+ "requiresRuntime": false
88
+ },
89
+ "activation": {
90
+ "onStartup": false
91
+ },
92
+ "configSchema": {
93
+ "type": "object",
94
+ "additionalProperties": false
95
+ }
96
+ }
97
+ ```
98
+
99
+ `cliBackends` is the runtime ownership list. It lets OpenClaw auto-load the
100
+ plugin when config or model selection mentions `acme-cli/...`.
101
+
102
+ `setup.cliBackends` is the descriptor-first setup surface. Add it when
103
+ model discovery, onboarding, or status should recognize the backend without
104
+ loading plugin runtime. Use `requiresRuntime: false` only when those static
105
+ descriptors are enough for setup.
106
+
107
+ </Step>
108
+
109
+ <Step title="Register the backend">
110
+ ```typescript index.ts
111
+ import { definePluginEntry } from "openclaw/plugin-sdk/plugin-entry";
112
+ import {
113
+ CLI_FRESH_WATCHDOG_DEFAULTS,
114
+ CLI_RESUME_WATCHDOG_DEFAULTS,
115
+ type CliBackendPlugin,
116
+ } from "openclaw/plugin-sdk/cli-backend";
117
+
118
+ function buildAcmeCliBackend(): CliBackendPlugin {
119
+ return {
120
+ id: "acme-cli",
121
+ liveTest: {
122
+ defaultModelRef: "acme-cli/acme-large",
123
+ defaultImageProbe: false,
124
+ defaultMcpProbe: false,
125
+ docker: {
126
+ npmPackage: "@acme/acme-cli",
127
+ binaryName: "acme",
128
+ },
129
+ },
130
+ config: {
131
+ command: "acme",
132
+ args: ["chat", "--json"],
133
+ output: "json",
134
+ input: "stdin",
135
+ modelArg: "--model",
136
+ sessionArg: "--session",
137
+ sessionMode: "existing",
138
+ sessionIdFields: ["session_id", "conversation_id"],
139
+ systemPromptFileArg: "--system-file",
140
+ systemPromptWhen: "first",
141
+ imageArg: "--image",
142
+ imageMode: "repeat",
143
+ reliability: {
144
+ watchdog: {
145
+ fresh: { ...CLI_FRESH_WATCHDOG_DEFAULTS },
146
+ resume: { ...CLI_RESUME_WATCHDOG_DEFAULTS },
147
+ },
148
+ },
149
+ serialize: true,
150
+ },
151
+ };
152
+ }
153
+
154
+ export default definePluginEntry({
155
+ id: "acme-cli",
156
+ name: "Acme CLI",
157
+ description: "Run Acme's local AI CLI through OpenClaw",
158
+ register(api) {
159
+ api.registerCliBackend(buildAcmeCliBackend());
160
+ },
161
+ });
162
+ ```
163
+
164
+ The backend id must match the manifest `cliBackends` entry. The registered
165
+ `config` is only the default; user config under
166
+ `agents.defaults.cliBackends.acme-cli` is merged over it at runtime.
167
+
168
+ </Step>
169
+ </Steps>
170
+
171
+ ## Config shape
172
+
173
+ `CliBackendConfig` describes how OpenClaw should launch and parse the CLI:
174
+
175
+ | Field | Use |
176
+ | ----------------------------------------- | ----------------------------------------------------------- |
177
+ | `command` | Binary name or absolute command path |
178
+ | `args` | Base argv for fresh runs |
179
+ | `resumeArgs` | Alternate argv for resumed sessions; supports `{sessionId}` |
180
+ | `output` / `resumeOutput` | Parser: `json`, `jsonl`, or `text` |
181
+ | `input` | Prompt transport: `arg` or `stdin` |
182
+ | `modelArg` | Flag used before the model id |
183
+ | `modelAliases` | Map OpenClaw model ids to CLI-native ids |
184
+ | `sessionArg` / `sessionArgs` | How to pass a session id |
185
+ | `sessionMode` | `always`, `existing`, or `none` |
186
+ | `sessionIdFields` | JSON fields OpenClaw reads from CLI output |
187
+ | `systemPromptArg` / `systemPromptFileArg` | System prompt transport |
188
+ | `systemPromptWhen` | `first`, `always`, or `never` |
189
+ | `imageArg` / `imageMode` | Image path support |
190
+ | `serialize` | Keep same-backend runs ordered |
191
+ | `reliability.watchdog` | No-output timeout tuning |
192
+
193
+ Prefer the smallest static config that matches the CLI. Add plugin callbacks
194
+ only for behavior that really belongs to the backend.
195
+
196
+ ## Advanced backend hooks
197
+
198
+ `CliBackendPlugin` can also define:
199
+
200
+ | Hook | Use |
201
+ | ---------------------------------- | ------------------------------------------------------ |
202
+ | `normalizeConfig(config, context)` | Rewrite legacy user config after merge |
203
+ | `resolveExecutionArgs(ctx)` | Add request-scoped flags such as thinking effort |
204
+ | `prepareExecution(ctx)` | Create temporary auth or config bridges before launch |
205
+ | `transformSystemPrompt(ctx)` | Apply a final CLI-specific system prompt transform |
206
+ | `textTransforms` | Bidirectional prompt/output replacements |
207
+ | `defaultAuthProfileId` | Prefer a specific OpenClaw auth profile |
208
+ | `authEpochMode` | Decide how auth changes invalidate stored CLI sessions |
209
+ | `nativeToolMode` | Declare whether the CLI has always-on native tools |
210
+ | `bundleMcp` / `bundleMcpMode` | Opt into OpenClaw's loopback MCP tool bridge |
211
+ | `ownsNativeCompaction` | Backend owns its own compaction - OpenClaw defers |
212
+
213
+ Keep these hooks provider-owned. Do not add CLI-specific branches to core when a
214
+ backend hook can express the behavior.
215
+
216
+ ### `ownsNativeCompaction`: opting out of OpenClaw compaction
217
+
218
+ If your backend runs an agent that compacts its **own** transcript, set
219
+ `ownsNativeCompaction: true` so OpenClaw's safeguard summarizer never runs against its
220
+ sessions - the CLI compaction lifecycle returns a no-op and the turn proceeds. `claude-cli`
221
+ declares it because Claude Code compacts internally with no harness endpoint. Native-harness
222
+ sessions such as Codex keep routing to their harness compaction endpoint instead.
223
+
224
+ **Only declare it when all of the following hold**, or a deferred over-budget session can
225
+ stay over budget / go stale (OpenClaw no longer rescues it):
226
+
227
+ - the backend reliably compacts or bounds its own transcript as it nears its window;
228
+ - it persists a resumable session so the compacted state survives turns
229
+ (e.g. `--resume` / `--session-id`);
230
+ - it is not a native-harness compaction session - matching `agentHarnessId` sessions
231
+ route to the harness endpoint instead.
232
+
233
+ ## MCP tool bridge
234
+
235
+ CLI backends do not receive OpenClaw tools by default. If the CLI can consume an
236
+ MCP configuration, opt in explicitly:
237
+
238
+ ```typescript
239
+ return {
240
+ id: "acme-cli",
241
+ bundleMcp: true,
242
+ bundleMcpMode: "codex-config-overrides",
243
+ config: {
244
+ command: "acme",
245
+ args: ["chat", "--json"],
246
+ output: "json",
247
+ },
248
+ };
249
+ ```
250
+
251
+ Supported bridge modes are:
252
+
253
+ | Mode | Use |
254
+ | ------------------------ | ---------------------------------------------------------------- |
255
+ | `claude-config-file` | CLIs that accept an MCP config file |
256
+ | `codex-config-overrides` | CLIs that accept config overrides on argv |
257
+ | `gemini-system-settings` | CLIs that read MCP settings from their system settings directory |
258
+
259
+ Only enable the bridge when the CLI can actually consume it. If the CLI has its
260
+ own built-in tool layer that cannot be disabled, set `nativeToolMode:
261
+ "always-on"` so OpenClaw can fail closed when a caller requires no native tools.
262
+
263
+ ## User configuration
264
+
265
+ Users can override any backend default:
266
+
267
+ ```json5
268
+ {
269
+ agents: {
270
+ defaults: {
271
+ cliBackends: {
272
+ "acme-cli": {
273
+ command: "/opt/acme/bin/acme",
274
+ args: ["chat", "--json", "--profile", "work"],
275
+ modelAliases: {
276
+ large: "acme-large-2026",
277
+ },
278
+ },
279
+ },
280
+ model: {
281
+ primary: "openai/gpt-5.5",
282
+ fallbacks: ["acme-cli/large"],
283
+ },
284
+ },
285
+ },
286
+ }
287
+ ```
288
+
289
+ Document the minimum override users are likely to need. Usually that is only
290
+ `command` when the binary is outside `PATH`.
291
+
292
+ ## Verification
293
+
294
+ For bundled plugins, add a focused test around the builder and setup
295
+ registration, then run the plugin's targeted test lane:
296
+
297
+ ```bash
298
+ pnpm test extensions/acme-cli
299
+ ```
300
+
301
+ For local or installed plugins, verify discovery and one real model run:
302
+
303
+ ```bash
304
+ openclaw plugins inspect acme-cli --runtime --json
305
+ openclaw agent --message "reply exactly: backend ok" --model acme-cli/acme-large
306
+ ```
307
+
308
+ If the backend supports images or MCP, add a live smoke that proves those paths
309
+ with the real CLI. Do not rely on static inspection for prompt, image, MCP, or
310
+ session-resume behavior.
311
+
312
+ ## Checklist
313
+
314
+ <Check>`package.json` has `openclaw.extensions` and built runtime entries for published packages</Check>
315
+ <Check>`openclaw.plugin.json` declares `cliBackends` and intentional `activation.onStartup`</Check>
316
+ <Check>`setup.cliBackends` is present when setup/model discovery should see the backend cold</Check>
317
+ <Check>`api.registerCliBackend(...)` uses the same backend id as the manifest</Check>
318
+ <Check>User overrides under `agents.defaults.cliBackends.<id>` still win</Check>
319
+ <Check>Session, system prompt, image, and output parser settings match the real CLI contract</Check>
320
+ <Check>Targeted tests and at least one live CLI smoke prove the backend path</Check>
321
+
322
+ ## Related
323
+
324
+ - [CLI backends](/gateway/cli-backends) - user configuration and runtime behavior
325
+ - [Building plugins](/plugins/building-plugins) - package and manifest basics
326
+ - [Plugin SDK overview](/plugins/sdk-overview) - registration API reference
327
+ - [Plugin manifest](/plugins/manifest) - `cliBackends` and setup descriptors
328
+ - [Agent harness](/plugins/sdk-agent-harness) - full external agent runtimes
@@ -0,0 +1,297 @@
1
+ ---
2
+ summary: "Set up Codex Computer Use for Codex-mode OpenClaw agents"
3
+ title: "Codex Computer Use"
4
+ read_when:
5
+ - You want Codex-mode OpenClaw agents to use Codex Computer Use
6
+ - You are deciding between Codex Computer Use, PeekabooBridge, and direct cua-driver MCP
7
+ - You are deciding between Codex Computer Use and a direct cua-driver MCP setup
8
+ - You are configuring computerUse for the bundled Codex plugin
9
+ - You are troubleshooting /codex computer-use status or install
10
+ ---
11
+
12
+ Computer Use is a Codex-native MCP plugin for local desktop control. OpenClaw
13
+ does not vendor the desktop app, execute desktop actions itself, or bypass
14
+ Codex permissions. The bundled `codex` plugin only prepares Codex app-server:
15
+ it enables Codex plugin support, finds or installs the configured Codex
16
+ Computer Use plugin, checks that the `computer-use` MCP server is available, and
17
+ then lets Codex own the native MCP tool calls during Codex-mode turns.
18
+
19
+ Use this page when OpenClaw is already using the native Codex harness. For the
20
+ runtime setup itself, see [Codex harness](/plugins/codex-harness).
21
+
22
+ ## OpenClaw.app and Peekaboo
23
+
24
+ OpenClaw.app's Peekaboo integration is separate from Codex Computer Use. The
25
+ macOS app can host a PeekabooBridge socket so the `peekaboo` CLI can reuse the
26
+ app's local Accessibility and Screen Recording grants for Peekaboo's own
27
+ automation tools. That bridge does not install or proxy Codex Computer Use, and
28
+ Codex Computer Use does not call through the PeekabooBridge socket.
29
+
30
+ Use [Peekaboo bridge](/platforms/mac/peekaboo) when you want OpenClaw.app to be
31
+ a permission-aware host for Peekaboo CLI automation. Use this page when a
32
+ Codex-mode OpenClaw agent should have Codex's native `computer-use` MCP plugin
33
+ available before the turn starts.
34
+
35
+ ## iOS app
36
+
37
+ The iOS app is separate from Codex Computer Use. It does not install or proxy
38
+ the Codex `computer-use` MCP server and it is not a desktop-control backend.
39
+ Instead, the iOS app connects as an OpenClaw node and exposes mobile
40
+ capabilities through node commands such as `canvas.*`, `camera.*`, `screen.*`,
41
+ `location.*`, and `talk.*`.
42
+
43
+ Use [iOS](/platforms/ios) when you want an agent to drive an iPhone node through
44
+ the gateway. Use this page when a Codex-mode agent should control the local
45
+ macOS desktop through Codex's native Computer Use plugin.
46
+
47
+ ## Direct cua-driver MCP
48
+
49
+ Codex Computer Use is not the only way to expose desktop control. If you want
50
+ OpenClaw-managed runtimes to call TryCua's driver directly, use the upstream
51
+ `cua-driver mcp` server through OpenClaw's MCP registry instead of the
52
+ Codex-specific marketplace flow.
53
+
54
+ After installing `cua-driver`, either ask it for the OpenClaw command:
55
+
56
+ ```bash
57
+ cua-driver mcp-config --client openclaw
58
+ ```
59
+
60
+ or register the stdio server yourself:
61
+
62
+ ```bash
63
+ openclaw mcp set cua-driver '{"command":"cua-driver","args":["mcp"]}'
64
+ ```
65
+
66
+ That path keeps the upstream MCP tool surface intact, including the driver
67
+ schemas and structured MCP responses. Use it when you want the CUA driver
68
+ available as a normal OpenClaw MCP server. Use the Codex Computer Use setup on
69
+ this page when Codex app-server should own plugin installation, MCP reloads,
70
+ and native tool calls inside Codex-mode turns.
71
+
72
+ CUA's driver is macOS-specific and still requires the local macOS permissions
73
+ that its app prompts for, such as Accessibility and Screen Recording. OpenClaw
74
+ does not install `cua-driver`, grant those permissions, or bypass the upstream
75
+ driver's safety model.
76
+
77
+ ## Quick setup
78
+
79
+ Set `plugins.entries.codex.config.computerUse` when Codex-mode turns must have
80
+ Computer Use available before a thread starts. `autoInstall: true` opts
81
+ Computer Use in and lets OpenClaw install or re-enable it before the turn:
82
+
83
+ ```json5
84
+ {
85
+ plugins: {
86
+ entries: {
87
+ codex: {
88
+ enabled: true,
89
+ config: {
90
+ computerUse: {
91
+ autoInstall: true,
92
+ },
93
+ },
94
+ },
95
+ },
96
+ },
97
+ agents: {
98
+ defaults: {
99
+ model: "openai/gpt-5.5",
100
+ },
101
+ },
102
+ }
103
+ ```
104
+
105
+ With this config, OpenClaw checks Codex app-server before each Codex-mode turn.
106
+ If Computer Use is missing but Codex app-server has already discovered an
107
+ installable marketplace, OpenClaw asks Codex app-server to install or re-enable
108
+ the plugin and reload MCP servers. On macOS, when no matching marketplace is
109
+ registered and the standard Codex app bundle exists, OpenClaw also tries to
110
+ register the bundled Codex marketplace from
111
+ `/Applications/Codex.app/Contents/Resources/plugins/openai-bundled` before it
112
+ fails. If setup still cannot make the MCP server available, the turn fails
113
+ before the thread starts.
114
+
115
+ After changing Computer Use config, use `/new` or `/reset` in the affected chat
116
+ before testing if an existing Codex thread has already started.
117
+
118
+ ## Commands
119
+
120
+ Use the `/codex computer-use` commands from any chat surface where the `codex`
121
+ plugin command surface is available. These are OpenClaw chat/runtime commands,
122
+ not `openclaw codex ...` CLI subcommands:
123
+
124
+ ```text
125
+ /codex computer-use status
126
+ /codex computer-use install
127
+ /codex computer-use install --source <marketplace-source>
128
+ /codex computer-use install --marketplace-path <path>
129
+ /codex computer-use install --marketplace <name>
130
+ ```
131
+
132
+ `status` is read-only. It does not add marketplace sources, install plugins, or
133
+ enable Codex plugin support. If no config opts Computer Use in, `status` can
134
+ report disabled even after a one-off install command.
135
+
136
+ `install` enables Codex app-server plugin support, optionally adds a configured
137
+ marketplace source, installs or re-enables the configured plugin through Codex
138
+ app-server, reloads MCP servers, and verifies that the MCP server exposes tools.
139
+
140
+ ## Marketplace choices
141
+
142
+ OpenClaw uses the same app-server API that Codex itself exposes. The
143
+ marketplace fields choose where Codex should find `computer-use`.
144
+
145
+ | Field | Use when | Install support |
146
+ | -------------------- | --------------------------------------------------------------- | -------------------------------------------------------- |
147
+ | No marketplace field | You want Codex app-server to use marketplaces it already knows. | Yes, when app-server returns a local marketplace. |
148
+ | `marketplaceSource` | You have a Codex marketplace source app-server can add. | Yes, for explicit `/codex computer-use install`. |
149
+ | `marketplacePath` | You already know the local marketplace file path on the host. | Yes, for explicit install and turn-start auto-install. |
150
+ | `marketplaceName` | You want to select one already registered marketplace by name. | Yes only when the selected marketplace has a local path. |
151
+
152
+ Fresh Codex homes may need a short moment to seed their official marketplaces.
153
+ During install, OpenClaw polls `plugin/list` for up to
154
+ `marketplaceDiscoveryTimeoutMs` milliseconds. The default is 60 seconds.
155
+
156
+ If multiple known marketplaces contain Computer Use, OpenClaw prefers
157
+ `openai-bundled`, then `openai-curated`, then `local`. Unknown ambiguous matches
158
+ fail closed and ask you to set `marketplaceName` or `marketplacePath`.
159
+
160
+ ## Bundled macOS marketplace
161
+
162
+ Recent Codex desktop builds bundle Computer Use here:
163
+
164
+ ```text
165
+ /Applications/Codex.app/Contents/Resources/plugins/openai-bundled/plugins/computer-use
166
+ ```
167
+
168
+ When `computerUse.autoInstall` is true and no marketplace containing
169
+ `computer-use` is registered, OpenClaw tries to add the standard bundled
170
+ marketplace root automatically:
171
+
172
+ ```text
173
+ /Applications/Codex.app/Contents/Resources/plugins/openai-bundled
174
+ ```
175
+
176
+ You can also register it explicitly from a shell with Codex:
177
+
178
+ ```bash
179
+ codex plugin marketplace add /Applications/Codex.app/Contents/Resources/plugins/openai-bundled
180
+ ```
181
+
182
+ If you use a nonstandard Codex app path, run `/codex computer-use install
183
+ --source <marketplace-root>` once or set `computerUse.marketplacePath` to a
184
+ local marketplace file path. Use `--marketplace-path` only when you have the
185
+ marketplace JSON file path, not the bundled marketplace root.
186
+
187
+ ## Remote catalog limit
188
+
189
+ Codex app-server can list and read remote-only catalog entries, but it does not
190
+ currently support remote `plugin/install`. That means `marketplaceName` can
191
+ select a remote-only marketplace for status checks, but installs and re-enables
192
+ still need a local marketplace via `marketplaceSource` or `marketplacePath`.
193
+
194
+ If status says the plugin is available in a remote Codex marketplace but remote
195
+ install is unsupported, run install with a local source or path:
196
+
197
+ ```text
198
+ /codex computer-use install --source <marketplace-source>
199
+ /codex computer-use install --marketplace-path <path>
200
+ ```
201
+
202
+ ## Configuration reference
203
+
204
+ | Field | Default | Meaning |
205
+ | ------------------------------- | -------------- | ------------------------------------------------------------------------------ |
206
+ | `enabled` | inferred | Require Computer Use. Defaults to true when another Computer Use field is set. |
207
+ | `autoInstall` | false | Install or re-enable from already discovered marketplaces at turn start. |
208
+ | `marketplaceDiscoveryTimeoutMs` | 60000 | How long install waits for Codex app-server marketplace discovery. |
209
+ | `marketplaceSource` | unset | Source string passed to Codex app-server `marketplace/add`. |
210
+ | `marketplacePath` | unset | Local Codex marketplace file path containing the plugin. |
211
+ | `marketplaceName` | unset | Registered Codex marketplace name to select. |
212
+ | `pluginName` | `computer-use` | Codex marketplace plugin name. |
213
+ | `mcpServerName` | `computer-use` | MCP server name exposed by the installed plugin. |
214
+
215
+ Turn-start auto-install intentionally refuses configured `marketplaceSource`
216
+ values. Adding a new source is an explicit setup operation, so use
217
+ `/codex computer-use install --source <marketplace-source>` once, then let
218
+ `autoInstall` handle future re-enables from discovered local marketplaces.
219
+ Turn-start auto-install can use a configured `marketplacePath`, because that is
220
+ already a local path on the host.
221
+
222
+ ## What OpenClaw checks
223
+
224
+ OpenClaw reports a stable setup reason internally and formats the user-facing
225
+ status for chat:
226
+
227
+ | Reason | Meaning | Next step |
228
+ | ---------------------------- | ------------------------------------------------------ | --------------------------------------------- |
229
+ | `disabled` | `computerUse.enabled` resolved to false. | Set `enabled` or another Computer Use field. |
230
+ | `marketplace_missing` | No matching marketplace was available. | Configure source, path, or marketplace name. |
231
+ | `plugin_not_installed` | Marketplace exists, but the plugin is not installed. | Run install or enable `autoInstall`. |
232
+ | `plugin_disabled` | Plugin is installed but disabled in Codex config. | Run install to re-enable it. |
233
+ | `remote_install_unsupported` | Selected marketplace is remote-only. | Use `marketplaceSource` or `marketplacePath`. |
234
+ | `mcp_missing` | Plugin is enabled, but the MCP server is unavailable. | Check Codex Computer Use and OS permissions. |
235
+ | `ready` | Plugin and MCP tools are available. | Start the Codex-mode turn. |
236
+ | `check_failed` | A Codex app-server request failed during status check. | Check app-server connectivity and logs. |
237
+ | `auto_install_blocked` | Turn-start setup would need to add a new source. | Run explicit install first. |
238
+
239
+ The chat output includes the plugin state, MCP server state, marketplace, tools
240
+ when available, and the specific message for the failing setup step.
241
+
242
+ ## macOS permissions
243
+
244
+ Computer Use is macOS-specific. The Codex-owned MCP server may need local OS
245
+ permissions before it can inspect or control apps. If OpenClaw says Computer Use
246
+ is installed but the MCP server is unavailable, verify the Codex-side Computer
247
+ Use setup first:
248
+
249
+ - Codex app-server is running on the same host where desktop control should
250
+ happen.
251
+ - The Computer Use plugin is enabled in Codex config.
252
+ - The `computer-use` MCP server appears in Codex app-server MCP status.
253
+ - macOS has granted the required permissions for the desktop-control app.
254
+ - The current host session can access the desktop being controlled.
255
+
256
+ OpenClaw intentionally fails closed when `computerUse.enabled` is true. A
257
+ Codex-mode turn should not silently proceed without the native desktop tools
258
+ that the config required.
259
+
260
+ ## Troubleshooting
261
+
262
+ **Status says not installed.** Run `/codex computer-use install`. If the
263
+ marketplace is not discovered, pass `--source` or `--marketplace-path`.
264
+
265
+ **Status says installed but disabled.** Run `/codex computer-use install` again.
266
+ Codex app-server install writes the plugin config back to enabled.
267
+
268
+ **Status says remote install is unsupported.** Use a local marketplace source or
269
+ path. Remote-only catalog entries can be inspected but not installed through the
270
+ current app-server API.
271
+
272
+ **Status says the MCP server is unavailable.** Re-run install once so MCP
273
+ servers reload. If it remains unavailable, fix the Codex Computer Use app,
274
+ Codex app-server MCP status, or macOS permissions.
275
+
276
+ **Status or a probe times out on `computer-use.list_apps`.** The plugin and MCP
277
+ server are present, but the local Computer Use bridge did not answer. Quit or
278
+ restart Codex Computer Use, relaunch Codex Desktop if needed, then retry in a
279
+ fresh OpenClaw session.
280
+
281
+ **A Computer Use tool says `Native hook relay unavailable`.** The Codex-native
282
+ tool hook could not reach an active OpenClaw relay through the local bridge or
283
+ Gateway fallback. Start a fresh OpenClaw session with `/new` or `/reset`. If it
284
+ works once and then fails again on a later tool call, `/new` is only clearing the
285
+ current attempt; restart the Codex app-server or OpenClaw Gateway so old threads
286
+ and hook registrations are dropped, then retry in a fresh session.
287
+
288
+ **Turn-start auto-install refuses a source.** This is intentional. Add the
289
+ source with explicit `/codex computer-use install --source <marketplace-source>`
290
+ first, then future turn-start auto-install can use the discovered local
291
+ marketplace.
292
+
293
+ ## Related
294
+
295
+ - [Codex harness](/plugins/codex-harness)
296
+ - [Peekaboo bridge](/platforms/mac/peekaboo)
297
+ - [iOS app](/platforms/ios)