@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,731 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "Integrated browser control service + action commands"
|
|
3
|
+
read_when:
|
|
4
|
+
- Adding agent-controlled browser automation
|
|
5
|
+
- Debugging why quantumclaw is interfering with your own Chrome
|
|
6
|
+
- Implementing browser settings + lifecycle in the macOS app
|
|
7
|
+
title: "Browser (QuantumClaw-managed)"
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# Browser (quantumclaw-managed)
|
|
11
|
+
|
|
12
|
+
QuantumClaw can run a **dedicated Chrome/Brave/Edge/Chromium profile** that the agent controls.
|
|
13
|
+
It is isolated from your personal browser and is managed through a small local
|
|
14
|
+
control service inside the Gateway (loopback only).
|
|
15
|
+
|
|
16
|
+
Beginner view:
|
|
17
|
+
|
|
18
|
+
- Think of it as a **separate, agent-only browser**.
|
|
19
|
+
- The `quantumclaw` profile does **not** touch your personal browser profile.
|
|
20
|
+
- The agent can **open tabs, read pages, click, and type** in a safe lane.
|
|
21
|
+
- The built-in `user` profile attaches to your real signed-in Chrome session via Chrome MCP.
|
|
22
|
+
|
|
23
|
+
## What you get
|
|
24
|
+
|
|
25
|
+
- A separate browser profile named **quantumclaw** (orange accent by default).
|
|
26
|
+
- Deterministic tab control (list/open/focus/close).
|
|
27
|
+
- Agent actions (click/type/drag/select), snapshots, screenshots, PDFs.
|
|
28
|
+
- Optional multi-profile support (`quantumclaw`, `work`, `remote`, ...).
|
|
29
|
+
|
|
30
|
+
This browser is **not** your daily driver. It is a safe, isolated surface for
|
|
31
|
+
agent automation and verification.
|
|
32
|
+
|
|
33
|
+
## Quick start
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
quantumclaw browser --browser-profile quantumclaw status
|
|
37
|
+
quantumclaw browser --browser-profile quantumclaw start
|
|
38
|
+
quantumclaw browser --browser-profile quantumclaw open https://example.com
|
|
39
|
+
quantumclaw browser --browser-profile quantumclaw snapshot
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
If you get “Browser disabled”, enable it in config (see below) and restart the
|
|
43
|
+
Gateway.
|
|
44
|
+
|
|
45
|
+
## Profiles: `quantumclaw` vs `user`
|
|
46
|
+
|
|
47
|
+
- `quantumclaw`: managed, isolated browser (no extension required).
|
|
48
|
+
- `user`: built-in Chrome MCP attach profile for your **real signed-in Chrome**
|
|
49
|
+
session.
|
|
50
|
+
|
|
51
|
+
For agent browser tool calls:
|
|
52
|
+
|
|
53
|
+
- Default: use the isolated `quantumclaw` browser.
|
|
54
|
+
- Prefer `profile="user"` when existing logged-in sessions matter and the user
|
|
55
|
+
is at the computer to click/approve any attach prompt.
|
|
56
|
+
- `profile` is the explicit override when you want a specific browser mode.
|
|
57
|
+
|
|
58
|
+
Set `browser.defaultProfile: "quantumclaw"` if you want managed mode by default.
|
|
59
|
+
|
|
60
|
+
## Configuration
|
|
61
|
+
|
|
62
|
+
Browser settings live in `~/.quantumclaw/quantumclaw.json`.
|
|
63
|
+
|
|
64
|
+
```json5
|
|
65
|
+
{
|
|
66
|
+
browser: {
|
|
67
|
+
enabled: true, // default: true
|
|
68
|
+
ssrfPolicy: {
|
|
69
|
+
dangerouslyAllowPrivateNetwork: true, // default trusted-network mode
|
|
70
|
+
// allowPrivateNetwork: true, // legacy alias
|
|
71
|
+
// hostnameAllowlist: ["*.example.com", "example.com"],
|
|
72
|
+
// allowedHostnames: ["localhost"],
|
|
73
|
+
},
|
|
74
|
+
// cdpUrl: "http://127.0.0.1:18792", // legacy single-profile override
|
|
75
|
+
remoteCdpTimeoutMs: 1500, // remote CDP HTTP timeout (ms)
|
|
76
|
+
remoteCdpHandshakeTimeoutMs: 3000, // remote CDP WebSocket handshake timeout (ms)
|
|
77
|
+
defaultProfile: "quantumclaw",
|
|
78
|
+
color: "#FF4500",
|
|
79
|
+
headless: false,
|
|
80
|
+
noSandbox: false,
|
|
81
|
+
attachOnly: false,
|
|
82
|
+
executablePath: "/Applications/Brave Browser.app/Contents/MacOS/Brave Browser",
|
|
83
|
+
profiles: {
|
|
84
|
+
quantumclaw: { cdpPort: 18800, color: "#FF4500" },
|
|
85
|
+
work: { cdpPort: 18801, color: "#0066CC" },
|
|
86
|
+
user: {
|
|
87
|
+
driver: "existing-session",
|
|
88
|
+
attachOnly: true,
|
|
89
|
+
color: "#00AA00",
|
|
90
|
+
},
|
|
91
|
+
brave: {
|
|
92
|
+
driver: "existing-session",
|
|
93
|
+
attachOnly: true,
|
|
94
|
+
userDataDir: "~/Library/Application Support/BraveSoftware/Brave-Browser",
|
|
95
|
+
color: "#FB542B",
|
|
96
|
+
},
|
|
97
|
+
remote: { cdpUrl: "http://10.0.0.42:9222", color: "#00AA00" },
|
|
98
|
+
},
|
|
99
|
+
},
|
|
100
|
+
}
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
Notes:
|
|
104
|
+
|
|
105
|
+
- The browser control service binds to loopback on a port derived from `gateway.port`
|
|
106
|
+
(default: `18791`, which is gateway + 2).
|
|
107
|
+
- If you override the Gateway port (`gateway.port` or `QUANTUMCLAW_GATEWAY_PORT`),
|
|
108
|
+
the derived browser ports shift to stay in the same “family”.
|
|
109
|
+
- `cdpUrl` defaults to the managed local CDP port when unset.
|
|
110
|
+
- `remoteCdpTimeoutMs` applies to remote (non-loopback) CDP reachability checks.
|
|
111
|
+
- `remoteCdpHandshakeTimeoutMs` applies to remote CDP WebSocket reachability checks.
|
|
112
|
+
- Browser navigation/open-tab is SSRF-guarded before navigation and best-effort re-checked on final `http(s)` URL after navigation.
|
|
113
|
+
- In strict SSRF mode, remote CDP endpoint discovery/probes (`cdpUrl`, including `/json/version` lookups) are checked too.
|
|
114
|
+
- `browser.ssrfPolicy.dangerouslyAllowPrivateNetwork` defaults to `true` (trusted-network model). Set it to `false` for strict public-only browsing.
|
|
115
|
+
- `browser.ssrfPolicy.allowPrivateNetwork` remains supported as a legacy alias for compatibility.
|
|
116
|
+
- `attachOnly: true` means “never launch a local browser; only attach if it is already running.”
|
|
117
|
+
- `color` + per-profile `color` tint the browser UI so you can see which profile is active.
|
|
118
|
+
- Default profile is `quantumclaw` (QuantumClaw-managed standalone browser). Use `defaultProfile: "user"` to opt into the signed-in user browser.
|
|
119
|
+
- Auto-detect order: system default browser if Chromium-based; otherwise Chrome → Brave → Edge → Chromium → Chrome Canary.
|
|
120
|
+
- Local `quantumclaw` profiles auto-assign `cdpPort`/`cdpUrl` — set those only for remote CDP.
|
|
121
|
+
- `driver: "existing-session"` uses Chrome DevTools MCP instead of raw CDP. Do
|
|
122
|
+
not set `cdpUrl` for that driver.
|
|
123
|
+
- Set `browser.profiles.<name>.userDataDir` when an existing-session profile
|
|
124
|
+
should attach to a non-default Chromium user profile such as Brave or Edge.
|
|
125
|
+
|
|
126
|
+
## Use Brave (or another Chromium-based browser)
|
|
127
|
+
|
|
128
|
+
If your **system default** browser is Chromium-based (Chrome/Brave/Edge/etc),
|
|
129
|
+
QuantumClaw uses it automatically. Set `browser.executablePath` to override
|
|
130
|
+
auto-detection:
|
|
131
|
+
|
|
132
|
+
CLI example:
|
|
133
|
+
|
|
134
|
+
```bash
|
|
135
|
+
quantumclaw config set browser.executablePath "/usr/bin/google-chrome"
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
```json5
|
|
139
|
+
// macOS
|
|
140
|
+
{
|
|
141
|
+
browser: {
|
|
142
|
+
executablePath: "/Applications/Brave Browser.app/Contents/MacOS/Brave Browser"
|
|
143
|
+
}
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
// Windows
|
|
147
|
+
{
|
|
148
|
+
browser: {
|
|
149
|
+
executablePath: "C:\\Program Files\\BraveSoftware\\Brave-Browser\\Application\\brave.exe"
|
|
150
|
+
}
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
// Linux
|
|
154
|
+
{
|
|
155
|
+
browser: {
|
|
156
|
+
executablePath: "/usr/bin/brave-browser"
|
|
157
|
+
}
|
|
158
|
+
}
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
## Local vs remote control
|
|
162
|
+
|
|
163
|
+
- **Local control (default):** the Gateway starts the loopback control service and can launch a local browser.
|
|
164
|
+
- **Remote control (node host):** run a node host on the machine that has the browser; the Gateway proxies browser actions to it.
|
|
165
|
+
- **Remote CDP:** set `browser.profiles.<name>.cdpUrl` (or `browser.cdpUrl`) to
|
|
166
|
+
attach to a remote Chromium-based browser. In this case, QuantumClaw will not launch a local browser.
|
|
167
|
+
|
|
168
|
+
Remote CDP URLs can include auth:
|
|
169
|
+
|
|
170
|
+
- Query tokens (e.g., `https://provider.example?token=<token>`)
|
|
171
|
+
- HTTP Basic auth (e.g., `https://user:pass@provider.example`)
|
|
172
|
+
|
|
173
|
+
QuantumClaw preserves the auth when calling `/json/*` endpoints and when connecting
|
|
174
|
+
to the CDP WebSocket. Prefer environment variables or secrets managers for
|
|
175
|
+
tokens instead of committing them to config files.
|
|
176
|
+
|
|
177
|
+
## Node browser proxy (zero-config default)
|
|
178
|
+
|
|
179
|
+
If you run a **node host** on the machine that has your browser, QuantumClaw can
|
|
180
|
+
auto-route browser tool calls to that node without any extra browser config.
|
|
181
|
+
This is the default path for remote gateways.
|
|
182
|
+
|
|
183
|
+
Notes:
|
|
184
|
+
|
|
185
|
+
- The node host exposes its local browser control server via a **proxy command**.
|
|
186
|
+
- Profiles come from the node’s own `browser.profiles` config (same as local).
|
|
187
|
+
- Disable if you don’t want it:
|
|
188
|
+
- On the node: `nodeHost.browserProxy.enabled=false`
|
|
189
|
+
- On the gateway: `gateway.nodes.browser.mode="off"`
|
|
190
|
+
|
|
191
|
+
## Browserless (hosted remote CDP)
|
|
192
|
+
|
|
193
|
+
[Browserless](https://browserless.io) is a hosted Chromium service that exposes
|
|
194
|
+
CDP endpoints over HTTPS. You can point an QuantumClaw browser profile at a
|
|
195
|
+
Browserless region endpoint and authenticate with your API key.
|
|
196
|
+
|
|
197
|
+
Example:
|
|
198
|
+
|
|
199
|
+
```json5
|
|
200
|
+
{
|
|
201
|
+
browser: {
|
|
202
|
+
enabled: true,
|
|
203
|
+
defaultProfile: "browserless",
|
|
204
|
+
remoteCdpTimeoutMs: 2000,
|
|
205
|
+
remoteCdpHandshakeTimeoutMs: 4000,
|
|
206
|
+
profiles: {
|
|
207
|
+
browserless: {
|
|
208
|
+
cdpUrl: "https://production-sfo.browserless.io?token=<BROWSERLESS_API_KEY>",
|
|
209
|
+
color: "#00AA00",
|
|
210
|
+
},
|
|
211
|
+
},
|
|
212
|
+
},
|
|
213
|
+
}
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
Notes:
|
|
217
|
+
|
|
218
|
+
- Replace `<BROWSERLESS_API_KEY>` with your real Browserless token.
|
|
219
|
+
- Choose the region endpoint that matches your Browserless account (see their docs).
|
|
220
|
+
|
|
221
|
+
## Direct WebSocket CDP providers
|
|
222
|
+
|
|
223
|
+
Some hosted browser services expose a **direct WebSocket** endpoint rather than
|
|
224
|
+
the standard HTTP-based CDP discovery (`/json/version`). QuantumClaw supports both:
|
|
225
|
+
|
|
226
|
+
- **HTTP(S) endpoints** (e.g. Browserless) — QuantumClaw calls `/json/version` to
|
|
227
|
+
discover the WebSocket debugger URL, then connects.
|
|
228
|
+
- **WebSocket endpoints** (`ws://` / `wss://`) — QuantumClaw connects directly,
|
|
229
|
+
skipping `/json/version`. Use this for services like
|
|
230
|
+
[Browserbase](https://www.browserbase.com) or any provider that hands you a
|
|
231
|
+
WebSocket URL.
|
|
232
|
+
|
|
233
|
+
### Browserbase
|
|
234
|
+
|
|
235
|
+
[Browserbase](https://www.browserbase.com) is a cloud platform for running
|
|
236
|
+
headless browsers with built-in CAPTCHA solving, stealth mode, and residential
|
|
237
|
+
proxies.
|
|
238
|
+
|
|
239
|
+
```json5
|
|
240
|
+
{
|
|
241
|
+
browser: {
|
|
242
|
+
enabled: true,
|
|
243
|
+
defaultProfile: "browserbase",
|
|
244
|
+
remoteCdpTimeoutMs: 3000,
|
|
245
|
+
remoteCdpHandshakeTimeoutMs: 5000,
|
|
246
|
+
profiles: {
|
|
247
|
+
browserbase: {
|
|
248
|
+
cdpUrl: "wss://connect.browserbase.com?apiKey=<BROWSERBASE_API_KEY>",
|
|
249
|
+
color: "#F97316",
|
|
250
|
+
},
|
|
251
|
+
},
|
|
252
|
+
},
|
|
253
|
+
}
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
Notes:
|
|
257
|
+
|
|
258
|
+
- [Sign up](https://www.browserbase.com/sign-up) and copy your **API Key**
|
|
259
|
+
from the [Overview dashboard](https://www.browserbase.com/overview).
|
|
260
|
+
- Replace `<BROWSERBASE_API_KEY>` with your real Browserbase API key.
|
|
261
|
+
- Browserbase auto-creates a browser session on WebSocket connect, so no
|
|
262
|
+
manual session creation step is needed.
|
|
263
|
+
- The free tier allows one concurrent session and one browser hour per month.
|
|
264
|
+
See [pricing](https://www.browserbase.com/pricing) for paid plan limits.
|
|
265
|
+
- See the [Browserbase docs](https://docs.browserbase.com) for full API
|
|
266
|
+
reference, SDK guides, and integration examples.
|
|
267
|
+
|
|
268
|
+
## Security
|
|
269
|
+
|
|
270
|
+
Key ideas:
|
|
271
|
+
|
|
272
|
+
- Browser control is loopback-only; access flows through the Gateway’s auth or node pairing.
|
|
273
|
+
- If browser control is enabled and no auth is configured, QuantumClaw auto-generates `gateway.auth.token` on startup and persists it to config.
|
|
274
|
+
- Keep the Gateway and any node hosts on a private network (Tailscale); avoid public exposure.
|
|
275
|
+
- Treat remote CDP URLs/tokens as secrets; prefer env vars or a secrets manager.
|
|
276
|
+
|
|
277
|
+
Remote CDP tips:
|
|
278
|
+
|
|
279
|
+
- Prefer encrypted endpoints (HTTPS or WSS) and short-lived tokens where possible.
|
|
280
|
+
- Avoid embedding long-lived tokens directly in config files.
|
|
281
|
+
|
|
282
|
+
## Profiles (multi-browser)
|
|
283
|
+
|
|
284
|
+
QuantumClaw supports multiple named profiles (routing configs). Profiles can be:
|
|
285
|
+
|
|
286
|
+
- **quantumclaw-managed**: a dedicated Chromium-based browser instance with its own user data directory + CDP port
|
|
287
|
+
- **remote**: an explicit CDP URL (Chromium-based browser running elsewhere)
|
|
288
|
+
- **existing session**: your existing Chrome profile via Chrome DevTools MCP auto-connect
|
|
289
|
+
|
|
290
|
+
Defaults:
|
|
291
|
+
|
|
292
|
+
- The `quantumclaw` profile is auto-created if missing.
|
|
293
|
+
- The `user` profile is built-in for Chrome MCP existing-session attach.
|
|
294
|
+
- Existing-session profiles are opt-in beyond `user`; create them with `--driver existing-session`.
|
|
295
|
+
- Local CDP ports allocate from **18800–18899** by default.
|
|
296
|
+
- Deleting a profile moves its local data directory to Trash.
|
|
297
|
+
|
|
298
|
+
All control endpoints accept `?profile=<name>`; the CLI uses `--browser-profile`.
|
|
299
|
+
|
|
300
|
+
## Existing-session via Chrome DevTools MCP
|
|
301
|
+
|
|
302
|
+
QuantumClaw can also attach to a running Chromium-based browser profile through the
|
|
303
|
+
official Chrome DevTools MCP server. This reuses the tabs and login state
|
|
304
|
+
already open in that browser profile.
|
|
305
|
+
|
|
306
|
+
Official background and setup references:
|
|
307
|
+
|
|
308
|
+
- [Chrome for Developers: Use Chrome DevTools MCP with your browser session](https://developer.chrome.com/blog/chrome-devtools-mcp-debug-your-browser-session)
|
|
309
|
+
- [Chrome DevTools MCP README](https://github.com/ChromeDevTools/chrome-devtools-mcp)
|
|
310
|
+
|
|
311
|
+
Built-in profile:
|
|
312
|
+
|
|
313
|
+
- `user`
|
|
314
|
+
|
|
315
|
+
Optional: create your own custom existing-session profile if you want a
|
|
316
|
+
different name, color, or browser data directory.
|
|
317
|
+
|
|
318
|
+
Default behavior:
|
|
319
|
+
|
|
320
|
+
- The built-in `user` profile uses Chrome MCP auto-connect, which targets the
|
|
321
|
+
default local Google Chrome profile.
|
|
322
|
+
|
|
323
|
+
Use `userDataDir` for Brave, Edge, Chromium, or a non-default Chrome profile:
|
|
324
|
+
|
|
325
|
+
```json5
|
|
326
|
+
{
|
|
327
|
+
browser: {
|
|
328
|
+
profiles: {
|
|
329
|
+
brave: {
|
|
330
|
+
driver: "existing-session",
|
|
331
|
+
attachOnly: true,
|
|
332
|
+
userDataDir: "~/Library/Application Support/BraveSoftware/Brave-Browser",
|
|
333
|
+
color: "#FB542B",
|
|
334
|
+
},
|
|
335
|
+
},
|
|
336
|
+
},
|
|
337
|
+
}
|
|
338
|
+
```
|
|
339
|
+
|
|
340
|
+
Then in the matching browser:
|
|
341
|
+
|
|
342
|
+
1. Open that browser's inspect page for remote debugging.
|
|
343
|
+
2. Enable remote debugging.
|
|
344
|
+
3. Keep the browser running and approve the connection prompt when QuantumClaw attaches.
|
|
345
|
+
|
|
346
|
+
Common inspect pages:
|
|
347
|
+
|
|
348
|
+
- Chrome: `chrome://inspect/#remote-debugging`
|
|
349
|
+
- Brave: `brave://inspect/#remote-debugging`
|
|
350
|
+
- Edge: `edge://inspect/#remote-debugging`
|
|
351
|
+
|
|
352
|
+
Live attach smoke test:
|
|
353
|
+
|
|
354
|
+
```bash
|
|
355
|
+
quantumclaw browser --browser-profile user start
|
|
356
|
+
quantumclaw browser --browser-profile user status
|
|
357
|
+
quantumclaw browser --browser-profile user tabs
|
|
358
|
+
quantumclaw browser --browser-profile user snapshot --format ai
|
|
359
|
+
```
|
|
360
|
+
|
|
361
|
+
What success looks like:
|
|
362
|
+
|
|
363
|
+
- `status` shows `driver: existing-session`
|
|
364
|
+
- `status` shows `transport: chrome-mcp`
|
|
365
|
+
- `status` shows `running: true`
|
|
366
|
+
- `tabs` lists your already-open browser tabs
|
|
367
|
+
- `snapshot` returns refs from the selected live tab
|
|
368
|
+
|
|
369
|
+
What to check if attach does not work:
|
|
370
|
+
|
|
371
|
+
- the target Chromium-based browser is version `144+`
|
|
372
|
+
- remote debugging is enabled in that browser's inspect page
|
|
373
|
+
- the browser showed and you accepted the attach consent prompt
|
|
374
|
+
- `quantumclaw doctor` migrates old extension-based browser config and checks that
|
|
375
|
+
Chrome is installed locally for default auto-connect profiles, but it cannot
|
|
376
|
+
enable browser-side remote debugging for you
|
|
377
|
+
|
|
378
|
+
Agent use:
|
|
379
|
+
|
|
380
|
+
- Use `profile="user"` when you need the user’s logged-in browser state.
|
|
381
|
+
- If you use a custom existing-session profile, pass that explicit profile name.
|
|
382
|
+
- Only choose this mode when the user is at the computer to approve the attach
|
|
383
|
+
prompt.
|
|
384
|
+
- the Gateway or node host can spawn `npx chrome-devtools-mcp@latest --autoConnect`
|
|
385
|
+
|
|
386
|
+
Notes:
|
|
387
|
+
|
|
388
|
+
- This path is higher-risk than the isolated `quantumclaw` profile because it can
|
|
389
|
+
act inside your signed-in browser session.
|
|
390
|
+
- QuantumClaw does not launch the browser for this driver; it attaches to an
|
|
391
|
+
existing session only.
|
|
392
|
+
- QuantumClaw uses the official Chrome DevTools MCP `--autoConnect` flow here. If
|
|
393
|
+
`userDataDir` is set, QuantumClaw passes it through to target that explicit
|
|
394
|
+
Chromium user data directory.
|
|
395
|
+
- Existing-session screenshots support page captures and `--ref` element
|
|
396
|
+
captures from snapshots, but not CSS `--element` selectors.
|
|
397
|
+
- Existing-session `wait --url` supports exact, substring, and glob patterns
|
|
398
|
+
like other browser drivers. `wait --load networkidle` is not supported yet.
|
|
399
|
+
- Some features still require the managed browser path, such as PDF export and
|
|
400
|
+
download interception.
|
|
401
|
+
- Existing-session is host-local. If Chrome lives on a different machine or a
|
|
402
|
+
different network namespace, use remote CDP or a node host instead.
|
|
403
|
+
|
|
404
|
+
## Isolation guarantees
|
|
405
|
+
|
|
406
|
+
- **Dedicated user data dir**: never touches your personal browser profile.
|
|
407
|
+
- **Dedicated ports**: avoids `9222` to prevent collisions with dev workflows.
|
|
408
|
+
- **Deterministic tab control**: target tabs by `targetId`, not “last tab”.
|
|
409
|
+
|
|
410
|
+
## Browser selection
|
|
411
|
+
|
|
412
|
+
When launching locally, QuantumClaw picks the first available:
|
|
413
|
+
|
|
414
|
+
1. Chrome
|
|
415
|
+
2. Brave
|
|
416
|
+
3. Edge
|
|
417
|
+
4. Chromium
|
|
418
|
+
5. Chrome Canary
|
|
419
|
+
|
|
420
|
+
You can override with `browser.executablePath`.
|
|
421
|
+
|
|
422
|
+
Platforms:
|
|
423
|
+
|
|
424
|
+
- macOS: checks `/Applications` and `~/Applications`.
|
|
425
|
+
- Linux: looks for `google-chrome`, `brave`, `microsoft-edge`, `chromium`, etc.
|
|
426
|
+
- Windows: checks common install locations.
|
|
427
|
+
|
|
428
|
+
## Control API (optional)
|
|
429
|
+
|
|
430
|
+
For local integrations only, the Gateway exposes a small loopback HTTP API:
|
|
431
|
+
|
|
432
|
+
- Status/start/stop: `GET /`, `POST /start`, `POST /stop`
|
|
433
|
+
- Tabs: `GET /tabs`, `POST /tabs/open`, `POST /tabs/focus`, `DELETE /tabs/:targetId`
|
|
434
|
+
- Snapshot/screenshot: `GET /snapshot`, `POST /screenshot`
|
|
435
|
+
- Actions: `POST /navigate`, `POST /act`
|
|
436
|
+
- Hooks: `POST /hooks/file-chooser`, `POST /hooks/dialog`
|
|
437
|
+
- Downloads: `POST /download`, `POST /wait/download`
|
|
438
|
+
- Debugging: `GET /console`, `POST /pdf`
|
|
439
|
+
- Debugging: `GET /errors`, `GET /requests`, `POST /trace/start`, `POST /trace/stop`, `POST /highlight`
|
|
440
|
+
- Network: `POST /response/body`
|
|
441
|
+
- State: `GET /cookies`, `POST /cookies/set`, `POST /cookies/clear`
|
|
442
|
+
- State: `GET /storage/:kind`, `POST /storage/:kind/set`, `POST /storage/:kind/clear`
|
|
443
|
+
- Settings: `POST /set/offline`, `POST /set/headers`, `POST /set/credentials`, `POST /set/geolocation`, `POST /set/media`, `POST /set/timezone`, `POST /set/locale`, `POST /set/device`
|
|
444
|
+
|
|
445
|
+
All endpoints accept `?profile=<name>`.
|
|
446
|
+
|
|
447
|
+
If gateway auth is configured, browser HTTP routes require auth too:
|
|
448
|
+
|
|
449
|
+
- `Authorization: Bearer <gateway token>`
|
|
450
|
+
- `x-quantumclaw-password: <gateway password>` or HTTP Basic auth with that password
|
|
451
|
+
|
|
452
|
+
### Playwright requirement
|
|
453
|
+
|
|
454
|
+
Some features (navigate/act/AI snapshot/role snapshot, element screenshots, PDF) require
|
|
455
|
+
Playwright. If Playwright isn’t installed, those endpoints return a clear 501
|
|
456
|
+
error. ARIA snapshots and basic screenshots still work for quantumclaw-managed Chrome.
|
|
457
|
+
|
|
458
|
+
If you see `Playwright is not available in this gateway build`, install the full
|
|
459
|
+
Playwright package (not `playwright-core`) and restart the gateway, or reinstall
|
|
460
|
+
QuantumClaw with browser support.
|
|
461
|
+
|
|
462
|
+
#### Docker Playwright install
|
|
463
|
+
|
|
464
|
+
If your Gateway runs in Docker, avoid `npx playwright` (npm override conflicts).
|
|
465
|
+
Use the bundled CLI instead:
|
|
466
|
+
|
|
467
|
+
```bash
|
|
468
|
+
docker compose run --rm quantumclaw-cli \
|
|
469
|
+
node /app/node_modules/playwright-core/cli.js install chromium
|
|
470
|
+
```
|
|
471
|
+
|
|
472
|
+
To persist browser downloads, set `PLAYWRIGHT_BROWSERS_PATH` (for example,
|
|
473
|
+
`/home/node/.cache/ms-playwright`) and make sure `/home/node` is persisted via
|
|
474
|
+
`QUANTUMCLAW_HOME_VOLUME` or a bind mount. See [Docker](/install/docker).
|
|
475
|
+
|
|
476
|
+
## How it works (internal)
|
|
477
|
+
|
|
478
|
+
High-level flow:
|
|
479
|
+
|
|
480
|
+
- A small **control server** accepts HTTP requests.
|
|
481
|
+
- It connects to Chromium-based browsers (Chrome/Brave/Edge/Chromium) via **CDP**.
|
|
482
|
+
- For advanced actions (click/type/snapshot/PDF), it uses **Playwright** on top
|
|
483
|
+
of CDP.
|
|
484
|
+
- When Playwright is missing, only non-Playwright operations are available.
|
|
485
|
+
|
|
486
|
+
This design keeps the agent on a stable, deterministic interface while letting
|
|
487
|
+
you swap local/remote browsers and profiles.
|
|
488
|
+
|
|
489
|
+
## CLI quick reference
|
|
490
|
+
|
|
491
|
+
All commands accept `--browser-profile <name>` to target a specific profile.
|
|
492
|
+
All commands also accept `--json` for machine-readable output (stable payloads).
|
|
493
|
+
|
|
494
|
+
Basics:
|
|
495
|
+
|
|
496
|
+
- `quantumclaw browser status`
|
|
497
|
+
- `quantumclaw browser start`
|
|
498
|
+
- `quantumclaw browser stop`
|
|
499
|
+
- `quantumclaw browser tabs`
|
|
500
|
+
- `quantumclaw browser tab`
|
|
501
|
+
- `quantumclaw browser tab new`
|
|
502
|
+
- `quantumclaw browser tab select 2`
|
|
503
|
+
- `quantumclaw browser tab close 2`
|
|
504
|
+
- `quantumclaw browser open https://example.com`
|
|
505
|
+
- `quantumclaw browser focus abcd1234`
|
|
506
|
+
- `quantumclaw browser close abcd1234`
|
|
507
|
+
|
|
508
|
+
Inspection:
|
|
509
|
+
|
|
510
|
+
- `quantumclaw browser screenshot`
|
|
511
|
+
- `quantumclaw browser screenshot --full-page`
|
|
512
|
+
- `quantumclaw browser screenshot --ref 12`
|
|
513
|
+
- `quantumclaw browser screenshot --ref e12`
|
|
514
|
+
- `quantumclaw browser snapshot`
|
|
515
|
+
- `quantumclaw browser snapshot --format aria --limit 200`
|
|
516
|
+
- `quantumclaw browser snapshot --interactive --compact --depth 6`
|
|
517
|
+
- `quantumclaw browser snapshot --efficient`
|
|
518
|
+
- `quantumclaw browser snapshot --labels`
|
|
519
|
+
- `quantumclaw browser snapshot --selector "#main" --interactive`
|
|
520
|
+
- `quantumclaw browser snapshot --frame "iframe#main" --interactive`
|
|
521
|
+
- `quantumclaw browser console --level error`
|
|
522
|
+
- `quantumclaw browser errors --clear`
|
|
523
|
+
- `quantumclaw browser requests --filter api --clear`
|
|
524
|
+
- `quantumclaw browser pdf`
|
|
525
|
+
- `quantumclaw browser responsebody "**/api" --max-chars 5000`
|
|
526
|
+
|
|
527
|
+
Actions:
|
|
528
|
+
|
|
529
|
+
- `quantumclaw browser navigate https://example.com`
|
|
530
|
+
- `quantumclaw browser resize 1280 720`
|
|
531
|
+
- `quantumclaw browser click 12 --double`
|
|
532
|
+
- `quantumclaw browser click e12 --double`
|
|
533
|
+
- `quantumclaw browser type 23 "hello" --submit`
|
|
534
|
+
- `quantumclaw browser press Enter`
|
|
535
|
+
- `quantumclaw browser hover 44`
|
|
536
|
+
- `quantumclaw browser scrollintoview e12`
|
|
537
|
+
- `quantumclaw browser drag 10 11`
|
|
538
|
+
- `quantumclaw browser select 9 OptionA OptionB`
|
|
539
|
+
- `quantumclaw browser download e12 report.pdf`
|
|
540
|
+
- `quantumclaw browser waitfordownload report.pdf`
|
|
541
|
+
- `quantumclaw browser upload /tmp/quantumclaw/uploads/file.pdf`
|
|
542
|
+
- `quantumclaw browser fill --fields '[{"ref":"1","type":"text","value":"Ada"}]'`
|
|
543
|
+
- `quantumclaw browser dialog --accept`
|
|
544
|
+
- `quantumclaw browser wait --text "Done"`
|
|
545
|
+
- `quantumclaw browser wait "#main" --url "**/dash" --load networkidle --fn "window.ready===true"`
|
|
546
|
+
- `quantumclaw browser evaluate --fn '(el) => el.textContent' --ref 7`
|
|
547
|
+
- `quantumclaw browser highlight e12`
|
|
548
|
+
- `quantumclaw browser trace start`
|
|
549
|
+
- `quantumclaw browser trace stop`
|
|
550
|
+
|
|
551
|
+
State:
|
|
552
|
+
|
|
553
|
+
- `quantumclaw browser cookies`
|
|
554
|
+
- `quantumclaw browser cookies set session abc123 --url "https://example.com"`
|
|
555
|
+
- `quantumclaw browser cookies clear`
|
|
556
|
+
- `quantumclaw browser storage local get`
|
|
557
|
+
- `quantumclaw browser storage local set theme dark`
|
|
558
|
+
- `quantumclaw browser storage session clear`
|
|
559
|
+
- `quantumclaw browser set offline on`
|
|
560
|
+
- `quantumclaw browser set headers --headers-json '{"X-Debug":"1"}'`
|
|
561
|
+
- `quantumclaw browser set credentials user pass`
|
|
562
|
+
- `quantumclaw browser set credentials --clear`
|
|
563
|
+
- `quantumclaw browser set geo 37.7749 -122.4194 --origin "https://example.com"`
|
|
564
|
+
- `quantumclaw browser set geo --clear`
|
|
565
|
+
- `quantumclaw browser set media dark`
|
|
566
|
+
- `quantumclaw browser set timezone America/New_York`
|
|
567
|
+
- `quantumclaw browser set locale en-US`
|
|
568
|
+
- `quantumclaw browser set device "iPhone 14"`
|
|
569
|
+
|
|
570
|
+
Notes:
|
|
571
|
+
|
|
572
|
+
- `upload` and `dialog` are **arming** calls; run them before the click/press
|
|
573
|
+
that triggers the chooser/dialog.
|
|
574
|
+
- Download and trace output paths are constrained to QuantumClaw temp roots:
|
|
575
|
+
- traces: `/tmp/quantumclaw` (fallback: `${os.tmpdir()}/quantumclaw`)
|
|
576
|
+
- downloads: `/tmp/quantumclaw/downloads` (fallback: `${os.tmpdir()}/quantumclaw/downloads`)
|
|
577
|
+
- Upload paths are constrained to an QuantumClaw temp uploads root:
|
|
578
|
+
- uploads: `/tmp/quantumclaw/uploads` (fallback: `${os.tmpdir()}/quantumclaw/uploads`)
|
|
579
|
+
- `upload` can also set file inputs directly via `--input-ref` or `--element`.
|
|
580
|
+
- `snapshot`:
|
|
581
|
+
- `--format ai` (default when Playwright is installed): returns an AI snapshot with numeric refs (`aria-ref="<n>"`).
|
|
582
|
+
- `--format aria`: returns the accessibility tree (no refs; inspection only).
|
|
583
|
+
- `--efficient` (or `--mode efficient`): compact role snapshot preset (interactive + compact + depth + lower maxChars).
|
|
584
|
+
- Config default (tool/CLI only): set `browser.snapshotDefaults.mode: "efficient"` to use efficient snapshots when the caller does not pass a mode (see [Gateway configuration](/gateway/configuration-reference#browser)).
|
|
585
|
+
- Role snapshot options (`--interactive`, `--compact`, `--depth`, `--selector`) force a role-based snapshot with refs like `ref=e12`.
|
|
586
|
+
- `--frame "<iframe selector>"` scopes role snapshots to an iframe (pairs with role refs like `e12`).
|
|
587
|
+
- `--interactive` outputs a flat, easy-to-pick list of interactive elements (best for driving actions).
|
|
588
|
+
- `--labels` adds a viewport-only screenshot with overlayed ref labels (prints `MEDIA:<path>`).
|
|
589
|
+
- `click`/`type`/etc require a `ref` from `snapshot` (either numeric `12` or role ref `e12`).
|
|
590
|
+
CSS selectors are intentionally not supported for actions.
|
|
591
|
+
|
|
592
|
+
## Snapshots and refs
|
|
593
|
+
|
|
594
|
+
QuantumClaw supports two “snapshot” styles:
|
|
595
|
+
|
|
596
|
+
- **AI snapshot (numeric refs)**: `quantumclaw browser snapshot` (default; `--format ai`)
|
|
597
|
+
- Output: a text snapshot that includes numeric refs.
|
|
598
|
+
- Actions: `quantumclaw browser click 12`, `quantumclaw browser type 23 "hello"`.
|
|
599
|
+
- Internally, the ref is resolved via Playwright’s `aria-ref`.
|
|
600
|
+
|
|
601
|
+
- **Role snapshot (role refs like `e12`)**: `quantumclaw browser snapshot --interactive` (or `--compact`, `--depth`, `--selector`, `--frame`)
|
|
602
|
+
- Output: a role-based list/tree with `[ref=e12]` (and optional `[nth=1]`).
|
|
603
|
+
- Actions: `quantumclaw browser click e12`, `quantumclaw browser highlight e12`.
|
|
604
|
+
- Internally, the ref is resolved via `getByRole(...)` (plus `nth()` for duplicates).
|
|
605
|
+
- Add `--labels` to include a viewport screenshot with overlayed `e12` labels.
|
|
606
|
+
|
|
607
|
+
Ref behavior:
|
|
608
|
+
|
|
609
|
+
- Refs are **not stable across navigations**; if something fails, re-run `snapshot` and use a fresh ref.
|
|
610
|
+
- If the role snapshot was taken with `--frame`, role refs are scoped to that iframe until the next role snapshot.
|
|
611
|
+
|
|
612
|
+
## Wait power-ups
|
|
613
|
+
|
|
614
|
+
You can wait on more than just time/text:
|
|
615
|
+
|
|
616
|
+
- Wait for URL (globs supported by Playwright):
|
|
617
|
+
- `quantumclaw browser wait --url "**/dash"`
|
|
618
|
+
- Wait for load state:
|
|
619
|
+
- `quantumclaw browser wait --load networkidle`
|
|
620
|
+
- Wait for a JS predicate:
|
|
621
|
+
- `quantumclaw browser wait --fn "window.ready===true"`
|
|
622
|
+
- Wait for a selector to become visible:
|
|
623
|
+
- `quantumclaw browser wait "#main"`
|
|
624
|
+
|
|
625
|
+
These can be combined:
|
|
626
|
+
|
|
627
|
+
```bash
|
|
628
|
+
quantumclaw browser wait "#main" \
|
|
629
|
+
--url "**/dash" \
|
|
630
|
+
--load networkidle \
|
|
631
|
+
--fn "window.ready===true" \
|
|
632
|
+
--timeout-ms 15000
|
|
633
|
+
```
|
|
634
|
+
|
|
635
|
+
## Debug workflows
|
|
636
|
+
|
|
637
|
+
When an action fails (e.g. “not visible”, “strict mode violation”, “covered”):
|
|
638
|
+
|
|
639
|
+
1. `quantumclaw browser snapshot --interactive`
|
|
640
|
+
2. Use `click <ref>` / `type <ref>` (prefer role refs in interactive mode)
|
|
641
|
+
3. If it still fails: `quantumclaw browser highlight <ref>` to see what Playwright is targeting
|
|
642
|
+
4. If the page behaves oddly:
|
|
643
|
+
- `quantumclaw browser errors --clear`
|
|
644
|
+
- `quantumclaw browser requests --filter api --clear`
|
|
645
|
+
5. For deep debugging: record a trace:
|
|
646
|
+
- `quantumclaw browser trace start`
|
|
647
|
+
- reproduce the issue
|
|
648
|
+
- `quantumclaw browser trace stop` (prints `TRACE:<path>`)
|
|
649
|
+
|
|
650
|
+
## JSON output
|
|
651
|
+
|
|
652
|
+
`--json` is for scripting and structured tooling.
|
|
653
|
+
|
|
654
|
+
Examples:
|
|
655
|
+
|
|
656
|
+
```bash
|
|
657
|
+
quantumclaw browser status --json
|
|
658
|
+
quantumclaw browser snapshot --interactive --json
|
|
659
|
+
quantumclaw browser requests --filter api --json
|
|
660
|
+
quantumclaw browser cookies --json
|
|
661
|
+
```
|
|
662
|
+
|
|
663
|
+
Role snapshots in JSON include `refs` plus a small `stats` block (lines/chars/refs/interactive) so tools can reason about payload size and density.
|
|
664
|
+
|
|
665
|
+
## State and environment knobs
|
|
666
|
+
|
|
667
|
+
These are useful for “make the site behave like X” workflows:
|
|
668
|
+
|
|
669
|
+
- Cookies: `cookies`, `cookies set`, `cookies clear`
|
|
670
|
+
- Storage: `storage local|session get|set|clear`
|
|
671
|
+
- Offline: `set offline on|off`
|
|
672
|
+
- Headers: `set headers --headers-json '{"X-Debug":"1"}'` (legacy `set headers --json '{"X-Debug":"1"}'` remains supported)
|
|
673
|
+
- HTTP basic auth: `set credentials user pass` (or `--clear`)
|
|
674
|
+
- Geolocation: `set geo <lat> <lon> --origin "https://example.com"` (or `--clear`)
|
|
675
|
+
- Media: `set media dark|light|no-preference|none`
|
|
676
|
+
- Timezone / locale: `set timezone ...`, `set locale ...`
|
|
677
|
+
- Device / viewport:
|
|
678
|
+
- `set device "iPhone 14"` (Playwright device presets)
|
|
679
|
+
- `set viewport 1280 720`
|
|
680
|
+
|
|
681
|
+
## Security & privacy
|
|
682
|
+
|
|
683
|
+
- The quantumclaw browser profile may contain logged-in sessions; treat it as sensitive.
|
|
684
|
+
- `browser act kind=evaluate` / `quantumclaw browser evaluate` and `wait --fn`
|
|
685
|
+
execute arbitrary JavaScript in the page context. Prompt injection can steer
|
|
686
|
+
this. Disable it with `browser.evaluateEnabled=false` if you do not need it.
|
|
687
|
+
- For logins and anti-bot notes (X/Twitter, etc.), see [Browser login + X/Twitter posting](/tools/browser-login).
|
|
688
|
+
- Keep the Gateway/node host private (loopback or tailnet-only).
|
|
689
|
+
- Remote CDP endpoints are powerful; tunnel and protect them.
|
|
690
|
+
|
|
691
|
+
Strict-mode example (block private/internal destinations by default):
|
|
692
|
+
|
|
693
|
+
```json5
|
|
694
|
+
{
|
|
695
|
+
browser: {
|
|
696
|
+
ssrfPolicy: {
|
|
697
|
+
dangerouslyAllowPrivateNetwork: false,
|
|
698
|
+
hostnameAllowlist: ["*.example.com", "example.com"],
|
|
699
|
+
allowedHostnames: ["localhost"], // optional exact allow
|
|
700
|
+
},
|
|
701
|
+
},
|
|
702
|
+
}
|
|
703
|
+
```
|
|
704
|
+
|
|
705
|
+
## Troubleshooting
|
|
706
|
+
|
|
707
|
+
For Linux-specific issues (especially snap Chromium), see
|
|
708
|
+
[Browser troubleshooting](/tools/browser-linux-troubleshooting).
|
|
709
|
+
|
|
710
|
+
For WSL2 Gateway + Windows Chrome split-host setups, see
|
|
711
|
+
[WSL2 + Windows + remote Chrome CDP troubleshooting](/tools/browser-wsl2-windows-remote-cdp-troubleshooting).
|
|
712
|
+
|
|
713
|
+
## Agent tools + how control works
|
|
714
|
+
|
|
715
|
+
The agent gets **one tool** for browser automation:
|
|
716
|
+
|
|
717
|
+
- `browser` — status/start/stop/tabs/open/focus/close/snapshot/screenshot/navigate/act
|
|
718
|
+
|
|
719
|
+
How it maps:
|
|
720
|
+
|
|
721
|
+
- `browser snapshot` returns a stable UI tree (AI or ARIA).
|
|
722
|
+
- `browser act` uses the snapshot `ref` IDs to click/type/drag/select.
|
|
723
|
+
- `browser screenshot` captures pixels (full page or element).
|
|
724
|
+
- `browser` accepts:
|
|
725
|
+
- `profile` to choose a named browser profile (quantumclaw, chrome, or remote CDP).
|
|
726
|
+
- `target` (`sandbox` | `host` | `node`) to select where the browser lives.
|
|
727
|
+
- In sandboxed sessions, `target: "host"` requires `agents.defaults.sandbox.browser.allowHostControl=true`.
|
|
728
|
+
- If `target` is omitted: sandboxed sessions default to `sandbox`, non-sandbox sessions default to `host`.
|
|
729
|
+
- If a browser-capable node is connected, the tool may auto-route to it unless you pin `target="host"` or `target="node"`.
|
|
730
|
+
|
|
731
|
+
This keeps the agent deterministic and avoids brittle selectors.
|