教程

OpenClaw 配置文件完全指南:openclaw.json 所有字段详解与实用示例

OpenClaw 核心配置文件 openclaw.json 完整说明:配置文件位置与格式(JSON5)、各频道配置结构(Telegram/Discord/WhatsApp/Slack)、AI 模型设置与 API Key 配置、agents 工作区路径设置、Cron 定时任务配置、工具开关配置(Browser/Exec/Web)、热重载机制、配置验证与 openclaw doctor 诊断,以及完整可复制的生产级配置示例。

2026/3/174分钟 阅读ClaudeEagle

OpenClaw 的所有行为都通过一个核心配置文件控制:~/.openclaw/openclaw.json。 本文提供完整字段说明和可直接复制的配置模板。

配置文件基础

位置与格式

文件路径:~/.openclaw/openclaw.json 格式:JSON5(支持注释!普通 JSON 也兼容)

JSON5 的优势:可以写注释(///* */),方便记录配置目的。

json5
// ~/.openclaw/openclaw.json
{
  // 这是一条注释,JSON5 支持!
  channels: {
    telegram: {
      token: "你的Bot Token",  // BotFather 给的
      allowFrom: ["12345678"], // 允许的用户 ID 列表
    }
  }
}

编辑方式

bash
# 方式 1:交互式向导(推荐新手)
openclaw configure

# 方式 2:命令行直接设置
openclaw config set channels.telegram.token "你的token"
openclaw config get agents.defaults.workspace

# 方式 3:直接编辑文件
nano ~/.openclaw/openclaw.json

# 方式 4:Dashboard UI(浏览器)
openclaw dashboard  # 打开后找 Config 标签

热重载(无需重启)

修改 openclaw.json 后,Gateway 会自动检测并应用大部分配置变更, 无需手动重启。例外:新频道连接、模型切换需重启。

bash
# 手动触发重载(或有些场景需要)
openclaw gateway reload

# 验证配置是否有效(变更前先检查)
openclaw config validate

完整配置字段说明

频道配置(channels)

json5
{
  channels: {
    // ── Telegram ──
    telegram: {
      token: "1234567890:AAFxxx",  // 必填,BotFather 生成
      allowFrom: ["123456789"],     // 允许的用户 ID(数字字符串)
      allowFromUsernames: ["alice"], // 允许的用户名(不含@)
      groups: {
        "*": { requireMention: true }  // 群组里必须 @Bot 才响应
      }
    },

    // ── Discord ──
    discord: {
      token: "Bot Token",
      allowedGuilds: ["服务器ID"],
      allowedChannels: ["频道ID"],
      mentionRequired: true,
    },

    // ── WhatsApp ──
    whatsapp: {
      allowFrom: ["+8613800000000"],  // E.164 格式手机号
      groups: {
        "群组名称": { requireMention: true }
      }
    },

    // ── Slack ──
    slack: {
      botToken: "xoxb-xxx",
      appToken: "xapp-xxx",
      allowedUsers: ["U01234"],
    },
  }
}

AI 代理配置(agents)

json5
{
  agents: {
    defaults: {
      // 工作区目录(SOUL.md、MEMORY.md 等存放位置)
      workspace: "~/.openclaw/workspace-content",

      // 默认 AI 模型
      model: "claude-sonnet-4-5",

      // 心跳任务(定期自动执行)
      heartbeat: {
        enabled: true,
        every: "30m",  // 每 30 分钟触发一次
        prompt: "Read HEARTBEAT.md if it exists. If nothing needs attention, reply HEARTBEAT_OK."
      },

      // 会话压缩(长对话自动压缩节省 Token)
      session: {
        compression: {
          enabled: true,
          triggerTokens: 80000,  // 超过 80K tokens 触发压缩
        }
      }
    }
  }
}

工具开关(tools)

json5
{
  tools: {
    // 浏览器工具(Playwright 网页自动化)
    browser: {
      enabled: true,
      sandbox: true,
    },

    // 命令执行工具
    exec: {
      enabled: true,
      sandbox: "docker",  // 在 Docker 中隔离执行
      allowedCommands: ["git", "npm", "python3"],
    },

    // 网络搜索工具
    web: {
      enabled: true,
      search: {
        provider: "brave",
        apiKey: "BSA_xxx",  // Brave Search API Key
      }
    },

    // TTS(文字转语音)
    tts: {
      enabled: true,
      provider: "elevenlabs",
      apiKey: "EL_xxx",
    }
  }
}

Cron 定时任务(cron)

json5
{
  cron: {
    jobs: [
      {
        id: "morning-briefing",
        schedule: "0 8 * * 1-5",  // 周一到周五 8:00
        task: "给我发早报:今日天气 + 日历事项 + 重要邮件摘要"
      },
      {
        id: "weekly-summary",
        schedule: "0 18 * * 5",  // 周五 18:00
        task: "总结本周工作进展,发送到 Telegram"
      }
    ]
  }
}

完整生产配置模板

以下是一个完整的个人使用配置,可直接复制修改:

json5
// ~/.openclaw/openclaw.json(生产级个人配置)
{
  // AI 代理设置
  agents: {
    defaults: {
      workspace: "~/.openclaw/workspace-content",
      model: "claude-sonnet-4-5",
      heartbeat: {
        enabled: true,
        every: "30m",
      },
      session: {
        compression: { enabled: true, triggerTokens: 80000 }
      }
    }
  },

  // 频道:只开启 Telegram
  channels: {
    telegram: {
      token: "你的Bot Token",
      allowFrom: ["你的Telegram用户ID"],
    }
  },

  // 工具
  tools: {
    browser: { enabled: true },
    exec: { enabled: true },
    web: {
      enabled: true,
      search: { provider: "brave", apiKey: "你的Brave API Key" }
    }
  },

  // 日志
  logging: {
    level: "info",
  }
}

配置验证与诊断

bash
# 检查配置文件语法和字段有效性
openclaw config validate

# 全面诊断(推荐每次重大变更后运行)
openclaw doctor

# 常见 doctor 输出说明:
# ✅ Config valid           — 配置文件语法正确
# ✅ Telegram connected     — Telegram Bot 正常连接
# ⚠️  No AI provider found  — 未配置 API Key,需要设置
# ❌ Workspace not found    — 工作区目录不存在,需要创建

来源:OpenClaw 官方文档 - docs.openclaw.ai/gateway/configuration

相关文章推荐

教程OpenClaw Standing Orders 完全指南:让 AI 记住你的长期规则和行为偏好OpenClaw Standing Orders(常驻指令)功能完整教程:Standing Orders 与 SOUL.md 的区别(动态运行时规则 vs 静态人格文件)、通过对话动态添加/查看/删除常驻指令、指令的持久化存储与跨会话生效机制、适合写入 Standing Orders 的内容类型(格式偏好/禁止行为/固定工作流)、与 Hooks 的协同使用、按渠道/Agent 设置不同的 Standing Orders,以及常驻指令的最佳实践(写清晰的规则、避免矛盾冲突、定期清理过时规则)。2026/3/26教程OpenClaw 多媒体处理完全指南:图片识别、音频转写与视频理解实战OpenClaw 多媒体处理(Media)完整教程:发送图片给 AI 进行视觉分析(OCR/物体识别/图表解读/代码截图)、音频消息自动转写为文字(Whisper/系统STT)、视频消息关键帧提取与理解、Node 摄像头实时拍照触发分析、媒体消息的渠道支持差异(各渠道的图片/音频/视频支持情况对比)、大文件处理策略(分割/压缩/超时设置)、媒体消息在不同 AI 模型上的能力对比(Claude Vision/GPT-4V/Gemini Pro Vision),以及本地媒体文件分析(read 工具读取图片路径)。2026/3/25教程OpenClaw TUI 完全指南:纯键盘操作的终端管理界面使用详解OpenClaw TUI(Terminal User Interface,终端用户界面)完整使用指南:TUI 与 Control UI(浏览器)的定位对比、适合 TUI 的场景(SSH 远程/无浏览器服务器/低带宽环境)、启动命令(openclaw tui)及参数、界面布局(Agents 面板/Sessions 面板/Channels 状态/Logs 实时流)、全键盘快捷键手册(导航/选择/搜索/刷新/退出)、在 TUI 中发送测试消息、实时日志过滤与搜索,以及 TUI 与 tmux/screen 配合使用的后台运行方案。2026/3/25教程OpenClaw Control UI 与 Dashboard 完全指南:浏览器管理 AI 助手的全功能界面OpenClaw Control UI(控制面板)与 Dashboard(仪表盘)完整使用指南:Control UI 的功能布局(Agents 管理/Tools 工具面板/Sessions 会话查看/Channel 渠道状态)、浏览器访问方式(本地 localhost:18789 vs 远程 SSH 隧道)、在 Control UI 中实时修改 Agent 配置(SOUL.md 编辑/模型切换/工具开关)、Dashboard 数据概览(Token 用量/渠道在线状态/会话列表/Node 节点健康)、从 Dashboard 发起诊断(doctor 命令)、以及 TUI(终端界面)的使用场景与快捷键。2026/3/24教程OpenClaw 群消息完全指南:群组配置、@ 触发、白名单与多 Bot 协同实战OpenClaw 群消息(Group Messages)完整配置教程:群组消息的触发方式(requireMention/commandPrefix/respondToAll)、各渠道群组配置差异(Telegram群/Discord服务器/Slack频道/WhatsApp群)、群组白名单与黑名单管理、限制特定成员才能触发 AI(allowedUsers/allowedRoles)、响应限速防刷屏(cooldown)、多 Bot 在同一群组协同分工的配置方案、群组 Session 的记忆与上下文管理,以及群组中 AI 的礼貌边界设计(何时发言/何时沉默)。2026/3/24教程OpenClaw 接入 Nextcloud Talk:自托管视频会议平台 AI 助手完全配置指南OpenClaw 接入 Nextcloud Talk 的完整教程:Nextcloud Talk 的自托管通信平台特点(视频会议+聊天+文件协作)、插件安装(@openclaw/nextcloud-talk)、通过 occ CLI 创建 Bot 账户并注册 Webhook、OpenClaw 最简配置(serverUrl+appPassword+sharedSecret)、DM 私信与房间(Room)访问控制、Markdown 消息格式和表情反应支持、局域网/内网部署注意事项(WebSocket vs Polling),以及 Nextcloud Talk AI 助手的典型使用场景(会议摘要/文件问答/任务分派)。2026/3/24