@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,125 @@
|
|
|
1
|
+
---
|
|
2
|
+
read_when:
|
|
3
|
+
- ゼロからの初回セットアップ
|
|
4
|
+
- 動作するチャットへの最短ルートを知りたい
|
|
5
|
+
summary: QuantumClawをインストールし、数分で最初のチャットを実行しましょう。
|
|
6
|
+
title: はじめに
|
|
7
|
+
x-i18n:
|
|
8
|
+
generated_at: "2026-02-08T17:15:16Z"
|
|
9
|
+
model: claude-opus-4-5
|
|
10
|
+
provider: pi
|
|
11
|
+
source_hash: 27aeeb3d18c495380e94e6b011b0df3def518535c9f1eee504f04871d8a32269
|
|
12
|
+
source_path: start/getting-started.md
|
|
13
|
+
workflow: 15
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
# はじめに
|
|
17
|
+
|
|
18
|
+
目標:ゼロから最小限のセットアップで最初の動作するチャットを実現する。
|
|
19
|
+
|
|
20
|
+
<Info>
|
|
21
|
+
最速のチャット方法:Control UIを開く(チャンネル設定は不要)。`quantumclaw dashboard`を実行してブラウザでチャットするか、<Tooltip headline="Gatewayホスト" tip="QuantumClaw Gatewayサービスを実行しているマシン。">Gatewayホスト</Tooltip>で`http://127.0.0.1:18789/`を開きます。
|
|
22
|
+
ドキュメント:[Dashboard](/web/dashboard)と[Control UI](/web/control-ui)。
|
|
23
|
+
</Info>
|
|
24
|
+
|
|
25
|
+
## 前提条件
|
|
26
|
+
|
|
27
|
+
- Node 22以降
|
|
28
|
+
|
|
29
|
+
<Tip>
|
|
30
|
+
不明な場合は`node --version`でNodeのバージョンを確認してください。
|
|
31
|
+
</Tip>
|
|
32
|
+
|
|
33
|
+
## クイックセットアップ(CLI)
|
|
34
|
+
|
|
35
|
+
<Steps>
|
|
36
|
+
<Step title="QuantumClawをインストール(推奨)">
|
|
37
|
+
<Tabs>
|
|
38
|
+
<Tab title="macOS/Linux">
|
|
39
|
+
```bash
|
|
40
|
+
curl -fsSL https://quantumclaw.ai/install.sh | bash
|
|
41
|
+
```
|
|
42
|
+
</Tab>
|
|
43
|
+
<Tab title="Windows (PowerShell)">
|
|
44
|
+
```powershell
|
|
45
|
+
iwr -useb https://quantumclaw.ai/install.ps1 | iex
|
|
46
|
+
```
|
|
47
|
+
</Tab>
|
|
48
|
+
</Tabs>
|
|
49
|
+
|
|
50
|
+
<Note>
|
|
51
|
+
その他のインストール方法と要件:[インストール](/install)。
|
|
52
|
+
</Note>
|
|
53
|
+
|
|
54
|
+
</Step>
|
|
55
|
+
<Step title="オンボーディングウィザードを実行">
|
|
56
|
+
```bash
|
|
57
|
+
quantumclaw onboard --install-daemon
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
ウィザードは認証、Gateway設定、およびオプションのチャンネルを構成します。
|
|
61
|
+
詳細は[オンボーディングウィザード](/start/wizard)を参照してください。
|
|
62
|
+
|
|
63
|
+
</Step>
|
|
64
|
+
<Step title="Gatewayを確認">
|
|
65
|
+
サービスをインストールした場合、すでに実行されているはずです:
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
quantumclaw gateway status
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
</Step>
|
|
72
|
+
<Step title="Control UIを開く">
|
|
73
|
+
```bash
|
|
74
|
+
quantumclaw dashboard
|
|
75
|
+
```
|
|
76
|
+
</Step>
|
|
77
|
+
</Steps>
|
|
78
|
+
|
|
79
|
+
<Check>
|
|
80
|
+
Control UIが読み込まれれば、Gatewayは使用可能な状態です。
|
|
81
|
+
</Check>
|
|
82
|
+
|
|
83
|
+
## オプションの確認と追加機能
|
|
84
|
+
|
|
85
|
+
<AccordionGroup>
|
|
86
|
+
<Accordion title="Gatewayをフォアグラウンドで実行">
|
|
87
|
+
クイックテストやトラブルシューティングに便利です。
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
quantumclaw gateway --port 18789
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
</Accordion>
|
|
94
|
+
<Accordion title="テストメッセージを送信">
|
|
95
|
+
構成済みのチャンネルが必要です。
|
|
96
|
+
|
|
97
|
+
```bash
|
|
98
|
+
quantumclaw message send --target +15555550123 --message "Hello from QuantumClaw"
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
</Accordion>
|
|
102
|
+
</AccordionGroup>
|
|
103
|
+
|
|
104
|
+
## さらに詳しく
|
|
105
|
+
|
|
106
|
+
<Columns>
|
|
107
|
+
<Card title="オンボーディングウィザード(詳細)" href="/start/wizard">
|
|
108
|
+
完全なCLIウィザードリファレンスと高度なオプション。
|
|
109
|
+
</Card>
|
|
110
|
+
<Card title="macOSアプリのオンボーディング" href="/start/onboarding">
|
|
111
|
+
macOSアプリの初回実行フロー。
|
|
112
|
+
</Card>
|
|
113
|
+
</Columns>
|
|
114
|
+
|
|
115
|
+
## 完了後の状態
|
|
116
|
+
|
|
117
|
+
- 実行中のGateway
|
|
118
|
+
- 構成済みの認証
|
|
119
|
+
- Control UIアクセスまたは接続済みのチャンネル
|
|
120
|
+
|
|
121
|
+
## 次のステップ
|
|
122
|
+
|
|
123
|
+
- DMの安全性と承認:[ペアリング](/channels/pairing)
|
|
124
|
+
- さらにチャンネルを接続:[チャンネル](/channels)
|
|
125
|
+
- 高度なワークフローとソースからのビルド:[セットアップ](/start/setup)
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
---
|
|
2
|
+
read_when:
|
|
3
|
+
- オンボーディングウィザードの実行または設定時
|
|
4
|
+
- 新しいマシンのセットアップ時
|
|
5
|
+
sidebarTitle: Wizard (CLI)
|
|
6
|
+
summary: CLIオンボーディングウィザード:Gateway、ワークスペース、チャンネル、Skillsの対話式セットアップ
|
|
7
|
+
title: オンボーディングウィザード(CLI)
|
|
8
|
+
x-i18n:
|
|
9
|
+
generated_at: "2026-02-08T17:15:18Z"
|
|
10
|
+
model: claude-opus-4-5
|
|
11
|
+
provider: pi
|
|
12
|
+
source_hash: 9a650d46044a930aa4aaec30b35f1273ca3969bf676ab67bf4e1575b5c46db4c
|
|
13
|
+
source_path: start/wizard.md
|
|
14
|
+
workflow: 15
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
# オンボーディングウィザード(CLI)
|
|
18
|
+
|
|
19
|
+
CLIオンボーディングウィザードは、macOS、Linux、Windows(WSL2経由)でQuantumClawをセットアップする際の推奨パスです。ローカルGatewayまたはリモートGateway接続に加えて、ワークスペースのデフォルト設定、チャンネル、Skillsを構成します。
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
quantumclaw onboard
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
<Info>
|
|
26
|
+
最速で初回チャットを開始する方法:Control UI を開きます(チャンネル設定は不要)。`quantumclaw dashboard` を実行してブラウザでチャットできます。ドキュメント:[Dashboard](/web/dashboard)。
|
|
27
|
+
</Info>
|
|
28
|
+
|
|
29
|
+
## クイックスタート vs 詳細設定
|
|
30
|
+
|
|
31
|
+
ウィザードは**クイックスタート**(デフォルト設定)と**詳細設定**(完全な制御)のどちらかを選択して開始します。
|
|
32
|
+
|
|
33
|
+
<Tabs>
|
|
34
|
+
<Tab title="クイックスタート(デフォルト設定)">
|
|
35
|
+
- loopback上のローカルGateway
|
|
36
|
+
- 既存のワークスペースまたはデフォルトワークスペース
|
|
37
|
+
- Gatewayポート `18789`
|
|
38
|
+
- Gateway認証トークンは自動生成(loopback上でも生成されます)
|
|
39
|
+
- Tailscale公開はオフ
|
|
40
|
+
- TelegramとWhatsAppのDMはデフォルトで許可リスト(電話番号の入力を求められる場合があります)
|
|
41
|
+
</Tab>
|
|
42
|
+
<Tab title="詳細設定(完全な制御)">
|
|
43
|
+
- モード、ワークスペース、Gateway、チャンネル、デーモン、Skillsの完全なプロンプトフローを表示
|
|
44
|
+
</Tab>
|
|
45
|
+
</Tabs>
|
|
46
|
+
|
|
47
|
+
## CLIオンボーディングの詳細
|
|
48
|
+
|
|
49
|
+
<Columns>
|
|
50
|
+
<Card title="CLIリファレンス" href="/start/wizard-cli-reference">
|
|
51
|
+
ローカルおよびリモートフローの完全な説明、認証とモデルマトリックス、設定出力、ウィザードRPC、signal-cliの動作。
|
|
52
|
+
</Card>
|
|
53
|
+
<Card title="自動化とスクリプト" href="/start/wizard-cli-automation">
|
|
54
|
+
非対話式オンボーディングのレシピと自動化された `agents add` の例。
|
|
55
|
+
</Card>
|
|
56
|
+
</Columns>
|
|
57
|
+
|
|
58
|
+
## よく使うフォローアップコマンド
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
quantumclaw configure
|
|
62
|
+
quantumclaw agents add <name>
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
<Note>
|
|
66
|
+
`--json` は非対話モードを意味しません。スクリプトでは `--non-interactive` を使用してください。
|
|
67
|
+
</Note>
|
|
68
|
+
|
|
69
|
+
<Tip>
|
|
70
|
+
推奨:エージェントが `web_search` を使用できるように、Brave Search APIキーを設定してください(`web_fetch` はキーなしで動作します)。最も簡単な方法:`quantumclaw configure --section web` を実行すると `plugins.entries.brave.config.webSearch.apiKey` に保存されます。旧 `tools.web.search.apiKey` パスは互換用に引き続き読み込まれますが、新しい設定では使用しないでください。ドキュメント:[Webツール](/tools/web)。
|
|
71
|
+
</Tip>
|
|
72
|
+
|
|
73
|
+
## 関連ドキュメント
|
|
74
|
+
|
|
75
|
+
- CLIコマンドリファレンス:[`quantumclaw onboard`](/cli/onboard)
|
|
76
|
+
- macOSアプリのオンボーディング:[オンボーディング](/start/onboarding)
|
|
77
|
+
- エージェント初回起動の手順:[エージェントブートストラップ](/start/bootstrapping)
|
package/docs/logging.md
ADDED
|
@@ -0,0 +1,352 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "Logging overview: file logs, console output, CLI tailing, and the Control UI"
|
|
3
|
+
read_when:
|
|
4
|
+
- You need a beginner-friendly overview of logging
|
|
5
|
+
- You want to configure log levels or formats
|
|
6
|
+
- You are troubleshooting and need to find logs quickly
|
|
7
|
+
title: "Logging"
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# Logging
|
|
11
|
+
|
|
12
|
+
QuantumClaw logs in two places:
|
|
13
|
+
|
|
14
|
+
- **File logs** (JSON lines) written by the Gateway.
|
|
15
|
+
- **Console output** shown in terminals and the Control UI.
|
|
16
|
+
|
|
17
|
+
This page explains where logs live, how to read them, and how to configure log
|
|
18
|
+
levels and formats.
|
|
19
|
+
|
|
20
|
+
## Where logs live
|
|
21
|
+
|
|
22
|
+
By default, the Gateway writes a rolling log file under:
|
|
23
|
+
|
|
24
|
+
`/tmp/quantumclaw/quantumclaw-YYYY-MM-DD.log`
|
|
25
|
+
|
|
26
|
+
The date uses the gateway host's local timezone.
|
|
27
|
+
|
|
28
|
+
You can override this in `~/.quantumclaw/quantumclaw.json`:
|
|
29
|
+
|
|
30
|
+
```json
|
|
31
|
+
{
|
|
32
|
+
"logging": {
|
|
33
|
+
"file": "/path/to/quantumclaw.log"
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## How to read logs
|
|
39
|
+
|
|
40
|
+
### CLI: live tail (recommended)
|
|
41
|
+
|
|
42
|
+
Use the CLI to tail the gateway log file via RPC:
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
quantumclaw logs --follow
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
Output modes:
|
|
49
|
+
|
|
50
|
+
- **TTY sessions**: pretty, colorized, structured log lines.
|
|
51
|
+
- **Non-TTY sessions**: plain text.
|
|
52
|
+
- `--json`: line-delimited JSON (one log event per line).
|
|
53
|
+
- `--plain`: force plain text in TTY sessions.
|
|
54
|
+
- `--no-color`: disable ANSI colors.
|
|
55
|
+
|
|
56
|
+
In JSON mode, the CLI emits `type`-tagged objects:
|
|
57
|
+
|
|
58
|
+
- `meta`: stream metadata (file, cursor, size)
|
|
59
|
+
- `log`: parsed log entry
|
|
60
|
+
- `notice`: truncation / rotation hints
|
|
61
|
+
- `raw`: unparsed log line
|
|
62
|
+
|
|
63
|
+
If the Gateway is unreachable, the CLI prints a short hint to run:
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
quantumclaw doctor
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### Control UI (web)
|
|
70
|
+
|
|
71
|
+
The Control UI’s **Logs** tab tails the same file using `logs.tail`.
|
|
72
|
+
See [/web/control-ui](/web/control-ui) for how to open it.
|
|
73
|
+
|
|
74
|
+
### Channel-only logs
|
|
75
|
+
|
|
76
|
+
To filter channel activity (WhatsApp/Telegram/etc), use:
|
|
77
|
+
|
|
78
|
+
```bash
|
|
79
|
+
quantumclaw channels logs --channel whatsapp
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
## Log formats
|
|
83
|
+
|
|
84
|
+
### File logs (JSONL)
|
|
85
|
+
|
|
86
|
+
Each line in the log file is a JSON object. The CLI and Control UI parse these
|
|
87
|
+
entries to render structured output (time, level, subsystem, message).
|
|
88
|
+
|
|
89
|
+
### Console output
|
|
90
|
+
|
|
91
|
+
Console logs are **TTY-aware** and formatted for readability:
|
|
92
|
+
|
|
93
|
+
- Subsystem prefixes (e.g. `gateway/channels/whatsapp`)
|
|
94
|
+
- Level coloring (info/warn/error)
|
|
95
|
+
- Optional compact or JSON mode
|
|
96
|
+
|
|
97
|
+
Console formatting is controlled by `logging.consoleStyle`.
|
|
98
|
+
|
|
99
|
+
## Configuring logging
|
|
100
|
+
|
|
101
|
+
All logging configuration lives under `logging` in `~/.quantumclaw/quantumclaw.json`.
|
|
102
|
+
|
|
103
|
+
```json
|
|
104
|
+
{
|
|
105
|
+
"logging": {
|
|
106
|
+
"level": "info",
|
|
107
|
+
"file": "/tmp/quantumclaw/quantumclaw-YYYY-MM-DD.log",
|
|
108
|
+
"consoleLevel": "info",
|
|
109
|
+
"consoleStyle": "pretty",
|
|
110
|
+
"redactSensitive": "tools",
|
|
111
|
+
"redactPatterns": ["sk-.*"]
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
### Log levels
|
|
117
|
+
|
|
118
|
+
- `logging.level`: **file logs** (JSONL) level.
|
|
119
|
+
- `logging.consoleLevel`: **console** verbosity level.
|
|
120
|
+
|
|
121
|
+
You can override both via the **`QUANTUMCLAW_LOG_LEVEL`** environment variable (e.g. `QUANTUMCLAW_LOG_LEVEL=debug`). The env var takes precedence over the config file, so you can raise verbosity for a single run without editing `quantumclaw.json`. You can also pass the global CLI option **`--log-level <level>`** (for example, `quantumclaw --log-level debug gateway run`), which overrides the environment variable for that command.
|
|
122
|
+
|
|
123
|
+
`--verbose` only affects console output; it does not change file log levels.
|
|
124
|
+
|
|
125
|
+
### Console styles
|
|
126
|
+
|
|
127
|
+
`logging.consoleStyle`:
|
|
128
|
+
|
|
129
|
+
- `pretty`: human-friendly, colored, with timestamps.
|
|
130
|
+
- `compact`: tighter output (best for long sessions).
|
|
131
|
+
- `json`: JSON per line (for log processors).
|
|
132
|
+
|
|
133
|
+
### Redaction
|
|
134
|
+
|
|
135
|
+
Tool summaries can redact sensitive tokens before they hit the console:
|
|
136
|
+
|
|
137
|
+
- `logging.redactSensitive`: `off` | `tools` (default: `tools`)
|
|
138
|
+
- `logging.redactPatterns`: list of regex strings to override the default set
|
|
139
|
+
|
|
140
|
+
Redaction affects **console output only** and does not alter file logs.
|
|
141
|
+
|
|
142
|
+
## Diagnostics + OpenTelemetry
|
|
143
|
+
|
|
144
|
+
Diagnostics are structured, machine-readable events for model runs **and**
|
|
145
|
+
message-flow telemetry (webhooks, queueing, session state). They do **not**
|
|
146
|
+
replace logs; they exist to feed metrics, traces, and other exporters.
|
|
147
|
+
|
|
148
|
+
Diagnostics events are emitted in-process, but exporters only attach when
|
|
149
|
+
diagnostics + the exporter plugin are enabled.
|
|
150
|
+
|
|
151
|
+
### OpenTelemetry vs OTLP
|
|
152
|
+
|
|
153
|
+
- **OpenTelemetry (OTel)**: the data model + SDKs for traces, metrics, and logs.
|
|
154
|
+
- **OTLP**: the wire protocol used to export OTel data to a collector/backend.
|
|
155
|
+
- QuantumClaw exports via **OTLP/HTTP (protobuf)** today.
|
|
156
|
+
|
|
157
|
+
### Signals exported
|
|
158
|
+
|
|
159
|
+
- **Metrics**: counters + histograms (token usage, message flow, queueing).
|
|
160
|
+
- **Traces**: spans for model usage + webhook/message processing.
|
|
161
|
+
- **Logs**: exported over OTLP when `diagnostics.otel.logs` is enabled. Log
|
|
162
|
+
volume can be high; keep `logging.level` and exporter filters in mind.
|
|
163
|
+
|
|
164
|
+
### Diagnostic event catalog
|
|
165
|
+
|
|
166
|
+
Model usage:
|
|
167
|
+
|
|
168
|
+
- `model.usage`: tokens, cost, duration, context, provider/model/channel, session ids.
|
|
169
|
+
|
|
170
|
+
Message flow:
|
|
171
|
+
|
|
172
|
+
- `webhook.received`: webhook ingress per channel.
|
|
173
|
+
- `webhook.processed`: webhook handled + duration.
|
|
174
|
+
- `webhook.error`: webhook handler errors.
|
|
175
|
+
- `message.queued`: message enqueued for processing.
|
|
176
|
+
- `message.processed`: outcome + duration + optional error.
|
|
177
|
+
|
|
178
|
+
Queue + session:
|
|
179
|
+
|
|
180
|
+
- `queue.lane.enqueue`: command queue lane enqueue + depth.
|
|
181
|
+
- `queue.lane.dequeue`: command queue lane dequeue + wait time.
|
|
182
|
+
- `session.state`: session state transition + reason.
|
|
183
|
+
- `session.stuck`: session stuck warning + age.
|
|
184
|
+
- `run.attempt`: run retry/attempt metadata.
|
|
185
|
+
- `diagnostic.heartbeat`: aggregate counters (webhooks/queue/session).
|
|
186
|
+
|
|
187
|
+
### Enable diagnostics (no exporter)
|
|
188
|
+
|
|
189
|
+
Use this if you want diagnostics events available to plugins or custom sinks:
|
|
190
|
+
|
|
191
|
+
```json
|
|
192
|
+
{
|
|
193
|
+
"diagnostics": {
|
|
194
|
+
"enabled": true
|
|
195
|
+
}
|
|
196
|
+
}
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
### Diagnostics flags (targeted logs)
|
|
200
|
+
|
|
201
|
+
Use flags to turn on extra, targeted debug logs without raising `logging.level`.
|
|
202
|
+
Flags are case-insensitive and support wildcards (e.g. `telegram.*` or `*`).
|
|
203
|
+
|
|
204
|
+
```json
|
|
205
|
+
{
|
|
206
|
+
"diagnostics": {
|
|
207
|
+
"flags": ["telegram.http"]
|
|
208
|
+
}
|
|
209
|
+
}
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
Env override (one-off):
|
|
213
|
+
|
|
214
|
+
```
|
|
215
|
+
QUANTUMCLAW_DIAGNOSTICS=telegram.http,telegram.payload
|
|
216
|
+
```
|
|
217
|
+
|
|
218
|
+
Notes:
|
|
219
|
+
|
|
220
|
+
- Flag logs go to the standard log file (same as `logging.file`).
|
|
221
|
+
- Output is still redacted according to `logging.redactSensitive`.
|
|
222
|
+
- Full guide: [/diagnostics/flags](/diagnostics/flags).
|
|
223
|
+
|
|
224
|
+
### Export to OpenTelemetry
|
|
225
|
+
|
|
226
|
+
Diagnostics can be exported via the `diagnostics-otel` plugin (OTLP/HTTP). This
|
|
227
|
+
works with any OpenTelemetry collector/backend that accepts OTLP/HTTP.
|
|
228
|
+
|
|
229
|
+
```json
|
|
230
|
+
{
|
|
231
|
+
"plugins": {
|
|
232
|
+
"allow": ["diagnostics-otel"],
|
|
233
|
+
"entries": {
|
|
234
|
+
"diagnostics-otel": {
|
|
235
|
+
"enabled": true
|
|
236
|
+
}
|
|
237
|
+
}
|
|
238
|
+
},
|
|
239
|
+
"diagnostics": {
|
|
240
|
+
"enabled": true,
|
|
241
|
+
"otel": {
|
|
242
|
+
"enabled": true,
|
|
243
|
+
"endpoint": "http://otel-collector:4318",
|
|
244
|
+
"protocol": "http/protobuf",
|
|
245
|
+
"serviceName": "quantumclaw-gateway",
|
|
246
|
+
"traces": true,
|
|
247
|
+
"metrics": true,
|
|
248
|
+
"logs": true,
|
|
249
|
+
"sampleRate": 0.2,
|
|
250
|
+
"flushIntervalMs": 60000
|
|
251
|
+
}
|
|
252
|
+
}
|
|
253
|
+
}
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
Notes:
|
|
257
|
+
|
|
258
|
+
- You can also enable the plugin with `quantumclaw plugins enable diagnostics-otel`.
|
|
259
|
+
- `protocol` currently supports `http/protobuf` only. `grpc` is ignored.
|
|
260
|
+
- Metrics include token usage, cost, context size, run duration, and message-flow
|
|
261
|
+
counters/histograms (webhooks, queueing, session state, queue depth/wait).
|
|
262
|
+
- Traces/metrics can be toggled with `traces` / `metrics` (default: on). Traces
|
|
263
|
+
include model usage spans plus webhook/message processing spans when enabled.
|
|
264
|
+
- Set `headers` when your collector requires auth.
|
|
265
|
+
- Environment variables supported: `OTEL_EXPORTER_OTLP_ENDPOINT`,
|
|
266
|
+
`OTEL_SERVICE_NAME`, `OTEL_EXPORTER_OTLP_PROTOCOL`.
|
|
267
|
+
|
|
268
|
+
### Exported metrics (names + types)
|
|
269
|
+
|
|
270
|
+
Model usage:
|
|
271
|
+
|
|
272
|
+
- `quantumclaw.tokens` (counter, attrs: `quantumclaw.token`, `quantumclaw.channel`,
|
|
273
|
+
`quantumclaw.provider`, `quantumclaw.model`)
|
|
274
|
+
- `quantumclaw.cost.usd` (counter, attrs: `quantumclaw.channel`, `quantumclaw.provider`,
|
|
275
|
+
`quantumclaw.model`)
|
|
276
|
+
- `quantumclaw.run.duration_ms` (histogram, attrs: `quantumclaw.channel`,
|
|
277
|
+
`quantumclaw.provider`, `quantumclaw.model`)
|
|
278
|
+
- `quantumclaw.context.tokens` (histogram, attrs: `quantumclaw.context`,
|
|
279
|
+
`quantumclaw.channel`, `quantumclaw.provider`, `quantumclaw.model`)
|
|
280
|
+
|
|
281
|
+
Message flow:
|
|
282
|
+
|
|
283
|
+
- `quantumclaw.webhook.received` (counter, attrs: `quantumclaw.channel`,
|
|
284
|
+
`quantumclaw.webhook`)
|
|
285
|
+
- `quantumclaw.webhook.error` (counter, attrs: `quantumclaw.channel`,
|
|
286
|
+
`quantumclaw.webhook`)
|
|
287
|
+
- `quantumclaw.webhook.duration_ms` (histogram, attrs: `quantumclaw.channel`,
|
|
288
|
+
`quantumclaw.webhook`)
|
|
289
|
+
- `quantumclaw.message.queued` (counter, attrs: `quantumclaw.channel`,
|
|
290
|
+
`quantumclaw.source`)
|
|
291
|
+
- `quantumclaw.message.processed` (counter, attrs: `quantumclaw.channel`,
|
|
292
|
+
`quantumclaw.outcome`)
|
|
293
|
+
- `quantumclaw.message.duration_ms` (histogram, attrs: `quantumclaw.channel`,
|
|
294
|
+
`quantumclaw.outcome`)
|
|
295
|
+
|
|
296
|
+
Queues + sessions:
|
|
297
|
+
|
|
298
|
+
- `quantumclaw.queue.lane.enqueue` (counter, attrs: `quantumclaw.lane`)
|
|
299
|
+
- `quantumclaw.queue.lane.dequeue` (counter, attrs: `quantumclaw.lane`)
|
|
300
|
+
- `quantumclaw.queue.depth` (histogram, attrs: `quantumclaw.lane` or
|
|
301
|
+
`quantumclaw.channel=heartbeat`)
|
|
302
|
+
- `quantumclaw.queue.wait_ms` (histogram, attrs: `quantumclaw.lane`)
|
|
303
|
+
- `quantumclaw.session.state` (counter, attrs: `quantumclaw.state`, `quantumclaw.reason`)
|
|
304
|
+
- `quantumclaw.session.stuck` (counter, attrs: `quantumclaw.state`)
|
|
305
|
+
- `quantumclaw.session.stuck_age_ms` (histogram, attrs: `quantumclaw.state`)
|
|
306
|
+
- `quantumclaw.run.attempt` (counter, attrs: `quantumclaw.attempt`)
|
|
307
|
+
|
|
308
|
+
### Exported spans (names + key attributes)
|
|
309
|
+
|
|
310
|
+
- `quantumclaw.model.usage`
|
|
311
|
+
- `quantumclaw.channel`, `quantumclaw.provider`, `quantumclaw.model`
|
|
312
|
+
- `quantumclaw.sessionKey`, `quantumclaw.sessionId`
|
|
313
|
+
- `quantumclaw.tokens.*` (input/output/cache_read/cache_write/total)
|
|
314
|
+
- `quantumclaw.webhook.processed`
|
|
315
|
+
- `quantumclaw.channel`, `quantumclaw.webhook`, `quantumclaw.chatId`
|
|
316
|
+
- `quantumclaw.webhook.error`
|
|
317
|
+
- `quantumclaw.channel`, `quantumclaw.webhook`, `quantumclaw.chatId`,
|
|
318
|
+
`quantumclaw.error`
|
|
319
|
+
- `quantumclaw.message.processed`
|
|
320
|
+
- `quantumclaw.channel`, `quantumclaw.outcome`, `quantumclaw.chatId`,
|
|
321
|
+
`quantumclaw.messageId`, `quantumclaw.sessionKey`, `quantumclaw.sessionId`,
|
|
322
|
+
`quantumclaw.reason`
|
|
323
|
+
- `quantumclaw.session.stuck`
|
|
324
|
+
- `quantumclaw.state`, `quantumclaw.ageMs`, `quantumclaw.queueDepth`,
|
|
325
|
+
`quantumclaw.sessionKey`, `quantumclaw.sessionId`
|
|
326
|
+
|
|
327
|
+
### Sampling + flushing
|
|
328
|
+
|
|
329
|
+
- Trace sampling: `diagnostics.otel.sampleRate` (0.0–1.0, root spans only).
|
|
330
|
+
- Metric export interval: `diagnostics.otel.flushIntervalMs` (min 1000ms).
|
|
331
|
+
|
|
332
|
+
### Protocol notes
|
|
333
|
+
|
|
334
|
+
- OTLP/HTTP endpoints can be set via `diagnostics.otel.endpoint` or
|
|
335
|
+
`OTEL_EXPORTER_OTLP_ENDPOINT`.
|
|
336
|
+
- If the endpoint already contains `/v1/traces` or `/v1/metrics`, it is used as-is.
|
|
337
|
+
- If the endpoint already contains `/v1/logs`, it is used as-is for logs.
|
|
338
|
+
- `diagnostics.otel.logs` enables OTLP log export for the main logger output.
|
|
339
|
+
|
|
340
|
+
### Log export behavior
|
|
341
|
+
|
|
342
|
+
- OTLP logs use the same structured records written to `logging.file`.
|
|
343
|
+
- Respect `logging.level` (file log level). Console redaction does **not** apply
|
|
344
|
+
to OTLP logs.
|
|
345
|
+
- High-volume installs should prefer OTLP collector sampling/filtering.
|
|
346
|
+
|
|
347
|
+
## Troubleshooting tips
|
|
348
|
+
|
|
349
|
+
- **Gateway not reachable?** Run `quantumclaw doctor` first.
|
|
350
|
+
- **Logs empty?** Check that the Gateway is running and writing to the file path
|
|
351
|
+
in `logging.file`.
|
|
352
|
+
- **Need more detail?** Set `logging.level` to `debug` or `trace` and retry.
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
(() => {
|
|
2
|
+
const NAV_TABS_SELECTOR = ".nav-tabs";
|
|
3
|
+
const ACTIVE_UNDERLINE_SELECTOR = ".nav-tabs-item > div.bg-primary";
|
|
4
|
+
const UNDERLINE_CLASS = "nav-tabs-underline";
|
|
5
|
+
const READY_CLASS = "nav-tabs-underline-ready";
|
|
6
|
+
|
|
7
|
+
let navTabs = null;
|
|
8
|
+
let navTabsObserver = null;
|
|
9
|
+
let lastX = null;
|
|
10
|
+
let lastWidth = null;
|
|
11
|
+
|
|
12
|
+
const ensureUnderline = (tabs) => {
|
|
13
|
+
let underline = tabs.querySelector(`.${UNDERLINE_CLASS}`);
|
|
14
|
+
if (!underline) {
|
|
15
|
+
underline = document.createElement("div");
|
|
16
|
+
underline.className = UNDERLINE_CLASS;
|
|
17
|
+
tabs.appendChild(underline);
|
|
18
|
+
}
|
|
19
|
+
return underline;
|
|
20
|
+
};
|
|
21
|
+
|
|
22
|
+
const getActiveTab = (tabs) => {
|
|
23
|
+
const activeUnderline = tabs.querySelector(ACTIVE_UNDERLINE_SELECTOR);
|
|
24
|
+
return activeUnderline?.closest(".nav-tabs-item") ?? null;
|
|
25
|
+
};
|
|
26
|
+
|
|
27
|
+
const updateUnderline = () => {
|
|
28
|
+
if (!navTabs) {
|
|
29
|
+
return;
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
ensureUnderline(navTabs);
|
|
33
|
+
|
|
34
|
+
const activeTab = getActiveTab(navTabs);
|
|
35
|
+
if (!activeTab) {
|
|
36
|
+
navTabs.classList.remove(READY_CLASS);
|
|
37
|
+
return;
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
const navRect = navTabs.getBoundingClientRect();
|
|
41
|
+
const tabRect = activeTab.getBoundingClientRect();
|
|
42
|
+
const left = tabRect.left - navRect.left;
|
|
43
|
+
|
|
44
|
+
navTabs.style.setProperty("--nav-tab-underline-x", `${left}px`);
|
|
45
|
+
navTabs.style.setProperty("--nav-tab-underline-width", `${tabRect.width}px`);
|
|
46
|
+
navTabs.classList.add(READY_CLASS);
|
|
47
|
+
|
|
48
|
+
lastX = left;
|
|
49
|
+
lastWidth = tabRect.width;
|
|
50
|
+
};
|
|
51
|
+
|
|
52
|
+
const scheduleUpdate = () => {
|
|
53
|
+
requestAnimationFrame(updateUnderline);
|
|
54
|
+
};
|
|
55
|
+
|
|
56
|
+
const setupNavTabsObserver = (tabs) => {
|
|
57
|
+
if (!tabs || tabs === navTabs) {
|
|
58
|
+
return;
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
navTabs = tabs;
|
|
62
|
+
ensureUnderline(navTabs);
|
|
63
|
+
if (lastX !== null && lastWidth !== null) {
|
|
64
|
+
navTabs.style.setProperty("--nav-tab-underline-x", `${lastX}px`);
|
|
65
|
+
navTabs.style.setProperty("--nav-tab-underline-width", `${lastWidth}px`);
|
|
66
|
+
navTabs.classList.add(READY_CLASS);
|
|
67
|
+
}
|
|
68
|
+
navTabsObserver?.disconnect();
|
|
69
|
+
navTabsObserver = new MutationObserver(scheduleUpdate);
|
|
70
|
+
navTabsObserver.observe(navTabs, {
|
|
71
|
+
subtree: true,
|
|
72
|
+
attributes: true,
|
|
73
|
+
attributeFilter: ["class"],
|
|
74
|
+
});
|
|
75
|
+
|
|
76
|
+
scheduleUpdate();
|
|
77
|
+
};
|
|
78
|
+
|
|
79
|
+
const setupObservers = () => {
|
|
80
|
+
const tabs = document.querySelector(NAV_TABS_SELECTOR);
|
|
81
|
+
if (tabs) {
|
|
82
|
+
setupNavTabsObserver(tabs);
|
|
83
|
+
}
|
|
84
|
+
};
|
|
85
|
+
|
|
86
|
+
const rootObserver = new MutationObserver(setupObservers);
|
|
87
|
+
|
|
88
|
+
if (document.readyState === "loading") {
|
|
89
|
+
document.addEventListener("DOMContentLoaded", () => {
|
|
90
|
+
setupObservers();
|
|
91
|
+
rootObserver.observe(document.body, { childList: true, subtree: true });
|
|
92
|
+
});
|
|
93
|
+
} else {
|
|
94
|
+
setupObservers();
|
|
95
|
+
rootObserver.observe(document.body, { childList: true, subtree: true });
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
window.addEventListener("resize", scheduleUpdate);
|
|
99
|
+
void document.fonts?.ready?.then(scheduleUpdate, () => {});
|
|
100
|
+
})();
|