@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,215 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "Scripted onboarding and agent setup for the QuantumClaw CLI"
|
|
3
|
+
read_when:
|
|
4
|
+
- You are automating onboarding in scripts or CI
|
|
5
|
+
- You need non-interactive examples for specific providers
|
|
6
|
+
title: "CLI Automation"
|
|
7
|
+
sidebarTitle: "CLI automation"
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# CLI Automation
|
|
11
|
+
|
|
12
|
+
Use `--non-interactive` to automate `quantumclaw onboard`.
|
|
13
|
+
|
|
14
|
+
<Note>
|
|
15
|
+
`--json` does not imply non-interactive mode. Use `--non-interactive` (and `--workspace`) for scripts.
|
|
16
|
+
</Note>
|
|
17
|
+
|
|
18
|
+
## Baseline non-interactive example
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
quantumclaw onboard --non-interactive \
|
|
22
|
+
--mode local \
|
|
23
|
+
--auth-choice apiKey \
|
|
24
|
+
--anthropic-api-key "$ANTHROPIC_API_KEY" \
|
|
25
|
+
--secret-input-mode plaintext \
|
|
26
|
+
--gateway-port 18789 \
|
|
27
|
+
--gateway-bind loopback \
|
|
28
|
+
--install-daemon \
|
|
29
|
+
--daemon-runtime node \
|
|
30
|
+
--skip-skills
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Add `--json` for a machine-readable summary.
|
|
34
|
+
|
|
35
|
+
Use `--secret-input-mode ref` to store env-backed refs in auth profiles instead of plaintext values.
|
|
36
|
+
Interactive selection between env refs and configured provider refs (`file` or `exec`) is available in the onboarding flow.
|
|
37
|
+
|
|
38
|
+
In non-interactive `ref` mode, provider env vars must be set in the process environment.
|
|
39
|
+
Passing inline key flags without the matching env var now fails fast.
|
|
40
|
+
|
|
41
|
+
Example:
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
quantumclaw onboard --non-interactive \
|
|
45
|
+
--mode local \
|
|
46
|
+
--auth-choice openai-api-key \
|
|
47
|
+
--secret-input-mode ref \
|
|
48
|
+
--accept-risk
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## Provider-specific examples
|
|
52
|
+
|
|
53
|
+
<AccordionGroup>
|
|
54
|
+
<Accordion title="Gemini example">
|
|
55
|
+
```bash
|
|
56
|
+
quantumclaw onboard --non-interactive \
|
|
57
|
+
--mode local \
|
|
58
|
+
--auth-choice gemini-api-key \
|
|
59
|
+
--gemini-api-key "$GEMINI_API_KEY" \
|
|
60
|
+
--gateway-port 18789 \
|
|
61
|
+
--gateway-bind loopback
|
|
62
|
+
```
|
|
63
|
+
</Accordion>
|
|
64
|
+
<Accordion title="Z.AI example">
|
|
65
|
+
```bash
|
|
66
|
+
quantumclaw onboard --non-interactive \
|
|
67
|
+
--mode local \
|
|
68
|
+
--auth-choice zai-api-key \
|
|
69
|
+
--zai-api-key "$ZAI_API_KEY" \
|
|
70
|
+
--gateway-port 18789 \
|
|
71
|
+
--gateway-bind loopback
|
|
72
|
+
```
|
|
73
|
+
</Accordion>
|
|
74
|
+
<Accordion title="Vercel AI Gateway example">
|
|
75
|
+
```bash
|
|
76
|
+
quantumclaw onboard --non-interactive \
|
|
77
|
+
--mode local \
|
|
78
|
+
--auth-choice ai-gateway-api-key \
|
|
79
|
+
--ai-gateway-api-key "$AI_GATEWAY_API_KEY" \
|
|
80
|
+
--gateway-port 18789 \
|
|
81
|
+
--gateway-bind loopback
|
|
82
|
+
```
|
|
83
|
+
</Accordion>
|
|
84
|
+
<Accordion title="Cloudflare AI Gateway example">
|
|
85
|
+
```bash
|
|
86
|
+
quantumclaw onboard --non-interactive \
|
|
87
|
+
--mode local \
|
|
88
|
+
--auth-choice cloudflare-ai-gateway-api-key \
|
|
89
|
+
--cloudflare-ai-gateway-account-id "your-account-id" \
|
|
90
|
+
--cloudflare-ai-gateway-gateway-id "your-gateway-id" \
|
|
91
|
+
--cloudflare-ai-gateway-api-key "$CLOUDFLARE_AI_GATEWAY_API_KEY" \
|
|
92
|
+
--gateway-port 18789 \
|
|
93
|
+
--gateway-bind loopback
|
|
94
|
+
```
|
|
95
|
+
</Accordion>
|
|
96
|
+
<Accordion title="Moonshot example">
|
|
97
|
+
```bash
|
|
98
|
+
quantumclaw onboard --non-interactive \
|
|
99
|
+
--mode local \
|
|
100
|
+
--auth-choice moonshot-api-key \
|
|
101
|
+
--moonshot-api-key "$MOONSHOT_API_KEY" \
|
|
102
|
+
--gateway-port 18789 \
|
|
103
|
+
--gateway-bind loopback
|
|
104
|
+
```
|
|
105
|
+
</Accordion>
|
|
106
|
+
<Accordion title="Mistral example">
|
|
107
|
+
```bash
|
|
108
|
+
quantumclaw onboard --non-interactive \
|
|
109
|
+
--mode local \
|
|
110
|
+
--auth-choice mistral-api-key \
|
|
111
|
+
--mistral-api-key "$MISTRAL_API_KEY" \
|
|
112
|
+
--gateway-port 18789 \
|
|
113
|
+
--gateway-bind loopback
|
|
114
|
+
```
|
|
115
|
+
</Accordion>
|
|
116
|
+
<Accordion title="Synthetic example">
|
|
117
|
+
```bash
|
|
118
|
+
quantumclaw onboard --non-interactive \
|
|
119
|
+
--mode local \
|
|
120
|
+
--auth-choice synthetic-api-key \
|
|
121
|
+
--synthetic-api-key "$SYNTHETIC_API_KEY" \
|
|
122
|
+
--gateway-port 18789 \
|
|
123
|
+
--gateway-bind loopback
|
|
124
|
+
```
|
|
125
|
+
</Accordion>
|
|
126
|
+
<Accordion title="OpenCode example">
|
|
127
|
+
```bash
|
|
128
|
+
quantumclaw onboard --non-interactive \
|
|
129
|
+
--mode local \
|
|
130
|
+
--auth-choice opencode-zen \
|
|
131
|
+
--opencode-zen-api-key "$OPENCODE_API_KEY" \
|
|
132
|
+
--gateway-port 18789 \
|
|
133
|
+
--gateway-bind loopback
|
|
134
|
+
```
|
|
135
|
+
Swap to `--auth-choice opencode-go --opencode-go-api-key "$OPENCODE_API_KEY"` for the Go catalog.
|
|
136
|
+
</Accordion>
|
|
137
|
+
<Accordion title="Ollama example">
|
|
138
|
+
```bash
|
|
139
|
+
quantumclaw onboard --non-interactive \
|
|
140
|
+
--mode local \
|
|
141
|
+
--auth-choice ollama \
|
|
142
|
+
--custom-model-id "qwen3.5:27b" \
|
|
143
|
+
--accept-risk \
|
|
144
|
+
--gateway-port 18789 \
|
|
145
|
+
--gateway-bind loopback
|
|
146
|
+
```
|
|
147
|
+
</Accordion>
|
|
148
|
+
<Accordion title="Custom provider example">
|
|
149
|
+
```bash
|
|
150
|
+
quantumclaw onboard --non-interactive \
|
|
151
|
+
--mode local \
|
|
152
|
+
--auth-choice custom-api-key \
|
|
153
|
+
--custom-base-url "https://llm.example.com/v1" \
|
|
154
|
+
--custom-model-id "foo-large" \
|
|
155
|
+
--custom-api-key "$CUSTOM_API_KEY" \
|
|
156
|
+
--custom-provider-id "my-custom" \
|
|
157
|
+
--custom-compatibility anthropic \
|
|
158
|
+
--gateway-port 18789 \
|
|
159
|
+
--gateway-bind loopback
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
`--custom-api-key` is optional. If omitted, onboarding checks `CUSTOM_API_KEY`.
|
|
163
|
+
|
|
164
|
+
Ref-mode variant:
|
|
165
|
+
|
|
166
|
+
```bash
|
|
167
|
+
export CUSTOM_API_KEY="your-key"
|
|
168
|
+
quantumclaw onboard --non-interactive \
|
|
169
|
+
--mode local \
|
|
170
|
+
--auth-choice custom-api-key \
|
|
171
|
+
--custom-base-url "https://llm.example.com/v1" \
|
|
172
|
+
--custom-model-id "foo-large" \
|
|
173
|
+
--secret-input-mode ref \
|
|
174
|
+
--custom-provider-id "my-custom" \
|
|
175
|
+
--custom-compatibility anthropic \
|
|
176
|
+
--gateway-port 18789 \
|
|
177
|
+
--gateway-bind loopback
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
In this mode, onboarding stores `apiKey` as `{ source: "env", provider: "default", id: "CUSTOM_API_KEY" }`.
|
|
181
|
+
|
|
182
|
+
</Accordion>
|
|
183
|
+
</AccordionGroup>
|
|
184
|
+
|
|
185
|
+
## Add another agent
|
|
186
|
+
|
|
187
|
+
Use `quantumclaw agents add <name>` to create a separate agent with its own workspace,
|
|
188
|
+
sessions, and auth profiles. Running without `--workspace` launches the wizard.
|
|
189
|
+
|
|
190
|
+
```bash
|
|
191
|
+
quantumclaw agents add work \
|
|
192
|
+
--workspace ~/.quantumclaw/workspace-work \
|
|
193
|
+
--model openai/gpt-5.2 \
|
|
194
|
+
--bind whatsapp:biz \
|
|
195
|
+
--non-interactive \
|
|
196
|
+
--json
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
What it sets:
|
|
200
|
+
|
|
201
|
+
- `agents.list[].name`
|
|
202
|
+
- `agents.list[].workspace`
|
|
203
|
+
- `agents.list[].agentDir`
|
|
204
|
+
|
|
205
|
+
Notes:
|
|
206
|
+
|
|
207
|
+
- Default workspaces follow `~/.quantumclaw/workspace-<agentId>`.
|
|
208
|
+
- Add `bindings` to route inbound messages (the wizard can do this).
|
|
209
|
+
- Non-interactive flags: `--model`, `--agent-dir`, `--bind`, `--non-interactive`.
|
|
210
|
+
|
|
211
|
+
## Related docs
|
|
212
|
+
|
|
213
|
+
- Onboarding hub: [Onboarding (CLI)](/start/wizard)
|
|
214
|
+
- Full reference: [CLI Setup Reference](/start/wizard-cli-reference)
|
|
215
|
+
- Command reference: [`quantumclaw onboard`](/cli/onboard)
|
|
@@ -0,0 +1,299 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "Complete reference for CLI setup flow, auth/model setup, outputs, and internals"
|
|
3
|
+
read_when:
|
|
4
|
+
- You need detailed behavior for quantumclaw onboard
|
|
5
|
+
- You are debugging onboarding results or integrating onboarding clients
|
|
6
|
+
title: "CLI Setup Reference"
|
|
7
|
+
sidebarTitle: "CLI reference"
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# CLI Setup Reference
|
|
11
|
+
|
|
12
|
+
This page is the full reference for `quantumclaw onboard`.
|
|
13
|
+
For the short guide, see [Onboarding (CLI)](/start/wizard).
|
|
14
|
+
|
|
15
|
+
## What the wizard does
|
|
16
|
+
|
|
17
|
+
Local mode (default) walks you through:
|
|
18
|
+
|
|
19
|
+
- Model and auth setup (OpenAI Code subscription OAuth, Anthropic API key or setup token, plus MiniMax, GLM, Ollama, Moonshot, and AI Gateway options)
|
|
20
|
+
- Workspace location and bootstrap files
|
|
21
|
+
- Gateway settings (port, bind, auth, tailscale)
|
|
22
|
+
- Channels and providers (Telegram, WhatsApp, Discord, Google Chat, Mattermost plugin, Signal)
|
|
23
|
+
- Daemon install (LaunchAgent or systemd user unit)
|
|
24
|
+
- Health check
|
|
25
|
+
- Skills setup
|
|
26
|
+
|
|
27
|
+
Remote mode configures this machine to connect to a gateway elsewhere.
|
|
28
|
+
It does not install or modify anything on the remote host.
|
|
29
|
+
|
|
30
|
+
## Local flow details
|
|
31
|
+
|
|
32
|
+
<Steps>
|
|
33
|
+
<Step title="Existing config detection">
|
|
34
|
+
- If `~/.quantumclaw/quantumclaw.json` exists, choose Keep, Modify, or Reset.
|
|
35
|
+
- Re-running the wizard does not wipe anything unless you explicitly choose Reset (or pass `--reset`).
|
|
36
|
+
- CLI `--reset` defaults to `config+creds+sessions`; use `--reset-scope full` to also remove workspace.
|
|
37
|
+
- If config is invalid or contains legacy keys, the wizard stops and asks you to run `quantumclaw doctor` before continuing.
|
|
38
|
+
- Reset uses `trash` and offers scopes:
|
|
39
|
+
- Config only
|
|
40
|
+
- Config + credentials + sessions
|
|
41
|
+
- Full reset (also removes workspace)
|
|
42
|
+
</Step>
|
|
43
|
+
<Step title="Model and auth">
|
|
44
|
+
- Full option matrix is in [Auth and model options](#auth-and-model-options).
|
|
45
|
+
</Step>
|
|
46
|
+
<Step title="Workspace">
|
|
47
|
+
- Default `~/.quantumclaw/workspace` (configurable).
|
|
48
|
+
- Seeds workspace files needed for first-run bootstrap ritual.
|
|
49
|
+
- Workspace layout: [Agent workspace](/concepts/agent-workspace).
|
|
50
|
+
</Step>
|
|
51
|
+
<Step title="Gateway">
|
|
52
|
+
- Prompts for port, bind, auth mode, and tailscale exposure.
|
|
53
|
+
- Recommended: keep token auth enabled even for loopback so local WS clients must authenticate.
|
|
54
|
+
- In token mode, interactive setup offers:
|
|
55
|
+
- **Generate/store plaintext token** (default)
|
|
56
|
+
- **Use SecretRef** (opt-in)
|
|
57
|
+
- In password mode, interactive setup also supports plaintext or SecretRef storage.
|
|
58
|
+
- Non-interactive token SecretRef path: `--gateway-token-ref-env <ENV_VAR>`.
|
|
59
|
+
- Requires a non-empty env var in the onboarding process environment.
|
|
60
|
+
- Cannot be combined with `--gateway-token`.
|
|
61
|
+
- Disable auth only if you fully trust every local process.
|
|
62
|
+
- Non-loopback binds still require auth.
|
|
63
|
+
</Step>
|
|
64
|
+
<Step title="Channels">
|
|
65
|
+
- [WhatsApp](/channels/whatsapp): optional QR login
|
|
66
|
+
- [Telegram](/channels/telegram): bot token
|
|
67
|
+
- [Discord](/channels/discord): bot token
|
|
68
|
+
- [Google Chat](/channels/googlechat): service account JSON + webhook audience
|
|
69
|
+
- [Mattermost](/channels/mattermost) plugin: bot token + base URL
|
|
70
|
+
- [Signal](/channels/signal): optional `signal-cli` install + account config
|
|
71
|
+
- [BlueBubbles](/channels/bluebubbles): recommended for iMessage; server URL + password + webhook
|
|
72
|
+
- [iMessage](/channels/imessage): legacy `imsg` CLI path + DB access
|
|
73
|
+
- DM security: default is pairing. First DM sends a code; approve via
|
|
74
|
+
`quantumclaw pairing approve <channel> <code>` or use allowlists.
|
|
75
|
+
</Step>
|
|
76
|
+
<Step title="Daemon install">
|
|
77
|
+
- macOS: LaunchAgent
|
|
78
|
+
- Requires logged-in user session; for headless, use a custom LaunchDaemon (not shipped).
|
|
79
|
+
- Linux and Windows via WSL2: systemd user unit
|
|
80
|
+
- Wizard attempts `loginctl enable-linger <user>` so gateway stays up after logout.
|
|
81
|
+
- May prompt for sudo (writes `/var/lib/systemd/linger`); it tries without sudo first.
|
|
82
|
+
- Runtime selection: Node (recommended; required for WhatsApp and Telegram). Bun is not recommended.
|
|
83
|
+
</Step>
|
|
84
|
+
<Step title="Health check">
|
|
85
|
+
- Starts gateway (if needed) and runs `quantumclaw health`.
|
|
86
|
+
- `quantumclaw status --deep` adds gateway health probes to status output.
|
|
87
|
+
</Step>
|
|
88
|
+
<Step title="Skills">
|
|
89
|
+
- Reads available skills and checks requirements.
|
|
90
|
+
- Lets you choose node manager: npm or pnpm (bun not recommended).
|
|
91
|
+
- Installs optional dependencies (some use Homebrew on macOS).
|
|
92
|
+
</Step>
|
|
93
|
+
<Step title="Finish">
|
|
94
|
+
- Summary and next steps, including iOS, Android, and macOS app options.
|
|
95
|
+
</Step>
|
|
96
|
+
</Steps>
|
|
97
|
+
|
|
98
|
+
<Note>
|
|
99
|
+
If no GUI is detected, the wizard prints SSH port-forward instructions for the Control UI instead of opening a browser.
|
|
100
|
+
If Control UI assets are missing, the wizard attempts to build them; fallback is `pnpm ui:build` (auto-installs UI deps).
|
|
101
|
+
</Note>
|
|
102
|
+
|
|
103
|
+
## Remote mode details
|
|
104
|
+
|
|
105
|
+
Remote mode configures this machine to connect to a gateway elsewhere.
|
|
106
|
+
|
|
107
|
+
<Info>
|
|
108
|
+
Remote mode does not install or modify anything on the remote host.
|
|
109
|
+
</Info>
|
|
110
|
+
|
|
111
|
+
What you set:
|
|
112
|
+
|
|
113
|
+
- Remote gateway URL (`ws://...`)
|
|
114
|
+
- Token if remote gateway auth is required (recommended)
|
|
115
|
+
|
|
116
|
+
<Note>
|
|
117
|
+
- If gateway is loopback-only, use SSH tunneling or a tailnet.
|
|
118
|
+
- Discovery hints:
|
|
119
|
+
- macOS: Bonjour (`dns-sd`)
|
|
120
|
+
- Linux: Avahi (`avahi-browse`)
|
|
121
|
+
</Note>
|
|
122
|
+
|
|
123
|
+
## Auth and model options
|
|
124
|
+
|
|
125
|
+
<AccordionGroup>
|
|
126
|
+
<Accordion title="Anthropic API key">
|
|
127
|
+
Uses `ANTHROPIC_API_KEY` if present or prompts for a key, then saves it for daemon use.
|
|
128
|
+
</Accordion>
|
|
129
|
+
<Accordion title="Anthropic OAuth (Claude Code CLI)">
|
|
130
|
+
- macOS: checks Keychain item "Claude Code-credentials"
|
|
131
|
+
- Linux and Windows: reuses `~/.claude/.credentials.json` if present
|
|
132
|
+
|
|
133
|
+
On macOS, choose "Always Allow" so launchd starts do not block.
|
|
134
|
+
|
|
135
|
+
</Accordion>
|
|
136
|
+
<Accordion title="Anthropic token (setup-token paste)">
|
|
137
|
+
Run `claude setup-token` on any machine, then paste the token.
|
|
138
|
+
You can name it; blank uses default.
|
|
139
|
+
</Accordion>
|
|
140
|
+
<Accordion title="OpenAI Code subscription (Codex CLI reuse)">
|
|
141
|
+
If `~/.codex/auth.json` exists, the wizard can reuse it.
|
|
142
|
+
</Accordion>
|
|
143
|
+
<Accordion title="OpenAI Code subscription (OAuth)">
|
|
144
|
+
Browser flow; paste `code#state`.
|
|
145
|
+
|
|
146
|
+
Sets `agents.defaults.model` to `openai-codex/gpt-5.4` when model is unset or `openai/*`.
|
|
147
|
+
|
|
148
|
+
</Accordion>
|
|
149
|
+
<Accordion title="OpenAI API key">
|
|
150
|
+
Uses `OPENAI_API_KEY` if present or prompts for a key, then stores the credential in auth profiles.
|
|
151
|
+
|
|
152
|
+
Sets `agents.defaults.model` to `openai/gpt-5.4` when model is unset, `openai/*`, or `openai-codex/*`.
|
|
153
|
+
|
|
154
|
+
</Accordion>
|
|
155
|
+
<Accordion title="xAI (Grok) API key">
|
|
156
|
+
Prompts for `XAI_API_KEY` and configures xAI as a model provider.
|
|
157
|
+
</Accordion>
|
|
158
|
+
<Accordion title="OpenCode">
|
|
159
|
+
Prompts for `OPENCODE_API_KEY` (or `OPENCODE_ZEN_API_KEY`) and lets you choose the Zen or Go catalog.
|
|
160
|
+
Setup URL: [opencode.ai/auth](https://opencode.ai/auth).
|
|
161
|
+
</Accordion>
|
|
162
|
+
<Accordion title="API key (generic)">
|
|
163
|
+
Stores the key for you.
|
|
164
|
+
</Accordion>
|
|
165
|
+
<Accordion title="Vercel AI Gateway">
|
|
166
|
+
Prompts for `AI_GATEWAY_API_KEY`.
|
|
167
|
+
More detail: [Vercel AI Gateway](/providers/vercel-ai-gateway).
|
|
168
|
+
</Accordion>
|
|
169
|
+
<Accordion title="Cloudflare AI Gateway">
|
|
170
|
+
Prompts for account ID, gateway ID, and `CLOUDFLARE_AI_GATEWAY_API_KEY`.
|
|
171
|
+
More detail: [Cloudflare AI Gateway](/providers/cloudflare-ai-gateway).
|
|
172
|
+
</Accordion>
|
|
173
|
+
<Accordion title="MiniMax">
|
|
174
|
+
Config is auto-written. Hosted default is `MiniMax-M2.7`; `MiniMax-M2.5` stays available.
|
|
175
|
+
More detail: [MiniMax](/providers/minimax).
|
|
176
|
+
</Accordion>
|
|
177
|
+
<Accordion title="Synthetic (Anthropic-compatible)">
|
|
178
|
+
Prompts for `SYNTHETIC_API_KEY`.
|
|
179
|
+
More detail: [Synthetic](/providers/synthetic).
|
|
180
|
+
</Accordion>
|
|
181
|
+
<Accordion title="Ollama (Cloud and local open models)">
|
|
182
|
+
Prompts for base URL (default `http://127.0.0.1:11434`), then offers Cloud + Local or Local mode.
|
|
183
|
+
Discovers available models and suggests defaults.
|
|
184
|
+
More detail: [Ollama](/providers/ollama).
|
|
185
|
+
</Accordion>
|
|
186
|
+
<Accordion title="Moonshot and Kimi Coding">
|
|
187
|
+
Moonshot (Kimi K2) and Kimi Coding configs are auto-written.
|
|
188
|
+
More detail: [Moonshot AI (Kimi + Kimi Coding)](/providers/moonshot).
|
|
189
|
+
</Accordion>
|
|
190
|
+
<Accordion title="Custom provider">
|
|
191
|
+
Works with OpenAI-compatible and Anthropic-compatible endpoints.
|
|
192
|
+
|
|
193
|
+
Interactive onboarding supports the same API key storage choices as other provider API key flows:
|
|
194
|
+
- **Paste API key now** (plaintext)
|
|
195
|
+
- **Use secret reference** (env ref or configured provider ref, with preflight validation)
|
|
196
|
+
|
|
197
|
+
Non-interactive flags:
|
|
198
|
+
- `--auth-choice custom-api-key`
|
|
199
|
+
- `--custom-base-url`
|
|
200
|
+
- `--custom-model-id`
|
|
201
|
+
- `--custom-api-key` (optional; falls back to `CUSTOM_API_KEY`)
|
|
202
|
+
- `--custom-provider-id` (optional)
|
|
203
|
+
- `--custom-compatibility <openai|anthropic>` (optional; default `openai`)
|
|
204
|
+
|
|
205
|
+
</Accordion>
|
|
206
|
+
<Accordion title="Skip">
|
|
207
|
+
Leaves auth unconfigured.
|
|
208
|
+
</Accordion>
|
|
209
|
+
</AccordionGroup>
|
|
210
|
+
|
|
211
|
+
Model behavior:
|
|
212
|
+
|
|
213
|
+
- Pick default model from detected options, or enter provider and model manually.
|
|
214
|
+
- Wizard runs a model check and warns if the configured model is unknown or missing auth.
|
|
215
|
+
|
|
216
|
+
Credential and profile paths:
|
|
217
|
+
|
|
218
|
+
- OAuth credentials: `~/.quantumclaw/credentials/oauth.json`
|
|
219
|
+
- Auth profiles (API keys + OAuth): `~/.quantumclaw/agents/<agentId>/agent/auth-profiles.json`
|
|
220
|
+
|
|
221
|
+
Credential storage mode:
|
|
222
|
+
|
|
223
|
+
- Default onboarding behavior persists API keys as plaintext values in auth profiles.
|
|
224
|
+
- `--secret-input-mode ref` enables reference mode instead of plaintext key storage.
|
|
225
|
+
In interactive setup, you can choose either:
|
|
226
|
+
- environment variable ref (for example `keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" }`)
|
|
227
|
+
- configured provider ref (`file` or `exec`) with provider alias + id
|
|
228
|
+
- Interactive reference mode runs a fast preflight validation before saving.
|
|
229
|
+
- Env refs: validates variable name + non-empty value in the current onboarding environment.
|
|
230
|
+
- Provider refs: validates provider config and resolves the requested id.
|
|
231
|
+
- If preflight fails, onboarding shows the error and lets you retry.
|
|
232
|
+
- In non-interactive mode, `--secret-input-mode ref` is env-backed only.
|
|
233
|
+
- Set the provider env var in the onboarding process environment.
|
|
234
|
+
- Inline key flags (for example `--openai-api-key`) require that env var to be set; otherwise onboarding fails fast.
|
|
235
|
+
- For custom providers, non-interactive `ref` mode stores `models.providers.<id>.apiKey` as `{ source: "env", provider: "default", id: "CUSTOM_API_KEY" }`.
|
|
236
|
+
- In that custom-provider case, `--custom-api-key` requires `CUSTOM_API_KEY` to be set; otherwise onboarding fails fast.
|
|
237
|
+
- Gateway auth credentials support plaintext and SecretRef choices in interactive setup:
|
|
238
|
+
- Token mode: **Generate/store plaintext token** (default) or **Use SecretRef**.
|
|
239
|
+
- Password mode: plaintext or SecretRef.
|
|
240
|
+
- Non-interactive token SecretRef path: `--gateway-token-ref-env <ENV_VAR>`.
|
|
241
|
+
- Existing plaintext setups continue to work unchanged.
|
|
242
|
+
|
|
243
|
+
<Note>
|
|
244
|
+
Headless and server tip: complete OAuth on a machine with a browser, then copy
|
|
245
|
+
`~/.quantumclaw/credentials/oauth.json` (or `$QUANTUMCLAW_STATE_DIR/credentials/oauth.json`)
|
|
246
|
+
to the gateway host.
|
|
247
|
+
</Note>
|
|
248
|
+
|
|
249
|
+
## Outputs and internals
|
|
250
|
+
|
|
251
|
+
Typical fields in `~/.quantumclaw/quantumclaw.json`:
|
|
252
|
+
|
|
253
|
+
- `agents.defaults.workspace`
|
|
254
|
+
- `agents.defaults.model` / `models.providers` (if Minimax chosen)
|
|
255
|
+
- `tools.profile` (local onboarding defaults to `"coding"` when unset; existing explicit values are preserved)
|
|
256
|
+
- `gateway.*` (mode, bind, auth, tailscale)
|
|
257
|
+
- `session.dmScope` (local onboarding defaults this to `per-channel-peer` when unset; existing explicit values are preserved)
|
|
258
|
+
- `channels.telegram.botToken`, `channels.discord.token`, `channels.signal.*`, `channels.imessage.*`
|
|
259
|
+
- Channel allowlists (Slack, Discord, Matrix, Microsoft Teams) when you opt in during prompts (names resolve to IDs when possible)
|
|
260
|
+
- `skills.install.nodeManager`
|
|
261
|
+
- `wizard.lastRunAt`
|
|
262
|
+
- `wizard.lastRunVersion`
|
|
263
|
+
- `wizard.lastRunCommit`
|
|
264
|
+
- `wizard.lastRunCommand`
|
|
265
|
+
- `wizard.lastRunMode`
|
|
266
|
+
|
|
267
|
+
`quantumclaw agents add` writes `agents.list[]` and optional `bindings`.
|
|
268
|
+
|
|
269
|
+
WhatsApp credentials go under `~/.quantumclaw/credentials/whatsapp/<accountId>/`.
|
|
270
|
+
Sessions are stored under `~/.quantumclaw/agents/<agentId>/sessions/`.
|
|
271
|
+
|
|
272
|
+
<Note>
|
|
273
|
+
Some channels are delivered as plugins. When selected during setup, the wizard
|
|
274
|
+
prompts to install the plugin (npm or local path) before channel configuration.
|
|
275
|
+
</Note>
|
|
276
|
+
|
|
277
|
+
Gateway wizard RPC:
|
|
278
|
+
|
|
279
|
+
- `wizard.start`
|
|
280
|
+
- `wizard.next`
|
|
281
|
+
- `wizard.cancel`
|
|
282
|
+
- `wizard.status`
|
|
283
|
+
|
|
284
|
+
Clients (macOS app and Control UI) can render steps without re-implementing onboarding logic.
|
|
285
|
+
|
|
286
|
+
Signal setup behavior:
|
|
287
|
+
|
|
288
|
+
- Downloads the appropriate release asset
|
|
289
|
+
- Stores it under `~/.quantumclaw/tools/signal-cli/<version>/`
|
|
290
|
+
- Writes `channels.signal.cliPath` in config
|
|
291
|
+
- JVM builds require Java 21
|
|
292
|
+
- Native builds are used when available
|
|
293
|
+
- Windows uses WSL2 and follows Linux signal-cli flow inside WSL
|
|
294
|
+
|
|
295
|
+
## Related docs
|
|
296
|
+
|
|
297
|
+
- Onboarding hub: [Onboarding (CLI)](/start/wizard)
|
|
298
|
+
- Automation and scripts: [CLI Automation](/start/wizard-cli-automation)
|
|
299
|
+
- Command reference: [`quantumclaw onboard`](/cli/onboard)
|
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "CLI onboarding: guided setup for gateway, workspace, channels, and skills"
|
|
3
|
+
read_when:
|
|
4
|
+
- Running or configuring CLI onboarding
|
|
5
|
+
- Setting up a new machine
|
|
6
|
+
title: "Onboarding (CLI)"
|
|
7
|
+
sidebarTitle: "Onboarding: CLI"
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# Onboarding (CLI)
|
|
11
|
+
|
|
12
|
+
CLI onboarding is the **recommended** way to set up QuantumClaw on macOS,
|
|
13
|
+
Linux, or Windows (via WSL2; strongly recommended).
|
|
14
|
+
It configures a local Gateway or a remote Gateway connection, plus channels, skills,
|
|
15
|
+
and workspace defaults in one guided flow.
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
quantumclaw onboard
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
<Info>
|
|
22
|
+
Fastest first chat: open the Control UI (no channel setup needed). Run
|
|
23
|
+
`quantumclaw dashboard` and chat in the browser. Docs: [Dashboard](/web/dashboard).
|
|
24
|
+
</Info>
|
|
25
|
+
|
|
26
|
+
To reconfigure later:
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
quantumclaw configure
|
|
30
|
+
quantumclaw agents add <name>
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
<Note>
|
|
34
|
+
`--json` does not imply non-interactive mode. For scripts, use `--non-interactive`.
|
|
35
|
+
</Note>
|
|
36
|
+
|
|
37
|
+
<Tip>
|
|
38
|
+
CLI onboarding includes a web search step where you can pick a provider
|
|
39
|
+
(Perplexity, Brave, Gemini, Grok, or Kimi) and paste your API key so the agent
|
|
40
|
+
can use `web_search`. You can also configure this later with
|
|
41
|
+
`quantumclaw configure --section web`. Docs: [Web tools](/tools/web).
|
|
42
|
+
</Tip>
|
|
43
|
+
|
|
44
|
+
## QuickStart vs Advanced
|
|
45
|
+
|
|
46
|
+
Onboarding starts with **QuickStart** (defaults) vs **Advanced** (full control).
|
|
47
|
+
|
|
48
|
+
<Tabs>
|
|
49
|
+
<Tab title="QuickStart (defaults)">
|
|
50
|
+
- Local gateway (loopback)
|
|
51
|
+
- Workspace default (or existing workspace)
|
|
52
|
+
- Gateway port **18789**
|
|
53
|
+
- Gateway auth **Token** (auto‑generated, even on loopback)
|
|
54
|
+
- Tool policy default for new local setups: `tools.profile: "coding"` (existing explicit profile is preserved)
|
|
55
|
+
- DM isolation default: local onboarding writes `session.dmScope: "per-channel-peer"` when unset. Details: [CLI Setup Reference](/start/wizard-cli-reference#outputs-and-internals)
|
|
56
|
+
- Tailscale exposure **Off**
|
|
57
|
+
- Telegram + WhatsApp DMs default to **allowlist** (you'll be prompted for your phone number)
|
|
58
|
+
</Tab>
|
|
59
|
+
<Tab title="Advanced (full control)">
|
|
60
|
+
- Exposes every step (mode, workspace, gateway, channels, daemon, skills).
|
|
61
|
+
</Tab>
|
|
62
|
+
</Tabs>
|
|
63
|
+
|
|
64
|
+
## What onboarding configures
|
|
65
|
+
|
|
66
|
+
**Local mode (default)** walks you through these steps:
|
|
67
|
+
|
|
68
|
+
1. **Model/Auth** — choose any supported provider/auth flow (API key, OAuth, or setup-token), including Custom Provider
|
|
69
|
+
(OpenAI-compatible, Anthropic-compatible, or Unknown auto-detect). Pick a default model.
|
|
70
|
+
Security note: if this agent will run tools or process webhook/hooks content, prefer the strongest latest-generation model available and keep tool policy strict. Weaker/older tiers are easier to prompt-inject.
|
|
71
|
+
For non-interactive runs, `--secret-input-mode ref` stores env-backed refs in auth profiles instead of plaintext API key values.
|
|
72
|
+
In non-interactive `ref` mode, the provider env var must be set; passing inline key flags without that env var fails fast.
|
|
73
|
+
In interactive runs, choosing secret reference mode lets you point at either an environment variable or a configured provider ref (`file` or `exec`), with a fast preflight validation before saving.
|
|
74
|
+
2. **Workspace** — Location for agent files (default `~/.quantumclaw/workspace`). Seeds bootstrap files.
|
|
75
|
+
3. **Gateway** — Port, bind address, auth mode, Tailscale exposure.
|
|
76
|
+
In interactive token mode, choose default plaintext token storage or opt into SecretRef.
|
|
77
|
+
Non-interactive token SecretRef path: `--gateway-token-ref-env <ENV_VAR>`.
|
|
78
|
+
4. **Channels** — WhatsApp, Telegram, Discord, Google Chat, Mattermost, Signal, BlueBubbles, or iMessage.
|
|
79
|
+
5. **Daemon** — Installs a LaunchAgent (macOS) or systemd user unit (Linux/WSL2).
|
|
80
|
+
If token auth requires a token and `gateway.auth.token` is SecretRef-managed, daemon install validates it but does not persist the resolved token into supervisor service environment metadata.
|
|
81
|
+
If token auth requires a token and the configured token SecretRef is unresolved, daemon install is blocked with actionable guidance.
|
|
82
|
+
If both `gateway.auth.token` and `gateway.auth.password` are configured and `gateway.auth.mode` is unset, daemon install is blocked until mode is set explicitly.
|
|
83
|
+
6. **Health check** — Starts the Gateway and verifies it's running.
|
|
84
|
+
7. **Skills** — Installs recommended skills and optional dependencies.
|
|
85
|
+
|
|
86
|
+
<Note>
|
|
87
|
+
Re-running onboarding does **not** wipe anything unless you explicitly choose **Reset** (or pass `--reset`).
|
|
88
|
+
CLI `--reset` defaults to config, credentials, and sessions; use `--reset-scope full` to include workspace.
|
|
89
|
+
If the config is invalid or contains legacy keys, onboarding asks you to run `quantumclaw doctor` first.
|
|
90
|
+
</Note>
|
|
91
|
+
|
|
92
|
+
**Remote mode** only configures the local client to connect to a Gateway elsewhere.
|
|
93
|
+
It does **not** install or change anything on the remote host.
|
|
94
|
+
|
|
95
|
+
## Add another agent
|
|
96
|
+
|
|
97
|
+
Use `quantumclaw agents add <name>` to create a separate agent with its own workspace,
|
|
98
|
+
sessions, and auth profiles. Running without `--workspace` launches onboarding.
|
|
99
|
+
|
|
100
|
+
What it sets:
|
|
101
|
+
|
|
102
|
+
- `agents.list[].name`
|
|
103
|
+
- `agents.list[].workspace`
|
|
104
|
+
- `agents.list[].agentDir`
|
|
105
|
+
|
|
106
|
+
Notes:
|
|
107
|
+
|
|
108
|
+
- Default workspaces follow `~/.quantumclaw/workspace-<agentId>`.
|
|
109
|
+
- Add `bindings` to route inbound messages (onboarding can do this).
|
|
110
|
+
- Non-interactive flags: `--model`, `--agent-dir`, `--bind`, `--non-interactive`.
|
|
111
|
+
|
|
112
|
+
## Full reference
|
|
113
|
+
|
|
114
|
+
For detailed step-by-step breakdowns and config outputs, see
|
|
115
|
+
[CLI Setup Reference](/start/wizard-cli-reference).
|
|
116
|
+
For non-interactive examples, see [CLI Automation](/start/wizard-cli-automation).
|
|
117
|
+
For the deeper technical reference, including RPC details, see
|
|
118
|
+
[Onboarding Reference](/reference/wizard).
|
|
119
|
+
|
|
120
|
+
## Related docs
|
|
121
|
+
|
|
122
|
+
- CLI command reference: [`quantumclaw onboard`](/cli/onboard)
|
|
123
|
+
- Onboarding overview: [Onboarding Overview](/start/onboarding-overview)
|
|
124
|
+
- macOS app onboarding: [Onboarding](/start/onboarding)
|
|
125
|
+
- Agent first-run ritual: [Agent Bootstrapping](/start/bootstrapping)
|
package/docs/style.css
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
#content > h1:first-of-type {
|
|
2
|
+
display: none !important;
|
|
3
|
+
}
|
|
4
|
+
|
|
5
|
+
.nav-tabs {
|
|
6
|
+
position: relative;
|
|
7
|
+
}
|
|
8
|
+
|
|
9
|
+
.nav-tabs-item > div {
|
|
10
|
+
opacity: 0;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
.nav-tabs-underline {
|
|
14
|
+
position: absolute;
|
|
15
|
+
left: 0;
|
|
16
|
+
bottom: 0;
|
|
17
|
+
height: 1.5px;
|
|
18
|
+
width: var(--nav-tab-underline-width, 0);
|
|
19
|
+
transform: translateX(var(--nav-tab-underline-x, 0));
|
|
20
|
+
background-color: rgb(var(--primary));
|
|
21
|
+
border-radius: 999px;
|
|
22
|
+
pointer-events: none;
|
|
23
|
+
opacity: 0;
|
|
24
|
+
transition:
|
|
25
|
+
transform 260ms ease-in-out,
|
|
26
|
+
width 260ms ease-in-out,
|
|
27
|
+
opacity 160ms ease-in-out;
|
|
28
|
+
will-change: transform, width;
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
html.dark .nav-tabs-underline {
|
|
32
|
+
background-color: rgb(var(--primary-light));
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
.nav-tabs-underline-ready .nav-tabs-underline {
|
|
36
|
+
opacity: 1;
|
|
37
|
+
}
|