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.
- package/CHANGELOG.md +12331 -0
- package/LICENSE +24 -0
- package/README.md +314 -0
- package/THIRD_PARTY_NOTICES.md +37 -0
- package/docs/.i18n/README.md +81 -0
- package/docs/.i18n/ar-navigation.json +18 -0
- package/docs/.i18n/de-navigation.json +18 -0
- package/docs/.i18n/es-navigation.json +18 -0
- package/docs/.i18n/fr-navigation.json +18 -0
- package/docs/.i18n/glossary.ar.json +82 -0
- package/docs/.i18n/glossary.de.json +82 -0
- package/docs/.i18n/glossary.es.json +82 -0
- package/docs/.i18n/glossary.fa.json +82 -0
- package/docs/.i18n/glossary.fr.json +82 -0
- package/docs/.i18n/glossary.id.json +82 -0
- package/docs/.i18n/glossary.it.json +82 -0
- package/docs/.i18n/glossary.ja-JP.json +102 -0
- package/docs/.i18n/glossary.ko.json +82 -0
- package/docs/.i18n/glossary.nl.json +82 -0
- package/docs/.i18n/glossary.pl.json +82 -0
- package/docs/.i18n/glossary.pt-BR.json +82 -0
- package/docs/.i18n/glossary.th.json +82 -0
- package/docs/.i18n/glossary.tr.json +82 -0
- package/docs/.i18n/glossary.uk.json +82 -0
- package/docs/.i18n/glossary.vi.json +82 -0
- package/docs/.i18n/glossary.zh-CN.json +1182 -0
- package/docs/.i18n/glossary.zh-TW.json +162 -0
- package/docs/.i18n/id-navigation.json +18 -0
- package/docs/.i18n/it-navigation.json +18 -0
- package/docs/.i18n/ja-navigation.json +18 -0
- package/docs/.i18n/ko-navigation.json +18 -0
- package/docs/.i18n/pl-navigation.json +18 -0
- package/docs/.i18n/pt-BR-navigation.json +18 -0
- package/docs/.i18n/tr-navigation.json +18 -0
- package/docs/.i18n/translation-workflow.md +111 -0
- package/docs/.i18n/zh-Hans-navigation.json +552 -0
- package/docs/AGENTS.md +36 -0
- package/docs/agent-runtime-architecture.md +48 -0
- package/docs/announcements/bluebubbles-imessage.md +79 -0
- package/docs/auth-credential-semantics.md +124 -0
- package/docs/automation/auth-monitoring.md +11 -0
- package/docs/automation/clawflow.md +12 -0
- package/docs/automation/cron-jobs.md +569 -0
- package/docs/automation/cron-vs-heartbeat.md +11 -0
- package/docs/automation/gmail-pubsub.md +11 -0
- package/docs/automation/hooks.md +387 -0
- package/docs/automation/index.md +135 -0
- package/docs/automation/poll.md +12 -0
- package/docs/automation/standing-orders.md +250 -0
- package/docs/automation/taskflow.md +155 -0
- package/docs/automation/tasks.md +374 -0
- package/docs/automation/troubleshooting.md +12 -0
- package/docs/automation/webhook.md +12 -0
- package/docs/brave-search.md +11 -0
- package/docs/channels/access-groups.md +201 -0
- package/docs/channels/ambient-room-events.md +214 -0
- package/docs/channels/bot-loop-protection.md +131 -0
- package/docs/channels/broadcast-groups.md +472 -0
- package/docs/channels/channel-routing.md +162 -0
- package/docs/channels/clickclack.md +146 -0
- package/docs/channels/discord.md +1758 -0
- package/docs/channels/feishu.md +654 -0
- package/docs/channels/googlechat.md +286 -0
- package/docs/channels/group-messages.md +95 -0
- package/docs/channels/groups.md +610 -0
- package/docs/channels/imessage-from-bluebubbles.md +259 -0
- package/docs/channels/imessage.md +864 -0
- package/docs/channels/index.md +65 -0
- package/docs/channels/irc.md +253 -0
- package/docs/channels/line.md +243 -0
- package/docs/channels/location.md +71 -0
- package/docs/channels/matrix-migration.md +375 -0
- package/docs/channels/matrix-presentation.md +77 -0
- package/docs/channels/matrix-push-rules.md +150 -0
- package/docs/channels/matrix.md +935 -0
- package/docs/channels/mattermost.md +542 -0
- package/docs/channels/msteams.md +1097 -0
- package/docs/channels/nextcloud-talk.md +176 -0
- package/docs/channels/nostr.md +253 -0
- package/docs/channels/pairing.md +214 -0
- package/docs/channels/qqbot.md +317 -0
- package/docs/channels/signal.md +417 -0
- package/docs/channels/slack.md +1623 -0
- package/docs/channels/sms.md +380 -0
- package/docs/channels/synology-chat.md +187 -0
- package/docs/channels/telegram.md +1121 -0
- package/docs/channels/tlon.md +296 -0
- package/docs/channels/troubleshooting.md +162 -0
- package/docs/channels/twitch.md +431 -0
- package/docs/channels/wechat.md +171 -0
- package/docs/channels/whatsapp.md +796 -0
- package/docs/channels/yuanbao.md +416 -0
- package/docs/channels/zalo.md +253 -0
- package/docs/channels/zalouser.md +217 -0
- package/docs/ci.md +665 -0
- package/docs/clawhub/cli.md +82 -0
- package/docs/clawhub/publishing.md +96 -0
- package/docs/cli/acp.md +370 -0
- package/docs/cli/agent.md +109 -0
- package/docs/cli/agents.md +253 -0
- package/docs/cli/approvals.md +193 -0
- package/docs/cli/backup.md +98 -0
- package/docs/cli/browser.md +322 -0
- package/docs/cli/channels.md +154 -0
- package/docs/cli/clawbot.md +25 -0
- package/docs/cli/commitments.md +90 -0
- package/docs/cli/completion.md +39 -0
- package/docs/cli/config.md +504 -0
- package/docs/cli/configure.md +77 -0
- package/docs/cli/crestodian.md +337 -0
- package/docs/cli/cron.md +344 -0
- package/docs/cli/daemon.md +67 -0
- package/docs/cli/dashboard.md +33 -0
- package/docs/cli/devices.md +240 -0
- package/docs/cli/directory.md +68 -0
- package/docs/cli/dns.md +53 -0
- package/docs/cli/docs.md +63 -0
- package/docs/cli/doctor.md +254 -0
- package/docs/cli/flows.md +52 -0
- package/docs/cli/gateway.md +572 -0
- package/docs/cli/health.md +43 -0
- package/docs/cli/hooks.md +345 -0
- package/docs/cli/index.md +406 -0
- package/docs/cli/infer.md +364 -0
- package/docs/cli/logs.md +68 -0
- package/docs/cli/mcp.md +851 -0
- package/docs/cli/memory.md +183 -0
- package/docs/cli/message.md +317 -0
- package/docs/cli/migrate.md +334 -0
- package/docs/cli/models.md +239 -0
- package/docs/cli/node.md +178 -0
- package/docs/cli/nodes.md +76 -0
- package/docs/cli/onboard.md +251 -0
- package/docs/cli/pairing.md +77 -0
- package/docs/cli/path.md +511 -0
- package/docs/cli/plugins.md +480 -0
- package/docs/cli/policy.md +929 -0
- package/docs/cli/proxy.md +89 -0
- package/docs/cli/qr.md +56 -0
- package/docs/cli/reset.md +39 -0
- package/docs/cli/sandbox.md +208 -0
- package/docs/cli/secrets.md +202 -0
- package/docs/cli/security.md +135 -0
- package/docs/cli/sessions.md +178 -0
- package/docs/cli/setup.md +60 -0
- package/docs/cli/skills.md +156 -0
- package/docs/cli/status.md +45 -0
- package/docs/cli/system.md +89 -0
- package/docs/cli/tasks.md +111 -0
- package/docs/cli/transcripts.md +151 -0
- package/docs/cli/tui.md +92 -0
- package/docs/cli/uninstall.md +45 -0
- package/docs/cli/update.md +283 -0
- package/docs/cli/voicecall.md +204 -0
- package/docs/cli/webhooks.md +117 -0
- package/docs/cli/wiki.md +256 -0
- package/docs/cli/workboard.md +228 -0
- package/docs/concepts/active-memory.md +856 -0
- package/docs/concepts/agent-loop.md +185 -0
- package/docs/concepts/agent-runtimes.md +276 -0
- package/docs/concepts/agent-workspace.md +230 -0
- package/docs/concepts/agent.md +142 -0
- package/docs/concepts/architecture.md +154 -0
- package/docs/concepts/channel-docking.md +145 -0
- package/docs/concepts/commitments.md +150 -0
- package/docs/concepts/compaction.md +203 -0
- package/docs/concepts/context-engine.md +347 -0
- package/docs/concepts/context.md +199 -0
- package/docs/concepts/delegate-architecture.md +319 -0
- package/docs/concepts/dreaming.md +279 -0
- package/docs/concepts/experimental-features.md +111 -0
- package/docs/concepts/features.md +91 -0
- package/docs/concepts/mantis-slack-desktop-runbook.md +231 -0
- package/docs/concepts/mantis.md +744 -0
- package/docs/concepts/markdown-formatting.md +139 -0
- package/docs/concepts/memory-builtin.md +151 -0
- package/docs/concepts/memory-honcho.md +144 -0
- package/docs/concepts/memory-qmd.md +277 -0
- package/docs/concepts/memory-search.md +175 -0
- package/docs/concepts/memory.md +299 -0
- package/docs/concepts/message-lifecycle-refactor.md +1126 -0
- package/docs/concepts/messages.md +216 -0
- package/docs/concepts/model-failover.md +405 -0
- package/docs/concepts/model-providers.md +719 -0
- package/docs/concepts/models.md +371 -0
- package/docs/concepts/multi-agent.md +625 -0
- package/docs/concepts/oauth.md +218 -0
- package/docs/concepts/parallel-specialist-lanes.md +127 -0
- package/docs/concepts/personal-agent-benchmark-pack.md +74 -0
- package/docs/concepts/presence.md +117 -0
- package/docs/concepts/progress-drafts.md +406 -0
- package/docs/concepts/qa-e2e-automation.md +979 -0
- package/docs/concepts/qa-matrix.md +139 -0
- package/docs/concepts/queue-steering.md +90 -0
- package/docs/concepts/queue.md +136 -0
- package/docs/concepts/retry.md +86 -0
- package/docs/concepts/session-pruning.md +104 -0
- package/docs/concepts/session-tool.md +201 -0
- package/docs/concepts/session.md +164 -0
- package/docs/concepts/soul.md +116 -0
- package/docs/concepts/streaming.md +258 -0
- package/docs/concepts/system-prompt.md +330 -0
- package/docs/concepts/timezone.md +47 -0
- package/docs/concepts/typebox.md +309 -0
- package/docs/concepts/typing-indicators.md +88 -0
- package/docs/concepts/usage-tracking.md +72 -0
- package/docs/date-time.md +126 -0
- package/docs/debug/node-issue.md +90 -0
- package/docs/diagnostics/flags.md +182 -0
- package/docs/docs.json +1885 -0
- package/docs/gateway/authentication.md +286 -0
- package/docs/gateway/background-process.md +147 -0
- package/docs/gateway/bonjour.md +303 -0
- package/docs/gateway/bridge-protocol.md +97 -0
- package/docs/gateway/cli-backends.md +463 -0
- package/docs/gateway/config-agents.md +1525 -0
- package/docs/gateway/config-channels.md +942 -0
- package/docs/gateway/config-tools.md +806 -0
- package/docs/gateway/configuration-examples.md +706 -0
- package/docs/gateway/configuration-reference.md +1449 -0
- package/docs/gateway/configuration.md +748 -0
- package/docs/gateway/diagnostics.md +213 -0
- package/docs/gateway/discovery.md +154 -0
- package/docs/gateway/doctor.md +576 -0
- package/docs/gateway/external-apps.md +86 -0
- package/docs/gateway/gateway-lock.md +37 -0
- package/docs/gateway/health.md +73 -0
- package/docs/gateway/heartbeat.md +498 -0
- package/docs/gateway/index.md +385 -0
- package/docs/gateway/local-model-services.md +205 -0
- package/docs/gateway/local-models.md +355 -0
- package/docs/gateway/logging.md +149 -0
- package/docs/gateway/multiple-gateways.md +178 -0
- package/docs/gateway/network-model.md +15 -0
- package/docs/gateway/openai-http-api.md +379 -0
- package/docs/gateway/openresponses-http-api.md +349 -0
- package/docs/gateway/openshell.md +316 -0
- package/docs/gateway/opentelemetry.md +440 -0
- package/docs/gateway/operator-scopes.md +119 -0
- package/docs/gateway/pairing.md +207 -0
- package/docs/gateway/prometheus.md +249 -0
- package/docs/gateway/protocol.md +839 -0
- package/docs/gateway/remote-gateway-readme.md +169 -0
- package/docs/gateway/remote.md +280 -0
- package/docs/gateway/sandbox-vs-tool-policy-vs-elevated.md +148 -0
- package/docs/gateway/sandboxing.md +546 -0
- package/docs/gateway/secrets-plan-contract.md +159 -0
- package/docs/gateway/secrets.md +805 -0
- package/docs/gateway/security/audit-checks.md +127 -0
- package/docs/gateway/security/exposure-runbook.md +212 -0
- package/docs/gateway/security/index.md +1344 -0
- package/docs/gateway/security/secure-file-operations.md +76 -0
- package/docs/gateway/security/shrinkwrap.md +111 -0
- package/docs/gateway/tailscale.md +180 -0
- package/docs/gateway/tools-invoke-http-api.md +175 -0
- package/docs/gateway/troubleshooting.md +881 -0
- package/docs/gateway/trusted-proxy-auth.md +483 -0
- package/docs/help/debugging.md +341 -0
- package/docs/help/environment.md +240 -0
- package/docs/help/faq-first-run.md +872 -0
- package/docs/help/faq-models.md +557 -0
- package/docs/help/faq.md +2115 -0
- package/docs/help/index.md +39 -0
- package/docs/help/scripts.md +56 -0
- package/docs/help/testing-live.md +592 -0
- package/docs/help/testing-updates-plugins.md +299 -0
- package/docs/help/testing.md +977 -0
- package/docs/help/troubleshooting.md +500 -0
- package/docs/index.md +196 -0
- package/docs/install/ansible.md +233 -0
- package/docs/install/azure.md +315 -0
- package/docs/install/bun.md +59 -0
- package/docs/install/clawdock.md +112 -0
- package/docs/install/development-channels.md +148 -0
- package/docs/install/digitalocean.md +174 -0
- package/docs/install/docker-vm-runtime.md +154 -0
- package/docs/install/docker.md +564 -0
- package/docs/install/exe-dev.md +201 -0
- package/docs/install/fly.md +524 -0
- package/docs/install/gcp.md +418 -0
- package/docs/install/hetzner.md +285 -0
- package/docs/install/hostinger.md +98 -0
- package/docs/install/index.md +236 -0
- package/docs/install/installer.md +447 -0
- package/docs/install/kubernetes.md +196 -0
- package/docs/install/macos-vm.md +281 -0
- package/docs/install/migrating-claude.md +165 -0
- package/docs/install/migrating-hermes.md +178 -0
- package/docs/install/migrating.md +137 -0
- package/docs/install/nix.md +112 -0
- package/docs/install/node.md +142 -0
- package/docs/install/northflank.mdx +44 -0
- package/docs/install/oracle.md +218 -0
- package/docs/install/podman.md +216 -0
- package/docs/install/railway.mdx +92 -0
- package/docs/install/raspberry-pi.md +234 -0
- package/docs/install/render.mdx +167 -0
- package/docs/install/uninstall.md +140 -0
- package/docs/install/updating.md +284 -0
- package/docs/install/upstash.md +96 -0
- package/docs/logging.md +322 -0
- package/docs/maturity-scores.yaml +5361 -0
- package/docs/nav-tabs-underline.js +104 -0
- package/docs/network.md +72 -0
- package/docs/nodes/audio.md +216 -0
- package/docs/nodes/camera.md +166 -0
- package/docs/nodes/images.md +77 -0
- package/docs/nodes/index.md +444 -0
- package/docs/nodes/location-command.md +102 -0
- package/docs/nodes/media-understanding.md +495 -0
- package/docs/nodes/talk.md +160 -0
- package/docs/nodes/troubleshooting.md +123 -0
- package/docs/nodes/voicewake.md +93 -0
- package/docs/openclaw-agent-runtime.md +82 -0
- package/docs/perplexity.md +11 -0
- package/docs/plan/codex-context-engine-harness.md +624 -0
- package/docs/plan/ui-channels.md +284 -0
- package/docs/platforms/android.md +286 -0
- package/docs/platforms/digitalocean.md +12 -0
- package/docs/platforms/easyrunner.md +109 -0
- package/docs/platforms/index.md +65 -0
- package/docs/platforms/ios.md +287 -0
- package/docs/platforms/linux.md +141 -0
- package/docs/platforms/mac/bundled-gateway.md +79 -0
- package/docs/platforms/mac/canvas.md +128 -0
- package/docs/platforms/mac/child-process.md +72 -0
- package/docs/platforms/mac/dev-setup.md +112 -0
- package/docs/platforms/mac/health.md +39 -0
- package/docs/platforms/mac/icon.md +36 -0
- package/docs/platforms/mac/logging.md +62 -0
- package/docs/platforms/mac/menu-bar.md +93 -0
- package/docs/platforms/mac/peekaboo.md +96 -0
- package/docs/platforms/mac/permissions.md +73 -0
- package/docs/platforms/mac/remote.md +123 -0
- package/docs/platforms/mac/signing.md +52 -0
- package/docs/platforms/mac/skills.md +45 -0
- package/docs/platforms/mac/voice-overlay.md +66 -0
- package/docs/platforms/mac/voicewake.md +79 -0
- package/docs/platforms/mac/webchat.md +54 -0
- package/docs/platforms/mac/xpc.md +66 -0
- package/docs/platforms/macos.md +228 -0
- package/docs/platforms/oracle.md +12 -0
- package/docs/platforms/raspberry-pi.md +13 -0
- package/docs/platforms/windows.md +304 -0
- package/docs/plugins/adding-capabilities.md +146 -0
- package/docs/plugins/admin-http-rpc.md +216 -0
- package/docs/plugins/agent-tools.md +13 -0
- package/docs/plugins/architecture-internals.md +1203 -0
- package/docs/plugins/architecture.md +483 -0
- package/docs/plugins/building-extensions.md +13 -0
- package/docs/plugins/building-plugins.md +343 -0
- package/docs/plugins/bundles.md +310 -0
- package/docs/plugins/cli-backend-plugins.md +328 -0
- package/docs/plugins/codex-computer-use.md +297 -0
- package/docs/plugins/codex-harness-reference.md +480 -0
- package/docs/plugins/codex-harness-runtime.md +268 -0
- package/docs/plugins/codex-harness.md +800 -0
- package/docs/plugins/codex-native-plugins.md +280 -0
- package/docs/plugins/community.md +77 -0
- package/docs/plugins/compatibility.md +198 -0
- package/docs/plugins/copilot.md +355 -0
- package/docs/plugins/dependency-resolution.md +176 -0
- package/docs/plugins/google-meet.md +1737 -0
- package/docs/plugins/hooks.md +525 -0
- package/docs/plugins/install-overrides.md +80 -0
- package/docs/plugins/llama-cpp.md +58 -0
- package/docs/plugins/manage-plugins.md +214 -0
- package/docs/plugins/manifest.md +1468 -0
- package/docs/plugins/memory-lancedb.md +385 -0
- package/docs/plugins/memory-wiki.md +529 -0
- package/docs/plugins/message-presentation.md +487 -0
- package/docs/plugins/oc-path.md +166 -0
- package/docs/plugins/plugin-inventory.md +318 -0
- package/docs/plugins/plugin-permission-requests.md +193 -0
- package/docs/plugins/reference/acpx.md +23 -0
- package/docs/plugins/reference/admin-http-rpc.md +23 -0
- package/docs/plugins/reference/alibaba.md +23 -0
- package/docs/plugins/reference/amazon-bedrock-mantle.md +23 -0
- package/docs/plugins/reference/amazon-bedrock.md +23 -0
- package/docs/plugins/reference/anthropic-vertex.md +29 -0
- package/docs/plugins/reference/anthropic.md +23 -0
- package/docs/plugins/reference/arcee.md +23 -0
- package/docs/plugins/reference/azure-speech.md +23 -0
- package/docs/plugins/reference/bonjour.md +19 -0
- package/docs/plugins/reference/brave.md +23 -0
- package/docs/plugins/reference/browser.md +23 -0
- package/docs/plugins/reference/byteplus.md +19 -0
- package/docs/plugins/reference/canvas.md +19 -0
- package/docs/plugins/reference/cerebras.md +23 -0
- package/docs/plugins/reference/chutes.md +23 -0
- package/docs/plugins/reference/clickclack.md +23 -0
- package/docs/plugins/reference/cloudflare-ai-gateway.md +23 -0
- package/docs/plugins/reference/codex-supervisor.md +27 -0
- package/docs/plugins/reference/codex.md +23 -0
- package/docs/plugins/reference/comfy.md +23 -0
- package/docs/plugins/reference/copilot-proxy.md +19 -0
- package/docs/plugins/reference/copilot.md +23 -0
- package/docs/plugins/reference/deepgram.md +23 -0
- package/docs/plugins/reference/deepinfra.md +23 -0
- package/docs/plugins/reference/deepseek.md +23 -0
- package/docs/plugins/reference/diagnostics-otel.md +19 -0
- package/docs/plugins/reference/diagnostics-prometheus.md +19 -0
- package/docs/plugins/reference/diffs-language-pack.md +31 -0
- package/docs/plugins/reference/diffs.md +19 -0
- package/docs/plugins/reference/discord.md +23 -0
- package/docs/plugins/reference/document-extract.md +23 -0
- package/docs/plugins/reference/duckduckgo.md +23 -0
- package/docs/plugins/reference/elevenlabs.md +23 -0
- package/docs/plugins/reference/exa.md +23 -0
- package/docs/plugins/reference/fal.md +23 -0
- package/docs/plugins/reference/feishu.md +23 -0
- package/docs/plugins/reference/file-transfer.md +19 -0
- package/docs/plugins/reference/firecrawl.md +23 -0
- package/docs/plugins/reference/fireworks.md +23 -0
- package/docs/plugins/reference/github-copilot.md +23 -0
- package/docs/plugins/reference/gmi.md +23 -0
- package/docs/plugins/reference/google-meet.md +23 -0
- package/docs/plugins/reference/google.md +23 -0
- package/docs/plugins/reference/googlechat.md +23 -0
- package/docs/plugins/reference/gradium.md +23 -0
- package/docs/plugins/reference/groq.md +23 -0
- package/docs/plugins/reference/huggingface.md +23 -0
- package/docs/plugins/reference/imessage.md +23 -0
- package/docs/plugins/reference/inworld.md +23 -0
- package/docs/plugins/reference/irc.md +23 -0
- package/docs/plugins/reference/kilocode.md +23 -0
- package/docs/plugins/reference/kimi.md +23 -0
- package/docs/plugins/reference/line.md +23 -0
- package/docs/plugins/reference/litellm.md +23 -0
- package/docs/plugins/reference/llama-cpp.md +23 -0
- package/docs/plugins/reference/llm-task.md +19 -0
- package/docs/plugins/reference/lmstudio.md +23 -0
- package/docs/plugins/reference/lobster.md +19 -0
- package/docs/plugins/reference/matrix.md +23 -0
- package/docs/plugins/reference/mattermost.md +23 -0
- package/docs/plugins/reference/memory-core.md +19 -0
- package/docs/plugins/reference/memory-lancedb.md +23 -0
- package/docs/plugins/reference/memory-wiki.md +23 -0
- package/docs/plugins/reference/microsoft-foundry.md +113 -0
- package/docs/plugins/reference/microsoft.md +19 -0
- package/docs/plugins/reference/migrate-claude.md +19 -0
- package/docs/plugins/reference/migrate-hermes.md +19 -0
- package/docs/plugins/reference/minimax.md +23 -0
- package/docs/plugins/reference/mistral.md +23 -0
- package/docs/plugins/reference/moonshot.md +23 -0
- package/docs/plugins/reference/msteams.md +23 -0
- package/docs/plugins/reference/nextcloud-talk.md +23 -0
- package/docs/plugins/reference/nostr.md +23 -0
- package/docs/plugins/reference/novita.md +23 -0
- package/docs/plugins/reference/nvidia.md +23 -0
- package/docs/plugins/reference/oc-path.md +23 -0
- package/docs/plugins/reference/ollama.md +24 -0
- package/docs/plugins/reference/open-prose.md +19 -0
- package/docs/plugins/reference/openai.md +23 -0
- package/docs/plugins/reference/opencode-go.md +23 -0
- package/docs/plugins/reference/opencode.md +23 -0
- package/docs/plugins/reference/openrouter.md +23 -0
- package/docs/plugins/reference/openshell.md +19 -0
- package/docs/plugins/reference/perplexity.md +23 -0
- package/docs/plugins/reference/pixverse.md +23 -0
- package/docs/plugins/reference/policy.md +79 -0
- package/docs/plugins/reference/qa-channel.md +23 -0
- package/docs/plugins/reference/qa-lab.md +19 -0
- package/docs/plugins/reference/qa-matrix.md +19 -0
- package/docs/plugins/reference/qianfan.md +23 -0
- package/docs/plugins/reference/qqbot.md +23 -0
- package/docs/plugins/reference/qwen.md +24 -0
- package/docs/plugins/reference/runway.md +23 -0
- package/docs/plugins/reference/searxng.md +19 -0
- package/docs/plugins/reference/senseaudio.md +23 -0
- package/docs/plugins/reference/sglang.md +23 -0
- package/docs/plugins/reference/signal.md +23 -0
- package/docs/plugins/reference/slack.md +23 -0
- package/docs/plugins/reference/sms.md +23 -0
- package/docs/plugins/reference/stepfun.md +23 -0
- package/docs/plugins/reference/synology-chat.md +23 -0
- package/docs/plugins/reference/synthetic.md +23 -0
- package/docs/plugins/reference/tavily.md +23 -0
- package/docs/plugins/reference/telegram.md +23 -0
- package/docs/plugins/reference/tencent.md +23 -0
- package/docs/plugins/reference/tlon.md +23 -0
- package/docs/plugins/reference/together.md +23 -0
- package/docs/plugins/reference/tokenjuice.md +23 -0
- package/docs/plugins/reference/tts-local-cli.md +19 -0
- package/docs/plugins/reference/twitch.md +23 -0
- package/docs/plugins/reference/venice.md +23 -0
- package/docs/plugins/reference/vercel-ai-gateway.md +23 -0
- package/docs/plugins/reference/vllm.md +23 -0
- package/docs/plugins/reference/voice-call.md +23 -0
- package/docs/plugins/reference/volcengine.md +23 -0
- package/docs/plugins/reference/voyage.md +19 -0
- package/docs/plugins/reference/vydra.md +23 -0
- package/docs/plugins/reference/web-readability.md +19 -0
- package/docs/plugins/reference/webhooks.md +23 -0
- package/docs/plugins/reference/whatsapp.md +23 -0
- package/docs/plugins/reference/workboard.md +23 -0
- package/docs/plugins/reference/xai.md +23 -0
- package/docs/plugins/reference/xiaomi.md +23 -0
- package/docs/plugins/reference/zai.md +23 -0
- package/docs/plugins/reference/zalo.md +23 -0
- package/docs/plugins/reference/zalouser.md +24 -0
- package/docs/plugins/reference.md +19 -0
- package/docs/plugins/sdk-agent-harness.md +339 -0
- package/docs/plugins/sdk-channel-inbound.md +70 -0
- package/docs/plugins/sdk-channel-ingress.md +137 -0
- package/docs/plugins/sdk-channel-message.md +18 -0
- package/docs/plugins/sdk-channel-outbound.md +113 -0
- package/docs/plugins/sdk-channel-plugins.md +770 -0
- package/docs/plugins/sdk-channel-turn.md +9 -0
- package/docs/plugins/sdk-entrypoints.md +344 -0
- package/docs/plugins/sdk-migration.md +1011 -0
- package/docs/plugins/sdk-overview.md +525 -0
- package/docs/plugins/sdk-provider-plugins.md +1019 -0
- package/docs/plugins/sdk-runtime.md +683 -0
- package/docs/plugins/sdk-setup.md +550 -0
- package/docs/plugins/sdk-subpaths.md +401 -0
- package/docs/plugins/sdk-testing.md +403 -0
- package/docs/plugins/tool-plugins.md +411 -0
- package/docs/plugins/voice-call.md +942 -0
- package/docs/plugins/webhooks.md +192 -0
- package/docs/plugins/workboard.md +402 -0
- package/docs/plugins/zalouser.md +86 -0
- package/docs/prose.md +191 -0
- package/docs/providers/alibaba.md +158 -0
- package/docs/providers/anthropic.md +386 -0
- package/docs/providers/arcee.md +144 -0
- package/docs/providers/azure-speech.md +119 -0
- package/docs/providers/bedrock-mantle.md +224 -0
- package/docs/providers/bedrock.md +433 -0
- package/docs/providers/cerebras.md +130 -0
- package/docs/providers/chutes.md +153 -0
- package/docs/providers/claude-max-api-proxy.md +191 -0
- package/docs/providers/cloudflare-ai-gateway.md +119 -0
- package/docs/providers/comfy.md +362 -0
- package/docs/providers/deepgram.md +184 -0
- package/docs/providers/deepinfra.md +92 -0
- package/docs/providers/deepseek.md +146 -0
- package/docs/providers/ds4.md +309 -0
- package/docs/providers/elevenlabs.md +130 -0
- package/docs/providers/fal.md +240 -0
- package/docs/providers/fireworks.md +144 -0
- package/docs/providers/github-copilot.md +257 -0
- package/docs/providers/gmi.md +92 -0
- package/docs/providers/google.md +472 -0
- package/docs/providers/gradium.md +123 -0
- package/docs/providers/groq.md +171 -0
- package/docs/providers/huggingface.md +235 -0
- package/docs/providers/index.md +105 -0
- package/docs/providers/inferrs.md +272 -0
- package/docs/providers/inworld.md +120 -0
- package/docs/providers/kilocode.md +135 -0
- package/docs/providers/litellm.md +234 -0
- package/docs/providers/lmstudio.md +224 -0
- package/docs/providers/minimax.md +518 -0
- package/docs/providers/mistral.md +235 -0
- package/docs/providers/models.md +64 -0
- package/docs/providers/moonshot.md +413 -0
- package/docs/providers/novita.md +92 -0
- package/docs/providers/nvidia.md +208 -0
- package/docs/providers/ollama-cloud.md +115 -0
- package/docs/providers/ollama.md +1225 -0
- package/docs/providers/openai.md +1091 -0
- package/docs/providers/opencode-go.md +123 -0
- package/docs/providers/opencode.md +149 -0
- package/docs/providers/openrouter.md +390 -0
- package/docs/providers/perplexity-provider.md +123 -0
- package/docs/providers/pixverse.md +165 -0
- package/docs/providers/qianfan.md +132 -0
- package/docs/providers/qwen-oauth.md +115 -0
- package/docs/providers/qwen.md +364 -0
- package/docs/providers/runway.md +103 -0
- package/docs/providers/senseaudio.md +68 -0
- package/docs/providers/sglang.md +161 -0
- package/docs/providers/stepfun.md +229 -0
- package/docs/providers/synthetic.md +154 -0
- package/docs/providers/tencent.md +130 -0
- package/docs/providers/together.md +140 -0
- package/docs/providers/venice.md +312 -0
- package/docs/providers/vercel-ai-gateway.md +128 -0
- package/docs/providers/vllm.md +407 -0
- package/docs/providers/volcengine.md +199 -0
- package/docs/providers/vydra.md +180 -0
- package/docs/providers/xai.md +571 -0
- package/docs/providers/xiaomi.md +286 -0
- package/docs/providers/zai.md +224 -0
- package/docs/refactor/access.md +9 -0
- package/docs/refactor/acp.md +298 -0
- package/docs/refactor/canvas.md +131 -0
- package/docs/refactor/database-first.md +2263 -0
- package/docs/refactor/ingress-core.md +341 -0
- package/docs/reference/AGENTS.default.md +131 -0
- package/docs/reference/RELEASING.md +844 -0
- package/docs/reference/api-usage-costs.md +208 -0
- package/docs/reference/application-modernization-plan.md +208 -0
- package/docs/reference/code-mode.md +1058 -0
- package/docs/reference/credits.md +33 -0
- package/docs/reference/device-models.md +50 -0
- package/docs/reference/full-release-validation.md +206 -0
- package/docs/reference/memory-config.md +630 -0
- package/docs/reference/prompt-caching.md +358 -0
- package/docs/reference/release-performance-sweep.md +347 -0
- package/docs/reference/rich-output-protocol.md +93 -0
- package/docs/reference/rpc.md +43 -0
- package/docs/reference/secret-placeholder-conventions.md +33 -0
- package/docs/reference/secretref-credential-surface.md +163 -0
- package/docs/reference/secretref-user-supplied-credentials-matrix.json +691 -0
- package/docs/reference/session-management-compaction.md +474 -0
- package/docs/reference/templates/AGENTS.dev.md +90 -0
- package/docs/reference/templates/AGENTS.md +227 -0
- package/docs/reference/templates/BOOT.md +16 -0
- package/docs/reference/templates/BOOTSTRAP.md +66 -0
- package/docs/reference/templates/HEARTBEAT.md +24 -0
- package/docs/reference/templates/IDENTITY.dev.md +52 -0
- package/docs/reference/templates/IDENTITY.md +34 -0
- package/docs/reference/templates/SOUL.dev.md +82 -0
- package/docs/reference/templates/SOUL.md +49 -0
- package/docs/reference/templates/TOOLS.dev.md +29 -0
- package/docs/reference/templates/TOOLS.md +51 -0
- package/docs/reference/templates/USER.dev.md +23 -0
- package/docs/reference/templates/USER.md +28 -0
- package/docs/reference/test.md +248 -0
- package/docs/reference/token-use.md +246 -0
- package/docs/reference/transcript-hygiene.md +226 -0
- package/docs/reference/wizard.md +252 -0
- package/docs/security/CONTRIBUTING-THREAT-MODEL.md +101 -0
- package/docs/security/THREAT-MODEL-ATLAS.md +611 -0
- package/docs/security/formal-verification.md +170 -0
- package/docs/security/incident-response.md +59 -0
- package/docs/security/network-proxy.md +268 -0
- package/docs/snippets/plugin-publish/minimal-openclaw.plugin.json +12 -0
- package/docs/snippets/plugin-publish/minimal-package.json +16 -0
- package/docs/specs/claw-supervisor.md +247 -0
- package/docs/start/bootstrapping.md +49 -0
- package/docs/start/docs-directory.md +69 -0
- package/docs/start/getting-started.md +152 -0
- package/docs/start/hubs.md +201 -0
- package/docs/start/lore.md +223 -0
- package/docs/start/onboarding-overview.md +72 -0
- package/docs/start/onboarding.md +98 -0
- package/docs/start/openclaw.md +246 -0
- package/docs/start/quickstart.md +25 -0
- package/docs/start/setup.md +178 -0
- package/docs/start/showcase.md +371 -0
- package/docs/start/wizard-cli-automation.md +232 -0
- package/docs/start/wizard-cli-reference.md +331 -0
- package/docs/start/wizard.md +142 -0
- package/docs/style.css +137 -0
- package/docs/tools/acp-agents-setup.md +356 -0
- package/docs/tools/acp-agents.md +865 -0
- package/docs/tools/agent-send.md +130 -0
- package/docs/tools/apply-patch.md +64 -0
- package/docs/tools/brave-search.md +139 -0
- package/docs/tools/browser-control.md +405 -0
- package/docs/tools/browser-linux-troubleshooting.md +173 -0
- package/docs/tools/browser-login.md +77 -0
- package/docs/tools/browser-wsl2-windows-remote-cdp-troubleshooting.md +219 -0
- package/docs/tools/browser.md +866 -0
- package/docs/tools/btw.md +159 -0
- package/docs/tools/capability-cookbook.md +12 -0
- package/docs/tools/clawhub.md +5 -0
- package/docs/tools/code-execution.md +173 -0
- package/docs/tools/creating-skills.md +271 -0
- package/docs/tools/diffs.md +527 -0
- package/docs/tools/duckduckgo-search.md +109 -0
- package/docs/tools/elevated.md +128 -0
- package/docs/tools/exa-search.md +152 -0
- package/docs/tools/exec-approvals-advanced.md +457 -0
- package/docs/tools/exec-approvals.md +520 -0
- package/docs/tools/exec.md +294 -0
- package/docs/tools/firecrawl.md +155 -0
- package/docs/tools/gemini-search.md +114 -0
- package/docs/tools/goal.md +217 -0
- package/docs/tools/grok-search.md +129 -0
- package/docs/tools/image-generation.md +538 -0
- package/docs/tools/index.md +176 -0
- package/docs/tools/kimi-search.md +105 -0
- package/docs/tools/llm-task.md +137 -0
- package/docs/tools/lobster.md +365 -0
- package/docs/tools/loop-detection.md +154 -0
- package/docs/tools/media-overview.md +161 -0
- package/docs/tools/minimax-search.md +102 -0
- package/docs/tools/multi-agent-sandbox-tools.md +409 -0
- package/docs/tools/music-generation.md +372 -0
- package/docs/tools/ollama-search.md +153 -0
- package/docs/tools/parallel-search.md +154 -0
- package/docs/tools/pdf.md +213 -0
- package/docs/tools/permission-modes.md +111 -0
- package/docs/tools/perplexity-search.md +220 -0
- package/docs/tools/plugin.md +378 -0
- package/docs/tools/reactions.md +100 -0
- package/docs/tools/searxng-search.md +141 -0
- package/docs/tools/skill-workshop.md +283 -0
- package/docs/tools/skills-config.md +457 -0
- package/docs/tools/skills.md +591 -0
- package/docs/tools/slash-commands.md +518 -0
- package/docs/tools/steer.md +77 -0
- package/docs/tools/subagents.md +652 -0
- package/docs/tools/tavily.md +162 -0
- package/docs/tools/thinking.md +142 -0
- package/docs/tools/tokenjuice.md +84 -0
- package/docs/tools/tool-search.md +269 -0
- package/docs/tools/trajectory.md +229 -0
- package/docs/tools/tts.md +1013 -0
- package/docs/tools/video-generation.md +555 -0
- package/docs/tools/web-fetch.md +210 -0
- package/docs/tools/web.md +476 -0
- package/docs/tts.md +11 -0
- package/docs/vps.md +139 -0
- package/docs/web/control-ui.md +530 -0
- package/docs/web/dashboard.md +107 -0
- package/docs/web/index.md +133 -0
- package/docs/web/tui.md +258 -0
- package/docs/web/webchat.md +102 -0
- package/npm-shrinkwrap.json +3485 -0
- package/openclaw.mjs +661 -0
- package/package.json +1971 -0
- package/patches/.gitkeep +0 -0
- package/patches/@agentclientprotocol__claude-agent-acp@0.39.0.patch +40 -0
- package/pnpm-workspace.yaml +124 -0
- package/scripts/crabbox-wrapper.mjs +2470 -0
- package/scripts/lib/official-external-channel-catalog.json +570 -0
- package/scripts/lib/official-external-plugin-catalog.json +284 -0
- package/scripts/lib/official-external-provider-catalog.json +158 -0
- package/scripts/lib/package-dist-imports.mjs +174 -0
- package/scripts/npm-runner.mjs +95 -0
- package/scripts/postinstall-bundled-plugins.mjs +978 -0
- package/scripts/preinstall-package-manager-warning.mjs +74 -0
- package/scripts/prepare-git-hooks.mjs +73 -0
- package/scripts/windows-cmd-helpers.mjs +29 -0
- package/skills/1password/SKILL.md +70 -0
- package/skills/1password/references/cli-examples.md +29 -0
- package/skills/1password/references/get-started.md +17 -0
- package/skills/apple-notes/SKILL.md +77 -0
- package/skills/apple-reminders/SKILL.md +118 -0
- package/skills/bear-notes/SKILL.md +107 -0
- package/skills/blogwatcher/SKILL.md +69 -0
- package/skills/blucli/SKILL.md +47 -0
- package/skills/camsnap/SKILL.md +45 -0
- package/skills/canvas/SKILL.md +78 -0
- package/skills/clawhub/SKILL.md +77 -0
- package/skills/coding-agent/SKILL.md +143 -0
- package/skills/diagram-maker/SKILL.md +53 -0
- package/skills/diagram-maker/references/excalidraw-patterns.md +85 -0
- package/skills/diagram-maker/references/svg-template.md +112 -0
- package/skills/discord/SKILL.md +136 -0
- package/skills/eightctl/SKILL.md +50 -0
- package/skills/gemini/SKILL.md +47 -0
- package/skills/gh-issues/SKILL.md +213 -0
- package/skills/gifgrep/SKILL.md +85 -0
- package/skills/github/SKILL.md +84 -0
- package/skills/gog/SKILL.md +116 -0
- package/skills/goplaces/SKILL.md +52 -0
- package/skills/healthcheck/SKILL.md +105 -0
- package/skills/himalaya/SKILL.md +80 -0
- package/skills/himalaya/references/configuration.md +184 -0
- package/skills/himalaya/references/message-composition.md +199 -0
- package/skills/imsg/SKILL.md +122 -0
- package/skills/mcporter/SKILL.md +61 -0
- package/skills/meme-maker/SKILL.md +42 -0
- package/skills/meme-maker/references/templates.json +358 -0
- package/skills/meme-maker/scripts/meme.mjs +398 -0
- package/skills/model-usage/SKILL.md +71 -0
- package/skills/model-usage/references/codexbar-cli.md +33 -0
- package/skills/model-usage/scripts/model_usage.py +319 -0
- package/skills/model-usage/scripts/test_model_usage.py +40 -0
- package/skills/nano-pdf/SKILL.md +38 -0
- package/skills/node-connect/SKILL.md +143 -0
- package/skills/node-inspect-debugger/SKILL.md +85 -0
- package/skills/notion/SKILL.md +150 -0
- package/skills/obsidian/SKILL.md +119 -0
- package/skills/openai-whisper/SKILL.md +38 -0
- package/skills/openai-whisper-api/SKILL.md +71 -0
- package/skills/openai-whisper-api/scripts/transcribe.sh +154 -0
- package/skills/openhue/SKILL.md +112 -0
- package/skills/oracle/SKILL.md +126 -0
- package/skills/ordercli/SKILL.md +78 -0
- package/skills/peekaboo/SKILL.md +198 -0
- package/skills/pyproject.toml +10 -0
- package/skills/python-debugpy/SKILL.md +73 -0
- package/skills/sag/SKILL.md +87 -0
- package/skills/session-logs/SKILL.md +151 -0
- package/skills/sherpa-onnx-tts/SKILL.md +109 -0
- package/skills/sherpa-onnx-tts/bin/sherpa-onnx-tts +178 -0
- package/skills/skill-creator/SKILL.md +78 -0
- package/skills/skill-creator/license.txt +202 -0
- package/skills/skill-creator/scripts/init_skill.py +378 -0
- package/skills/skill-creator/scripts/package_skill.py +144 -0
- package/skills/skill-creator/scripts/quick_validate.py +169 -0
- package/skills/skill-creator/scripts/test_package_skill.py +199 -0
- package/skills/skill-creator/scripts/test_quick_validate.py +116 -0
- package/skills/slack/SKILL.md +78 -0
- package/skills/songsee/SKILL.md +49 -0
- package/skills/sonoscli/SKILL.md +65 -0
- package/skills/spike/SKILL.md +51 -0
- package/skills/spotify-player/SKILL.md +64 -0
- package/skills/summarize/SKILL.md +87 -0
- package/skills/taskflow/SKILL.md +149 -0
- package/skills/taskflow/examples/inbox-triage.lobster +33 -0
- package/skills/taskflow/examples/pr-intake.lobster +32 -0
- package/skills/taskflow-inbox-triage/SKILL.md +119 -0
- package/skills/things-mac/SKILL.md +86 -0
- package/skills/tmux/SKILL.md +91 -0
- package/skills/tmux/scripts/find-sessions.sh +112 -0
- package/skills/tmux/scripts/wait-for-text.sh +83 -0
- package/skills/trello/SKILL.md +108 -0
- package/skills/video-frames/SKILL.md +46 -0
- package/skills/video-frames/scripts/frame.sh +81 -0
- package/skills/voice-call/SKILL.md +45 -0
- package/skills/wacli/SKILL.md +72 -0
- package/skills/weather/SKILL.md +87 -0
- package/skills/xurl/SKILL.md +120 -0
- package/src/agents/templates/HEARTBEAT.md +5 -0
|
@@ -0,0 +1,386 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "Use Anthropic Claude via API keys or Claude CLI in OpenClaw"
|
|
3
|
+
read_when:
|
|
4
|
+
- You want to use Anthropic models in OpenClaw
|
|
5
|
+
title: "Anthropic"
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
Anthropic builds the **Claude** model family. OpenClaw supports two auth routes:
|
|
9
|
+
|
|
10
|
+
- **API key** — direct Anthropic API access with usage-based billing (`anthropic/*` models)
|
|
11
|
+
- **Claude CLI** — reuse an existing Claude Code login on the same host
|
|
12
|
+
|
|
13
|
+
<Warning>
|
|
14
|
+
OpenClaw's Claude CLI backend runs the installed Claude Code CLI in
|
|
15
|
+
non-interactive print mode. Anthropic's current Claude Code docs describe
|
|
16
|
+
`claude -p` as Agent SDK/programmatic usage. Starting June 15, 2026, Anthropic
|
|
17
|
+
says subscription-plan `claude -p` usage no longer draws from normal Claude
|
|
18
|
+
plan limits; it draws from a separate monthly Agent SDK credit first, then from
|
|
19
|
+
usage credits at standard API rates when those credits are enabled.
|
|
20
|
+
|
|
21
|
+
Interactive Claude Code still draws from the signed-in Claude plan limits. API
|
|
22
|
+
key auth remains direct pay-as-you-go API billing. For long-lived gateway hosts,
|
|
23
|
+
shared automation, and predictable production spend, use an Anthropic API key.
|
|
24
|
+
|
|
25
|
+
Anthropic's current public docs:
|
|
26
|
+
|
|
27
|
+
- [Claude Code CLI reference](https://code.claude.com/docs/en/cli-usage)
|
|
28
|
+
- [Use the Claude Agent SDK with your Claude plan](https://support.claude.com/en/articles/15036540-use-the-claude-agent-sdk-with-your-claude-plan)
|
|
29
|
+
- [Use Claude Code with your Pro or Max plan](https://support.claude.com/en/articles/11145838-use-claude-code-with-your-pro-or-max-plan)
|
|
30
|
+
- [Use Claude Code with your Team or Enterprise plan](https://support.claude.com/en/articles/11845131-using-claude-code-with-your-team-or-enterprise-plan)
|
|
31
|
+
- [Manage Claude Code costs](https://code.claude.com/docs/en/costs)
|
|
32
|
+
|
|
33
|
+
</Warning>
|
|
34
|
+
|
|
35
|
+
## Getting started
|
|
36
|
+
|
|
37
|
+
<Tabs>
|
|
38
|
+
<Tab title="API key">
|
|
39
|
+
**Best for:** standard API access and usage-based billing.
|
|
40
|
+
|
|
41
|
+
<Steps>
|
|
42
|
+
<Step title="Get your API key">
|
|
43
|
+
Create an API key in the [Anthropic Console](https://console.anthropic.com/).
|
|
44
|
+
</Step>
|
|
45
|
+
<Step title="Run onboarding">
|
|
46
|
+
```bash
|
|
47
|
+
openclaw onboard
|
|
48
|
+
# choose: Anthropic API key
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Or pass the key directly:
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
openclaw onboard --anthropic-api-key "$ANTHROPIC_API_KEY"
|
|
55
|
+
```
|
|
56
|
+
</Step>
|
|
57
|
+
<Step title="Verify the model is available">
|
|
58
|
+
```bash
|
|
59
|
+
openclaw models list --provider anthropic
|
|
60
|
+
```
|
|
61
|
+
</Step>
|
|
62
|
+
</Steps>
|
|
63
|
+
|
|
64
|
+
### Config example
|
|
65
|
+
|
|
66
|
+
```json5
|
|
67
|
+
{
|
|
68
|
+
env: { ANTHROPIC_API_KEY: "example-anthropic-key-not-real" },
|
|
69
|
+
agents: { defaults: { model: { primary: "anthropic/claude-opus-4-8" } } },
|
|
70
|
+
}
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
</Tab>
|
|
74
|
+
|
|
75
|
+
<Tab title="Claude CLI">
|
|
76
|
+
**Best for:** reusing an existing Claude CLI login without a separate API key.
|
|
77
|
+
|
|
78
|
+
<Steps>
|
|
79
|
+
<Step title="Ensure Claude CLI is installed and logged in">
|
|
80
|
+
Verify with:
|
|
81
|
+
|
|
82
|
+
```bash
|
|
83
|
+
claude --version
|
|
84
|
+
```
|
|
85
|
+
</Step>
|
|
86
|
+
<Step title="Run onboarding">
|
|
87
|
+
```bash
|
|
88
|
+
openclaw onboard
|
|
89
|
+
# choose: Claude CLI
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
OpenClaw detects and reuses the existing Claude CLI credentials.
|
|
93
|
+
</Step>
|
|
94
|
+
<Step title="Verify the model is available">
|
|
95
|
+
```bash
|
|
96
|
+
openclaw models list --provider anthropic
|
|
97
|
+
```
|
|
98
|
+
</Step>
|
|
99
|
+
</Steps>
|
|
100
|
+
|
|
101
|
+
<Note>
|
|
102
|
+
Setup and runtime details for the Claude CLI backend are in [CLI Backends](/gateway/cli-backends).
|
|
103
|
+
</Note>
|
|
104
|
+
|
|
105
|
+
<Warning>
|
|
106
|
+
Claude CLI reuse expects the OpenClaw process to run on the same host as the
|
|
107
|
+
Claude CLI login. Container installs such as [Podman](/install/podman) do
|
|
108
|
+
not mount host `~/.claude` into setup or runtime; use an Anthropic API key
|
|
109
|
+
there, or choose a provider with OpenClaw-managed OAuth such as
|
|
110
|
+
[OpenAI Codex](/providers/openai).
|
|
111
|
+
</Warning>
|
|
112
|
+
|
|
113
|
+
### Config example
|
|
114
|
+
|
|
115
|
+
Prefer the canonical Anthropic model ref plus a CLI runtime override:
|
|
116
|
+
|
|
117
|
+
```json5
|
|
118
|
+
{
|
|
119
|
+
agents: {
|
|
120
|
+
defaults: {
|
|
121
|
+
model: { primary: "anthropic/claude-opus-4-8" },
|
|
122
|
+
models: {
|
|
123
|
+
"anthropic/claude-opus-4-8": {
|
|
124
|
+
agentRuntime: { id: "claude-cli" },
|
|
125
|
+
},
|
|
126
|
+
},
|
|
127
|
+
},
|
|
128
|
+
},
|
|
129
|
+
}
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
Legacy `claude-cli/claude-opus-4-7` model refs still work for
|
|
133
|
+
compatibility, but new config should keep provider/model selection as
|
|
134
|
+
`anthropic/*` and put the execution backend in provider/model runtime policy.
|
|
135
|
+
|
|
136
|
+
### Billing and `claude -p`
|
|
137
|
+
|
|
138
|
+
OpenClaw uses Claude Code's non-interactive `claude -p` path for Claude CLI
|
|
139
|
+
runs. Anthropic currently treats that path as Agent SDK/programmatic usage:
|
|
140
|
+
|
|
141
|
+
- Until June 15, 2026, subscription-plan handling follows Anthropic's active
|
|
142
|
+
Claude Code rules for the signed-in account.
|
|
143
|
+
- Starting June 15, 2026, subscription-plan `claude -p` usage draws from the
|
|
144
|
+
user's monthly Agent SDK credit first, then from usage credits at standard
|
|
145
|
+
API rates if usage credits are enabled.
|
|
146
|
+
- Console/API-key logins use pay-as-you-go API billing and do not receive
|
|
147
|
+
the subscription Agent SDK credit.
|
|
148
|
+
|
|
149
|
+
Anthropic can change Claude Code billing and rate-limit behavior without an
|
|
150
|
+
OpenClaw release. Check `claude auth status`, `/status`, and
|
|
151
|
+
Anthropic's linked docs when billing predictability matters.
|
|
152
|
+
|
|
153
|
+
<Tip>
|
|
154
|
+
For shared production automation, use an Anthropic API key instead of
|
|
155
|
+
Claude CLI. OpenClaw also supports subscription-style options from
|
|
156
|
+
[OpenAI Codex](/providers/openai), [Qwen Cloud](/providers/qwen),
|
|
157
|
+
[MiniMax](/providers/minimax), and [Z.AI / GLM](/providers/zai).
|
|
158
|
+
</Tip>
|
|
159
|
+
|
|
160
|
+
</Tab>
|
|
161
|
+
</Tabs>
|
|
162
|
+
|
|
163
|
+
## Thinking defaults (Claude Fable 5, 4.8, and 4.6)
|
|
164
|
+
|
|
165
|
+
`anthropic/claude-fable-5` always uses adaptive thinking and defaults to `high`
|
|
166
|
+
effort. Because Anthropic does not allow thinking to be disabled for this model,
|
|
167
|
+
`/think off` and `/think minimal` use `low` effort. OpenClaw also omits custom
|
|
168
|
+
temperature values for Fable 5 requests.
|
|
169
|
+
|
|
170
|
+
Claude Opus 4.8 keeps thinking off by default in OpenClaw. When you explicitly enable adaptive thinking with `/think high|xhigh|max`, OpenClaw sends Anthropic's Opus 4.8 effort values; Claude 4.6 models default to `adaptive`.
|
|
171
|
+
|
|
172
|
+
Override per-message with `/think:<level>` or in model params:
|
|
173
|
+
|
|
174
|
+
```json5
|
|
175
|
+
{
|
|
176
|
+
agents: {
|
|
177
|
+
defaults: {
|
|
178
|
+
models: {
|
|
179
|
+
"anthropic/claude-opus-4-8": {
|
|
180
|
+
params: { thinking: "high" },
|
|
181
|
+
},
|
|
182
|
+
},
|
|
183
|
+
},
|
|
184
|
+
},
|
|
185
|
+
}
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
<Note>
|
|
189
|
+
Related Anthropic docs:
|
|
190
|
+
- [Adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking)
|
|
191
|
+
- [Extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking)
|
|
192
|
+
|
|
193
|
+
</Note>
|
|
194
|
+
|
|
195
|
+
## Prompt caching
|
|
196
|
+
|
|
197
|
+
OpenClaw supports Anthropic's prompt caching feature for API-key auth.
|
|
198
|
+
|
|
199
|
+
| Value | Cache duration | Description |
|
|
200
|
+
| ------------------- | -------------- | -------------------------------------- |
|
|
201
|
+
| `"short"` (default) | 5 minutes | Applied automatically for API-key auth |
|
|
202
|
+
| `"long"` | 1 hour | Extended cache |
|
|
203
|
+
| `"none"` | No caching | Disable prompt caching |
|
|
204
|
+
|
|
205
|
+
```json5
|
|
206
|
+
{
|
|
207
|
+
agents: {
|
|
208
|
+
defaults: {
|
|
209
|
+
models: {
|
|
210
|
+
"anthropic/claude-opus-4-6": {
|
|
211
|
+
params: { cacheRetention: "long" },
|
|
212
|
+
},
|
|
213
|
+
},
|
|
214
|
+
},
|
|
215
|
+
},
|
|
216
|
+
}
|
|
217
|
+
```
|
|
218
|
+
|
|
219
|
+
<AccordionGroup>
|
|
220
|
+
<Accordion title="Per-agent cache overrides">
|
|
221
|
+
Use model-level params as your baseline, then override specific agents via `agents.list[].params`:
|
|
222
|
+
|
|
223
|
+
```json5
|
|
224
|
+
{
|
|
225
|
+
agents: {
|
|
226
|
+
defaults: {
|
|
227
|
+
model: { primary: "anthropic/claude-opus-4-6" },
|
|
228
|
+
models: {
|
|
229
|
+
"anthropic/claude-opus-4-6": {
|
|
230
|
+
params: { cacheRetention: "long" },
|
|
231
|
+
},
|
|
232
|
+
},
|
|
233
|
+
},
|
|
234
|
+
list: [
|
|
235
|
+
{ id: "research", default: true },
|
|
236
|
+
{ id: "alerts", params: { cacheRetention: "none" } },
|
|
237
|
+
],
|
|
238
|
+
},
|
|
239
|
+
}
|
|
240
|
+
```
|
|
241
|
+
|
|
242
|
+
Config merge order:
|
|
243
|
+
|
|
244
|
+
1. `agents.defaults.models["provider/model"].params`
|
|
245
|
+
2. `agents.list[].params` (matching `id`, overrides by key)
|
|
246
|
+
|
|
247
|
+
This lets one agent keep a long-lived cache while another agent on the same model disables caching for bursty/low-reuse traffic.
|
|
248
|
+
|
|
249
|
+
</Accordion>
|
|
250
|
+
|
|
251
|
+
<Accordion title="Bedrock Claude notes">
|
|
252
|
+
- Anthropic Claude models on Bedrock (`amazon-bedrock/*anthropic.claude*`) accept `cacheRetention` pass-through when configured.
|
|
253
|
+
- Non-Anthropic Bedrock models are forced to `cacheRetention: "none"` at runtime.
|
|
254
|
+
- API-key smart defaults also seed `cacheRetention: "short"` for Claude-on-Bedrock refs when no explicit value is set.
|
|
255
|
+
|
|
256
|
+
</Accordion>
|
|
257
|
+
</AccordionGroup>
|
|
258
|
+
|
|
259
|
+
## Advanced configuration
|
|
260
|
+
|
|
261
|
+
<AccordionGroup>
|
|
262
|
+
<Accordion title="Fast mode">
|
|
263
|
+
OpenClaw's shared `/fast` toggle supports direct Anthropic traffic (API-key and OAuth to `api.anthropic.com`).
|
|
264
|
+
|
|
265
|
+
| Command | Maps to |
|
|
266
|
+
|---------|---------|
|
|
267
|
+
| `/fast on` | `service_tier: "auto"` |
|
|
268
|
+
| `/fast off` | `service_tier: "standard_only"` |
|
|
269
|
+
|
|
270
|
+
```json5
|
|
271
|
+
{
|
|
272
|
+
agents: {
|
|
273
|
+
defaults: {
|
|
274
|
+
models: {
|
|
275
|
+
"anthropic/claude-sonnet-4-6": {
|
|
276
|
+
params: { fastMode: true },
|
|
277
|
+
},
|
|
278
|
+
},
|
|
279
|
+
},
|
|
280
|
+
},
|
|
281
|
+
}
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
<Note>
|
|
285
|
+
- Only injected for direct `api.anthropic.com` requests. Proxy routes leave `service_tier` untouched.
|
|
286
|
+
- Explicit `serviceTier` or `service_tier` params override `/fast` when both are set.
|
|
287
|
+
- On accounts without Priority Tier capacity, `service_tier: "auto"` may resolve to `standard`.
|
|
288
|
+
|
|
289
|
+
</Note>
|
|
290
|
+
|
|
291
|
+
</Accordion>
|
|
292
|
+
|
|
293
|
+
<Accordion title="Media understanding (image and PDF)">
|
|
294
|
+
The bundled Anthropic plugin registers image and PDF understanding. OpenClaw
|
|
295
|
+
auto-resolves media capabilities from the configured Anthropic auth — no
|
|
296
|
+
additional config is needed.
|
|
297
|
+
|
|
298
|
+
| Property | Value |
|
|
299
|
+
| --------------- | --------------------- |
|
|
300
|
+
| Default model | `claude-opus-4-8` |
|
|
301
|
+
| Supported input | Images, PDF documents |
|
|
302
|
+
|
|
303
|
+
When an image or PDF is attached to a conversation, OpenClaw automatically
|
|
304
|
+
routes it through the Anthropic media understanding provider.
|
|
305
|
+
|
|
306
|
+
</Accordion>
|
|
307
|
+
|
|
308
|
+
<Accordion title="1M context window">
|
|
309
|
+
Anthropic's 1M context window is available on GA-capable Claude 4.x models
|
|
310
|
+
such as Opus 4.8, Opus 4.7, Opus 4.6, and Sonnet 4.6. OpenClaw sizes those models at
|
|
311
|
+
1M automatically:
|
|
312
|
+
|
|
313
|
+
```json5
|
|
314
|
+
{
|
|
315
|
+
agents: {
|
|
316
|
+
defaults: {
|
|
317
|
+
models: {
|
|
318
|
+
"anthropic/claude-opus-4-6": {},
|
|
319
|
+
},
|
|
320
|
+
},
|
|
321
|
+
},
|
|
322
|
+
}
|
|
323
|
+
```
|
|
324
|
+
|
|
325
|
+
Older configs can keep `params.context1m: true`, but OpenClaw no longer sends
|
|
326
|
+
the retired `context-1m-2025-08-07` beta header. Older `anthropicBeta` config
|
|
327
|
+
entries with that value are ignored during request header resolution and
|
|
328
|
+
unsupported older Claude models stay on their normal context window.
|
|
329
|
+
|
|
330
|
+
`params.context1m: true` also applies to the Claude CLI backend
|
|
331
|
+
(`claude-cli/*`) for eligible GA-capable Opus and Sonnet models, preserving
|
|
332
|
+
the runtime context window for those CLI sessions to match the direct-API
|
|
333
|
+
behavior.
|
|
334
|
+
|
|
335
|
+
<Warning>
|
|
336
|
+
Requires long-context access on your Anthropic credential. OAuth/subscription token auth keeps its required Anthropic beta headers, but OpenClaw strips the retired 1M beta header if it remains in older config.
|
|
337
|
+
</Warning>
|
|
338
|
+
|
|
339
|
+
</Accordion>
|
|
340
|
+
|
|
341
|
+
<Accordion title="Claude Opus 4.8 1M context">
|
|
342
|
+
`anthropic/claude-opus-4-8` and its `claude-cli` variant have a 1M context
|
|
343
|
+
window by default — no `params.context1m: true` needed.
|
|
344
|
+
</Accordion>
|
|
345
|
+
</AccordionGroup>
|
|
346
|
+
|
|
347
|
+
## Troubleshooting
|
|
348
|
+
|
|
349
|
+
<AccordionGroup>
|
|
350
|
+
<Accordion title="401 errors / token suddenly invalid">
|
|
351
|
+
Anthropic token auth expires and can be revoked. For new setups, use an Anthropic API key instead.
|
|
352
|
+
</Accordion>
|
|
353
|
+
|
|
354
|
+
<Accordion title='No API key found for provider "anthropic"'>
|
|
355
|
+
Anthropic auth is **per agent** — new agents do not inherit the main agent's keys. Re-run onboarding for that agent (or configure an API key on the gateway host), then verify with `openclaw models status`.
|
|
356
|
+
</Accordion>
|
|
357
|
+
|
|
358
|
+
<Accordion title='No credentials found for profile "anthropic:default"'>
|
|
359
|
+
Run `openclaw models status` to see which auth profile is active. Re-run onboarding, or configure an API key for that profile path.
|
|
360
|
+
</Accordion>
|
|
361
|
+
|
|
362
|
+
<Accordion title="No available auth profile (all in cooldown)">
|
|
363
|
+
Check `openclaw models status --json` for `auth.unusableProfiles`. Anthropic rate-limit cooldowns can be model-scoped, so a sibling Anthropic model may still be usable. Add another Anthropic profile or wait for cooldown.
|
|
364
|
+
</Accordion>
|
|
365
|
+
</AccordionGroup>
|
|
366
|
+
|
|
367
|
+
<Note>
|
|
368
|
+
More help: [Troubleshooting](/help/troubleshooting) and [FAQ](/help/faq).
|
|
369
|
+
</Note>
|
|
370
|
+
|
|
371
|
+
## Related
|
|
372
|
+
|
|
373
|
+
<CardGroup cols={2}>
|
|
374
|
+
<Card title="Model selection" href="/concepts/model-providers" icon="layers">
|
|
375
|
+
Choosing providers, model refs, and failover behavior.
|
|
376
|
+
</Card>
|
|
377
|
+
<Card title="CLI backends" href="/gateway/cli-backends" icon="terminal">
|
|
378
|
+
Claude CLI backend setup and runtime details.
|
|
379
|
+
</Card>
|
|
380
|
+
<Card title="Prompt caching" href="/reference/prompt-caching" icon="database">
|
|
381
|
+
How prompt caching works across providers.
|
|
382
|
+
</Card>
|
|
383
|
+
<Card title="OAuth and auth" href="/gateway/authentication" icon="key">
|
|
384
|
+
Auth details and credential reuse rules.
|
|
385
|
+
</Card>
|
|
386
|
+
</CardGroup>
|
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "Arcee AI setup (auth + model selection)"
|
|
3
|
+
title: "Arcee AI"
|
|
4
|
+
read_when:
|
|
5
|
+
- You want to use Arcee AI with OpenClaw
|
|
6
|
+
- You need the API key env var or CLI auth choice
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
[Arcee AI](https://arcee.ai) provides access to the Trinity family of mixture-of-experts models through an OpenAI-compatible API. All Trinity models are Apache 2.0 licensed.
|
|
10
|
+
|
|
11
|
+
Arcee AI models can be accessed directly via the Arcee platform or through [OpenRouter](/providers/openrouter).
|
|
12
|
+
|
|
13
|
+
| Property | Value |
|
|
14
|
+
| -------- | ------------------------------------------------------------------------------------- |
|
|
15
|
+
| Provider | `arcee` |
|
|
16
|
+
| Auth | `ARCEEAI_API_KEY` (direct) or `OPENROUTER_API_KEY` (via OpenRouter) |
|
|
17
|
+
| API | OpenAI-compatible |
|
|
18
|
+
| Base URL | `https://api.arcee.ai/api/v1` (direct) or `https://openrouter.ai/api/v1` (OpenRouter) |
|
|
19
|
+
|
|
20
|
+
## Getting started
|
|
21
|
+
|
|
22
|
+
<Tabs>
|
|
23
|
+
<Tab title="Direct (Arcee platform)">
|
|
24
|
+
<Steps>
|
|
25
|
+
<Step title="Get an API key">
|
|
26
|
+
Create an API key at [Arcee AI](https://chat.arcee.ai/).
|
|
27
|
+
</Step>
|
|
28
|
+
<Step title="Run onboarding">
|
|
29
|
+
```bash
|
|
30
|
+
openclaw onboard --auth-choice arceeai-api-key
|
|
31
|
+
```
|
|
32
|
+
</Step>
|
|
33
|
+
<Step title="Set a default model">
|
|
34
|
+
```json5
|
|
35
|
+
{
|
|
36
|
+
agents: {
|
|
37
|
+
defaults: {
|
|
38
|
+
model: { primary: "arcee/trinity-large-thinking" },
|
|
39
|
+
},
|
|
40
|
+
},
|
|
41
|
+
}
|
|
42
|
+
```
|
|
43
|
+
</Step>
|
|
44
|
+
</Steps>
|
|
45
|
+
</Tab>
|
|
46
|
+
|
|
47
|
+
<Tab title="Via OpenRouter">
|
|
48
|
+
<Steps>
|
|
49
|
+
<Step title="Get an API key">
|
|
50
|
+
Create an API key at [OpenRouter](https://openrouter.ai/keys).
|
|
51
|
+
</Step>
|
|
52
|
+
<Step title="Run onboarding">
|
|
53
|
+
```bash
|
|
54
|
+
openclaw onboard --auth-choice arceeai-openrouter
|
|
55
|
+
```
|
|
56
|
+
</Step>
|
|
57
|
+
<Step title="Set a default model">
|
|
58
|
+
```json5
|
|
59
|
+
{
|
|
60
|
+
agents: {
|
|
61
|
+
defaults: {
|
|
62
|
+
model: { primary: "arcee/trinity-large-thinking" },
|
|
63
|
+
},
|
|
64
|
+
},
|
|
65
|
+
}
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
The same model refs work for both direct and OpenRouter setups (for example `arcee/trinity-large-thinking`).
|
|
69
|
+
</Step>
|
|
70
|
+
</Steps>
|
|
71
|
+
|
|
72
|
+
</Tab>
|
|
73
|
+
</Tabs>
|
|
74
|
+
|
|
75
|
+
## Non-interactive setup
|
|
76
|
+
|
|
77
|
+
<Tabs>
|
|
78
|
+
<Tab title="Direct (Arcee platform)">
|
|
79
|
+
```bash
|
|
80
|
+
openclaw onboard --non-interactive \
|
|
81
|
+
--mode local \
|
|
82
|
+
--auth-choice arceeai-api-key \
|
|
83
|
+
--arceeai-api-key "$ARCEEAI_API_KEY"
|
|
84
|
+
```
|
|
85
|
+
</Tab>
|
|
86
|
+
|
|
87
|
+
<Tab title="Via OpenRouter">
|
|
88
|
+
```bash
|
|
89
|
+
openclaw onboard --non-interactive \
|
|
90
|
+
--mode local \
|
|
91
|
+
--auth-choice arceeai-openrouter \
|
|
92
|
+
--openrouter-api-key "$OPENROUTER_API_KEY"
|
|
93
|
+
```
|
|
94
|
+
</Tab>
|
|
95
|
+
</Tabs>
|
|
96
|
+
|
|
97
|
+
## Built-in catalog
|
|
98
|
+
|
|
99
|
+
OpenClaw currently ships this bundled Arcee catalog:
|
|
100
|
+
|
|
101
|
+
| Model ref | Name | Input | Context | Cost (in/out per 1M) | Notes |
|
|
102
|
+
| ------------------------------ | ---------------------- | ----- | ------- | -------------------- | ----------------------------------------- |
|
|
103
|
+
| `arcee/trinity-large-thinking` | Trinity Large Thinking | text | 256K | $0.25 / $0.90 | Default model; reasoning enabled |
|
|
104
|
+
| `arcee/trinity-large-preview` | Trinity Large Preview | text | 128K | $0.25 / $1.00 | General-purpose; 400B params, 13B active |
|
|
105
|
+
| `arcee/trinity-mini` | Trinity Mini 26B | text | 128K | $0.045 / $0.15 | Fast and cost-efficient; function calling |
|
|
106
|
+
|
|
107
|
+
<Tip>
|
|
108
|
+
The onboarding preset sets `arcee/trinity-large-thinking` as the default model.
|
|
109
|
+
</Tip>
|
|
110
|
+
|
|
111
|
+
## Supported features
|
|
112
|
+
|
|
113
|
+
| Feature | Supported |
|
|
114
|
+
| --------------------------------------------- | -------------------------------------------- |
|
|
115
|
+
| Streaming | Yes |
|
|
116
|
+
| Tool use / function calling | Yes (Trinity Mini, Trinity Large Preview) |
|
|
117
|
+
| Structured output (JSON mode and JSON schema) | Yes |
|
|
118
|
+
| Extended thinking | Yes (Trinity Large Thinking; tools disabled) |
|
|
119
|
+
|
|
120
|
+
<AccordionGroup>
|
|
121
|
+
<Accordion title="Environment note">
|
|
122
|
+
If the Gateway runs as a daemon (launchd/systemd), make sure `ARCEEAI_API_KEY`
|
|
123
|
+
(or `OPENROUTER_API_KEY`) is available to that process (for example, in
|
|
124
|
+
`~/.openclaw/.env` or via `env.shellEnv`).
|
|
125
|
+
</Accordion>
|
|
126
|
+
|
|
127
|
+
<Accordion title="OpenRouter routing">
|
|
128
|
+
When using Arcee models via OpenRouter, the same `arcee/*` model refs apply.
|
|
129
|
+
OpenClaw handles routing transparently based on your auth choice. See the
|
|
130
|
+
[OpenRouter provider docs](/providers/openrouter) for OpenRouter-specific
|
|
131
|
+
configuration details.
|
|
132
|
+
</Accordion>
|
|
133
|
+
</AccordionGroup>
|
|
134
|
+
|
|
135
|
+
## Related
|
|
136
|
+
|
|
137
|
+
<CardGroup cols={2}>
|
|
138
|
+
<Card title="OpenRouter" href="/providers/openrouter" icon="shuffle">
|
|
139
|
+
Access Arcee models and many others through a single API key.
|
|
140
|
+
</Card>
|
|
141
|
+
<Card title="Model selection" href="/concepts/model-providers" icon="layers">
|
|
142
|
+
Choosing providers, model refs, and failover behavior.
|
|
143
|
+
</Card>
|
|
144
|
+
</CardGroup>
|
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "Azure AI Speech text-to-speech for OpenClaw replies"
|
|
3
|
+
read_when:
|
|
4
|
+
- You want Azure Speech synthesis for outbound replies
|
|
5
|
+
- You need native Ogg Opus voice-note output from Azure Speech
|
|
6
|
+
title: "Azure Speech"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
Azure Speech is an Azure AI Speech text-to-speech provider. In OpenClaw it
|
|
10
|
+
synthesizes outbound reply audio as MP3 by default, native Ogg/Opus for voice
|
|
11
|
+
notes, and 8 kHz mulaw audio for telephony channels such as Voice Call.
|
|
12
|
+
|
|
13
|
+
OpenClaw uses the Azure Speech REST API directly with SSML and sends the
|
|
14
|
+
provider-owned output format through `X-Microsoft-OutputFormat`.
|
|
15
|
+
|
|
16
|
+
| Detail | Value |
|
|
17
|
+
| ----------------------- | -------------------------------------------------------------------------------------------------------------- |
|
|
18
|
+
| Website | [Azure AI Speech](https://azure.microsoft.com/products/ai-services/ai-speech) |
|
|
19
|
+
| Docs | [Speech REST text-to-speech](https://learn.microsoft.com/azure/ai-services/speech-service/rest-text-to-speech) |
|
|
20
|
+
| Auth | `AZURE_SPEECH_KEY` plus `AZURE_SPEECH_REGION` |
|
|
21
|
+
| Default voice | `en-US-JennyNeural` |
|
|
22
|
+
| Default file output | `audio-24khz-48kbitrate-mono-mp3` |
|
|
23
|
+
| Default voice-note file | `ogg-24khz-16bit-mono-opus` |
|
|
24
|
+
|
|
25
|
+
## Getting started
|
|
26
|
+
|
|
27
|
+
<Steps>
|
|
28
|
+
<Step title="Create an Azure Speech resource">
|
|
29
|
+
In the Azure portal, create a Speech resource. Copy **KEY 1** from
|
|
30
|
+
Resource Management > Keys and Endpoint, and copy the resource location
|
|
31
|
+
such as `eastus`.
|
|
32
|
+
|
|
33
|
+
```
|
|
34
|
+
AZURE_SPEECH_KEY=<speech-resource-key>
|
|
35
|
+
AZURE_SPEECH_REGION=eastus
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
</Step>
|
|
39
|
+
<Step title="Select Azure Speech in messages.tts">
|
|
40
|
+
```json5
|
|
41
|
+
{
|
|
42
|
+
messages: {
|
|
43
|
+
tts: {
|
|
44
|
+
auto: "always",
|
|
45
|
+
provider: "azure-speech",
|
|
46
|
+
providers: {
|
|
47
|
+
"azure-speech": {
|
|
48
|
+
speakerVoice: "en-US-JennyNeural",
|
|
49
|
+
lang: "en-US",
|
|
50
|
+
},
|
|
51
|
+
},
|
|
52
|
+
},
|
|
53
|
+
},
|
|
54
|
+
}
|
|
55
|
+
```
|
|
56
|
+
</Step>
|
|
57
|
+
<Step title="Send a message">
|
|
58
|
+
Send a reply through any connected channel. OpenClaw synthesizes the audio
|
|
59
|
+
with Azure Speech and delivers MP3 for standard audio, or Ogg/Opus when
|
|
60
|
+
the channel expects a voice note.
|
|
61
|
+
</Step>
|
|
62
|
+
</Steps>
|
|
63
|
+
|
|
64
|
+
## Configuration options
|
|
65
|
+
|
|
66
|
+
| Option | Path | Description |
|
|
67
|
+
| ----------------------- | ----------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
|
68
|
+
| `apiKey` | `messages.tts.providers.azure-speech.apiKey` | Azure Speech resource key. Falls back to `AZURE_SPEECH_KEY`, `AZURE_SPEECH_API_KEY`, or `SPEECH_KEY`. |
|
|
69
|
+
| `region` | `messages.tts.providers.azure-speech.region` | Azure Speech resource region. Falls back to `AZURE_SPEECH_REGION` or `SPEECH_REGION`. |
|
|
70
|
+
| `endpoint` | `messages.tts.providers.azure-speech.endpoint` | Optional Azure Speech endpoint/base URL override. |
|
|
71
|
+
| `baseUrl` | `messages.tts.providers.azure-speech.baseUrl` | Optional Azure Speech base URL override. |
|
|
72
|
+
| `speakerVoice` | `messages.tts.providers.azure-speech.speakerVoice` | Azure voice ShortName (default `en-US-JennyNeural`). Legacy alias: `voice`. |
|
|
73
|
+
| `lang` | `messages.tts.providers.azure-speech.lang` | SSML language code (default `en-US`). |
|
|
74
|
+
| `outputFormat` | `messages.tts.providers.azure-speech.outputFormat` | Audio-file output format (default `audio-24khz-48kbitrate-mono-mp3`). |
|
|
75
|
+
| `voiceNoteOutputFormat` | `messages.tts.providers.azure-speech.voiceNoteOutputFormat` | Voice-note output format (default `ogg-24khz-16bit-mono-opus`). |
|
|
76
|
+
|
|
77
|
+
## Notes
|
|
78
|
+
|
|
79
|
+
<AccordionGroup>
|
|
80
|
+
<Accordion title="Authentication">
|
|
81
|
+
Azure Speech uses a Speech resource key, not an Azure OpenAI key. The key
|
|
82
|
+
is sent as `Ocp-Apim-Subscription-Key`; OpenClaw derives
|
|
83
|
+
`https://<region>.tts.speech.microsoft.com` from `region` unless you
|
|
84
|
+
provide `endpoint` or `baseUrl`.
|
|
85
|
+
</Accordion>
|
|
86
|
+
<Accordion title="Voice names">
|
|
87
|
+
Use the Azure Speech voice `ShortName` value, for example
|
|
88
|
+
`en-US-JennyNeural`. The bundled provider can list voices through the
|
|
89
|
+
same Speech resource and filters voices marked deprecated or retired.
|
|
90
|
+
</Accordion>
|
|
91
|
+
<Accordion title="Audio outputs">
|
|
92
|
+
Azure accepts output formats such as `audio-24khz-48kbitrate-mono-mp3`,
|
|
93
|
+
`ogg-24khz-16bit-mono-opus`, and `riff-24khz-16bit-mono-pcm`. OpenClaw
|
|
94
|
+
requests Ogg/Opus for `voice-note` targets so channels can send native
|
|
95
|
+
voice bubbles without an extra MP3 conversion.
|
|
96
|
+
</Accordion>
|
|
97
|
+
<Accordion title="Alias">
|
|
98
|
+
`azure` is accepted as a provider alias for existing PRs and user config,
|
|
99
|
+
but new config should use `azure-speech` to avoid confusion with Azure
|
|
100
|
+
OpenAI model providers.
|
|
101
|
+
</Accordion>
|
|
102
|
+
</AccordionGroup>
|
|
103
|
+
|
|
104
|
+
## Related
|
|
105
|
+
|
|
106
|
+
<CardGroup cols={2}>
|
|
107
|
+
<Card title="Text-to-speech" href="/tools/tts" icon="waveform-lines">
|
|
108
|
+
TTS overview, providers, and `messages.tts` config.
|
|
109
|
+
</Card>
|
|
110
|
+
<Card title="Configuration" href="/gateway/configuration" icon="gear">
|
|
111
|
+
Full config reference including `messages.tts` settings.
|
|
112
|
+
</Card>
|
|
113
|
+
<Card title="Providers" href="/providers" icon="grid">
|
|
114
|
+
All bundled OpenClaw providers.
|
|
115
|
+
</Card>
|
|
116
|
+
<Card title="Troubleshooting" href="/help/troubleshooting" icon="wrench">
|
|
117
|
+
Common issues and debugging steps.
|
|
118
|
+
</Card>
|
|
119
|
+
</CardGroup>
|