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,135 @@
1
+ ---
2
+ summary: "CLI reference for `openclaw security` (audit and fix common security footguns)"
3
+ read_when:
4
+ - You want to run a quick security audit on config/state
5
+ - You want to apply safe "fix" suggestions (permissions, tighten defaults)
6
+ title: "Security"
7
+ ---
8
+
9
+ # `openclaw security`
10
+
11
+ Security tools (audit + optional fixes).
12
+
13
+ Related:
14
+
15
+ - Security guide: [Security](/gateway/security)
16
+
17
+ ## Audit
18
+
19
+ ```bash
20
+ openclaw security audit
21
+ openclaw security audit --deep
22
+ openclaw security audit --deep --password <password>
23
+ openclaw security audit --deep --token <token>
24
+ openclaw security audit --fix
25
+ openclaw security audit --json
26
+ ```
27
+
28
+ Plain `security audit` stays on the cold config/filesystem/read-only path. It does not discover plugin runtime security collectors by default, so routine audits do not load every installed plugin runtime. Use `--deep` to include best-effort live Gateway probes and plugin-owned security audit collectors; explicit internal callers may also opt into those plugin-owned collectors when they already have an appropriate runtime scope.
29
+
30
+ The audit warns when multiple DM senders share the main session and recommends **secure DM mode**: `session.dmScope="per-channel-peer"` (or `per-account-channel-peer` for multi-account channels) for shared inboxes.
31
+ This is for cooperative/shared inbox hardening. A single Gateway shared by mutually untrusted/adversarial operators is not a recommended setup; split trust boundaries with separate gateways (or separate OS users/hosts).
32
+ It also emits `security.trust_model.multi_user_heuristic` when config suggests likely shared-user ingress (for example open DM/group policy, configured group targets, or wildcard sender rules), and reminds you that OpenClaw is a personal-assistant trust model by default.
33
+ For intentional shared-user setups, the audit guidance is to sandbox all sessions, keep filesystem access workspace-scoped, and keep personal/private identities or credentials off that runtime.
34
+ It also warns when small models (`<=300B`) are used without sandboxing and with web/browser tools enabled.
35
+ For webhook ingress, startup logs a non-fatal security warning and audit flags `hooks.token` reuse of active Gateway shared-secret auth values, including `gateway.auth.token` / `OPENCLAW_GATEWAY_TOKEN` and `gateway.auth.password` / `OPENCLAW_GATEWAY_PASSWORD`. It also warns when:
36
+
37
+ - `hooks.token` is short
38
+ - `hooks.path="/"`
39
+ - `hooks.defaultSessionKey` is unset
40
+ - `hooks.allowedAgentIds` is unrestricted
41
+ - request `sessionKey` overrides are enabled
42
+ - overrides are enabled without `hooks.allowedSessionKeyPrefixes`
43
+
44
+ If Gateway password auth is supplied only at startup, pass the same value to `openclaw security audit --auth password --password <password>` so the audit can check it against `hooks.token`.
45
+ Run `openclaw doctor --fix` to rotate a persisted reused `hooks.token`, then update external hook senders to use the new hook token.
46
+
47
+ It also warns when sandbox Docker settings are configured while sandbox mode is off, when `gateway.nodes.denyCommands` uses ineffective pattern-like/unknown entries (exact node command-name matching only, not shell-text filtering), when `gateway.nodes.allowCommands` explicitly enables dangerous node commands, when global `tools.profile="minimal"` is overridden by agent tool profiles, when write/edit tools are disabled but `exec` is still available without a constraining sandbox filesystem boundary, when open groups expose runtime/filesystem tools without sandbox/workspace guards, and when installed plugin tools may be reachable under permissive tool policy.
48
+ It also flags `gateway.allowRealIpFallback=true` (header-spoofing risk if proxies are misconfigured) and `discovery.mdns.mode="full"` (metadata leakage via mDNS TXT records).
49
+ It also warns when sandbox browser uses Docker `bridge` network without `sandbox.browser.cdpSourceRange`.
50
+ It also flags dangerous sandbox Docker network modes (including `host` and `container:*` namespace joins).
51
+ It also warns when existing sandbox browser Docker containers have missing/stale hash labels (for example pre-migration containers missing `openclaw.browserConfigEpoch`) and recommends `openclaw sandbox recreate --browser --all`.
52
+ It also warns when npm-based plugin/hook install records are unpinned, missing integrity metadata, or drift from currently installed package versions.
53
+ It warns when channel allowlists rely on mutable names/emails/tags instead of stable IDs (Discord, Slack, Google Chat, Microsoft Teams, Mattermost, IRC scopes where applicable).
54
+ It warns when `gateway.auth.mode="none"` leaves Gateway HTTP APIs reachable without a shared secret (`/tools/invoke` plus any enabled `/v1/*` endpoint).
55
+ Settings prefixed with `dangerous`/`dangerously` are explicit break-glass operator overrides; enabling one is not, by itself, a security vulnerability report.
56
+ For the complete dangerous-parameter inventory, see the "Insecure or dangerous flags summary" section in [Security](/gateway/security).
57
+
58
+ Intentional standing findings can be accepted with `security.audit.suppressions`.
59
+ Each suppression matches an exact `checkId` and can be narrowed with
60
+ `titleIncludes` and/or `detailIncludes` case-insensitive substrings:
61
+
62
+ ```json
63
+ {
64
+ "security": {
65
+ "audit": {
66
+ "suppressions": [
67
+ {
68
+ "checkId": "plugins.tools_reachable_permissive_policy",
69
+ "detailIncludes": "Enabled extension plugins: gbrain",
70
+ "reason": "trusted local operator plugin"
71
+ }
72
+ ]
73
+ }
74
+ }
75
+ }
76
+ ```
77
+
78
+ Suppressed findings are removed from the active `summary` and `findings` list.
79
+ JSON output keeps them under `suppressedFindings` for auditability.
80
+ When suppressions are configured, active output also keeps an unsuppressible
81
+ `security.audit.suppressions.active` info finding so readers can tell the audit
82
+ was filtered. Dangerous config flags are emitted one flag per finding, so
83
+ accepting one dangerous flag does not hide other enabled flags that share the
84
+ same `config.insecure_or_dangerous_flags` checkId.
85
+ Because suppressions can hide standing risk, adding or removing them through
86
+ agent-run shell commands requires exec approval unless exec is already running
87
+ with `security="full"` and `ask="off"` for trusted local automation.
88
+
89
+ SecretRef behavior:
90
+
91
+ - `security audit` resolves supported SecretRefs in read-only mode for its targeted paths.
92
+ - If a SecretRef is unavailable in the current command path, audit continues and reports `secretDiagnostics` (instead of crashing).
93
+ - `--token` and `--password` only override deep-probe auth for that command invocation; they do not rewrite config or SecretRef mappings.
94
+
95
+ ## JSON output
96
+
97
+ Use `--json` for CI/policy checks:
98
+
99
+ ```bash
100
+ openclaw security audit --json | jq '.summary'
101
+ openclaw security audit --deep --json | jq '.findings[] | select(.severity=="critical") | .checkId'
102
+ ```
103
+
104
+ If `--fix` and `--json` are combined, output includes both fix actions and final report:
105
+
106
+ ```bash
107
+ openclaw security audit --fix --json | jq '{fix: .fix.ok, summary: .report.summary}'
108
+ ```
109
+
110
+ ## What `--fix` changes
111
+
112
+ `--fix` applies safe, deterministic remediations:
113
+
114
+ - flips common `groupPolicy="open"` to `groupPolicy="allowlist"` (including account variants in supported channels)
115
+ - when WhatsApp group policy flips to `allowlist`, seeds `groupAllowFrom` from
116
+ the stored `allowFrom` file when that list exists and config does not already
117
+ define `allowFrom`
118
+ - sets `logging.redactSensitive` from `"off"` to `"tools"`
119
+ - tightens permissions for state/config and common sensitive files
120
+ (`credentials/*.json`, `auth-profiles.json`, `sessions.json`, session
121
+ `*.jsonl`)
122
+ - also tightens config include files referenced from `openclaw.json`
123
+ - uses `chmod` on POSIX hosts and `icacls` resets on Windows
124
+
125
+ `--fix` does **not**:
126
+
127
+ - rotate tokens/passwords/API keys
128
+ - disable tools (`gateway`, `cron`, `exec`, etc.)
129
+ - change gateway bind/auth/network exposure choices
130
+ - remove or rewrite plugins/skills
131
+
132
+ ## Related
133
+
134
+ - [CLI reference](/cli)
135
+ - [Security audit](/gateway/security)
@@ -0,0 +1,178 @@
1
+ ---
2
+ summary: "CLI reference for `openclaw sessions` (list stored sessions + usage)"
3
+ read_when:
4
+ - You want to list stored sessions and see recent activity
5
+ title: "Sessions"
6
+ ---
7
+
8
+ # `openclaw sessions`
9
+
10
+ List stored conversation sessions.
11
+
12
+ Session lists are not channel/provider liveness checks. They show persisted
13
+ conversation rows from session stores. A quiet Discord, Slack, Telegram, or
14
+ other channel can reconnect successfully without creating a new session row
15
+ until a message is processed. Use `openclaw channels status --probe`,
16
+ `openclaw status --deep`, or `openclaw health --verbose` when you need live
17
+ channel connectivity.
18
+
19
+ `openclaw sessions` and Gateway `sessions.list` responses are bounded by
20
+ default so large long-lived stores cannot monopolize the CLI process or Gateway
21
+ event loop. The CLI returns the newest 100 sessions by default; pass
22
+ `--limit <n>` for a smaller/larger window or `--limit all` when you intentionally
23
+ need the full store. JSON responses include `totalCount`, `limitApplied`, and
24
+ `hasMore` when callers need to show that more rows exist.
25
+
26
+ RPC clients can pass `configuredAgentsOnly: true` to keep the broad combined
27
+ discovery source but return only rows for agents currently present in config.
28
+ Control UI uses that mode by default so deleted or disk-only agent stores do
29
+ not reappear in the Sessions view.
30
+
31
+ ```bash
32
+ openclaw sessions
33
+ openclaw sessions --agent work
34
+ openclaw sessions --all-agents
35
+ openclaw sessions --active 120
36
+ openclaw sessions --limit 25
37
+ openclaw sessions --verbose
38
+ openclaw sessions --json
39
+ ```
40
+
41
+ Scope selection:
42
+
43
+ - default: configured default agent store
44
+ - `--verbose`: verbose logging
45
+ - `--agent <id>`: one configured agent store
46
+ - `--all-agents`: aggregate all configured agent stores
47
+ - `--store <path>`: explicit store path (cannot be combined with `--agent` or `--all-agents`)
48
+ - `--limit <n|all>`: max rows to output (default `100`; `all` restores full output)
49
+
50
+ Tail human-readable trajectory progress for stored sessions:
51
+
52
+ ```bash
53
+ openclaw sessions tail
54
+ openclaw sessions tail --follow
55
+ openclaw sessions tail --session-key "agent:main:telegram:direct:123" --tail 25
56
+ openclaw sessions --agent work tail --follow
57
+ openclaw sessions --all-agents tail --follow
58
+ ```
59
+
60
+ `openclaw sessions tail` renders recent trajectory JSONL events as compact progress lines. Without `--session-key`, it tails running sessions first, then the latest stored session. `--tail <count>` controls how many existing events print before follow mode; the default is `80`, and `0` starts at the current end. `--follow` keeps watching the selected trajectory files, including relocated files referenced by `<session>.trajectory-path.json`.
61
+
62
+ The progress view is intentionally conservative: prompt text, tool arguments, and tool result bodies are not printed. Tool calls show the tool name with `{...redacted...}`; tool results show status such as `ok`, `error`, or `done`; model completion lines show provider/model and terminal status.
63
+
64
+ Export a trajectory bundle for a stored session:
65
+
66
+ ```bash
67
+ openclaw sessions export-trajectory --session-key "agent:main:telegram:direct:123" --workspace .
68
+ openclaw sessions export-trajectory --session-key "agent:main:telegram:direct:123" --output bug-123 --json
69
+ ```
70
+
71
+ This is the command path used by the `/export-trajectory` slash command after
72
+ the owner approves the exec request. The output directory is always resolved
73
+ inside `.openclaw/trajectory-exports/` under the selected workspace.
74
+
75
+ `openclaw sessions --all-agents` reads configured agent stores. Gateway and ACP
76
+ session discovery are broader: they also include disk-only stores found under
77
+ the default `agents/` root or a templated `session.store` root. Those
78
+ discovered stores must resolve to regular `sessions.json` files inside the
79
+ agent root; symlinks and out-of-root paths are skipped.
80
+
81
+ JSON examples:
82
+
83
+ `openclaw sessions --all-agents --json`:
84
+
85
+ ```json
86
+ {
87
+ "path": null,
88
+ "stores": [
89
+ { "agentId": "main", "path": "/home/user/.openclaw/agents/main/sessions/sessions.json" },
90
+ { "agentId": "work", "path": "/home/user/.openclaw/agents/work/sessions/sessions.json" }
91
+ ],
92
+ "allAgents": true,
93
+ "count": 2,
94
+ "totalCount": 2,
95
+ "limitApplied": 100,
96
+ "hasMore": false,
97
+ "activeMinutes": null,
98
+ "sessions": [
99
+ { "agentId": "main", "key": "agent:main:main", "model": "gpt-5" },
100
+ { "agentId": "work", "key": "agent:work:main", "model": "claude-opus-4-6" }
101
+ ]
102
+ }
103
+ ```
104
+
105
+ ## Cleanup maintenance
106
+
107
+ Run maintenance now (instead of waiting for the next write cycle):
108
+
109
+ ```bash
110
+ openclaw sessions cleanup --dry-run
111
+ openclaw sessions cleanup --agent work --dry-run
112
+ openclaw sessions cleanup --all-agents --dry-run
113
+ openclaw sessions cleanup --enforce
114
+ openclaw sessions cleanup --enforce --active-key "agent:main:telegram:direct:123"
115
+ openclaw sessions cleanup --dry-run --fix-dm-scope
116
+ openclaw sessions cleanup --json
117
+ ```
118
+
119
+ `openclaw sessions cleanup` uses `session.maintenance` settings from config:
120
+
121
+ - Scope note: `openclaw sessions cleanup` maintains session stores, transcripts, and trajectory sidecars. It does not prune cron run history, which is managed by `cron.runLog.keepLines` in [Cron configuration](/automation/cron-jobs#configuration) and explained in [Cron maintenance](/automation/cron-jobs#maintenance).
122
+ - Cleanup also prunes unreferenced primary transcripts, compaction checkpoints, and trajectory sidecars older than `session.maintenance.pruneAfter`; files still referenced by `sessions.json` are preserved.
123
+
124
+ - `--dry-run`: preview how many entries would be pruned/capped without writing.
125
+ - In text mode, dry-run prints a per-session action table (`Action`, `Key`, `Age`, `Model`, `Flags`) so you can see what would be kept vs removed.
126
+ - `--enforce`: apply maintenance even when `session.maintenance.mode` is `warn`.
127
+ - `--fix-missing`: remove entries whose transcript files are missing or header-only/empty, even if they would not normally age/count out yet.
128
+ - `--fix-dm-scope`: when `session.dmScope` is `main`, retire stale peer-keyed direct-DM rows left behind by earlier `per-peer`, `per-channel-peer`, or `per-account-channel-peer` routing. Use `--dry-run` first; applying the cleanup removes those rows from `sessions.json` and preserves their transcripts as deleted archives.
129
+ - `--active-key <key>`: protect a specific active key from disk-budget eviction. Durable external conversation pointers, such as group sessions and thread-scoped chat sessions, are also kept by age/count/disk-budget maintenance.
130
+ - `--agent <id>`: run cleanup for one configured agent store.
131
+ - `--all-agents`: run cleanup for all configured agent stores.
132
+ - `--store <path>`: run against a specific `sessions.json` file.
133
+ - `--json`: print a JSON summary. With `--all-agents`, output includes one summary per store.
134
+
135
+ When a Gateway is reachable, non-dry-run cleanup for configured agent stores is
136
+ sent through the Gateway so it shares the same session-store writer as runtime
137
+ traffic. Use `--store <path>` for explicit offline repair of a store file.
138
+
139
+ `openclaw sessions cleanup --all-agents --dry-run --json`:
140
+
141
+ ```json
142
+ {
143
+ "allAgents": true,
144
+ "mode": "warn",
145
+ "dryRun": true,
146
+ "stores": [
147
+ {
148
+ "agentId": "main",
149
+ "storePath": "/home/user/.openclaw/agents/main/sessions/sessions.json",
150
+ "beforeCount": 120,
151
+ "afterCount": 80,
152
+ "missing": 0,
153
+ "dmScopeRetired": 0,
154
+ "pruned": 40,
155
+ "capped": 0
156
+ },
157
+ {
158
+ "agentId": "work",
159
+ "storePath": "/home/user/.openclaw/agents/work/sessions/sessions.json",
160
+ "beforeCount": 18,
161
+ "afterCount": 18,
162
+ "missing": 0,
163
+ "dmScopeRetired": 0,
164
+ "pruned": 0,
165
+ "capped": 0
166
+ }
167
+ ]
168
+ }
169
+ ```
170
+
171
+ Related:
172
+
173
+ - Session config: [Configuration reference](/gateway/config-agents#session)
174
+
175
+ ## Related
176
+
177
+ - [CLI reference](/cli)
178
+ - [Session management](/concepts/session)
@@ -0,0 +1,60 @@
1
+ ---
2
+ summary: "CLI reference for `openclaw setup` (initialize config plus workspace, optionally run onboarding)"
3
+ read_when:
4
+ - You're doing first-run setup without full CLI onboarding
5
+ - You want to set the default workspace path
6
+ - You need every flag and how setup decides between baseline and wizard mode
7
+ title: "Setup"
8
+ ---
9
+
10
+ # `openclaw setup`
11
+
12
+ Initialize the baseline config and agent workspace. With any onboarding flag present, also runs the wizard.
13
+
14
+ <Note>
15
+ `openclaw setup` is for mutable config installs. In Nix mode (`OPENCLAW_NIX_MODE=1`) OpenClaw refuses setup writes because the config file is managed by Nix. Use the first-party [nix-openclaw Quick Start](https://github.com/openclaw/nix-openclaw#quick-start) or the equivalent source config for another Nix package.
16
+ </Note>
17
+
18
+ ## Options
19
+
20
+ | Flag | Description |
21
+ | -------------------------- | --------------------------------------------------------------------------------------------------- |
22
+ | `--workspace <dir>` | Agent workspace directory (default `~/.openclaw/workspace`; stored as `agents.defaults.workspace`). |
23
+ | `--wizard` | Run interactive onboarding. |
24
+ | `--non-interactive` | Run onboarding without prompts. |
25
+ | `--accept-risk` | Acknowledge full-system agent access risk; required with `--non-interactive`. |
26
+ | `--mode <mode>` | Onboarding mode: `local` or `remote`. |
27
+ | `--import-from <provider>` | Migration provider to run during onboarding. |
28
+ | `--import-source <path>` | Source agent home for `--import-from`. |
29
+ | `--import-secrets` | Import supported secrets during onboarding migration. |
30
+ | `--remote-url <url>` | Remote Gateway WebSocket URL. |
31
+ | `--remote-token <token>` | Remote Gateway token (optional). |
32
+
33
+ ### Wizard auto-trigger
34
+
35
+ `openclaw setup` runs the wizard when any of these flags are explicitly present, even without `--wizard`:
36
+
37
+ `--wizard`, `--non-interactive`, `--accept-risk`, `--mode`, `--import-from`, `--import-source`, `--import-secrets`, `--remote-url`, `--remote-token`.
38
+
39
+ ## Examples
40
+
41
+ ```bash
42
+ openclaw setup
43
+ openclaw setup --workspace ~/.openclaw/workspace
44
+ openclaw setup --wizard
45
+ openclaw setup --wizard --import-from hermes --import-source ~/.hermes
46
+ openclaw setup --non-interactive --accept-risk --mode remote --remote-url wss://gateway-host:18789 --remote-token <token>
47
+ ```
48
+
49
+ ## Notes
50
+
51
+ - Plain `openclaw setup` initializes config and workspace without running the full onboarding flow.
52
+ - After plain setup, run `openclaw onboard` for the full guided journey, `openclaw configure` for targeted changes, or `openclaw channels add` to add channel accounts.
53
+ - If Hermes state is detected, interactive onboarding can offer migration automatically. Import onboarding requires a fresh setup; use [Migrate](/cli/migrate) for dry-run plans, backups, and overwrite mode outside onboarding.
54
+
55
+ ## Related
56
+
57
+ - [CLI reference](/cli)
58
+ - [Onboarding (CLI)](/start/wizard)
59
+ - [Getting started](/start/getting-started)
60
+ - [Install overview](/install)
@@ -0,0 +1,156 @@
1
+ ---
2
+ summary: "CLI reference for `openclaw skills` (search/install/update/verify/list/info/check/workshop)"
3
+ read_when:
4
+ - You want to see which skills are available and ready to run
5
+ - You want to search ClawHub or install skills from ClawHub, Git, or local directories
6
+ - You want to verify a ClawHub skill with ClawHub
7
+ - You want to debug missing binaries/env/config for skills
8
+ title: "Skills"
9
+ ---
10
+
11
+ # `openclaw skills`
12
+
13
+ Inspect local skills, search ClawHub, install skills from ClawHub/Git/local
14
+ directories, verify ClawHub skills, and update ClawHub-tracked installs.
15
+
16
+ Related:
17
+
18
+ - Skills system: [Skills](/tools/skills)
19
+ - Skill Workshop: [Skill Workshop](/tools/skill-workshop)
20
+ - Skills config: [Skills config](/tools/skills-config)
21
+ - ClawHub installs: [ClawHub](/clawhub/cli)
22
+
23
+ ## Commands
24
+
25
+ ```bash
26
+ openclaw skills search "calendar"
27
+ openclaw skills search --limit 20 --json
28
+ openclaw skills install <slug>
29
+ openclaw skills install <slug> --version <version>
30
+ openclaw skills install git:owner/repo
31
+ openclaw skills install git:owner/repo@main
32
+ openclaw skills install ./path/to/skill --as custom-name
33
+ openclaw skills install <slug> --force
34
+ openclaw skills install <slug> --agent <id>
35
+ openclaw skills install <slug> --global
36
+ openclaw skills update <slug>
37
+ openclaw skills update <slug> --global
38
+ openclaw skills update --all
39
+ openclaw skills update --all --agent <id>
40
+ openclaw skills update --all --global
41
+ openclaw skills verify <slug>
42
+ openclaw skills verify <slug> --version <version>
43
+ openclaw skills verify <slug> --tag <tag>
44
+ openclaw skills verify <slug> --card
45
+ openclaw skills verify <slug> --global
46
+ openclaw skills list
47
+ openclaw skills list --eligible
48
+ openclaw skills list --json
49
+ openclaw skills list --verbose
50
+ openclaw skills list --agent <id>
51
+ openclaw skills info <name>
52
+ openclaw skills info <name> --json
53
+ openclaw skills info <name> --agent <id>
54
+ openclaw skills check
55
+ openclaw skills check --agent <id>
56
+ openclaw skills check --json
57
+ openclaw skills workshop propose-create --name "qa-check" --description "QA checklist" --proposal ./PROPOSAL.md
58
+ openclaw skills workshop propose-update qa-check --proposal ./PROPOSAL.md
59
+ openclaw skills workshop list
60
+ openclaw skills workshop inspect <proposal-id>
61
+ openclaw skills workshop revise <proposal-id> --proposal ./PROPOSAL.md
62
+ openclaw skills workshop apply <proposal-id>
63
+ openclaw skills workshop reject <proposal-id> --reason "Not reusable"
64
+ openclaw skills workshop quarantine <proposal-id> --reason "Needs security review"
65
+ ```
66
+
67
+ `search`, `update`, and `verify` use ClawHub directly. `install <slug>` installs
68
+ a ClawHub skill, `install git:owner/repo[@ref]` clones a Git skill, and
69
+ `install ./path` copies a local skill directory. By default, `install`, `update`,
70
+ and `verify` target the active workspace `skills/` directory; with `--global`,
71
+ they target the shared managed skills directory. `list`/`info`/`check` still
72
+ inspect the local skills visible to the current workspace and config.
73
+ Workspace-backed commands resolve the target workspace from `--agent <id>`, then
74
+ the current working directory when it is inside a configured agent workspace,
75
+ then the default agent.
76
+
77
+ Git and local directory installs expect `SKILL.md` at the source root. The
78
+ install slug comes from `SKILL.md` frontmatter `name` when it is valid, then the
79
+ source directory or repository name; use `--as <slug>` to override it. `--version`
80
+ is ClawHub-only. Skill installs do not support npm package specs or zip/archive
81
+ paths, and `openclaw skills update` updates ClawHub-tracked installs only.
82
+
83
+ Gateway-backed skill dependency installs triggered from onboarding or Skills
84
+ settings use the separate `skills.install` request path instead.
85
+
86
+ Notes:
87
+
88
+ - `search [query...]` accepts an optional query; omit it to browse the default
89
+ ClawHub search feed.
90
+ - `search --limit <n>` caps returned results.
91
+ - `install git:owner/repo[@ref]` installs a Git skill. Branch refs may contain
92
+ slashes, such as `git:owner/repo@feature/foo`.
93
+ - `install ./path/to/skill` installs a local directory whose root contains
94
+ `SKILL.md`.
95
+ - `install --as <slug>` overrides the inferred slug for Git and local directory
96
+ installs.
97
+ - `install --version <version>` applies only to ClawHub skill slugs.
98
+ - `install --force` overwrites an existing workspace skill folder for the same
99
+ slug.
100
+ - `--global` targets the shared managed skills directory and cannot be combined
101
+ with `--agent <id>`.
102
+ - `--agent <id>` targets one configured agent workspace and overrides current
103
+ working directory inference.
104
+ - `update <slug>` updates a single tracked skill. Add `--global` to target the
105
+ shared managed skills directory instead of the workspace.
106
+ - `update --all` updates tracked ClawHub installs in the selected workspace, or
107
+ in the shared managed skills directory when combined with `--global`.
108
+ - `verify <slug>` prints ClawHub's `clawhub.skill.verify.v1` JSON envelope by
109
+ default. There is no `--json` flag because JSON is already the default.
110
+ - `verify` uses `.clawhub/origin.json` for installed ClawHub skills, so it
111
+ verifies the installed version against the registry it came from. `--version`
112
+ and `--tag` override the version selector but keep that installed registry
113
+ when origin metadata exists.
114
+ - `verify --card` prints the generated Skill Card Markdown instead of JSON. The
115
+ command exits non-zero when ClawHub returns `ok: false` or `decision: "fail"`;
116
+ unsigned signatures are informational unless ClawHub policy changes.
117
+ - Installed ClawHub bundles can include a generated `skill-card.md`. OpenClaw
118
+ treats verification as a ClawHub server decision and does not reject an
119
+ installed skill just because that generated card changes the bundle
120
+ fingerprint.
121
+ - `check --agent <id>` checks the selected agent's workspace and reports which
122
+ ready skills are actually visible to that agent's prompt or command surface.
123
+ - `list` is the default action when no subcommand is provided.
124
+ - `list`, `info`, and `check` write their rendered output to stdout. With
125
+ `--json`, that means the machine-readable payload stays on stdout for pipes
126
+ and scripts.
127
+
128
+ ## Skill Workshop
129
+
130
+ `openclaw skills workshop` manages pending skill proposals in the selected
131
+ workspace. Proposals are not active skills until applied. For proposal storage,
132
+ support-file safeguards, Gateway methods, and approval policy, see
133
+ [Skill Workshop](/tools/skill-workshop).
134
+
135
+ ```bash
136
+ openclaw skills workshop propose-create \
137
+ --name "qa-check" \
138
+ --description "Repeatable QA checklist" \
139
+ --proposal ./PROPOSAL.md
140
+ openclaw skills workshop propose-create \
141
+ --name "qa-check" \
142
+ --description "Repeatable QA checklist" \
143
+ --proposal-dir ./qa-check-proposal
144
+ openclaw skills workshop propose-update qa-check --proposal ./PROPOSAL.md
145
+ openclaw skills workshop list
146
+ openclaw skills workshop inspect <proposal-id>
147
+ openclaw skills workshop revise <proposal-id> --proposal ./PROPOSAL.md
148
+ openclaw skills workshop apply <proposal-id>
149
+ openclaw skills workshop reject <proposal-id> --reason "Duplicate"
150
+ openclaw skills workshop quarantine <proposal-id> --reason "Needs security review"
151
+ ```
152
+
153
+ ## Related
154
+
155
+ - [CLI reference](/cli)
156
+ - [Skills](/tools/skills)
@@ -0,0 +1,45 @@
1
+ ---
2
+ summary: "CLI reference for `openclaw status` (diagnostics, probes, usage snapshots)"
3
+ read_when:
4
+ - You want a quick diagnosis of channel health + recent session recipients
5
+ - You want a pasteable "all" status for debugging
6
+ title: "openclaw status"
7
+ ---
8
+
9
+ Diagnostics for channels + sessions.
10
+
11
+ ```bash
12
+ openclaw status
13
+ openclaw status --all
14
+ openclaw status --deep
15
+ openclaw status --usage
16
+ ```
17
+
18
+ Notes:
19
+
20
+ - `--deep` runs live probes (WhatsApp Web + Telegram + Discord + Slack + Signal).
21
+ - Plain `openclaw status` stays on the fast read-only path and marks memory as `not checked` instead of unavailable when it skips memory inspection. Heavy security audit, plugin compatibility, and memory-vector probes are left to `openclaw status --all`, `openclaw status --deep`, `openclaw security audit`, and `openclaw memory status --deep`.
22
+ - `status --json --all` reports memory details from the active memory plugin runtime selected by `plugins.slots.memory`. Custom memory plugins can leave built-in `agents.defaults.memorySearch.enabled` disabled and still report their own files, chunks, vector, and FTS state.
23
+ - `--usage` prints normalized provider usage windows as `X% left`.
24
+ - Session status output separates `Execution:` from `Runtime:`. `Execution` is the sandbox path (`direct`, `docker/*`), while `Runtime` tells you whether the session is using `OpenClaw Default`, `OpenAI Codex`, a CLI backend, or an ACP backend such as `codex (acp/acpx)`. See [Agent runtimes](/concepts/agent-runtimes) for the provider/model/runtime distinction.
25
+ - MiniMax's raw `usage_percent` / `usagePercent` fields are remaining quota, so OpenClaw inverts them before display; count-based fields win when present. `model_remains` responses prefer the chat-model entry, derive the window label from timestamps when needed, and include the model name in the plan label.
26
+ - When the current session snapshot is sparse, `/status` can backfill token and cache counters from the most recent transcript usage log. Existing nonzero live values still win over transcript fallback values.
27
+ - `/status` includes compact Gateway process uptime and host system uptime.
28
+ - Transcript fallback can also recover the active runtime model label when the live session entry is missing it. If that transcript model differs from the selected model, status resolves the context window against the recovered runtime model instead of the selected one.
29
+ - When a session is pinned to a model that differs from the configured primary, status prints both values, the reason (`session override`), and the clear hint (`/model <configured-default>` or `/reset`). The configured primary applies to new or unpinned sessions; existing pinned sessions keep their session selection until cleared.
30
+ - For prompt-size accounting, transcript fallback prefers the larger prompt-oriented total when session metadata is missing or smaller, so custom-provider sessions do not collapse to `0` token displays.
31
+ - Output includes per-agent session stores when multiple agents are configured.
32
+ - Overview includes Gateway + node host service install/runtime status when available.
33
+ - Overview includes update channel + git SHA (for source checkouts).
34
+ - Update info surfaces in the Overview; if an update is available, status prints a hint to run `openclaw update` (see [Updating](/install/updating)).
35
+ - Model pricing refresh failures are shown as optional pricing warnings. They do
36
+ not mean the Gateway or channels are unhealthy.
37
+ - Read-only status surfaces (`status`, `status --json`, `status --all`) resolve supported SecretRefs for their targeted config paths when possible.
38
+ - If a supported channel SecretRef is configured but unavailable in the current command path, status stays read-only and reports degraded output instead of crashing. Human output shows warnings such as "configured token unavailable in this command path", and JSON output includes `secretDiagnostics`.
39
+ - When command-local SecretRef resolution succeeds, status prefers the resolved snapshot and clears transient "secret unavailable" channel markers from the final output.
40
+ - `status --all` includes a Secrets overview row and a diagnosis section that summarizes secret diagnostics (truncated for readability) without stopping report generation.
41
+
42
+ ## Related
43
+
44
+ - [CLI reference](/cli)
45
+ - [Doctor](/gateway/doctor)
@@ -0,0 +1,89 @@
1
+ ---
2
+ summary: "CLI reference for `openclaw system` (system events, heartbeat, presence)"
3
+ read_when:
4
+ - You want to enqueue a system event without creating a cron job
5
+ - You need to enable or disable heartbeats
6
+ - You want to inspect system presence entries
7
+ title: "System"
8
+ ---
9
+
10
+ # `openclaw system`
11
+
12
+ System-level helpers for the Gateway: enqueue system events, control heartbeats,
13
+ and view presence.
14
+
15
+ All `system` subcommands use Gateway RPC and accept the shared client flags:
16
+
17
+ - `--url <url>`
18
+ - `--token <token>`
19
+ - `--timeout <ms>`
20
+ - `--expect-final`
21
+
22
+ ## Common commands
23
+
24
+ ```bash
25
+ openclaw system event --text "Check for urgent follow-ups" --mode now
26
+ openclaw system event --text "Check for urgent follow-ups" --url ws://127.0.0.1:18789 --token "$OPENCLAW_GATEWAY_TOKEN"
27
+ openclaw system heartbeat enable
28
+ openclaw system heartbeat last
29
+ openclaw system presence
30
+ ```
31
+
32
+ ## `system event`
33
+
34
+ Enqueue a system event on the **main** session by default. The next heartbeat
35
+ will inject it as a `System:` line in the prompt. Use `--mode now` to trigger
36
+ the heartbeat immediately; `next-heartbeat` waits for the next scheduled tick.
37
+
38
+ Pass `--session-key` to target a specific session (for example to relay an
39
+ async-task completion back to the channel that started it).
40
+
41
+ > **Timing exception with `--session-key`:** when `--session-key` is supplied,
42
+ > `--mode next-heartbeat` collapses to an immediate targeted wake instead of
43
+ > waiting for the next scheduled tick. Targeted wakes use heartbeat intent
44
+ > `immediate` so they bypass the runner's not-due gate that would otherwise
45
+ > defer (and effectively drop) an `event`-intent wake. If you want delayed
46
+ > delivery, omit `--session-key` so the event lands on the main session and
47
+ > rides the next regular heartbeat.
48
+
49
+ Flags:
50
+
51
+ - `--text <text>`: required system event text.
52
+ - `--mode <mode>`: `now` or `next-heartbeat` (default).
53
+ - `--session-key <sessionKey>`: optional; target a specific agent session
54
+ instead of the agent's main session. Keys that do not belong to the
55
+ resolved agent fall back to the agent's main session.
56
+ - `--json`: machine-readable output.
57
+ - `--url`, `--token`, `--timeout`, `--expect-final`: shared Gateway RPC flags.
58
+
59
+ ## `system heartbeat last|enable|disable`
60
+
61
+ Heartbeat controls:
62
+
63
+ - `last`: show the last heartbeat event.
64
+ - `enable`: turn heartbeats back on (use this if they were disabled).
65
+ - `disable`: pause heartbeats.
66
+
67
+ Flags:
68
+
69
+ - `--json`: machine-readable output.
70
+ - `--url`, `--token`, `--timeout`, `--expect-final`: shared Gateway RPC flags.
71
+
72
+ ## `system presence`
73
+
74
+ List the current system presence entries the Gateway knows about (nodes,
75
+ instances, and similar status lines).
76
+
77
+ Flags:
78
+
79
+ - `--json`: machine-readable output.
80
+ - `--url`, `--token`, `--timeout`, `--expect-final`: shared Gateway RPC flags.
81
+
82
+ ## Notes
83
+
84
+ - Requires a running Gateway reachable by your current config (local or remote).
85
+ - System events are ephemeral and not persisted across restarts.
86
+
87
+ ## Related
88
+
89
+ - [CLI reference](/cli)