OpenClaw 文档中心

Appearance

安装指南 ​

欢迎使用 OpenClaw！本指南将帮助你在不同平台上安装、配置和使用 OpenClaw。

目录 ​

系统要求 ​

在开始之前，请确保你的系统满足以下要求：

要求最低配置推荐配置
操作系统Windows 10 / macOS 10.15 / Ubuntu 18.04Windows 11 / macOS 13 / Ubuntu 22.04
内存4 GB8 GB 或以上
磁盘空间1 GB2 GB 或以上
Node.jsv18.0.0v20.0.0 或以上

必备软件 ​

  • Node.js - OpenClaw 基于 Node.js 运行
  • npm 或 pnpm - 包管理器（推荐使用 pnpm）
  • Git - 用于克隆仓库和更新

快速安装 ​

1. 安装 Node.js ​

bash
# 使用 winget 安装
winget install OpenJS.NodeJS.LTS

# 或从官网下载安装包
# https://nodejs.org/
bash
# 使用 Homebrew 安装
brew install node

# 验证安装
node --version
npm --version
bash
# 使用 nvm 安装（推荐）
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
source ~/.bashrc
nvm install --lts

# 或使用 apt 安装
sudo apt update
sudo apt install nodejs npm

2. 安装 OpenClaw ​

bash
# 使用 npm 安装
npm install -g openclaw

# 或使用 pnpm 安装（推荐，更快）
pnpm add -g openclaw

3. 验证安装 ​

bash
# 检查版本
openclaw --version

# 查看帮助
openclaw --help

# 初始化工作目录
openclaw init

平台详细指南 ​

Windows ​

  1. 安装 Node.js

    • 访问 Node.js 官网
    • 下载 LTS（长期支持）版本
    • 运行安装程序，按提示完成安装

  2. 配置环境变量

    • 默认情况下，安装程序会自动配置
    • 如果命令无法识别，手动添加 Node.js 到 PATH

  3. 安装 OpenClaw

    powershell
    # 以管理员身份运行 PowerShell
npm install -g openclaw

# 初始化
openclaw init

macOS ​

  1. 安装 Homebrew（如果还没有）

    bash
    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

  2. 安装 Node.js

    bash
    brew install node

  3. 安装 OpenClaw

    bash
    npm install -g openclaw
openclaw init

Linux ​

  1. 更新系统包

    bash
    sudo apt update && sudo apt upgrade -y

  2. 安装 Node.js（推荐使用 nvm）

    bash
    # 安装 nvm
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash

# 重新加载配置
source ~/.bashrc

# 安装 LTS 版本
nvm install --lts
nvm use --lts

  3. 安装 OpenClaw

    bash
    npm install -g openclaw
openclaw init

目录结构 ​

初始化后，OpenClaw 会在当前目录创建以下结构：

.openclaw/
├── config.json              # 主配置文件
├── .env                     # 环境变量（API Keys 等）
├── logs/                    # 日志文件
│   ├── openclaw.log
│   └── error.log
└── extensions/              # 扩展插件
    └── ...

workspace-{name}/            # 工作区目录
├── AGENTS.md                # Agent 行为指南
├── SOUL.md                  # Agent 人格设定
├── USER.md                  # 用户信息
├── MEMORY.md                # 长期记忆
├── TOOLS.md                 # 工具配置说明
├── HEARTBEAT.md             # 心跳任务配置
├── IDENTITY.md              # 身份标识
├── BOOTSTRAP.md             # 初始化引导（首次运行后删除）
├── docs/                    # 文档目录
├── skills/                  # 本地技能
├── memory/                  # 每日记忆
│   └── 2024-01-15.md
└── .vitepress/              # 文档站点配置（可选）

核心文件说明 ​

文件用途
config.json主配置文件，包含通道、模型、技能等配置
.env敏感信息，如 API Keys、Token 等
AGENTS.md定义 Agent 的行为规则和约束
SOUL.md定义 Agent 的人格、语气、风格
USER.md用户信息、偏好、联系方式
MEMORY.mdAgent 的长期记忆，持久化重要信息
TOOLS.md工具和技能的本地配置说明
HEARTBEAT.md定时任务配置，心跳检查项

配置通道 ​

OpenClaw 支持多种消息通道，让你可以通过不同平台与 AI 对话。

支持的通道 ​

通道说明配置难度
飞书企业协作平台⭐⭐
企业微信企业通讯工具⭐⭐
Discord社区聊天平台⭐
Telegram即时通讯⭐
WhatsApp即时通讯⭐⭐
Signal加密通讯⭐⭐
IRC传统聊天协议⭐

飞书配置 ​

1. 创建飞书应用 ​

  1. 访问 飞书开放平台
  2. 创建企业自建应用
  3. 记录 App ID 和 App Secret

2. 配置权限 ​

在应用管理后台，添加以下权限：

消息与通讯
├── 获取与发送单聊、群组消息
├── 获取用户信息
└── 获取群组信息

文档
├── 查看、评论、编辑和管理多维表格
├── 查看、评论和导出文档
└── 查看云空间文件

3. 配置事件订阅 ​

  1. 在「事件订阅」页面添加请求网址：

    https://your-domain.com/webhook/feishu

  2. 添加事件：

    • im.message.receive_v1 - 接收消息

4. 修改 OpenClaw 配置 ​

编辑 config.json：

json
{
  "channels": {
    "feishu": {
      "enabled": true,
      "appId": "cli_xxxxxxxxxxxx",
      "appSecret": "xxxxxxxxxxxxxxxxxxxx",
      "encryptKey": "xxxxxxxxxxxxxxxxxxxx",
      "verificationToken": "xxxxxxxxxxxxxxxxxxxx"
    }
  }
}

或在 .env 文件中配置：

bash
FEISHU_APP_ID=cli_xxxxxxxxxxxx
FEISHU_APP_SECRET=xxxxxxxxxxxxxxxxxxxx
FEISHU_ENCRYPT_KEY=xxxxxxxxxxxxxxxxxxxx
FEISHU_VERIFICATION_TOKEN=xxxxxxxxxxxxxxxxxxxx

5. 发布应用 ​

  1. 在飞书管理后台提交应用审核
  2. 审核通过后，将应用添加到企业
  3. 用户可以开始与机器人对话

企业微信配置 ​

1. 创建企业微信应用 ​

  1. 访问 企业微信管理后台

  2. 进入「应用管理」→「自建」→「创建应用」

  3. 记录 AgentId、Secret

  4. 在「我的企业」页面记录 企业ID (CorpId)

2. 配置可信域名 ​

在应用设置中，添加可信域名：

your-domain.com

3. 设置接收消息 ​

  1. 在「接收消息」页面设置 API 接收
  2. 填写 URL：
    https://your-domain.com/webhook/wecom
  3. 记录 Token 和 EncodingAESKey

4. 修改 OpenClaw 配置 ​

编辑 config.json：

json
{
  "channels": {
    "wecom": {
      "enabled": true,
      "corpId": "wwxxxxxxxxxxxxxxxx",
      "agentId": 1000001,
      "secret": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "token": "xxxxxxxx",
      "encodingAESKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
    }
  }
}

或在 .env 文件中配置：

bash
WECOM_CORP_ID=wwxxxxxxxxxxxxxxxx
WECOM_AGENT_ID=1000001
WECOM_SECRET=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
WECOM_TOKEN=xxxxxxxx
WECOM_ENCODING_AES_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Discord 配置 ​

1. 创建 Discord Bot ​

  1. 访问 Discord Developer Portal
  2. 创建新应用
  3. 进入「Bot」页面，创建 Bot
  4. 记录 Token
  5. 开启必要的 Intents：
    • MESSAGE CONTENT INTENT
    • SERVER MEMBERS INTENT

2. 邀请 Bot 到服务器 ​

生成邀请链接，需要的权限：

  • Send Messages
  • Read Messages
  • Read Message History
  • Embed Links

3. 修改 OpenClaw 配置 ​

json
{
  "channels": {
    "discord": {
      "enabled": true,
      "token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
    }
  }
}

Telegram 配置 ​

1. 创建 Telegram Bot ​

  1. 在 Telegram 中搜索 @BotFather
  2. 发送 /newbot 命令
  3. 按提示设置 Bot 名称
  4. 记录返回的 Token

2. 修改 OpenClaw 配置 ​

json
{
  "channels": {
    "telegram": {
      "enabled": true,
      "token": "123456789:ABCdefGHIjklMNOpqrsTUVwxyz"
    }
  }
}

技能安装 ​

技能（Skills）是 OpenClaw 的扩展能力，可以添加各种功能。

从 SkillHub 安装 ​

SkillHub 是官方技能市场，提供丰富的技能：

bash
# 搜索技能
openclaw skill search <关键词>

# 安装技能
openclaw skill install <技能名>

# 查看已安装技能
openclaw skill list

# 更新技能
openclaw skill update <技能名>

# 卸载技能
openclaw skill uninstall <技能名>

推荐技能 ​

技能功能安装命令
weather天气查询openclaw skill install weather
feishu-doc飞书文档操作openclaw skill install feishu-doc
healthcheck系统健康检查openclaw skill install healthcheck
video-frames视频帧提取openclaw skill install video-frames

本地技能开发 ​

你也可以开发自己的技能：

  1. 在工作区创建 skills/ 目录
  2. 创建技能文件夹和 SKILL.md 文件
  3. 编写技能逻辑

技能目录结构：

skills/
└── my-skill/
    ├── SKILL.md           # 技能说明和指令
    ├── scripts/           # 脚本文件
    │   └── main.sh
    └── references/        # 参考文档
        └── api-docs.md

从 Git 仓库安装 ​

bash
# 从 GitHub 安装
openclaw skill install github:user/repo

# 从 GitLab 安装
openclaw skill install gitlab:user/repo

配置 AI 模型 ​

配置 API Key ​

OpenClaw 支持多种 AI 模型提供商：

bash
# 设置默认模型
openclaw config set model gpt-4

# 设置 API Key
openclaw config set apiKey sk-xxxxxxxx

或在 .env 文件中配置：

bash
# OpenAI
OPENAI_API_KEY=sk-xxxxxxxx

# Claude
ANTHROPIC_API_KEY=sk-xxxxxxxx

# 其他兼容服务
OPENAI_BASE_URL=https://api.example.com/v1

支持的模型 ​

提供商模型配置
OpenAIGPT-4, GPT-3.5model: gpt-4
AnthropicClaude 3model: claude-3-opus
GoogleGeminimodel: gemini-pro
本地Ollamamodel: llama2

启动服务 ​

开发模式 ​

bash
# 启动开发服务器
openclaw dev

# 指定端口
openclaw dev --port 3000

生产模式 ​

bash
# 启动服务
openclaw start

# 后台运行
openclaw start --daemon

# 停止服务
openclaw stop

# 重启服务
openclaw restart

# 查看状态
openclaw status

使用 PM2 管理（推荐） ​

bash
# 安装 PM2
npm install -g pm2

# 启动服务
pm2 start "openclaw start" --name openclaw

# 设置开机自启
pm2 startup
pm2 save

常见问题 ​

安装问题 ​

npm install 速度慢？ ​

bash
# 设置淘宝镜像
npm config set registry https://registry.npmmirror.com

# 或使用 pnpm
npm install -g pnpm

权限问题？ ​

bash
# Linux/macOS 可能需要 sudo
sudo npm install -g openclaw

# 或修复 npm 权限
mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc
source ~/.bashrc

Node.js 版本太旧？ ​

bash
# 使用 nvm 升级
nvm install --lts
nvm use --lts

通道问题 ​

飞书机器人不回复？ ​

  1. 检查应用是否已发布
  2. 检查权限配置是否正确
  3. 检查事件订阅是否配置
  4. 查看日志：tail -f ~/.openclaw/logs/error.log

企业微信收不到消息？ ​

  1. 检查可信域名配置
  2. 检查 API 接收配置
  3. 确认 IP 白名单设置

技能问题 ​

技能安装失败？ ​

bash
# 清除缓存重试
openclaw skill cache clear
openclaw skill install <技能名> --force

下一步 ​

← 返回首页 | 快速开始 →