@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,306 @@
|
|
|
1
|
+
---
|
|
2
|
+
read_when:
|
|
3
|
+
- 你需要了解 `quantumclaw onboard` 的详细行为
|
|
4
|
+
- 你正在调试新手引导结果或集成新手引导客户端
|
|
5
|
+
sidebarTitle: CLI reference
|
|
6
|
+
summary: CLI 设置流程、身份验证/模型设置、输出和内部机制的完整参考
|
|
7
|
+
title: CLI 设置参考
|
|
8
|
+
x-i18n:
|
|
9
|
+
generated_at: "2026-03-16T06:28:34Z"
|
|
10
|
+
model: gpt-5.4
|
|
11
|
+
provider: openai
|
|
12
|
+
source_hash: 6b9460013b6a0fbd59f639ade6b255c8d7f7412238495e78b942859ade695e86
|
|
13
|
+
source_path: start/wizard-cli-reference.md
|
|
14
|
+
workflow: 15
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
# CLI 设置参考
|
|
18
|
+
|
|
19
|
+
本页是 `quantumclaw onboard` 的完整参考。
|
|
20
|
+
简短指南请参见 [设置向导(CLI)](/start/wizard)。
|
|
21
|
+
|
|
22
|
+
## 向导会执行什么
|
|
23
|
+
|
|
24
|
+
本地模式(默认)会引导你完成以下内容:
|
|
25
|
+
|
|
26
|
+
- 模型和身份验证设置(OpenAI Code 订阅 OAuth、Anthropic API 密钥或 setup token,以及 MiniMax、GLM、Ollama、Moonshot 和 AI Gateway 选项)
|
|
27
|
+
- 工作区位置和 bootstrap 文件
|
|
28
|
+
- Gateway 网关设置(端口、绑定、身份验证、tailscale)
|
|
29
|
+
- 渠道和提供商(Telegram、WhatsApp、Discord、Google Chat、Mattermost 插件、Signal)
|
|
30
|
+
- 守护进程安装(LaunchAgent 或 systemd 用户单元)
|
|
31
|
+
- 健康检查
|
|
32
|
+
- Skills 设置
|
|
33
|
+
|
|
34
|
+
远程模式会将此机器配置为连接到其他位置的网关。
|
|
35
|
+
它不会在远程主机上安装或修改任何内容。
|
|
36
|
+
|
|
37
|
+
## 本地流程详情
|
|
38
|
+
|
|
39
|
+
<Steps>
|
|
40
|
+
<Step title="现有配置检测">
|
|
41
|
+
- 如果 `~/.quantumclaw/quantumclaw.json` 存在,可选择 Keep、Modify 或 Reset。
|
|
42
|
+
- 重新运行向导不会清除任何内容,除非你明确选择 Reset(或传递 `--reset`)。
|
|
43
|
+
- CLI `--reset` 默认作用于 `config+creds+sessions`;使用 `--reset-scope full` 还会删除工作区。
|
|
44
|
+
- 如果配置无效或包含旧版键,向导会停止,并要求你先运行 `quantumclaw doctor` 再继续。
|
|
45
|
+
- Reset 使用 `trash`,并提供以下范围:
|
|
46
|
+
- 仅配置
|
|
47
|
+
- 配置 + 凭证 + 会话
|
|
48
|
+
- 完全重置(也会删除工作区)
|
|
49
|
+
</Step>
|
|
50
|
+
<Step title="模型和身份验证">
|
|
51
|
+
- 完整选项矩阵见 [身份验证和模型选项](#auth-and-model-options)。
|
|
52
|
+
</Step>
|
|
53
|
+
<Step title="工作区">
|
|
54
|
+
- 默认值为 `~/.quantumclaw/workspace`(可配置)。
|
|
55
|
+
- 会植入首次运行 bootstrap 仪式所需的工作区文件。
|
|
56
|
+
- 工作区布局:[智能体工作区](/concepts/agent-workspace)。
|
|
57
|
+
</Step>
|
|
58
|
+
<Step title="Gateway 网关">
|
|
59
|
+
- 会提示你输入端口、绑定、身份验证模式和 tailscale 暴露设置。
|
|
60
|
+
- 建议:即使仅用于 loopback,也保持启用令牌身份验证,这样本地 WS 客户端也必须进行身份验证。
|
|
61
|
+
- 在令牌模式下,交互式设置提供:
|
|
62
|
+
- **生成/存储明文令牌**(默认)
|
|
63
|
+
- **使用 SecretRef**(可选)
|
|
64
|
+
- 在密码模式下,交互式设置也支持明文或 SecretRef 存储。
|
|
65
|
+
- 非交互式令牌 SecretRef 路径:`--gateway-token-ref-env <ENV_VAR>`。
|
|
66
|
+
- 要求在新手引导进程环境中存在一个非空环境变量。
|
|
67
|
+
- 不能与 `--gateway-token` 组合使用。
|
|
68
|
+
- 仅当你完全信任每个本地进程时才禁用身份验证。
|
|
69
|
+
- 非 loopback 绑定仍然需要身份验证。
|
|
70
|
+
</Step>
|
|
71
|
+
<Step title="渠道">
|
|
72
|
+
- [WhatsApp](/channels/whatsapp):可选 QR 登录
|
|
73
|
+
- [Telegram](/channels/telegram):bot 令牌
|
|
74
|
+
- [Discord](/channels/discord):bot 令牌
|
|
75
|
+
- [Google Chat](/channels/googlechat):服务账号 JSON + webhook audience
|
|
76
|
+
- [Mattermost](/channels/mattermost) 插件:bot 令牌 + 基础 URL
|
|
77
|
+
- [Signal](/channels/signal):可选 `signal-cli` 安装 + 账户配置
|
|
78
|
+
- [BlueBubbles](/channels/bluebubbles):推荐用于 iMessage;服务器 URL + 密码 + webhook
|
|
79
|
+
- [iMessage](/channels/imessage):旧版 `imsg` CLI 路径 + 数据库访问
|
|
80
|
+
- 私信安全:默认是配对。首次私信会发送一个代码;通过
|
|
81
|
+
`quantumclaw pairing approve <channel> <code>` 批准,或使用 allowlist。
|
|
82
|
+
</Step>
|
|
83
|
+
<Step title="守护进程安装">
|
|
84
|
+
- macOS:LaunchAgent
|
|
85
|
+
- 需要已登录的用户会话;对于无头环境,请使用自定义 LaunchDaemon(未随附)。
|
|
86
|
+
- Linux 和通过 WSL2 的 Windows:systemd 用户单元
|
|
87
|
+
- 向导会尝试执行 `loginctl enable-linger <user>`,使网关在注销后仍保持运行。
|
|
88
|
+
- 可能会提示输入 sudo(写入 `/var/lib/systemd/linger`);会先尝试不使用 sudo。
|
|
89
|
+
- 运行时选择:Node(推荐;WhatsApp 和 Telegram 必需)。不建议使用 Bun。
|
|
90
|
+
</Step>
|
|
91
|
+
<Step title="健康检查">
|
|
92
|
+
- 启动 Gateway 网关(如有需要),并运行 `quantumclaw health`。
|
|
93
|
+
- `quantumclaw status --deep` 会在状态输出中添加 Gateway 网关健康探测。
|
|
94
|
+
</Step>
|
|
95
|
+
<Step title="Skills">
|
|
96
|
+
- 读取可用的 Skills 并检查要求。
|
|
97
|
+
- 让你选择 node 管理器:npm 或 pnpm(不建议使用 bun)。
|
|
98
|
+
- 安装可选依赖(部分依赖在 macOS 上使用 Homebrew)。
|
|
99
|
+
</Step>
|
|
100
|
+
<Step title="完成">
|
|
101
|
+
- 显示摘要和后续步骤,包括 iOS、Android 和 macOS 应用选项。
|
|
102
|
+
</Step>
|
|
103
|
+
</Steps>
|
|
104
|
+
|
|
105
|
+
<Note>
|
|
106
|
+
如果未检测到 GUI,向导会打印用于控制 UI 的 SSH 端口转发说明,而不是打开浏览器。
|
|
107
|
+
如果缺少控制 UI 资源,向导会尝试构建它们;回退命令为 `pnpm ui:build`(首次运行会自动安装 UI 依赖)。
|
|
108
|
+
</Note>
|
|
109
|
+
|
|
110
|
+
## 远程模式详情
|
|
111
|
+
|
|
112
|
+
远程模式会将此机器配置为连接到其他位置的网关。
|
|
113
|
+
|
|
114
|
+
<Info>
|
|
115
|
+
远程模式不会在远程主机上安装或修改任何内容。
|
|
116
|
+
</Info>
|
|
117
|
+
|
|
118
|
+
你需要设置的内容:
|
|
119
|
+
|
|
120
|
+
- 远程 Gateway 网关 URL(`ws://...`)
|
|
121
|
+
- 如果远程 Gateway 网关需要身份验证,则设置令牌(推荐)
|
|
122
|
+
|
|
123
|
+
<Note>
|
|
124
|
+
- 如果网关仅绑定到 loopback,请使用 SSH 隧道或 tailnet。
|
|
125
|
+
- 发现提示:
|
|
126
|
+
- macOS:Bonjour(`dns-sd`)
|
|
127
|
+
- Linux:Avahi(`avahi-browse`)
|
|
128
|
+
</Note>
|
|
129
|
+
|
|
130
|
+
## 身份验证和模型选项
|
|
131
|
+
|
|
132
|
+
<AccordionGroup>
|
|
133
|
+
<Accordion title="Anthropic API 密钥">
|
|
134
|
+
如果存在 `ANTHROPIC_API_KEY` 则使用它,否则提示输入密钥,然后保存以供守护进程使用。
|
|
135
|
+
</Accordion>
|
|
136
|
+
<Accordion title="Anthropic OAuth(Claude Code CLI)">
|
|
137
|
+
- macOS:检查 Keychain 条目 “Claude Code-credentials”
|
|
138
|
+
- Linux 和 Windows:如果存在,则复用 `~/.claude/.credentials.json`
|
|
139
|
+
|
|
140
|
+
在 macOS 上,请选择 “Always Allow”,以免 launchd 启动被阻塞。
|
|
141
|
+
|
|
142
|
+
</Accordion>
|
|
143
|
+
<Accordion title="Anthropic token(粘贴 setup token)">
|
|
144
|
+
在任意机器上运行 `claude setup-token`,然后粘贴该令牌。
|
|
145
|
+
你可以为其命名;留空则使用默认值。
|
|
146
|
+
</Accordion>
|
|
147
|
+
<Accordion title="OpenAI Code 订阅(复用 Codex CLI)">
|
|
148
|
+
如果存在 `~/.codex/auth.json`,向导可以复用它。
|
|
149
|
+
</Accordion>
|
|
150
|
+
<Accordion title="OpenAI Code 订阅(OAuth)">
|
|
151
|
+
浏览器流程;粘贴 `code#state`。
|
|
152
|
+
|
|
153
|
+
当模型未设置或为 `openai/*` 时,将 `agents.defaults.model` 设置为 `openai-codex/gpt-5.4`。
|
|
154
|
+
|
|
155
|
+
</Accordion>
|
|
156
|
+
<Accordion title="OpenAI API 密钥">
|
|
157
|
+
如果存在 `OPENAI_API_KEY` 则使用它,否则提示输入密钥,然后将该凭证存储在 auth profile 中。
|
|
158
|
+
|
|
159
|
+
当模型未设置、为 `openai/*` 或 `openai-codex/*` 时,将 `agents.defaults.model` 设置为 `openai/gpt-5.1-codex`。
|
|
160
|
+
|
|
161
|
+
</Accordion>
|
|
162
|
+
<Accordion title="xAI(Grok)API 密钥">
|
|
163
|
+
提示输入 `XAI_API_KEY`,并将 xAI 配置为模型提供商。
|
|
164
|
+
</Accordion>
|
|
165
|
+
<Accordion title="OpenCode">
|
|
166
|
+
提示输入 `OPENCODE_API_KEY`(或 `OPENCODE_ZEN_API_KEY`),并让你选择 Zen 或 Go 目录。
|
|
167
|
+
设置 URL:[opencode.ai/auth](https://opencode.ai/auth)。
|
|
168
|
+
</Accordion>
|
|
169
|
+
<Accordion title="API 密钥(通用)">
|
|
170
|
+
会为你存储该密钥。
|
|
171
|
+
</Accordion>
|
|
172
|
+
<Accordion title="Vercel AI Gateway">
|
|
173
|
+
提示输入 `AI_GATEWAY_API_KEY`。
|
|
174
|
+
更多详情:[Vercel AI Gateway](/providers/vercel-ai-gateway)。
|
|
175
|
+
</Accordion>
|
|
176
|
+
<Accordion title="Cloudflare AI Gateway">
|
|
177
|
+
提示输入账户 ID、Gateway ID 和 `CLOUDFLARE_AI_GATEWAY_API_KEY`。
|
|
178
|
+
更多详情:[Cloudflare AI Gateway](/providers/cloudflare-ai-gateway)。
|
|
179
|
+
</Accordion>
|
|
180
|
+
<Accordion title="MiniMax M2.5">
|
|
181
|
+
配置会自动写入。
|
|
182
|
+
更多详情:[MiniMax](/providers/minimax)。
|
|
183
|
+
</Accordion>
|
|
184
|
+
<Accordion title="Synthetic(兼容 Anthropic)">
|
|
185
|
+
提示输入 `SYNTHETIC_API_KEY`。
|
|
186
|
+
更多详情:[Synthetic](/providers/synthetic)。
|
|
187
|
+
</Accordion>
|
|
188
|
+
<Accordion title="Ollama(Cloud 和本地开放模型)">
|
|
189
|
+
提示输入基础 URL(默认 `http://127.0.0.1:11434`),然后提供 Cloud + Local 或 Local 模式。
|
|
190
|
+
会发现可用模型并建议默认值。
|
|
191
|
+
更多详情:[Ollama](/providers/ollama)。
|
|
192
|
+
</Accordion>
|
|
193
|
+
<Accordion title="Moonshot 和 Kimi Coding">
|
|
194
|
+
Moonshot(Kimi K2)和 Kimi Coding 配置会自动写入。
|
|
195
|
+
更多详情:[Moonshot AI(Kimi + Kimi Coding)](/providers/moonshot)。
|
|
196
|
+
</Accordion>
|
|
197
|
+
<Accordion title="自定义提供商">
|
|
198
|
+
适用于兼容 OpenAI 和兼容 Anthropic 的端点。
|
|
199
|
+
|
|
200
|
+
交互式新手引导支持与其他提供商 API 密钥流程相同的 API 密钥存储选项:
|
|
201
|
+
- **现在粘贴 API 密钥**(明文)
|
|
202
|
+
- **使用密钥引用**(环境变量引用或已配置提供商引用,并带有预检验证)
|
|
203
|
+
|
|
204
|
+
非交互式标志:
|
|
205
|
+
- `--auth-choice custom-api-key`
|
|
206
|
+
- `--custom-base-url`
|
|
207
|
+
- `--custom-model-id`
|
|
208
|
+
- `--custom-api-key`(可选;回退到 `CUSTOM_API_KEY`)
|
|
209
|
+
- `--custom-provider-id`(可选)
|
|
210
|
+
- `--custom-compatibility <openai|anthropic>`(可选;默认 `openai`)
|
|
211
|
+
|
|
212
|
+
</Accordion>
|
|
213
|
+
<Accordion title="跳过">
|
|
214
|
+
保持身份验证未配置。
|
|
215
|
+
</Accordion>
|
|
216
|
+
</AccordionGroup>
|
|
217
|
+
|
|
218
|
+
模型行为:
|
|
219
|
+
|
|
220
|
+
- 从检测到的选项中选择默认模型,或手动输入提供商和模型。
|
|
221
|
+
- 向导会执行模型检查,并在配置的模型未知或缺少身份验证时发出警告。
|
|
222
|
+
|
|
223
|
+
凭证和配置档案路径:
|
|
224
|
+
|
|
225
|
+
- OAuth 凭证:`~/.quantumclaw/credentials/oauth.json`
|
|
226
|
+
- Auth profile(API 密钥 + OAuth):`~/.quantumclaw/agents/<agentId>/agent/auth-profiles.json`
|
|
227
|
+
|
|
228
|
+
凭证存储模式:
|
|
229
|
+
|
|
230
|
+
- 默认新手引导行为会将 API 密钥作为明文值持久化到 auth profile 中。
|
|
231
|
+
- `--secret-input-mode ref` 会启用引用模式,而不是明文密钥存储。
|
|
232
|
+
在交互式设置中,你可以选择:
|
|
233
|
+
- 环境变量引用(例如 `keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" }`)
|
|
234
|
+
- 已配置提供商引用(`file` 或 `exec`),带提供商别名 + id
|
|
235
|
+
- 交互式引用模式会在保存前运行快速预检验证。
|
|
236
|
+
- 环境变量引用:验证变量名 + 当前新手引导环境中的非空值。
|
|
237
|
+
- 提供商引用:验证提供商配置并解析所请求的 id。
|
|
238
|
+
- 如果预检失败,新手引导会显示错误并让你重试。
|
|
239
|
+
- 在非交互式模式下,`--secret-input-mode ref` 仅支持由环境变量支持的引用。
|
|
240
|
+
- 在新手引导进程环境中设置提供商环境变量。
|
|
241
|
+
- 内联密钥标志(例如 `--openai-api-key`)要求设置该环境变量;否则新手引导会快速失败。
|
|
242
|
+
- 对于自定义提供商,非交互式 `ref` 模式会将 `models.providers.<id>.apiKey` 存储为 `{ source: "env", provider: "default", id: "CUSTOM_API_KEY" }`。
|
|
243
|
+
- 在这种自定义提供商场景下,`--custom-api-key` 要求设置 `CUSTOM_API_KEY`;否则新手引导会快速失败。
|
|
244
|
+
- Gateway 网关身份验证凭证在交互式设置中支持明文和 SecretRef 选项:
|
|
245
|
+
- 令牌模式:**生成/存储明文令牌**(默认)或 **使用 SecretRef**。
|
|
246
|
+
- 密码模式:明文或 SecretRef。
|
|
247
|
+
- 非交互式令牌 SecretRef 路径:`--gateway-token-ref-env <ENV_VAR>`。
|
|
248
|
+
- 现有的明文设置会继续保持不变并正常工作。
|
|
249
|
+
|
|
250
|
+
<Note>
|
|
251
|
+
无头和服务器提示:在有浏览器的机器上完成 OAuth,然后复制
|
|
252
|
+
`~/.quantumclaw/credentials/oauth.json`(或 `$QUANTUMCLAW_STATE_DIR/credentials/oauth.json`)
|
|
253
|
+
到 Gateway 网关主机。
|
|
254
|
+
</Note>
|
|
255
|
+
|
|
256
|
+
## 输出和内部机制
|
|
257
|
+
|
|
258
|
+
`~/.quantumclaw/quantumclaw.json` 中的典型字段:
|
|
259
|
+
|
|
260
|
+
- `agents.defaults.workspace`
|
|
261
|
+
- `agents.defaults.model` / `models.providers`(如果选择了 Minimax)
|
|
262
|
+
- `tools.profile`(本地新手引导在未设置时默认设为 `"coding"`;现有显式值会保留)
|
|
263
|
+
- `gateway.*`(模式、绑定、身份验证、tailscale)
|
|
264
|
+
- `session.dmScope`(本地新手引导在未设置时默认设为 `per-channel-peer`;现有显式值会保留)
|
|
265
|
+
- `channels.telegram.botToken`、`channels.discord.token`、`channels.signal.*`、`channels.imessage.*`
|
|
266
|
+
- 当你在提示中选择加入时的渠道 allowlist(Slack、Discord、Matrix、Microsoft Teams)(如果可能,名称会解析为 ID)
|
|
267
|
+
- `skills.install.nodeManager`
|
|
268
|
+
- `wizard.lastRunAt`
|
|
269
|
+
- `wizard.lastRunVersion`
|
|
270
|
+
- `wizard.lastRunCommit`
|
|
271
|
+
- `wizard.lastRunCommand`
|
|
272
|
+
- `wizard.lastRunMode`
|
|
273
|
+
|
|
274
|
+
`quantumclaw agents add` 会写入 `agents.list[]` 和可选的 `bindings`。
|
|
275
|
+
|
|
276
|
+
WhatsApp 凭证位于 `~/.quantumclaw/credentials/whatsapp/<accountId>/`。
|
|
277
|
+
会话存储在 `~/.quantumclaw/agents/<agentId>/sessions/` 下。
|
|
278
|
+
|
|
279
|
+
<Note>
|
|
280
|
+
某些渠道以插件形式交付。在设置期间选择这些渠道时,向导
|
|
281
|
+
会先提示安装插件(npm 或本地路径),然后再进行渠道配置。
|
|
282
|
+
</Note>
|
|
283
|
+
|
|
284
|
+
Gateway 网关向导 RPC:
|
|
285
|
+
|
|
286
|
+
- `wizard.start`
|
|
287
|
+
- `wizard.next`
|
|
288
|
+
- `wizard.cancel`
|
|
289
|
+
- `wizard.status`
|
|
290
|
+
|
|
291
|
+
客户端(macOS 应用和控制 UI)可以在不重新实现新手引导逻辑的情况下渲染步骤。
|
|
292
|
+
|
|
293
|
+
Signal 设置行为:
|
|
294
|
+
|
|
295
|
+
- 下载适当的发布资源
|
|
296
|
+
- 将其存储在 `~/.quantumclaw/tools/signal-cli/<version>/`
|
|
297
|
+
- 在配置中写入 `channels.signal.cliPath`
|
|
298
|
+
- JVM 构建需要 Java 21
|
|
299
|
+
- 在可用时使用原生构建
|
|
300
|
+
- Windows 使用 WSL2,并在 WSL 内遵循 Linux 的 signal-cli 流程
|
|
301
|
+
|
|
302
|
+
## 相关文档
|
|
303
|
+
|
|
304
|
+
- 新手引导中心:[设置向导(CLI)](/start/wizard)
|
|
305
|
+
- 自动化和脚本:[CLI 自动化](/start/wizard-cli-automation)
|
|
306
|
+
- 命令参考:[`quantumclaw onboard`](/cli/onboard)
|
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
---
|
|
2
|
+
read_when:
|
|
3
|
+
- 运行或配置 CLI 新手引导
|
|
4
|
+
- 设置一台新机器
|
|
5
|
+
sidebarTitle: "Onboarding: CLI"
|
|
6
|
+
summary: CLI 新手引导:用于 Gateway 网关、工作区、渠道和 Skills 的引导式设置
|
|
7
|
+
title: CLI 新手引导
|
|
8
|
+
x-i18n:
|
|
9
|
+
generated_at: "2026-03-16T06:28:38Z"
|
|
10
|
+
model: gpt-5.4
|
|
11
|
+
provider: openai
|
|
12
|
+
source_hash: 99fd87dddd78798eb0087ad9433e5a32de2af110b6e65ee351b1a194a11c7df3
|
|
13
|
+
source_path: start/wizard.md
|
|
14
|
+
workflow: 15
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
# CLI 新手引导
|
|
18
|
+
|
|
19
|
+
CLI 新手引导是在 macOS、
|
|
20
|
+
Linux 或 Windows(通过 WSL2;强烈推荐)上设置 QuantumClaw 的**推荐**方式。
|
|
21
|
+
它可在一次引导式流程中配置本地 Gateway 网关或远程 Gateway 网关连接,以及渠道、Skills
|
|
22
|
+
和工作区默认值。
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
quantumclaw onboard
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
<Info>
|
|
29
|
+
最快的首次聊天方式:打开 Control UI(无需设置渠道)。运行
|
|
30
|
+
`quantumclaw dashboard` 并在浏览器中聊天。文档:[Dashboard](/web/dashboard)。
|
|
31
|
+
</Info>
|
|
32
|
+
|
|
33
|
+
若要稍后重新配置:
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
quantumclaw configure
|
|
37
|
+
quantumclaw agents add <name>
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
<Note>
|
|
41
|
+
`--json` 并不意味着非交互模式。对于脚本,请使用 `--non-interactive`。
|
|
42
|
+
</Note>
|
|
43
|
+
|
|
44
|
+
<Tip>
|
|
45
|
+
CLI 新手引导包含一个 web search 步骤,你可以选择一个提供商
|
|
46
|
+
(Perplexity、Brave、Gemini、Grok 或 Kimi),并粘贴你的 API 密钥,以便智能体
|
|
47
|
+
可以使用 `web_search`。你也可以稍后通过
|
|
48
|
+
`quantumclaw configure --section web` 进行配置。文档:[Web 工具](/tools/web)。
|
|
49
|
+
</Tip>
|
|
50
|
+
|
|
51
|
+
## 快速开始与高级模式
|
|
52
|
+
|
|
53
|
+
新手引导开始时会让你选择**快速开始**(默认值)或**高级模式**(完全控制)。
|
|
54
|
+
|
|
55
|
+
<Tabs>
|
|
56
|
+
<Tab title="快速开始(默认值)">
|
|
57
|
+
- 本地网关(loopback)
|
|
58
|
+
- 默认工作区(或现有工作区)
|
|
59
|
+
- Gateway 网关端口 **18789**
|
|
60
|
+
- Gateway 网关认证 **Token**(即使在 loopback 上也会自动生成)
|
|
61
|
+
- 新本地设置的默认工具策略:`tools.profile: "coding"`(会保留现有显式配置文件)
|
|
62
|
+
- 私信隔离默认值:本地新手引导会在未设置时写入 `session.dmScope: "per-channel-peer"`。详情见:[CLI 设置参考](/start/wizard-cli-reference#outputs-and-internals)
|
|
63
|
+
- Tailscale 暴露 **关闭**
|
|
64
|
+
- Telegram + WhatsApp 私信默认使用 **allowlist**(系统会提示你输入电话号码)
|
|
65
|
+
</Tab>
|
|
66
|
+
<Tab title="高级模式(完全控制)">
|
|
67
|
+
- 暴露每一个步骤(模式、工作区、Gateway 网关、渠道、守护进程、Skills)。
|
|
68
|
+
</Tab>
|
|
69
|
+
</Tabs>
|
|
70
|
+
|
|
71
|
+
## 新手引导会配置什么
|
|
72
|
+
|
|
73
|
+
**本地模式(默认)**会引导你完成以下步骤:
|
|
74
|
+
|
|
75
|
+
1. **模型/认证** —— 选择任意受支持的提供商/认证流程(API 密钥、OAuth 或 setup-token),包括自定义提供商
|
|
76
|
+
(兼容 OpenAI、兼容 Anthropic,或未知自动检测)。选择一个默认模型。
|
|
77
|
+
安全说明:如果这个智能体将运行工具或处理 webhook/hooks 内容,请优先选择当前可用的最强最新一代模型,并保持严格的工具策略。较弱/较旧的层级更容易被 prompt 注入。
|
|
78
|
+
对于非交互式运行,`--secret-input-mode ref` 会在认证配置文件中存储基于环境变量的引用,而不是明文 API 密钥值。
|
|
79
|
+
在非交互式 `ref` 模式下,必须设置提供商环境变量;如果传入内联密钥标志但缺少该环境变量,则会快速失败。
|
|
80
|
+
在交互式运行中,选择 secret reference 模式后,你可以指向环境变量或已配置的 provider ref(`file` 或 `exec`),并在保存前进行快速预检校验。
|
|
81
|
+
2. **工作区** —— 智能体文件的位置(默认 `~/.quantumclaw/workspace`)。会植入引导文件。
|
|
82
|
+
3. **Gateway 网关** —— 端口、绑定地址、认证模式、Tailscale 暴露。
|
|
83
|
+
在交互式 token 模式中,你可以选择默认的明文 token 存储,或选择启用 SecretRef。
|
|
84
|
+
非交互式 token SecretRef 路径:`--gateway-token-ref-env <ENV_VAR>`。
|
|
85
|
+
4. **渠道** —— WhatsApp、Telegram、Discord、Google Chat、Mattermost、Signal、BlueBubbles 或 iMessage。
|
|
86
|
+
5. **守护进程** —— 安装 LaunchAgent(macOS)或 systemd 用户单元(Linux/WSL2)。
|
|
87
|
+
如果 token 认证需要 token,且 `gateway.auth.token` 由 SecretRef 管理,守护进程安装会验证它,但不会将已解析的 token 持久化到监督服务的环境元数据中。
|
|
88
|
+
如果 token 认证需要 token,而已配置的 token SecretRef 无法解析,守护进程安装会被阻止,并提供可执行的指导。
|
|
89
|
+
如果同时配置了 `gateway.auth.token` 和 `gateway.auth.password`,而 `gateway.auth.mode` 未设置,守护进程安装会被阻止,直到显式设置 mode。
|
|
90
|
+
6. **健康检查** —— 启动 Gateway 网关并验证其正在运行。
|
|
91
|
+
7. **Skills** —— 安装推荐的 Skills 和可选依赖项。
|
|
92
|
+
|
|
93
|
+
<Note>
|
|
94
|
+
重新运行新手引导**不会**清除任何内容,除非你显式选择 **Reset**(或传入 `--reset`)。
|
|
95
|
+
CLI `--reset` 默认会重置配置、凭证和会话;如需包含工作区,请使用 `--reset-scope full`。
|
|
96
|
+
如果配置无效或包含旧版键,新手引导会先要求你运行 `quantumclaw doctor`。
|
|
97
|
+
</Note>
|
|
98
|
+
|
|
99
|
+
**远程模式**只会配置本地客户端以连接到其他地方的 Gateway 网关。
|
|
100
|
+
它**不会**在远程主机上安装或更改任何内容。
|
|
101
|
+
|
|
102
|
+
## 添加另一个智能体
|
|
103
|
+
|
|
104
|
+
使用 `quantumclaw agents add <name>` 创建一个单独的智能体,它拥有自己的工作区、
|
|
105
|
+
会话和认证配置文件。不带 `--workspace` 运行会启动新手引导。
|
|
106
|
+
|
|
107
|
+
它会设置:
|
|
108
|
+
|
|
109
|
+
- `agents.list[].name`
|
|
110
|
+
- `agents.list[].workspace`
|
|
111
|
+
- `agents.list[].agentDir`
|
|
112
|
+
|
|
113
|
+
说明:
|
|
114
|
+
|
|
115
|
+
- 默认工作区遵循 `~/.quantumclaw/workspace-<agentId>`。
|
|
116
|
+
- 添加 `bindings` 以路由入站消息(新手引导可以完成这项操作)。
|
|
117
|
+
- 非交互式标志:`--model`、`--agent-dir`、`--bind`、`--non-interactive`。
|
|
118
|
+
|
|
119
|
+
## 完整参考
|
|
120
|
+
|
|
121
|
+
有关详细的分步骤拆解和配置输出,请参见
|
|
122
|
+
[CLI 设置参考](/start/wizard-cli-reference)。
|
|
123
|
+
有关非交互式示例,请参见 [CLI 自动化](/start/wizard-cli-automation)。
|
|
124
|
+
有关更深入的技术参考(包括 RPC 细节),请参见
|
|
125
|
+
[新手引导参考](/reference/wizard)。
|
|
126
|
+
|
|
127
|
+
## 相关文档
|
|
128
|
+
|
|
129
|
+
- CLI 命令参考:[`quantumclaw onboard`](/cli/onboard)
|
|
130
|
+
- 新手引导概览:[Onboarding Overview](/start/onboarding-overview)
|
|
131
|
+
- macOS 应用新手引导:[新手引导](/start/onboarding)
|
|
132
|
+
- 智能体首次运行仪式:[智能体引导](/start/bootstrapping)
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
---
|
|
2
|
+
read_when:
|
|
3
|
+
- 添加或修改智能体 CLI 入口点
|
|
4
|
+
summary: 直接 `quantumclaw agent` CLI 运行(带可选投递)
|
|
5
|
+
title: Agent Send
|
|
6
|
+
x-i18n:
|
|
7
|
+
generated_at: "2026-02-03T07:54:52Z"
|
|
8
|
+
model: claude-opus-4-5
|
|
9
|
+
provider: pi
|
|
10
|
+
source_hash: a84d6a304333eebe155da2bf24cf5fc0482022a0a48ab34aa1465cd6e667022d
|
|
11
|
+
source_path: tools/agent-send.md
|
|
12
|
+
workflow: 15
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# `quantumclaw agent`(直接智能体运行)
|
|
16
|
+
|
|
17
|
+
`quantumclaw agent` 运行单个智能体回合,无需入站聊天消息。
|
|
18
|
+
默认情况下它**通过 Gateway 网关**运行;添加 `--local` 以强制在当前机器上使用嵌入式运行时。
|
|
19
|
+
|
|
20
|
+
## 行为
|
|
21
|
+
|
|
22
|
+
- 必需:`--message <text>`
|
|
23
|
+
- 会话选择:
|
|
24
|
+
- `--to <dest>` 派生会话键(群组/频道目标保持隔离;直接聊天折叠到 `main`),**或**
|
|
25
|
+
- `--session-id <id>` 通过 ID 重用现有会话,**或**
|
|
26
|
+
- `--agent <id>` 直接定位已配置的智能体(使用该智能体的 `main` 会话键)
|
|
27
|
+
- 运行与正常入站回复相同的嵌入式智能体运行时。
|
|
28
|
+
- 思考/详细标志持久化到会话存储中。
|
|
29
|
+
- 输出:
|
|
30
|
+
- 默认:打印回复文本(加上 `MEDIA:<url>` 行)
|
|
31
|
+
- `--json`:打印结构化负载 + 元数据
|
|
32
|
+
- 可选使用 `--deliver` + `--channel` 将回复投递回渠道(目标格式与 `quantumclaw message --target` 匹配)。
|
|
33
|
+
- 使用 `--reply-channel`/`--reply-to`/`--reply-account` 覆盖投递而不更改会话。
|
|
34
|
+
|
|
35
|
+
如果 Gateway 网关不可达,CLI 会**回退**到嵌入式本地运行。
|
|
36
|
+
|
|
37
|
+
## 示例
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
quantumclaw agent --to +15555550123 --message "status update"
|
|
41
|
+
quantumclaw agent --agent ops --message "Summarize logs"
|
|
42
|
+
quantumclaw agent --session-id 1234 --message "Summarize inbox" --thinking medium
|
|
43
|
+
quantumclaw agent --to +15555550123 --message "Trace logs" --verbose on --json
|
|
44
|
+
quantumclaw agent --to +15555550123 --message "Summon reply" --deliver
|
|
45
|
+
quantumclaw agent --agent ops --message "Generate report" --deliver --reply-channel slack --reply-to "#reports"
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## 标志
|
|
49
|
+
|
|
50
|
+
- `--local`:本地运行(需要你的 shell 中有模型提供商 API 密钥)
|
|
51
|
+
- `--deliver`:将回复发送到所选渠道
|
|
52
|
+
- `--channel`:投递渠道(`whatsapp|telegram|discord|googlechat|slack|signal|imessage`,默认:`whatsapp`)
|
|
53
|
+
- `--reply-to`:投递目标覆盖
|
|
54
|
+
- `--reply-channel`:投递渠道覆盖
|
|
55
|
+
- `--reply-account`:投递账户 ID 覆盖
|
|
56
|
+
- `--thinking <off|minimal|low|medium|high|xhigh>`:持久化思考级别(仅限 GPT-5.2 + Codex 模型)
|
|
57
|
+
- `--verbose <on|full|off>`:持久化详细级别
|
|
58
|
+
- `--timeout <seconds>`:覆盖智能体超时
|
|
59
|
+
- `--json`:输出结构化 JSON
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
---
|
|
2
|
+
read_when:
|
|
3
|
+
- 你需要跨多个文件进行结构化编辑
|
|
4
|
+
- 你想要记录或调试基于补丁的编辑
|
|
5
|
+
summary: 使用 apply_patch 工具应用多文件补丁
|
|
6
|
+
title: apply_patch 工具
|
|
7
|
+
x-i18n:
|
|
8
|
+
generated_at: "2026-02-01T21:39:24Z"
|
|
9
|
+
model: claude-opus-4-5
|
|
10
|
+
provider: pi
|
|
11
|
+
source_hash: 8cec2b4ee3afa9105fc3dd1bc28a338917df129afc634ac83620a3347c46bcec
|
|
12
|
+
source_path: tools/apply-patch.md
|
|
13
|
+
workflow: 15
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
# apply_patch 工具
|
|
17
|
+
|
|
18
|
+
使用结构化补丁格式应用文件更改。这非常适合多文件
|
|
19
|
+
或多段编辑,在这些场景下单次 `edit` 调用会很脆弱。
|
|
20
|
+
|
|
21
|
+
该工具接受一个 `input` 字符串,其中包含一个或多个文件操作:
|
|
22
|
+
|
|
23
|
+
```
|
|
24
|
+
*** Begin Patch
|
|
25
|
+
*** Add File: path/to/file.txt
|
|
26
|
+
+line 1
|
|
27
|
+
+line 2
|
|
28
|
+
*** Update File: src/app.ts
|
|
29
|
+
@@
|
|
30
|
+
-old line
|
|
31
|
+
+new line
|
|
32
|
+
*** Delete File: obsolete.txt
|
|
33
|
+
*** End Patch
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## 参数
|
|
37
|
+
|
|
38
|
+
- `input`(必需):完整的补丁内容,包括 `*** Begin Patch` 和 `*** End Patch`。
|
|
39
|
+
|
|
40
|
+
## 说明
|
|
41
|
+
|
|
42
|
+
- 路径相对于工作区根目录解析。
|
|
43
|
+
- 在 `*** Update File:` 段中使用 `*** Move to:` 可重命名文件。
|
|
44
|
+
- 需要时使用 `*** End of File` 标记仅在文件末尾的插入。
|
|
45
|
+
- 实验性功能,默认禁用。通过 `tools.exec.applyPatch.enabled` 启用。
|
|
46
|
+
- 仅限 OpenAI(包括 OpenAI Codex)。可选通过
|
|
47
|
+
`tools.exec.applyPatch.allowModels` 按模型进行限制。
|
|
48
|
+
- 配置仅在 `tools.exec` 下。
|
|
49
|
+
|
|
50
|
+
## 示例
|
|
51
|
+
|
|
52
|
+
```json
|
|
53
|
+
{
|
|
54
|
+
"tool": "apply_patch",
|
|
55
|
+
"input": "*** Begin Patch\n*** Update File: src/index.ts\n@@\n-const foo = 1\n+const foo = 2\n*** End Patch"
|
|
56
|
+
}
|
|
57
|
+
```
|