@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,157 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "CLI reference for `quantumclaw onboard` (interactive onboarding)"
|
|
3
|
+
read_when:
|
|
4
|
+
- You want guided setup for gateway, workspace, auth, channels, and skills
|
|
5
|
+
title: "onboard"
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# `quantumclaw onboard`
|
|
9
|
+
|
|
10
|
+
Interactive onboarding for local or remote Gateway setup.
|
|
11
|
+
|
|
12
|
+
## Related guides
|
|
13
|
+
|
|
14
|
+
- CLI onboarding hub: [Onboarding (CLI)](/start/wizard)
|
|
15
|
+
- Onboarding overview: [Onboarding Overview](/start/onboarding-overview)
|
|
16
|
+
- CLI onboarding reference: [CLI Setup Reference](/start/wizard-cli-reference)
|
|
17
|
+
- CLI automation: [CLI Automation](/start/wizard-cli-automation)
|
|
18
|
+
- macOS onboarding: [Onboarding (macOS App)](/start/onboarding)
|
|
19
|
+
|
|
20
|
+
## Examples
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
quantumclaw onboard
|
|
24
|
+
quantumclaw onboard --flow quickstart
|
|
25
|
+
quantumclaw onboard --flow manual
|
|
26
|
+
quantumclaw onboard --mode remote --remote-url wss://gateway-host:18789
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
For plaintext private-network `ws://` targets (trusted networks only), set
|
|
30
|
+
`QUANTUMCLAW_ALLOW_INSECURE_PRIVATE_WS=1` in the onboarding process environment.
|
|
31
|
+
|
|
32
|
+
Non-interactive custom provider:
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
quantumclaw onboard --non-interactive \
|
|
36
|
+
--auth-choice custom-api-key \
|
|
37
|
+
--custom-base-url "https://llm.example.com/v1" \
|
|
38
|
+
--custom-model-id "foo-large" \
|
|
39
|
+
--custom-api-key "$CUSTOM_API_KEY" \
|
|
40
|
+
--secret-input-mode plaintext \
|
|
41
|
+
--custom-compatibility openai
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
`--custom-api-key` is optional in non-interactive mode. If omitted, onboarding checks `CUSTOM_API_KEY`.
|
|
45
|
+
|
|
46
|
+
Non-interactive Ollama:
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
quantumclaw onboard --non-interactive \
|
|
50
|
+
--auth-choice ollama \
|
|
51
|
+
--custom-base-url "http://ollama-host:11434" \
|
|
52
|
+
--custom-model-id "qwen3.5:27b" \
|
|
53
|
+
--accept-risk
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
`--custom-base-url` defaults to `http://127.0.0.1:11434`. `--custom-model-id` is optional; if omitted, onboarding uses Ollama's suggested defaults. Cloud model IDs such as `kimi-k2.5:cloud` also work here.
|
|
57
|
+
|
|
58
|
+
Store provider keys as refs instead of plaintext:
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
quantumclaw onboard --non-interactive \
|
|
62
|
+
--auth-choice openai-api-key \
|
|
63
|
+
--secret-input-mode ref \
|
|
64
|
+
--accept-risk
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
With `--secret-input-mode ref`, onboarding writes env-backed refs instead of plaintext key values.
|
|
68
|
+
For auth-profile backed providers this writes `keyRef` entries; for custom providers this writes `models.providers.<id>.apiKey` as an env ref (for example `{ source: "env", provider: "default", id: "CUSTOM_API_KEY" }`).
|
|
69
|
+
|
|
70
|
+
Non-interactive `ref` mode contract:
|
|
71
|
+
|
|
72
|
+
- Set the provider env var in the onboarding process environment (for example `OPENAI_API_KEY`).
|
|
73
|
+
- Do not pass inline key flags (for example `--openai-api-key`) unless that env var is also set.
|
|
74
|
+
- If an inline key flag is passed without the required env var, onboarding fails fast with guidance.
|
|
75
|
+
|
|
76
|
+
Gateway token options in non-interactive mode:
|
|
77
|
+
|
|
78
|
+
- `--gateway-auth token --gateway-token <token>` stores a plaintext token.
|
|
79
|
+
- `--gateway-auth token --gateway-token-ref-env <name>` stores `gateway.auth.token` as an env SecretRef.
|
|
80
|
+
- `--gateway-token` and `--gateway-token-ref-env` are mutually exclusive.
|
|
81
|
+
- `--gateway-token-ref-env` requires a non-empty env var in the onboarding process environment.
|
|
82
|
+
- With `--install-daemon`, when token auth requires a token, SecretRef-managed gateway tokens are validated but not persisted as resolved plaintext in supervisor service environment metadata.
|
|
83
|
+
- With `--install-daemon`, if token mode requires a token and the configured token SecretRef is unresolved, onboarding fails closed with remediation guidance.
|
|
84
|
+
- With `--install-daemon`, if both `gateway.auth.token` and `gateway.auth.password` are configured and `gateway.auth.mode` is unset, onboarding blocks install until mode is set explicitly.
|
|
85
|
+
|
|
86
|
+
Example:
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
export QUANTUMCLAW_GATEWAY_TOKEN="your-token"
|
|
90
|
+
quantumclaw onboard --non-interactive \
|
|
91
|
+
--mode local \
|
|
92
|
+
--auth-choice skip \
|
|
93
|
+
--gateway-auth token \
|
|
94
|
+
--gateway-token-ref-env QUANTUMCLAW_GATEWAY_TOKEN \
|
|
95
|
+
--accept-risk
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
Non-interactive local gateway health:
|
|
99
|
+
|
|
100
|
+
- Unless you pass `--skip-health`, onboarding waits for a reachable local gateway before it exits successfully.
|
|
101
|
+
- `--install-daemon` starts the managed gateway install path first. Without it, you must already have a local gateway running, for example `quantumclaw gateway run`.
|
|
102
|
+
- If you only want config/workspace/bootstrap writes in automation, use `--skip-health`.
|
|
103
|
+
- On native Windows, `--install-daemon` tries Scheduled Tasks first and falls back to a per-user Startup-folder login item if task creation is denied.
|
|
104
|
+
|
|
105
|
+
Interactive onboarding behavior with reference mode:
|
|
106
|
+
|
|
107
|
+
- Choose **Use secret reference** when prompted.
|
|
108
|
+
- Then choose either:
|
|
109
|
+
- Environment variable
|
|
110
|
+
- Configured secret provider (`file` or `exec`)
|
|
111
|
+
- Onboarding performs a fast preflight validation before saving the ref.
|
|
112
|
+
- If validation fails, onboarding shows the error and lets you retry.
|
|
113
|
+
|
|
114
|
+
Non-interactive Z.AI endpoint choices:
|
|
115
|
+
|
|
116
|
+
Note: `--auth-choice zai-api-key` now auto-detects the best Z.AI endpoint for your key (prefers the general API with `zai/glm-5`).
|
|
117
|
+
If you specifically want the GLM Coding Plan endpoints, pick `zai-coding-global` or `zai-coding-cn`.
|
|
118
|
+
|
|
119
|
+
```bash
|
|
120
|
+
# Promptless endpoint selection
|
|
121
|
+
quantumclaw onboard --non-interactive \
|
|
122
|
+
--auth-choice zai-coding-global \
|
|
123
|
+
--zai-api-key "$ZAI_API_KEY"
|
|
124
|
+
|
|
125
|
+
# Other Z.AI endpoint choices:
|
|
126
|
+
# --auth-choice zai-coding-cn
|
|
127
|
+
# --auth-choice zai-global
|
|
128
|
+
# --auth-choice zai-cn
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
Non-interactive Mistral example:
|
|
132
|
+
|
|
133
|
+
```bash
|
|
134
|
+
quantumclaw onboard --non-interactive \
|
|
135
|
+
--auth-choice mistral-api-key \
|
|
136
|
+
--mistral-api-key "$MISTRAL_API_KEY"
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
Flow notes:
|
|
140
|
+
|
|
141
|
+
- `quickstart`: minimal prompts, auto-generates a gateway token.
|
|
142
|
+
- `manual`: full prompts for port/bind/auth (alias of `advanced`).
|
|
143
|
+
- Local onboarding DM scope behavior: [CLI Setup Reference](/start/wizard-cli-reference#outputs-and-internals).
|
|
144
|
+
- Fastest first chat: `quantumclaw dashboard` (Control UI, no channel setup).
|
|
145
|
+
- Custom Provider: connect any OpenAI or Anthropic compatible endpoint,
|
|
146
|
+
including hosted providers not listed. Use Unknown to auto-detect.
|
|
147
|
+
|
|
148
|
+
## Common follow-up commands
|
|
149
|
+
|
|
150
|
+
```bash
|
|
151
|
+
quantumclaw configure
|
|
152
|
+
quantumclaw agents add <name>
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
<Note>
|
|
156
|
+
`--json` does not imply non-interactive mode. Use `--non-interactive` for scripts.
|
|
157
|
+
</Note>
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "CLI reference for `quantumclaw pairing` (approve/list pairing requests)"
|
|
3
|
+
read_when:
|
|
4
|
+
- You’re using pairing-mode DMs and need to approve senders
|
|
5
|
+
title: "pairing"
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# `quantumclaw pairing`
|
|
9
|
+
|
|
10
|
+
Approve or inspect DM pairing requests (for channels that support pairing).
|
|
11
|
+
|
|
12
|
+
Related:
|
|
13
|
+
|
|
14
|
+
- Pairing flow: [Pairing](/channels/pairing)
|
|
15
|
+
|
|
16
|
+
## Commands
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
quantumclaw pairing list telegram
|
|
20
|
+
quantumclaw pairing list --channel telegram --account work
|
|
21
|
+
quantumclaw pairing list telegram --json
|
|
22
|
+
|
|
23
|
+
quantumclaw pairing approve telegram <code>
|
|
24
|
+
quantumclaw pairing approve --channel telegram --account work <code> --notify
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Notes
|
|
28
|
+
|
|
29
|
+
- Channel input: pass it positionally (`pairing list telegram`) or with `--channel <channel>`.
|
|
30
|
+
- `pairing list` supports `--account <accountId>` for multi-account channels.
|
|
31
|
+
- `pairing approve` supports `--account <accountId>` and `--notify`.
|
|
32
|
+
- If only one pairing-capable channel is configured, `pairing approve <code>` is allowed.
|
|
@@ -0,0 +1,210 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "CLI reference for `quantumclaw plugins` (list, install, marketplace, uninstall, enable/disable, doctor)"
|
|
3
|
+
read_when:
|
|
4
|
+
- You want to install or manage Gateway plugins or compatible bundles
|
|
5
|
+
- You want to debug plugin load failures
|
|
6
|
+
title: "plugins"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# `quantumclaw plugins`
|
|
10
|
+
|
|
11
|
+
Manage Gateway plugins/extensions, hook packs, and compatible bundles.
|
|
12
|
+
|
|
13
|
+
Related:
|
|
14
|
+
|
|
15
|
+
- Plugin system: [Plugins](/tools/plugin)
|
|
16
|
+
- Bundle compatibility: [Plugin bundles](/plugins/bundles)
|
|
17
|
+
- Plugin manifest + schema: [Plugin manifest](/plugins/manifest)
|
|
18
|
+
- Security hardening: [Security](/gateway/security)
|
|
19
|
+
|
|
20
|
+
## Commands
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
quantumclaw plugins list
|
|
24
|
+
quantumclaw plugins install <path-or-spec>
|
|
25
|
+
quantumclaw plugins inspect <id>
|
|
26
|
+
quantumclaw plugins enable <id>
|
|
27
|
+
quantumclaw plugins disable <id>
|
|
28
|
+
quantumclaw plugins uninstall <id>
|
|
29
|
+
quantumclaw plugins doctor
|
|
30
|
+
quantumclaw plugins update <id>
|
|
31
|
+
quantumclaw plugins update --all
|
|
32
|
+
quantumclaw plugins marketplace list <marketplace>
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Bundled plugins ship with QuantumClaw but start disabled. Use `plugins enable` to
|
|
36
|
+
activate them.
|
|
37
|
+
|
|
38
|
+
Native QuantumClaw plugins must ship `quantumclaw.plugin.json` with an inline JSON
|
|
39
|
+
Schema (`configSchema`, even if empty). Compatible bundles use their own bundle
|
|
40
|
+
manifests instead.
|
|
41
|
+
|
|
42
|
+
`plugins list` shows `Format: quantumclaw` or `Format: bundle`. Verbose list/info
|
|
43
|
+
output also shows the bundle subtype (`codex`, `claude`, or `cursor`) plus detected bundle
|
|
44
|
+
capabilities.
|
|
45
|
+
|
|
46
|
+
### Install
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
quantumclaw plugins install <path-or-spec>
|
|
50
|
+
quantumclaw plugins install <npm-spec> --pin
|
|
51
|
+
quantumclaw plugins install clawhub:<package>
|
|
52
|
+
quantumclaw plugins install <plugin>@<marketplace>
|
|
53
|
+
quantumclaw plugins install <plugin> --marketplace <marketplace>
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Security note: treat plugin installs like running code. Prefer pinned versions.
|
|
57
|
+
|
|
58
|
+
`plugins install` is also the install surface for hook packs that expose
|
|
59
|
+
`quantumclaw.hooks` in `package.json`. Use `quantumclaw hooks` for filtered hook
|
|
60
|
+
visibility and per-hook enablement, not package installation.
|
|
61
|
+
|
|
62
|
+
Npm specs are **registry-only** (package name + optional **exact version** or
|
|
63
|
+
**dist-tag**). Git/URL/file specs and semver ranges are rejected. Dependency
|
|
64
|
+
installs run with `--ignore-scripts` for safety.
|
|
65
|
+
|
|
66
|
+
Bare specs and `@latest` stay on the stable track. If npm resolves either of
|
|
67
|
+
those to a prerelease, QuantumClaw stops and asks you to opt in explicitly with a
|
|
68
|
+
prerelease tag such as `@beta`/`@rc` or an exact prerelease version such as
|
|
69
|
+
`@1.2.3-beta.4`.
|
|
70
|
+
|
|
71
|
+
If a bare install spec matches a bundled plugin id (for example `diffs`), QuantumClaw
|
|
72
|
+
installs the bundled plugin directly. To install an npm package with the same
|
|
73
|
+
name, use an explicit scoped spec (for example `@scope/diffs`).
|
|
74
|
+
|
|
75
|
+
Supported archives: `.zip`, `.tgz`, `.tar.gz`, `.tar`.
|
|
76
|
+
|
|
77
|
+
Claude marketplace installs are also supported.
|
|
78
|
+
|
|
79
|
+
ClawHub installs use an explicit `clawhub:<package>` locator:
|
|
80
|
+
|
|
81
|
+
```bash
|
|
82
|
+
quantumclaw plugins install clawhub:quantumclaw-codex-app-server
|
|
83
|
+
quantumclaw plugins install clawhub:quantumclaw-codex-app-server@1.2.3
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
QuantumClaw now also prefers ClawHub for bare npm-safe plugin specs. It only falls
|
|
87
|
+
back to npm if ClawHub does not have that package or version:
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
quantumclaw plugins install quantumclaw-codex-app-server
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
QuantumClaw downloads the package archive from ClawHub, checks the advertised
|
|
94
|
+
plugin API / minimum gateway compatibility, then installs it through the normal
|
|
95
|
+
archive path. Recorded installs keep their ClawHub source metadata for later
|
|
96
|
+
updates.
|
|
97
|
+
|
|
98
|
+
Use `plugin@marketplace` shorthand when the marketplace name exists in Claude's
|
|
99
|
+
local registry cache at `~/.claude/plugins/known_marketplaces.json`:
|
|
100
|
+
|
|
101
|
+
```bash
|
|
102
|
+
quantumclaw plugins marketplace list <marketplace-name>
|
|
103
|
+
quantumclaw plugins install <plugin-name>@<marketplace-name>
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
Use `--marketplace` when you want to pass the marketplace source explicitly:
|
|
107
|
+
|
|
108
|
+
```bash
|
|
109
|
+
quantumclaw plugins install <plugin-name> --marketplace <marketplace-name>
|
|
110
|
+
quantumclaw plugins install <plugin-name> --marketplace <owner/repo>
|
|
111
|
+
quantumclaw plugins install <plugin-name> --marketplace ./my-marketplace
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
Marketplace sources can be:
|
|
115
|
+
|
|
116
|
+
- a Claude known-marketplace name from `~/.claude/plugins/known_marketplaces.json`
|
|
117
|
+
- a local marketplace root or `marketplace.json` path
|
|
118
|
+
- a GitHub repo shorthand such as `owner/repo`
|
|
119
|
+
- a git URL
|
|
120
|
+
|
|
121
|
+
For local paths and archives, QuantumClaw auto-detects:
|
|
122
|
+
|
|
123
|
+
- native QuantumClaw plugins (`quantumclaw.plugin.json`)
|
|
124
|
+
- Codex-compatible bundles (`.codex-plugin/plugin.json`)
|
|
125
|
+
- Claude-compatible bundles (`.claude-plugin/plugin.json` or the default Claude
|
|
126
|
+
component layout)
|
|
127
|
+
- Cursor-compatible bundles (`.cursor-plugin/plugin.json`)
|
|
128
|
+
|
|
129
|
+
Compatible bundles install into the normal extensions root and participate in
|
|
130
|
+
the same list/info/enable/disable flow. Today, bundle skills, Claude
|
|
131
|
+
command-skills, Claude `settings.json` defaults, Cursor command-skills, and compatible Codex hook
|
|
132
|
+
directories are supported; other detected bundle capabilities are shown in
|
|
133
|
+
diagnostics/info but are not yet wired into runtime execution.
|
|
134
|
+
|
|
135
|
+
Use `--link` to avoid copying a local directory (adds to `plugins.load.paths`):
|
|
136
|
+
|
|
137
|
+
```bash
|
|
138
|
+
quantumclaw plugins install -l ./my-plugin
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
Use `--pin` on npm installs to save the resolved exact spec (`name@version`) in
|
|
142
|
+
`plugins.installs` while keeping the default behavior unpinned.
|
|
143
|
+
|
|
144
|
+
### Uninstall
|
|
145
|
+
|
|
146
|
+
```bash
|
|
147
|
+
quantumclaw plugins uninstall <id>
|
|
148
|
+
quantumclaw plugins uninstall <id> --dry-run
|
|
149
|
+
quantumclaw plugins uninstall <id> --keep-files
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
`uninstall` removes plugin records from `plugins.entries`, `plugins.installs`,
|
|
153
|
+
the plugin allowlist, and linked `plugins.load.paths` entries when applicable.
|
|
154
|
+
For active memory plugins, the memory slot resets to `memory-core`.
|
|
155
|
+
|
|
156
|
+
By default, uninstall also removes the plugin install directory under the active
|
|
157
|
+
state dir extensions root (`$QUANTUMCLAW_STATE_DIR/extensions/<id>`). Use
|
|
158
|
+
`--keep-files` to keep files on disk.
|
|
159
|
+
|
|
160
|
+
`--keep-config` is supported as a deprecated alias for `--keep-files`.
|
|
161
|
+
|
|
162
|
+
### Update
|
|
163
|
+
|
|
164
|
+
```bash
|
|
165
|
+
quantumclaw plugins update <id-or-npm-spec>
|
|
166
|
+
quantumclaw plugins update --all
|
|
167
|
+
quantumclaw plugins update <id-or-npm-spec> --dry-run
|
|
168
|
+
quantumclaw plugins update @quantumclaw/voice-call@beta
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
Updates apply to tracked installs in `plugins.installs` and tracked hook-pack
|
|
172
|
+
installs in `hooks.internal.installs`.
|
|
173
|
+
|
|
174
|
+
When you pass a plugin id, QuantumClaw reuses the recorded install spec for that
|
|
175
|
+
plugin. That means previously stored dist-tags such as `@beta` and exact pinned
|
|
176
|
+
versions continue to be used on later `update <id>` runs.
|
|
177
|
+
|
|
178
|
+
For npm installs, you can also pass an explicit npm package spec with a dist-tag
|
|
179
|
+
or exact version. QuantumClaw resolves that package name back to the tracked plugin
|
|
180
|
+
record, updates that installed plugin, and records the new npm spec for future
|
|
181
|
+
id-based updates.
|
|
182
|
+
|
|
183
|
+
When a stored integrity hash exists and the fetched artifact hash changes,
|
|
184
|
+
QuantumClaw prints a warning and asks for confirmation before proceeding. Use
|
|
185
|
+
global `--yes` to bypass prompts in CI/non-interactive runs.
|
|
186
|
+
|
|
187
|
+
### Inspect
|
|
188
|
+
|
|
189
|
+
```bash
|
|
190
|
+
quantumclaw plugins inspect <id>
|
|
191
|
+
quantumclaw plugins inspect <id> --json
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
Deep introspection for a single plugin. Shows identity, load status, source,
|
|
195
|
+
registered capabilities, hooks, tools, commands, services, gateway methods,
|
|
196
|
+
HTTP routes, policy flags, diagnostics, and install metadata.
|
|
197
|
+
|
|
198
|
+
Each plugin is classified by what it actually registers at runtime:
|
|
199
|
+
|
|
200
|
+
- **plain-capability** — one capability type (e.g. a provider-only plugin)
|
|
201
|
+
- **hybrid-capability** — multiple capability types (e.g. text + speech + images)
|
|
202
|
+
- **hook-only** — only hooks, no capabilities or surfaces
|
|
203
|
+
- **non-capability** — tools/commands/services but no capabilities
|
|
204
|
+
|
|
205
|
+
See [Plugin shapes](/plugins/architecture#plugin-shapes) for more on the capability model.
|
|
206
|
+
|
|
207
|
+
The `--json` flag outputs a machine-readable report suitable for scripting and
|
|
208
|
+
auditing.
|
|
209
|
+
|
|
210
|
+
`info` is an alias for `inspect`.
|
package/docs/cli/qr.md
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "CLI reference for `quantumclaw qr` (generate iOS pairing QR + setup code)"
|
|
3
|
+
read_when:
|
|
4
|
+
- You want to pair the iOS app with a gateway quickly
|
|
5
|
+
- You need setup-code output for remote/manual sharing
|
|
6
|
+
title: "qr"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# `quantumclaw qr`
|
|
10
|
+
|
|
11
|
+
Generate an iOS pairing QR and setup code from your current Gateway configuration.
|
|
12
|
+
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
quantumclaw qr
|
|
17
|
+
quantumclaw qr --setup-code-only
|
|
18
|
+
quantumclaw qr --json
|
|
19
|
+
quantumclaw qr --remote
|
|
20
|
+
quantumclaw qr --url wss://gateway.example/ws
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Options
|
|
24
|
+
|
|
25
|
+
- `--remote`: use `gateway.remote.url` plus remote token/password from config
|
|
26
|
+
- `--url <url>`: override gateway URL used in payload
|
|
27
|
+
- `--public-url <url>`: override public URL used in payload
|
|
28
|
+
- `--token <token>`: override which gateway token the bootstrap flow authenticates against
|
|
29
|
+
- `--password <password>`: override which gateway password the bootstrap flow authenticates against
|
|
30
|
+
- `--setup-code-only`: print only setup code
|
|
31
|
+
- `--no-ascii`: skip ASCII QR rendering
|
|
32
|
+
- `--json`: emit JSON (`setupCode`, `gatewayUrl`, `auth`, `urlSource`)
|
|
33
|
+
|
|
34
|
+
## Notes
|
|
35
|
+
|
|
36
|
+
- `--token` and `--password` are mutually exclusive.
|
|
37
|
+
- The setup code itself now carries an opaque short-lived `bootstrapToken`, not the shared gateway token/password.
|
|
38
|
+
- With `--remote`, if effectively active remote credentials are configured as SecretRefs and you do not pass `--token` or `--password`, the command resolves them from the active gateway snapshot. If gateway is unavailable, the command fails fast.
|
|
39
|
+
- Without `--remote`, local gateway auth SecretRefs are resolved when no CLI auth override is passed:
|
|
40
|
+
- `gateway.auth.token` resolves when token auth can win (explicit `gateway.auth.mode="token"` or inferred mode where no password source wins).
|
|
41
|
+
- `gateway.auth.password` resolves when password auth can win (explicit `gateway.auth.mode="password"` or inferred mode with no winning token from auth/env).
|
|
42
|
+
- If both `gateway.auth.token` and `gateway.auth.password` are configured (including SecretRefs) and `gateway.auth.mode` is unset, setup-code resolution fails until mode is set explicitly.
|
|
43
|
+
- Gateway version skew note: this command path requires a gateway that supports `secrets.resolve`; older gateways return an unknown-method error.
|
|
44
|
+
- After scanning, approve device pairing with:
|
|
45
|
+
- `quantumclaw devices list`
|
|
46
|
+
- `quantumclaw devices approve <requestId>`
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "CLI reference for `quantumclaw reset` (reset local state/config)"
|
|
3
|
+
read_when:
|
|
4
|
+
- You want to wipe local state while keeping the CLI installed
|
|
5
|
+
- You want a dry-run of what would be removed
|
|
6
|
+
title: "reset"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# `quantumclaw reset`
|
|
10
|
+
|
|
11
|
+
Reset local config/state (keeps the CLI installed).
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
quantumclaw backup create
|
|
15
|
+
quantumclaw reset
|
|
16
|
+
quantumclaw reset --dry-run
|
|
17
|
+
quantumclaw reset --scope config+creds+sessions --yes --non-interactive
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Run `quantumclaw backup create` first if you want a restorable snapshot before removing local state.
|
|
@@ -0,0 +1,197 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Sandbox CLI
|
|
3
|
+
summary: "Manage sandbox runtimes and inspect effective sandbox policy"
|
|
4
|
+
read_when: "You are managing sandbox runtimes or debugging sandbox/tool-policy behavior."
|
|
5
|
+
status: active
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Sandbox CLI
|
|
9
|
+
|
|
10
|
+
Manage sandbox runtimes for isolated agent execution.
|
|
11
|
+
|
|
12
|
+
## Overview
|
|
13
|
+
|
|
14
|
+
QuantumClaw can run agents in isolated sandbox runtimes for security. The `sandbox` commands help you inspect and recreate those runtimes after updates or configuration changes.
|
|
15
|
+
|
|
16
|
+
Today that usually means:
|
|
17
|
+
|
|
18
|
+
- Docker sandbox containers
|
|
19
|
+
- SSH sandbox runtimes when `agents.defaults.sandbox.backend = "ssh"`
|
|
20
|
+
- OpenShell sandbox runtimes when `agents.defaults.sandbox.backend = "openshell"`
|
|
21
|
+
|
|
22
|
+
For `ssh` and OpenShell `remote`, recreate matters more than with Docker:
|
|
23
|
+
|
|
24
|
+
- the remote workspace is canonical after the initial seed
|
|
25
|
+
- `quantumclaw sandbox recreate` deletes that canonical remote workspace for the selected scope
|
|
26
|
+
- next use seeds it again from the current local workspace
|
|
27
|
+
|
|
28
|
+
## Commands
|
|
29
|
+
|
|
30
|
+
### `quantumclaw sandbox explain`
|
|
31
|
+
|
|
32
|
+
Inspect the **effective** sandbox mode/scope/workspace access, sandbox tool policy, and elevated gates (with fix-it config key paths).
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
quantumclaw sandbox explain
|
|
36
|
+
quantumclaw sandbox explain --session agent:main:main
|
|
37
|
+
quantumclaw sandbox explain --agent work
|
|
38
|
+
quantumclaw sandbox explain --json
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### `quantumclaw sandbox list`
|
|
42
|
+
|
|
43
|
+
List all sandbox runtimes with their status and configuration.
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
quantumclaw sandbox list
|
|
47
|
+
quantumclaw sandbox list --browser # List only browser containers
|
|
48
|
+
quantumclaw sandbox list --json # JSON output
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
**Output includes:**
|
|
52
|
+
|
|
53
|
+
- Runtime name and status
|
|
54
|
+
- Backend (`docker`, `openshell`, etc.)
|
|
55
|
+
- Config label and whether it matches current config
|
|
56
|
+
- Age (time since creation)
|
|
57
|
+
- Idle time (time since last use)
|
|
58
|
+
- Associated session/agent
|
|
59
|
+
|
|
60
|
+
### `quantumclaw sandbox recreate`
|
|
61
|
+
|
|
62
|
+
Remove sandbox runtimes to force recreation with updated config.
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
quantumclaw sandbox recreate --all # Recreate all containers
|
|
66
|
+
quantumclaw sandbox recreate --session main # Specific session
|
|
67
|
+
quantumclaw sandbox recreate --agent mybot # Specific agent
|
|
68
|
+
quantumclaw sandbox recreate --browser # Only browser containers
|
|
69
|
+
quantumclaw sandbox recreate --all --force # Skip confirmation
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
**Options:**
|
|
73
|
+
|
|
74
|
+
- `--all`: Recreate all sandbox containers
|
|
75
|
+
- `--session <key>`: Recreate container for specific session
|
|
76
|
+
- `--agent <id>`: Recreate containers for specific agent
|
|
77
|
+
- `--browser`: Only recreate browser containers
|
|
78
|
+
- `--force`: Skip confirmation prompt
|
|
79
|
+
|
|
80
|
+
**Important:** Runtimes are automatically recreated when the agent is next used.
|
|
81
|
+
|
|
82
|
+
## Use Cases
|
|
83
|
+
|
|
84
|
+
### After updating a Docker image
|
|
85
|
+
|
|
86
|
+
```bash
|
|
87
|
+
# Pull new image
|
|
88
|
+
docker pull quantumclaw-sandbox:latest
|
|
89
|
+
docker tag quantumclaw-sandbox:latest quantumclaw-sandbox:bookworm-slim
|
|
90
|
+
|
|
91
|
+
# Update config to use new image
|
|
92
|
+
# Edit config: agents.defaults.sandbox.docker.image (or agents.list[].sandbox.docker.image)
|
|
93
|
+
|
|
94
|
+
# Recreate containers
|
|
95
|
+
quantumclaw sandbox recreate --all
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
### After changing sandbox configuration
|
|
99
|
+
|
|
100
|
+
```bash
|
|
101
|
+
# Edit config: agents.defaults.sandbox.* (or agents.list[].sandbox.*)
|
|
102
|
+
|
|
103
|
+
# Recreate to apply new config
|
|
104
|
+
quantumclaw sandbox recreate --all
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
### After changing SSH target or SSH auth material
|
|
108
|
+
|
|
109
|
+
```bash
|
|
110
|
+
# Edit config:
|
|
111
|
+
# - agents.defaults.sandbox.backend
|
|
112
|
+
# - agents.defaults.sandbox.ssh.target
|
|
113
|
+
# - agents.defaults.sandbox.ssh.workspaceRoot
|
|
114
|
+
# - agents.defaults.sandbox.ssh.identityFile / certificateFile / knownHostsFile
|
|
115
|
+
# - agents.defaults.sandbox.ssh.identityData / certificateData / knownHostsData
|
|
116
|
+
|
|
117
|
+
quantumclaw sandbox recreate --all
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
For the core `ssh` backend, recreate deletes the per-scope remote workspace root
|
|
121
|
+
on the SSH target. The next run seeds it again from the local workspace.
|
|
122
|
+
|
|
123
|
+
### After changing OpenShell source, policy, or mode
|
|
124
|
+
|
|
125
|
+
```bash
|
|
126
|
+
# Edit config:
|
|
127
|
+
# - agents.defaults.sandbox.backend
|
|
128
|
+
# - plugins.entries.openshell.config.from
|
|
129
|
+
# - plugins.entries.openshell.config.mode
|
|
130
|
+
# - plugins.entries.openshell.config.policy
|
|
131
|
+
|
|
132
|
+
quantumclaw sandbox recreate --all
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
For OpenShell `remote` mode, recreate deletes the canonical remote workspace
|
|
136
|
+
for that scope. The next run seeds it again from the local workspace.
|
|
137
|
+
|
|
138
|
+
### After changing setupCommand
|
|
139
|
+
|
|
140
|
+
```bash
|
|
141
|
+
quantumclaw sandbox recreate --all
|
|
142
|
+
# or just one agent:
|
|
143
|
+
quantumclaw sandbox recreate --agent family
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
### For a specific agent only
|
|
147
|
+
|
|
148
|
+
```bash
|
|
149
|
+
# Update only one agent's containers
|
|
150
|
+
quantumclaw sandbox recreate --agent alfred
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
## Why is this needed?
|
|
154
|
+
|
|
155
|
+
**Problem:** When you update sandbox configuration:
|
|
156
|
+
|
|
157
|
+
- Existing runtimes continue running with old settings
|
|
158
|
+
- Runtimes are only pruned after 24h of inactivity
|
|
159
|
+
- Regularly-used agents keep old runtimes alive indefinitely
|
|
160
|
+
|
|
161
|
+
**Solution:** Use `quantumclaw sandbox recreate` to force removal of old runtimes. They'll be recreated automatically with current settings when next needed.
|
|
162
|
+
|
|
163
|
+
Tip: prefer `quantumclaw sandbox recreate` over manual backend-specific cleanup.
|
|
164
|
+
It uses the Gateway’s runtime registry and avoids mismatches when scope/session keys change.
|
|
165
|
+
|
|
166
|
+
## Configuration
|
|
167
|
+
|
|
168
|
+
Sandbox settings live in `~/.quantumclaw/quantumclaw.json` under `agents.defaults.sandbox` (per-agent overrides go in `agents.list[].sandbox`):
|
|
169
|
+
|
|
170
|
+
```jsonc
|
|
171
|
+
{
|
|
172
|
+
"agents": {
|
|
173
|
+
"defaults": {
|
|
174
|
+
"sandbox": {
|
|
175
|
+
"mode": "all", // off, non-main, all
|
|
176
|
+
"backend": "docker", // docker, ssh, openshell
|
|
177
|
+
"scope": "agent", // session, agent, shared
|
|
178
|
+
"docker": {
|
|
179
|
+
"image": "quantumclaw-sandbox:bookworm-slim",
|
|
180
|
+
"containerPrefix": "quantumclaw-sbx-",
|
|
181
|
+
// ... more Docker options
|
|
182
|
+
},
|
|
183
|
+
"prune": {
|
|
184
|
+
"idleHours": 24, // Auto-prune after 24h idle
|
|
185
|
+
"maxAgeDays": 7, // Auto-prune after 7 days
|
|
186
|
+
},
|
|
187
|
+
},
|
|
188
|
+
},
|
|
189
|
+
},
|
|
190
|
+
}
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
## See Also
|
|
194
|
+
|
|
195
|
+
- [Sandbox Documentation](/gateway/sandboxing)
|
|
196
|
+
- [Agent Configuration](/concepts/agent-workspace)
|
|
197
|
+
- [Doctor Command](/gateway/doctor) - Check sandbox setup
|