🦞 374k Stars 🟦 TypeScript MIT License Node 24 50+ 渠道

🖥️ 系统要求

🟩
Node.js
24.x(推荐)或 22.19+
运行时,TypeScript 通过 tsx 直接执行
📦
pnpm
最新版(从源码构建)
Monorepo 包管理,npm 安装无需此项
🐳
Docker(可选)
容器化部署
支持 docker-compose,Fly.io / Render 部署
🔑
LLM API Key
25+ 提供商
OpenAI / Anthropic / Google 或本地 Ollama

⬇️ 安装方式

最快上手方式。一条命令全局安装,通过 onboard 向导完成 Gateway、渠道和 Skill 配置,全程约 3 分钟。
Terminal
# 全局安装(stable 频道)
npm install -g openclaw@latest

# 启动引导向导(完成 Gateway + 渠道 + Skill 配置)
openclaw onboard --install-daemon
发布频道
# Stable(正式版)
npm install -g openclaw@latest

# Beta(预发布)
npm install -g openclaw@beta

# Dev(main 分支最新)
npm install -g openclaw@dev
ℹ️
Docker 部署适合服务器环境,Gateway 以容器方式常驻运行。
docker-compose.yml
docker compose up -d

# 或直接运行
docker run -d \
  --name openclaw \
  -p 18789:18789 \
  -v ~/.openclaw:/root/.openclaw \
  openclaw/openclaw:latest
  1. 1
    克隆仓库
    bash
    git clone https://github.com/openclaw/openclaw.git
    cd openclaw
  2. 2
    安装依赖 & 初始化
    bash
    pnpm install
    pnpm openclaw setup
  3. 3
    启动 Gateway(开发模式)
    bash
    pnpm gateway:watch    # 热重载开发
☁️
支持一键部署到 Fly.ioRenderRailway 等平台,配置文件已内置。
Fly.io 部署
# fly.toml 已预配置
fly launch --no-deploy
fly secrets set OPENCLAW_MODEL="anthropic/claude-sonnet-4-6"
fly deploy
Render 部署
# render.yaml 已预配置,直接 Connect Repository
# 在 Render Dashboard 设置环境变量:
OPENCLAW_MODEL = "openai/gpt-4o"
OPENCLAW_WORKSPACE = "/data/.openclaw"

⚙️ 配置文件

核心配置位于 ~/.openclaw/openclaw.json,设计上追求极简。

~/.openclaw/openclaw.json — 最小配置
{
  "agent": {
    "model": "anthropic/claude-sonnet-4-6"   // provider/model-id 格式
  }
}
~/.openclaw/openclaw.json — 完整示例
{
  "agent": {
    "model": "anthropic/claude-sonnet-4-6",
    "thinking": "auto",             // none | auto | high
    "fallback_model": "openai/gpt-4o"
  },
  "gateway": {
    "port": 18789,                    // WebSocket 端口
    "auth_mode": "pairing"           // pairing | open
  },
  "memory": {
    "enabled": true,
    "soul_file": "~/.openclaw/workspace/SOUL.md"
  },
  "sandbox": {
    "backend": "docker"             // docker | ssh | openshell
  }
}
配置项默认值说明
agent.model主 LLM,格式 provider/model-id,支持 25+ 提供商
agent.thinkingauto推理深度:none(快速)/ auto / high(深度)
gateway.port18789WebSocket 服务器端口,所有客户端连接此端口
gateway.auth_modepairingpairing: 新设备需配对码;open: 无需验证
sandbox.backendhost工具执行沙箱:host(本机)/ docker / ssh / openshell
memory.soul_fileSOUL.mdAgent 人格定义文件,影响行为和风格
📁
工作区结构:所有数据存储在 ~/.openclaw/workspace/,包括:SOUL.md(人格)、MEMORY.md(长期记忆)、AGENTS.md、每日日志文件(append-only Markdown)。无向量数据库,纯 Markdown 文本。

🔗 消息渠道接入(50+)

运行 openclaw onboard 后,按向导配置需要的渠道。OpenClaw 会监听所有已启用渠道的消息,路由到 Agent 处理。

📱 WhatsApp
✈️ Telegram
💬 Slack
🎮 Discord
📞 Signal
💬 iMessage
🤝 Teams
🌐 Matrix
🔷 Google Chat
🐦 IRC
🪶 Feishu
🟢 LINE
🏢 Mattermost
💬 WeChat
🔵 QQ
+35 更多
🔒
安全:未知发送者会收到配对码验证,Bot 不处理消息直到通过审批。通过 gateway.auth_mode 控制策略(pairing 或 open)。

📟 命令参考

CLI 命令

openclaw onboard --install-daemon
引导向导:配置 Gateway、渠道、Skill
openclaw agent --message "..."
直接发送消息给 Agent
openclaw agent --message "..." --thinking high
启用高强度推理模式
openclaw message send --target +1234 --message "..."
向指定联系人发送消息
openclaw status
查看 Gateway 状态
pnpm gateway:watch
开发模式启动(源码热重载)

聊天斜杠命令(对话中输入)

/status
查看当前会话状态
/new
开启新会话
/reset
重置当前会话上下文
/compact
压缩对话历史(节省 Token)
/think <none|auto|high>
调整推理深度
/verbose
开启详细输出模式
/trace
启用执行追踪
/usage
查看 Token 用量统计
/activation
管理唤醒词设置

🛡️ 安全模型

三级执行模型
┌─────────────────────────────────────────────────────┐
│  主会话(自己)    → Host 直接执行,完全访问权限    │
│  群组会话          → Sandbox(Docker/SSH)隔离执行  │
│  未知发送者        → 需配对码审批,Bot 拒绝处理     │
└─────────────────────────────────────────────────────┘

# 沙箱后端配置
"sandbox": {
  "backend": "docker"     // docker | ssh | openshell
}
⚠️
默认行为:主会话工具运行在宿主机上,Agent 拥有完全访问权限(适合个人单用户场景)。群组/多用户场景务必配置沙箱后端。