@quantumclaw/quantumclaw 2026.3.22
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 +4601 -0
- package/LICENSE +21 -0
- package/README.md +559 -0
- package/assets/avatar-placeholder.svg +19 -0
- package/assets/chrome-extension/icons/icon128.png +0 -0
- package/assets/chrome-extension/icons/icon16.png +0 -0
- package/assets/chrome-extension/icons/icon32.png +0 -0
- package/assets/chrome-extension/icons/icon48.png +0 -0
- package/assets/dmg-background-small.png +0 -0
- package/assets/dmg-background.png +0 -0
- package/docs/.i18n/README.md +31 -0
- package/docs/.i18n/glossary.ja-JP.json +14 -0
- package/docs/.i18n/glossary.zh-CN.json +302 -0
- package/docs/.i18n/ja-JP.tm.jsonl +0 -0
- package/docs/assets/install-script.svg +1 -0
- package/docs/assets/macos-onboarding/01-macos-warning.jpeg +0 -0
- package/docs/assets/macos-onboarding/02-local-networks.jpeg +0 -0
- package/docs/assets/macos-onboarding/03-security-notice.png +0 -0
- package/docs/assets/macos-onboarding/04-choose-gateway.png +0 -0
- package/docs/assets/macos-onboarding/05-permissions.png +0 -0
- package/docs/assets/pixel-lobster.svg +60 -0
- package/docs/assets/quantumclaw-logo-text-dark.png +0 -0
- package/docs/assets/quantumclaw-logo-text-dark.svg +418 -0
- package/docs/assets/quantumclaw-logo-text.png +0 -0
- package/docs/assets/quantumclaw-logo-text.svg +418 -0
- package/docs/assets/showcase/agents-ui.jpg +0 -0
- package/docs/assets/showcase/bambu-cli.png +0 -0
- package/docs/assets/showcase/codexmonitor.png +0 -0
- package/docs/assets/showcase/gohome-grafana.png +0 -0
- package/docs/assets/showcase/ios-testflight.jpg +0 -0
- package/docs/assets/showcase/oura-health.png +0 -0
- package/docs/assets/showcase/padel-cli.svg +11 -0
- package/docs/assets/showcase/padel-screenshot.jpg +0 -0
- package/docs/assets/showcase/papla-tts.jpg +0 -0
- package/docs/assets/showcase/pr-review-telegram.jpg +0 -0
- package/docs/assets/showcase/roborock-screenshot.jpg +0 -0
- package/docs/assets/showcase/roborock-status.svg +13 -0
- package/docs/assets/showcase/roof-camera-sky.jpg +0 -0
- package/docs/assets/showcase/snag.png +0 -0
- package/docs/assets/showcase/tesco-shop.jpg +0 -0
- package/docs/assets/showcase/wienerlinien.png +0 -0
- package/docs/assets/showcase/wine-cellar-skill.jpg +0 -0
- package/docs/assets/showcase/winix-air-purifier.jpg +0 -0
- package/docs/assets/showcase/xuezh-pronunciation.jpeg +0 -0
- package/docs/assets/sponsors/blacksmith.svg +14 -0
- package/docs/assets/sponsors/convex.svg +16 -0
- package/docs/assets/sponsors/openai.svg +3 -0
- package/docs/assets/sponsors/vercel.svg +5 -0
- package/docs/auth-credential-semantics.md +53 -0
- package/docs/automation/auth-monitoring.md +44 -0
- package/docs/automation/cron-jobs.md +727 -0
- package/docs/automation/cron-vs-heartbeat.md +286 -0
- package/docs/automation/gmail-pubsub.md +256 -0
- package/docs/automation/hooks.md +1056 -0
- package/docs/automation/poll.md +86 -0
- package/docs/automation/standing-orders.md +251 -0
- package/docs/automation/troubleshooting.md +122 -0
- package/docs/automation/webhook.md +217 -0
- package/docs/brave-search.md +93 -0
- package/docs/channels/bluebubbles.md +347 -0
- package/docs/channels/broadcast-groups.md +442 -0
- package/docs/channels/channel-routing.md +139 -0
- package/docs/channels/discord.md +1229 -0
- package/docs/channels/feishu.md +747 -0
- package/docs/channels/googlechat.md +261 -0
- package/docs/channels/group-messages.md +84 -0
- package/docs/channels/groups.md +379 -0
- package/docs/channels/imessage.md +367 -0
- package/docs/channels/index.md +47 -0
- package/docs/channels/irc.md +242 -0
- package/docs/channels/line.md +194 -0
- package/docs/channels/location.md +56 -0
- package/docs/channels/matrix.md +677 -0
- package/docs/channels/mattermost.md +427 -0
- package/docs/channels/msteams.md +780 -0
- package/docs/channels/nextcloud-talk.md +138 -0
- package/docs/channels/nostr.md +249 -0
- package/docs/channels/pairing.md +114 -0
- package/docs/channels/signal.md +329 -0
- package/docs/channels/slack.md +603 -0
- package/docs/channels/synology-chat.md +134 -0
- package/docs/channels/telegram.md +987 -0
- package/docs/channels/tlon.md +276 -0
- package/docs/channels/troubleshooting.md +118 -0
- package/docs/channels/twitch.md +379 -0
- package/docs/channels/whatsapp.md +460 -0
- package/docs/channels/zalo.md +243 -0
- package/docs/channels/zalouser.md +181 -0
- package/docs/ci.md +55 -0
- package/docs/cli/acp.md +288 -0
- package/docs/cli/agent.md +29 -0
- package/docs/cli/agents.md +123 -0
- package/docs/cli/approvals.md +50 -0
- package/docs/cli/backup.md +76 -0
- package/docs/cli/browser.md +106 -0
- package/docs/cli/channels.md +102 -0
- package/docs/cli/clawbot.md +21 -0
- package/docs/cli/completion.md +35 -0
- package/docs/cli/config.md +295 -0
- package/docs/cli/configure.md +36 -0
- package/docs/cli/cron.md +77 -0
- package/docs/cli/daemon.md +53 -0
- package/docs/cli/dashboard.md +22 -0
- package/docs/cli/devices.md +139 -0
- package/docs/cli/directory.md +63 -0
- package/docs/cli/dns.md +23 -0
- package/docs/cli/docs.md +15 -0
- package/docs/cli/doctor.md +48 -0
- package/docs/cli/gateway.md +235 -0
- package/docs/cli/health.md +21 -0
- package/docs/cli/hooks.md +329 -0
- package/docs/cli/index.md +1150 -0
- package/docs/cli/logs.md +28 -0
- package/docs/cli/memory.md +66 -0
- package/docs/cli/message.md +278 -0
- package/docs/cli/models.md +81 -0
- package/docs/cli/node.md +127 -0
- package/docs/cli/nodes.md +75 -0
- package/docs/cli/onboard.md +157 -0
- package/docs/cli/pairing.md +32 -0
- package/docs/cli/plugins.md +210 -0
- package/docs/cli/qr.md +46 -0
- package/docs/cli/reset.md +20 -0
- package/docs/cli/sandbox.md +197 -0
- package/docs/cli/secrets.md +188 -0
- package/docs/cli/security.md +79 -0
- package/docs/cli/sessions.md +110 -0
- package/docs/cli/setup.md +29 -0
- package/docs/cli/skills.md +36 -0
- package/docs/cli/status.md +30 -0
- package/docs/cli/system.md +60 -0
- package/docs/cli/tui.md +30 -0
- package/docs/cli/uninstall.md +20 -0
- package/docs/cli/update.md +103 -0
- package/docs/cli/voicecall.md +34 -0
- package/docs/cli/webhooks.md +25 -0
- package/docs/concepts/agent-loop.md +148 -0
- package/docs/concepts/agent-workspace.md +236 -0
- package/docs/concepts/agent.md +122 -0
- package/docs/concepts/architecture.md +137 -0
- package/docs/concepts/compaction.md +123 -0
- package/docs/concepts/context-engine.md +268 -0
- package/docs/concepts/context.md +172 -0
- package/docs/concepts/delegate-architecture.md +296 -0
- package/docs/concepts/features.md +73 -0
- package/docs/concepts/markdown-formatting.md +130 -0
- package/docs/concepts/memory.md +108 -0
- package/docs/concepts/messages.md +154 -0
- package/docs/concepts/model-failover.md +152 -0
- package/docs/concepts/model-providers.md +607 -0
- package/docs/concepts/models.md +225 -0
- package/docs/concepts/multi-agent.md +552 -0
- package/docs/concepts/oauth.md +158 -0
- package/docs/concepts/presence.md +102 -0
- package/docs/concepts/queue.md +89 -0
- package/docs/concepts/retry.md +69 -0
- package/docs/concepts/session-pruning.md +121 -0
- package/docs/concepts/session-tool.md +242 -0
- package/docs/concepts/session.md +310 -0
- package/docs/concepts/streaming.md +155 -0
- package/docs/concepts/system-prompt.md +132 -0
- package/docs/concepts/timezone.md +91 -0
- package/docs/concepts/typebox.md +291 -0
- package/docs/concepts/typing-indicators.md +68 -0
- package/docs/concepts/usage-tracking.md +35 -0
- package/docs/date-time.md +128 -0
- package/docs/debug/node-issue.md +85 -0
- package/docs/diagnostics/flags.md +91 -0
- package/docs/docs.json +2078 -0
- package/docs/gateway/authentication.md +179 -0
- package/docs/gateway/background-process.md +97 -0
- package/docs/gateway/bonjour.md +177 -0
- package/docs/gateway/bridge-protocol.md +91 -0
- package/docs/gateway/cli-backends.md +225 -0
- package/docs/gateway/configuration-examples.md +651 -0
- package/docs/gateway/configuration-reference.md +3123 -0
- package/docs/gateway/configuration.md +633 -0
- package/docs/gateway/discovery.md +123 -0
- package/docs/gateway/doctor.md +362 -0
- package/docs/gateway/gateway-lock.md +34 -0
- package/docs/gateway/health.md +44 -0
- package/docs/gateway/heartbeat.md +393 -0
- package/docs/gateway/index.md +261 -0
- package/docs/gateway/local-models.md +152 -0
- package/docs/gateway/logging.md +113 -0
- package/docs/gateway/multiple-gateways.md +112 -0
- package/docs/gateway/network-model.md +22 -0
- package/docs/gateway/openai-http-api.md +132 -0
- package/docs/gateway/openresponses-http-api.md +295 -0
- package/docs/gateway/openshell.md +307 -0
- package/docs/gateway/pairing.md +99 -0
- package/docs/gateway/protocol.md +267 -0
- package/docs/gateway/remote-gateway-readme.md +158 -0
- package/docs/gateway/remote.md +153 -0
- package/docs/gateway/sandbox-vs-tool-policy-vs-elevated.md +134 -0
- package/docs/gateway/sandboxing.md +469 -0
- package/docs/gateway/secrets-plan-contract.md +116 -0
- package/docs/gateway/secrets.md +503 -0
- package/docs/gateway/security/index.md +1220 -0
- package/docs/gateway/tailscale.md +132 -0
- package/docs/gateway/tools-invoke-http-api.md +118 -0
- package/docs/gateway/troubleshooting.md +378 -0
- package/docs/gateway/trusted-proxy-auth.md +330 -0
- package/docs/help/debugging.md +168 -0
- package/docs/help/environment.md +163 -0
- package/docs/help/faq.md +2997 -0
- package/docs/help/index.md +28 -0
- package/docs/help/scripts.md +28 -0
- package/docs/help/testing.md +526 -0
- package/docs/help/troubleshooting.md +297 -0
- package/docs/images/configure-model-picker-unsearchable.png +0 -0
- package/docs/images/feishu-step2-create-app.png +0 -0
- package/docs/images/feishu-step3-credentials.png +0 -0
- package/docs/images/feishu-step4-permissions.png +0 -0
- package/docs/images/feishu-step5-bot-capability.png +0 -0
- package/docs/images/feishu-step6-event-subscription.png +0 -0
- package/docs/images/feishu-verification-token.png +0 -0
- package/docs/images/groups-flow.svg +52 -0
- package/docs/images/mobile-ui-screenshot.png +0 -0
- package/docs/index.md +196 -0
- package/docs/install/ansible.md +230 -0
- package/docs/install/azure.md +311 -0
- package/docs/install/bun.md +55 -0
- package/docs/install/development-channels.md +120 -0
- package/docs/install/digitalocean.md +129 -0
- package/docs/install/docker-vm-runtime.md +142 -0
- package/docs/install/docker.md +375 -0
- package/docs/install/exe-dev.md +126 -0
- package/docs/install/fly.md +501 -0
- package/docs/install/gcp.md +402 -0
- package/docs/install/hetzner.md +251 -0
- package/docs/install/index.md +183 -0
- package/docs/install/installer.md +415 -0
- package/docs/install/kubernetes.md +191 -0
- package/docs/install/macos-vm.md +281 -0
- package/docs/install/migrating-matrix.md +346 -0
- package/docs/install/migrating.md +110 -0
- package/docs/install/nix.md +89 -0
- package/docs/install/node.md +138 -0
- package/docs/install/northflank.mdx +54 -0
- package/docs/install/oracle.md +156 -0
- package/docs/install/podman.md +133 -0
- package/docs/install/railway.mdx +100 -0
- package/docs/install/raspberry-pi.md +159 -0
- package/docs/install/render.mdx +169 -0
- package/docs/install/uninstall.md +128 -0
- package/docs/install/updating.md +128 -0
- package/docs/ja-JP/index.md +186 -0
- package/docs/ja-JP/start/getting-started.md +125 -0
- package/docs/ja-JP/start/wizard.md +77 -0
- package/docs/logging.md +352 -0
- package/docs/nav-tabs-underline.js +100 -0
- package/docs/network.md +54 -0
- package/docs/nodes/audio.md +187 -0
- package/docs/nodes/camera.md +162 -0
- package/docs/nodes/images.md +72 -0
- package/docs/nodes/index.md +393 -0
- package/docs/nodes/location-command.md +98 -0
- package/docs/nodes/media-understanding.md +394 -0
- package/docs/nodes/talk.md +92 -0
- package/docs/nodes/troubleshooting.md +114 -0
- package/docs/nodes/voicewake.md +66 -0
- package/docs/perplexity.md +174 -0
- package/docs/pi-dev.md +80 -0
- package/docs/pi.md +567 -0
- package/docs/platforms/android.md +168 -0
- package/docs/platforms/digitalocean.md +266 -0
- package/docs/platforms/index.md +54 -0
- package/docs/platforms/ios.md +220 -0
- package/docs/platforms/linux.md +94 -0
- package/docs/platforms/mac/bundled-gateway.md +73 -0
- package/docs/platforms/mac/canvas.md +125 -0
- package/docs/platforms/mac/child-process.md +69 -0
- package/docs/platforms/mac/dev-setup.md +104 -0
- package/docs/platforms/mac/health.md +34 -0
- package/docs/platforms/mac/icon.md +31 -0
- package/docs/platforms/mac/logging.md +57 -0
- package/docs/platforms/mac/menu-bar.md +81 -0
- package/docs/platforms/mac/peekaboo.md +65 -0
- package/docs/platforms/mac/permissions.md +50 -0
- package/docs/platforms/mac/remote.md +84 -0
- package/docs/platforms/mac/signing.md +47 -0
- package/docs/platforms/mac/skills.md +33 -0
- package/docs/platforms/mac/voice-overlay.md +60 -0
- package/docs/platforms/mac/voicewake.md +67 -0
- package/docs/platforms/mac/webchat.md +43 -0
- package/docs/platforms/mac/xpc.md +61 -0
- package/docs/platforms/macos.md +226 -0
- package/docs/platforms/oracle.md +303 -0
- package/docs/platforms/raspberry-pi.md +412 -0
- package/docs/platforms/windows.md +241 -0
- package/docs/plugins/agent-tools.md +10 -0
- package/docs/plugins/architecture.md +1366 -0
- package/docs/plugins/building-extensions.md +10 -0
- package/docs/plugins/building-plugins.md +239 -0
- package/docs/plugins/bundles.md +181 -0
- package/docs/plugins/community.md +145 -0
- package/docs/plugins/manifest.md +241 -0
- package/docs/plugins/sdk-channel-plugins.md +370 -0
- package/docs/plugins/sdk-entrypoints.md +161 -0
- package/docs/plugins/sdk-migration.md +172 -0
- package/docs/plugins/sdk-overview.md +196 -0
- package/docs/plugins/sdk-provider-plugins.md +370 -0
- package/docs/plugins/sdk-runtime.md +345 -0
- package/docs/plugins/sdk-setup.md +331 -0
- package/docs/plugins/sdk-testing.md +263 -0
- package/docs/plugins/voice-call.md +380 -0
- package/docs/plugins/zalouser.md +77 -0
- package/docs/prose.md +134 -0
- package/docs/providers/anthropic.md +259 -0
- package/docs/providers/bedrock.md +176 -0
- package/docs/providers/claude-max-api-proxy.md +154 -0
- package/docs/providers/cloudflare-ai-gateway.md +71 -0
- package/docs/providers/deepgram.md +93 -0
- package/docs/providers/github-copilot.md +72 -0
- package/docs/providers/glm.md +43 -0
- package/docs/providers/google.md +78 -0
- package/docs/providers/groq.md +96 -0
- package/docs/providers/huggingface.md +209 -0
- package/docs/providers/index.md +69 -0
- package/docs/providers/kilocode.md +74 -0
- package/docs/providers/litellm.md +154 -0
- package/docs/providers/minimax.md +224 -0
- package/docs/providers/mistral.md +54 -0
- package/docs/providers/models.md +45 -0
- package/docs/providers/modelstudio.md +66 -0
- package/docs/providers/moonshot.md +175 -0
- package/docs/providers/nvidia.md +55 -0
- package/docs/providers/ollama.md +352 -0
- package/docs/providers/openai.md +303 -0
- package/docs/providers/opencode-go.md +45 -0
- package/docs/providers/opencode.md +64 -0
- package/docs/providers/openrouter.md +37 -0
- package/docs/providers/perplexity-provider.md +62 -0
- package/docs/providers/qianfan.md +38 -0
- package/docs/providers/qwen.md +53 -0
- package/docs/providers/sglang.md +104 -0
- package/docs/providers/synthetic.md +99 -0
- package/docs/providers/together.md +66 -0
- package/docs/providers/venice.md +282 -0
- package/docs/providers/vercel-ai-gateway.md +60 -0
- package/docs/providers/vllm.md +92 -0
- package/docs/providers/volcengine.md +74 -0
- package/docs/providers/xai.md +60 -0
- package/docs/providers/xiaomi.md +86 -0
- package/docs/providers/zai.md +46 -0
- package/docs/reference/AGENTS.default.md +126 -0
- package/docs/reference/RELEASING.md +42 -0
- package/docs/reference/api-usage-costs.md +144 -0
- package/docs/reference/credits.md +30 -0
- package/docs/reference/device-models.md +47 -0
- package/docs/reference/memory-config.md +711 -0
- package/docs/reference/prompt-caching.md +185 -0
- package/docs/reference/rpc.md +43 -0
- package/docs/reference/secretref-credential-surface.md +140 -0
- package/docs/reference/secretref-user-supplied-credentials-matrix.json +563 -0
- package/docs/reference/session-management-compaction.md +324 -0
- package/docs/reference/templates/AGENTS.dev.md +83 -0
- package/docs/reference/templates/AGENTS.md +219 -0
- package/docs/reference/templates/BOOT.md +11 -0
- package/docs/reference/templates/BOOTSTRAP.md +62 -0
- package/docs/reference/templates/HEARTBEAT.md +14 -0
- package/docs/reference/templates/IDENTITY.dev.md +47 -0
- package/docs/reference/templates/IDENTITY.md +29 -0
- package/docs/reference/templates/SOUL.dev.md +76 -0
- package/docs/reference/templates/SOUL.md +43 -0
- package/docs/reference/templates/TOOLS.dev.md +24 -0
- package/docs/reference/templates/TOOLS.md +47 -0
- package/docs/reference/templates/USER.dev.md +18 -0
- package/docs/reference/templates/USER.md +23 -0
- package/docs/reference/test.md +90 -0
- package/docs/reference/token-use.md +175 -0
- package/docs/reference/transcript-hygiene.md +151 -0
- package/docs/reference/wizard.md +235 -0
- package/docs/security/CONTRIBUTING-THREAT-MODEL.md +98 -0
- package/docs/security/THREAT-MODEL-ATLAS.md +611 -0
- package/docs/security/formal-verification.md +167 -0
- package/docs/start/bootstrapping.md +41 -0
- package/docs/start/docs-directory.md +66 -0
- package/docs/start/getting-started.md +116 -0
- package/docs/start/hubs.md +198 -0
- package/docs/start/lore.md +219 -0
- package/docs/start/onboarding-overview.md +67 -0
- package/docs/start/onboarding.md +91 -0
- package/docs/start/openclaw.md +221 -0
- package/docs/start/quickstart.md +22 -0
- package/docs/start/setup.md +164 -0
- package/docs/start/showcase.md +418 -0
- package/docs/start/wizard-cli-automation.md +215 -0
- package/docs/start/wizard-cli-reference.md +299 -0
- package/docs/start/wizard.md +125 -0
- package/docs/style.css +37 -0
- package/docs/tools/acp-agents.md +623 -0
- package/docs/tools/agent-send.md +100 -0
- package/docs/tools/apply-patch.md +51 -0
- package/docs/tools/brave-search.md +93 -0
- package/docs/tools/browser-linux-troubleshooting.md +138 -0
- package/docs/tools/browser-login.md +73 -0
- package/docs/tools/browser-wsl2-windows-remote-cdp-troubleshooting.md +211 -0
- package/docs/tools/browser.md +731 -0
- package/docs/tools/btw.md +142 -0
- package/docs/tools/capability-cookbook.md +119 -0
- package/docs/tools/clawhub.md +298 -0
- package/docs/tools/creating-skills.md +117 -0
- package/docs/tools/diffs.md +386 -0
- package/docs/tools/elevated.md +114 -0
- package/docs/tools/exec-approvals.md +430 -0
- package/docs/tools/exec.md +207 -0
- package/docs/tools/firecrawl.md +140 -0
- package/docs/tools/index.md +137 -0
- package/docs/tools/llm-task.md +119 -0
- package/docs/tools/lobster.md +340 -0
- package/docs/tools/loop-detection.md +100 -0
- package/docs/tools/multi-agent-sandbox-tools.md +364 -0
- package/docs/tools/pdf.md +156 -0
- package/docs/tools/perplexity-search.md +174 -0
- package/docs/tools/plugin.md +255 -0
- package/docs/tools/reactions.md +64 -0
- package/docs/tools/skills-config.md +86 -0
- package/docs/tools/skills.md +309 -0
- package/docs/tools/slash-commands.md +294 -0
- package/docs/tools/subagents.md +295 -0
- package/docs/tools/tavily.md +125 -0
- package/docs/tools/thinking.md +96 -0
- package/docs/tools/tts.md +406 -0
- package/docs/tools/web.md +516 -0
- package/docs/tts.md +406 -0
- package/docs/vps.md +112 -0
- package/docs/web/control-ui.md +275 -0
- package/docs/web/dashboard.md +54 -0
- package/docs/web/index.md +120 -0
- package/docs/web/tui.md +170 -0
- package/docs/web/webchat.md +61 -0
- package/docs/whatsapp-openclaw-ai-zh.jpg +0 -0
- package/docs/whatsapp-openclaw.jpg +0 -0
- package/docs/zh-CN/AGENTS.md +61 -0
- package/docs/zh-CN/automation/auth-monitoring.md +47 -0
- package/docs/zh-CN/automation/cron-jobs.md +435 -0
- package/docs/zh-CN/automation/cron-vs-heartbeat.md +286 -0
- package/docs/zh-CN/automation/gmail-pubsub.md +249 -0
- package/docs/zh-CN/automation/hooks.md +1051 -0
- package/docs/zh-CN/automation/poll.md +76 -0
- package/docs/zh-CN/automation/troubleshooting.md +8 -0
- package/docs/zh-CN/automation/webhook.md +163 -0
- package/docs/zh-CN/brave-search.md +60 -0
- package/docs/zh-CN/channels/bluebubbles.md +354 -0
- package/docs/zh-CN/channels/broadcast-groups.md +449 -0
- package/docs/zh-CN/channels/channel-routing.md +117 -0
- package/docs/zh-CN/channels/discord.md +468 -0
- package/docs/zh-CN/channels/feishu.md +728 -0
- package/docs/zh-CN/channels/googlechat.md +257 -0
- package/docs/zh-CN/channels/grammy.md +38 -0
- package/docs/zh-CN/channels/group-messages.md +91 -0
- package/docs/zh-CN/channels/groups.md +379 -0
- package/docs/zh-CN/channels/imessage.md +302 -0
- package/docs/zh-CN/channels/index.md +53 -0
- package/docs/zh-CN/channels/line.md +180 -0
- package/docs/zh-CN/channels/location.md +63 -0
- package/docs/zh-CN/channels/matrix.md +221 -0
- package/docs/zh-CN/channels/mattermost.md +144 -0
- package/docs/zh-CN/channels/msteams.md +775 -0
- package/docs/zh-CN/channels/nextcloud-talk.md +142 -0
- package/docs/zh-CN/channels/nostr.md +249 -0
- package/docs/zh-CN/channels/pairing.md +89 -0
- package/docs/zh-CN/channels/signal.md +209 -0
- package/docs/zh-CN/channels/slack.md +531 -0
- package/docs/zh-CN/channels/synology-chat.md +138 -0
- package/docs/zh-CN/channels/telegram.md +751 -0
- package/docs/zh-CN/channels/tlon.md +136 -0
- package/docs/zh-CN/channels/troubleshooting.md +36 -0
- package/docs/zh-CN/channels/twitch.md +385 -0
- package/docs/zh-CN/channels/whatsapp.md +411 -0
- package/docs/zh-CN/channels/zalo.md +196 -0
- package/docs/zh-CN/channels/zalouser.md +147 -0
- package/docs/zh-CN/cli/acp.md +173 -0
- package/docs/zh-CN/cli/agent.md +30 -0
- package/docs/zh-CN/cli/agents.md +82 -0
- package/docs/zh-CN/cli/approvals.md +57 -0
- package/docs/zh-CN/cli/browser.md +114 -0
- package/docs/zh-CN/cli/channels.md +86 -0
- package/docs/zh-CN/cli/config.md +57 -0
- package/docs/zh-CN/cli/configure.md +38 -0
- package/docs/zh-CN/cli/cron.md +43 -0
- package/docs/zh-CN/cli/dashboard.md +23 -0
- package/docs/zh-CN/cli/devices.md +74 -0
- package/docs/zh-CN/cli/directory.md +70 -0
- package/docs/zh-CN/cli/dns.md +30 -0
- package/docs/zh-CN/cli/docs.md +22 -0
- package/docs/zh-CN/cli/doctor.md +48 -0
- package/docs/zh-CN/cli/gateway.md +206 -0
- package/docs/zh-CN/cli/health.md +28 -0
- package/docs/zh-CN/cli/hooks.md +298 -0
- package/docs/zh-CN/cli/index.md +1143 -0
- package/docs/zh-CN/cli/logs.md +31 -0
- package/docs/zh-CN/cli/memory.md +52 -0
- package/docs/zh-CN/cli/message.md +246 -0
- package/docs/zh-CN/cli/models.md +85 -0
- package/docs/zh-CN/cli/node.md +115 -0
- package/docs/zh-CN/cli/nodes.md +80 -0
- package/docs/zh-CN/cli/onboard.md +164 -0
- package/docs/zh-CN/cli/pairing.md +28 -0
- package/docs/zh-CN/cli/plugins.md +66 -0
- package/docs/zh-CN/cli/reset.md +24 -0
- package/docs/zh-CN/cli/sandbox.md +158 -0
- package/docs/zh-CN/cli/security.md +33 -0
- package/docs/zh-CN/cli/sessions.md +23 -0
- package/docs/zh-CN/cli/setup.md +36 -0
- package/docs/zh-CN/cli/skills.md +33 -0
- package/docs/zh-CN/cli/status.md +33 -0
- package/docs/zh-CN/cli/system.md +63 -0
- package/docs/zh-CN/cli/tui.md +30 -0
- package/docs/zh-CN/cli/uninstall.md +24 -0
- package/docs/zh-CN/cli/update.md +101 -0
- package/docs/zh-CN/cli/voicecall.md +41 -0
- package/docs/zh-CN/cli/webhooks.md +32 -0
- package/docs/zh-CN/concepts/agent-loop.md +146 -0
- package/docs/zh-CN/concepts/agent-workspace.md +219 -0
- package/docs/zh-CN/concepts/agent.md +115 -0
- package/docs/zh-CN/concepts/architecture.md +123 -0
- package/docs/zh-CN/concepts/compaction.md +67 -0
- package/docs/zh-CN/concepts/context.md +168 -0
- package/docs/zh-CN/concepts/features.md +59 -0
- package/docs/zh-CN/concepts/markdown-formatting.md +117 -0
- package/docs/zh-CN/concepts/memory.md +412 -0
- package/docs/zh-CN/concepts/messages.md +141 -0
- package/docs/zh-CN/concepts/model-failover.md +145 -0
- package/docs/zh-CN/concepts/model-providers.md +606 -0
- package/docs/zh-CN/concepts/models.md +225 -0
- package/docs/zh-CN/concepts/multi-agent.md +372 -0
- package/docs/zh-CN/concepts/oauth.md +164 -0
- package/docs/zh-CN/concepts/presence.md +99 -0
- package/docs/zh-CN/concepts/queue.md +94 -0
- package/docs/zh-CN/concepts/retry.md +76 -0
- package/docs/zh-CN/concepts/session-pruning.md +129 -0
- package/docs/zh-CN/concepts/session-tool.md +200 -0
- package/docs/zh-CN/concepts/session.md +166 -0
- package/docs/zh-CN/concepts/streaming.md +133 -0
- package/docs/zh-CN/concepts/system-prompt.md +101 -0
- package/docs/zh-CN/concepts/timezone.md +96 -0
- package/docs/zh-CN/concepts/typebox.md +284 -0
- package/docs/zh-CN/concepts/typing-indicators.md +74 -0
- package/docs/zh-CN/concepts/usage-tracking.md +42 -0
- package/docs/zh-CN/date-time.md +129 -0
- package/docs/zh-CN/debug/node-issue.md +90 -0
- package/docs/zh-CN/diagnostics/flags.md +98 -0
- package/docs/zh-CN/gateway/authentication.md +184 -0
- package/docs/zh-CN/gateway/background-process.md +100 -0
- package/docs/zh-CN/gateway/bonjour.md +174 -0
- package/docs/zh-CN/gateway/bridge-protocol.md +86 -0
- package/docs/zh-CN/gateway/cli-backends.md +213 -0
- package/docs/zh-CN/gateway/configuration-examples.md +587 -0
- package/docs/zh-CN/gateway/configuration-reference.md +3103 -0
- package/docs/zh-CN/gateway/configuration.md +640 -0
- package/docs/zh-CN/gateway/discovery.md +123 -0
- package/docs/zh-CN/gateway/doctor.md +238 -0
- package/docs/zh-CN/gateway/gateway-lock.md +41 -0
- package/docs/zh-CN/gateway/health.md +42 -0
- package/docs/zh-CN/gateway/heartbeat.md +274 -0
- package/docs/zh-CN/gateway/index.md +335 -0
- package/docs/zh-CN/gateway/local-models.md +159 -0
- package/docs/zh-CN/gateway/logging.md +114 -0
- package/docs/zh-CN/gateway/multiple-gateways.md +119 -0
- package/docs/zh-CN/gateway/network-model.md +23 -0
- package/docs/zh-CN/gateway/openai-http-api.md +125 -0
- package/docs/zh-CN/gateway/openresponses-http-api.md +317 -0
- package/docs/zh-CN/gateway/pairing.md +99 -0
- package/docs/zh-CN/gateway/protocol.md +220 -0
- package/docs/zh-CN/gateway/remote-gateway-readme.md +164 -0
- package/docs/zh-CN/gateway/remote.md +133 -0
- package/docs/zh-CN/gateway/sandbox-vs-tool-policy-vs-elevated.md +135 -0
- package/docs/zh-CN/gateway/sandboxing.md +188 -0
- package/docs/zh-CN/gateway/security/index.md +777 -0
- package/docs/zh-CN/gateway/tailscale.md +124 -0
- package/docs/zh-CN/gateway/tools-invoke-http-api.md +92 -0
- package/docs/zh-CN/gateway/troubleshooting.md +771 -0
- package/docs/zh-CN/help/debugging.md +160 -0
- package/docs/zh-CN/help/environment.md +88 -0
- package/docs/zh-CN/help/faq.md +2640 -0
- package/docs/zh-CN/help/index.md +28 -0
- package/docs/zh-CN/help/scripts.md +35 -0
- package/docs/zh-CN/help/testing.md +375 -0
- package/docs/zh-CN/help/troubleshooting.md +104 -0
- package/docs/zh-CN/index.md +186 -0
- package/docs/zh-CN/install/ansible.md +215 -0
- package/docs/zh-CN/install/bun.md +65 -0
- package/docs/zh-CN/install/development-channels.md +81 -0
- package/docs/zh-CN/install/docker.md +532 -0
- package/docs/zh-CN/install/exe-dev.md +133 -0
- package/docs/zh-CN/install/fly.md +490 -0
- package/docs/zh-CN/install/gcp.md +510 -0
- package/docs/zh-CN/install/hetzner.md +337 -0
- package/docs/zh-CN/install/index.md +235 -0
- package/docs/zh-CN/install/installer.md +422 -0
- package/docs/zh-CN/install/macos-vm.md +288 -0
- package/docs/zh-CN/install/migrating.md +199 -0
- package/docs/zh-CN/install/nix.md +99 -0
- package/docs/zh-CN/install/node.md +8 -0
- package/docs/zh-CN/install/northflank.mdx +60 -0
- package/docs/zh-CN/install/railway.mdx +106 -0
- package/docs/zh-CN/install/render.mdx +169 -0
- package/docs/zh-CN/install/uninstall.md +135 -0
- package/docs/zh-CN/install/updating.md +233 -0
- package/docs/zh-CN/logging.md +329 -0
- package/docs/zh-CN/network.md +59 -0
- package/docs/zh-CN/nodes/audio.md +120 -0
- package/docs/zh-CN/nodes/camera.md +162 -0
- package/docs/zh-CN/nodes/images.md +79 -0
- package/docs/zh-CN/nodes/index.md +348 -0
- package/docs/zh-CN/nodes/location-command.md +120 -0
- package/docs/zh-CN/nodes/media-understanding.md +380 -0
- package/docs/zh-CN/nodes/talk.md +97 -0
- package/docs/zh-CN/nodes/troubleshooting.md +8 -0
- package/docs/zh-CN/nodes/voicewake.md +72 -0
- package/docs/zh-CN/perplexity.md +102 -0
- package/docs/zh-CN/pi-dev.md +77 -0
- package/docs/zh-CN/pi.md +619 -0
- package/docs/zh-CN/platforms/android.md +155 -0
- package/docs/zh-CN/platforms/digitalocean.md +273 -0
- package/docs/zh-CN/platforms/index.md +60 -0
- package/docs/zh-CN/platforms/ios.md +114 -0
- package/docs/zh-CN/platforms/linux.md +100 -0
- package/docs/zh-CN/platforms/mac/bundled-gateway.md +75 -0
- package/docs/zh-CN/platforms/mac/canvas.md +128 -0
- package/docs/zh-CN/platforms/mac/child-process.md +73 -0
- package/docs/zh-CN/platforms/mac/dev-setup.md +109 -0
- package/docs/zh-CN/platforms/mac/health.md +41 -0
- package/docs/zh-CN/platforms/mac/icon.md +38 -0
- package/docs/zh-CN/platforms/mac/logging.md +64 -0
- package/docs/zh-CN/platforms/mac/menu-bar.md +88 -0
- package/docs/zh-CN/platforms/mac/peekaboo.md +62 -0
- package/docs/zh-CN/platforms/mac/permissions.md +46 -0
- package/docs/zh-CN/platforms/mac/remote.md +90 -0
- package/docs/zh-CN/platforms/mac/signing.md +54 -0
- package/docs/zh-CN/platforms/mac/skills.md +40 -0
- package/docs/zh-CN/platforms/mac/voice-overlay.md +67 -0
- package/docs/zh-CN/platforms/mac/voicewake.md +74 -0
- package/docs/zh-CN/platforms/mac/webchat.md +43 -0
- package/docs/zh-CN/platforms/mac/xpc.md +68 -0
- package/docs/zh-CN/platforms/macos.md +193 -0
- package/docs/zh-CN/platforms/oracle.md +310 -0
- package/docs/zh-CN/platforms/raspberry-pi.md +416 -0
- package/docs/zh-CN/platforms/windows.md +247 -0
- package/docs/zh-CN/plugins/agent-tools.md +99 -0
- package/docs/zh-CN/plugins/manifest.md +68 -0
- package/docs/zh-CN/plugins/voice-call.md +250 -0
- package/docs/zh-CN/plugins/zalouser.md +88 -0
- package/docs/zh-CN/prose.md +141 -0
- package/docs/zh-CN/providers/anthropic.md +265 -0
- package/docs/zh-CN/providers/bedrock.md +170 -0
- package/docs/zh-CN/providers/claude-max-api-proxy.md +155 -0
- package/docs/zh-CN/providers/cloudflare-ai-gateway.md +78 -0
- package/docs/zh-CN/providers/deepgram.md +97 -0
- package/docs/zh-CN/providers/github-copilot.md +67 -0
- package/docs/zh-CN/providers/glm.md +50 -0
- package/docs/zh-CN/providers/huggingface.md +216 -0
- package/docs/zh-CN/providers/index.md +69 -0
- package/docs/zh-CN/providers/kilocode.md +80 -0
- package/docs/zh-CN/providers/litellm.md +160 -0
- package/docs/zh-CN/providers/minimax.md +222 -0
- package/docs/zh-CN/providers/mistral.md +61 -0
- package/docs/zh-CN/providers/models.md +51 -0
- package/docs/zh-CN/providers/moonshot.md +182 -0
- package/docs/zh-CN/providers/nvidia.md +62 -0
- package/docs/zh-CN/providers/ollama.md +359 -0
- package/docs/zh-CN/providers/openai.md +308 -0
- package/docs/zh-CN/providers/opencode-go.md +52 -0
- package/docs/zh-CN/providers/opencode.md +71 -0
- package/docs/zh-CN/providers/openrouter.md +44 -0
- package/docs/zh-CN/providers/qianfan.md +45 -0
- package/docs/zh-CN/providers/qwen.md +55 -0
- package/docs/zh-CN/providers/sglang.md +111 -0
- package/docs/zh-CN/providers/synthetic.md +106 -0
- package/docs/zh-CN/providers/together.md +72 -0
- package/docs/zh-CN/providers/venice.md +289 -0
- package/docs/zh-CN/providers/vercel-ai-gateway.md +66 -0
- package/docs/zh-CN/providers/xiaomi.md +93 -0
- package/docs/zh-CN/providers/zai.md +53 -0
- package/docs/zh-CN/reference/AGENTS.default.md +131 -0
- package/docs/zh-CN/reference/RELEASING.md +48 -0
- package/docs/zh-CN/reference/api-usage-costs.md +141 -0
- package/docs/zh-CN/reference/credits.md +34 -0
- package/docs/zh-CN/reference/device-models.md +54 -0
- package/docs/zh-CN/reference/rpc.md +48 -0
- package/docs/zh-CN/reference/session-management-compaction.md +287 -0
- package/docs/zh-CN/reference/templates/AGENTS.dev.md +89 -0
- package/docs/zh-CN/reference/templates/AGENTS.md +225 -0
- package/docs/zh-CN/reference/templates/BOOT.md +17 -0
- package/docs/zh-CN/reference/templates/BOOTSTRAP.md +68 -0
- package/docs/zh-CN/reference/templates/HEARTBEAT.md +18 -0
- package/docs/zh-CN/reference/templates/IDENTITY.dev.md +54 -0
- package/docs/zh-CN/reference/templates/IDENTITY.md +36 -0
- package/docs/zh-CN/reference/templates/SOUL.dev.md +83 -0
- package/docs/zh-CN/reference/templates/SOUL.md +49 -0
- package/docs/zh-CN/reference/templates/TOOLS.dev.md +31 -0
- package/docs/zh-CN/reference/templates/TOOLS.md +53 -0
- package/docs/zh-CN/reference/templates/USER.dev.md +25 -0
- package/docs/zh-CN/reference/templates/USER.md +30 -0
- package/docs/zh-CN/reference/test.md +57 -0
- package/docs/zh-CN/reference/token-use.md +119 -0
- package/docs/zh-CN/reference/transcript-hygiene.md +109 -0
- package/docs/zh-CN/reference/wizard.md +242 -0
- package/docs/zh-CN/security/formal-verification.md +171 -0
- package/docs/zh-CN/start/bootstrapping.md +9 -0
- package/docs/zh-CN/start/docs-directory.md +70 -0
- package/docs/zh-CN/start/getting-started.md +143 -0
- package/docs/zh-CN/start/hubs.md +194 -0
- package/docs/zh-CN/start/lore.md +226 -0
- package/docs/zh-CN/start/onboarding-overview.md +58 -0
- package/docs/zh-CN/start/onboarding.md +105 -0
- package/docs/zh-CN/start/openclaw.md +248 -0
- package/docs/zh-CN/start/quickstart.md +88 -0
- package/docs/zh-CN/start/setup.md +153 -0
- package/docs/zh-CN/start/showcase.md +423 -0
- package/docs/zh-CN/start/wizard-cli-automation.md +222 -0
- package/docs/zh-CN/start/wizard-cli-reference.md +306 -0
- package/docs/zh-CN/start/wizard.md +132 -0
- package/docs/zh-CN/tools/agent-send.md +59 -0
- package/docs/zh-CN/tools/apply-patch.md +57 -0
- package/docs/zh-CN/tools/browser-linux-troubleshooting.md +144 -0
- package/docs/zh-CN/tools/browser-login.md +75 -0
- package/docs/zh-CN/tools/browser.md +553 -0
- package/docs/zh-CN/tools/chrome-extension.md +183 -0
- package/docs/zh-CN/tools/clawhub.md +209 -0
- package/docs/zh-CN/tools/creating-skills.md +61 -0
- package/docs/zh-CN/tools/elevated.md +64 -0
- package/docs/zh-CN/tools/exec-approvals.md +234 -0
- package/docs/zh-CN/tools/exec.md +169 -0
- package/docs/zh-CN/tools/firecrawl.md +68 -0
- package/docs/zh-CN/tools/index.md +515 -0
- package/docs/zh-CN/tools/llm-task.md +117 -0
- package/docs/zh-CN/tools/lobster.md +349 -0
- package/docs/zh-CN/tools/multi-agent-sandbox-tools.md +401 -0
- package/docs/zh-CN/tools/plugin.md +1612 -0
- package/docs/zh-CN/tools/reactions.md +29 -0
- package/docs/zh-CN/tools/skills-config.md +78 -0
- package/docs/zh-CN/tools/skills.md +279 -0
- package/docs/zh-CN/tools/slash-commands.md +205 -0
- package/docs/zh-CN/tools/subagents.md +167 -0
- package/docs/zh-CN/tools/thinking.md +80 -0
- package/docs/zh-CN/tools/web.md +289 -0
- package/docs/zh-CN/tts.md +375 -0
- package/docs/zh-CN/vps.md +47 -0
- package/docs/zh-CN/web/control-ui.md +191 -0
- package/docs/zh-CN/web/dashboard.md +53 -0
- package/docs/zh-CN/web/index.md +118 -0
- package/docs/zh-CN/web/tui.md +166 -0
- package/docs/zh-CN/web/webchat.md +56 -0
- package/package.json +841 -0
- package/quantumclaw.mjs +135 -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/bluebubbles/SKILL.md +131 -0
- package/skills/camsnap/SKILL.md +45 -0
- package/skills/canvas/SKILL.md +198 -0
- package/skills/clawhub/SKILL.md +77 -0
- package/skills/coding-agent/SKILL.md +295 -0
- package/skills/discord/SKILL.md +197 -0
- package/skills/eightctl/SKILL.md +50 -0
- package/skills/gemini/SKILL.md +43 -0
- package/skills/gh-issues/SKILL.md +865 -0
- package/skills/gifgrep/SKILL.md +79 -0
- package/skills/github/SKILL.md +163 -0
- package/skills/gog/SKILL.md +116 -0
- package/skills/goplaces/SKILL.md +52 -0
- package/skills/healthcheck/SKILL.md +245 -0
- package/skills/himalaya/SKILL.md +257 -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/model-usage/SKILL.md +69 -0
- package/skills/model-usage/references/codexbar-cli.md +33 -0
- package/skills/model-usage/scripts/model_usage.py +320 -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 +142 -0
- package/skills/notion/SKILL.md +174 -0
- package/skills/obsidian/SKILL.md +81 -0
- package/skills/openai-image-gen/SKILL.md +92 -0
- package/skills/openai-image-gen/scripts/gen.py +328 -0
- package/skills/openai-image-gen/scripts/test_gen.py +140 -0
- package/skills/openai-whisper/SKILL.md +38 -0
- package/skills/openai-whisper-api/SKILL.md +52 -0
- package/skills/openai-whisper-api/scripts/transcribe.sh +85 -0
- package/skills/openhue/SKILL.md +112 -0
- package/skills/oracle/SKILL.md +125 -0
- package/skills/ordercli/SKILL.md +78 -0
- package/skills/peekaboo/SKILL.md +190 -0
- package/skills/sag/SKILL.md +87 -0
- package/skills/session-logs/SKILL.md +115 -0
- package/skills/sherpa-onnx-tts/SKILL.md +103 -0
- package/skills/sherpa-onnx-tts/bin/sherpa-onnx-tts +178 -0
- package/skills/skill-creator/SKILL.md +372 -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 +139 -0
- package/skills/skill-creator/scripts/quick_validate.py +159 -0
- package/skills/skill-creator/scripts/test_package_skill.py +160 -0
- package/skills/skill-creator/scripts/test_quick_validate.py +72 -0
- package/skills/slack/SKILL.md +144 -0
- package/skills/songsee/SKILL.md +49 -0
- package/skills/sonoscli/SKILL.md +65 -0
- package/skills/spotify-player/SKILL.md +64 -0
- package/skills/summarize/SKILL.md +87 -0
- package/skills/things-mac/SKILL.md +86 -0
- package/skills/tmux/SKILL.md +153 -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 +95 -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 +112 -0
- package/skills/xurl/SKILL.md +461 -0
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "Use Synthetic's Anthropic-compatible API in QuantumClaw"
|
|
3
|
+
read_when:
|
|
4
|
+
- You want to use Synthetic as a model provider
|
|
5
|
+
- You need a Synthetic API key or base URL setup
|
|
6
|
+
title: "Synthetic"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# Synthetic
|
|
10
|
+
|
|
11
|
+
Synthetic exposes Anthropic-compatible endpoints. QuantumClaw registers it as the
|
|
12
|
+
`synthetic` provider and uses the Anthropic Messages API.
|
|
13
|
+
|
|
14
|
+
## Quick setup
|
|
15
|
+
|
|
16
|
+
1. Set `SYNTHETIC_API_KEY` (or run the wizard below).
|
|
17
|
+
2. Run onboarding:
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
quantumclaw onboard --auth-choice synthetic-api-key
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
The default model is set to:
|
|
24
|
+
|
|
25
|
+
```
|
|
26
|
+
synthetic/hf:MiniMaxAI/MiniMax-M2.5
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Config example
|
|
30
|
+
|
|
31
|
+
```json5
|
|
32
|
+
{
|
|
33
|
+
env: { SYNTHETIC_API_KEY: "sk-..." },
|
|
34
|
+
agents: {
|
|
35
|
+
defaults: {
|
|
36
|
+
model: { primary: "synthetic/hf:MiniMaxAI/MiniMax-M2.5" },
|
|
37
|
+
models: { "synthetic/hf:MiniMaxAI/MiniMax-M2.5": { alias: "MiniMax M2.5" } },
|
|
38
|
+
},
|
|
39
|
+
},
|
|
40
|
+
models: {
|
|
41
|
+
mode: "merge",
|
|
42
|
+
providers: {
|
|
43
|
+
synthetic: {
|
|
44
|
+
baseUrl: "https://api.synthetic.new/anthropic",
|
|
45
|
+
apiKey: "${SYNTHETIC_API_KEY}",
|
|
46
|
+
api: "anthropic-messages",
|
|
47
|
+
models: [
|
|
48
|
+
{
|
|
49
|
+
id: "hf:MiniMaxAI/MiniMax-M2.5",
|
|
50
|
+
name: "MiniMax M2.5",
|
|
51
|
+
reasoning: false,
|
|
52
|
+
input: ["text"],
|
|
53
|
+
cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
|
|
54
|
+
contextWindow: 192000,
|
|
55
|
+
maxTokens: 65536,
|
|
56
|
+
},
|
|
57
|
+
],
|
|
58
|
+
},
|
|
59
|
+
},
|
|
60
|
+
},
|
|
61
|
+
}
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
Note: QuantumClaw's Anthropic client appends `/v1` to the base URL, so use
|
|
65
|
+
`https://api.synthetic.new/anthropic` (not `/anthropic/v1`). If Synthetic changes
|
|
66
|
+
its base URL, override `models.providers.synthetic.baseUrl`.
|
|
67
|
+
|
|
68
|
+
## Model catalog
|
|
69
|
+
|
|
70
|
+
All models below use cost `0` (input/output/cache).
|
|
71
|
+
|
|
72
|
+
| Model ID | Context window | Max tokens | Reasoning | Input |
|
|
73
|
+
| ------------------------------------------------------ | -------------- | ---------- | --------- | ------------ |
|
|
74
|
+
| `hf:MiniMaxAI/MiniMax-M2.5` | 192000 | 65536 | false | text |
|
|
75
|
+
| `hf:moonshotai/Kimi-K2-Thinking` | 256000 | 8192 | true | text |
|
|
76
|
+
| `hf:zai-org/GLM-4.7` | 198000 | 128000 | false | text |
|
|
77
|
+
| `hf:deepseek-ai/DeepSeek-R1-0528` | 128000 | 8192 | false | text |
|
|
78
|
+
| `hf:deepseek-ai/DeepSeek-V3-0324` | 128000 | 8192 | false | text |
|
|
79
|
+
| `hf:deepseek-ai/DeepSeek-V3.1` | 128000 | 8192 | false | text |
|
|
80
|
+
| `hf:deepseek-ai/DeepSeek-V3.1-Terminus` | 128000 | 8192 | false | text |
|
|
81
|
+
| `hf:deepseek-ai/DeepSeek-V3.2` | 159000 | 8192 | false | text |
|
|
82
|
+
| `hf:meta-llama/Llama-3.3-70B-Instruct` | 128000 | 8192 | false | text |
|
|
83
|
+
| `hf:meta-llama/Llama-4-Maverick-17B-128E-Instruct-FP8` | 524000 | 8192 | false | text |
|
|
84
|
+
| `hf:moonshotai/Kimi-K2-Instruct-0905` | 256000 | 8192 | false | text |
|
|
85
|
+
| `hf:openai/gpt-oss-120b` | 128000 | 8192 | false | text |
|
|
86
|
+
| `hf:Qwen/Qwen3-235B-A22B-Instruct-2507` | 256000 | 8192 | false | text |
|
|
87
|
+
| `hf:Qwen/Qwen3-Coder-480B-A35B-Instruct` | 256000 | 8192 | false | text |
|
|
88
|
+
| `hf:Qwen/Qwen3-VL-235B-A22B-Instruct` | 250000 | 8192 | false | text + image |
|
|
89
|
+
| `hf:zai-org/GLM-4.5` | 128000 | 128000 | false | text |
|
|
90
|
+
| `hf:zai-org/GLM-4.6` | 198000 | 128000 | false | text |
|
|
91
|
+
| `hf:deepseek-ai/DeepSeek-V3` | 128000 | 8192 | false | text |
|
|
92
|
+
| `hf:Qwen/Qwen3-235B-A22B-Thinking-2507` | 256000 | 8192 | true | text |
|
|
93
|
+
|
|
94
|
+
## Notes
|
|
95
|
+
|
|
96
|
+
- Model refs use `synthetic/<modelId>`.
|
|
97
|
+
- If you enable a model allowlist (`agents.defaults.models`), add every model you
|
|
98
|
+
plan to use.
|
|
99
|
+
- See [Model providers](/concepts/model-providers) for provider rules.
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Together AI"
|
|
3
|
+
summary: "Together AI setup (auth + model selection)"
|
|
4
|
+
read_when:
|
|
5
|
+
- You want to use Together AI with QuantumClaw
|
|
6
|
+
- You need the API key env var or CLI auth choice
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# Together AI
|
|
10
|
+
|
|
11
|
+
The [Together AI](https://together.ai) provides access to leading open-source models including Llama, DeepSeek, Kimi, and more through a unified API.
|
|
12
|
+
|
|
13
|
+
- Provider: `together`
|
|
14
|
+
- Auth: `TOGETHER_API_KEY`
|
|
15
|
+
- API: OpenAI-compatible
|
|
16
|
+
|
|
17
|
+
## Quick start
|
|
18
|
+
|
|
19
|
+
1. Set the API key (recommended: store it for the Gateway):
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
quantumclaw onboard --auth-choice together-api-key
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
2. Set a default model:
|
|
26
|
+
|
|
27
|
+
```json5
|
|
28
|
+
{
|
|
29
|
+
agents: {
|
|
30
|
+
defaults: {
|
|
31
|
+
model: { primary: "together/moonshotai/Kimi-K2.5" },
|
|
32
|
+
},
|
|
33
|
+
},
|
|
34
|
+
}
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Non-interactive example
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
quantumclaw onboard --non-interactive \
|
|
41
|
+
--mode local \
|
|
42
|
+
--auth-choice together-api-key \
|
|
43
|
+
--together-api-key "$TOGETHER_API_KEY"
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
This will set `together/moonshotai/Kimi-K2.5` as the default model.
|
|
47
|
+
|
|
48
|
+
## Environment note
|
|
49
|
+
|
|
50
|
+
If the Gateway runs as a daemon (launchd/systemd), make sure `TOGETHER_API_KEY`
|
|
51
|
+
is available to that process (for example, in `~/.quantumclaw/.env` or via
|
|
52
|
+
`env.shellEnv`).
|
|
53
|
+
|
|
54
|
+
## Available models
|
|
55
|
+
|
|
56
|
+
Together AI provides access to many popular open-source models:
|
|
57
|
+
|
|
58
|
+
- **GLM 4.7 Fp8** - Default model with 200K context window
|
|
59
|
+
- **Llama 3.3 70B Instruct Turbo** - Fast, efficient instruction following
|
|
60
|
+
- **Llama 4 Scout** - Vision model with image understanding
|
|
61
|
+
- **Llama 4 Maverick** - Advanced vision and reasoning
|
|
62
|
+
- **DeepSeek V3.1** - Powerful coding and reasoning model
|
|
63
|
+
- **DeepSeek R1** - Advanced reasoning model
|
|
64
|
+
- **Kimi K2 Instruct** - High-performance model with 262K context window
|
|
65
|
+
|
|
66
|
+
All models support standard chat completions and are OpenAI API compatible.
|
|
@@ -0,0 +1,282 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "Use Venice AI privacy-focused models in QuantumClaw"
|
|
3
|
+
read_when:
|
|
4
|
+
- You want privacy-focused inference in QuantumClaw
|
|
5
|
+
- You want Venice AI setup guidance
|
|
6
|
+
title: "Venice AI"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# Venice AI (Venice highlight)
|
|
10
|
+
|
|
11
|
+
**Venice** is our highlight Venice setup for privacy-first inference with optional anonymized access to proprietary models.
|
|
12
|
+
|
|
13
|
+
Venice AI provides privacy-focused AI inference with support for uncensored models and access to major proprietary models through their anonymized proxy. All inference is private by default—no training on your data, no logging.
|
|
14
|
+
|
|
15
|
+
## Why Venice in QuantumClaw
|
|
16
|
+
|
|
17
|
+
- **Private inference** for open-source models (no logging).
|
|
18
|
+
- **Uncensored models** when you need them.
|
|
19
|
+
- **Anonymized access** to proprietary models (Opus/GPT/Gemini) when quality matters.
|
|
20
|
+
- OpenAI-compatible `/v1` endpoints.
|
|
21
|
+
|
|
22
|
+
## Privacy Modes
|
|
23
|
+
|
|
24
|
+
Venice offers two privacy levels — understanding this is key to choosing your model:
|
|
25
|
+
|
|
26
|
+
| Mode | Description | Models |
|
|
27
|
+
| -------------- | --------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
|
|
28
|
+
| **Private** | Fully private. Prompts/responses are **never stored or logged**. Ephemeral. | Llama, Qwen, DeepSeek, Kimi, MiniMax, Venice Uncensored, etc. |
|
|
29
|
+
| **Anonymized** | Proxied through Venice with metadata stripped. The underlying provider (OpenAI, Anthropic, Google, xAI) sees anonymized requests. | Claude, GPT, Gemini, Grok |
|
|
30
|
+
|
|
31
|
+
## Features
|
|
32
|
+
|
|
33
|
+
- **Privacy-focused**: Choose between "private" (fully private) and "anonymized" (proxied) modes
|
|
34
|
+
- **Uncensored models**: Access to models without content restrictions
|
|
35
|
+
- **Major model access**: Use Claude, GPT, Gemini, and Grok via Venice's anonymized proxy
|
|
36
|
+
- **OpenAI-compatible API**: Standard `/v1` endpoints for easy integration
|
|
37
|
+
- **Streaming**: ✅ Supported on all models
|
|
38
|
+
- **Function calling**: ✅ Supported on select models (check model capabilities)
|
|
39
|
+
- **Vision**: ✅ Supported on models with vision capability
|
|
40
|
+
- **No hard rate limits**: Fair-use throttling may apply for extreme usage
|
|
41
|
+
|
|
42
|
+
## Setup
|
|
43
|
+
|
|
44
|
+
### 1. Get API Key
|
|
45
|
+
|
|
46
|
+
1. Sign up at [venice.ai](https://venice.ai)
|
|
47
|
+
2. Go to **Settings → API Keys → Create new key**
|
|
48
|
+
3. Copy your API key (format: `vapi_xxxxxxxxxxxx`)
|
|
49
|
+
|
|
50
|
+
### 2. Configure QuantumClaw
|
|
51
|
+
|
|
52
|
+
**Option A: Environment Variable**
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
export VENICE_API_KEY="vapi_xxxxxxxxxxxx"
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
**Option B: Interactive Setup (Recommended)**
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
quantumclaw onboard --auth-choice venice-api-key
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
This will:
|
|
65
|
+
|
|
66
|
+
1. Prompt for your API key (or use existing `VENICE_API_KEY`)
|
|
67
|
+
2. Show all available Venice models
|
|
68
|
+
3. Let you pick your default model
|
|
69
|
+
4. Configure the provider automatically
|
|
70
|
+
|
|
71
|
+
**Option C: Non-interactive**
|
|
72
|
+
|
|
73
|
+
```bash
|
|
74
|
+
quantumclaw onboard --non-interactive \
|
|
75
|
+
--auth-choice venice-api-key \
|
|
76
|
+
--venice-api-key "vapi_xxxxxxxxxxxx"
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
### 3. Verify Setup
|
|
80
|
+
|
|
81
|
+
```bash
|
|
82
|
+
quantumclaw agent --model venice/kimi-k2-5 --message "Hello, are you working?"
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
## Model Selection
|
|
86
|
+
|
|
87
|
+
After setup, QuantumClaw shows all available Venice models. Pick based on your needs:
|
|
88
|
+
|
|
89
|
+
- **Default model**: `venice/kimi-k2-5` for strong private reasoning plus vision.
|
|
90
|
+
- **High-capability option**: `venice/claude-opus-4-6` for the strongest anonymized Venice path.
|
|
91
|
+
- **Privacy**: Choose "private" models for fully private inference.
|
|
92
|
+
- **Capability**: Choose "anonymized" models to access Claude, GPT, Gemini via Venice's proxy.
|
|
93
|
+
|
|
94
|
+
Change your default model anytime:
|
|
95
|
+
|
|
96
|
+
```bash
|
|
97
|
+
quantumclaw models set venice/kimi-k2-5
|
|
98
|
+
quantumclaw models set venice/claude-opus-4-6
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
List all available models:
|
|
102
|
+
|
|
103
|
+
```bash
|
|
104
|
+
quantumclaw models list | grep venice
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
## Configure via `quantumclaw configure`
|
|
108
|
+
|
|
109
|
+
1. Run `quantumclaw configure`
|
|
110
|
+
2. Select **Model/auth**
|
|
111
|
+
3. Choose **Venice AI**
|
|
112
|
+
|
|
113
|
+
## Which Model Should I Use?
|
|
114
|
+
|
|
115
|
+
| Use Case | Recommended Model | Why |
|
|
116
|
+
| -------------------------- | -------------------------------- | -------------------------------------------- |
|
|
117
|
+
| **General chat (default)** | `kimi-k2-5` | Strong private reasoning plus vision |
|
|
118
|
+
| **Best overall quality** | `claude-opus-4-6` | Strongest anonymized Venice option |
|
|
119
|
+
| **Privacy + coding** | `qwen3-coder-480b-a35b-instruct` | Private coding model with large context |
|
|
120
|
+
| **Private vision** | `kimi-k2-5` | Vision support without leaving private mode |
|
|
121
|
+
| **Fast + cheap** | `qwen3-4b` | Lightweight reasoning model |
|
|
122
|
+
| **Complex private tasks** | `deepseek-v3.2` | Strong reasoning, but no Venice tool support |
|
|
123
|
+
| **Uncensored** | `venice-uncensored` | No content restrictions |
|
|
124
|
+
|
|
125
|
+
## Available Models (41 Total)
|
|
126
|
+
|
|
127
|
+
### Private Models (26) - Fully Private, No Logging
|
|
128
|
+
|
|
129
|
+
| Model ID | Name | Context | Features |
|
|
130
|
+
| -------------------------------------- | ----------------------------------- | ------- | -------------------------- |
|
|
131
|
+
| `kimi-k2-5` | Kimi K2.5 | 256k | Default, reasoning, vision |
|
|
132
|
+
| `kimi-k2-thinking` | Kimi K2 Thinking | 256k | Reasoning |
|
|
133
|
+
| `llama-3.3-70b` | Llama 3.3 70B | 128k | General |
|
|
134
|
+
| `llama-3.2-3b` | Llama 3.2 3B | 128k | General |
|
|
135
|
+
| `hermes-3-llama-3.1-405b` | Hermes 3 Llama 3.1 405B | 128k | General, tools disabled |
|
|
136
|
+
| `qwen3-235b-a22b-thinking-2507` | Qwen3 235B Thinking | 128k | Reasoning |
|
|
137
|
+
| `qwen3-235b-a22b-instruct-2507` | Qwen3 235B Instruct | 128k | General |
|
|
138
|
+
| `qwen3-coder-480b-a35b-instruct` | Qwen3 Coder 480B | 256k | Coding |
|
|
139
|
+
| `qwen3-coder-480b-a35b-instruct-turbo` | Qwen3 Coder 480B Turbo | 256k | Coding |
|
|
140
|
+
| `qwen3-5-35b-a3b` | Qwen3.5 35B A3B | 256k | Reasoning, vision |
|
|
141
|
+
| `qwen3-next-80b` | Qwen3 Next 80B | 256k | General |
|
|
142
|
+
| `qwen3-vl-235b-a22b` | Qwen3 VL 235B (Vision) | 256k | Vision |
|
|
143
|
+
| `qwen3-4b` | Venice Small (Qwen3 4B) | 32k | Fast, reasoning |
|
|
144
|
+
| `deepseek-v3.2` | DeepSeek V3.2 | 160k | Reasoning, tools disabled |
|
|
145
|
+
| `venice-uncensored` | Venice Uncensored (Dolphin-Mistral) | 32k | Uncensored, tools disabled |
|
|
146
|
+
| `mistral-31-24b` | Venice Medium (Mistral) | 128k | Vision |
|
|
147
|
+
| `google-gemma-3-27b-it` | Google Gemma 3 27B Instruct | 198k | Vision |
|
|
148
|
+
| `openai-gpt-oss-120b` | OpenAI GPT OSS 120B | 128k | General |
|
|
149
|
+
| `nvidia-nemotron-3-nano-30b-a3b` | NVIDIA Nemotron 3 Nano 30B | 128k | General |
|
|
150
|
+
| `olafangensan-glm-4.7-flash-heretic` | GLM 4.7 Flash Heretic | 128k | Reasoning |
|
|
151
|
+
| `zai-org-glm-4.6` | GLM 4.6 | 198k | General |
|
|
152
|
+
| `zai-org-glm-4.7` | GLM 4.7 | 198k | Reasoning |
|
|
153
|
+
| `zai-org-glm-4.7-flash` | GLM 4.7 Flash | 128k | Reasoning |
|
|
154
|
+
| `zai-org-glm-5` | GLM 5 | 198k | Reasoning |
|
|
155
|
+
| `minimax-m21` | MiniMax M2.1 | 198k | Reasoning |
|
|
156
|
+
| `minimax-m25` | MiniMax M2.5 | 198k | Reasoning |
|
|
157
|
+
|
|
158
|
+
### Anonymized Models (15) - Via Venice Proxy
|
|
159
|
+
|
|
160
|
+
| Model ID | Name | Context | Features |
|
|
161
|
+
| ------------------------------- | ------------------------------ | ------- | ------------------------- |
|
|
162
|
+
| `claude-opus-4-6` | Claude Opus 4.6 (via Venice) | 1M | Reasoning, vision |
|
|
163
|
+
| `claude-opus-4-5` | Claude Opus 4.5 (via Venice) | 198k | Reasoning, vision |
|
|
164
|
+
| `claude-sonnet-4-6` | Claude Sonnet 4.6 (via Venice) | 1M | Reasoning, vision |
|
|
165
|
+
| `claude-sonnet-4-5` | Claude Sonnet 4.5 (via Venice) | 198k | Reasoning, vision |
|
|
166
|
+
| `openai-gpt-54` | GPT-5.4 (via Venice) | 1M | Reasoning, vision |
|
|
167
|
+
| `openai-gpt-53-codex` | GPT-5.3 Codex (via Venice) | 400k | Reasoning, vision, coding |
|
|
168
|
+
| `openai-gpt-52` | GPT-5.2 (via Venice) | 256k | Reasoning |
|
|
169
|
+
| `openai-gpt-52-codex` | GPT-5.2 Codex (via Venice) | 256k | Reasoning, vision, coding |
|
|
170
|
+
| `openai-gpt-4o-2024-11-20` | GPT-4o (via Venice) | 128k | Vision |
|
|
171
|
+
| `openai-gpt-4o-mini-2024-07-18` | GPT-4o Mini (via Venice) | 128k | Vision |
|
|
172
|
+
| `gemini-3-1-pro-preview` | Gemini 3.1 Pro (via Venice) | 1M | Reasoning, vision |
|
|
173
|
+
| `gemini-3-pro-preview` | Gemini 3 Pro (via Venice) | 198k | Reasoning, vision |
|
|
174
|
+
| `gemini-3-flash-preview` | Gemini 3 Flash (via Venice) | 256k | Reasoning, vision |
|
|
175
|
+
| `grok-41-fast` | Grok 4.1 Fast (via Venice) | 1M | Reasoning, vision |
|
|
176
|
+
| `grok-code-fast-1` | Grok Code Fast 1 (via Venice) | 256k | Reasoning, coding |
|
|
177
|
+
|
|
178
|
+
## Model Discovery
|
|
179
|
+
|
|
180
|
+
QuantumClaw automatically discovers models from the Venice API when `VENICE_API_KEY` is set. If the API is unreachable, it falls back to a static catalog.
|
|
181
|
+
|
|
182
|
+
The `/models` endpoint is public (no auth needed for listing), but inference requires a valid API key.
|
|
183
|
+
|
|
184
|
+
## Streaming & Tool Support
|
|
185
|
+
|
|
186
|
+
| Feature | Support |
|
|
187
|
+
| -------------------- | ------------------------------------------------------- |
|
|
188
|
+
| **Streaming** | ✅ All models |
|
|
189
|
+
| **Function calling** | ✅ Most models (check `supportsFunctionCalling` in API) |
|
|
190
|
+
| **Vision/Images** | ✅ Models marked with "Vision" feature |
|
|
191
|
+
| **JSON mode** | ✅ Supported via `response_format` |
|
|
192
|
+
|
|
193
|
+
## Pricing
|
|
194
|
+
|
|
195
|
+
Venice uses a credit-based system. Check [venice.ai/pricing](https://venice.ai/pricing) for current rates:
|
|
196
|
+
|
|
197
|
+
- **Private models**: Generally lower cost
|
|
198
|
+
- **Anonymized models**: Similar to direct API pricing + small Venice fee
|
|
199
|
+
|
|
200
|
+
## Comparison: Venice vs Direct API
|
|
201
|
+
|
|
202
|
+
| Aspect | Venice (Anonymized) | Direct API |
|
|
203
|
+
| ------------ | ----------------------------- | ------------------- |
|
|
204
|
+
| **Privacy** | Metadata stripped, anonymized | Your account linked |
|
|
205
|
+
| **Latency** | +10-50ms (proxy) | Direct |
|
|
206
|
+
| **Features** | Most features supported | Full features |
|
|
207
|
+
| **Billing** | Venice credits | Provider billing |
|
|
208
|
+
|
|
209
|
+
## Usage Examples
|
|
210
|
+
|
|
211
|
+
```bash
|
|
212
|
+
# Use the default private model
|
|
213
|
+
quantumclaw agent --model venice/kimi-k2-5 --message "Quick health check"
|
|
214
|
+
|
|
215
|
+
# Use Claude Opus via Venice (anonymized)
|
|
216
|
+
quantumclaw agent --model venice/claude-opus-4-6 --message "Summarize this task"
|
|
217
|
+
|
|
218
|
+
# Use uncensored model
|
|
219
|
+
quantumclaw agent --model venice/venice-uncensored --message "Draft options"
|
|
220
|
+
|
|
221
|
+
# Use vision model with image
|
|
222
|
+
quantumclaw agent --model venice/qwen3-vl-235b-a22b --message "Review attached image"
|
|
223
|
+
|
|
224
|
+
# Use coding model
|
|
225
|
+
quantumclaw agent --model venice/qwen3-coder-480b-a35b-instruct --message "Refactor this function"
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
## Troubleshooting
|
|
229
|
+
|
|
230
|
+
### API key not recognized
|
|
231
|
+
|
|
232
|
+
```bash
|
|
233
|
+
echo $VENICE_API_KEY
|
|
234
|
+
quantumclaw models list | grep venice
|
|
235
|
+
```
|
|
236
|
+
|
|
237
|
+
Ensure the key starts with `vapi_`.
|
|
238
|
+
|
|
239
|
+
### Model not available
|
|
240
|
+
|
|
241
|
+
The Venice model catalog updates dynamically. Run `quantumclaw models list` to see currently available models. Some models may be temporarily offline.
|
|
242
|
+
|
|
243
|
+
### Connection issues
|
|
244
|
+
|
|
245
|
+
Venice API is at `https://api.venice.ai/api/v1`. Ensure your network allows HTTPS connections.
|
|
246
|
+
|
|
247
|
+
## Config file example
|
|
248
|
+
|
|
249
|
+
```json5
|
|
250
|
+
{
|
|
251
|
+
env: { VENICE_API_KEY: "vapi_..." },
|
|
252
|
+
agents: { defaults: { model: { primary: "venice/kimi-k2-5" } } },
|
|
253
|
+
models: {
|
|
254
|
+
mode: "merge",
|
|
255
|
+
providers: {
|
|
256
|
+
venice: {
|
|
257
|
+
baseUrl: "https://api.venice.ai/api/v1",
|
|
258
|
+
apiKey: "${VENICE_API_KEY}",
|
|
259
|
+
api: "openai-completions",
|
|
260
|
+
models: [
|
|
261
|
+
{
|
|
262
|
+
id: "kimi-k2-5",
|
|
263
|
+
name: "Kimi K2.5",
|
|
264
|
+
reasoning: true,
|
|
265
|
+
input: ["text", "image"],
|
|
266
|
+
cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
|
|
267
|
+
contextWindow: 256000,
|
|
268
|
+
maxTokens: 65536,
|
|
269
|
+
},
|
|
270
|
+
],
|
|
271
|
+
},
|
|
272
|
+
},
|
|
273
|
+
},
|
|
274
|
+
}
|
|
275
|
+
```
|
|
276
|
+
|
|
277
|
+
## Links
|
|
278
|
+
|
|
279
|
+
- [Venice AI](https://venice.ai)
|
|
280
|
+
- [API Documentation](https://docs.venice.ai)
|
|
281
|
+
- [Pricing](https://venice.ai/pricing)
|
|
282
|
+
- [Status](https://status.venice.ai)
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Vercel AI Gateway"
|
|
3
|
+
summary: "Vercel AI Gateway setup (auth + model selection)"
|
|
4
|
+
read_when:
|
|
5
|
+
- You want to use Vercel AI Gateway with QuantumClaw
|
|
6
|
+
- You need the API key env var or CLI auth choice
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# Vercel AI Gateway
|
|
10
|
+
|
|
11
|
+
The [Vercel AI Gateway](https://vercel.com/ai-gateway) provides a unified API to access hundreds of models through a single endpoint.
|
|
12
|
+
|
|
13
|
+
- Provider: `vercel-ai-gateway`
|
|
14
|
+
- Auth: `AI_GATEWAY_API_KEY`
|
|
15
|
+
- API: Anthropic Messages compatible
|
|
16
|
+
- QuantumClaw auto-discovers the Gateway `/v1/models` catalog, so `/models vercel-ai-gateway`
|
|
17
|
+
includes current model refs such as `vercel-ai-gateway/openai/gpt-5.4`.
|
|
18
|
+
|
|
19
|
+
## Quick start
|
|
20
|
+
|
|
21
|
+
1. Set the API key (recommended: store it for the Gateway):
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
quantumclaw onboard --auth-choice ai-gateway-api-key
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
2. Set a default model:
|
|
28
|
+
|
|
29
|
+
```json5
|
|
30
|
+
{
|
|
31
|
+
agents: {
|
|
32
|
+
defaults: {
|
|
33
|
+
model: { primary: "vercel-ai-gateway/anthropic/claude-opus-4.6" },
|
|
34
|
+
},
|
|
35
|
+
},
|
|
36
|
+
}
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Non-interactive example
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
quantumclaw onboard --non-interactive \
|
|
43
|
+
--mode local \
|
|
44
|
+
--auth-choice ai-gateway-api-key \
|
|
45
|
+
--ai-gateway-api-key "$AI_GATEWAY_API_KEY"
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## Environment note
|
|
49
|
+
|
|
50
|
+
If the Gateway runs as a daemon (launchd/systemd), make sure `AI_GATEWAY_API_KEY`
|
|
51
|
+
is available to that process (for example, in `~/.quantumclaw/.env` or via
|
|
52
|
+
`env.shellEnv`).
|
|
53
|
+
|
|
54
|
+
## Model ID shorthand
|
|
55
|
+
|
|
56
|
+
QuantumClaw accepts Vercel Claude shorthand model refs and normalizes them at
|
|
57
|
+
runtime:
|
|
58
|
+
|
|
59
|
+
- `vercel-ai-gateway/claude-opus-4.6` -> `vercel-ai-gateway/anthropic/claude-opus-4.6`
|
|
60
|
+
- `vercel-ai-gateway/opus-4.6` -> `vercel-ai-gateway/anthropic/claude-opus-4-6`
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "Run QuantumClaw with vLLM (OpenAI-compatible local server)"
|
|
3
|
+
read_when:
|
|
4
|
+
- You want to run QuantumClaw against a local vLLM server
|
|
5
|
+
- You want OpenAI-compatible /v1 endpoints with your own models
|
|
6
|
+
title: "vLLM"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# vLLM
|
|
10
|
+
|
|
11
|
+
vLLM can serve open-source (and some custom) models via an **OpenAI-compatible** HTTP API. QuantumClaw can connect to vLLM using the `openai-completions` API.
|
|
12
|
+
|
|
13
|
+
QuantumClaw can also **auto-discover** available models from vLLM when you opt in with `VLLM_API_KEY` (any value works if your server doesn’t enforce auth) and you do not define an explicit `models.providers.vllm` entry.
|
|
14
|
+
|
|
15
|
+
## Quick start
|
|
16
|
+
|
|
17
|
+
1. Start vLLM with an OpenAI-compatible server.
|
|
18
|
+
|
|
19
|
+
Your base URL should expose `/v1` endpoints (e.g. `/v1/models`, `/v1/chat/completions`). vLLM commonly runs on:
|
|
20
|
+
|
|
21
|
+
- `http://127.0.0.1:8000/v1`
|
|
22
|
+
|
|
23
|
+
2. Opt in (any value works if no auth is configured):
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
export VLLM_API_KEY="vllm-local"
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
3. Select a model (replace with one of your vLLM model IDs):
|
|
30
|
+
|
|
31
|
+
```json5
|
|
32
|
+
{
|
|
33
|
+
agents: {
|
|
34
|
+
defaults: {
|
|
35
|
+
model: { primary: "vllm/your-model-id" },
|
|
36
|
+
},
|
|
37
|
+
},
|
|
38
|
+
}
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Model discovery (implicit provider)
|
|
42
|
+
|
|
43
|
+
When `VLLM_API_KEY` is set (or an auth profile exists) and you **do not** define `models.providers.vllm`, QuantumClaw will query:
|
|
44
|
+
|
|
45
|
+
- `GET http://127.0.0.1:8000/v1/models`
|
|
46
|
+
|
|
47
|
+
…and convert the returned IDs into model entries.
|
|
48
|
+
|
|
49
|
+
If you set `models.providers.vllm` explicitly, auto-discovery is skipped and you must define models manually.
|
|
50
|
+
|
|
51
|
+
## Explicit configuration (manual models)
|
|
52
|
+
|
|
53
|
+
Use explicit config when:
|
|
54
|
+
|
|
55
|
+
- vLLM runs on a different host/port.
|
|
56
|
+
- You want to pin `contextWindow`/`maxTokens` values.
|
|
57
|
+
- Your server requires a real API key (or you want to control headers).
|
|
58
|
+
|
|
59
|
+
```json5
|
|
60
|
+
{
|
|
61
|
+
models: {
|
|
62
|
+
providers: {
|
|
63
|
+
vllm: {
|
|
64
|
+
baseUrl: "http://127.0.0.1:8000/v1",
|
|
65
|
+
apiKey: "${VLLM_API_KEY}",
|
|
66
|
+
api: "openai-completions",
|
|
67
|
+
models: [
|
|
68
|
+
{
|
|
69
|
+
id: "your-model-id",
|
|
70
|
+
name: "Local vLLM Model",
|
|
71
|
+
reasoning: false,
|
|
72
|
+
input: ["text"],
|
|
73
|
+
cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
|
|
74
|
+
contextWindow: 128000,
|
|
75
|
+
maxTokens: 8192,
|
|
76
|
+
},
|
|
77
|
+
],
|
|
78
|
+
},
|
|
79
|
+
},
|
|
80
|
+
},
|
|
81
|
+
}
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
## Troubleshooting
|
|
85
|
+
|
|
86
|
+
- Check the server is reachable:
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
curl http://127.0.0.1:8000/v1/models
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
- If requests fail with auth errors, set a real `VLLM_API_KEY` that matches your server configuration, or configure the provider explicitly under `models.providers.vllm`.
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Volcengine (Doubao)"
|
|
3
|
+
summary: "Volcano Engine setup (Doubao models, general + coding endpoints)"
|
|
4
|
+
read_when:
|
|
5
|
+
- You want to use Volcano Engine or Doubao models with QuantumClaw
|
|
6
|
+
- You need the Volcengine API key setup
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# Volcengine (Doubao)
|
|
10
|
+
|
|
11
|
+
The Volcengine provider gives access to Doubao models and third-party models
|
|
12
|
+
hosted on Volcano Engine, with separate endpoints for general and coding
|
|
13
|
+
workloads.
|
|
14
|
+
|
|
15
|
+
- Providers: `volcengine` (general) + `volcengine-plan` (coding)
|
|
16
|
+
- Auth: `VOLCANO_ENGINE_API_KEY`
|
|
17
|
+
- API: OpenAI-compatible
|
|
18
|
+
|
|
19
|
+
## Quick start
|
|
20
|
+
|
|
21
|
+
1. Set the API key:
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
quantumclaw onboard --auth-choice volcengine-api-key
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
2. Set a default model:
|
|
28
|
+
|
|
29
|
+
```json5
|
|
30
|
+
{
|
|
31
|
+
agents: {
|
|
32
|
+
defaults: {
|
|
33
|
+
model: { primary: "volcengine-plan/ark-code-latest" },
|
|
34
|
+
},
|
|
35
|
+
},
|
|
36
|
+
}
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Non-interactive example
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
quantumclaw onboard --non-interactive \
|
|
43
|
+
--mode local \
|
|
44
|
+
--auth-choice volcengine-api-key \
|
|
45
|
+
--volcengine-api-key "$VOLCANO_ENGINE_API_KEY"
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## Providers and endpoints
|
|
49
|
+
|
|
50
|
+
| Provider | Endpoint | Use case |
|
|
51
|
+
| ----------------- | ----------------------------------------- | -------------- |
|
|
52
|
+
| `volcengine` | `ark.cn-beijing.volces.com/api/v3` | General models |
|
|
53
|
+
| `volcengine-plan` | `ark.cn-beijing.volces.com/api/coding/v3` | Coding models |
|
|
54
|
+
|
|
55
|
+
Both providers are configured from a single API key. Setup registers both
|
|
56
|
+
automatically.
|
|
57
|
+
|
|
58
|
+
## Available models
|
|
59
|
+
|
|
60
|
+
- **doubao-seed-1-8** - Doubao Seed 1.8 (general, default)
|
|
61
|
+
- **doubao-seed-code-preview** - Doubao coding model
|
|
62
|
+
- **ark-code-latest** - Coding plan default
|
|
63
|
+
- **Kimi K2.5** - Moonshot AI via Volcano Engine
|
|
64
|
+
- **GLM-4.7** - GLM via Volcano Engine
|
|
65
|
+
- **DeepSeek V3.2** - DeepSeek via Volcano Engine
|
|
66
|
+
|
|
67
|
+
Most models support text + image input. Context windows range from 128K to 256K
|
|
68
|
+
tokens.
|
|
69
|
+
|
|
70
|
+
## Environment note
|
|
71
|
+
|
|
72
|
+
If the Gateway runs as a daemon (launchd/systemd), make sure
|
|
73
|
+
`VOLCANO_ENGINE_API_KEY` is available to that process (for example, in
|
|
74
|
+
`~/.quantumclaw/.env` or via `env.shellEnv`).
|