@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,103 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "CLI reference for `quantumclaw update` (safe-ish source update + gateway auto-restart)"
|
|
3
|
+
read_when:
|
|
4
|
+
- You want to update a source checkout safely
|
|
5
|
+
- You need to understand `--update` shorthand behavior
|
|
6
|
+
title: "update"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# `quantumclaw update`
|
|
10
|
+
|
|
11
|
+
Safely update QuantumClaw and switch between stable/beta/dev channels.
|
|
12
|
+
|
|
13
|
+
If you installed via **npm/pnpm** (global install, no git metadata), updates happen via the package manager flow in [Updating](/install/updating).
|
|
14
|
+
|
|
15
|
+
## Usage
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
quantumclaw update
|
|
19
|
+
quantumclaw update status
|
|
20
|
+
quantumclaw update wizard
|
|
21
|
+
quantumclaw update --channel beta
|
|
22
|
+
quantumclaw update --channel dev
|
|
23
|
+
quantumclaw update --tag beta
|
|
24
|
+
quantumclaw update --tag main
|
|
25
|
+
quantumclaw update --dry-run
|
|
26
|
+
quantumclaw update --no-restart
|
|
27
|
+
quantumclaw update --json
|
|
28
|
+
quantumclaw --update
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## Options
|
|
32
|
+
|
|
33
|
+
- `--no-restart`: skip restarting the Gateway service after a successful update.
|
|
34
|
+
- `--channel <stable|beta|dev>`: set the update channel (git + npm; persisted in config).
|
|
35
|
+
- `--tag <dist-tag|version|spec>`: override the package target for this update only. For package installs, `main` maps to `github:quantumclaw/quantumclaw#main`.
|
|
36
|
+
- `--dry-run`: preview planned update actions (channel/tag/target/restart flow) without writing config, installing, syncing plugins, or restarting.
|
|
37
|
+
- `--json`: print machine-readable `UpdateRunResult` JSON.
|
|
38
|
+
- `--timeout <seconds>`: per-step timeout (default is 1200s).
|
|
39
|
+
|
|
40
|
+
Note: downgrades require confirmation because older versions can break configuration.
|
|
41
|
+
|
|
42
|
+
## `update status`
|
|
43
|
+
|
|
44
|
+
Show the active update channel + git tag/branch/SHA (for source checkouts), plus update availability.
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
quantumclaw update status
|
|
48
|
+
quantumclaw update status --json
|
|
49
|
+
quantumclaw update status --timeout 10
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
Options:
|
|
53
|
+
|
|
54
|
+
- `--json`: print machine-readable status JSON.
|
|
55
|
+
- `--timeout <seconds>`: timeout for checks (default is 3s).
|
|
56
|
+
|
|
57
|
+
## `update wizard`
|
|
58
|
+
|
|
59
|
+
Interactive flow to pick an update channel and confirm whether to restart the Gateway
|
|
60
|
+
after updating (default is to restart). If you select `dev` without a git checkout, it
|
|
61
|
+
offers to create one.
|
|
62
|
+
|
|
63
|
+
## What it does
|
|
64
|
+
|
|
65
|
+
When you switch channels explicitly (`--channel ...`), QuantumClaw also keeps the
|
|
66
|
+
install method aligned:
|
|
67
|
+
|
|
68
|
+
- `dev` → ensures a git checkout (default: `~/quantumclaw`, override with `QUANTUMCLAW_GIT_DIR`),
|
|
69
|
+
updates it, and installs the global CLI from that checkout.
|
|
70
|
+
- `stable`/`beta` → installs from npm using the matching dist-tag.
|
|
71
|
+
|
|
72
|
+
The Gateway core auto-updater (when enabled via config) reuses this same update path.
|
|
73
|
+
|
|
74
|
+
## Git checkout flow
|
|
75
|
+
|
|
76
|
+
Channels:
|
|
77
|
+
|
|
78
|
+
- `stable`: checkout the latest non-beta tag, then build + doctor.
|
|
79
|
+
- `beta`: checkout the latest `-beta` tag, then build + doctor.
|
|
80
|
+
- `dev`: checkout `main`, then fetch + rebase.
|
|
81
|
+
|
|
82
|
+
High-level:
|
|
83
|
+
|
|
84
|
+
1. Requires a clean worktree (no uncommitted changes).
|
|
85
|
+
2. Switches to the selected channel (tag or branch).
|
|
86
|
+
3. Fetches upstream (dev only).
|
|
87
|
+
4. Dev only: preflight lint + TypeScript build in a temp worktree; if the tip fails, walks back up to 10 commits to find the newest clean build.
|
|
88
|
+
5. Rebases onto the selected commit (dev only).
|
|
89
|
+
6. Installs deps (pnpm preferred; npm fallback).
|
|
90
|
+
7. Builds + builds the Control UI.
|
|
91
|
+
8. Runs `quantumclaw doctor` as the final “safe update” check.
|
|
92
|
+
9. Syncs plugins to the active channel (dev uses bundled extensions; stable/beta uses npm) and updates npm-installed plugins.
|
|
93
|
+
|
|
94
|
+
## `--update` shorthand
|
|
95
|
+
|
|
96
|
+
`quantumclaw --update` rewrites to `quantumclaw update` (useful for shells and launcher scripts).
|
|
97
|
+
|
|
98
|
+
## See also
|
|
99
|
+
|
|
100
|
+
- `quantumclaw doctor` (offers to run update first on git checkouts)
|
|
101
|
+
- [Development channels](/install/development-channels)
|
|
102
|
+
- [Updating](/install/updating)
|
|
103
|
+
- [CLI reference](/cli)
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "CLI reference for `quantumclaw voicecall` (voice-call plugin command surface)"
|
|
3
|
+
read_when:
|
|
4
|
+
- You use the voice-call plugin and want the CLI entry points
|
|
5
|
+
- You want quick examples for `voicecall call|continue|status|tail|expose`
|
|
6
|
+
title: "voicecall"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# `quantumclaw voicecall`
|
|
10
|
+
|
|
11
|
+
`voicecall` is a plugin-provided command. It only appears if the voice-call plugin is installed and enabled.
|
|
12
|
+
|
|
13
|
+
Primary doc:
|
|
14
|
+
|
|
15
|
+
- Voice-call plugin: [Voice Call](/plugins/voice-call)
|
|
16
|
+
|
|
17
|
+
## Common commands
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
quantumclaw voicecall status --call-id <id>
|
|
21
|
+
quantumclaw voicecall call --to "+15555550123" --message "Hello" --mode notify
|
|
22
|
+
quantumclaw voicecall continue --call-id <id> --message "Any questions?"
|
|
23
|
+
quantumclaw voicecall end --call-id <id>
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Exposing webhooks (Tailscale)
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
quantumclaw voicecall expose --mode serve
|
|
30
|
+
quantumclaw voicecall expose --mode funnel
|
|
31
|
+
quantumclaw voicecall expose --mode off
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Security note: only expose the webhook endpoint to networks you trust. Prefer Tailscale Serve over Funnel when possible.
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "CLI reference for `quantumclaw webhooks` (webhook helpers + Gmail Pub/Sub)"
|
|
3
|
+
read_when:
|
|
4
|
+
- You want to wire Gmail Pub/Sub events into QuantumClaw
|
|
5
|
+
- You want webhook helper commands
|
|
6
|
+
title: "webhooks"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# `quantumclaw webhooks`
|
|
10
|
+
|
|
11
|
+
Webhook helpers and integrations (Gmail Pub/Sub, webhook helpers).
|
|
12
|
+
|
|
13
|
+
Related:
|
|
14
|
+
|
|
15
|
+
- Webhooks: [Webhook](/automation/webhook)
|
|
16
|
+
- Gmail Pub/Sub: [Gmail Pub/Sub](/automation/gmail-pubsub)
|
|
17
|
+
|
|
18
|
+
## Gmail
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
quantumclaw webhooks gmail setup --account you@example.com
|
|
22
|
+
quantumclaw webhooks gmail run
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
See [Gmail Pub/Sub documentation](/automation/gmail-pubsub) for details.
|
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "Agent loop lifecycle, streams, and wait semantics"
|
|
3
|
+
read_when:
|
|
4
|
+
- You need an exact walkthrough of the agent loop or lifecycle events
|
|
5
|
+
title: "Agent Loop"
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Agent Loop (QuantumClaw)
|
|
9
|
+
|
|
10
|
+
An agentic loop is the full “real” run of an agent: intake → context assembly → model inference →
|
|
11
|
+
tool execution → streaming replies → persistence. It’s the authoritative path that turns a message
|
|
12
|
+
into actions and a final reply, while keeping session state consistent.
|
|
13
|
+
|
|
14
|
+
In QuantumClaw, a loop is a single, serialized run per session that emits lifecycle and stream events
|
|
15
|
+
as the model thinks, calls tools, and streams output. This doc explains how that authentic loop is
|
|
16
|
+
wired end-to-end.
|
|
17
|
+
|
|
18
|
+
## Entry points
|
|
19
|
+
|
|
20
|
+
- Gateway RPC: `agent` and `agent.wait`.
|
|
21
|
+
- CLI: `agent` command.
|
|
22
|
+
|
|
23
|
+
## How it works (high-level)
|
|
24
|
+
|
|
25
|
+
1. `agent` RPC validates params, resolves session (sessionKey/sessionId), persists session metadata, returns `{ runId, acceptedAt }` immediately.
|
|
26
|
+
2. `agentCommand` runs the agent:
|
|
27
|
+
- resolves model + thinking/verbose defaults
|
|
28
|
+
- loads skills snapshot
|
|
29
|
+
- calls `runEmbeddedPiAgent` (pi-agent-core runtime)
|
|
30
|
+
- emits **lifecycle end/error** if the embedded loop does not emit one
|
|
31
|
+
3. `runEmbeddedPiAgent`:
|
|
32
|
+
- serializes runs via per-session + global queues
|
|
33
|
+
- resolves model + auth profile and builds the pi session
|
|
34
|
+
- subscribes to pi events and streams assistant/tool deltas
|
|
35
|
+
- enforces timeout -> aborts run if exceeded
|
|
36
|
+
- returns payloads + usage metadata
|
|
37
|
+
4. `subscribeEmbeddedPiSession` bridges pi-agent-core events to QuantumClaw `agent` stream:
|
|
38
|
+
- tool events => `stream: "tool"`
|
|
39
|
+
- assistant deltas => `stream: "assistant"`
|
|
40
|
+
- lifecycle events => `stream: "lifecycle"` (`phase: "start" | "end" | "error"`)
|
|
41
|
+
5. `agent.wait` uses `waitForAgentJob`:
|
|
42
|
+
- waits for **lifecycle end/error** for `runId`
|
|
43
|
+
- returns `{ status: ok|error|timeout, startedAt, endedAt, error? }`
|
|
44
|
+
|
|
45
|
+
## Queueing + concurrency
|
|
46
|
+
|
|
47
|
+
- Runs are serialized per session key (session lane) and optionally through a global lane.
|
|
48
|
+
- This prevents tool/session races and keeps session history consistent.
|
|
49
|
+
- Messaging channels can choose queue modes (collect/steer/followup) that feed this lane system.
|
|
50
|
+
See [Command Queue](/concepts/queue).
|
|
51
|
+
|
|
52
|
+
## Session + workspace preparation
|
|
53
|
+
|
|
54
|
+
- Workspace is resolved and created; sandboxed runs may redirect to a sandbox workspace root.
|
|
55
|
+
- Skills are loaded (or reused from a snapshot) and injected into env and prompt.
|
|
56
|
+
- Bootstrap/context files are resolved and injected into the system prompt report.
|
|
57
|
+
- A session write lock is acquired; `SessionManager` is opened and prepared before streaming.
|
|
58
|
+
|
|
59
|
+
## Prompt assembly + system prompt
|
|
60
|
+
|
|
61
|
+
- System prompt is built from QuantumClaw’s base prompt, skills prompt, bootstrap context, and per-run overrides.
|
|
62
|
+
- Model-specific limits and compaction reserve tokens are enforced.
|
|
63
|
+
- See [System prompt](/concepts/system-prompt) for what the model sees.
|
|
64
|
+
|
|
65
|
+
## Hook points (where you can intercept)
|
|
66
|
+
|
|
67
|
+
QuantumClaw has two hook systems:
|
|
68
|
+
|
|
69
|
+
- **Internal hooks** (Gateway hooks): event-driven scripts for commands and lifecycle events.
|
|
70
|
+
- **Plugin hooks**: extension points inside the agent/tool lifecycle and gateway pipeline.
|
|
71
|
+
|
|
72
|
+
### Internal hooks (Gateway hooks)
|
|
73
|
+
|
|
74
|
+
- **`agent:bootstrap`**: runs while building bootstrap files before the system prompt is finalized.
|
|
75
|
+
Use this to add/remove bootstrap context files.
|
|
76
|
+
- **Command hooks**: `/new`, `/reset`, `/stop`, and other command events (see Hooks doc).
|
|
77
|
+
|
|
78
|
+
See [Hooks](/automation/hooks) for setup and examples.
|
|
79
|
+
|
|
80
|
+
### Plugin hooks (agent + gateway lifecycle)
|
|
81
|
+
|
|
82
|
+
These run inside the agent loop or gateway pipeline:
|
|
83
|
+
|
|
84
|
+
- **`before_model_resolve`**: runs pre-session (no `messages`) to deterministically override provider/model before model resolution.
|
|
85
|
+
- **`before_prompt_build`**: runs after session load (with `messages`) to inject `prependContext`, `systemPrompt`, `prependSystemContext`, or `appendSystemContext` before prompt submission. Use `prependContext` for per-turn dynamic text and system-context fields for stable guidance that should sit in system prompt space.
|
|
86
|
+
- **`before_agent_start`**: legacy compatibility hook that may run in either phase; prefer the explicit hooks above.
|
|
87
|
+
- **`agent_end`**: inspect the final message list and run metadata after completion.
|
|
88
|
+
- **`before_compaction` / `after_compaction`**: observe or annotate compaction cycles.
|
|
89
|
+
- **`before_tool_call` / `after_tool_call`**: intercept tool params/results.
|
|
90
|
+
- **`tool_result_persist`**: synchronously transform tool results before they are written to the session transcript.
|
|
91
|
+
- **`message_received` / `message_sending` / `message_sent`**: inbound + outbound message hooks.
|
|
92
|
+
- **`session_start` / `session_end`**: session lifecycle boundaries.
|
|
93
|
+
- **`gateway_start` / `gateway_stop`**: gateway lifecycle events.
|
|
94
|
+
|
|
95
|
+
See [Plugin hooks](/plugins/architecture#provider-runtime-hooks) for the hook API and registration details.
|
|
96
|
+
|
|
97
|
+
## Streaming + partial replies
|
|
98
|
+
|
|
99
|
+
- Assistant deltas are streamed from pi-agent-core and emitted as `assistant` events.
|
|
100
|
+
- Block streaming can emit partial replies either on `text_end` or `message_end`.
|
|
101
|
+
- Reasoning streaming can be emitted as a separate stream or as block replies.
|
|
102
|
+
- See [Streaming](/concepts/streaming) for chunking and block reply behavior.
|
|
103
|
+
|
|
104
|
+
## Tool execution + messaging tools
|
|
105
|
+
|
|
106
|
+
- Tool start/update/end events are emitted on the `tool` stream.
|
|
107
|
+
- Tool results are sanitized for size and image payloads before logging/emitting.
|
|
108
|
+
- Messaging tool sends are tracked to suppress duplicate assistant confirmations.
|
|
109
|
+
|
|
110
|
+
## Reply shaping + suppression
|
|
111
|
+
|
|
112
|
+
- Final payloads are assembled from:
|
|
113
|
+
- assistant text (and optional reasoning)
|
|
114
|
+
- inline tool summaries (when verbose + allowed)
|
|
115
|
+
- assistant error text when the model errors
|
|
116
|
+
- `NO_REPLY` is treated as a silent token and filtered from outgoing payloads.
|
|
117
|
+
- Messaging tool duplicates are removed from the final payload list.
|
|
118
|
+
- If no renderable payloads remain and a tool errored, a fallback tool error reply is emitted
|
|
119
|
+
(unless a messaging tool already sent a user-visible reply).
|
|
120
|
+
|
|
121
|
+
## Compaction + retries
|
|
122
|
+
|
|
123
|
+
- Auto-compaction emits `compaction` stream events and can trigger a retry.
|
|
124
|
+
- On retry, in-memory buffers and tool summaries are reset to avoid duplicate output.
|
|
125
|
+
- See [Compaction](/concepts/compaction) for the compaction pipeline.
|
|
126
|
+
|
|
127
|
+
## Event streams (today)
|
|
128
|
+
|
|
129
|
+
- `lifecycle`: emitted by `subscribeEmbeddedPiSession` (and as a fallback by `agentCommand`)
|
|
130
|
+
- `assistant`: streamed deltas from pi-agent-core
|
|
131
|
+
- `tool`: streamed tool events from pi-agent-core
|
|
132
|
+
|
|
133
|
+
## Chat channel handling
|
|
134
|
+
|
|
135
|
+
- Assistant deltas are buffered into chat `delta` messages.
|
|
136
|
+
- A chat `final` is emitted on **lifecycle end/error**.
|
|
137
|
+
|
|
138
|
+
## Timeouts
|
|
139
|
+
|
|
140
|
+
- `agent.wait` default: 30s (just the wait). `timeoutMs` param overrides.
|
|
141
|
+
- Agent runtime: `agents.defaults.timeoutSeconds` default 600s; enforced in `runEmbeddedPiAgent` abort timer.
|
|
142
|
+
|
|
143
|
+
## Where things can end early
|
|
144
|
+
|
|
145
|
+
- Agent timeout (abort)
|
|
146
|
+
- AbortSignal (cancel)
|
|
147
|
+
- Gateway disconnect or RPC timeout
|
|
148
|
+
- `agent.wait` timeout (wait-only, does not stop agent)
|
|
@@ -0,0 +1,236 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "Agent workspace: location, layout, and backup strategy"
|
|
3
|
+
read_when:
|
|
4
|
+
- You need to explain the agent workspace or its file layout
|
|
5
|
+
- You want to back up or migrate an agent workspace
|
|
6
|
+
title: "Agent Workspace"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# Agent workspace
|
|
10
|
+
|
|
11
|
+
The workspace is the agent's home. It is the only working directory used for
|
|
12
|
+
file tools and for workspace context. Keep it private and treat it as memory.
|
|
13
|
+
|
|
14
|
+
This is separate from `~/.quantumclaw/`, which stores config, credentials, and
|
|
15
|
+
sessions.
|
|
16
|
+
|
|
17
|
+
**Important:** the workspace is the **default cwd**, not a hard sandbox. Tools
|
|
18
|
+
resolve relative paths against the workspace, but absolute paths can still reach
|
|
19
|
+
elsewhere on the host unless sandboxing is enabled. If you need isolation, use
|
|
20
|
+
[`agents.defaults.sandbox`](/gateway/sandboxing) (and/or per‑agent sandbox config).
|
|
21
|
+
When sandboxing is enabled and `workspaceAccess` is not `"rw"`, tools operate
|
|
22
|
+
inside a sandbox workspace under `~/.quantumclaw/sandboxes`, not your host workspace.
|
|
23
|
+
|
|
24
|
+
## Default location
|
|
25
|
+
|
|
26
|
+
- Default: `~/.quantumclaw/workspace`
|
|
27
|
+
- If `QUANTUMCLAW_PROFILE` is set and not `"default"`, the default becomes
|
|
28
|
+
`~/.quantumclaw/workspace-<profile>`.
|
|
29
|
+
- Override in `~/.quantumclaw/quantumclaw.json`:
|
|
30
|
+
|
|
31
|
+
```json5
|
|
32
|
+
{
|
|
33
|
+
agent: {
|
|
34
|
+
workspace: "~/.quantumclaw/workspace",
|
|
35
|
+
},
|
|
36
|
+
}
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
`quantumclaw onboard`, `quantumclaw configure`, or `quantumclaw setup` will create the
|
|
40
|
+
workspace and seed the bootstrap files if they are missing.
|
|
41
|
+
Sandbox seed copies only accept regular in-workspace files; symlink/hardlink
|
|
42
|
+
aliases that resolve outside the source workspace are ignored.
|
|
43
|
+
|
|
44
|
+
If you already manage the workspace files yourself, you can disable bootstrap
|
|
45
|
+
file creation:
|
|
46
|
+
|
|
47
|
+
```json5
|
|
48
|
+
{ agent: { skipBootstrap: true } }
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## Extra workspace folders
|
|
52
|
+
|
|
53
|
+
Older installs may have created `~/quantumclaw`. Keeping multiple workspace
|
|
54
|
+
directories around can cause confusing auth or state drift, because only one
|
|
55
|
+
workspace is active at a time.
|
|
56
|
+
|
|
57
|
+
**Recommendation:** keep a single active workspace. If you no longer use the
|
|
58
|
+
extra folders, archive or move them to Trash (for example `trash ~/quantumclaw`).
|
|
59
|
+
If you intentionally keep multiple workspaces, make sure
|
|
60
|
+
`agents.defaults.workspace` points to the active one.
|
|
61
|
+
|
|
62
|
+
`quantumclaw doctor` warns when it detects extra workspace directories.
|
|
63
|
+
|
|
64
|
+
## Workspace file map (what each file means)
|
|
65
|
+
|
|
66
|
+
These are the standard files QuantumClaw expects inside the workspace:
|
|
67
|
+
|
|
68
|
+
- `AGENTS.md`
|
|
69
|
+
- Operating instructions for the agent and how it should use memory.
|
|
70
|
+
- Loaded at the start of every session.
|
|
71
|
+
- Good place for rules, priorities, and "how to behave" details.
|
|
72
|
+
|
|
73
|
+
- `SOUL.md`
|
|
74
|
+
- Persona, tone, and boundaries.
|
|
75
|
+
- Loaded every session.
|
|
76
|
+
|
|
77
|
+
- `USER.md`
|
|
78
|
+
- Who the user is and how to address them.
|
|
79
|
+
- Loaded every session.
|
|
80
|
+
|
|
81
|
+
- `IDENTITY.md`
|
|
82
|
+
- The agent's name, vibe, and emoji.
|
|
83
|
+
- Created/updated during the bootstrap ritual.
|
|
84
|
+
|
|
85
|
+
- `TOOLS.md`
|
|
86
|
+
- Notes about your local tools and conventions.
|
|
87
|
+
- Does not control tool availability; it is only guidance.
|
|
88
|
+
|
|
89
|
+
- `HEARTBEAT.md`
|
|
90
|
+
- Optional tiny checklist for heartbeat runs.
|
|
91
|
+
- Keep it short to avoid token burn.
|
|
92
|
+
|
|
93
|
+
- `BOOT.md`
|
|
94
|
+
- Optional startup checklist executed on gateway restart when internal hooks are enabled.
|
|
95
|
+
- Keep it short; use the message tool for outbound sends.
|
|
96
|
+
|
|
97
|
+
- `BOOTSTRAP.md`
|
|
98
|
+
- One-time first-run ritual.
|
|
99
|
+
- Only created for a brand-new workspace.
|
|
100
|
+
- Delete it after the ritual is complete.
|
|
101
|
+
|
|
102
|
+
- `memory/YYYY-MM-DD.md`
|
|
103
|
+
- Daily memory log (one file per day).
|
|
104
|
+
- Recommended to read today + yesterday on session start.
|
|
105
|
+
|
|
106
|
+
- `MEMORY.md` (optional)
|
|
107
|
+
- Curated long-term memory.
|
|
108
|
+
- Only load in the main, private session (not shared/group contexts).
|
|
109
|
+
|
|
110
|
+
See [Memory](/concepts/memory) for the workflow and automatic memory flush.
|
|
111
|
+
|
|
112
|
+
- `skills/` (optional)
|
|
113
|
+
- Workspace-specific skills.
|
|
114
|
+
- Overrides managed/bundled skills when names collide.
|
|
115
|
+
|
|
116
|
+
- `canvas/` (optional)
|
|
117
|
+
- Canvas UI files for node displays (for example `canvas/index.html`).
|
|
118
|
+
|
|
119
|
+
If any bootstrap file is missing, QuantumClaw injects a "missing file" marker into
|
|
120
|
+
the session and continues. Large bootstrap files are truncated when injected;
|
|
121
|
+
adjust limits with `agents.defaults.bootstrapMaxChars` (default: 20000) and
|
|
122
|
+
`agents.defaults.bootstrapTotalMaxChars` (default: 150000).
|
|
123
|
+
`quantumclaw setup` can recreate missing defaults without overwriting existing
|
|
124
|
+
files.
|
|
125
|
+
|
|
126
|
+
## What is NOT in the workspace
|
|
127
|
+
|
|
128
|
+
These live under `~/.quantumclaw/` and should NOT be committed to the workspace repo:
|
|
129
|
+
|
|
130
|
+
- `~/.quantumclaw/quantumclaw.json` (config)
|
|
131
|
+
- `~/.quantumclaw/credentials/` (OAuth tokens, API keys)
|
|
132
|
+
- `~/.quantumclaw/agents/<agentId>/sessions/` (session transcripts + metadata)
|
|
133
|
+
- `~/.quantumclaw/skills/` (managed skills)
|
|
134
|
+
|
|
135
|
+
If you need to migrate sessions or config, copy them separately and keep them
|
|
136
|
+
out of version control.
|
|
137
|
+
|
|
138
|
+
## Git backup (recommended, private)
|
|
139
|
+
|
|
140
|
+
Treat the workspace as private memory. Put it in a **private** git repo so it is
|
|
141
|
+
backed up and recoverable.
|
|
142
|
+
|
|
143
|
+
Run these steps on the machine where the Gateway runs (that is where the
|
|
144
|
+
workspace lives).
|
|
145
|
+
|
|
146
|
+
### 1) Initialize the repo
|
|
147
|
+
|
|
148
|
+
If git is installed, brand-new workspaces are initialized automatically. If this
|
|
149
|
+
workspace is not already a repo, run:
|
|
150
|
+
|
|
151
|
+
```bash
|
|
152
|
+
cd ~/.quantumclaw/workspace
|
|
153
|
+
git init
|
|
154
|
+
git add AGENTS.md SOUL.md TOOLS.md IDENTITY.md USER.md HEARTBEAT.md memory/
|
|
155
|
+
git commit -m "Add agent workspace"
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
### 2) Add a private remote (beginner-friendly options)
|
|
159
|
+
|
|
160
|
+
Option A: GitHub web UI
|
|
161
|
+
|
|
162
|
+
1. Create a new **private** repository on GitHub.
|
|
163
|
+
2. Do not initialize with a README (avoids merge conflicts).
|
|
164
|
+
3. Copy the HTTPS remote URL.
|
|
165
|
+
4. Add the remote and push:
|
|
166
|
+
|
|
167
|
+
```bash
|
|
168
|
+
git branch -M main
|
|
169
|
+
git remote add origin <https-url>
|
|
170
|
+
git push -u origin main
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
Option B: GitHub CLI (`gh`)
|
|
174
|
+
|
|
175
|
+
```bash
|
|
176
|
+
gh auth login
|
|
177
|
+
gh repo create quantumclaw-workspace --private --source . --remote origin --push
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
Option C: GitLab web UI
|
|
181
|
+
|
|
182
|
+
1. Create a new **private** repository on GitLab.
|
|
183
|
+
2. Do not initialize with a README (avoids merge conflicts).
|
|
184
|
+
3. Copy the HTTPS remote URL.
|
|
185
|
+
4. Add the remote and push:
|
|
186
|
+
|
|
187
|
+
```bash
|
|
188
|
+
git branch -M main
|
|
189
|
+
git remote add origin <https-url>
|
|
190
|
+
git push -u origin main
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
### 3) Ongoing updates
|
|
194
|
+
|
|
195
|
+
```bash
|
|
196
|
+
git status
|
|
197
|
+
git add .
|
|
198
|
+
git commit -m "Update memory"
|
|
199
|
+
git push
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
## Do not commit secrets
|
|
203
|
+
|
|
204
|
+
Even in a private repo, avoid storing secrets in the workspace:
|
|
205
|
+
|
|
206
|
+
- API keys, OAuth tokens, passwords, or private credentials.
|
|
207
|
+
- Anything under `~/.quantumclaw/`.
|
|
208
|
+
- Raw dumps of chats or sensitive attachments.
|
|
209
|
+
|
|
210
|
+
If you must store sensitive references, use placeholders and keep the real
|
|
211
|
+
secret elsewhere (password manager, environment variables, or `~/.quantumclaw/`).
|
|
212
|
+
|
|
213
|
+
Suggested `.gitignore` starter:
|
|
214
|
+
|
|
215
|
+
```gitignore
|
|
216
|
+
.DS_Store
|
|
217
|
+
.env
|
|
218
|
+
**/*.key
|
|
219
|
+
**/*.pem
|
|
220
|
+
**/secrets*
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
## Moving the workspace to a new machine
|
|
224
|
+
|
|
225
|
+
1. Clone the repo to the desired path (default `~/.quantumclaw/workspace`).
|
|
226
|
+
2. Set `agents.defaults.workspace` to that path in `~/.quantumclaw/quantumclaw.json`.
|
|
227
|
+
3. Run `quantumclaw setup --workspace <path>` to seed any missing files.
|
|
228
|
+
4. If you need sessions, copy `~/.quantumclaw/agents/<agentId>/sessions/` from the
|
|
229
|
+
old machine separately.
|
|
230
|
+
|
|
231
|
+
## Advanced notes
|
|
232
|
+
|
|
233
|
+
- Multi-agent routing can use different workspaces per agent. See
|
|
234
|
+
[Channel routing](/channels/channel-routing) for routing configuration.
|
|
235
|
+
- If `agents.defaults.sandbox` is enabled, non-main sessions can use per-session sandbox
|
|
236
|
+
workspaces under `agents.defaults.sandbox.workspaceRoot`.
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "Agent runtime, workspace contract, and session bootstrap"
|
|
3
|
+
read_when:
|
|
4
|
+
- Changing agent runtime, workspace bootstrap, or session behavior
|
|
5
|
+
title: "Agent Runtime"
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Agent Runtime
|
|
9
|
+
|
|
10
|
+
QuantumClaw runs a single embedded agent runtime.
|
|
11
|
+
|
|
12
|
+
## Workspace (required)
|
|
13
|
+
|
|
14
|
+
QuantumClaw uses a single agent workspace directory (`agents.defaults.workspace`) as the agent’s **only** working directory (`cwd`) for tools and context.
|
|
15
|
+
|
|
16
|
+
Recommended: use `quantumclaw setup` to create `~/.quantumclaw/quantumclaw.json` if missing and initialize the workspace files.
|
|
17
|
+
|
|
18
|
+
Full workspace layout + backup guide: [Agent workspace](/concepts/agent-workspace)
|
|
19
|
+
|
|
20
|
+
If `agents.defaults.sandbox` is enabled, non-main sessions can override this with
|
|
21
|
+
per-session workspaces under `agents.defaults.sandbox.workspaceRoot` (see
|
|
22
|
+
[Gateway configuration](/gateway/configuration)).
|
|
23
|
+
|
|
24
|
+
## Bootstrap files (injected)
|
|
25
|
+
|
|
26
|
+
Inside `agents.defaults.workspace`, QuantumClaw expects these user-editable files:
|
|
27
|
+
|
|
28
|
+
- `AGENTS.md` — operating instructions + “memory”
|
|
29
|
+
- `SOUL.md` — persona, boundaries, tone
|
|
30
|
+
- `TOOLS.md` — user-maintained tool notes (e.g. `imsg`, `sag`, conventions)
|
|
31
|
+
- `BOOTSTRAP.md` — one-time first-run ritual (deleted after completion)
|
|
32
|
+
- `IDENTITY.md` — agent name/vibe/emoji
|
|
33
|
+
- `USER.md` — user profile + preferred address
|
|
34
|
+
|
|
35
|
+
On the first turn of a new session, QuantumClaw injects the contents of these files directly into the agent context.
|
|
36
|
+
|
|
37
|
+
Blank files are skipped. Large files are trimmed and truncated with a marker so prompts stay lean (read the file for full content).
|
|
38
|
+
|
|
39
|
+
If a file is missing, QuantumClaw injects a single “missing file” marker line (and `quantumclaw setup` will create a safe default template).
|
|
40
|
+
|
|
41
|
+
`BOOTSTRAP.md` is only created for a **brand new workspace** (no other bootstrap files present). If you delete it after completing the ritual, it should not be recreated on later restarts.
|
|
42
|
+
|
|
43
|
+
To disable bootstrap file creation entirely (for pre-seeded workspaces), set:
|
|
44
|
+
|
|
45
|
+
```json5
|
|
46
|
+
{ agent: { skipBootstrap: true } }
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## Built-in tools
|
|
50
|
+
|
|
51
|
+
Core tools (read/exec/edit/write and related system tools) are always available,
|
|
52
|
+
subject to tool policy. `apply_patch` is optional and gated by
|
|
53
|
+
`tools.exec.applyPatch`. `TOOLS.md` does **not** control which tools exist; it’s
|
|
54
|
+
guidance for how _you_ want them used.
|
|
55
|
+
|
|
56
|
+
## Skills
|
|
57
|
+
|
|
58
|
+
QuantumClaw loads skills from three locations (workspace wins on name conflict):
|
|
59
|
+
|
|
60
|
+
- Bundled (shipped with the install)
|
|
61
|
+
- Managed/local: `~/.quantumclaw/skills`
|
|
62
|
+
- Workspace: `<workspace>/skills`
|
|
63
|
+
|
|
64
|
+
Skills can be gated by config/env (see `skills` in [Gateway configuration](/gateway/configuration)).
|
|
65
|
+
|
|
66
|
+
## Runtime boundaries
|
|
67
|
+
|
|
68
|
+
The embedded agent runtime is built on the Pi agent core (models, tools, and
|
|
69
|
+
prompt pipeline). Session management, discovery, tool wiring, and channel
|
|
70
|
+
delivery are QuantumClaw-owned layers on top of that core.
|
|
71
|
+
|
|
72
|
+
## Sessions
|
|
73
|
+
|
|
74
|
+
Session transcripts are stored as JSONL at:
|
|
75
|
+
|
|
76
|
+
- `~/.quantumclaw/agents/<agentId>/sessions/<SessionId>.jsonl`
|
|
77
|
+
|
|
78
|
+
The session ID is stable and chosen by QuantumClaw.
|
|
79
|
+
Legacy session folders from other tools are not read.
|
|
80
|
+
|
|
81
|
+
## Steering while streaming
|
|
82
|
+
|
|
83
|
+
When queue mode is `steer`, inbound messages are injected into the current run.
|
|
84
|
+
The queue is checked **after each tool call**; if a queued message is present,
|
|
85
|
+
remaining tool calls from the current assistant message are skipped (error tool
|
|
86
|
+
results with "Skipped due to queued user message."), then the queued user
|
|
87
|
+
message is injected before the next assistant response.
|
|
88
|
+
|
|
89
|
+
When queue mode is `followup` or `collect`, inbound messages are held until the
|
|
90
|
+
current turn ends, then a new agent turn starts with the queued payloads. See
|
|
91
|
+
[Queue](/concepts/queue) for mode + debounce/cap behavior.
|
|
92
|
+
|
|
93
|
+
Block streaming sends completed assistant blocks as soon as they finish; it is
|
|
94
|
+
**off by default** (`agents.defaults.blockStreamingDefault: "off"`).
|
|
95
|
+
Tune the boundary via `agents.defaults.blockStreamingBreak` (`text_end` vs `message_end`; defaults to text_end).
|
|
96
|
+
Control soft block chunking with `agents.defaults.blockStreamingChunk` (defaults to
|
|
97
|
+
800–1200 chars; prefers paragraph breaks, then newlines; sentences last).
|
|
98
|
+
Coalesce streamed chunks with `agents.defaults.blockStreamingCoalesce` to reduce
|
|
99
|
+
single-line spam (idle-based merging before send). Non-Telegram channels require
|
|
100
|
+
explicit `*.blockStreaming: true` to enable block replies.
|
|
101
|
+
Verbose tool summaries are emitted at tool start (no debounce); Control UI
|
|
102
|
+
streams tool output via agent events when available.
|
|
103
|
+
More details: [Streaming + chunking](/concepts/streaming).
|
|
104
|
+
|
|
105
|
+
## Model refs
|
|
106
|
+
|
|
107
|
+
Model refs in config (for example `agents.defaults.model` and `agents.defaults.models`) are parsed by splitting on the **first** `/`.
|
|
108
|
+
|
|
109
|
+
- Use `provider/model` when configuring models.
|
|
110
|
+
- If the model ID itself contains `/` (OpenRouter-style), include the provider prefix (example: `openrouter/moonshotai/kimi-k2`).
|
|
111
|
+
- If you omit the provider, QuantumClaw treats the input as an alias or a model for the **default provider** (only works when there is no `/` in the model ID).
|
|
112
|
+
|
|
113
|
+
## Configuration (minimal)
|
|
114
|
+
|
|
115
|
+
At minimum, set:
|
|
116
|
+
|
|
117
|
+
- `agents.defaults.workspace`
|
|
118
|
+
- `channels.whatsapp.allowFrom` (strongly recommended)
|
|
119
|
+
|
|
120
|
+
---
|
|
121
|
+
|
|
122
|
+
_Next: [Group Chats](/channels/group-messages)_ 🦞
|