配置 🔧
OpenClaw 从~/.openclaw/openclaw.json 读取可选的 JSON5 配置(支持注释和尾逗号)。
如果文件不存在,OpenClaw 使用安全的默认值(内置 Pi 智能体 + 按发送者分会话 + 工作区 ~/.openclaw/workspace)。通常只在以下情况需要配置:
- 限制谁可以触发机器人(
channels.whatsapp.allowFrom、channels.telegram.allowFrom等) - 控制群组白名单 + 提及行为(
channels.whatsapp.groups、channels.telegram.groups、channels.discord.guilds、agents.list[].groupChat) - 自定义消息前缀(
messages) - 设置智能体工作区(
agents.defaults.workspace或agents.list[].workspace) - 调整内置智能体默认值(
agents.defaults)和会话行为(session) - 设置每个智能体的身份标识(
agents.list[].identity)
初次接触配置? 请查阅配置示例指南,获取带有详细说明的完整示例!
严格配置验证
OpenClaw 只接受完全匹配 schema 的配置。 未知键、类型错误或无效值会导致 Gateway网关 拒绝启动以确保安全。 验证失败时:- Gateway网关不会启动。
- 只允许诊断命令(例如:
openclaw doctor、openclaw logs、openclaw health、openclaw status、openclaw service、openclaw help)。 - 运行
openclaw doctor查看具体问题。 - 运行
openclaw doctor --fix(或--yes)应用迁移/修复。
--fix/--yes。
Schema + UI 提示
Gateway网关通过config.schema 暴露配置的 JSON Schema 表示,供 UI 编辑器使用。
控制台 UI 根据此 schema 渲染表单,并提供 Raw JSON 编辑器作为应急手段。
渠道插件和扩展可以为其配置注册 schema + UI 提示,因此渠道设置
在各应用间保持 schema 驱动,无需硬编码表单。
提示信息(标签、分组、敏感字段)随 schema 一起提供,客户端无需硬编码配置知识即可渲染更好的表单。
应用 + 重启(RPC)
使用config.apply 在一步中验证 + 写入完整配置并重启 Gateway网关。
它会写入重启哨兵文件,并在 Gateway网关恢复后 ping 最后活跃的会话。
警告:config.apply 会替换整个配置。如果你只想更改部分键,
请使用 config.patch 或 openclaw config set。请备份 ~/.openclaw/openclaw.json。
参数:
raw(字符串)— 整个配置的 JSON5 负载baseHash(可选)— 来自config.get的配置哈希(当配置已存在时为必需)sessionKey(可选)— 最后活跃会话的键,用于唤醒 pingnote(可选)— 包含在重启哨兵中的备注restartDelayMs(可选)— 重启前的延迟(默认 2000)
gateway call):
部分更新(RPC)
使用config.patch 将部分更新合并到现有配置中,而不会覆盖
无关的键。它采用 JSON merge patch 语义:
- 对象递归合并
null删除键- 数组替换
与
config.apply类似,它会验证、写入配置、存储重启哨兵,并调度 Gateway网关重启(当提供sessionKey时可选择唤醒)。
raw(字符串)— 仅包含要更改的键的 JSON5 负载baseHash(必需)— 来自config.get的配置哈希sessionKey(可选)— 最后活跃会话的键,用于唤醒 pingnote(可选)— 包含在重启哨兵中的备注restartDelayMs(可选)— 重启前的延迟(默认 2000)
最小配置(推荐起点)
自聊天模式(推荐用于群组控制)
防止机器人在群组中响应 WhatsApp @提及(仅响应特定文本触发器):配置包含($include)
使用 $include 指令将配置拆分为多个文件。适用于:
- 组织大型配置(例如按客户定义智能体)
- 跨环境共享通用设置
- 将敏感配置单独存放
基本用法
合并行为
- 单个文件:替换包含
$include的对象 - 文件数组:按顺序深度合并(后面的文件覆盖前面的)
- 带兄弟键:兄弟键在包含之后合并(覆盖被包含的值)
- 兄弟键 + 数组/原始值:不支持(被包含的内容必须是对象)
嵌套包含
被包含的文件本身可以包含$include 指令(最多 10 层深度):
路径解析
- 相对路径:相对于包含文件解析
- 绝对路径:直接使用
- 父目录:
../引用按预期工作
错误处理
- 文件缺失:显示清晰的错误及解析后的路径
- 解析错误:显示哪个被包含的文件出错
- 循环包含:检测并报告包含链
示例:多客户法律事务设置
常用选项
环境变量 + .env
OpenClaw 从父进程(shell、launchd/systemd、CI 等)读取环境变量。
此外,它还会加载:
- 当前工作目录中的
.env(如果存在) ~/.openclaw/.env(即$OPENCLAW_STATE_DIR/.env)作为全局回退.env
.env 文件都不会覆盖已有的环境变量。
你也可以在配置中提供内联环境变量。这些仅在进程环境中缺少该键时应用(相同的不覆盖规则):
env.shellEnv(可选)
可选便利功能:如果启用且预期键均未设置,OpenClaw 会运行你的登录 shell 并仅导入缺失的预期键(不会覆盖)。
这实际上会 source 你的 shell 配置文件。
OPENCLAW_LOAD_SHELL_ENV=1OPENCLAW_SHELL_ENV_TIMEOUT_MS=15000
配置中的环境变量替换
你可以在任何配置字符串值中使用${VAR_NAME} 语法直接引用环境变量。变量在配置加载时、验证之前进行替换。
- 仅匹配大写环境变量名:
[A-Z_][A-Z0-9_]* - 缺失或为空的环境变量在配置加载时会抛出错误
- 使用
$${VAR}转义以输出字面量${VAR} - 与
$include配合使用(被包含的文件也会进行替换)
认证存储(OAuth + API 密钥)
OpenClaw 在以下位置存储每个智能体的认证配置文件(OAuth + API 密钥):<agentDir>/auth-profiles.json(默认:~/.openclaw/agents/<agentId>/agent/auth-profiles.json)
~/.openclaw/credentials/oauth.json(或$OPENCLAW_STATE_DIR/credentials/oauth.json)
<agentDir>/auth.json(自动管理;请勿手动编辑)
~/.openclaw/agent/*(由openclaw doctor迁移到~/.openclaw/agents/<defaultAgentId>/agent/*)
- OAuth 目录(仅旧版导入):
OPENCLAW_OAUTH_DIR - 智能体目录(默认智能体根目录覆盖):
OPENCLAW_AGENT_DIR(推荐)、PI_CODING_AGENT_DIR(旧版)
oauth.json 条目导入到 auth-profiles.json 中。
auth
认证配置文件的可选元数据。这不存储密钥;它将配置文件 ID 映射到提供商 + 模式(以及可选的邮箱),并定义用于故障转移的提供商轮换顺序。
agents.list[].identity
用于默认值和用户体验的可选每智能体身份标识。由 macOS 新手引导助手写入。
如果设置了,OpenClaw 会推导默认值(仅在你未明确设置时):
messages.ackReaction来自活跃智能体的identity.emoji(回退到 👀)agents.list[].groupChat.mentionPatterns来自智能体的identity.name/identity.emoji(因此 “@Samantha” 在 Telegram/Slack/Discord/Google Chat/iMessage/WhatsApp 的群组中均可使用)identity.avatar接受工作区相对图片路径或远程 URL/data URL。本地文件必须位于智能体工作区内。
identity.avatar 接受:
- 工作区相对路径(必须在智能体工作区内)
http(s)URLdata:URI
wizard
由 CLI 向导(onboard、configure、doctor)写入的元数据。
logging
- 默认日志文件:
/tmp/openclaw/openclaw-YYYY-MM-DD.log - 如需稳定路径,将
logging.file设为/tmp/openclaw/openclaw.log。 - 控制台输出可通过以下方式单独调整:
logging.consoleLevel(默认info,使用--verbose时提升为debug)logging.consoleStyle(pretty|compact|json)
- 工具摘要可以脱敏以避免泄露密钥:
logging.redactSensitive(off|tools,默认:tools)logging.redactPatterns(正则表达式字符串数组;覆盖默认值)
channels.whatsapp.dmPolicy
控制 WhatsApp 私聊(私信)的处理方式:
"pairing"(默认):未知发送者会收到配对码;所有者必须批准"allowlist":仅允许channels.whatsapp.allowFrom(或已配对的允许存储)中的发送者"open":允许所有入站私聊(需要channels.whatsapp.allowFrom包含"*")"disabled":忽略所有入站私聊
openclaw pairing list whatsappopenclaw pairing approve whatsapp <code>
channels.whatsapp.allowFrom
允许触发 WhatsApp 自动回复的 E.164 电话号码白名单(仅限私聊)。
如果为空且 channels.whatsapp.dmPolicy="pairing",未知发送者将收到配对码。
对于群组,使用 channels.whatsapp.groupPolicy + channels.whatsapp.groupAllowFrom。
channels.whatsapp.sendReadReceipts
控制入站 WhatsApp 消息是否标记为已读(蓝色双勾)。默认:true。
自聊天模式始终跳过已读回执,即使已启用。
每账号覆盖:channels.whatsapp.accounts.<id>.sendReadReceipts。
channels.whatsapp.accounts(多账号)
在一个 Gateway网关中运行多个 WhatsApp 账号:
- 出站命令默认使用
default账号(如果存在);否则使用第一个配置的账号 id(排序后)。 - 旧版单账号 Baileys 认证目录由
openclaw doctor迁移到whatsapp/default。
channels.telegram.accounts / channels.discord.accounts / channels.googlechat.accounts / channels.slack.accounts / channels.mattermost.accounts / channels.signal.accounts / channels.imessage.accounts
每个渠道运行多个账号(每个账号有自己的 accountId 和可选的 name):
- 省略
accountId时使用default(CLI + 路由)。 - 环境变量 token 仅适用于默认账号。
- 基础渠道设置(群组策略、提及门控等)适用于所有账号,除非在每个账号中单独覆盖。
- 使用
bindings[].match.accountId将每个账号路由到不同的 agents.defaults。
群聊提及门控(agents.list[].groupChat + messages.groupChat)
群消息默认需要提及(元数据提及或正则模式)。适用于 WhatsApp、Telegram、Discord、Google Chat 和 iMessage 群聊。
提及类型:
- 元数据提及:原生平台 @提及(例如 WhatsApp 点按提及)。在 WhatsApp 自聊天模式中被忽略(参见
channels.whatsapp.allowFrom)。 - 文本模式:在
agents.list[].groupChat.mentionPatterns中定义的正则模式。无论自聊天模式如何始终检查。 - 提及门控仅在可以检测提及时执行(原生提及或至少一个
mentionPattern)。
messages.groupChat.historyLimit 设置群组历史上下文的全局默认值。渠道可以通过 channels.<channel>.historyLimit(或多账号的 channels.<channel>.accounts.*.historyLimit)覆盖。设为 0 禁用历史包装。
私聊历史限制
私聊对话使用由智能体管理的基于会话的历史。你可以限制每个私聊会话保留的用户轮次数:- 每私聊覆盖:
channels.<provider>.dms[userId].historyLimit - 提供商默认值:
channels.<provider>.dmHistoryLimit - 无限制(保留所有历史)
telegram、whatsapp、discord、slack、signal、imessage、msteams。
每智能体覆盖(设置后优先,即使为 []):
channels.whatsapp.groups、channels.telegram.groups、channels.imessage.groups、channels.discord.guilds)。当设置了 *.groups 时,它也充当群组白名单;包含 "*" 以允许所有群组。
仅响应特定文本触发器(忽略原生 @提及):
群组策略(按渠道)
使用channels.*.groupPolicy 控制是否接受群组/房间消息:
"open":群组绕过白名单;提及门控仍然适用。"disabled":阻止所有群组/房间消息。"allowlist":仅允许匹配配置白名单的群组/房间。channels.defaults.groupPolicy设置提供商的groupPolicy未设置时的默认值。- WhatsApp/Telegram/Signal/iMessage/Microsoft Teams 使用
groupAllowFrom(回退:显式allowFrom)。 - Discord/Slack 使用渠道白名单(
channels.discord.guilds.*.channels、channels.slack.channels)。 - 群组私聊(Discord/Slack)仍由
dm.groupEnabled+dm.groupChannels控制。 - 默认为
groupPolicy: "allowlist"(除非被channels.defaults.groupPolicy覆盖);如果未配置白名单,群组消息将被阻止。
多智能体路由(agents.list + bindings)
在一个 Gateway网关中运行多个隔离的智能体(独立的工作区、agentDir、会话)。
入站消息通过绑定路由到智能体。
agents.list[]:每智能体覆盖。id:稳定的智能体 id(必需)。default:可选;当设置多个时,第一个获胜并记录警告。 如果未设置,列表中的第一个条目为默认智能体。name:智能体的显示名称。workspace:默认~/.openclaw/workspace-<agentId>(对于main,回退到agents.defaults.workspace)。agentDir:默认~/.openclaw/agents/<agentId>/agent。model:每智能体默认模型,覆盖该智能体的agents.defaults.model。- 字符串形式:
"provider/model",仅覆盖agents.defaults.model.primary - 对象形式:
{ primary, fallbacks }(fallbacks 覆盖agents.defaults.model.fallbacks;[]为该智能体禁用全局回退)
- 字符串形式:
identity:每智能体的名称/主题/表情(用于提及模式 + 确认反应)。groupChat:每智能体的提及门控(mentionPatterns)。sandbox:每智能体的沙盒配置(覆盖agents.defaults.sandbox)。mode:"off"|"non-main"|"all"workspaceAccess:"none"|"ro"|"rw"scope:"session"|"agent"|"shared"workspaceRoot:自定义沙盒工作区根目录docker:每智能体 docker 覆盖(例如image、network、env、setupCommand、限制;scope: "shared"时忽略)browser:每智能体沙盒浏览器覆盖(scope: "shared"时忽略)prune:每智能体沙盒清理覆盖(scope: "shared"时忽略)
subagents:每智能体子智能体默认值。allowAgents:允许从此智能体执行sessions_spawn的智能体 id 白名单(["*"]= 允许任何;默认:仅同一智能体)
tools:每智能体工具限制(在沙盒工具策略之前应用)。profile:基础工具配置文件(在 allow/deny 之前应用)allow:允许的工具名称数组deny:拒绝的工具名称数组(deny 优先)
agents.defaults:共享的智能体默认值(模型、工作区、沙盒等)。bindings[]:将入站消息路由到agentId。match.channel(必需)match.accountId(可选;*= 任何账号;省略 = 默认账号)match.peer(可选;{ kind: dm|group|channel, id })match.guildId/match.teamId(可选;渠道特定)
match.peermatch.guildIdmatch.teamIdmatch.accountId(精确匹配,无 peer/guild/team)match.accountId: "*"(渠道范围,无 peer/guild/team)- 默认智能体(
agents.list[].default,否则第一个列表条目,否则"main")
bindings 中的第一个匹配条目获胜。
每智能体访问配置(多智能体)
每个智能体可以携带自己的沙盒 + 工具策略。用于在一个 Gateway网关中混合访问级别:- 完全访问(个人智能体)
- 只读工具 + 工作区
- 无文件系统访问(仅消息/会话工具)
tools.agentToAgent(可选)
智能体间消息传递为可选功能:
messages.queue
控制智能体运行已在执行时入站消息的行为。
messages.inbound
防抖同一发送者的快速入站消息,使多条连续消息合并为一个智能体轮次。防抖按渠道 + 对话进行范围限定,并使用最新消息进行回复线程/ID。
- 防抖仅批量处理纯文本消息;媒体/附件立即刷新。
- 控制命令(例如
/queue、/new)绕过防抖,保持独立。
commands(聊天命令处理)
控制跨连接器的聊天命令启用方式。
- 文本命令必须作为独立消息发送,并使用前导
/(无纯文本别名)。 commands.text: false禁用解析聊天消息中的命令。commands.native: "auto"(默认)为 Discord/Telegram 启用原生命令,Slack 保持关闭;不支持的渠道保持纯文本。- 设为
commands.native: true|false强制全部开启或关闭,或按渠道覆盖channels.discord.commands.native、channels.telegram.commands.native、channels.slack.commands.native(bool 或"auto")。false在启动时清除 Discord/Telegram 上先前注册的命令;Slack 命令在 Slack 应用中管理。 channels.telegram.customCommands添加额外的 Telegram 机器人菜单项。名称会被规范化;与原生命令冲突的会被忽略。commands.bash: true启用! <cmd>运行主机 shell 命令(/bash <cmd>也可作为别名)。需要tools.elevated.enabled并在tools.elevated.allowFrom.<channel>中添加发送者白名单。commands.bashForegroundMs控制 bash 在后台运行前等待的时间。当 bash 任务正在运行时,新的! <cmd>请求会被拒绝(一次一个)。commands.config: true启用/config(读写openclaw.json)。channels.<provider>.configWrites控制由该渠道发起的配置变更(默认:true)。适用于/config set|unset以及提供商特定的自动迁移(Telegram 超级群组 ID 变更、Slack 频道 ID 变更)。commands.debug: true启用/debug(仅运行时覆盖)。commands.restart: true启用/restart和 gateway 工具重启动作。commands.useAccessGroups: false允许命令绕过访问组白名单/策略。- 斜杠命令和指令仅对已授权发送者有效。授权来自渠道白名单/配对以及
commands.useAccessGroups。
web(WhatsApp Web 渠道运行时)
WhatsApp 通过 Gateway网关的 Web 渠道(Baileys Web)运行。当存在已链接的会话时自动启动。
设置 web.enabled: false 使其默认关闭。
channels.telegram(机器人传输)
OpenClaw 仅在存在 channels.telegram 配置段时启动 Telegram。机器人 token 从 channels.telegram.botToken(或 channels.telegram.tokenFile)解析,TELEGRAM_BOT_TOKEN 作为默认账号的回退。
设置 channels.telegram.enabled: false 禁用自动启动。
多账号支持在 channels.telegram.accounts 下(参见上方多账号部分)。环境变量 token 仅适用于默认账号。
设置 channels.telegram.configWrites: false 阻止 Telegram 发起的配置写入(包括超级群组 ID 迁移和 /config set|unset)。
- 使用 Telegram
sendMessageDraft(草稿气泡,不是真正的消息)。 - 需要私聊话题(私信 中的 message_thread_id;机器人已启用话题)。
/reasoning stream将推理过程流式传输到草稿中,然后发送最终答案。 重试策略默认值和行为记录在重试策略中。
channels.discord(机器人传输)
通过设置机器人 token 和可选的门控配置 Discord 机器人:
多账号支持在 channels.discord.accounts 下(参见上方多账号部分)。环境变量 token 仅适用于默认账号。
channels.discord 配置段时启动 Discord。token 从 channels.discord.token 解析,DISCORD_BOT_TOKEN 作为默认账号的回退(除非 channels.discord.enabled 为 false)。在为 cron/CLI 命令指定投递目标时,使用 user:<id>(私聊)或 channel:<id>(服务器频道);裸数字 ID 有歧义会被拒绝。
服务器 slug 为小写,空格替换为 -;频道键使用 slug 化的频道名称(无前导 #)。建议使用服务器 id 作为键以避免重命名歧义。
机器人发送的消息默认被忽略。通过 channels.discord.allowBots 启用(自身消息仍会被过滤以防止自回复循环)。
反应通知模式:
off:无反应事件。own:机器人自身消息上的反应(默认)。all:所有消息上的所有反应。allowlist:guilds.<id>.users中的用户在所有消息上的反应(空列表禁用)。 出站文本按channels.discord.textChunkLimit(默认 2000)分块。设置channels.discord.chunkMode="newline"在长度分块前按空行(段落边界)分割。Discord 客户端可能裁剪过高的消息,因此channels.discord.maxLinesPerMessage(默认 17)即使在 2000 字符以内也会分割长多行回复。 重试策略默认值和行为记录在重试策略中。
channels.googlechat(Chat API webhook)
Google Chat 通过 HTTP webhook 运行,使用应用级认证(服务账号)。
多账号支持在 channels.googlechat.accounts 下(参见上方多账号部分)。环境变量仅适用于默认账号。
- 服务账号 JSON 可以内联(
serviceAccount)或基于文件(serviceAccountFile)。 - 默认账号的环境变量回退:
GOOGLE_CHAT_SERVICE_ACCOUNT或GOOGLE_CHAT_SERVICE_ACCOUNT_FILE。 audienceType+audience必须与 Chat 应用的 webhook 认证配置匹配。- 设置投递目标时使用
spaces/<spaceId>或users/<userId|email>。
channels.slack(socket 模式)
Slack 以 Socket Mode 运行,需要机器人 token 和应用 token:
channels.slack.accounts 下(参见上方多账号部分)。环境变量 token 仅适用于默认账号。
OpenClaw 在提供商启用且两个 token 都已设置时启动 Slack(通过配置或 SLACK_BOT_TOKEN + SLACK_APP_TOKEN)。在为 cron/CLI 命令指定投递目标时使用 user:<id>(私聊)或 channel:<id>。
设置 channels.slack.configWrites: false 阻止 Slack 发起的配置写入(包括频道 ID 迁移和 /config set|unset)。
机器人发送的消息默认被忽略。通过 channels.slack.allowBots 或 channels.slack.channels.<id>.allowBots 启用。
反应通知模式:
off:无反应事件。own:机器人自身消息上的反应(默认)。all:所有消息上的所有反应。allowlist:channels.slack.reactionAllowlist中的用户在所有消息上的反应(空列表禁用)。
channels.slack.thread.historyScope控制线程历史是按线程(thread,默认)还是跨频道共享(channel)。channels.slack.thread.inheritParent控制新线程会话是否继承父频道的记录(默认:false)。
slack 工具动作):
| 动作组 | 默认 | 说明 |
|---|---|---|
| reactions | 已启用 | 反应 + 列出反应 |
| messages | 已启用 | 读取/发送/编辑/删除 |
| pins | 已启用 | 固定/取消固定/列出 |
| memberInfo | 已启用 | 成员信息 |
| emojiList | 已启用 | 自定义表情列表 |
channels.mattermost(机器人 token)
Mattermost 作为插件提供,不包含在核心安装中。
请先安装:openclaw plugins install @openclaw/mattermost(或从 git checkout 使用 ./extensions/mattermost)。
Mattermost 需要机器人 token 加上服务器的基础 URL:
channels.mattermost.botToken + channels.mattermost.baseUrl 或默认账号的 MATTERMOST_BOT_TOKEN + MATTERMOST_URL 解析(除非 channels.mattermost.enabled 为 false)。
聊天模式:
oncall(默认):仅在被 @提及时响应频道消息。onmessage:响应每条频道消息。onchar:当消息以触发前缀开头时响应(channels.mattermost.oncharPrefixes,默认[">", "!"])。
- 默认私聊:
channels.mattermost.dmPolicy="pairing"(未知发送者收到配对码)。 - 公开私聊:
channels.mattermost.dmPolicy="open"加上channels.mattermost.allowFrom=["*"]。 - 群组:
channels.mattermost.groupPolicy="allowlist"为默认值(提及门控)。使用channels.mattermost.groupAllowFrom限制发送者。
channels.mattermost.accounts 下(参见上方多账号部分)。环境变量仅适用于默认账号。
指定投递目标时使用 channel:<id> 或 user:<id>(或 @username);裸 id 被视为频道 id。
channels.signal(signal-cli)
Signal 反应可以发出系统事件(共享反应工具):
off:无反应事件。own:机器人自身消息上的反应(默认)。all:所有消息上的所有反应。allowlist:channels.signal.reactionAllowlist中的用户在所有消息上的反应(空列表禁用)。
channels.imessage(imsg CLI)
OpenClaw 会生成 imsg rpc(通过 stdio 的 JSON-RPC)。无需守护进程或端口。
channels.imessage.accounts 下(参见上方多账号部分)。
说明:
- 需要对消息数据库的完全磁盘访问权限。
- 首次发送时会提示请求消息自动化权限。
- 建议使用
chat_id:<id>目标。使用imsg chats --limit 20列出聊天。 channels.imessage.cliPath可以指向包装脚本(例如ssh到另一台运行imsg rpc的 Mac);使用 SSH 密钥避免密码提示。- 对于远程 SSH 包装器,设置
channels.imessage.remoteHost以便在启用includeAttachments时通过 SCP 获取附件。
agents.defaults.workspace
设置智能体用于文件操作的单一全局工作区目录。
默认:~/.openclaw/workspace。
agents.defaults.sandbox,非主会话可以在 agents.defaults.sandbox.workspaceRoot 下使用各自的每范围工作区来覆盖此设置。
agents.defaults.repoRoot
在系统提示的 Runtime 行中显示的可选仓库根目录。如果未设置,OpenClaw 会从工作区(和当前工作目录)向上查找 .git 目录进行检测。路径必须存在才能使用。
agents.defaults.skipBootstrap
禁用自动创建工作区引导文件(AGENTS.md、SOUL.md、TOOLS.md、IDENTITY.md、USER.md 和 BOOTSTRAP.md)。
适用于工作区文件来自仓库的预置部署。
agents.defaults.bootstrapMaxChars
注入系统提示前每个工作区引导文件截断前的最大字符数。默认:20000。
当文件超过此限制时,OpenClaw 会记录警告并注入带标记的头尾截断内容。
agents.defaults.userTimezone
设置用户时区用于系统提示上下文(不用于消息信封中的时间戳)。如果未设置,OpenClaw 在运行时使用主机时区。
agents.defaults.timeFormat
控制系统提示中”当前日期和时间”部分显示的时间格式。
默认:auto(操作系统偏好)。
messages
控制入站/出站前缀和可选的确认反应。
参见消息了解排队、会话和流式上下文。
responsePrefix 应用于跨渠道的所有出站回复(工具摘要、块流式传输、最终回复),除非已存在。
如果未设置 messages.responsePrefix,默认不应用前缀。WhatsApp 自聊天回复是例外:它们在设置时默认为 [{identity.name}],否则为 [openclaw],以保持同一手机上的对话可读性。
设为 "auto" 可为路由的智能体推导 [{identity.name}](当设置时)。
模板变量
responsePrefix 字符串可以包含动态解析的模板变量:
| 变量 | 描述 | 示例 |
|---|---|---|
{model} | 短模型名称 | claude-opus-4-5、gpt-4o |
{modelFull} | 完整模型标识符 | anthropic/claude-opus-4-5 |
{provider} | 提供商名称 | anthropic、openai |
{thinkingLevel} | 当前思考级别 | high、low、off |
{identity.name} | 智能体身份名称 | (与 "auto" 模式相同) |
{MODEL} = {model})。{think} 是 {thinkingLevel} 的别名。
未解析的变量保持为字面文本。
[claude-opus-4-5 | think:high] Here's my response...
WhatsApp 入站前缀通过 channels.whatsapp.messagePrefix 配置(已弃用:messages.messagePrefix)。默认保持不变:当 channels.whatsapp.allowFrom 为空时为 "[openclaw]",否则为 ""(无前缀)。使用 "[openclaw]" 时,如果路由的智能体设置了 identity.name,OpenClaw 会改用 [{identity.name}]。
ackReaction 在支持反应的渠道(Slack/Discord/Telegram/Google Chat)上发送尽力而为的表情反应来确认入站消息。设置时默认为活跃智能体的 identity.emoji,否则为 "👀"。设为 "" 禁用。
ackReactionScope 控制反应触发时机:
group-mentions(默认):仅在群组/房间要求提及且机器人被提及时group-all:所有群组/房间消息direct:仅私聊消息all:所有消息
removeAckAfterReply 在发送回复后移除机器人的确认反应(仅 Slack/Discord/Telegram/Google Chat)。默认:false。
messages.tts
为出站回复启用文字转语音。开启后,OpenClaw 使用 ElevenLabs 或 OpenAI 生成音频并附加到回复中。Telegram 使用 Opus 语音消息;其他渠道发送 MP3 音频。
messages.tts.auto控制自动 TTS(off、always、inbound、tagged)。/tts off|always|inbound|tagged设置每会话的自动模式(覆盖配置)。messages.tts.enabled为旧版;doctor 会将其迁移为messages.tts.auto。prefsPath存储本地覆盖(提供商/限制/摘要)。maxTextLength是 TTS 输入的硬上限;摘要会被截断以适应。summaryModel覆盖自动摘要的agents.defaults.model.primary。- 接受
provider/model或来自agents.defaults.models的别名。
- 接受
modelOverrides启用模型驱动的覆盖如[[tts:...]]标签(默认开启)。/tts limit和/tts summary控制每用户的摘要设置。apiKey值回退到ELEVENLABS_API_KEY/XI_API_KEY和OPENAI_API_KEY。elevenlabs.baseUrl覆盖 ElevenLabs API 基础 URL。elevenlabs.voiceSettings支持stability/similarityBoost/style(0..1)、useSpeakerBoost和speed(0.5..2.0)。
talk
Talk 模式(macOS/iOS/Android)的默认值。语音 ID 在未设置时回退到 ELEVENLABS_VOICE_ID 或 SAG_VOICE_ID。
apiKey 在未设置时回退到 ELEVENLABS_API_KEY(或 Gateway网关的 shell 配置文件)。
voiceAliases 允许 Talk 指令使用友好名称(例如 "voice":"Clawd")。
agents.defaults
控制内置智能体运行时(模型/思考/详细/超时)。
agents.defaults.models 定义已配置的模型目录(也充当 /model 的白名单)。
agents.defaults.model.primary 设置默认模型;agents.defaults.model.fallbacks 是全局故障转移。
agents.defaults.imageModel 是可选的,仅在主模型缺少图像输入时使用。
每个 agents.defaults.models 条目可以包含:
alias(可选的模型快捷方式,例如/opus)。params(可选的提供商特定 API 参数,传递给模型请求)。
params 也应用于流式运行(内置智能体 + 压缩)。目前支持的键:temperature、maxTokens。这些与调用时选项合并;调用方提供的值优先。temperature 是高级旋钮——除非你了解模型的默认值且需要更改,否则不要设置。
示例:
- 设置
--thinking off,或 - 自行定义
agents.defaults.models["zai/<model>"].params.thinking。
agents.defaults.models 中时才应用:
opus->anthropic/claude-opus-4-5sonnet->anthropic/claude-sonnet-4-5gpt->openai/gpt-5.2gpt-mini->openai/gpt-5-minigemini->google/gemini-3-pro-previewgemini-flash->google/gemini-3-flash-preview
MINIMAX_API_KEY(环境变量)或配置 models.providers.minimax。
agents.defaults.cliBackends(CLI 回退)
可选的 CLI 后端用于纯文本回退运行(无工具调用)。当 API 提供商失败时可作为备用路径。当你配置了接受文件路径的 imageArg 时支持图像透传。
说明:
- CLI 后端以文本为主;工具始终禁用。
- 设置
sessionArg时支持会话;会话 id 按后端持久化。 - 对于
claude-cli,默认值已内置。如果 PATH 不完整(launchd/systemd),请覆盖命令路径。
agents.defaults.contextPruning(工具结果裁剪)
agents.defaults.contextPruning 在请求发送到 LLM 之前裁剪内存上下文中的旧工具结果。
它不会修改磁盘上的会话历史(*.jsonl 保持完整)。
这旨在减少随时间积累大量工具输出的智能体的 token 消耗。
概述:
- 不触及用户/助手消息。
- 保护最后
keepLastAssistants条助手消息(该点之后的工具结果不会被裁剪)。 - 保护引导前缀(第一条用户消息之前的内容不会被裁剪)。
- 模式:
adaptive:当估计的上下文比率超过softTrimRatio时,软裁剪过大的工具结果(保留头尾)。 然后当估计的上下文比率超过hardClearRatio且有足够的可裁剪工具结果量(minPrunableToolChars)时,硬清除最旧的符合条件的工具结果。aggressive:始终用hardClear.placeholder替换截止点之前符合条件的工具结果(不做比率检查)。
- 软裁剪:仅针对过大的工具结果。保留开头 + 结尾,在中间插入
...。- 之前:
toolResult("…很长的输出…") - 之后:
toolResult("HEAD…\n...\n…TAIL\n\n[Tool result trimmed: …]")
- 之前:
- 硬清除:用占位符替换整个工具结果。
- 之前:
toolResult("…很长的输出…") - 之后:
toolResult("[Old tool result content cleared]")
- 之前:
- 目前包含图像块的工具结果会被跳过(不会被裁剪/清除)。
- 估计的”上下文比率”基于字符(近似值),不是精确的 token 数。
- 如果会话尚未包含至少
keepLastAssistants条助手消息,则跳过裁剪。 - 在
aggressive模式下,hardClear.enabled被忽略(符合条件的工具结果始终被替换为hardClear.placeholder)。
mode 为 "adaptive" 或 "aggressive" 时):
keepLastAssistants:3softTrimRatio:0.3(仅 adaptive)hardClearRatio:0.5(仅 adaptive)minPrunableToolChars:50000(仅 adaptive)softTrim:{ maxChars: 4000, headChars: 1500, tailChars: 1500 }(仅 adaptive)hardClear:{ enabled: true, placeholder: "[Old tool result content cleared]" }
agents.defaults.compaction(预留空间 + 记忆刷新)
agents.defaults.compaction.mode 选择压缩摘要策略。默认为 default;设为 safeguard 可为超长历史启用分块摘要。参见 /concepts/compaction。
agents.defaults.compaction.reserveTokensFloor 为 Pi 压缩强制一个最小 reserveTokens 值(默认:20000)。设为 0 禁用此底线。
agents.defaults.compaction.memoryFlush 在自动压缩前运行一个静默智能体轮次,指示模型将持久记忆存储到磁盘(例如 memory/YYYY-MM-DD.md)。当会话 token 估计值超过压缩限制以下的软阈值时触发。
旧版默认值:
memoryFlush.enabled:truememoryFlush.softThresholdTokens:4000memoryFlush.prompt/memoryFlush.systemPrompt:带NO_REPLY的内置默认值- 注意:当会话工作区为只读时跳过记忆刷新(
agents.defaults.sandbox.workspaceAccess: "ro"或"none")。
agents.defaults.blockStreamingDefault:"on"/"off"(默认 off)。- 渠道覆盖:
*.blockStreaming(及每账号变体)强制块流式传输开/关。 非 Telegram 渠道需要显式设置*.blockStreaming: true来启用块回复。 agents.defaults.blockStreamingBreak:"text_end"或"message_end"(默认:text_end)。agents.defaults.blockStreamingChunk:流式块的软分块。默认 800–1200 字符,优先段落分隔(\n\n),然后换行,然后句子。 示例:agents.defaults.blockStreamingCoalesce:发送前合并流式块。 默认为{ idleMs: 1000 },从blockStreamingChunk继承minChars,maxChars上限为渠道文本限制。Signal/Slack/Discord/Google Chat 默认minChars: 1500,除非被覆盖。 渠道覆盖:channels.whatsapp.blockStreamingCoalesce、channels.telegram.blockStreamingCoalesce、channels.discord.blockStreamingCoalesce、channels.slack.blockStreamingCoalesce、channels.mattermost.blockStreamingCoalesce、channels.signal.blockStreamingCoalesce、channels.imessage.blockStreamingCoalesce、channels.msteams.blockStreamingCoalesce、channels.googlechat.blockStreamingCoalesce(及每账号变体)。agents.defaults.humanDelay:第一条之后块回复之间的随机延迟。 模式:off(默认)、natural(800–2500ms)、custom(使用minMs/maxMs)。 每智能体覆盖:agents.list[].humanDelay。 示例:参见 /concepts/streaming 了解行为 + 分块细节。
agents.defaults.typingMode:"never" | "instant" | "thinking" | "message"。私聊/提及默认为instant,未被提及的群聊默认为message。session.typingMode:每会话的模式覆盖。agents.defaults.typingIntervalSeconds:输入信号刷新频率(默认:6s)。session.typingIntervalSeconds:每会话的刷新间隔覆盖。 参见 /concepts/typing-indicators 了解行为细节。
agents.defaults.model.primary 应设为 provider/model(例如 anthropic/claude-opus-4-5)。
别名来自 agents.defaults.models.*.alias(例如 Opus)。
如果省略提供商,OpenClaw 目前假定 anthropic 作为临时弃用回退。
Z.AI 模型可通过 zai/<model> 使用(例如 zai/glm-4.7),需要环境中设置
ZAI_API_KEY(或旧版 Z_AI_API_KEY)。
agents.defaults.heartbeat 配置定期心跳运行:
every:持续时间字符串(ms、s、m、h);默认单位分钟。默认:30m。设为0m禁用。model:可选的心跳运行覆盖模型(provider/model)。includeReasoning:为true时,心跳也会传递单独的Reasoning:消息(与/reasoning on相同形式)。默认:false。session:可选的会话键,控制心跳在哪个会话中运行。默认:main。to:可选的收件人覆盖(渠道特定 id,例如 WhatsApp 的 E.164,Telegram 的聊天 id)。target:可选的投递渠道(last、whatsapp、telegram、discord、slack、msteams、signal、imessage、none)。默认:last。prompt:可选的心跳内容覆盖(默认:Read HEARTBEAT.md if it exists (workspace context). Follow it strictly. Do not infer or repeat old tasks from prior chats. If nothing needs attention, reply HEARTBEAT_OK.)。覆盖值按原样发送;如果仍需读取文件,请包含Read HEARTBEAT.md行。ackMaxChars:HEARTBEAT_OK之后投递前允许的最大字符数(默认:300)。
- 设置
agents.list[].heartbeat为特定智能体启用或覆盖心跳设置。 - 如果任何智能体条目定义了
heartbeat,仅那些智能体运行心跳;默认值 成为那些智能体的共享基线。
every,保持 HEARTBEAT.md 精简,和/或选择更便宜的 model。
tools.exec 配置后台执行默认值:
backgroundMs:自动后台化前的时间(ms,默认 10000)timeoutSec:超过此运行时间后自动终止(秒,默认 1800)cleanupMs:完成的会话在内存中保留多久(ms,默认 1800000)notifyOnExit:后台执行退出时加入系统事件 + 请求心跳(默认 true)applyPatch.enabled:启用实验性apply_patch(仅 OpenAI/OpenAI Codex;默认 false)applyPatch.allowModels:可选的模型 id 白名单(例如gpt-5.2或openai/gpt-5.2) 注意:applyPatch仅在tools.exec下。
tools.web 配置 Web 搜索 + 获取工具:
tools.web.search.enabled(默认:有密钥时为 true)tools.web.search.apiKey(推荐:通过openclaw configure --section web设置,或使用BRAVE_API_KEY环境变量)tools.web.search.maxResults(1–10,默认 5)tools.web.search.timeoutSeconds(默认 30)tools.web.search.cacheTtlMinutes(默认 15)tools.web.fetch.enabled(默认 true)tools.web.fetch.maxChars(默认 50000)tools.web.fetch.timeoutSeconds(默认 30)tools.web.fetch.cacheTtlMinutes(默认 15)tools.web.fetch.userAgent(可选覆盖)tools.web.fetch.readability(默认 true;禁用后仅使用基本 HTML 清理)tools.web.fetch.firecrawl.enabled(默认:设置了 API 密钥时为 true)tools.web.fetch.firecrawl.apiKey(可选;默认为FIRECRAWL_API_KEY)tools.web.fetch.firecrawl.baseUrl(默认 https://api.firecrawl.dev)tools.web.fetch.firecrawl.onlyMainContent(默认 true)tools.web.fetch.firecrawl.maxAgeMs(可选)tools.web.fetch.firecrawl.timeoutSeconds(可选)
tools.media 配置入站媒体理解(图片/音频/视频):
tools.media.models:共享模型列表(按能力标记;在每能力列表之后使用)。tools.media.concurrency:最大并发能力运行数(默认 2)。tools.media.image/tools.media.audio/tools.media.video:enabled:选择退出开关(配置了模型时默认为 true)。prompt:可选的提示覆盖(图片/视频自动附加maxChars提示)。maxChars:最大输出字符数(图片/视频默认 500;音频未设置)。maxBytes:发送的最大媒体大小(默认:图片 10MB,音频 20MB,视频 50MB)。timeoutSeconds:请求超时(默认:图片 60s,音频 60s,视频 120s)。language:可选的音频提示。attachments:附件策略(mode、maxAttachments、prefer)。scope:可选的门控(第一个匹配获胜),带match.channel、match.chatType或match.keyPrefix。models:有序的模型条目列表;失败或超大媒体回退到下一个条目。
- 每个
models[]条目:- 提供商条目(
type: "provider"或省略):provider:API 提供商 id(openai、anthropic、google/gemini、groq等)。model:模型 id 覆盖(图片必需;音频提供商默认为gpt-4o-mini-transcribe/whisper-large-v3-turbo,视频默认为gemini-3-flash-preview)。profile/preferredProfile:认证配置文件选择。
- CLI 条目(
type: "cli"):command:要运行的可执行文件。args:模板化参数(支持{{MediaPath}}、{{Prompt}}、{{MaxChars}}等)。
capabilities:可选的能力列表(image、audio、video)用于门控共享条目。省略时的默认值:openai/anthropic/minimax→ image,google→ image+audio+video,groq→ audio。prompt、maxChars、maxBytes、timeoutSeconds、language可在每个条目中覆盖。
- 提供商条目(
enabled: false),理解将被跳过;模型仍会接收原始附件。
提供商认证遵循标准模型认证顺序(认证配置文件、环境变量如 OPENAI_API_KEY/GROQ_API_KEY/GEMINI_API_KEY,或 models.providers.*.apiKey)。
示例:
agents.defaults.subagents 配置子智能体默认值:
model:生成的子智能体的默认模型(字符串或{ primary, fallbacks })。如果省略,子智能体继承调用者的模型,除非按智能体或按调用覆盖。maxConcurrent:最大并发子智能体运行数(默认 1)archiveAfterMinutes:N 分钟后自动归档子智能体会话(默认 60;设为0禁用)- 每子智能体工具策略:
tools.subagents.tools.allow/tools.subagents.tools.deny(deny 优先)
tools.profile 设置 tools.allow/tools.deny 之前的基础工具白名单:
minimal:仅session_statuscoding:group:fs、group:runtime、group:sessions、group:memory、imagemessaging:group:messaging、sessions_list、sessions_history、sessions_send、session_statusfull:无限制(与未设置相同)
agents.list[].tools.profile。
示例(默认仅消息传递,另外允许 Slack + Discord 工具):
tools.byProvider 允许你为特定提供商(或单个 provider/model)进一步限制工具。
每智能体覆盖:agents.list[].tools.byProvider。
顺序:基础配置文件 → 提供商配置文件 → allow/deny 策略。
提供商键接受 provider(例如 google-antigravity)或 provider/model
(例如 openai/gpt-5.2)。
示例(保持全局编码配置文件,但为 Google Antigravity 使用最小工具):
tools.allow / tools.deny 配置全局工具允许/拒绝策略(deny 优先)。
匹配不区分大小写并支持 * 通配符("*" 表示所有工具)。
即使 Docker 沙盒关闭,此策略也会应用。
示例(全局禁用 browser/canvas):
group:runtime:exec、bash、processgroup:fs:read、write、edit、apply_patchgroup:sessions:sessions_list、sessions_history、sessions_send、sessions_spawn、session_statusgroup:memory:memory_search、memory_getgroup:web:web_search、web_fetchgroup:ui:browser、canvasgroup:automation:cron、gatewaygroup:messaging:messagegroup:nodes:nodesgroup:openclaw:所有内置 OpenClaw 工具(不包含提供商插件)
tools.elevated 控制提升(主机)执行访问:
enabled:允许提升模式(默认 true)allowFrom:每渠道白名单(空 = 禁用)whatsapp:E.164 号码telegram:聊天 id 或用户名discord:用户 id 或用户名(省略时回退到channels.discord.dm.allowFrom)signal:E.164 号码imessage:句柄/聊天 idwebchat:会话 id 或用户名
tools.elevated是全局基线。agents.list[].tools.elevated只能进一步限制(两者都必须允许)。/elevated on|off|ask|full按会话键存储状态;内联指令仅应用于单条消息。- 提升的
exec在主机上运行并绕过沙盒。 - 工具策略仍然适用;如果
exec被拒绝,则无法使用提升。
agents.defaults.maxConcurrent 设置跨会话可并行执行的内置智能体运行的最大数量。每个会话仍然是串行的(每个会话键同时只有一个运行)。默认:1。
agents.defaults.sandbox
为内置智能体提供可选的 Docker 沙盒。适用于非主会话,使其无法访问你的主机系统。
详情:沙盒
默认值(如果启用):
- scope:
"agent"(每个智能体一个容器 + 工作区) - 基于 Debian bookworm-slim 的镜像
- 智能体工作区访问:
workspaceAccess: "none"(默认)"none":在~/.openclaw/sandboxes下使用每范围的沙盒工作区
"ro":将沙盒工作区保持在/workspace,智能体工作区以只读方式挂载到/agent(禁用write/edit/apply_patch)"rw":将智能体工作区以读写方式挂载到/workspace
- 自动清理:空闲超过 24h 或存在超过 7d
- 工具策略:仅允许
exec、process、read、write、edit、apply_patch、sessions_list、sessions_history、sessions_send、sessions_spawn、session_status(deny 优先)- 通过
tools.sandbox.tools配置,通过agents.list[].tools.sandbox.tools进行每智能体覆盖 - 沙盒策略中支持工具组简写:
group:runtime、group:fs、group:sessions、group:memory(参见沙盒 vs 工具策略 vs 提升)
- 通过
- 可选的沙盒浏览器(Chromium + CDP,noVNC 观察器)
- 加固旋钮:
network、user、pidsLimit、memory、cpus、ulimits、seccompProfile、apparmorProfile
scope: "shared" 意味着共享容器和共享工作区。无跨会话隔离。使用 scope: "session" 获得每会话隔离。
旧版:perSession 仍然支持(true → scope: "session",false → scope: "shared")。
setupCommand 在容器创建后运行一次(在容器内通过 sh -lc 执行)。
对于包安装,确保网络出口、可写根文件系统和 root 用户。
network: "none";如果智能体需要出站访问,请将 agents.defaults.sandbox.docker.network 设为 "bridge"(或你的自定义网络)。
注意:入站附件会暂存到活跃工作区的 media/inbound/* 中。使用 workspaceAccess: "rw" 时,文件会写入智能体工作区。
注意:docker.binds 挂载额外的主机目录;全局和每智能体的 binds 会合并。
构建可选的浏览器镜像:
agents.defaults.sandbox.browser.enabled=true 时,浏览器工具使用沙盒化的
Chromium 实例(CDP)。如果启用了 noVNC(headless=false 时默认启用),
noVNC URL 会注入系统提示中,以便智能体可以引用它。
这不需要主配置中的 browser.enabled;沙盒控制 URL 按会话注入。
agents.defaults.sandbox.browser.allowHostControl(默认:false)允许
沙盒会话通过浏览器工具显式访问主机浏览器控制服务器
(target: "host")。如果你需要严格的沙盒隔离,请保持关闭。
远程控制白名单:
allowedControlUrls:target: "custom"允许的精确控制 URL。allowedControlHosts:允许的主机名(仅主机名,无端口)。allowedControlPorts:允许的端口(默认:http=80,https=443)。 默认:所有白名单未设置(无限制)。allowHostControl默认为 false。
models(自定义提供商 + 基础 URL)
OpenClaw 使用 pi-coding-agent 模型目录。你可以通过编写
~/.openclaw/agents/<agentId>/agent/models.json 或在 OpenClaw 配置中的 models.providers 下定义相同的 schema 来添加自定义提供商(LiteLLM、本地 OpenAI 兼容服务器、Anthropic 代理等)。
按提供商的概述 + 示例:/concepts/model-providers。
当存在 models.providers 时,OpenClaw 在启动时将 models.json 写入/合并到
~/.openclaw/agents/<agentId>/agent/:
- 默认行为:合并(保留现有提供商,按名称覆盖)
- 设为
models.mode: "replace"覆盖文件内容
agents.defaults.model.primary(provider/model)选择模型。
OpenCode Zen(多模型代理)
OpenCode Zen 是一个具有每模型端点的多模型网关。OpenClaw 使用 pi-ai 内置的opencode 提供商;从 https://opencode.ai/auth 设置 OPENCODE_API_KEY(或
OPENCODE_ZEN_API_KEY)。
说明:
- 模型引用使用
opencode/<modelId>(示例:opencode/claude-opus-4-5)。 - 如果你通过
agents.defaults.models启用白名单,请添加你计划使用的每个模型。 - 快捷方式:
openclaw onboard --auth-choice opencode-zen。
Z.AI(GLM-4.7)— 提供商别名支持
Z.AI 模型通过内置的zai 提供商提供。在环境中设置 ZAI_API_KEY
并通过 provider/model 引用模型。
快捷方式:openclaw onboard --auth-choice zai-api-key。
z.ai/*和z-ai/*是接受的别名,规范化为zai/*。- 如果缺少
ZAI_API_KEY,对zai/*的请求将在运行时因认证错误失败。 - 示例错误:
No API key found for provider "zai". - Z.AI 的通用 API 端点是
https://api.z.ai/api/paas/v4。GLM 编码 请求使用专用编码端点https://api.z.ai/api/coding/paas/v4。 内置的zai提供商使用编码端点。如果你需要通用 端点,请在models.providers中定义自定义提供商并覆盖基础 URL (参见上方自定义提供商部分)。 - 在文档/配置中使用假占位符;切勿提交真实 API 密钥。
Moonshot AI(Kimi)
使用 Moonshot 的 OpenAI 兼容端点:- 在环境中设置
MOONSHOT_API_KEY或使用openclaw onboard --auth-choice moonshot-api-key。 - 模型引用:
moonshot/kimi-k2.5。 - 如需中国端点,使用
https://api.moonshot.cn/v1。
Kimi Coding
使用 Moonshot AI 的 Kimi Coding 端点(Anthropic 兼容,内置提供商):- 在环境中设置
KIMI_API_KEY或使用openclaw onboard --auth-choice kimi-code-api-key。 - 模型引用:
kimi-coding/k2p5。
Synthetic(Anthropic 兼容)
使用 Synthetic 的 Anthropic 兼容端点:- 设置
SYNTHETIC_API_KEY或使用openclaw onboard --auth-choice synthetic-api-key。 - 模型引用:
synthetic/hf:MiniMaxAI/MiniMax-M2.1。 - 基础 URL 应省略
/v1,因为 Anthropic 客户端会自动附加。
本地模型(LM Studio)— 推荐设置
参见 /gateway/local-models 了解当前本地指南。简而言之:在高性能硬件上通过 LM Studio Responses API 运行 MiniMax M2.1;保留托管模型合并作为回退。MiniMax M2.1
不通过 LM Studio 直接使用 MiniMax M2.1:- 设置
MINIMAX_API_KEY环境变量或使用openclaw onboard --auth-choice minimax-api。 - 可用模型:
MiniMax-M2.1(默认)。 - 如需精确费用跟踪,请在
models.json中更新定价。
Cerebras(GLM 4.6 / 4.7)
通过 Cerebras 的 OpenAI 兼容端点使用:- Cerebras 使用
cerebras/zai-glm-4.7;Z.AI 直连使用zai/glm-4.7。 - 在环境或配置中设置
CEREBRAS_API_KEY。
- 支持的 API:
openai-completions、openai-responses、anthropic-messages、google-generative-ai - 对于自定义认证需求使用
authHeader: true+headers。 - 如果你希望
models.json存储在其他位置,请使用OPENCLAW_AGENT_DIR(或PI_CODING_AGENT_DIR)覆盖智能体配置根目录(默认:~/.openclaw/agents/main/agent)。
session
控制会话作用域、重置策略、重置触发器以及会话存储的写入位置。
mainKey:私聊桶键(默认:"main")。当你想”重命名”主私聊线程而不更改agentId时有用。- 沙盒说明:
agents.defaults.sandbox.mode: "non-main"使用此键检测主会话。任何不匹配mainKey的会话键(群组/频道)都会被沙盒化。
- 沙盒说明:
dmScope:私聊会话如何分组(默认:"main")。main:所有私聊共享主会话以保持连续性。per-peer:按发送者 id 跨渠道隔离私聊。per-channel-peer:按渠道 + 发送者隔离私聊(推荐用于多用户收件箱)。per-account-channel-peer:按账号 + 渠道 + 发送者隔离私聊(推荐用于多账号收件箱)。
identityLinks:将规范 id 映射到提供商前缀的对等方,以便在使用per-peer、per-channel-peer或per-account-channel-peer时同一人跨渠道共享私聊会话。- 示例:
alice: ["telegram:123456789", "discord:987654321012345678"]。
- 示例:
reset:主重置策略。默认为 Gateway网关主机上本地时间凌晨 4:00 每日重置。mode:daily或idle(当存在reset时默认:daily)。atHour:本地小时(0-23)作为每日重置边界。idleMinutes:滑动空闲窗口(分钟)。当 daily + idle 都配置时,先到期的获胜。
resetByType:dm、group和thread的每会话覆盖。- 如果你只设置了旧版
session.idleMinutes而没有任何reset/resetByType,OpenClaw 保持仅空闲模式以向后兼容。
- 如果你只设置了旧版
heartbeatIdleMinutes:可选的心跳检查空闲覆盖(启用时每日重置仍然适用)。agentToAgent.maxPingPongTurns:请求者/目标之间的最大回复轮次(0–5,默认 5)。sendPolicy.default:无规则匹配时的allow或deny回退。sendPolicy.rules[]:按channel、chatType(direct|group|room)或keyPrefix(例如cron:)匹配。第一个 deny 获胜;否则 allow。
skills(Skills配置)
控制内置白名单、安装偏好、额外 Skills 文件夹和每 Skills 覆盖。适用于内置Skills 和 ~/.openclaw/skills(工作区 Skills 在名称冲突时仍然优先)。
字段:
allowBundled:可选的仅内置Skills 白名单。如果设置,仅那些内置 Skills 符合条件(管理/工作区 Skills 不受影响)。load.extraDirs:额外要扫描的 Skills 目录(最低优先级)。install.preferBrew:可用时优先使用 brew 安装程序(默认:true)。install.nodeManager:node 安装偏好(npm|pnpm|yarn,默认:npm)。entries.<skillKey>:每 Skills配置覆盖。
enabled:设为false禁用 Skills,即使它是内置/已安装的。env:为智能体运行注入的环境变量(仅在尚未设置时)。apiKey:对于声明了主环境变量的 Skills 的可选便利字段(例如nano-banana-pro→GEMINI_API_KEY)。
plugins(扩展)
控制插件发现、允许/拒绝和每插件配置。插件从 ~/.openclaw/extensions、<workspace>/.openclaw/extensions 以及任何 plugins.load.paths 条目加载。配置更改需要重启 Gateway网关。
参见 /plugin 了解全部用法。
字段:
enabled:插件加载的主开关(默认:true)。allow:可选的插件 id 白名单;设置后仅加载列出的插件。deny:可选的插件 id 拒绝列表(deny 优先)。load.paths:要加载的额外插件文件或目录(绝对路径或~)。entries.<pluginId>:每插件覆盖。enabled:设为false禁用。config:插件特定的配置对象(如果提供,由插件验证)。
browser(OpenClaw 管理的浏览器)
OpenClaw 可以为 OpenClaw 启动一个专用、隔离的 Chrome/Brave/Edge/Chromium 实例并暴露一个小型 local loopback 控制服务。
配置文件可以通过 profiles.<name>.cdpUrl 指向远程 Chromium 浏览器。远程配置文件为仅附加模式(start/stop/reset 被禁用)。
browser.cdpUrl 保留用于旧版单配置文件配置,以及作为仅设置 cdpPort 的配置文件的基础 scheme/host。
默认值:
- enabled:
true - evaluateEnabled:
true(设为false禁用act:evaluate和wait --fn) - 控制服务:仅 local loopback(端口从
gateway.port派生,默认18791) - CDP URL:
http://127.0.0.1:18792(控制服务 + 1,旧版单配置文件) - 配置文件颜色:
#FF4500(龙虾橙) - 注意:控制服务器由运行中的 Gateway网关(OpenClaw.app 菜单栏或
openclaw gateway)启动。 - 自动检测顺序:如果为 Chromium 内核则使用默认浏览器;否则 Chrome → Brave → Edge → Chromium → Chrome Canary。
ui(外观)
原生应用用于 UI 外观的可选强调色(例如 Talk 模式气泡着色)。
如果未设置,客户端回退到柔和的浅蓝色。
gateway(Gateway网关服务器模式 + 绑定)
使用 gateway.mode 明确声明此机器是否应运行 Gateway网关。
默认值:
- mode:未设置(视为”不自动启动”)
- bind:
loopback - port:
18789(WS + HTTP 单端口)
gateway.controlUi.basePath设置控制台 UI 提供服务的 URL 前缀。- 示例:
"/ui"、"/openclaw"、"/apps/openclaw"。 - 默认:根路径(
/)(不变)。 gateway.controlUi.allowInsecureAuth允许在省略设备身份时对控制台 UI 进行仅 token 认证(通常通过 HTTP)。默认:false。建议使用 HTTPS(Tailscale Serve)或127.0.0.1。gateway.controlUi.dangerouslyDisableDeviceAuth禁用控制台 UI 的设备身份检查(仅 token/密码)。默认:false。仅用于紧急情况。
gateway.trustedProxies:在 Gateway网关前面终止 TLS 的反向代理 IP 列表。- 当连接来自这些 IP 之一时,OpenClaw 使用
x-forwarded-for(或x-real-ip)来确定客户端 IP,用于本地配对检查和 HTTP 认证/本地检查。 - 仅列出你完全控制的代理,并确保它们覆盖传入的
x-forwarded-for。
openclaw gateway拒绝启动,除非gateway.mode设为local(或你传递了覆盖标志)。gateway.port控制用于 WebSocket + HTTP(控制台 UI、hooks、A2UI)的单一多路复用端口。- OpenAI Chat Completions 端点:默认禁用;通过
gateway.http.endpoints.chatCompletions.enabled: true启用。 - 优先级:
--port>OPENCLAW_GATEWAY_PORT>gateway.port> 默认18789。 - 默认需要 Gateway网关认证(token/密码或 Tailscale Serve 身份)。非 local loopback 绑定需要共享 token/密码。
- 新手引导向导默认生成 gateway token(即使在 local loopback 上)。
gateway.remote.token仅用于远程 CLI 调用;它不启用本地 gateway 认证。gateway.token被忽略。
gateway.auth.mode设置握手要求(token或password)。未设置时,假定 token 认证。gateway.auth.token存储 token 认证的共享 token(同一机器上的 CLI 使用)。- 当设置了
gateway.auth.mode时,仅接受该方法(加上可选的 Tailscale 头部)。 gateway.auth.password可在此设置,或通过OPENCLAW_GATEWAY_PASSWORD(推荐)。gateway.auth.allowTailscale允许 Tailscale Serve 身份头部 (tailscale-user-login)在请求通过 local loopback 到达且带有x-forwarded-for、x-forwarded-proto和x-forwarded-host时满足认证。OpenClaw 在接受之前 通过tailscale whois解析x-forwarded-for地址来验证身份。为true时, Serve 请求不需要 token/密码;设为false要求显式凭据。当tailscale.mode = "serve"且认证模式不是password时默认为true。gateway.tailscale.mode: "serve"使用 Tailscale Serve(仅 tailnet,local loopback 绑定)。gateway.tailscale.mode: "funnel"公开暴露仪表板;需要认证。gateway.tailscale.resetOnExit在关闭时重置 Serve/Funnel 配置。
gateway.remote.url设置gateway.mode = "remote"时 CLI 调用的默认 Gateway网关 WebSocket URL。gateway.remote.transport选择 macOS 远程传输(ssh默认,direct用于 ws/wss)。使用direct时,gateway.remote.url必须为ws://或wss://。ws://host默认端口18789。gateway.remote.token提供远程调用的 token(不需要认证时留空)。gateway.remote.password提供远程调用的密码(不需要认证时留空)。
- OpenClaw.app 监视
~/.openclaw/openclaw.json,当gateway.mode或gateway.remote.url变更时实时切换模式。 - 如果
gateway.mode未设置但gateway.remote.url已设置,macOS 应用将其视为远程模式。 - 当你在 macOS 应用中更改连接模式时,它会将
gateway.mode(以及远程模式下的gateway.remote.url+gateway.remote.transport)写回配置文件。
gateway.reload(配置热重载)
Gateway网关监视 ~/.openclaw/openclaw.json(或 OPENCLAW_CONFIG_PATH)并自动应用更改。
模式:
hybrid(默认):安全更改热应用;关键更改重启 Gateway网关。hot:仅应用热安全更改;需要重启时记录日志。restart:任何配置更改都重启 Gateway网关。off:禁用热重载。
热重载矩阵(文件 + 影响)
监视的文件:~/.openclaw/openclaw.json(或OPENCLAW_CONFIG_PATH)
hooks(webhook 认证/路径/映射)+hooks.gmail(Gmail 监视器重启)browser(浏览器控制服务器重启)cron(cron 服务重启 + 并发更新)agents.defaults.heartbeat(心跳运行器重启)web(WhatsApp Web 渠道重启)telegram、discord、signal、imessage(渠道重启)agent、models、routing、messages、session、whatsapp、logging、skills、ui、talk、identity、wizard(动态读取)
gateway(端口/绑定/认证/控制台 UI/tailscale)bridge(旧版)discoverycanvasHostplugins- 任何未知/不支持的配置路径(为安全默认重启)
多实例隔离
要在一台主机上运行多个 Gateway网关(用于冗余或救援机器人),请隔离每个实例的状态 + 配置并使用唯一端口:OPENCLAW_CONFIG_PATH(每实例配置)OPENCLAW_STATE_DIR(会话/凭据)agents.defaults.workspace(记忆)gateway.port(每实例唯一)
openclaw --dev …→ 使用~/.openclaw-dev+ 端口从基础19001偏移openclaw --profile <name> …→ 使用~/.openclaw-<name>(端口通过配置/环境变量/标志)
hooks(Gateway网关 webhook)
在 Gateway网关 HTTP 服务器上启用简单的 HTTP webhook 端点。
默认值:
- enabled:
false - path:
/hooks - maxBodyBytes:
262144(256 KB)
Authorization: Bearer <token>或x-openclaw-token: <token>或?token=<token>
POST /hooks/wake→{ text, mode?: "now"|"next-heartbeat" }POST /hooks/agent→{ message, name?, sessionKey?, wakeMode?, deliver?, channel?, to?, model?, thinking?, timeoutSeconds? }POST /hooks/<name>→ 通过hooks.mappings解析
/hooks/agent 始终将摘要发布到主会话(并可通过 wakeMode: "now" 可选地触发即时心跳)。
映射说明:
match.path匹配/hooks之后的子路径(例如/hooks/gmail→gmail)。match.source匹配负载字段(例如{ source: "gmail" }),以便使用通用的/hooks/ingest路径。{{messages[0].subject}}等模板从负载中读取。transform可以指向返回 hook 动作的 JS/TS 模块。deliver: true将最终回复发送到渠道;channel默认为last(回退到 WhatsApp)。- 如果没有先前的投递路由,请显式设置
channel+to(Telegram/Discord/Google Chat/Slack/Signal/iMessage/MS Teams 必需)。 model覆盖此 hook 运行的 LLM(provider/model或别名;如果设置了agents.defaults.models则必须被允许)。
openclaw webhooks gmail setup / run 使用):
hooks.gmail.model指定用于 Gmail hook 处理的模型(默认为会话主模型)。- 接受
provider/model引用或来自agents.defaults.models的别名。 - 在认证/速率限制/超时时回退到
agents.defaults.model.fallbacks,然后agents.defaults.model.primary。 - 如果设置了
agents.defaults.models,请将 hooks 模型包含在白名单中。 - 启动时,如果配置的模型不在模型目录或白名单中,会发出警告。
hooks.gmail.thinking设置 Gmail hook 的默认思考级别,被每 hook 的thinking覆盖。
- 如果
hooks.enabled=true且hooks.gmail.account已设置,Gateway网关在启动时 启动gog gmail watch serve并自动续期监视。 - 设置
OPENCLAW_SKIP_GMAIL_WATCHER=1禁用自动启动(用于手动运行)。 - 避免在 Gateway网关旁边单独运行
gog gmail watch serve;它会 因listen tcp 127.0.0.1:8788: bind: address already in use而失败。
tailscale.mode 开启时,OpenClaw 将 serve.path 默认为 /,以便
Tailscale 可以正确代理 /gmail-pubsub(它会去除设置的路径前缀)。
如果你需要后端接收带前缀的路径,请将
hooks.gmail.tailscale.target 设为完整 URL(并对齐 serve.path)。
canvasHost(LAN/tailnet Canvas 文件服务器 + 实时重载)
Gateway网关通过 HTTP 提供 HTML/CSS/JS 目录服务,以便 iOS/Android 节点可以简单地 canvas.navigate 到它。
默认根目录:~/.openclaw/workspace/canvas
默认端口:18793(选择此端口以避免 OpenClaw 浏览器 CDP 端口 18792)
服务器监听 Gateway网关绑定主机(LAN 或 Tailnet),以便节点可以访问。
服务器:
- 提供
canvasHost.root下的文件 - 向提供的 HTML 注入微型实时重载客户端
- 监视目录并通过
/__openclaw__/ws的 WebSocket 端点广播重载 - 目录为空时自动创建起始
index.html(以便你立即看到内容) - 同时在
/__openclaw__/a2ui/提供 A2UI,并作为canvasHostUrl通告给节点 (节点始终使用它来访问 Canvas/A2UI)
EMFILE,请禁用实时重载(和文件监视):
- 配置:
canvasHost: { liveReload: false }
canvasHost.* 的更改需要重启 Gateway网关(配置重载会触发重启)。
禁用方式:
- 配置:
canvasHost: { enabled: false } - 环境变量:
OPENCLAW_SKIP_CANVAS_HOST=1
bridge(旧版 TCP 桥接,已移除)
当前版本不再包含 TCP 桥接监听器;bridge.* 配置键会被忽略。
节点通过 Gateway网关 WebSocket 连接。此部分仅保留供历史参考。
旧版行为:
- Gateway网关可以为节点(iOS/Android)暴露简单的 TCP 桥接,通常在端口
18790。
- enabled:
true - port:
18790 - bind:
lan(绑定到0.0.0.0)
lan:0.0.0.0(可通过任何接口访问,包括 LAN/Wi‑Fi 和 Tailscale)tailnet:仅绑定到机器的 Tailscale IP(推荐用于跨地域访问)loopback:127.0.0.1(仅本地)auto:如果存在 tailnet IP 则优先使用,否则lan
bridge.tls.enabled:为桥接连接启用 TLS(启用时仅 TLS)。bridge.tls.autoGenerate:当无证书/密钥时生成自签名证书(默认:true)。bridge.tls.certPath/bridge.tls.keyPath:桥接证书 + 私钥的 PEM 路径。bridge.tls.caPath:可选的 PEM CA 捆绑包(自定义根证书或未来的 mTLS)。
bridgeTls=1 和 bridgeTlsSha256,以便节点可以固定证书。如果尚未存储指纹,手动连接使用首次信任。
自动生成的证书需要 PATH 中有 openssl;如果生成失败,桥接不会启动。
discovery.mdns(Bonjour / mDNS 广播模式)
控制 LAN mDNS 发现广播(_openclaw-gw._tcp)。
minimal(默认):从 TXT 记录中省略cliPath+sshPortfull:在 TXT 记录中包含cliPath+sshPortoff:完全禁用 mDNS 广播- 主机名:默认为
openclaw(通告openclaw.local)。通过OPENCLAW_MDNS_HOSTNAME覆盖。
discovery.wideArea(广域 Bonjour / 单播 DNS‑SD)
启用后,Gateway网关在 ~/.openclaw/dns/ 下使用配置的发现域(示例:openclaw.internal.)为 _openclaw-gw._tcp 写入单播 DNS-SD 区域。
要使 iOS/Android 跨网络发现(跨地域访问),请配合以下使用:
- 在 Gateway网关主机上运行 DNS 服务器,为你选择的域名提供服务(推荐 CoreDNS)
- Tailscale split DNS,使客户端通过 Gateway网关 DNS 服务器解析该域名
模板变量
模板占位符在tools.media.*.models[].args 和 tools.media.models[].args(以及未来任何模板化参数字段)中展开。
| 变量 | 描述 |
| ------------------ | ----------------------------------------------------- | -------- | ------- | ---------- | ----- | ------ | -------- | ------- | ------- | --- |
| {{Body}} | 完整的入站消息正文 |
| {{RawBody}} | 原始入站消息正文(无历史/发送者包装;最适合命令解析) |
| {{BodyStripped}} | 去除群组提及的正文(最适合智能体的默认值) |
| {{From}} | 发送者标识符(WhatsApp 为 E.164;按渠道可能不同) |
| {{To}} | 目标标识符 |
| {{MessageSid}} | 渠道消息 id(如果可用) |
| {{SessionId}} | 当前会话 UUID |
| {{IsNewSession}} | 创建新会话时为 "true" |
| {{MediaUrl}} | 入站媒体伪 URL(如果存在) |
| {{MediaPath}} | 本地媒体路径(如果已下载) |
| {{MediaType}} | 媒体类型(image/audio/document/…) |
| {{Transcript}} | 音频转录(启用时) |
| {{Prompt}} | CLI 条目的已解析媒体提示 |
| {{MaxChars}} | CLI 条目的已解析最大输出字符数 |
| {{ChatType}} | "direct" 或 "group" |
| {{GroupSubject}} | 群组主题(尽力而为) |
| {{GroupMembers}} | 群组成员预览(尽力而为) |
| {{SenderName}} | 发送者显示名称(尽力而为) |
| {{SenderE164}} | 发送者电话号码(尽力而为) |
| {{Provider}} | 提供商提示(whatsapp | telegram | discord | googlechat | slack | signal | imessage | msteams | webchat | …) |
Cron(Gateway网关调度器)
Cron 是 Gateway网关自有的唤醒和定时任务调度器。参见 Cron 任务 了解功能概述和 CLI 示例。下一步:智能体运行时 🦞