@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,640 @@
|
|
|
1
|
+
---
|
|
2
|
+
read_when:
|
|
3
|
+
- 首次设置 QuantumClaw
|
|
4
|
+
- 查找常见配置模式
|
|
5
|
+
- 导航到特定配置部分
|
|
6
|
+
summary: 配置概览:常见任务、快速设置,以及完整参考的链接
|
|
7
|
+
title: 配置
|
|
8
|
+
x-i18n:
|
|
9
|
+
generated_at: "2026-03-16T06:23:15Z"
|
|
10
|
+
model: gpt-5.4
|
|
11
|
+
provider: openai
|
|
12
|
+
source_hash: 0047a255e8d3b6d280634437167486e2a81bf98b2d367071259b4b5c85b5ba9f
|
|
13
|
+
source_path: gateway/configuration.md
|
|
14
|
+
workflow: 15
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
# 配置
|
|
18
|
+
|
|
19
|
+
QuantumClaw 会从 `~/.quantumclaw/quantumclaw.json` 读取可选的 <Tooltip tip="JSON5 supports comments and trailing commas">**JSON5**</Tooltip> 配置。
|
|
20
|
+
|
|
21
|
+
如果该文件缺失,QuantumClaw 会使用安全的默认值。添加配置的常见原因包括:
|
|
22
|
+
|
|
23
|
+
- 连接渠道并控制谁可以向 bot 发消息
|
|
24
|
+
- 设置模型、工具、沙箱隔离或自动化(cron、hooks)
|
|
25
|
+
- 调整会话、媒体、网络或 UI
|
|
26
|
+
|
|
27
|
+
所有可用字段请参阅 [完整参考](/gateway/configuration-reference)。
|
|
28
|
+
|
|
29
|
+
<Tip>
|
|
30
|
+
**刚接触配置?** 从 `quantumclaw onboard` 开始进行交互式设置,或者查看 [Configuration Examples](/gateway/configuration-examples) 指南,获取完整的可复制粘贴配置。
|
|
31
|
+
</Tip>
|
|
32
|
+
|
|
33
|
+
## 最小配置
|
|
34
|
+
|
|
35
|
+
```json5
|
|
36
|
+
// ~/.quantumclaw/quantumclaw.json
|
|
37
|
+
{
|
|
38
|
+
agents: { defaults: { workspace: "~/.quantumclaw/workspace" } },
|
|
39
|
+
channels: { whatsapp: { allowFrom: ["+15555550123"] } },
|
|
40
|
+
}
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## 编辑配置
|
|
44
|
+
|
|
45
|
+
<Tabs>
|
|
46
|
+
<Tab title="Interactive wizard">
|
|
47
|
+
```bash
|
|
48
|
+
quantumclaw onboard # 完整设置向导
|
|
49
|
+
quantumclaw configure # 配置向导
|
|
50
|
+
```
|
|
51
|
+
</Tab>
|
|
52
|
+
<Tab title="CLI (one-liners)">
|
|
53
|
+
```bash
|
|
54
|
+
quantumclaw config get agents.defaults.workspace
|
|
55
|
+
quantumclaw config set agents.defaults.heartbeat.every "2h"
|
|
56
|
+
quantumclaw config unset plugins.entries.brave.config.webSearch.apiKey
|
|
57
|
+
```
|
|
58
|
+
</Tab>
|
|
59
|
+
<Tab title="Control UI">
|
|
60
|
+
打开 [http://127.0.0.1:18789](http://127.0.0.1:18789) 并使用 **Config** 标签页。
|
|
61
|
+
Control UI 会根据配置 schema 渲染表单,并提供 **Raw JSON** 编辑器作为后备方式。
|
|
62
|
+
</Tab>
|
|
63
|
+
<Tab title="Direct edit">
|
|
64
|
+
直接编辑 `~/.quantumclaw/quantumclaw.json`。Gateway 网关会监视该文件并自动应用更改(参见[热重载](#config-hot-reload))。
|
|
65
|
+
</Tab>
|
|
66
|
+
</Tabs>
|
|
67
|
+
|
|
68
|
+
## 严格校验
|
|
69
|
+
|
|
70
|
+
<Warning>
|
|
71
|
+
QuantumClaw 只接受完全符合 schema 的配置。未知键、类型格式错误或无效值都会导致 Gateway 网关**拒绝启动**。唯一的根级例外是 `$schema`(字符串),这样编辑器就可以附加 JSON Schema 元数据。
|
|
72
|
+
</Warning>
|
|
73
|
+
|
|
74
|
+
当校验失败时:
|
|
75
|
+
|
|
76
|
+
- Gateway 网关不会启动
|
|
77
|
+
- 只有诊断命令可用(`quantumclaw doctor`、`quantumclaw logs`、`quantumclaw health`、`quantumclaw status`)
|
|
78
|
+
- 运行 `quantumclaw doctor` 以查看具体问题
|
|
79
|
+
- 运行 `quantumclaw doctor --fix`(或 `--yes`)以应用修复
|
|
80
|
+
|
|
81
|
+
## 常见任务
|
|
82
|
+
|
|
83
|
+
<AccordionGroup>
|
|
84
|
+
<Accordion title="设置一个渠道(WhatsApp、Telegram、Discord 等)">
|
|
85
|
+
每个渠道在 `channels.<provider>` 下都有各自的配置部分。设置步骤请参阅对应的渠道页面:
|
|
86
|
+
|
|
87
|
+
- [WhatsApp](/channels/whatsapp) — `channels.whatsapp`
|
|
88
|
+
- [Telegram](/channels/telegram) — `channels.telegram`
|
|
89
|
+
- [Discord](/channels/discord) — `channels.discord`
|
|
90
|
+
- [Slack](/channels/slack) — `channels.slack`
|
|
91
|
+
- [Signal](/channels/signal) — `channels.signal`
|
|
92
|
+
- [iMessage](/channels/imessage) — `channels.imessage`
|
|
93
|
+
- [Google Chat](/channels/googlechat) — `channels.googlechat`
|
|
94
|
+
- [Mattermost](/channels/mattermost) — `channels.mattermost`
|
|
95
|
+
- [MS Teams](/channels/msteams) — `channels.msteams`
|
|
96
|
+
|
|
97
|
+
所有渠道都共享同一种私信策略模式:
|
|
98
|
+
|
|
99
|
+
```json5
|
|
100
|
+
{
|
|
101
|
+
channels: {
|
|
102
|
+
telegram: {
|
|
103
|
+
enabled: true,
|
|
104
|
+
botToken: "123:abc",
|
|
105
|
+
dmPolicy: "pairing", // pairing | allowlist | open | disabled
|
|
106
|
+
allowFrom: ["tg:123"], // 仅用于 allowlist/open
|
|
107
|
+
},
|
|
108
|
+
},
|
|
109
|
+
}
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
</Accordion>
|
|
113
|
+
|
|
114
|
+
<Accordion title="选择并配置模型">
|
|
115
|
+
设置主模型和可选回退模型:
|
|
116
|
+
|
|
117
|
+
```json5
|
|
118
|
+
{
|
|
119
|
+
agents: {
|
|
120
|
+
defaults: {
|
|
121
|
+
model: {
|
|
122
|
+
primary: "anthropic/claude-sonnet-4-5",
|
|
123
|
+
fallbacks: ["openai/gpt-5.2"],
|
|
124
|
+
},
|
|
125
|
+
models: {
|
|
126
|
+
"anthropic/claude-sonnet-4-5": { alias: "Sonnet" },
|
|
127
|
+
"openai/gpt-5.2": { alias: "GPT" },
|
|
128
|
+
},
|
|
129
|
+
},
|
|
130
|
+
},
|
|
131
|
+
}
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
- `agents.defaults.models` 定义模型目录,并充当 `/model` 的允许列表。
|
|
135
|
+
- 模型引用使用 `provider/model` 格式(例如 `anthropic/claude-opus-4-6`)。
|
|
136
|
+
- `agents.defaults.imageMaxDimensionPx` 控制转录/工具图像的缩放下限(默认 `1200`);在截图较多的运行中,较低的值通常会减少视觉 token 使用量。
|
|
137
|
+
- 关于在聊天中切换模型,请参阅 [Models CLI](/concepts/models);关于凭证轮换和回退行为,请参阅 [Model Failover](/concepts/model-failover)。
|
|
138
|
+
- 关于自定义/自托管提供商,请参阅参考中的 [Custom providers](/gateway/configuration-reference#custom-providers-and-base-urls)。
|
|
139
|
+
|
|
140
|
+
</Accordion>
|
|
141
|
+
|
|
142
|
+
<Accordion title="控制谁可以向 bot 发消息">
|
|
143
|
+
私信访问通过每个渠道的 `dmPolicy` 控制:
|
|
144
|
+
|
|
145
|
+
- `"pairing"`(默认):未知发送者会收到一次性配对码以供批准
|
|
146
|
+
- `"allowlist"`:仅允许 `allowFrom`(或已配对允许存储)中的发送者
|
|
147
|
+
- `"open"`:允许所有入站私信(需要 `allowFrom: ["*"]`)
|
|
148
|
+
- `"disabled"`:忽略所有私信
|
|
149
|
+
|
|
150
|
+
对于群组,请使用 `groupPolicy` + `groupAllowFrom` 或特定渠道的允许列表。
|
|
151
|
+
|
|
152
|
+
有关每个渠道的详细信息,请参阅 [完整参考](/gateway/configuration-reference#dm-and-group-access)。
|
|
153
|
+
|
|
154
|
+
</Accordion>
|
|
155
|
+
|
|
156
|
+
<Accordion title="设置群聊提及门控">
|
|
157
|
+
群组消息默认设置为**需要提及**。可按智能体配置模式:
|
|
158
|
+
|
|
159
|
+
```json5
|
|
160
|
+
{
|
|
161
|
+
agents: {
|
|
162
|
+
list: [
|
|
163
|
+
{
|
|
164
|
+
id: "main",
|
|
165
|
+
groupChat: {
|
|
166
|
+
mentionPatterns: ["@quantumclaw", "quantumclaw"],
|
|
167
|
+
},
|
|
168
|
+
},
|
|
169
|
+
],
|
|
170
|
+
},
|
|
171
|
+
channels: {
|
|
172
|
+
whatsapp: {
|
|
173
|
+
groups: { "*": { requireMention: true } },
|
|
174
|
+
},
|
|
175
|
+
},
|
|
176
|
+
}
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
- **元数据提及**:原生 @ 提及(WhatsApp 点按提及、Telegram @bot 等)
|
|
180
|
+
- **文本模式**:`mentionPatterns` 中的安全正则模式
|
|
181
|
+
- 关于每个渠道的覆盖和自聊模式,请参阅 [完整参考](/gateway/configuration-reference#group-chat-mention-gating)。
|
|
182
|
+
|
|
183
|
+
</Accordion>
|
|
184
|
+
|
|
185
|
+
<Accordion title="调整 Gateway 网关渠道健康监控">
|
|
186
|
+
控制 Gateway 网关对看起来失活的渠道执行重启的积极程度:
|
|
187
|
+
|
|
188
|
+
```json5
|
|
189
|
+
{
|
|
190
|
+
gateway: {
|
|
191
|
+
channelHealthCheckMinutes: 5,
|
|
192
|
+
channelStaleEventThresholdMinutes: 30,
|
|
193
|
+
channelMaxRestartsPerHour: 10,
|
|
194
|
+
},
|
|
195
|
+
channels: {
|
|
196
|
+
telegram: {
|
|
197
|
+
healthMonitor: { enabled: false },
|
|
198
|
+
accounts: {
|
|
199
|
+
alerts: {
|
|
200
|
+
healthMonitor: { enabled: true },
|
|
201
|
+
},
|
|
202
|
+
},
|
|
203
|
+
},
|
|
204
|
+
},
|
|
205
|
+
}
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
- 设置 `gateway.channelHealthCheckMinutes: 0` 可全局禁用健康监控重启。
|
|
209
|
+
- `channelStaleEventThresholdMinutes` 应大于或等于检查间隔。
|
|
210
|
+
- 使用 `channels.<provider>.healthMonitor.enabled` 或 `channels.<provider>.accounts.<id>.healthMonitor.enabled`,可为单个渠道或账号禁用自动重启,而无需禁用全局监控。
|
|
211
|
+
- 有关运维调试,请参阅 [Health Checks](/gateway/health);所有字段请参阅 [完整参考](/gateway/configuration-reference#gateway)。
|
|
212
|
+
|
|
213
|
+
</Accordion>
|
|
214
|
+
|
|
215
|
+
<Accordion title="配置会话和重置">
|
|
216
|
+
会话控制对话的连续性和隔离性:
|
|
217
|
+
|
|
218
|
+
```json5
|
|
219
|
+
{
|
|
220
|
+
session: {
|
|
221
|
+
dmScope: "per-channel-peer", // 推荐用于多用户
|
|
222
|
+
threadBindings: {
|
|
223
|
+
enabled: true,
|
|
224
|
+
idleHours: 24,
|
|
225
|
+
maxAgeHours: 0,
|
|
226
|
+
},
|
|
227
|
+
reset: {
|
|
228
|
+
mode: "daily",
|
|
229
|
+
atHour: 4,
|
|
230
|
+
idleMinutes: 120,
|
|
231
|
+
},
|
|
232
|
+
},
|
|
233
|
+
}
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
- `dmScope`:`main`(共享)| `per-peer` | `per-channel-peer` | `per-account-channel-peer`
|
|
237
|
+
- `threadBindings`:线程绑定会话路由的全局默认值(Discord 支持 `/focus`、`/unfocus`、`/agents`、`/session idle` 和 `/session max-age`)。
|
|
238
|
+
- 关于作用域、身份链接和发送策略,请参阅 [Session Management](/concepts/session)。
|
|
239
|
+
- 所有字段请参阅 [完整参考](/gateway/configuration-reference#session)。
|
|
240
|
+
|
|
241
|
+
</Accordion>
|
|
242
|
+
|
|
243
|
+
<Accordion title="启用沙箱隔离">
|
|
244
|
+
在隔离的 Docker 容器中运行智能体会话:
|
|
245
|
+
|
|
246
|
+
```json5
|
|
247
|
+
{
|
|
248
|
+
agents: {
|
|
249
|
+
defaults: {
|
|
250
|
+
sandbox: {
|
|
251
|
+
mode: "non-main", // off | non-main | all
|
|
252
|
+
scope: "agent", // session | agent | shared
|
|
253
|
+
},
|
|
254
|
+
},
|
|
255
|
+
},
|
|
256
|
+
}
|
|
257
|
+
```
|
|
258
|
+
|
|
259
|
+
先构建镜像:`scripts/sandbox-setup.sh`
|
|
260
|
+
|
|
261
|
+
完整指南请参阅 [Sandboxing](/gateway/sandboxing),所有选项请参阅 [完整参考](/gateway/configuration-reference#sandbox)。
|
|
262
|
+
|
|
263
|
+
</Accordion>
|
|
264
|
+
|
|
265
|
+
<Accordion title="为官方 iOS 构建启用基于 relay 的推送">
|
|
266
|
+
基于 relay 的推送在 `quantumclaw.json` 中配置。
|
|
267
|
+
|
|
268
|
+
在 Gateway 网关配置中设置:
|
|
269
|
+
|
|
270
|
+
```json5
|
|
271
|
+
{
|
|
272
|
+
gateway: {
|
|
273
|
+
push: {
|
|
274
|
+
apns: {
|
|
275
|
+
relay: {
|
|
276
|
+
baseUrl: "https://relay.example.com",
|
|
277
|
+
// 可选。默认值:10000
|
|
278
|
+
timeoutMs: 10000,
|
|
279
|
+
},
|
|
280
|
+
},
|
|
281
|
+
},
|
|
282
|
+
},
|
|
283
|
+
}
|
|
284
|
+
```
|
|
285
|
+
|
|
286
|
+
等价 CLI:
|
|
287
|
+
|
|
288
|
+
```bash
|
|
289
|
+
quantumclaw config set gateway.push.apns.relay.baseUrl https://relay.example.com
|
|
290
|
+
```
|
|
291
|
+
|
|
292
|
+
这会带来以下效果:
|
|
293
|
+
|
|
294
|
+
- 让 Gateway 网关通过外部 relay 发送 `push.test`、唤醒提示和重连唤醒。
|
|
295
|
+
- 使用由已配对 iOS 应用转发的、以注册为范围的发送授权。Gateway 网关不需要部署范围的 relay token。
|
|
296
|
+
- 将每个基于 relay 的注册绑定到 iOS 应用配对的 Gateway 网关身份,因此其他 Gateway 网关无法复用已存储的注册。
|
|
297
|
+
- 保持本地/手动 iOS 构建继续使用直接 APNs。基于 relay 的发送仅适用于通过 relay 注册的官方分发构建。
|
|
298
|
+
- 必须与官方/TestFlight iOS 构建中固化的 relay 基础 URL 一致,这样注册和发送流量才能到达同一个 relay 部署。
|
|
299
|
+
|
|
300
|
+
端到端流程:
|
|
301
|
+
|
|
302
|
+
1. 安装一个使用相同 relay 基础 URL 编译的官方/TestFlight iOS 构建。
|
|
303
|
+
2. 在 Gateway 网关上配置 `gateway.push.apns.relay.baseUrl`。
|
|
304
|
+
3. 将 iOS 应用与 Gateway 网关配对,并让节点会话和操作员会话都连接。
|
|
305
|
+
4. iOS 应用获取 Gateway 网关身份,使用 App Attest 加上应用回执向 relay 注册,然后将基于 relay 的 `push.apns.register` 负载发布到已配对的 Gateway 网关。
|
|
306
|
+
5. Gateway 网关存储 relay handle 和发送授权,然后将它们用于 `push.test`、唤醒提示和重连唤醒。
|
|
307
|
+
|
|
308
|
+
运维说明:
|
|
309
|
+
|
|
310
|
+
- 如果你将 iOS 应用切换到另一个 Gateway 网关,请重新连接应用,以便它发布绑定到该 Gateway 网关的新 relay 注册。
|
|
311
|
+
- 如果你发布了一个指向不同 relay 部署的新 iOS 构建,应用会刷新其缓存的 relay 注册,而不是复用旧的 relay 来源。
|
|
312
|
+
|
|
313
|
+
兼容性说明:
|
|
314
|
+
|
|
315
|
+
- `QUANTUMCLAW_APNS_RELAY_BASE_URL` 和 `QUANTUMCLAW_APNS_RELAY_TIMEOUT_MS` 仍可作为临时环境变量覆盖使用。
|
|
316
|
+
- `QUANTUMCLAW_APNS_RELAY_ALLOW_HTTP=true` 仍是仅限 loopback 的开发逃生口;不要在配置中持久化 HTTP relay URL。
|
|
317
|
+
|
|
318
|
+
关于端到端流程,请参阅 [iOS App](/platforms/ios#relay-backed-push-for-official-builds);关于 relay 安全模型,请参阅 [Authentication and trust flow](/platforms/ios#authentication-and-trust-flow)。
|
|
319
|
+
|
|
320
|
+
</Accordion>
|
|
321
|
+
|
|
322
|
+
<Accordion title="设置 heartbeat(周期性报到)">
|
|
323
|
+
```json5
|
|
324
|
+
{
|
|
325
|
+
agents: {
|
|
326
|
+
defaults: {
|
|
327
|
+
heartbeat: {
|
|
328
|
+
every: "30m",
|
|
329
|
+
target: "last",
|
|
330
|
+
},
|
|
331
|
+
},
|
|
332
|
+
},
|
|
333
|
+
}
|
|
334
|
+
```
|
|
335
|
+
|
|
336
|
+
- `every`:时长字符串(`30m`、`2h`)。设置为 `0m` 可禁用。
|
|
337
|
+
- `target`:`last` | `whatsapp` | `telegram` | `discord` | `none`
|
|
338
|
+
- `directPolicy`:用于私信风格 heartbeat 目标时,设为 `allow`(默认)或 `block`
|
|
339
|
+
- 完整指南请参阅 [Heartbeat](/gateway/heartbeat)。
|
|
340
|
+
|
|
341
|
+
</Accordion>
|
|
342
|
+
|
|
343
|
+
<Accordion title="配置 cron 作业">
|
|
344
|
+
```json5
|
|
345
|
+
{
|
|
346
|
+
cron: {
|
|
347
|
+
enabled: true,
|
|
348
|
+
maxConcurrentRuns: 2,
|
|
349
|
+
sessionRetention: "24h",
|
|
350
|
+
runLog: {
|
|
351
|
+
maxBytes: "2mb",
|
|
352
|
+
keepLines: 2000,
|
|
353
|
+
},
|
|
354
|
+
},
|
|
355
|
+
}
|
|
356
|
+
```
|
|
357
|
+
|
|
358
|
+
- `sessionRetention`:从 `sessions.json` 中清理已完成的隔离运行会话(默认 `24h`;设置为 `false` 可禁用)。
|
|
359
|
+
- `runLog`:按大小和保留行数清理 `cron/runs/<jobId>.jsonl`。
|
|
360
|
+
- 功能概览和 CLI 示例请参阅 [Cron jobs](/automation/cron-jobs)。
|
|
361
|
+
|
|
362
|
+
</Accordion>
|
|
363
|
+
|
|
364
|
+
<Accordion title="设置 webhooks(hooks)">
|
|
365
|
+
在 Gateway 网关上启用 HTTP webhook 端点:
|
|
366
|
+
|
|
367
|
+
```json5
|
|
368
|
+
{
|
|
369
|
+
hooks: {
|
|
370
|
+
enabled: true,
|
|
371
|
+
token: "shared-secret",
|
|
372
|
+
path: "/hooks",
|
|
373
|
+
defaultSessionKey: "hook:ingress",
|
|
374
|
+
allowRequestSessionKey: false,
|
|
375
|
+
allowedSessionKeyPrefixes: ["hook:"],
|
|
376
|
+
mappings: [
|
|
377
|
+
{
|
|
378
|
+
match: { path: "gmail" },
|
|
379
|
+
action: "agent",
|
|
380
|
+
agentId: "main",
|
|
381
|
+
deliver: true,
|
|
382
|
+
},
|
|
383
|
+
],
|
|
384
|
+
},
|
|
385
|
+
}
|
|
386
|
+
```
|
|
387
|
+
|
|
388
|
+
安全说明:
|
|
389
|
+
- 将所有 hook/webhook 负载内容都视为不受信任输入。
|
|
390
|
+
- 保持不安全内容绕过标志处于禁用状态(`hooks.gmail.allowUnsafeExternalContent`、`hooks.mappings[].allowUnsafeExternalContent`),除非是在进行严格限定的调试。
|
|
391
|
+
- 对于由 hook 驱动的智能体,优先使用强大的现代模型层级和严格的工具策略(例如尽可能仅允许消息传递并启用沙箱隔离)。
|
|
392
|
+
|
|
393
|
+
所有映射选项和 Gmail 集成请参阅 [完整参考](/gateway/configuration-reference#hooks)。
|
|
394
|
+
|
|
395
|
+
</Accordion>
|
|
396
|
+
|
|
397
|
+
<Accordion title="配置多智能体路由">
|
|
398
|
+
运行多个彼此隔离的智能体,并使用独立的工作区和会话:
|
|
399
|
+
|
|
400
|
+
```json5
|
|
401
|
+
{
|
|
402
|
+
agents: {
|
|
403
|
+
list: [
|
|
404
|
+
{ id: "home", default: true, workspace: "~/.quantumclaw/workspace-home" },
|
|
405
|
+
{ id: "work", workspace: "~/.quantumclaw/workspace-work" },
|
|
406
|
+
],
|
|
407
|
+
},
|
|
408
|
+
bindings: [
|
|
409
|
+
{ agentId: "home", match: { channel: "whatsapp", accountId: "personal" } },
|
|
410
|
+
{ agentId: "work", match: { channel: "whatsapp", accountId: "biz" } },
|
|
411
|
+
],
|
|
412
|
+
}
|
|
413
|
+
```
|
|
414
|
+
|
|
415
|
+
关于绑定规则和每个智能体的访问配置文件,请参阅 [Multi-Agent](/concepts/multi-agent) 和 [完整参考](/gateway/configuration-reference#multi-agent-routing)。
|
|
416
|
+
|
|
417
|
+
</Accordion>
|
|
418
|
+
|
|
419
|
+
<Accordion title="将配置拆分到多个文件中($include)">
|
|
420
|
+
使用 `$include` 组织大型配置:
|
|
421
|
+
|
|
422
|
+
```json5
|
|
423
|
+
// ~/.quantumclaw/quantumclaw.json
|
|
424
|
+
{
|
|
425
|
+
gateway: { port: 18789 },
|
|
426
|
+
agents: { $include: "./agents.json5" },
|
|
427
|
+
broadcast: {
|
|
428
|
+
$include: ["./clients/a.json5", "./clients/b.json5"],
|
|
429
|
+
},
|
|
430
|
+
}
|
|
431
|
+
```
|
|
432
|
+
|
|
433
|
+
- **单个文件**:替换所在对象
|
|
434
|
+
- **文件数组**:按顺序深度合并(后者优先)
|
|
435
|
+
- **同级键**:在 include 之后合并(覆盖已包含的值)
|
|
436
|
+
- **嵌套 include**:支持,最多 10 层深
|
|
437
|
+
- **相对路径**:相对于包含它的文件解析
|
|
438
|
+
- **错误处理**:对于缺失文件、解析错误和循环 include,会提供清晰错误
|
|
439
|
+
|
|
440
|
+
</Accordion>
|
|
441
|
+
</AccordionGroup>
|
|
442
|
+
|
|
443
|
+
## 配置热重载
|
|
444
|
+
|
|
445
|
+
Gateway 网关会监视 `~/.quantumclaw/quantumclaw.json` 并自动应用更改 —— 对于大多数设置,无需手动重启。
|
|
446
|
+
|
|
447
|
+
### 重载模式
|
|
448
|
+
|
|
449
|
+
| 模式 | 行为 |
|
|
450
|
+
| -------------------- | -------------------------------------------------------- |
|
|
451
|
+
| **`hybrid`**(默认) | 立即热应用安全更改。对关键更改会自动重启。 |
|
|
452
|
+
| **`hot`** | 仅热应用安全更改。需要重启时会记录警告 —— 由你自行处理。 |
|
|
453
|
+
| **`restart`** | 任何配置更改都会重启 Gateway 网关,无论是否安全。 |
|
|
454
|
+
| **`off`** | 禁用文件监视。更改会在下一次手动重启时生效。 |
|
|
455
|
+
|
|
456
|
+
```json5
|
|
457
|
+
{
|
|
458
|
+
gateway: {
|
|
459
|
+
reload: { mode: "hybrid", debounceMs: 300 },
|
|
460
|
+
},
|
|
461
|
+
}
|
|
462
|
+
```
|
|
463
|
+
|
|
464
|
+
### 哪些可以热应用,哪些需要重启
|
|
465
|
+
|
|
466
|
+
大多数字段都可以无停机热应用。在 `hybrid` 模式下,需要重启的更改会自动处理。
|
|
467
|
+
|
|
468
|
+
| 类别 | 字段 | 需要重启? |
|
|
469
|
+
| ------------------ | ----------------------------------------------------- | ---------- |
|
|
470
|
+
| 渠道 | `channels.*`、`web`(WhatsApp)— 所有内置和扩展渠道 | 否 |
|
|
471
|
+
| 智能体和模型 | `agent`、`agents`、`models`、`routing` | 否 |
|
|
472
|
+
| 自动化 | `hooks`、`cron`、`agent.heartbeat` | 否 |
|
|
473
|
+
| 会话和消息 | `session`、`messages` | 否 |
|
|
474
|
+
| 工具和媒体 | `tools`、`browser`、`skills`、`audio`、`talk` | 否 |
|
|
475
|
+
| UI 和杂项 | `ui`、`logging`、`identity`、`bindings` | 否 |
|
|
476
|
+
| Gateway 网关服务器 | `gateway.*`(port、bind、auth、tailscale、TLS、HTTP) | **是** |
|
|
477
|
+
| 基础设施 | `discovery`、`canvasHost`、`plugins` | **是** |
|
|
478
|
+
|
|
479
|
+
<Note>
|
|
480
|
+
`gateway.reload` 和 `gateway.remote` 是例外 —— 更改它们**不会**触发重启。
|
|
481
|
+
</Note>
|
|
482
|
+
|
|
483
|
+
## 配置 RPC(程序化更新)
|
|
484
|
+
|
|
485
|
+
<Note>
|
|
486
|
+
控制平面写入 RPC(`config.apply`、`config.patch`、`update.run`)按每个 `deviceId+clientIp` 限制为**每 60 秒 3 个请求**。当触发限制时,RPC 会返回 `UNAVAILABLE` 和 `retryAfterMs`。
|
|
487
|
+
</Note>
|
|
488
|
+
|
|
489
|
+
<AccordionGroup>
|
|
490
|
+
<Accordion title="config.apply(完整替换)">
|
|
491
|
+
校验 + 写入完整配置,并在一步中重启 Gateway 网关。
|
|
492
|
+
|
|
493
|
+
<Warning>
|
|
494
|
+
`config.apply` 会替换**整个配置**。部分更新请使用 `config.patch`,单个键请使用 `quantumclaw config set`。
|
|
495
|
+
</Warning>
|
|
496
|
+
|
|
497
|
+
参数:
|
|
498
|
+
|
|
499
|
+
- `raw`(string)— 整个配置的 JSON5 负载
|
|
500
|
+
- `baseHash`(可选)— 来自 `config.get` 的配置 hash(配置已存在时必需)
|
|
501
|
+
- `sessionKey`(可选)— 重启后唤醒 ping 使用的会话键
|
|
502
|
+
- `note`(可选)— 重启哨兵的说明
|
|
503
|
+
- `restartDelayMs`(可选)— 重启前延迟(默认 2000)
|
|
504
|
+
|
|
505
|
+
当已有重启处于待处理/进行中时,重启请求会被合并,并且两次重启周期之间会应用 30 秒冷却。
|
|
506
|
+
|
|
507
|
+
```bash
|
|
508
|
+
quantumclaw gateway call config.get --params '{}' # 捕获 payload.hash
|
|
509
|
+
quantumclaw gateway call config.apply --params '{
|
|
510
|
+
"raw": "{ agents: { defaults: { workspace: \"~/.quantumclaw/workspace\" } } }",
|
|
511
|
+
"baseHash": "<hash>",
|
|
512
|
+
"sessionKey": "agent:main:whatsapp:direct:+15555550123"
|
|
513
|
+
}'
|
|
514
|
+
```
|
|
515
|
+
|
|
516
|
+
</Accordion>
|
|
517
|
+
|
|
518
|
+
<Accordion title="config.patch(部分更新)">
|
|
519
|
+
将部分更新合并到现有配置中(JSON merge patch 语义):
|
|
520
|
+
|
|
521
|
+
- 对象递归合并
|
|
522
|
+
- `null` 删除键
|
|
523
|
+
- 数组整体替换
|
|
524
|
+
|
|
525
|
+
参数:
|
|
526
|
+
|
|
527
|
+
- `raw`(string)— 仅包含要更改键的 JSON5
|
|
528
|
+
- `baseHash`(必需)— 来自 `config.get` 的配置 hash
|
|
529
|
+
- `sessionKey`、`note`、`restartDelayMs` — 与 `config.apply` 相同
|
|
530
|
+
|
|
531
|
+
重启行为与 `config.apply` 一致:合并待处理重启,并在两次重启周期之间应用 30 秒冷却。
|
|
532
|
+
|
|
533
|
+
```bash
|
|
534
|
+
quantumclaw gateway call config.patch --params '{
|
|
535
|
+
"raw": "{ channels: { telegram: { groups: { \"*\": { requireMention: false } } } } }",
|
|
536
|
+
"baseHash": "<hash>"
|
|
537
|
+
}'
|
|
538
|
+
```
|
|
539
|
+
|
|
540
|
+
</Accordion>
|
|
541
|
+
</AccordionGroup>
|
|
542
|
+
|
|
543
|
+
## 环境变量
|
|
544
|
+
|
|
545
|
+
QuantumClaw 会从父进程读取环境变量,另外还会读取:
|
|
546
|
+
|
|
547
|
+
- 当前工作目录中的 `.env`(如果存在)
|
|
548
|
+
- `~/.quantumclaw/.env`(全局回退)
|
|
549
|
+
|
|
550
|
+
这两个文件都不会覆盖现有环境变量。你也可以在配置中设置内联环境变量:
|
|
551
|
+
|
|
552
|
+
```json5
|
|
553
|
+
{
|
|
554
|
+
env: {
|
|
555
|
+
OPENROUTER_API_KEY: "sk-or-...",
|
|
556
|
+
vars: { GROQ_API_KEY: "gsk-..." },
|
|
557
|
+
},
|
|
558
|
+
}
|
|
559
|
+
```
|
|
560
|
+
|
|
561
|
+
<Accordion title="Shell 环境变量导入(可选)">
|
|
562
|
+
如果启用,并且预期键名尚未设置,QuantumClaw 会运行你的登录 shell,并且只导入缺失的键:
|
|
563
|
+
|
|
564
|
+
```json5
|
|
565
|
+
{
|
|
566
|
+
env: {
|
|
567
|
+
shellEnv: { enabled: true, timeoutMs: 15000 },
|
|
568
|
+
},
|
|
569
|
+
}
|
|
570
|
+
```
|
|
571
|
+
|
|
572
|
+
环境变量等价项:`QUANTUMCLAW_LOAD_SHELL_ENV=1`
|
|
573
|
+
</Accordion>
|
|
574
|
+
|
|
575
|
+
<Accordion title="在配置值中替换环境变量">
|
|
576
|
+
你可以在任何配置字符串值中使用 `${VAR_NAME}` 引用环境变量:
|
|
577
|
+
|
|
578
|
+
```json5
|
|
579
|
+
{
|
|
580
|
+
gateway: { auth: { token: "${QUANTUMCLAW_GATEWAY_TOKEN}" } },
|
|
581
|
+
models: { providers: { custom: { apiKey: "${CUSTOM_API_KEY}" } } },
|
|
582
|
+
}
|
|
583
|
+
```
|
|
584
|
+
|
|
585
|
+
规则:
|
|
586
|
+
|
|
587
|
+
- 仅匹配大写名称:`[A-Z_][A-Z0-9_]*`
|
|
588
|
+
- 缺失/为空的变量会在加载时抛出错误
|
|
589
|
+
- 使用 `$${VAR}` 进行转义,以输出字面值
|
|
590
|
+
- 在 `$include` 文件中也可用
|
|
591
|
+
- 内联替换:`"${BASE}/v1"` → `"https://api.example.com/v1"`
|
|
592
|
+
|
|
593
|
+
</Accordion>
|
|
594
|
+
|
|
595
|
+
<Accordion title="Secret refs(env、file、exec)">
|
|
596
|
+
对于支持 SecretRef 对象的字段,你可以使用:
|
|
597
|
+
|
|
598
|
+
```json5
|
|
599
|
+
{
|
|
600
|
+
models: {
|
|
601
|
+
providers: {
|
|
602
|
+
openai: { apiKey: { source: "env", provider: "default", id: "OPENAI_API_KEY" } },
|
|
603
|
+
},
|
|
604
|
+
},
|
|
605
|
+
skills: {
|
|
606
|
+
entries: {
|
|
607
|
+
"nano-banana-pro": {
|
|
608
|
+
apiKey: {
|
|
609
|
+
source: "file",
|
|
610
|
+
provider: "filemain",
|
|
611
|
+
id: "/skills/entries/nano-banana-pro/apiKey",
|
|
612
|
+
},
|
|
613
|
+
},
|
|
614
|
+
},
|
|
615
|
+
},
|
|
616
|
+
channels: {
|
|
617
|
+
googlechat: {
|
|
618
|
+
serviceAccountRef: {
|
|
619
|
+
source: "exec",
|
|
620
|
+
provider: "vault",
|
|
621
|
+
id: "channels/googlechat/serviceAccount",
|
|
622
|
+
},
|
|
623
|
+
},
|
|
624
|
+
},
|
|
625
|
+
}
|
|
626
|
+
```
|
|
627
|
+
|
|
628
|
+
SecretRef 详情(包括 `env`/`file`/`exec` 的 `secrets.providers`)请参阅 [Secrets Management](/gateway/secrets)。
|
|
629
|
+
支持的凭证路径列在 [SecretRef Credential Surface](/reference/secretref-credential-surface) 中。
|
|
630
|
+
</Accordion>
|
|
631
|
+
|
|
632
|
+
有关完整优先级和来源,请参阅 [Environment](/help/environment)。
|
|
633
|
+
|
|
634
|
+
## 完整参考
|
|
635
|
+
|
|
636
|
+
有关逐字段的完整参考,请参阅 **[Configuration Reference](/gateway/configuration-reference)**。
|
|
637
|
+
|
|
638
|
+
---
|
|
639
|
+
|
|
640
|
+
_相关内容:[Configuration Examples](/gateway/configuration-examples) · [Configuration Reference](/gateway/configuration-reference) · [Doctor](/gateway/doctor)_
|