Skip to content

第8章 配置文件:openclaw.json解剖

🎯 本章目标:学完这章,你能理解配置文件的层次结构,独立修改配置

⏱️ 预计时间:25分钟

📋 前置要求:已完成第3章(基础安装)

  • 配置文件的位置和编辑方式
  • 配置分层:全局→Agent→Channel 的优先级(后写覆盖先写)
  • 关键字段详解:gateway、agents、channels、tools
  • 多环境配置(家用/公司/云主机)
  • 修改后的验证方法

OpenClaw的配置文件位于:

macOS/Linux

~/.openclaw/openclaw.json

Windows

%APPDATA%\openclaw\openclaw.json

方式一:使用CLI命令(推荐)

Terminal window
# 读取整个配置的某个特定值(例如读取网关端口)
openclaw config get gateway.port
# 设置配置项
openclaw config set key value
# 示例:修改Gateway端口
openclaw config set gateway.port 18790

方式二:直接编辑文件

Terminal window
# 用你喜欢的编辑器打开
nano ~/.openclaw/openclaw.json
# 或
vim ~/.openclaw/openclaw.json
# 或VS Code
code ~/.openclaw/openclaw.json

⚠️ 注意:直接编辑文件前,建议先备份

Terminal window
cp ~/.openclaw/openclaw.json ~/.openclaw/openclaw.json.backup

操作提醒:手动改完配置后,记得执行一次 openclaw gateway restart,否则你看到的仍是旧配置效果。


OpenClaw 的配置是分层的。你可以先记一句:越靠近“当前这次启动/命令”的设置,优先级越高

默认值
全局配置(~/.openclaw/openclaw.json)
Workspace配置(workspace/.openclaw/config.json)
环境变量
命令行参数

越往下,优先级越高。

假设全局配置设置了:

{
"gateway": {
"port": 18789
}
}

但启动时指定了:

Terminal window
openclaw gateway start --port 18790

最终使用的端口是 18790(命令行参数优先级最高)。


{
"gateway": {
"port": 18789,
"host": "127.0.0.1",
"cors": {
"enabled": true,
"origins": ["http://localhost:3000"]
},
"auth": {
"type": "token",
"secret": "your-secret-token"
}
}
}

字段说明

字段说明默认值
portGateway监听端口18789
host绑定地址127.0.0.1
cors.enabled是否启用跨域true
cors.origins允许的跨域来源[]
auth.type认证类型token
auth.secret认证密钥随机生成

修改示例

Terminal window
# 修改端口
openclaw config set gateway.port 18790
# 允许外部访问(谨慎!)
openclaw config set gateway.host 0.0.0.0

{
"models": {
"primary": {
"provider": "kimi",
"model": "kimi-k2.5",
"apiKey": "sk-xxx",
"temperature": 0.7,
"maxTokens": 4000
},
"fallbacks": [
{
"provider": "minimax",
"model": "MiniMax-M2.5",
"apiKey": "xxx"
}
]
}
}

字段说明

字段说明示例
provider模型提供商kimi/minimax/glm/openai
model模型名称kimi-k2.5
apiKeyAPI密钥sk-xxx
temperature创造性(0-2)0.7
maxTokens最大token数4000

temperature说明

  • 0.0:最确定,适合代码、数学
  • 0.7:平衡,适合一般对话
  • 1.0+:更有创意,适合写作

{
"agents": {
"list": [
{
"id": "main",
"name": "Assistant",
"tools": {
"profile": "coding",
"allow": ["group:fs", "group:web"],
"deny": ["group:runtime"]
}
}
]
}
}

字段说明

字段说明
nameAgent显示名称
tools.profile工具预设(minimal/coding/messaging/full)
tools.allow允许使用的工具(支持 group:*
tools.deny禁止使用的工具(优先级高于allow)

tools.profile选项

profile包含的工具适用场景
minimalsession_status安全优先
codinggroup:fsgroup:runtimegroup:sessionsgroup:memoryimage开发助手
messaginggroup:messaging + 会话基础工具聊天机器人
full不限制(等同未设置)仅限已做好权限隔离时使用

{
"channels": {
"feishu": {
"type": "feishu",
"appId": "cli_xxx",
"appSecret": "xxx",
"domain": "feishu.cn",
"privateChat": "pairing",
"groupChat": "enabled",
"requireMention": true,
"allowFrom": [],
"groupAllowFrom": []
}
}
}

字段说明

字段说明选项
type渠道类型feishu/telegram/…
privateChat私聊策略pairing/allowlist/all
groupChat群聊开关enabled/disabled
requireMention是否需要@true/false
allowFrom私聊白名单用户ID列表
groupAllowFrom群聊白名单群ID列表

假设你有三个使用场景:

  1. 家用Mac:轻量使用,KIMI模型
  2. 公司电脑:团队协作,MiniMax模型
  3. 云主机:24小时运行,多模型备份

OpenClaw支持Workspace级别的配置,覆盖全局配置。

目录结构

~/projects/
├── home/ # 家用项目
│ └── .openclaw/
│ └── config.json
├── company/ # 公司项目
│ └── .openclaw/
│ └── config.json
└── server/ # 云主机项目
└── .openclaw/
└── config.json

家用配置示例~/projects/home/.openclaw/config.json):

{
"models": {
"primary": {
"provider": "kimi",
"model": "kimi-k2.5",
"apiKey": "sk-home-xxx"
}
},
"agents": {
"default": {
"tools": {
"profile": "minimal"
}
}
}
}

公司配置示例~/projects/company/.openclaw/config.json):

{
"models": {
"primary": {
"provider": "minimax",
"model": "MiniMax-M2.5",
"apiKey": "sk-company-xxx"
}
},
"channels": {
"feishu": {
"privateChat": "pairing",
"groupChat": "enabled",
"requireMention": true
}
}
}

使用方法

Terminal window
# 在家用目录下使用家用配置
cd ~/projects/home
openclaw gateway start
# 在公司目录下使用公司配置
cd ~/projects/company
openclaw gateway start

Terminal window
# 先做整体诊断(会检查关键配置)
openclaw doctor
# 再看网关状态
openclaw status

Terminal window
# 检查配置(交互式控制面板)
openclaw configure
# 查看模型状态(含鉴权摘要)
openclaw models status

Terminal window
# 测试模型连接
openclaw models status --probe
# 测试Channel连接
openclaw channels status --probe

如果配置出错,快速回滚:

Terminal window
# 从备份恢复
cp ~/.openclaw/openclaw.json.backup ~/.openclaw/openclaw.json
# 重启Gateway
openclaw gateway restart

配置文件的核心要点:

  1. 知道在哪 —— ~/.openclaw/openclaw.json
  2. 理解分层 —— 全局→Workspace→环境变量→命令行
  3. 关键字段 —— gateway、models、agents、channels
  4. 多环境 —— 用Workspace配置隔离不同场景
  5. 改前备份 —— 养成备份的好习惯

下一步:第9章,学习安全与沙箱配置。


  1. 找到你的配置文件,打开看看结构
  2. openclaw configure重新检查并保存当前主要配置
  3. 尝试修改一个配置项(如temperature)
  4. 运行openclaw doctor验证配置
  5. 备份你的配置文件