@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
package/docs/cli/logs.md
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "CLI reference for `quantumclaw logs` (tail gateway logs via RPC)"
|
|
3
|
+
read_when:
|
|
4
|
+
- You need to tail Gateway logs remotely (without SSH)
|
|
5
|
+
- You want JSON log lines for tooling
|
|
6
|
+
title: "logs"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# `quantumclaw logs`
|
|
10
|
+
|
|
11
|
+
Tail Gateway file logs over RPC (works in remote mode).
|
|
12
|
+
|
|
13
|
+
Related:
|
|
14
|
+
|
|
15
|
+
- Logging overview: [Logging](/logging)
|
|
16
|
+
|
|
17
|
+
## Examples
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
quantumclaw logs
|
|
21
|
+
quantumclaw logs --follow
|
|
22
|
+
quantumclaw logs --json
|
|
23
|
+
quantumclaw logs --limit 500
|
|
24
|
+
quantumclaw logs --local-time
|
|
25
|
+
quantumclaw logs --follow --local-time
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Use `--local-time` to render timestamps in your local timezone.
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "CLI reference for `quantumclaw memory` (status/index/search)"
|
|
3
|
+
read_when:
|
|
4
|
+
- You want to index or search semantic memory
|
|
5
|
+
- You’re debugging memory availability or indexing
|
|
6
|
+
title: "memory"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# `quantumclaw memory`
|
|
10
|
+
|
|
11
|
+
Manage semantic memory indexing and search.
|
|
12
|
+
Provided by the active memory plugin (default: `memory-core`; set `plugins.slots.memory = "none"` to disable).
|
|
13
|
+
|
|
14
|
+
Related:
|
|
15
|
+
|
|
16
|
+
- Memory concept: [Memory](/concepts/memory)
|
|
17
|
+
- Plugins: [Plugins](/tools/plugin)
|
|
18
|
+
|
|
19
|
+
## Examples
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
quantumclaw memory status
|
|
23
|
+
quantumclaw memory status --deep
|
|
24
|
+
quantumclaw memory index --force
|
|
25
|
+
quantumclaw memory search "meeting notes"
|
|
26
|
+
quantumclaw memory search --query "deployment" --max-results 20
|
|
27
|
+
quantumclaw memory status --json
|
|
28
|
+
quantumclaw memory status --deep --index
|
|
29
|
+
quantumclaw memory status --deep --index --verbose
|
|
30
|
+
quantumclaw memory status --agent main
|
|
31
|
+
quantumclaw memory index --agent main --verbose
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Options
|
|
35
|
+
|
|
36
|
+
`memory status` and `memory index`:
|
|
37
|
+
|
|
38
|
+
- `--agent <id>`: scope to a single agent. Without it, these commands run for each configured agent; if no agent list is configured, they fall back to the default agent.
|
|
39
|
+
- `--verbose`: emit detailed logs during probes and indexing.
|
|
40
|
+
|
|
41
|
+
`memory status`:
|
|
42
|
+
|
|
43
|
+
- `--deep`: probe vector + embedding availability.
|
|
44
|
+
- `--index`: run a reindex if the store is dirty (implies `--deep`).
|
|
45
|
+
- `--json`: print JSON output.
|
|
46
|
+
|
|
47
|
+
`memory index`:
|
|
48
|
+
|
|
49
|
+
- `--force`: force a full reindex.
|
|
50
|
+
|
|
51
|
+
`memory search`:
|
|
52
|
+
|
|
53
|
+
- Query input: pass either positional `[query]` or `--query <text>`.
|
|
54
|
+
- If both are provided, `--query` wins.
|
|
55
|
+
- If neither is provided, the command exits with an error.
|
|
56
|
+
- `--agent <id>`: scope to a single agent (default: the default agent).
|
|
57
|
+
- `--max-results <n>`: limit the number of results returned.
|
|
58
|
+
- `--min-score <n>`: filter out low-score matches.
|
|
59
|
+
- `--json`: print JSON results.
|
|
60
|
+
|
|
61
|
+
Notes:
|
|
62
|
+
|
|
63
|
+
- `memory index --verbose` prints per-phase details (provider, model, sources, batch activity).
|
|
64
|
+
- `memory status` includes any extra paths configured via `memorySearch.extraPaths`.
|
|
65
|
+
- If effectively active memory remote API key fields are configured as SecretRefs, the command resolves those values from the active gateway snapshot. If gateway is unavailable, the command fails fast.
|
|
66
|
+
- Gateway version skew note: this command path requires a gateway that supports `secrets.resolve`; older gateways return an unknown-method error.
|
|
@@ -0,0 +1,278 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "CLI reference for `quantumclaw message` (send + channel actions)"
|
|
3
|
+
read_when:
|
|
4
|
+
- Adding or modifying message CLI actions
|
|
5
|
+
- Changing outbound channel behavior
|
|
6
|
+
title: "message"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# `quantumclaw message`
|
|
10
|
+
|
|
11
|
+
Single outbound command for sending messages and channel actions
|
|
12
|
+
(Discord/Google Chat/Slack/Mattermost (plugin)/Telegram/WhatsApp/Signal/iMessage/Microsoft Teams).
|
|
13
|
+
|
|
14
|
+
## Usage
|
|
15
|
+
|
|
16
|
+
```
|
|
17
|
+
quantumclaw message <subcommand> [flags]
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Channel selection:
|
|
21
|
+
|
|
22
|
+
- `--channel` required if more than one channel is configured.
|
|
23
|
+
- If exactly one channel is configured, it becomes the default.
|
|
24
|
+
- Values: `whatsapp|telegram|discord|googlechat|slack|mattermost|signal|imessage|msteams` (Mattermost requires plugin)
|
|
25
|
+
|
|
26
|
+
Target formats (`--target`):
|
|
27
|
+
|
|
28
|
+
- WhatsApp: E.164 or group JID
|
|
29
|
+
- Telegram: chat id or `@username`
|
|
30
|
+
- Discord: `channel:<id>` or `user:<id>` (or `<@id>` mention; raw numeric ids are treated as channels)
|
|
31
|
+
- Google Chat: `spaces/<spaceId>` or `users/<userId>`
|
|
32
|
+
- Slack: `channel:<id>` or `user:<id>` (raw channel id is accepted)
|
|
33
|
+
- Mattermost (plugin): `channel:<id>`, `user:<id>`, or `@username` (bare ids are treated as channels)
|
|
34
|
+
- Signal: `+E.164`, `group:<id>`, `signal:+E.164`, `signal:group:<id>`, or `username:<name>`/`u:<name>`
|
|
35
|
+
- iMessage: handle, `chat_id:<id>`, `chat_guid:<guid>`, or `chat_identifier:<id>`
|
|
36
|
+
- Microsoft Teams: conversation id (`19:...@thread.tacv2`) or `conversation:<id>` or `user:<aad-object-id>`
|
|
37
|
+
|
|
38
|
+
Name lookup:
|
|
39
|
+
|
|
40
|
+
- For supported providers (Discord/Slack/etc), channel names like `Help` or `#help` are resolved via the directory cache.
|
|
41
|
+
- On cache miss, QuantumClaw will attempt a live directory lookup when the provider supports it.
|
|
42
|
+
|
|
43
|
+
## Common flags
|
|
44
|
+
|
|
45
|
+
- `--channel <name>`
|
|
46
|
+
- `--account <id>`
|
|
47
|
+
- `--target <dest>` (target channel or user for send/poll/read/etc)
|
|
48
|
+
- `--targets <name>` (repeat; broadcast only)
|
|
49
|
+
- `--json`
|
|
50
|
+
- `--dry-run`
|
|
51
|
+
- `--verbose`
|
|
52
|
+
|
|
53
|
+
## SecretRef behavior
|
|
54
|
+
|
|
55
|
+
- `quantumclaw message` resolves supported channel SecretRefs before running the selected action.
|
|
56
|
+
- Resolution is scoped to the active action target when possible:
|
|
57
|
+
- channel-scoped when `--channel` is set (or inferred from prefixed targets like `discord:...`)
|
|
58
|
+
- account-scoped when `--account` is set (channel globals + selected account surfaces)
|
|
59
|
+
- when `--account` is omitted, QuantumClaw does not force a `default` account SecretRef scope
|
|
60
|
+
- Unresolved SecretRefs on unrelated channels do not block a targeted message action.
|
|
61
|
+
- If the selected channel/account SecretRef is unresolved, the command fails closed for that action.
|
|
62
|
+
|
|
63
|
+
## Actions
|
|
64
|
+
|
|
65
|
+
### Core
|
|
66
|
+
|
|
67
|
+
- `send`
|
|
68
|
+
- Channels: WhatsApp/Telegram/Discord/Google Chat/Slack/Mattermost (plugin)/Signal/iMessage/Microsoft Teams
|
|
69
|
+
- Required: `--target`, plus `--message` or `--media`
|
|
70
|
+
- Optional: `--media`, `--reply-to`, `--thread-id`, `--gif-playback`
|
|
71
|
+
- Telegram only: `--buttons` (requires `channels.telegram.capabilities.inlineButtons` to allow it)
|
|
72
|
+
- Telegram only: `--force-document` (send images and GIFs as documents to avoid Telegram compression)
|
|
73
|
+
- Telegram only: `--thread-id` (forum topic id)
|
|
74
|
+
- Slack only: `--thread-id` (thread timestamp; `--reply-to` uses the same field)
|
|
75
|
+
- WhatsApp only: `--gif-playback`
|
|
76
|
+
|
|
77
|
+
- `poll`
|
|
78
|
+
- Channels: WhatsApp/Telegram/Discord/Matrix/Microsoft Teams
|
|
79
|
+
- Required: `--target`, `--poll-question`, `--poll-option` (repeat)
|
|
80
|
+
- Optional: `--poll-multi`
|
|
81
|
+
- Discord only: `--poll-duration-hours`, `--silent`, `--message`
|
|
82
|
+
- Telegram only: `--poll-duration-seconds` (5-600), `--silent`, `--poll-anonymous` / `--poll-public`, `--thread-id`
|
|
83
|
+
|
|
84
|
+
- `react`
|
|
85
|
+
- Channels: Discord/Google Chat/Slack/Telegram/WhatsApp/Signal
|
|
86
|
+
- Required: `--message-id`, `--target`
|
|
87
|
+
- Optional: `--emoji`, `--remove`, `--participant`, `--from-me`, `--target-author`, `--target-author-uuid`
|
|
88
|
+
- Note: `--remove` requires `--emoji` (omit `--emoji` to clear own reactions where supported; see /tools/reactions)
|
|
89
|
+
- WhatsApp only: `--participant`, `--from-me`
|
|
90
|
+
- Signal group reactions: `--target-author` or `--target-author-uuid` required
|
|
91
|
+
|
|
92
|
+
- `reactions`
|
|
93
|
+
- Channels: Discord/Google Chat/Slack
|
|
94
|
+
- Required: `--message-id`, `--target`
|
|
95
|
+
- Optional: `--limit`
|
|
96
|
+
|
|
97
|
+
- `read`
|
|
98
|
+
- Channels: Discord/Slack
|
|
99
|
+
- Required: `--target`
|
|
100
|
+
- Optional: `--limit`, `--before`, `--after`
|
|
101
|
+
- Discord only: `--around`
|
|
102
|
+
|
|
103
|
+
- `edit`
|
|
104
|
+
- Channels: Discord/Slack
|
|
105
|
+
- Required: `--message-id`, `--message`, `--target`
|
|
106
|
+
|
|
107
|
+
- `delete`
|
|
108
|
+
- Channels: Discord/Slack/Telegram
|
|
109
|
+
- Required: `--message-id`, `--target`
|
|
110
|
+
|
|
111
|
+
- `pin` / `unpin`
|
|
112
|
+
- Channels: Discord/Slack
|
|
113
|
+
- Required: `--message-id`, `--target`
|
|
114
|
+
|
|
115
|
+
- `pins` (list)
|
|
116
|
+
- Channels: Discord/Slack
|
|
117
|
+
- Required: `--target`
|
|
118
|
+
|
|
119
|
+
- `permissions`
|
|
120
|
+
- Channels: Discord
|
|
121
|
+
- Required: `--target`
|
|
122
|
+
|
|
123
|
+
- `search`
|
|
124
|
+
- Channels: Discord
|
|
125
|
+
- Required: `--guild-id`, `--query`
|
|
126
|
+
- Optional: `--channel-id`, `--channel-ids` (repeat), `--author-id`, `--author-ids` (repeat), `--limit`
|
|
127
|
+
|
|
128
|
+
### Threads
|
|
129
|
+
|
|
130
|
+
- `thread create`
|
|
131
|
+
- Channels: Discord
|
|
132
|
+
- Required: `--thread-name`, `--target` (channel id)
|
|
133
|
+
- Optional: `--message-id`, `--message`, `--auto-archive-min`
|
|
134
|
+
|
|
135
|
+
- `thread list`
|
|
136
|
+
- Channels: Discord
|
|
137
|
+
- Required: `--guild-id`
|
|
138
|
+
- Optional: `--channel-id`, `--include-archived`, `--before`, `--limit`
|
|
139
|
+
|
|
140
|
+
- `thread reply`
|
|
141
|
+
- Channels: Discord
|
|
142
|
+
- Required: `--target` (thread id), `--message`
|
|
143
|
+
- Optional: `--media`, `--reply-to`
|
|
144
|
+
|
|
145
|
+
### Emojis
|
|
146
|
+
|
|
147
|
+
- `emoji list`
|
|
148
|
+
- Discord: `--guild-id`
|
|
149
|
+
- Slack: no extra flags
|
|
150
|
+
|
|
151
|
+
- `emoji upload`
|
|
152
|
+
- Channels: Discord
|
|
153
|
+
- Required: `--guild-id`, `--emoji-name`, `--media`
|
|
154
|
+
- Optional: `--role-ids` (repeat)
|
|
155
|
+
|
|
156
|
+
### Stickers
|
|
157
|
+
|
|
158
|
+
- `sticker send`
|
|
159
|
+
- Channels: Discord
|
|
160
|
+
- Required: `--target`, `--sticker-id` (repeat)
|
|
161
|
+
- Optional: `--message`
|
|
162
|
+
|
|
163
|
+
- `sticker upload`
|
|
164
|
+
- Channels: Discord
|
|
165
|
+
- Required: `--guild-id`, `--sticker-name`, `--sticker-desc`, `--sticker-tags`, `--media`
|
|
166
|
+
|
|
167
|
+
### Roles / Channels / Members / Voice
|
|
168
|
+
|
|
169
|
+
- `role info` (Discord): `--guild-id`
|
|
170
|
+
- `role add` / `role remove` (Discord): `--guild-id`, `--user-id`, `--role-id`
|
|
171
|
+
- `channel info` (Discord): `--target`
|
|
172
|
+
- `channel list` (Discord): `--guild-id`
|
|
173
|
+
- `member info` (Discord/Slack): `--user-id` (+ `--guild-id` for Discord)
|
|
174
|
+
- `voice status` (Discord): `--guild-id`, `--user-id`
|
|
175
|
+
|
|
176
|
+
### Events
|
|
177
|
+
|
|
178
|
+
- `event list` (Discord): `--guild-id`
|
|
179
|
+
- `event create` (Discord): `--guild-id`, `--event-name`, `--start-time`
|
|
180
|
+
- Optional: `--end-time`, `--desc`, `--channel-id`, `--location`, `--event-type`
|
|
181
|
+
|
|
182
|
+
### Moderation (Discord)
|
|
183
|
+
|
|
184
|
+
- `timeout`: `--guild-id`, `--user-id` (optional `--duration-min` or `--until`; omit both to clear timeout)
|
|
185
|
+
- `kick`: `--guild-id`, `--user-id` (+ `--reason`)
|
|
186
|
+
- `ban`: `--guild-id`, `--user-id` (+ `--delete-days`, `--reason`)
|
|
187
|
+
- `timeout` also supports `--reason`
|
|
188
|
+
|
|
189
|
+
### Broadcast
|
|
190
|
+
|
|
191
|
+
- `broadcast`
|
|
192
|
+
- Channels: any configured channel; use `--channel all` to target all providers
|
|
193
|
+
- Required: `--targets` (repeat)
|
|
194
|
+
- Optional: `--message`, `--media`, `--dry-run`
|
|
195
|
+
|
|
196
|
+
## Examples
|
|
197
|
+
|
|
198
|
+
Send a Discord reply:
|
|
199
|
+
|
|
200
|
+
```
|
|
201
|
+
quantumclaw message send --channel discord \
|
|
202
|
+
--target channel:123 --message "hi" --reply-to 456
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
Send a Discord message with components:
|
|
206
|
+
|
|
207
|
+
```
|
|
208
|
+
quantumclaw message send --channel discord \
|
|
209
|
+
--target channel:123 --message "Choose:" \
|
|
210
|
+
--components '{"text":"Choose a path","blocks":[{"type":"actions","buttons":[{"label":"Approve","style":"success"},{"label":"Decline","style":"danger"}]}]}'
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
See [Discord components](/channels/discord#interactive-components) for the full schema.
|
|
214
|
+
|
|
215
|
+
Create a Discord poll:
|
|
216
|
+
|
|
217
|
+
```
|
|
218
|
+
quantumclaw message poll --channel discord \
|
|
219
|
+
--target channel:123 \
|
|
220
|
+
--poll-question "Snack?" \
|
|
221
|
+
--poll-option Pizza --poll-option Sushi \
|
|
222
|
+
--poll-multi --poll-duration-hours 48
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
Create a Telegram poll (auto-close in 2 minutes):
|
|
226
|
+
|
|
227
|
+
```
|
|
228
|
+
quantumclaw message poll --channel telegram \
|
|
229
|
+
--target @mychat \
|
|
230
|
+
--poll-question "Lunch?" \
|
|
231
|
+
--poll-option Pizza --poll-option Sushi \
|
|
232
|
+
--poll-duration-seconds 120 --silent
|
|
233
|
+
```
|
|
234
|
+
|
|
235
|
+
Send a Teams proactive message:
|
|
236
|
+
|
|
237
|
+
```
|
|
238
|
+
quantumclaw message send --channel msteams \
|
|
239
|
+
--target conversation:19:abc@thread.tacv2 --message "hi"
|
|
240
|
+
```
|
|
241
|
+
|
|
242
|
+
Create a Teams poll:
|
|
243
|
+
|
|
244
|
+
```
|
|
245
|
+
quantumclaw message poll --channel msteams \
|
|
246
|
+
--target conversation:19:abc@thread.tacv2 \
|
|
247
|
+
--poll-question "Lunch?" \
|
|
248
|
+
--poll-option Pizza --poll-option Sushi
|
|
249
|
+
```
|
|
250
|
+
|
|
251
|
+
React in Slack:
|
|
252
|
+
|
|
253
|
+
```
|
|
254
|
+
quantumclaw message react --channel slack \
|
|
255
|
+
--target C123 --message-id 456 --emoji "✅"
|
|
256
|
+
```
|
|
257
|
+
|
|
258
|
+
React in a Signal group:
|
|
259
|
+
|
|
260
|
+
```
|
|
261
|
+
quantumclaw message react --channel signal \
|
|
262
|
+
--target signal:group:abc123 --message-id 1737630212345 \
|
|
263
|
+
--emoji "✅" --target-author-uuid 123e4567-e89b-12d3-a456-426614174000
|
|
264
|
+
```
|
|
265
|
+
|
|
266
|
+
Send Telegram inline buttons:
|
|
267
|
+
|
|
268
|
+
```
|
|
269
|
+
quantumclaw message send --channel telegram --target @mychat --message "Choose:" \
|
|
270
|
+
--buttons '[ [{"text":"Yes","callback_data":"cmd:yes"}], [{"text":"No","callback_data":"cmd:no"}] ]'
|
|
271
|
+
```
|
|
272
|
+
|
|
273
|
+
Send a Telegram image as a document to avoid compression:
|
|
274
|
+
|
|
275
|
+
```bash
|
|
276
|
+
quantumclaw message send --channel telegram --target @mychat \
|
|
277
|
+
--media ./diagram.png --force-document
|
|
278
|
+
```
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "CLI reference for `quantumclaw models` (status/list/set/scan, aliases, fallbacks, auth)"
|
|
3
|
+
read_when:
|
|
4
|
+
- You want to change default models or view provider auth status
|
|
5
|
+
- You want to scan available models/providers and debug auth profiles
|
|
6
|
+
title: "models"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# `quantumclaw models`
|
|
10
|
+
|
|
11
|
+
Model discovery, scanning, and configuration (default model, fallbacks, auth profiles).
|
|
12
|
+
|
|
13
|
+
Related:
|
|
14
|
+
|
|
15
|
+
- Providers + models: [Models](/providers/models)
|
|
16
|
+
- Provider auth setup: [Getting started](/start/getting-started)
|
|
17
|
+
|
|
18
|
+
## Common commands
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
quantumclaw models status
|
|
22
|
+
quantumclaw models list
|
|
23
|
+
quantumclaw models set <model-or-alias>
|
|
24
|
+
quantumclaw models scan
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
`quantumclaw models status` shows the resolved default/fallbacks plus an auth overview.
|
|
28
|
+
When provider usage snapshots are available, the OAuth/token status section includes
|
|
29
|
+
provider usage headers.
|
|
30
|
+
Add `--probe` to run live auth probes against each configured provider profile.
|
|
31
|
+
Probes are real requests (may consume tokens and trigger rate limits).
|
|
32
|
+
Use `--agent <id>` to inspect a configured agent’s model/auth state. When omitted,
|
|
33
|
+
the command uses `QUANTUMCLAW_AGENT_DIR`/`PI_CODING_AGENT_DIR` if set, otherwise the
|
|
34
|
+
configured default agent.
|
|
35
|
+
|
|
36
|
+
Notes:
|
|
37
|
+
|
|
38
|
+
- `models set <model-or-alias>` accepts `provider/model` or an alias.
|
|
39
|
+
- Model refs are parsed by splitting on the **first** `/`. If the model ID includes `/` (OpenRouter-style), include the provider prefix (example: `openrouter/moonshotai/kimi-k2`).
|
|
40
|
+
- 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).
|
|
41
|
+
- `models status` may show `marker(<value>)` in auth output for non-secret placeholders (for example `OPENAI_API_KEY`, `secretref-managed`, `minimax-oauth`, `qwen-oauth`, `ollama-local`) instead of masking them as secrets.
|
|
42
|
+
|
|
43
|
+
### `models status`
|
|
44
|
+
|
|
45
|
+
Options:
|
|
46
|
+
|
|
47
|
+
- `--json`
|
|
48
|
+
- `--plain`
|
|
49
|
+
- `--check` (exit 1=expired/missing, 2=expiring)
|
|
50
|
+
- `--probe` (live probe of configured auth profiles)
|
|
51
|
+
- `--probe-provider <name>` (probe one provider)
|
|
52
|
+
- `--probe-profile <id>` (repeat or comma-separated profile ids)
|
|
53
|
+
- `--probe-timeout <ms>`
|
|
54
|
+
- `--probe-concurrency <n>`
|
|
55
|
+
- `--probe-max-tokens <n>`
|
|
56
|
+
- `--agent <id>` (configured agent id; overrides `QUANTUMCLAW_AGENT_DIR`/`PI_CODING_AGENT_DIR`)
|
|
57
|
+
|
|
58
|
+
## Aliases + fallbacks
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
quantumclaw models aliases list
|
|
62
|
+
quantumclaw models fallbacks list
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
## Auth profiles
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
quantumclaw models auth add
|
|
69
|
+
quantumclaw models auth login --provider <id>
|
|
70
|
+
quantumclaw models auth setup-token
|
|
71
|
+
quantumclaw models auth paste-token
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
`models auth login` runs a provider plugin’s auth flow (OAuth/API key). Use
|
|
75
|
+
`quantumclaw plugins list` to see which providers are installed.
|
|
76
|
+
|
|
77
|
+
Notes:
|
|
78
|
+
|
|
79
|
+
- `setup-token` prompts for a setup-token value (generate it with `claude setup-token` on any machine).
|
|
80
|
+
- `paste-token` accepts a token string generated elsewhere or from automation.
|
|
81
|
+
- Anthropic policy note: setup-token support is technical compatibility. Anthropic has blocked some subscription usage outside Claude Code in the past, so verify current terms before using it broadly.
|
package/docs/cli/node.md
ADDED
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "CLI reference for `quantumclaw node` (headless node host)"
|
|
3
|
+
read_when:
|
|
4
|
+
- Running the headless node host
|
|
5
|
+
- Pairing a non-macOS node for system.run
|
|
6
|
+
title: "node"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# `quantumclaw node`
|
|
10
|
+
|
|
11
|
+
Run a **headless node host** that connects to the Gateway WebSocket and exposes
|
|
12
|
+
`system.run` / `system.which` on this machine.
|
|
13
|
+
|
|
14
|
+
## Why use a node host?
|
|
15
|
+
|
|
16
|
+
Use a node host when you want agents to **run commands on other machines** in your
|
|
17
|
+
network without installing a full macOS companion app there.
|
|
18
|
+
|
|
19
|
+
Common use cases:
|
|
20
|
+
|
|
21
|
+
- Run commands on remote Linux/Windows boxes (build servers, lab machines, NAS).
|
|
22
|
+
- Keep exec **sandboxed** on the gateway, but delegate approved runs to other hosts.
|
|
23
|
+
- Provide a lightweight, headless execution target for automation or CI nodes.
|
|
24
|
+
|
|
25
|
+
Execution is still guarded by **exec approvals** and per‑agent allowlists on the
|
|
26
|
+
node host, so you can keep command access scoped and explicit.
|
|
27
|
+
|
|
28
|
+
## Browser proxy (zero-config)
|
|
29
|
+
|
|
30
|
+
Node hosts automatically advertise a browser proxy if `browser.enabled` is not
|
|
31
|
+
disabled on the node. This lets the agent use browser automation on that node
|
|
32
|
+
without extra configuration.
|
|
33
|
+
|
|
34
|
+
Disable it on the node if needed:
|
|
35
|
+
|
|
36
|
+
```json5
|
|
37
|
+
{
|
|
38
|
+
nodeHost: {
|
|
39
|
+
browserProxy: {
|
|
40
|
+
enabled: false,
|
|
41
|
+
},
|
|
42
|
+
},
|
|
43
|
+
}
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Run (foreground)
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
quantumclaw node run --host <gateway-host> --port 18789
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
Options:
|
|
53
|
+
|
|
54
|
+
- `--host <host>`: Gateway WebSocket host (default: `127.0.0.1`)
|
|
55
|
+
- `--port <port>`: Gateway WebSocket port (default: `18789`)
|
|
56
|
+
- `--tls`: Use TLS for the gateway connection
|
|
57
|
+
- `--tls-fingerprint <sha256>`: Expected TLS certificate fingerprint (sha256)
|
|
58
|
+
- `--node-id <id>`: Override node id (clears pairing token)
|
|
59
|
+
- `--display-name <name>`: Override the node display name
|
|
60
|
+
|
|
61
|
+
## Gateway auth for node host
|
|
62
|
+
|
|
63
|
+
`quantumclaw node run` and `quantumclaw node install` resolve gateway auth from config/env (no `--token`/`--password` flags on node commands):
|
|
64
|
+
|
|
65
|
+
- `QUANTUMCLAW_GATEWAY_TOKEN` / `QUANTUMCLAW_GATEWAY_PASSWORD` are checked first.
|
|
66
|
+
- Then local config fallback: `gateway.auth.token` / `gateway.auth.password`.
|
|
67
|
+
- In local mode, node host intentionally does not inherit `gateway.remote.token` / `gateway.remote.password`.
|
|
68
|
+
- If `gateway.auth.token` / `gateway.auth.password` is explicitly configured via SecretRef and unresolved, node auth resolution fails closed (no remote fallback masking).
|
|
69
|
+
- In `gateway.mode=remote`, remote client fields (`gateway.remote.token` / `gateway.remote.password`) are also eligible per remote precedence rules.
|
|
70
|
+
- Legacy `CLAWDBOT_GATEWAY_*` env vars are ignored for node host auth resolution.
|
|
71
|
+
|
|
72
|
+
## Service (background)
|
|
73
|
+
|
|
74
|
+
Install a headless node host as a user service.
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
quantumclaw node install --host <gateway-host> --port 18789
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
Options:
|
|
81
|
+
|
|
82
|
+
- `--host <host>`: Gateway WebSocket host (default: `127.0.0.1`)
|
|
83
|
+
- `--port <port>`: Gateway WebSocket port (default: `18789`)
|
|
84
|
+
- `--tls`: Use TLS for the gateway connection
|
|
85
|
+
- `--tls-fingerprint <sha256>`: Expected TLS certificate fingerprint (sha256)
|
|
86
|
+
- `--node-id <id>`: Override node id (clears pairing token)
|
|
87
|
+
- `--display-name <name>`: Override the node display name
|
|
88
|
+
- `--runtime <runtime>`: Service runtime (`node` or `bun`)
|
|
89
|
+
- `--force`: Reinstall/overwrite if already installed
|
|
90
|
+
|
|
91
|
+
Manage the service:
|
|
92
|
+
|
|
93
|
+
```bash
|
|
94
|
+
quantumclaw node status
|
|
95
|
+
quantumclaw node stop
|
|
96
|
+
quantumclaw node restart
|
|
97
|
+
quantumclaw node uninstall
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
Use `quantumclaw node run` for a foreground node host (no service).
|
|
101
|
+
|
|
102
|
+
Service commands accept `--json` for machine-readable output.
|
|
103
|
+
|
|
104
|
+
## Pairing
|
|
105
|
+
|
|
106
|
+
The first connection creates a pending device pairing request (`role: node`) on the Gateway.
|
|
107
|
+
Approve it via:
|
|
108
|
+
|
|
109
|
+
```bash
|
|
110
|
+
quantumclaw devices list
|
|
111
|
+
quantumclaw devices approve <requestId>
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
If the node retries pairing with changed auth details (role/scopes/public key),
|
|
115
|
+
the previous pending request is superseded and a new `requestId` is created.
|
|
116
|
+
Run `quantumclaw devices list` again before approval.
|
|
117
|
+
|
|
118
|
+
The node host stores its node id, token, display name, and gateway connection info in
|
|
119
|
+
`~/.quantumclaw/node.json`.
|
|
120
|
+
|
|
121
|
+
## Exec approvals
|
|
122
|
+
|
|
123
|
+
`system.run` is gated by local exec approvals:
|
|
124
|
+
|
|
125
|
+
- `~/.quantumclaw/exec-approvals.json`
|
|
126
|
+
- [Exec approvals](/tools/exec-approvals)
|
|
127
|
+
- `quantumclaw approvals --node <id|name|ip>` (edit from the Gateway)
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "CLI reference for `quantumclaw nodes` (list/status/approve/invoke, camera/canvas/screen)"
|
|
3
|
+
read_when:
|
|
4
|
+
- You’re managing paired nodes (cameras, screen, canvas)
|
|
5
|
+
- You need to approve requests or invoke node commands
|
|
6
|
+
title: "nodes"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# `quantumclaw nodes`
|
|
10
|
+
|
|
11
|
+
Manage paired nodes (devices) and invoke node capabilities.
|
|
12
|
+
|
|
13
|
+
Related:
|
|
14
|
+
|
|
15
|
+
- Nodes overview: [Nodes](/nodes)
|
|
16
|
+
- Camera: [Camera nodes](/nodes/camera)
|
|
17
|
+
- Images: [Image nodes](/nodes/images)
|
|
18
|
+
|
|
19
|
+
Common options:
|
|
20
|
+
|
|
21
|
+
- `--url`, `--token`, `--timeout`, `--json`
|
|
22
|
+
|
|
23
|
+
## Common commands
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
quantumclaw nodes list
|
|
27
|
+
quantumclaw nodes list --connected
|
|
28
|
+
quantumclaw nodes list --last-connected 24h
|
|
29
|
+
quantumclaw nodes pending
|
|
30
|
+
quantumclaw nodes approve <requestId>
|
|
31
|
+
quantumclaw nodes status
|
|
32
|
+
quantumclaw nodes status --connected
|
|
33
|
+
quantumclaw nodes status --last-connected 24h
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
`nodes list` prints pending/paired tables. Paired rows include the most recent connect age (Last Connect).
|
|
37
|
+
Use `--connected` to only show currently-connected nodes. Use `--last-connected <duration>` to
|
|
38
|
+
filter to nodes that connected within a duration (e.g. `24h`, `7d`).
|
|
39
|
+
|
|
40
|
+
## Invoke / run
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
quantumclaw nodes invoke --node <id|name|ip> --command <command> --params <json>
|
|
44
|
+
quantumclaw nodes run --node <id|name|ip> <command...>
|
|
45
|
+
quantumclaw nodes run --raw "git status"
|
|
46
|
+
quantumclaw nodes run --agent main --node <id|name|ip> --raw "git status"
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Invoke flags:
|
|
50
|
+
|
|
51
|
+
- `--params <json>`: JSON object string (default `{}`).
|
|
52
|
+
- `--invoke-timeout <ms>`: node invoke timeout (default `15000`).
|
|
53
|
+
- `--idempotency-key <key>`: optional idempotency key.
|
|
54
|
+
|
|
55
|
+
### Exec-style defaults
|
|
56
|
+
|
|
57
|
+
`nodes run` mirrors the model’s exec behavior (defaults + approvals):
|
|
58
|
+
|
|
59
|
+
- Reads `tools.exec.*` (plus `agents.list[].tools.exec.*` overrides).
|
|
60
|
+
- Uses exec approvals (`exec.approval.request`) before invoking `system.run`.
|
|
61
|
+
- `--node` can be omitted when `tools.exec.node` is set.
|
|
62
|
+
- Requires a node that advertises `system.run` (macOS companion app or headless node host).
|
|
63
|
+
|
|
64
|
+
Flags:
|
|
65
|
+
|
|
66
|
+
- `--cwd <path>`: working directory.
|
|
67
|
+
- `--env <key=val>`: env override (repeatable). Note: node hosts ignore `PATH` overrides (and `tools.exec.pathPrepend` is not applied to node hosts).
|
|
68
|
+
- `--command-timeout <ms>`: command timeout.
|
|
69
|
+
- `--invoke-timeout <ms>`: node invoke timeout (default `30000`).
|
|
70
|
+
- `--needs-screen-recording`: require screen recording permission.
|
|
71
|
+
- `--raw <command>`: run a shell string (`/bin/sh -lc` or `cmd.exe /c`).
|
|
72
|
+
In allowlist mode on Windows node hosts, `cmd.exe /c` shell-wrapper runs require approval
|
|
73
|
+
(allowlist entry alone does not auto-allow the wrapper form).
|
|
74
|
+
- `--agent <id>`: agent-scoped approvals/allowlists (defaults to configured agent).
|
|
75
|
+
- `--ask <off|on-miss|always>`, `--security <deny|allowlist|full>`: overrides.
|