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,334 @@
1
+ ---
2
+ summary: "CLI reference for `openclaw migrate` (import state from another agent system)"
3
+ read_when:
4
+ - You want to migrate from Hermes or another agent system into OpenClaw
5
+ - You are adding a plugin-owned migration provider
6
+ title: "Migrate"
7
+ ---
8
+
9
+ # `openclaw migrate`
10
+
11
+ Import state from another agent system through a plugin-owned migration provider. Bundled providers cover Codex CLI state, [Claude](/install/migrating-claude), and [Hermes](/install/migrating-hermes); third-party plugins can register additional providers.
12
+
13
+ <Tip>
14
+ For user-facing walkthroughs, see [Migrating from Claude](/install/migrating-claude) and [Migrating from Hermes](/install/migrating-hermes). The [migration hub](/install/migrating) lists all paths.
15
+ </Tip>
16
+
17
+ ## Commands
18
+
19
+ ```bash
20
+ openclaw migrate list
21
+ openclaw migrate claude --dry-run
22
+ openclaw migrate codex --dry-run
23
+ openclaw migrate codex --skill gog-vault77-google-workspace
24
+ openclaw migrate codex --plugin google-calendar --dry-run
25
+ openclaw migrate codex --plugin google-calendar --verify-plugin-apps --dry-run
26
+ openclaw migrate hermes --dry-run
27
+ openclaw migrate hermes
28
+ openclaw migrate apply codex --yes --skill gog-vault77-google-workspace
29
+ openclaw migrate apply codex --yes --plugin google-calendar
30
+ openclaw migrate apply codex --yes
31
+ openclaw migrate apply claude --yes
32
+ openclaw migrate apply hermes --yes
33
+ openclaw migrate apply hermes --include-secrets --yes
34
+ openclaw onboard --flow import
35
+ openclaw onboard --import-from claude --import-source ~/.claude
36
+ openclaw onboard --import-from hermes --import-source ~/.hermes
37
+ ```
38
+
39
+ <ParamField path="<provider>" type="string">
40
+ Name of a registered migration provider, for example `hermes`. Run `openclaw migrate list` to see installed providers.
41
+ </ParamField>
42
+ <ParamField path="--dry-run" type="boolean">
43
+ Build the plan and exit without changing state.
44
+ </ParamField>
45
+ <ParamField path="--from <path>" type="string">
46
+ Override the source state directory. Hermes defaults to `~/.hermes`.
47
+ </ParamField>
48
+ <ParamField path="--include-secrets" type="boolean">
49
+ Import supported credentials without prompting. Interactive apply asks before importing detected auth credentials, with yes selected by default; non-interactive `--yes` requires `--include-secrets` to import them.
50
+ </ParamField>
51
+ <ParamField path="--no-auth-credentials" type="boolean">
52
+ Skip auth credential import, including the interactive prompt.
53
+ </ParamField>
54
+ <ParamField path="--overwrite" type="boolean">
55
+ Allow apply to replace existing targets when the plan reports conflicts.
56
+ </ParamField>
57
+ <ParamField path="--yes" type="boolean">
58
+ Skip the confirmation prompt. Required in non-interactive mode.
59
+ </ParamField>
60
+ <ParamField path="--skill <name>" type="string">
61
+ Select one skill copy item by skill name or item id. Repeat the flag to migrate multiple skills. When omitted, interactive Codex migrations show a checkbox selector and non-interactive migrations keep all planned skills.
62
+ </ParamField>
63
+ <ParamField path="--plugin <name>" type="string">
64
+ Select one Codex plugin install item by plugin name or item id. Repeat the flag to migrate multiple Codex plugins. When omitted, interactive Codex migrations show a native Codex plugin checkbox selector and non-interactive migrations keep all planned plugins. This only applies to source-installed `openai-curated` Codex plugins discovered by the Codex app-server inventory.
65
+ </ParamField>
66
+ <ParamField path="--verify-plugin-apps" type="boolean">
67
+ Codex only. Force a fresh source Codex app-server `app/list` traversal before planning native plugin activation. Off by default to keep migration planning fast.
68
+ </ParamField>
69
+ <ParamField path="--no-backup" type="boolean">
70
+ Skip the pre-apply backup. Requires `--force` when local OpenClaw state exists.
71
+ </ParamField>
72
+ <ParamField path="--force" type="boolean">
73
+ Required alongside `--no-backup` when apply would otherwise refuse to skip backup.
74
+ </ParamField>
75
+ <ParamField path="--json" type="boolean">
76
+ Print the plan or apply result as JSON. With `--json` and no `--yes`, apply prints the plan and does not mutate state.
77
+ </ParamField>
78
+
79
+ ## Safety model
80
+
81
+ `openclaw migrate` is preview-first.
82
+
83
+ <AccordionGroup>
84
+ <Accordion title="Preview before apply">
85
+ The provider returns an itemized plan before anything changes, including conflicts, skipped items, and sensitive items. JSON plans, apply output, and migration reports redact nested secret-looking keys such as API keys, tokens, authorization headers, cookies, and passwords.
86
+
87
+ `openclaw migrate apply <provider>` previews the plan and prompts before changing state unless `--yes` is set. In non-interactive mode, apply requires `--yes`.
88
+
89
+ </Accordion>
90
+ <Accordion title="Backups">
91
+ Apply creates and verifies an OpenClaw backup before applying the migration. If no local OpenClaw state exists yet, the backup step is skipped and the migration can continue. To skip a backup when state exists, pass both `--no-backup` and `--force`.
92
+ </Accordion>
93
+ <Accordion title="Conflicts">
94
+ Apply refuses to continue when the plan has conflicts. Review the plan, then rerun with `--overwrite` if replacing existing targets is intentional. Providers may still write item-level backups for overwritten files in the migration report directory.
95
+ </Accordion>
96
+ <Accordion title="Secrets">
97
+ Interactive apply asks whether to import detected auth credentials, with yes selected by default. Use `--no-auth-credentials` to skip them, or use `--include-secrets` for unattended credential import with `--yes`.
98
+ </Accordion>
99
+ </AccordionGroup>
100
+
101
+ ## Claude provider
102
+
103
+ The bundled Claude provider detects Claude Code state at `~/.claude` by default. Use `--from <path>` to import a specific Claude Code home or project root.
104
+
105
+ <Tip>
106
+ For a user-facing walkthrough, see [Migrating from Claude](/install/migrating-claude).
107
+ </Tip>
108
+
109
+ ### What Claude imports
110
+
111
+ - Project `CLAUDE.md` and `.claude/CLAUDE.md` into the OpenClaw agent workspace.
112
+ - User `~/.claude/CLAUDE.md` appended to workspace `USER.md`.
113
+ - MCP server definitions from project `.mcp.json`, Claude Code `~/.claude.json`, and Claude Desktop `claude_desktop_config.json`.
114
+ - Claude skill directories that include `SKILL.md`.
115
+ - Claude command Markdown files converted into OpenClaw skills with manual invocation only.
116
+
117
+ ### Archive and manual-review state
118
+
119
+ Claude hooks, permissions, environment defaults, local memory, path-scoped rules, subagents, caches, plans, and project history are preserved in the migration report or reported as manual-review items. OpenClaw does not execute hooks, copy broad allowlists, or import OAuth/Desktop credential state automatically.
120
+
121
+ ## Codex provider
122
+
123
+ The bundled Codex provider detects Codex CLI state at `~/.codex` by default, or
124
+ at `CODEX_HOME` when that environment variable is set. Use `--from <path>` to
125
+ inventory a specific Codex home.
126
+
127
+ Use this provider when moving to the OpenClaw Codex harness and you want to
128
+ promote useful personal Codex CLI assets deliberately. Local Codex app-server
129
+ launches use a per-agent `CODEX_HOME`, so they do not read your personal
130
+ `~/.codex` by default. The normal process `HOME` is still inherited, so Codex
131
+ can see shared `$HOME/.agents/*` skills/plugin marketplace entries and
132
+ subprocesses can find user-home config and tokens.
133
+
134
+ Running `openclaw migrate codex` in an interactive terminal previews the full
135
+ plan, then opens checkbox selectors before the final apply confirmation. Skill
136
+ copy items are prompted first. Use `Toggle all on` or `Toggle all off` for bulk
137
+ selection. Press Space to toggle rows, or press Enter to activate the highlighted
138
+ row and continue. Planned skills start checked, conflict skills start unchecked, and
139
+ `Skip for now` skips skill copies for this run while still continuing to plugin
140
+ selection. When source-installed curated Codex plugins are migratable and
141
+ `--plugin` was not supplied, migration then prompts for native Codex plugin
142
+ activation by plugin name. Plugin items
143
+ start checked unless the target OpenClaw Codex plugin config already has that
144
+ plugin. Existing target plugins start unchecked and show a conflict hint such as
145
+ `conflict: plugin exists`; choose `Toggle all off` to migrate no native Codex
146
+ plugins in that run, or `Skip for now` to stop before applying. For scripted or
147
+ exact runs, pass `--skill <name>` once per skill, for example:
148
+
149
+ ```bash
150
+ openclaw migrate codex --dry-run --skill gog-vault77-google-workspace
151
+ openclaw migrate apply codex --yes --skill gog-vault77-google-workspace
152
+ ```
153
+
154
+ Use `--plugin <name>` to limit native Codex plugin migration non-interactively
155
+ to one or more source-installed curated plugins:
156
+
157
+ ```bash
158
+ openclaw migrate codex --dry-run --plugin google-calendar
159
+ openclaw migrate apply codex --yes --plugin google-calendar
160
+ ```
161
+
162
+ ### What Codex imports
163
+
164
+ - Codex CLI skill directories under `$CODEX_HOME/skills`, excluding Codex's
165
+ `.system` cache.
166
+ - Personal AgentSkills under `$HOME/.agents/skills`, copied into the current
167
+ OpenClaw agent workspace when you want per-agent ownership.
168
+ - Source-installed `openai-curated` Codex plugins discovered through Codex
169
+ app-server `plugin/list`. Planning reads `plugin/read` for each enabled
170
+ installed plugin. App-backed plugins require the source Codex app-server
171
+ account response to be a ChatGPT subscription account; non-ChatGPT or missing
172
+ account responses are skipped with `codex_subscription_required`. By default,
173
+ migration does not call source `app/list`, so app-backed plugins that pass the
174
+ account gate are planned without source app accessibility verification, and
175
+ account lookup transport failures skip with `codex_account_unavailable`. Pass
176
+ `--verify-plugin-apps` when you want migration to force a fresh source
177
+ `app/list` snapshot and require every owned app to be present, enabled, and
178
+ accessible before planning native activation. In that mode, account lookup
179
+ transport failures fall through to source app inventory verification. The
180
+ source app inventory snapshot is kept in memory for the current process; it
181
+ is not written to migration output or target config. Disabled plugins,
182
+ unreadable plugin details, subscription-gated source accounts, and, when
183
+ verification is requested, missing apps, disabled apps, inaccessible apps, or
184
+ source app inventory failures become manual skipped items with typed reasons
185
+ instead of target config entries.
186
+ Apply calls app-server `plugin/install` for each selected eligible plugin,
187
+ even if the target app-server already reports that plugin as installed and
188
+ enabled. Migrated Codex plugins are usable only in sessions that select the
189
+ native Codex harness; they are not exposed to OpenClaw provider runs,
190
+ ACP conversation bindings, or other harnesses.
191
+
192
+ ### Manual-review Codex state
193
+
194
+ Codex `config.toml`, native `hooks/hooks.json`, non-curated marketplaces, cached
195
+ plugin bundles that are not source-installed curated plugins, and source-installed
196
+ plugins that fail the source subscription gate are not activated automatically.
197
+ When `--verify-plugin-apps` is set, plugins that fail the source app-inventory
198
+ gate are also skipped. They are copied or reported in the migration report for
199
+ manual review.
200
+
201
+ For migrated source-installed curated plugins, apply writes:
202
+
203
+ - `plugins.entries.codex.enabled: true`
204
+ - `plugins.entries.codex.config.codexPlugins.enabled: true`
205
+ - `plugins.entries.codex.config.codexPlugins.allow_destructive_actions: true`
206
+ - one explicit plugin entry with `marketplaceName: "openai-curated"` and
207
+ `pluginName` for each selected plugin
208
+
209
+ Migration never writes `plugins["*"]` and never stores local marketplace cache
210
+ paths. Source-side subscription failures are reported on manual items with typed
211
+ reasons such as `codex_subscription_required`, `codex_account_unavailable`,
212
+ `plugin_disabled`, or `plugin_read_unavailable`. With `--verify-plugin-apps`,
213
+ source app-inventory failures can also appear as `app_inaccessible`,
214
+ `app_disabled`, `app_missing`, or `app_inventory_unavailable`. Skipped plugins
215
+ are not written to target config.
216
+ Target-side auth-required installs are reported on the affected plugin item with
217
+ `status: "skipped"`, `reason: "auth_required"`, and sanitized app identifiers.
218
+ Their explicit config entries are written disabled until you reauthorize and
219
+ enable them. Other install failures are item-scoped `error` results.
220
+
221
+ If Codex app-server plugin inventory is unavailable during planning, migration
222
+ falls back to cached bundle advisory items instead of failing the whole
223
+ migration.
224
+
225
+ ## Hermes provider
226
+
227
+ The bundled Hermes provider detects state at `~/.hermes` by default. Use `--from <path>` when Hermes lives elsewhere.
228
+
229
+ ### What Hermes imports
230
+
231
+ - Default model configuration from `config.yaml`.
232
+ - Configured model providers and custom OpenAI-compatible endpoints from `providers` and `custom_providers`.
233
+ - MCP server definitions from `mcp_servers` or `mcp.servers`.
234
+ - `SOUL.md` and `AGENTS.md` into the OpenClaw agent workspace.
235
+ - `memories/MEMORY.md` and `memories/USER.md` appended to workspace memory files.
236
+ - Memory config defaults for OpenClaw file memory, plus archive or manual-review items for external memory providers such as Honcho.
237
+ - Skills that include a `SKILL.md` file under `skills/<name>/`.
238
+ - Per-skill config values from `skills.config`.
239
+ - OpenCode OpenAI OAuth credentials from OpenCode `auth.json` when interactive credential migration is accepted, or when `--include-secrets` is set. Hermes `auth.json` OAuth entries are legacy state reported for manual OpenAI reauth or doctor repair.
240
+ - Supported API keys and tokens from Hermes `.env` and OpenCode `auth.json` when interactive credential migration is accepted, or when `--include-secrets` is set.
241
+
242
+ ### Supported `.env` keys
243
+
244
+ - `AI_GATEWAY_API_KEY`
245
+ - `ALIBABA_API_KEY`
246
+ - `ANTHROPIC_API_KEY`
247
+ - `ARCEEAI_API_KEY`
248
+ - `CEREBRAS_API_KEY`
249
+ - `CHUTES_API_KEY`
250
+ - `CLOUDFLARE_AI_GATEWAY_API_KEY`
251
+ - `COPILOT_GITHUB_TOKEN`
252
+ - `DASHSCOPE_API_KEY`
253
+ - `DEEPINFRA_API_KEY`
254
+ - `DEEPSEEK_API_KEY`
255
+ - `FIREWORKS_API_KEY`
256
+ - `GEMINI_API_KEY`
257
+ - `GH_TOKEN`
258
+ - `GITHUB_TOKEN`
259
+ - `GLM_API_KEY`
260
+ - `GOOGLE_API_KEY`
261
+ - `GROQ_API_KEY`
262
+ - `HF_TOKEN`
263
+ - `HUGGINGFACE_HUB_TOKEN`
264
+ - `KILOCODE_API_KEY`
265
+ - `KIMICODE_API_KEY`
266
+ - `KIMI_API_KEY`
267
+ - `MINIMAX_API_KEY`
268
+ - `MINIMAX_CODING_API_KEY`
269
+ - `MISTRAL_API_KEY`
270
+ - `MODELSTUDIO_API_KEY`
271
+ - `MOONSHOT_API_KEY`
272
+ - `NVIDIA_API_KEY`
273
+ - `OPENAI_API_KEY`
274
+ - `OPENCODE_API_KEY`
275
+ - `OPENCODE_GO_API_KEY`
276
+ - `OPENCODE_ZEN_API_KEY`
277
+ - `OPENROUTER_API_KEY`
278
+ - `QIANFAN_API_KEY`
279
+ - `QWEN_API_KEY`
280
+ - `TOGETHER_API_KEY`
281
+ - `VENICE_API_KEY`
282
+ - `XAI_API_KEY`
283
+ - `XIAOMI_API_KEY`
284
+ - `ZAI_API_KEY`
285
+ - `Z_AI_API_KEY`
286
+
287
+ ### Archive-only state
288
+
289
+ Hermes state that OpenClaw cannot safely interpret is copied into the migration report for manual review, but it is not loaded into live OpenClaw config or credentials. This preserves opaque or unsafe state without pretending OpenClaw can execute or trust it automatically:
290
+
291
+ - `plugins/`
292
+ - `sessions/`
293
+ - `logs/`
294
+ - `cron/`
295
+ - `mcp-tokens/`
296
+ - `state.db`
297
+
298
+ ### After applying
299
+
300
+ ```bash
301
+ openclaw doctor
302
+ ```
303
+
304
+ ## Plugin contract
305
+
306
+ Migration sources are plugins. A plugin declares its provider ids in `openclaw.plugin.json`:
307
+
308
+ ```json
309
+ {
310
+ "contracts": {
311
+ "migrationProviders": ["hermes"]
312
+ }
313
+ }
314
+ ```
315
+
316
+ At runtime the plugin calls `api.registerMigrationProvider(...)`. The provider implements `detect`, `plan`, and `apply`. Core owns CLI orchestration, backup policy, prompts, JSON output, and conflict preflight. Core passes the reviewed plan into `apply(ctx, plan)`, and providers may rebuild the plan only when that argument is absent for compatibility.
317
+
318
+ Provider plugins can use `openclaw/plugin-sdk/migration` for item construction and summary counts, plus `openclaw/plugin-sdk/migration-runtime` for conflict-aware file copies, archive-only report copies, cached config-runtime wrappers, and migration reports.
319
+
320
+ ## Onboarding integration
321
+
322
+ Onboarding can offer migration when a provider detects a known source. Both `openclaw onboard --flow import` and `openclaw setup --wizard --import-from hermes` use the same plugin migration provider and still show a preview before applying.
323
+
324
+ <Note>
325
+ Onboarding imports require a fresh OpenClaw setup. Reset config, credentials, sessions, and the workspace first if you already have local state. Backup-plus-overwrite or merge imports are feature-gated for existing setups.
326
+ </Note>
327
+
328
+ ## Related
329
+
330
+ - [Migrating from Hermes](/install/migrating-hermes): user-facing walkthrough.
331
+ - [Migrating from Claude](/install/migrating-claude): user-facing walkthrough.
332
+ - [Migrating](/install/migrating): move OpenClaw to a new machine.
333
+ - [Doctor](/gateway/doctor): health check after applying a migration.
334
+ - [Plugins](/tools/plugin): plugin install and registration.
@@ -0,0 +1,239 @@
1
+ ---
2
+ summary: "CLI reference for `openclaw models` (status/list/set/scan, aliases, fallbacks, auth)"
3
+ read_when:
4
+ - You want to change default models or view provider auth status
5
+ - You want to scan available models/providers and debug auth profiles
6
+ title: "Models"
7
+ ---
8
+
9
+ # `openclaw models`
10
+
11
+ Model discovery, scanning, and configuration (default model, fallbacks, auth profiles).
12
+
13
+ Related:
14
+
15
+ - Providers + models: [Models](/providers/models)
16
+ - Model selection concepts + `/models` slash command: [Models concept](/concepts/models)
17
+ - Provider auth setup: [Getting started](/start/getting-started)
18
+
19
+ ## Common commands
20
+
21
+ ```bash
22
+ openclaw models status
23
+ openclaw models list
24
+ openclaw models set <model-or-alias>
25
+ openclaw models scan
26
+ ```
27
+
28
+ `openclaw models status` shows the resolved default/fallbacks plus an auth overview.
29
+ When provider usage snapshots are available, the OAuth/API-key status section includes
30
+ provider usage windows and quota snapshots.
31
+ Current usage-window providers: Anthropic, GitHub Copilot, Gemini CLI, OpenAI,
32
+ MiniMax, Xiaomi, and z.ai. Usage auth comes from provider-specific hooks
33
+ when available; otherwise OpenClaw falls back to matching OAuth/API-key
34
+ credentials from auth profiles, env, or config.
35
+ In `--json` output, `auth.providers` is the env/config/store-aware provider
36
+ overview, while `auth.oauth` is auth-store profile health only.
37
+ Add `--probe` to run live auth probes against each configured provider profile.
38
+ Probes are real requests (may consume tokens and trigger rate limits).
39
+ Use `--agent <id>` to inspect a configured agent's model/auth state. When omitted,
40
+ the command uses `OPENCLAW_AGENT_DIR` if set, otherwise the
41
+ configured default agent.
42
+ Probe rows can come from auth profiles, env credentials, or `models.json`.
43
+ For OpenAI ChatGPT/Codex OAuth troubleshooting, `openclaw models status`,
44
+ `openclaw models auth list --provider openai`, and
45
+ `openclaw config get agents.defaults.model --json` are the quickest way to
46
+ confirm whether an agent has a usable `openai` OAuth profile for
47
+ `openai/*` through the native Codex runtime. See [OpenAI provider setup](/providers/openai#check-and-recover-codex-oauth-routing).
48
+
49
+ Notes:
50
+
51
+ - `models set <model-or-alias>` accepts `provider/model` or an alias.
52
+ - `models list` is read-only: it reads config, auth profiles, existing catalog
53
+ state, and provider-owned catalog rows, but it does not rewrite
54
+ `models.json`.
55
+ - The `Auth` column is provider-level and read-only. It is computed from local
56
+ auth profile metadata, env markers, configured provider keys, local-provider
57
+ markers, AWS Bedrock env/profile markers, and plugin synthetic-auth metadata;
58
+ it does not load provider runtime, read keychain secrets, call provider
59
+ APIs, or prove exact per-model execution readiness.
60
+ - `models list --all --provider <id>` can include provider-owned static catalog
61
+ rows from plugin manifests or bundled provider catalog metadata even when you
62
+ have not authenticated with that provider yet. Those rows still show as
63
+ unavailable until matching auth is configured.
64
+ - `models list` keeps the control plane responsive while provider catalog
65
+ discovery is slow. The default and configured views fall back to configured or
66
+ synthetic model rows after a short wait and let discovery finish in the
67
+ background. Use `--all` when you need the exact full discovered catalog and
68
+ are willing to wait for provider discovery.
69
+ - Broad `models list --all` merges manifest catalog rows over registry rows
70
+ without loading provider runtime supplement hooks. Provider-filtered manifest
71
+ fast paths use only providers marked `static`; providers marked `refreshable`
72
+ stay registry/cache-backed and append manifest rows as supplements, while
73
+ providers marked `runtime` stay on registry/runtime discovery.
74
+ - `models list` keeps native model metadata and runtime caps distinct. In table
75
+ output, `Ctx` shows `contextTokens/contextWindow` when an effective runtime
76
+ cap differs from the native context window; JSON rows include `contextTokens`
77
+ when a provider exposes that cap.
78
+ - `models list --provider <id>` filters by provider id, such as `moonshot` or
79
+ `openai`. It does not accept display labels from interactive provider
80
+ pickers, such as `Moonshot AI`.
81
+ - Model refs are parsed by splitting on the **first** `/`. If the model ID includes `/` (OpenRouter-style), include the provider prefix (example: `openrouter/moonshotai/kimi-k2`).
82
+ - If you omit the provider, OpenClaw resolves the input as an alias first, then
83
+ as a unique configured-provider match for that exact model id, and only then
84
+ falls back to the configured default provider with a deprecation warning.
85
+ If that provider no longer exposes the configured default model, OpenClaw
86
+ falls back to the first configured provider/model instead of surfacing a
87
+ stale removed-provider default.
88
+ - `models status` may show `marker(<value>)` in auth output for non-secret placeholders (for example `OPENAI_API_KEY`, `secretref-managed`, `minimax-oauth`, `oauth:chutes`, `ollama-local`) instead of masking them as secrets.
89
+
90
+ ### Models scan
91
+
92
+ `models scan` reads OpenRouter's public `:free` catalog and ranks candidates for
93
+ fallback use. The catalog itself is public, so metadata-only scans do not need
94
+ an OpenRouter key.
95
+
96
+ By default OpenClaw tries to probe tool and image support with live model calls.
97
+ If no OpenRouter key is configured, the command falls back to metadata-only
98
+ output and explains that `:free` models still require `OPENROUTER_API_KEY` for
99
+ probes and inference.
100
+
101
+ Options:
102
+
103
+ - `--no-probe` (metadata only; no config/secrets lookup)
104
+ - `--min-params <b>`
105
+ - `--max-age-days <days>`
106
+ - `--provider <name>`
107
+ - `--max-candidates <n>`
108
+ - `--timeout <ms>` (catalog request and per-probe timeout)
109
+ - `--concurrency <n>`
110
+ - `--yes`
111
+ - `--no-input`
112
+ - `--set-default`
113
+ - `--set-image`
114
+ - `--json`
115
+
116
+ `--set-default` and `--set-image` require live probes; metadata-only scan
117
+ results are informational and are not applied to config.
118
+
119
+ ### Models status
120
+
121
+ Options:
122
+
123
+ - `--json`
124
+ - `--plain`
125
+ - `--check` (exit 1=expired/missing, 2=expiring)
126
+ - `--probe` (live probe of configured auth profiles)
127
+ - `--probe-provider <name>` (probe one provider)
128
+ - `--probe-profile <id>` (repeat or comma-separated profile ids)
129
+ - `--probe-timeout <ms>`
130
+ - `--probe-concurrency <n>`
131
+ - `--probe-max-tokens <n>`
132
+ - `--agent <id>` (configured agent id; overrides `OPENCLAW_AGENT_DIR`)
133
+
134
+ `--json` keeps stdout reserved for the JSON payload. Auth-profile, provider,
135
+ and startup diagnostics are routed to stderr so scripts can pipe stdout directly
136
+ into tools such as `jq`.
137
+
138
+ Probe status buckets:
139
+
140
+ - `ok`
141
+ - `auth`
142
+ - `rate_limit`
143
+ - `billing`
144
+ - `timeout`
145
+ - `format`
146
+ - `unknown`
147
+ - `no_model`
148
+
149
+ Probe detail/reason-code cases to expect:
150
+
151
+ - `excluded_by_auth_order`: a stored profile exists, but explicit
152
+ `auth.order.<provider>` omitted it, so probe reports the exclusion instead of
153
+ trying it.
154
+ - `missing_credential`, `invalid_expires`, `expired`, `unresolved_ref`:
155
+ profile is present but not eligible/resolvable.
156
+ - `no_model`: provider auth exists, but OpenClaw could not resolve a probeable
157
+ model candidate for that provider.
158
+
159
+ ## Aliases + fallbacks
160
+
161
+ ```bash
162
+ openclaw models aliases list
163
+ openclaw models fallbacks list
164
+ ```
165
+
166
+ ## Auth profiles
167
+
168
+ ```bash
169
+ openclaw models auth add
170
+ openclaw models auth list [--provider <id>] [--json]
171
+ openclaw models auth login --provider <id>
172
+ openclaw models auth login --provider openai --profile-id openai:work
173
+ openclaw models auth paste-api-key --provider <id>
174
+ openclaw models auth setup-token --provider <id>
175
+ openclaw models auth paste-token
176
+ ```
177
+
178
+ `models auth add` is the interactive auth helper. It can launch a provider auth
179
+ flow (OAuth/API key) or guide you into manual token paste, depending on the
180
+ provider you choose.
181
+
182
+ `models auth list` lists saved auth profiles for the selected agent without
183
+ printing token, API-key, or OAuth secret material. Use `--provider <id>` to
184
+ filter to one provider, such as `openai`, and `--json` for scripting.
185
+
186
+ `models auth login` runs a provider plugin's auth flow (OAuth/API key). Use
187
+ `openclaw plugins list` to see which providers are installed.
188
+ Use `openclaw models auth --agent <id> <subcommand>` to write auth results to a
189
+ specific configured agent store. The parent `--agent` flag is honored by
190
+ `add`, `list`, `login`, `paste-api-key`, `setup-token`, `paste-token`, and
191
+ `login-github-copilot`.
192
+
193
+ For OpenAI models, `--provider openai` defaults to ChatGPT/Codex account login.
194
+ Use `--method api-key` only when you want to add an OpenAI API-key profile,
195
+ usually as a backup for Codex subscription limits. Run `openclaw doctor --fix`
196
+ to migrate older legacy OpenAI Codex prefix auth/profile state to `openai`.
197
+
198
+ Examples:
199
+
200
+ ```bash
201
+ openclaw models auth login --provider openai --set-default
202
+ openclaw models auth login --provider openai --method api-key
203
+ openclaw models auth paste-api-key --provider openai
204
+ openclaw models auth list --provider openai
205
+ ```
206
+
207
+ Notes:
208
+
209
+ - `login` accepts `--profile-id <id>` for providers that support named
210
+ profiles during login. Use this to keep multiple logins for the same
211
+ provider separate.
212
+ - `paste-api-key` accepts API keys generated elsewhere, prompts for the key
213
+ value, and writes it to the default profile id `<provider>:manual` unless you
214
+ pass `--profile-id`. In automation, pipe the key on stdin, for example
215
+ `printf "%s\n" "$OPENAI_API_KEY" | openclaw models auth paste-api-key --provider openai`.
216
+ - `setup-token` and `paste-token` remain generic token commands for providers
217
+ that expose token auth methods.
218
+ - `setup-token` requires an interactive TTY and runs the provider's token-auth
219
+ method (defaulting to that provider's `setup-token` method when it exposes
220
+ one).
221
+ - `paste-token` accepts a token string generated elsewhere or from automation.
222
+ - `paste-token` requires `--provider`, prompts for the token value by default,
223
+ and writes it to the default profile id `<provider>:manual` unless you pass
224
+ `--profile-id`.
225
+ - In automation, pipe the token on stdin instead of passing it as an argument so
226
+ provider credentials do not appear in shell history or process lists.
227
+ - `paste-token --expires-in <duration>` stores an absolute token expiry from a
228
+ relative duration such as `365d` or `12h`.
229
+ - For `openai`, OpenAI API keys and ChatGPT/OAuth token material are
230
+ different auth shapes. Use `paste-api-key` for `sk-...` OpenAI API keys and
231
+ `paste-token` only for token auth material.
232
+ - Anthropic note: Anthropic staff told us OpenClaw-style Claude CLI usage is allowed again, so OpenClaw treats Claude CLI reuse and `claude -p` usage as sanctioned for this integration unless Anthropic publishes a new policy.
233
+ - Anthropic `setup-token` / `paste-token` remain available as a supported OpenClaw token path, but OpenClaw now prefers Claude CLI reuse and `claude -p` when available.
234
+
235
+ ## Related
236
+
237
+ - [CLI reference](/cli)
238
+ - [Model selection](/concepts/model-providers)
239
+ - [Model failover](/concepts/model-failover)