You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
gpt-pilot/docs/docs.json

2163 lines
61 KiB
JSON

{
"$schema": "https://mintlify.com/docs.json",
"name": "OpenClaw",
"description": "Self-hosted gateway that connects Discord, Google Chat, iMessage, Matrix, Microsoft Teams, Signal, Slack, Telegram, WhatsApp, Zalo, and more to AI coding agents. Run one Gateway process on your own machine and message your AI assistant from anywhere.",
"theme": "mint",
"icons": {
"library": "lucide"
},
"logo": {
"light": "/assets/pixel-lobster.svg",
"dark": "/assets/pixel-lobster.svg"
},
"fonts": {
"body": {
"family": "Fragment Mono"
},
"heading": {
"family": "DM Sans"
}
},
"favicon": "/assets/pixel-lobster.svg",
"colors": {
"primary": "#FF5A36",
"dark": "#FF5A36",
"light": "#FF8A6B"
},
"styling": {
"codeblocks": {
"theme": {
"dark": "min-dark",
"light": "min-light"
}
}
},
"navbar": {
"links": [
{
"label": "GitHub",
"href": "https://github.com/openclaw/openclaw",
"icon": "github"
},
{
"label": "Releases",
"href": "https://github.com/openclaw/openclaw/releases",
"icon": "package"
},
{
"label": "Discord",
"href": "https://discord.com/invite/clawd",
"icon": "discord"
}
]
},
"redirects": [
{
"source": "/providers/modelstudio",
"destination": "/providers/qwen_modelstudio"
},
{
"source": "/platforms/oracle",
"destination": "/install/oracle"
},
{
"source": "/platforms/digitalocean",
"destination": "/install/digitalocean"
},
{
"source": "/platforms/raspberry-pi",
"destination": "/install/raspberry-pi"
},
{
"source": "/plugins/building-extensions",
"destination": "/plugins/building-plugins"
},
{
"source": "/plugins/agent-tools",
"destination": "/plugins/building-plugins#registering-agent-tools"
},
{
"source": "/tools/capability-cookbook",
"destination": "/plugins/architecture"
},
{
"source": "/brave-search",
"destination": "/tools/brave-search"
},
{
"source": "/perplexity",
"destination": "/tools/perplexity-search"
},
{
"source": "/web-fetch",
"destination": "/tools/web-fetch"
},
{
"source": "/duckduckgo-search",
"destination": "/tools/duckduckgo-search"
},
{
"source": "/exa-search",
"destination": "/tools/exa-search"
},
{
"source": "/gemini-search",
"destination": "/tools/gemini-search"
},
{
"source": "/grok-search",
"destination": "/tools/grok-search"
},
{
"source": "/kimi-search",
"destination": "/tools/kimi-search"
},
{
"source": "/tts",
"destination": "/tools/tts"
},
{
"source": "/messages",
"destination": "/concepts/messages"
},
{
"source": "/context",
"destination": "/concepts/context"
},
{
"source": "/compaction",
"destination": "/concepts/compaction"
},
{
"source": "/context-engine",
"destination": "/concepts/context-engine"
},
{
"source": "/cron",
"destination": "/automation/cron-jobs"
},
{
"source": "/minimax",
"destination": "/providers/minimax"
},
{
"source": "/xiaomi",
"destination": "/providers/xiaomi"
},
{
"source": "/openai",
"destination": "/providers/openai"
},
{
"source": "/openai/",
"destination": "/providers/openai"
},
{
"source": "/anthropic",
"destination": "/providers/anthropic"
},
{
"source": "/anthropic/",
"destination": "/providers/anthropic"
},
{
"source": "/moonshot",
"destination": "/providers/moonshot"
},
{
"source": "/mistral",
"destination": "/providers/mistral"
},
{
"source": "/openrouter",
"destination": "/providers/openrouter"
},
{
"source": "/opencode",
"destination": "/providers/opencode"
},
{
"source": "/opencode-go",
"destination": "/providers/opencode-go"
},
10 months ago
{
"source": "/qianfan",
"destination": "/providers/qianfan"
},
{
"source": "/mattermost",
"destination": "/channels/mattermost"
},
{
"source": "/line",
"destination": "/channels/line"
},
{
"source": "/glm",
"destination": "/providers/glm"
},
{
"source": "/zai",
"destination": "/providers/zai"
},
{
"source": "/message",
"destination": "/cli/message"
},
{
"source": "/providers/discord",
"destination": "/channels/discord"
},
{
"source": "/providers/googlechat",
"destination": "/channels/googlechat"
},
{
"source": "/providers/grammy",
"destination": "/channels/telegram"
},
{
"source": "/providers/imessage",
"destination": "/channels/imessage"
},
{
"source": "/providers/location",
"destination": "/channels/location"
},
{
"source": "/providers/mattermost",
"destination": "/channels/mattermost"
},
{
"source": "/providers/msteams",
"destination": "/channels/msteams"
},
{
"source": "/providers/line",
"destination": "/channels/line"
},
{
"source": "/providers/signal",
"destination": "/channels/signal"
},
{
"source": "/providers/slack",
"destination": "/channels/slack"
},
{
"source": "/providers/telegram",
"destination": "/channels/telegram"
},
{
"source": "/providers/troubleshooting",
"destination": "/channels/troubleshooting"
},
{
"source": "/providers/zalo",
"destination": "/channels/zalo"
},
{
"source": "/providers/whatsapp",
"destination": "/channels/whatsapp"
},
{
"source": "/sandbox",
"destination": "/cli/sandbox"
},
{
"source": "/sandboxing",
"destination": "/gateway/sandboxing"
},
{
"source": "/AGENTS.default",
"destination": "/reference/AGENTS.default"
},
{
"source": "/RELEASING",
"destination": "/reference/RELEASING"
},
{
"source": "/agent",
"destination": "/concepts/agent"
},
{
"source": "/agent-loop",
"destination": "/concepts/agent-loop"
},
{
"source": "/agent-send",
"destination": "/tools/agent-send"
},
{
"source": "/agent-workspace",
"destination": "/concepts/agent-workspace"
},
{
"source": "/android",
"destination": "/platforms/android"
},
{
"source": "/architecture",
"destination": "/concepts/architecture"
},
{
"source": "/audio",
"destination": "/nodes/audio"
},
{
"source": "/background-process",
"destination": "/gateway/background-process"
},
{
"source": "/bash",
"destination": "/tools/exec"
},
{
"source": "/tools/bash",
"destination": "/tools/exec"
},
{
"source": "/bonjour",
"destination": "/gateway/bonjour"
},
{
"source": "/browser",
"destination": "/tools/browser"
},
{
"source": "/browser-linux-troubleshooting",
"destination": "/tools/browser-linux-troubleshooting"
},
{
"source": "/bun",
"destination": "/install/bun"
},
{
"source": "/auth-monitoring",
"destination": "/gateway/authentication"
},
{
"source": "/camera",
"destination": "/nodes/camera"
},
{
"source": "/clawd",
"destination": "/start/openclaw"
},
{
"source": "/start/clawd",
"destination": "/start/openclaw"
},
{
"source": "/start/clawd/",
"destination": "/start/openclaw"
},
{
"source": "/start/pairing",
"destination": "/channels/pairing"
},
{
"source": "/clawhub",
"destination": "/tools/clawhub"
},
{
"source": "/clawdhub",
"destination": "/tools/clawhub"
},
{
"source": "/tools/clawdhub",
"destination": "/tools/clawhub"
},
{
"source": "/configuration",
"destination": "/gateway/configuration"
},
{
"source": "/control-ui",
"destination": "/web/control-ui"
},
{
"source": "/cron-jobs",
"destination": "/automation/cron-jobs"
},
{
"source": "/cron-vs-heartbeat",
"destination": "/automation"
},
{
"source": "/dashboard",
"destination": "/web/dashboard"
},
{
"source": "/device-models",
"destination": "/reference/device-models"
},
{
"source": "/discord",
"destination": "/channels/discord"
},
{
"source": "/discovery",
"destination": "/gateway/discovery"
},
{
"source": "/docker",
"destination": "/install/docker"
},
{
"source": "/podman",
"destination": "/install/podman"
},
{
"source": "/doctor",
"destination": "/gateway/doctor"
},
{
"source": "/elevated",
"destination": "/tools/elevated"
},
{
"source": "/faq",
"destination": "/help/faq"
},
{
"source": "/gateway-lock",
"destination": "/gateway/gateway-lock"
},
{
"source": "/getting-started",
"destination": "/start/getting-started"
},
{
"source": "/quickstart",
"destination": "/start/getting-started"
},
{
"source": "/start/quickstart",
"destination": "/start/getting-started"
},
{
"source": "/gmail-pubsub",
"destination": "/automation/cron-jobs"
},
{
"source": "/grammy",
"destination": "/channels/telegram"
},
{
"source": "/channels/grammy",
"destination": "/channels/telegram"
},
{
"source": "/group-messages",
"destination": "/channels/group-messages"
},
{
"source": "/groups",
"destination": "/channels/groups"
},
{
"source": "/health",
"destination": "/gateway/health"
},
{
"source": "/heartbeat",
"destination": "/gateway/heartbeat"
},
{
"source": "/hubs",
"destination": "/start/hubs"
},
{
"source": "/images",
"destination": "/nodes/images"
},
{
"source": "/imessage",
"destination": "/channels/imessage"
},
{
"source": "/ios",
"destination": "/platforms/ios"
},
{
"source": "/linux",
"destination": "/platforms/linux"
},
{
"source": "/location",
"destination": "/channels/location"
},
{
"source": "/location-command",
"destination": "/nodes/location-command"
},
{
"source": "/lore",
"destination": "/start/lore"
},
{
"source": "/mac/bun",
"destination": "/platforms/mac/bundled-gateway"
},
{
"source": "/platforms/mac/bun",
"destination": "/platforms/mac/bundled-gateway"
},
{
"source": "/mac/canvas",
"destination": "/platforms/mac/canvas"
},
{
"source": "/mac/child-process",
"destination": "/platforms/mac/child-process"
},
{
"source": "/mac/dev-setup",
"destination": "/platforms/mac/dev-setup"
},
{
"source": "/mac/health",
"destination": "/platforms/mac/health"
},
{
"source": "/mac/icon",
"destination": "/platforms/mac/icon"
},
{
"source": "/mac/logging",
"destination": "/platforms/mac/logging"
},
{
"source": "/mac/menu-bar",
"destination": "/platforms/mac/menu-bar"
},
{
"source": "/mac/peekaboo",
"destination": "/platforms/mac/peekaboo"
},
{
"source": "/mac/permissions",
"destination": "/platforms/mac/permissions"
},
{
"source": "/mac/release",
"destination": "/reference/RELEASING"
},
{
"source": "/mac/remote",
"destination": "/platforms/mac/remote"
},
{
"source": "/mac/signing",
"destination": "/platforms/mac/signing"
},
{
"source": "/mac/skills",
"destination": "/platforms/mac/skills"
},
{
"source": "/mac/voice-overlay",
"destination": "/platforms/mac/voice-overlay"
},
{
"source": "/mac/voicewake",
"destination": "/platforms/mac/voicewake"
},
{
"source": "/mac/webchat",
"destination": "/platforms/mac/webchat"
},
{
"source": "/mac/xpc",
"destination": "/platforms/mac/xpc"
},
{
"source": "/macos",
"destination": "/platforms/macos"
},
{
"source": "/model-failover",
"destination": "/concepts/model-failover"
},
{
"source": "/model",
"destination": "/concepts/models"
},
{
"source": "/model/",
"destination": "/concepts/models"
},
{
"source": "/models",
"destination": "/concepts/models"
},
{
"source": "/multi-agent",
"destination": "/concepts/multi-agent"
},
{
"source": "/nix",
"destination": "/install/nix"
},
{
"source": "/onboarding",
"destination": "/start/onboarding"
},
{
"source": "/pairing",
"destination": "/channels/pairing"
},
{
"source": "/experiments/plans/cron-add-hardening",
"destination": "/automation/cron-jobs"
},
{
"source": "/experiments/plans/group-policy-hardening",
"destination": "/channels/groups"
},
{
"source": "/poll",
"destination": "/cli/message"
},
{
"source": "/presence",
"destination": "/concepts/presence"
},
{
"source": "/provider-routing",
"destination": "/channels/channel-routing"
},
{
"source": "/concepts/provider-routing",
"destination": "/channels/channel-routing"
},
{
"source": "/queue",
"destination": "/concepts/queue"
},
{
"source": "/remote",
"destination": "/gateway/remote"
},
{
"source": "/remote-gateway-readme",
"destination": "/gateway/remote-gateway-readme"
},
{
"source": "/rpc",
"destination": "/reference/rpc"
},
{
"source": "/security",
"destination": "/gateway/security"
},
{
"source": "/session",
"destination": "/concepts/session"
},
{
"source": "/session-tool",
"destination": "/concepts/session-tool"
},
{
"source": "/sessions",
"destination": "/concepts/session"
},
{
"source": "/setup",
"destination": "/start/setup"
},
{
"source": "/showcase",
"destination": "/start/showcase"
},
{
"source": "/signal",
"destination": "/channels/signal"
},
{
"source": "/skills",
"destination": "/tools/skills"
},
{
"source": "/skills-config",
"destination": "/tools/skills-config"
},
{
"source": "/slack",
"destination": "/channels/slack"
},
{
"source": "/slash-commands",
"destination": "/tools/slash-commands"
},
{
"source": "/subagents",
"destination": "/tools/subagents"
},
{
"source": "/tailscale",
"destination": "/gateway/tailscale"
},
{
"source": "/talk",
"destination": "/nodes/talk"
},
{
"source": "/telegram",
"destination": "/channels/telegram"
},
{
"source": "/templates/AGENTS",
"destination": "/reference/templates/AGENTS"
},
{
"source": "/templates/BOOT",
"destination": "/reference/templates/BOOT"
},
{
"source": "/templates/BOOTSTRAP",
"destination": "/reference/templates/BOOTSTRAP"
},
{
"source": "/templates/HEARTBEAT",
"destination": "/reference/templates/HEARTBEAT"
},
{
"source": "/templates/IDENTITY",
"destination": "/reference/templates/IDENTITY"
},
{
"source": "/templates/SOUL",
"destination": "/reference/templates/SOUL"
},
{
"source": "/templates/TOOLS",
"destination": "/reference/templates/TOOLS"
},
{
"source": "/templates/USER",
"destination": "/reference/templates/USER"
},
{
"source": "/test",
"destination": "/reference/test"
},
{
"source": "/thinking",
"destination": "/tools/thinking"
},
{
"source": "/timezone",
"destination": "/concepts/timezone"
},
{
"source": "/troubleshooting",
"destination": "/help/troubleshooting"
},
{
"source": "/tui",
"destination": "/web/tui"
},
{
"source": "/typebox",
"destination": "/concepts/typebox"
},
{
"source": "/updating",
"destination": "/install/updating"
},
{
"source": "/voicewake",
"destination": "/nodes/voicewake"
},
{
"source": "/webchat",
"destination": "/web/webchat"
},
{
"source": "/webhook",
"destination": "/automation/cron-jobs"
},
{
"source": "/whatsapp",
"destination": "/channels/whatsapp"
},
{
"source": "/windows",
"destination": "/platforms/windows"
},
{
"source": "/wizard",
"destination": "/start/wizard"
},
{
"source": "/start/wizard-cli-flow",
"destination": "/start/wizard-cli-reference"
},
{
"source": "/start/wizard-cli-auth",
"destination": "/start/wizard-cli-reference"
},
{
"source": "/start/wizard-cli-outputs",
"destination": "/start/wizard-cli-reference"
},
{
"source": "/start/faq",
"destination": "/help/faq"
},
{
"source": "/oauth",
"destination": "/concepts/oauth"
},
{
"source": "/plugin",
"destination": "/tools/plugin"
},
{
"source": "/plugins",
"destination": "/tools/plugin"
},
{
"source": "/railway",
"destination": "/install/railway"
},
{
"source": "/northflank",
"destination": "/install/northflank"
},
{
"source": "/render",
"destination": "/install/render"
},
{
"source": "/gcp",
"destination": "/install/gcp"
},
{
"source": "/azure",
"destination": "/install/azure"
},
{
"source": "/platforms/fly",
"destination": "/install/fly"
},
{
"source": "/platforms/hetzner",
"destination": "/install/hetzner"
},
{
"source": "/platforms/gcp",
"destination": "/install/gcp"
},
{
"source": "/platforms/azure",
"destination": "/install/azure"
},
{
"source": "/platforms/macos-vm",
"destination": "/install/macos-vm"
},
{
"source": "/platforms/exe-dev",
"destination": "/install/exe-dev"
},
{
"source": "/platforms/railway",
"destination": "/install/railway"
},
{
"source": "/platforms/render",
"destination": "/install/render"
},
{
"source": "/platforms/northflank",
"destination": "/install/northflank"
},
{
"source": "/gateway/trusted-proxy",
"destination": "/gateway/trusted-proxy-auth"
},
{
"source": "/automation/clawflow",
"destination": "/automation/taskflow"
},
{
"source": "/automation/poll",
"destination": "/cli/message"
},
{
"source": "/automation/auth-monitoring",
"destination": "/gateway/authentication"
},
{
"source": "/automation/troubleshooting",
"destination": "/automation/cron-jobs"
},
{
"source": "/automation/cron-vs-heartbeat",
"destination": "/automation"
},
{
"source": "/automation/webhook",
"destination": "/automation/cron-jobs"
},
{
"source": "/automation/gmail-pubsub",
"destination": "/automation/cron-jobs"
}
],
"navigation": {
"languages": [
{
"language": "en",
"tabs": [
{
"tab": "Get started",
"groups": [
{
"group": "Overview",
"pages": ["index", "start/showcase", "concepts/features"]
},
{
"group": "First steps",
"pages": [
"start/getting-started",
"start/onboarding-overview",
"start/wizard",
"start/onboarding"
]
},
{
"group": "Guides",
"pages": [
"start/openclaw",
"start/wizard-cli-reference",
"start/wizard-cli-automation"
]
}
]
},
{
"tab": "Install",
"groups": [
{
"group": "Install overview",
"pages": ["install/index", "install/installer", "install/node"]
},
{
"group": "Containers",
"pages": [
"install/ansible",
"install/bun",
"install/clawdock",
"install/docker",
"install/nix",
"install/podman"
]
},
{
"group": "Hosting",
"pages": [
"install/azure",
"install/digitalocean",
"install/docker-vm-runtime",
"install/exe-dev",
"install/fly",
"install/gcp",
"install/hetzner",
"install/kubernetes",
"vps",
"install/macos-vm",
"install/northflank",
"install/oracle",
"install/railway",
"install/raspberry-pi",
"install/render"
]
},
{
"group": "Maintenance",
"pages": [
"install/updating",
"install/migrating",
"install/migrating-matrix",
"install/uninstall",
"install/development-channels"
]
}
]
},
{
"tab": "Channels",
"groups": [
{
"group": "Overview",
"pages": ["channels/index"]
},
{
"group": "Messaging platforms",
"pages": [
"channels/bluebubbles",
"channels/discord",
"channels/feishu",
"channels/googlechat",
"channels/imessage",
"channels/irc",
"channels/line",
"channels/matrix",
"channels/mattermost",
"channels/msteams",
"channels/nextcloud-talk",
"channels/nostr",
Feature/add qq channel (#52986) * feat: add QQ Bot channel extension * fix(qqbot): add setupWizard to runtime plugin for onboard re-entry * fix: fix review * fix: fix review * chore: sync lockfile and config-docs baseline for qqbot extension * refactor: 移除图床服务器相关代码 * fix * docs: 新增 QQ Bot 插件文档并修正链接路径 * refactor: remove credential backup functionality and update setup logic - Deleted the credential backup module to streamline the codebase. - Updated the setup surface to handle client secrets more robustly, allowing for configured secret inputs. - Simplified slash commands by removing unused hot upgrade compatibility checks and related functions. - Adjusted types to use SecretInput for client secrets in QQBot configuration. - Modified bundled plugin metadata to allow additional properties in the config schema. * feat: 添加本地媒体路径解析功能,修正 QQBot 媒体路径处理 * feat: 添加本地媒体路径解析功能,修正 QQBot 媒体路径处理 * feat: remove qqbot-media and qqbot-remind skills, add tests for config and setup - Deleted the qqbot-media and qqbot-remind skills documentation files. - Added unit tests for qqbot configuration and setup processes, ensuring proper handling of SecretRef-backed credentials and account configurations. - Implemented tests for local media path remapping, verifying correct resolution of media file paths. - Removed obsolete channel and remind tools, streamlining the codebase. * feat: 更新 QQBot 配置模式,添加音频格式和账户定义 * feat: 添加 QQBot 频道管理和定时提醒技能,更新媒体路径解析功能 * fix * feat: 添加 /bot-upgrade 指令以查看 QQBot 插件升级指引 * feat: update reminder and qq channel skills * feat: 更新remind工具投递目标地址格式 * feat: Refactor QQBot payload handling and improve code documentation - Simplified and clarified the structure of payload interfaces for Cron reminders and media messages. - Enhanced the parsing function to provide clearer error messages and improved validation. - Updated platform utility functions for better cross-platform compatibility and clearer documentation. - Improved text parsing utilities for better readability and consistency in emoji representation. - Optimized upload cache management with clearer comments and reduced redundancy. - Integrated QQBot plugin into the bundled channel plugins and updated metadata for installation. * OK apps/macos/Sources/OpenClaw/HostEnvSecurityPolicy.generated.swift > openclaw@2026.3.26 check:bundled-channel-config-metadata /Users/yuehuali/code/PR/openclaw > node --import tsx scripts/generate-bundled-channel-config-metadata.ts --check [bundled-channel-config-metadata] stale generated output at src/config/bundled-channel-config-metadata.generated.ts  ELIFECYCLE  Command failed with exit code 1.  ELIFECYCLE  Command failed with exit code 1. * feat: 添加 QQBot 渠道配置及相关账户设置 * fix(qqbot): resolve 14 high-priority bugs from PR #52986 review DM routing (7 fixes): - #1: DM slash-command replies use sendDmMessage(guildId) instead of sendC2CMessage(senderId) - #2: DM qualifiedTarget uses qqbot:dm:${guildId} instead of qqbot:c2c:${senderId} - #3: sendTextChunks adds DM branch - #4: sendMarkdownReply adds DM branch for text and Base64 images - #5: parseAndSendMediaTags maps DM to targetType:dm + guildId - #6: sendTextToTarget DM branch uses sendDmMessage; MessageTarget adds guildId field - #7: handleImage/Audio/Video/FilePayload add DM branches Other high-priority fixes: - #8: Fix sendC2CVoiceMessage/sendGroupVoiceMessage parameter misalignment - #9: broadcastMessage uses groupOpenid instead of member_openid for group users - #10: Unify KnownUser storage - proactive.ts delegates to known-users.ts - #11: Remove invalid recordKnownUser calls for guild/DM users - #12: sendGroupMessage uses sendAndNotify to trigger onMessageSent hook - #13: sendPhoto channel unsupported returns error field - #14: sendTextAfterMedia adds channel and dm branches Type fixes: - DeliverEventContext adds guildId field - MediaTargetContext.targetType adds dm variant - sendPlainTextReply imgMediaTarget adds DM branch * fix(qqbot): resolve 2 blockers + 7 medium-priority bugs from PR #52986 review Blocker-1: Remove unused dmPolicy config knob - dmPolicy was declared in schema/types/plugin.json but never consumed at runtime - Removed from config-schema.ts, types.ts, and openclaw.plugin.json - allowFrom remains active (already wired into framework command-auth) Blocker-2: Gate sensitive slash commands with allowFrom authorization - SlashCommand interface adds requireAuth?: boolean - SlashCommandContext adds commandAuthorized: boolean - /bot-logs set to requireAuth: true (reads local log files) - matchSlashCommand rejects unauthorized senders for requireAuth commands - trySlashCommandOrEnqueue computes commandAuthorized from allowFrom config Medium-priority fixes: - #15: Strip non-HTTP/non-local markdown image tags to prevent path leakage - #16: applyQQBotAccountConfig clears clientSecret when setting clientSecretFile and vice versa - #17: getAdminMarkerFile sanitizes accountId to prevent path traversal - #18: URGENT_COMMANDS uses exact match instead of startsWith prefix match - #19: isCronExpression validates each token starts with a cron-valid character - #20: --token format validation rejects malformed input without colon separator - #21: resolveDefaultQQBotAccountId checks QQBOT_APP_ID environment variable * test(qqbot): add focused tests for slash command authorization path - Unauthorized sender rejected for /bot-logs (requireAuth: true) - Authorized sender allowed for /bot-logs - Non-requireAuth commands (/bot-ping, /bot-help, /bot-version) work for all senders - Unknown slash commands return null (passthrough) - Non-slash messages return null - Usage query (/bot-logs ?) also gated by auth check * fix(qqbot): align global TTS fallback with framework config resolution - Extract isGlobalTTSAvailable to utils/audio-convert.ts, mirroring core resolveTtsConfig logic: check auto !== 'off', fall back to legacy enabled boolean, default to off when neither is set. - Add pre-check in reply-dispatcher before calling globalTextToSpeech to avoid unnecessary TTS calls and noisy error logs when TTS is not configured. - Remove inline as any casts; use OpenClawConfig type throughout. - Refactor handleAudioPayload into flat early-return structure with unified send path (plugin TTS → global fallback → send). * fix(qqbot): break ESM circular dependency causing multi-account startup crash The bundled gateway chunk had a circular static import on the channel chunk (gateway -> outbound-deliver -> channel, while channel dynamically imports gateway). When two accounts start concurrently via Promise.all, the first dynamic import triggers module graph evaluation; the circular reference causes api exports (including runDiagnostics) to resolve as undefined before the module finishes evaluating. Fix: extract chunkText and TEXT_CHUNK_LIMIT from channel.ts into a new text-utils.ts leaf module. outbound-deliver.ts now imports from text-utils.ts, breaking the cycle. channel.ts re-exports for backward compatibility. * fix(qqbot): serialize gateway module import to prevent multi-account startup race When multiple accounts start concurrently via Promise.all, each calls await import('./gateway.js') independently. Due to ESM circular dependencies in the bundled output, the first import can resolve transitive exports as undefined before module evaluation completes. Fix: cache the dynamic import promise in a module-level variable so all concurrent startAccount calls share the same import, ensuring the gateway module is fully evaluated before any account uses it. * refactor(qqbot): remove startup greeting logic Remove getStartupGreetingPlan and related startup greeting delivery: - Delete startup-greeting.ts (greeting plan, marker persistence) - Delete admin-resolver.ts (admin resolution, greeting dispatch) - Remove startup greeting calls from gateway READY/RESUMED handlers - Remove isFirstReadyGlobal flag and adminCtx * fix(qqbot): skip octal escape decoding for Windows local paths Windows paths like C:\Users\1\file.txt contain backslash-digit sequences that were incorrectly matched as octal escape sequences and decoded, corrupting the file path. Detect Windows local paths (drive letter or UNC prefix) and skip the octal decoding step for them. * fix bot issue * feat: 支持 TTS 自动开关并清理配置中的 clientSecretFile * docs: 添加 QQBot 配置和消息处理的设计说明 * rebase * fix(qqbot): align slash-command auth with shared command-auth model Route requireAuth:true slash commands (e.g. /bot-logs) through the framework's api.registerCommand() so resolveCommandAuthorization() applies commands.allowFrom.qqbot precedence and qqbot: prefix normalization before any handler runs. - slash-commands.ts: registerCommand() now auto-routes by requireAuth into two maps (commands / frameworkCommands); getFrameworkCommands() exports the auth-required set for framework registration; bot-help lists both maps - index.ts: registerFull() iterates getFrameworkCommands() and calls api.registerCommand() for each; handler derives msgType from ctx.from, sends file attachments via sendDocument, supports multi-account via ctx.accountId - gateway.ts (inbound): replace raw allowFrom string comparison with qqbotPlugin.config.formatAllowFrom() to strip qqbot: prefix and uppercase before matching event.senderId - gateway.ts (pre-dispatch): remove stale auth computation; commandAuthorized is true (requireAuth:true commands never reach matchSlashCommand) - command-auth.test.ts: add regression tests for qqbot: prefix normalization in the inbound commandAuthorized computation - slash-commands.test.ts: update /bot-logs tests to expect null (command routed to framework, not in local registry) * rebase and solve conflict * fix(qqbot): preserve mixed env setup credentials --------- Co-authored-by: yuehuali <yuehuali@tencent.com> Co-authored-by: walli <walli@tencent.com> Co-authored-by: WideLee <limkuan24@gmail.com> Co-authored-by: Frank Yang <frank.ekn@gmail.com>
8 months ago
"channels/qqbot",
"channels/signal",
"channels/slack",
"channels/synology-chat",
"channels/telegram",
"channels/tlon",
"channels/twitch",
"channels/whatsapp",
"channels/zalo",
"channels/zalouser"
]
},
{
"group": "Configuration",
"pages": [
"channels/pairing",
"channels/group-messages",
"channels/groups",
"channels/broadcast-groups",
"channels/channel-routing",
"channels/location",
"channels/troubleshooting"
]
}
]
},
{
"tab": "Agents",
"groups": [
{
"group": "Fundamentals",
"pages": [
"concepts/architecture",
"concepts/agent",
"concepts/agent-loop",
"concepts/system-prompt",
"concepts/context",
"concepts/context-engine",
"concepts/agent-workspace",
"concepts/soul",
"concepts/oauth",
"start/bootstrapping"
]
},
{
"group": "Sessions and memory",
"pages": [
"concepts/session",
"concepts/session-pruning",
"concepts/session-tool",
{
"group": "Memory",
"pages": [
"concepts/memory",
"concepts/memory-builtin",
"concepts/memory-qmd",
"concepts/memory-honcho",
"concepts/memory-search",
"concepts/memory-dreaming"
]
},
"concepts/compaction"
]
},
{
"group": "Multi-agent",
docs: add delegate architecture guide for organizational deployments (#43261) * docs: add delegate architecture guide for organizational deployments Adds a guide for running OpenClaw as a named delegate for organizations. Covers three capability tiers (read-only, send-on-behalf, proactive), M365 and Google Workspace delegation setup, security guardrails, and integration with multi-agent routing. AI-assisted: Claude Code (Opus 4.6) Based on: Production deployment at a 501(c)(3) nonprofit Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * docs: address review — add Google DWD warning, fix canvas in deny list - Add security warning for Google Workspace domain-wide delegation matching the existing M365 application access policy warning - Add "canvas" to the security guardrails tool deny list for consistency with the full example and multi-agent.md Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * docs: fix Tier 1 description to match read-only permissions Remove "draft replies (saved to Drafts folder)" from Tier 1 since saving drafts requires write access. Tier 1 is strictly read-only — the agent summarizes and flags via chat, human acts on the mailbox. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * style: fix oxfmt formatting for delegate-architecture and docs.json Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * docs: fix broken links to /automation/standing-orders Standing orders is a deployment pattern, not an existing doc page. Replaced with inline descriptions and links to /automation/cron-jobs and #security-guardrails anchor. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * docs: move hardening to prerequisites before identity provider setup Restructure per community feedback: isolation, tool restrictions, sandbox, hard blocks, and audit trail now come BEFORE granting any credentials. The most dangerous step (tenant-wide permissions) no longer precedes the most important step (scoping and isolation). Also strengthened M365 and Google Workspace security warnings with actionable verification steps. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * docs: add standing orders guide and fix broken links Add docs/automation/standing-orders.md covering: - Why standing orders (agent autonomy vs human bottleneck) - Anatomy of a standing order (scope, triggers, gates, escalation) - Integration with cron jobs for time-based enforcement - Execute-Verify-Report pattern for execution discipline - Three production-tested examples (content, finance, monitoring) - Multi-program architecture for complex agents - Best practices (do's and don'ts) Update delegate-architecture.md to link standing orders references to the new page instead of dead links. Add standing-orders to Automation nav group in docs.json (en + zh-CN). Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * docs: address review feedback on standing-orders - P1: Clarify that standing orders should go in AGENTS.md (auto-injected) rather than arbitrary subdirectory files. Add Tip callout explaining which workspace files are bootstrapped. - P2: Remove dead /concepts/personality-files link, replace with /concepts/agent-workspace which covers bootstrap files. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
8 months ago
"pages": [
"concepts/multi-agent",
"concepts/presence",
"concepts/delegate-architecture"
]
},
{
"group": "Messages and delivery",
"pages": [
"concepts/messages",
"concepts/streaming",
"concepts/retry",
"concepts/queue"
]
}
]
},
{
"tab": "Tools & Plugins",
"groups": [
{
"group": "Overview",
"pages": ["tools/index"]
},
{
"group": "Plugins",
"pages": [
"tools/plugin",
"plugins/community",
"plugins/bundles",
"plugins/voice-call",
docs(plugins): add SDK reference and how-to guide pages (#52366) * docs(plugins): add SDK reference and how-to guide pages Create 7 new plugin SDK documentation pages: - sdk-overview: import map, registration API reference - sdk-entrypoints: definePluginEntry/defineChannelPluginEntry reference - sdk-runtime: api.runtime namespace reference - sdk-setup: packaging, manifests, config schemas reference - sdk-channel-plugins: step-by-step channel plugin how-to - sdk-provider-plugins: step-by-step provider plugin how-to - sdk-testing: test utilities and patterns reference Restructure plugin docs navigation with nested groups: - Top-level: user-facing pages (Install, Community, Bundles) - Building Plugins: Getting Started, Channel, Provider - SDK Reference: Overview, Entry Points, Runtime, Setup, Testing, Migration, Manifest, Internals Revise existing pages for new IA: - building-plugins.md: tightened as quick-start, routes to detailed guides - architecture.md: updated info box with links to new guides - sdk-migration.md: expanded Related section * docs(plugins): add Mintlify components (Steps, CodeGroup, Tabs, Accordion, CardGroup) - Channel plugin guide: wrap walkthrough in Steps, use CodeGroup for package.json/manifest, Accordion for createChatChannelPlugin details, CardGroup for advanced topics - Provider plugin guide: wrap walkthrough in Steps, use CodeGroup for package files, Tabs for hook examples, Accordion for all-hooks reference - Getting started: use CardGroup for plugin-type picker and next steps, CodeGroup for package/manifest - SDK Overview: wrap subpath tables in AccordionGroup for scannability * fix(docs): address PR review feedback on plugin SDK pages - Remove nonexistent api.runtime.channel.handleInboundMessage call, replace with realistic webhook pattern and note about channel-specific inbound handling (issue a) - Fix registrationMode values: 'setup' -> 'setup-only' and 'setup-runtime' matching actual PluginRegistrationMode type (issue b) - Fix createOptionalChannelSetupSurface params: channelId -> channel, add required label field (issue c) - Fix broken anchor links: #multi-capability-providers -> #step-5-add-extra-capabilities, #plugin-kinds -> #registration-api (issue d) - Add missing acmeChatApi import in channel plugin example (issue e) - Fix undefined provider variable in provider test example (issue f) * fix(docs): use correct createProviderApiKeyAuthMethod options Replace incorrect params (provider, validate) with actual required fields (providerId, methodId, optionKey, flagName, promptMessage) matching src/plugins/provider-api-key-auth.ts. * fix(docs): address second round of PR review feedback - Add required model fields (reasoning, input, cost, contextWindow, maxTokens) to catalog example (issue b) - Fix buildChannelConfigSchema to take a Zod schema argument (issue c) - Replace fabricated setupWizard steps/run with real ChannelSetupWizard contract (channel, status, credentials) (issue d) - Add required sessionFile/workspaceDir to runEmbeddedPiAgent (issue e) - Fix wrapStreamFn to return StreamFn from ctx.streamFn (issue f)
8 months ago
{
"group": "Building Plugins",
"pages": [
"plugins/building-plugins",
"plugins/sdk-channel-plugins",
"plugins/sdk-provider-plugins",
"plugins/sdk-migration"
docs(plugins): add SDK reference and how-to guide pages (#52366) * docs(plugins): add SDK reference and how-to guide pages Create 7 new plugin SDK documentation pages: - sdk-overview: import map, registration API reference - sdk-entrypoints: definePluginEntry/defineChannelPluginEntry reference - sdk-runtime: api.runtime namespace reference - sdk-setup: packaging, manifests, config schemas reference - sdk-channel-plugins: step-by-step channel plugin how-to - sdk-provider-plugins: step-by-step provider plugin how-to - sdk-testing: test utilities and patterns reference Restructure plugin docs navigation with nested groups: - Top-level: user-facing pages (Install, Community, Bundles) - Building Plugins: Getting Started, Channel, Provider - SDK Reference: Overview, Entry Points, Runtime, Setup, Testing, Migration, Manifest, Internals Revise existing pages for new IA: - building-plugins.md: tightened as quick-start, routes to detailed guides - architecture.md: updated info box with links to new guides - sdk-migration.md: expanded Related section * docs(plugins): add Mintlify components (Steps, CodeGroup, Tabs, Accordion, CardGroup) - Channel plugin guide: wrap walkthrough in Steps, use CodeGroup for package.json/manifest, Accordion for createChatChannelPlugin details, CardGroup for advanced topics - Provider plugin guide: wrap walkthrough in Steps, use CodeGroup for package files, Tabs for hook examples, Accordion for all-hooks reference - Getting started: use CardGroup for plugin-type picker and next steps, CodeGroup for package/manifest - SDK Overview: wrap subpath tables in AccordionGroup for scannability * fix(docs): address PR review feedback on plugin SDK pages - Remove nonexistent api.runtime.channel.handleInboundMessage call, replace with realistic webhook pattern and note about channel-specific inbound handling (issue a) - Fix registrationMode values: 'setup' -> 'setup-only' and 'setup-runtime' matching actual PluginRegistrationMode type (issue b) - Fix createOptionalChannelSetupSurface params: channelId -> channel, add required label field (issue c) - Fix broken anchor links: #multi-capability-providers -> #step-5-add-extra-capabilities, #plugin-kinds -> #registration-api (issue d) - Add missing acmeChatApi import in channel plugin example (issue e) - Fix undefined provider variable in provider test example (issue f) * fix(docs): use correct createProviderApiKeyAuthMethod options Replace incorrect params (provider, validate) with actual required fields (providerId, methodId, optionKey, flagName, promptMessage) matching src/plugins/provider-api-key-auth.ts. * fix(docs): address second round of PR review feedback - Add required model fields (reasoning, input, cost, contextWindow, maxTokens) to catalog example (issue b) - Fix buildChannelConfigSchema to take a Zod schema argument (issue c) - Replace fabricated setupWizard steps/run with real ChannelSetupWizard contract (channel, status, credentials) (issue d) - Add required sessionFile/workspaceDir to runEmbeddedPiAgent (issue e) - Fix wrapStreamFn to return StreamFn from ctx.streamFn (issue f)
8 months ago
]
},
{
"group": "SDK Reference",
"pages": [
"plugins/sdk-overview",
"plugins/sdk-entrypoints",
"plugins/sdk-runtime",
"plugins/sdk-setup",
"plugins/sdk-testing",
"plugins/manifest",
"plugins/architecture"
]
}
]
},
{
"group": "Skills",
"pages": [
"tools/skills",
"tools/creating-skills",
"tools/skills-config",
"tools/slash-commands",
"tools/clawhub",
"prose"
]
},
{
"group": "Automation & Tasks",
"pages": [
"automation/index",
"automation/cron-jobs",
"automation/tasks",
"automation/taskflow",
"automation/standing-orders",
"automation/hooks"
]
},
{
"group": "Tools",
"pages": [
"tools/apply-patch",
{
"group": "Web Browser",
"pages": [
"tools/browser",
"tools/browser-login",
"tools/browser-linux-troubleshooting",
"tools/browser-wsl2-windows-remote-cdp-troubleshooting"
]
},
{
"group": "Web Tools",
"pages": [
"tools/web-fetch",
"tools/web",
"tools/brave-search",
"tools/duckduckgo-search",
"tools/exa-search",
"tools/firecrawl",
"tools/gemini-search",
"tools/grok-search",
"tools/kimi-search",
"tools/ollama-search",
"tools/perplexity-search",
"tools/searxng-search",
"tools/tavily"
]
},
"tools/btw",
"tools/code-execution",
"tools/diffs",
"tools/elevated",
"tools/exec",
"tools/exec-approvals",
"tools/image-generation",
"tools/llm-task",
"tools/lobster",
"tools/loop-detection",
"tools/pdf",
"tools/reactions",
"tools/thinking"
]
},
{
"group": "Agent coordination",
"pages": [
"tools/agent-send",
"tools/subagents",
"tools/acp-agents",
"tools/multi-agent-sandbox-tools"
]
}
]
},
{
"tab": "Models",
"groups": [
{
"group": "Overview",
"pages": ["providers/index", "providers/models"]
},
{
"group": "Concepts and configuration",
"pages": ["concepts/models", "concepts/model-providers", "concepts/model-failover"]
},
{
"group": "Providers",
"pages": [
"providers/anthropic",
"providers/bedrock",
"providers/chutes",
"providers/claude-max-api-proxy",
"providers/cloudflare-ai-gateway",
"providers/deepgram",
"providers/deepseek",
"providers/github-copilot",
"providers/glm",
"providers/google",
"providers/groq",
"providers/huggingface",
"providers/kilocode",
Feat/litellm provider (#12823) * feat: add LiteLLM provider types, env var, credentials, and auth choice Add litellm-api-key auth choice, LITELLM_API_KEY env var mapping, setLitellmApiKey() credential storage, and LITELLM_DEFAULT_MODEL_REF. * feat: add LiteLLM onboarding handler and provider config Add applyLitellmProviderConfig which properly registers models.providers.litellm with baseUrl, api type, and model definitions. This fixes the critical bug from PR #6488 where the provider entry was never created, causing model resolution to fail at runtime. * docs: add LiteLLM provider documentation Add setup guide covering onboarding, manual config, virtual keys, model routing, and usage tracking. Link from provider index. * docs: add LiteLLM to sidebar navigation in docs.json Add providers/litellm to both English and Chinese provider page lists so the docs page appears in the sidebar navigation. * test: add LiteLLM non-interactive onboarding test Wire up litellmApiKey flag inference and auth-choice handler for the non-interactive onboarding path, and add an integration test covering profile, model default, and credential storage. * fix: register --litellm-api-key CLI flag and add preferred provider mapping Wire up the missing Commander CLI option, action handler mapping, and help text for --litellm-api-key. Add litellm-api-key to the preferred provider map for consistency with other providers. * fix: remove zh-CN sidebar entry for litellm (no localized page yet) * style: format buildLitellmModelDefinition return type * fix(onboarding): harden LiteLLM provider setup (#12823) * refactor(onboarding): keep auth-choice provider dispatcher under size limit --------- Co-authored-by: Peter Steinberger <steipete@gmail.com>
9 months ago
"providers/litellm",
"providers/minimax",
"providers/mistral",
"providers/moonshot",
"providers/nvidia",
"providers/ollama",
"providers/openai",
"providers/opencode",
"providers/opencode-go",
"providers/openrouter",
"providers/perplexity-provider",
"providers/qianfan",
"providers/qwen_modelstudio",
"providers/qwen",
"providers/sglang",
"providers/stepfun",
"providers/synthetic",
"providers/together",
"providers/venice",
"providers/vercel-ai-gateway",
"providers/vllm",
"providers/volcengine",
"providers/xai",
"providers/xiaomi",
"providers/zai"
]
}
]
},
{
"tab": "Platforms",
"groups": [
{
"group": "Platforms overview",
"pages": [
"platforms/index",
"platforms/macos",
"platforms/linux",
"platforms/windows",
"platforms/android",
"platforms/ios"
]
},
{
"group": "macOS companion app",
"pages": [
"platforms/mac/dev-setup",
"platforms/mac/menu-bar",
"platforms/mac/voicewake",
"platforms/mac/voice-overlay",
"platforms/mac/webchat",
"platforms/mac/canvas",
"platforms/mac/child-process",
"platforms/mac/health",
"platforms/mac/icon",
"platforms/mac/logging",
"platforms/mac/permissions",
"platforms/mac/remote",
"platforms/mac/signing",
"platforms/mac/bundled-gateway",
"platforms/mac/xpc",
"platforms/mac/skills",
"platforms/mac/peekaboo"
]
}
]
},
{
"tab": "Gateway & Ops",
"groups": [
{
"group": "Gateway",
"pages": [
"gateway/index",
{
"group": "Configuration and operations",
"pages": [
"gateway/configuration",
"gateway/configuration-reference",
"gateway/configuration-examples",
"gateway/authentication",
"auth-credential-semantics",
"gateway/secrets",
"gateway/secrets-plan-contract",
"gateway/trusted-proxy-auth",
"gateway/health",
"gateway/heartbeat",
"gateway/doctor",
"gateway/logging",
"logging",
"gateway/gateway-lock",
"gateway/background-process",
"gateway/multiple-gateways",
"gateway/troubleshooting"
]
},
{
"group": "Security and sandboxing",
"pages": [
"gateway/security/index",
"gateway/sandboxing",
"gateway/openshell",
"gateway/sandbox-vs-tool-policy-vs-elevated"
]
},
{
"group": "Protocols and APIs",
"pages": [
"gateway/protocol",
"gateway/bridge-protocol",
"gateway/openai-http-api",
"gateway/openresponses-http-api",
"gateway/tools-invoke-http-api",
"gateway/cli-backends",
"gateway/local-models"
]
},
{
"group": "Networking and discovery",
"pages": [
"network",
"gateway/network-model",
"gateway/pairing",
"gateway/discovery",
"gateway/bonjour"
]
}
]
},
{
"group": "Remote access",
"pages": ["gateway/remote", "gateway/remote-gateway-readme", "gateway/tailscale"]
},
{
"group": "Security",
"pages": [
"security/formal-verification",
"security/THREAT-MODEL-ATLAS",
"security/CONTRIBUTING-THREAT-MODEL"
]
},
{
"group": "Nodes and media",
"pages": [
"nodes/index",
"nodes/troubleshooting",
{
"group": "Media capabilities",
"pages": [
"nodes/media-understanding",
"nodes/images",
"nodes/audio",
"nodes/camera",
"tools/tts"
]
},
{
"group": "Node features",
"pages": ["nodes/talk", "nodes/voicewake", "nodes/location-command"]
}
]
},
{
"group": "Web interfaces",
"pages": ["web/index", "web/control-ui", "web/dashboard", "web/webchat", "web/tui"]
}
]
},
{
"tab": "Reference",
"groups": [
{
"group": "CLI commands",
"pages": [
"cli/index",
{
"group": "Gateway and service",
"pages": [
"cli/backup",
"cli/daemon",
"cli/doctor",
"cli/gateway",
"cli/health",
"cli/logs",
"cli/onboard",
"cli/reset",
"cli/secrets",
"cli/security",
"cli/setup",
"cli/status",
"cli/uninstall",
"cli/update"
]
},
{
"group": "Agents and sessions",
"pages": [
"cli/agent",
"cli/agents",
"cli/hooks",
"cli/memory",
"cli/message",
"cli/models",
"cli/sessions",
"cli/system"
]
},
{
"group": "Channels and messaging",
"pages": [
"cli/channels",
"cli/devices",
"cli/directory",
"cli/pairing",
"cli/qr",
"cli/voicecall"
]
},
{
"group": "Tools and execution",
"pages": [
"cli/approvals",
"cli/browser",
"cli/cron",
"cli/flows",
"cli/node",
"cli/nodes",
"cli/sandbox"
]
},
{
"group": "Configuration",
"pages": ["cli/config", "cli/configure", "cli/webhooks"]
},
{
"group": "Plugins and skills",
"pages": ["cli/plugins", "cli/skills"]
},
{
"group": "Interfaces",
"pages": ["cli/dashboard", "cli/tui"]
},
{
"group": "Utility",
"pages": [
"cli/acp",
"cli/clawbot",
"cli/completion",
"cli/dns",
"cli/docs",
"cli/mcp"
]
}
]
},
{
"group": "RPC and API",
"pages": ["reference/rpc", "reference/device-models"]
},
{
"group": "Templates",
"pages": [
"reference/AGENTS.default",
"reference/templates/AGENTS",
"reference/templates/BOOT",
"reference/templates/BOOTSTRAP",
"reference/templates/HEARTBEAT",
"reference/templates/IDENTITY",
"reference/templates/SOUL",
"reference/templates/TOOLS",
"reference/templates/USER"
]
},
{
"group": "Technical reference",
"pages": [
"pi",
"reference/wizard",
"reference/token-use",
feat(secrets): expand SecretRef coverage across user-supplied credentials (#29580) * feat(secrets): expand secret target coverage and gateway tooling * docs(secrets): align gateway and CLI secret docs * chore(protocol): regenerate swift gateway models for secrets methods * fix(config): restore talk apiKey fallback and stabilize runner test * ci(windows): reduce test worker count for shard stability * ci(windows): raise node heap for test shard stability * test(feishu): make proxy env precedence assertion windows-safe * fix(gateway): resolve auth password SecretInput refs for clients * fix(gateway): resolve remote SecretInput credentials for clients * fix(secrets): skip inactive refs in command snapshot assignments * fix(secrets): scope gateway.remote refs to effective auth surfaces * fix(secrets): ignore memory defaults when enabled agents disable search * fix(secrets): honor Google Chat serviceAccountRef inheritance * fix(secrets): address tsgo errors in command and gateway collectors * fix(secrets): avoid auth-store load in providers-only configure * fix(gateway): defer local password ref resolution by precedence * fix(secrets): gate telegram webhook secret refs by webhook mode * fix(secrets): gate slack signing secret refs to http mode * fix(secrets): skip telegram botToken refs when tokenFile is set * fix(secrets): gate discord pluralkit refs by enabled flag * fix(secrets): gate discord voice tts refs by voice enabled * test(secrets): make runtime fixture modes explicit * fix(cli): resolve local qr password secret refs * fix(cli): fail when gateway leaves command refs unresolved * fix(gateway): fail when local password SecretRef is unresolved * fix(gateway): fail when required remote SecretRefs are unresolved * fix(gateway): resolve local password refs only when password can win * fix(cli): skip local password SecretRef resolution on qr token override * test(gateway): cast SecretRef fixtures to OpenClawConfig * test(secrets): activate mode-gated targets in runtime coverage fixture * fix(cron): support SecretInput webhook tokens safely * fix(bluebubbles): support SecretInput passwords across config paths * fix(msteams): make appPassword SecretInput-safe in onboarding/token paths * fix(bluebubbles): align SecretInput schema helper typing * fix(cli): clarify secrets.resolve version-skew errors * refactor(secrets): return structured inactive paths from secrets.resolve * refactor(gateway): type onboarding secret writes as SecretInput * chore(protocol): regenerate swift models for secrets.resolve * feat(secrets): expand extension credential secretref support * fix(secrets): gate web-search refs by active provider * fix(onboarding): detect SecretRef credentials in extension status * fix(onboarding): allow keeping existing ref in secret prompt * fix(onboarding): resolve gateway password SecretRefs for probe and tui * fix(onboarding): honor secret-input-mode for local gateway auth * fix(acp): resolve gateway SecretInput credentials * fix(secrets): gate gateway.remote refs to remote surfaces * test(secrets): cover pattern matching and inactive array refs * docs(secrets): clarify secrets.resolve and remote active surfaces * fix(bluebubbles): keep existing SecretRef during onboarding * fix(tests): resolve CI type errors in new SecretRef coverage * fix(extensions): replace raw fetch with SSRF-guarded fetch * test(secrets): mark gateway remote targets active in runtime coverage * test(infra): normalize home-prefix expectation across platforms * fix(cli): only resolve local qr password refs in password mode * test(cli): cover local qr token mode with unresolved password ref * docs(cli): clarify local qr password ref resolution behavior * refactor(extensions): reuse sdk SecretInput helpers * fix(wizard): resolve onboarding env-template secrets before plaintext * fix(cli): surface secrets.resolve diagnostics in memory and qr * test(secrets): repair post-rebase runtime and fixtures * fix(gateway): skip remote password ref resolution when token wins * fix(secrets): treat tailscale remote gateway refs as active * fix(gateway): allow remote password fallback when token ref is unresolved * fix(gateway): ignore stale local password refs for none and trusted-proxy * fix(gateway): skip remote secret ref resolution on local call paths * test(cli): cover qr remote tailscale secret ref resolution * fix(secrets): align gateway password active-surface with auth inference * fix(cli): resolve inferred local gateway password refs in qr * fix(gateway): prefer resolvable remote password over token ref pre-resolution * test(gateway): cover none and trusted-proxy stale password refs * docs(secrets): sync qr and gateway active-surface behavior * fix: restore stability blockers from pre-release audit * Secrets: fix collector/runtime precedence contradictions * docs: align secrets and web credential docs * fix(rebase): resolve integration regressions after main rebase * fix(node-host): resolve gateway secret refs for auth * fix(secrets): harden secretinput runtime readers * gateway: skip inactive auth secretref resolution * cli: avoid gateway preflight for inactive secret refs * extensions: allow unresolved refs in onboarding status * tests: fix qr-cli module mock hoist ordering * Security: align audit checks with SecretInput resolution * Gateway: resolve local-mode remote fallback secret refs * Node host: avoid resolving inactive password secret refs * Secrets runtime: mark Slack appToken inactive for HTTP mode * secrets: keep inactive gateway remote refs non-blocking * cli: include agent memory secret targets in runtime resolution * docs(secrets): sync docs with active-surface and web search behavior * fix(secrets): keep telegram top-level token refs active for blank account tokens * fix(daemon): resolve gateway password secret refs for probe auth * fix(secrets): skip IRC NickServ ref resolution when NickServ is disabled * fix(secrets): align token inheritance and exec timeout defaults * docs(secrets): clarify active-surface notes in cli docs * cli: require secrets.resolve gateway capability * gateway: log auth secret surface diagnostics * secrets: remove dead provider resolver module * fix(secrets): restore gateway auth precedence and fallback resolution * fix(tests): align plugin runtime mock typings --------- Co-authored-by: Peter Steinberger <steipete@gmail.com>
9 months ago
"reference/secretref-credential-surface",
"reference/prompt-caching",
"reference/api-usage-costs",
"reference/transcript-hygiene",
"reference/memory-config",
"date-time"
]
},
{
"group": "Concept internals",
"pages": [
"concepts/typebox",
"concepts/markdown-formatting",
"concepts/typing-indicators",
"concepts/usage-tracking",
"concepts/timezone"
]
},
{
"group": "Project",
"pages": ["reference/credits"]
},
{
"group": "Release policy",
"pages": ["reference/RELEASING", "reference/test"]
}
]
},
{
"tab": "Help",
"groups": [
{
"group": "Help",
"pages": ["help/index", "help/troubleshooting", "help/faq"]
},
{
"group": "Community",
"pages": ["start/lore"]
},
{
"group": "Environment and debugging",
"pages": [
"help/environment",
"help/debugging",
"help/testing",
"help/scripts",
"debug/node-issue",
"diagnostics/flags"
]
},
{
"group": "Compaction internals",
"pages": ["reference/session-management-compaction"]
},
{
"group": "Developer setup",
"pages": ["start/setup", "pi-dev"]
},
{
"group": "Contributing",
"pages": ["ci"]
},
{
"group": "Docs meta",
"pages": ["start/hubs", "start/docs-directory"]
}
]
}
]
},
{
"language": "zh-Hans",
"tabs": [
{
"tab": "快速开始",
"groups": [
{
"group": "首页",
"pages": ["zh-CN/index"]
},
{
"group": "概览",
"pages": ["zh-CN/start/showcase"]
},
{
"group": "核心概念",
"pages": ["zh-CN/concepts/features"]
},
{
"group": "第一步",
"pages": [
"zh-CN/start/getting-started",
"zh-CN/start/wizard",
"zh-CN/start/onboarding"
]
},
{
"group": "指南",
"pages": ["zh-CN/start/openclaw"]
}
]
},
{
"tab": "安装",
"groups": [
{
"group": "安装概览",
"pages": ["zh-CN/install/index", "zh-CN/install/installer"]
},
{
"group": "安装方式",
"pages": [
"zh-CN/install/docker",
"zh-CN/install/nix",
"zh-CN/install/ansible",
"zh-CN/install/bun"
]
},
{
"group": "维护",
"pages": [
"zh-CN/install/updating",
"zh-CN/install/migrating",
"zh-CN/install/uninstall"
]
},
{
"group": "托管与部署",
"pages": [
"zh-CN/vps",
"zh-CN/install/fly",
"zh-CN/install/hetzner",
"zh-CN/install/gcp",
"zh-CN/install/macos-vm",
"zh-CN/install/exe-dev",
"zh-CN/install/railway",
"zh-CN/install/render",
"zh-CN/install/northflank"
]
},
{
"group": "高级",
"pages": ["zh-CN/install/development-channels"]
}
]
},
{
"tab": "消息渠道",
"groups": [
{
"group": "概览",
"pages": ["zh-CN/channels/index"]
},
{
"group": "消息平台",
"pages": [
"zh-CN/channels/bluebubbles",
"zh-CN/channels/discord",
"zh-CN/channels/feishu",
"zh-CN/channels/grammy",
"zh-CN/channels/googlechat",
"zh-CN/channels/imessage",
"zh-CN/channels/line",
"zh-CN/channels/matrix",
"zh-CN/channels/mattermost",
"zh-CN/channels/msteams",
"zh-CN/channels/nextcloud-talk",
"zh-CN/channels/nostr",
"zh-CN/channels/signal",
"zh-CN/channels/slack",
"zh-CN/channels/telegram",
"zh-CN/channels/tlon",
"zh-CN/channels/twitch",
"zh-CN/channels/whatsapp",
"zh-CN/channels/zalo",
"zh-CN/channels/zalouser"
]
},
{
"group": "配置",
"pages": [
"zh-CN/channels/pairing",
"zh-CN/channels/group-messages",
"zh-CN/channels/groups",
"zh-CN/channels/broadcast-groups",
"zh-CN/channels/channel-routing",
"zh-CN/channels/location",
"zh-CN/channels/troubleshooting"
]
}
]
},
{
"tab": "代理",
"groups": [
{
"group": "基础",
"pages": [
"zh-CN/pi",
"zh-CN/concepts/architecture",
"zh-CN/concepts/agent",
"zh-CN/concepts/agent-loop",
"zh-CN/concepts/system-prompt",
"zh-CN/concepts/context",
"zh-CN/concepts/agent-workspace",
"zh-CN/concepts/oauth"
]
},
{
"group": "引导",
"pages": ["zh-CN/start/bootstrapping"]
},
{
"group": "会话与记忆",
"pages": [
"zh-CN/concepts/session",
"zh-CN/concepts/session-pruning",
"zh-CN/concepts/session-tool",
"zh-CN/concepts/memory",
"zh-CN/concepts/compaction"
]
},
{
"group": "多代理",
"pages": ["zh-CN/concepts/multi-agent", "zh-CN/concepts/presence"]
},
{
"group": "消息与投递",
"pages": [
"zh-CN/concepts/messages",
"zh-CN/concepts/streaming",
"zh-CN/concepts/retry",
"zh-CN/concepts/queue"
]
}
]
},
{
"tab": "工具",
"groups": [
{
"group": "概览",
"pages": ["zh-CN/tools/index"]
},
{
"group": "内置工具",
"pages": [
"zh-CN/tools/apply-patch",
"zh-CN/brave-search",
"zh-CN/tools/elevated",
"zh-CN/tools/exec",
"zh-CN/tools/exec-approvals",
"zh-CN/tools/firecrawl",
"zh-CN/tools/llm-task",
"zh-CN/tools/lobster",
"zh-CN/perplexity",
"zh-CN/tools/reactions",
"zh-CN/tools/thinking",
"zh-CN/tools/web"
]
},
{
"group": "浏览器",
"pages": [
"zh-CN/tools/browser",
"zh-CN/tools/browser-login",
"zh-CN/tools/browser-linux-troubleshooting"
]
},
{
"group": "代理协作",
"pages": [
"zh-CN/tools/agent-send",
"zh-CN/tools/subagents",
"zh-CN/tools/multi-agent-sandbox-tools"
]
},
{
"group": "技能",
"pages": [
"zh-CN/tools/creating-skills",
"zh-CN/tools/slash-commands",
"zh-CN/tools/skills",
"zh-CN/tools/skills-config",
"zh-CN/tools/clawhub",
"zh-CN/tools/plugin"
]
},
{
"group": "扩展",
"pages": [
"zh-CN/plugins/voice-call",
"zh-CN/plugins/zalouser",
"zh-CN/plugins/manifest",
"zh-CN/plugins/agent-tools",
"zh-CN/prose"
]
},
{
"group": "自动化与任务",
"pages": ["zh-CN/automation/hooks", "zh-CN/automation/cron-jobs"]
},
{
"group": "媒体与设备",
"pages": [
"zh-CN/nodes/index",
"zh-CN/nodes/troubleshooting",
"zh-CN/nodes/media-understanding",
"zh-CN/nodes/images",
"zh-CN/nodes/audio",
"zh-CN/nodes/camera",
"zh-CN/nodes/talk",
"zh-CN/nodes/voicewake",
"zh-CN/nodes/location-command",
"zh-CN/tts"
]
}
]
},
{
"tab": "模型",
"groups": [
{
"group": "概览",
"pages": ["zh-CN/providers/index", "zh-CN/providers/models"]
},
{
"group": "模型概念",
"pages": ["zh-CN/concepts/models"]
},
{
"group": "配置",
"pages": ["zh-CN/concepts/model-providers", "zh-CN/concepts/model-failover"]
},
{
"group": "提供商",
"pages": [
"zh-CN/providers/anthropic",
"zh-CN/providers/bedrock",
"zh-CN/providers/claude-max-api-proxy",
"zh-CN/providers/deepgram",
"zh-CN/providers/github-copilot",
"zh-CN/providers/glm",
"zh-CN/providers/moonshot",
"zh-CN/providers/minimax",
"zh-CN/providers/opencode",
"zh-CN/providers/ollama",
"zh-CN/providers/openai",
"zh-CN/providers/openrouter",
"zh-CN/providers/qianfan",
"zh-CN/providers/qwen",
"zh-CN/providers/synthetic",
"zh-CN/providers/venice",
"zh-CN/providers/vercel-ai-gateway",
"zh-CN/providers/xiaomi",
"zh-CN/providers/zai"
]
}
]
},
{
"tab": "平台",
"groups": [
{
"group": "平台概览",
"pages": [
"zh-CN/platforms/index",
"zh-CN/platforms/macos",
"zh-CN/platforms/linux",
"zh-CN/platforms/windows",
"zh-CN/platforms/android",
"zh-CN/platforms/ios",
"zh-CN/platforms/digitalocean",
"zh-CN/platforms/oracle",
"zh-CN/platforms/raspberry-pi"
]
},
{
"group": "macOS 配套应用",
"pages": [
"zh-CN/platforms/mac/dev-setup",
"zh-CN/platforms/mac/menu-bar",
"zh-CN/platforms/mac/voicewake",
"zh-CN/platforms/mac/voice-overlay",
"zh-CN/platforms/mac/webchat",
"zh-CN/platforms/mac/canvas",
"zh-CN/platforms/mac/child-process",
"zh-CN/platforms/mac/health",
"zh-CN/platforms/mac/icon",
"zh-CN/platforms/mac/logging",
"zh-CN/platforms/mac/permissions",
"zh-CN/platforms/mac/remote",
"zh-CN/platforms/mac/signing",
"zh-CN/platforms/mac/bundled-gateway",
"zh-CN/platforms/mac/xpc",
"zh-CN/platforms/mac/skills",
"zh-CN/platforms/mac/peekaboo"
]
}
]
},
{
"tab": "网关与运维",
"groups": [
{
"group": "网关",
"pages": [
"zh-CN/gateway/index",
{
"group": "配置与运维",
"pages": [
"zh-CN/gateway/configuration",
"zh-CN/gateway/configuration-examples",
"zh-CN/gateway/authentication",
"zh-CN/gateway/health",
"zh-CN/gateway/heartbeat",
"zh-CN/gateway/doctor",
"zh-CN/gateway/logging",
"zh-CN/gateway/gateway-lock",
"zh-CN/gateway/background-process",
"zh-CN/gateway/multiple-gateways",
"zh-CN/gateway/troubleshooting"
]
},
{
"group": "安全与沙箱",
"pages": [
"zh-CN/gateway/security/index",
"zh-CN/gateway/sandboxing",
"zh-CN/gateway/sandbox-vs-tool-policy-vs-elevated"
]
},
{
"group": "协议与 API",
"pages": [
"zh-CN/gateway/protocol",
"zh-CN/gateway/bridge-protocol",
"zh-CN/gateway/openai-http-api",
"zh-CN/gateway/openresponses-http-api",
"zh-CN/gateway/tools-invoke-http-api",
"zh-CN/gateway/cli-backends",
"zh-CN/gateway/local-models"
]
},
{
"group": "网络与发现",
"pages": [
"zh-CN/gateway/network-model",
"zh-CN/gateway/pairing",
"zh-CN/gateway/discovery",
"zh-CN/gateway/bonjour"
]
}
]
},
{
"group": "远程访问",
"pages": [
"zh-CN/gateway/remote",
"zh-CN/gateway/remote-gateway-readme",
"zh-CN/gateway/tailscale"
]
},
{
"group": "运维专题",
"pages": ["zh-CN/network", "zh-CN/logging"]
},
{
"group": "安全",
"pages": ["zh-CN/security/formal-verification"]
},
{
"group": "Web 界面",
"pages": [
"zh-CN/web/index",
"zh-CN/web/control-ui",
"zh-CN/web/dashboard",
"zh-CN/web/webchat",
"zh-CN/web/tui"
]
}
]
},
{
"tab": "参考",
"groups": [
{
"group": "CLI 命令",
"pages": [
"zh-CN/cli/index",
"zh-CN/cli/acp",
"zh-CN/cli/agent",
"zh-CN/cli/agents",
"zh-CN/cli/approvals",
"zh-CN/cli/browser",
"zh-CN/cli/channels",
"zh-CN/cli/config",
"zh-CN/cli/configure",
"zh-CN/cli/cron",
"zh-CN/cli/dashboard",
"zh-CN/cli/devices",
"zh-CN/cli/directory",
"zh-CN/cli/dns",
"zh-CN/cli/docs",
"zh-CN/cli/doctor",
"zh-CN/cli/gateway",
"zh-CN/cli/health",
"zh-CN/cli/hooks",
"zh-CN/cli/logs",
"zh-CN/cli/memory",
"zh-CN/cli/message",
"zh-CN/cli/models",
"zh-CN/cli/node",
"zh-CN/cli/nodes",
"zh-CN/cli/onboard",
"zh-CN/cli/pairing",
"zh-CN/cli/plugins",
"zh-CN/cli/reset",
"zh-CN/cli/sandbox",
"zh-CN/cli/security",
"zh-CN/cli/sessions",
"zh-CN/cli/setup",
"zh-CN/cli/skills",
"zh-CN/cli/status",
"zh-CN/cli/system",
"zh-CN/cli/tui",
"zh-CN/cli/uninstall",
"zh-CN/cli/update",
"zh-CN/cli/voicecall",
"zh-CN/cli/webhooks"
]
},
{
"group": "RPC 与 API",
"pages": ["zh-CN/reference/rpc", "zh-CN/reference/device-models"]
},
{
"group": "模板",
"pages": [
"zh-CN/reference/AGENTS.default",
"zh-CN/reference/templates/AGENTS",
"zh-CN/reference/templates/BOOT",
"zh-CN/reference/templates/BOOTSTRAP",
"zh-CN/reference/templates/HEARTBEAT",
"zh-CN/reference/templates/IDENTITY",
"zh-CN/reference/templates/SOUL",
"zh-CN/reference/templates/TOOLS",
"zh-CN/reference/templates/USER"
]
},
{
"group": "技术参考",
"pages": [
"zh-CN/reference/wizard",
"zh-CN/reference/token-use",
"zh-CN/reference/api-usage-costs",
"zh-CN/reference/transcript-hygiene",
"zh-CN/date-time"
]
},
{
"group": "概念内部机制",
"pages": [
"zh-CN/concepts/typebox",
"zh-CN/concepts/markdown-formatting",
"zh-CN/concepts/typing-indicators",
"zh-CN/concepts/usage-tracking",
"zh-CN/concepts/timezone"
]
},
{
"group": "项目",
"pages": ["zh-CN/reference/credits"]
},
{
"group": "发布策略",
"pages": ["zh-CN/reference/RELEASING", "zh-CN/reference/test"]
}
]
},
{
"tab": "帮助",
"groups": [
{
"group": "帮助",
"pages": ["zh-CN/help/index", "zh-CN/help/troubleshooting", "zh-CN/help/faq"]
},
{
"group": "社区",
"pages": ["zh-CN/start/lore"]
},
{
"group": "环境与调试",
"pages": [
"zh-CN/help/environment",
"zh-CN/help/debugging",
"zh-CN/help/testing",
"zh-CN/help/scripts",
"zh-CN/debug/node-issue",
"zh-CN/diagnostics/flags"
]
},
{
"group": "Node 运行时",
"pages": ["zh-CN/install/node"]
},
{
"group": "压缩机制内部参考",
"pages": ["zh-CN/reference/session-management-compaction"]
},
{
"group": "开发者设置",
"pages": ["zh-CN/start/setup", "zh-CN/pi-dev"]
},
{
"group": "文档元信息",
"pages": ["zh-CN/start/hubs", "zh-CN/start/docs-directory", "zh-CN/AGENTS"]
}
]
}
]
},
{
"language": "ja",
"tabs": [
{
"tab": "はじめに",
"groups": [
{
"group": "概要",
"pages": ["ja-JP/index"]
},
{
"group": "初回セットアップ",
"pages": ["ja-JP/start/getting-started", "ja-JP/start/wizard"]
}
]
}
]
}
]
}
}