OpenClaw 快速上手:5 分钟部署指南

OpenClaw 学习笔记

分类:基础入门

核心主题:OpenClaw Agent SDK 的安装、配置与首次使用

主要内容:本文详细介绍了 OpenClaw 智能体开发框架在三大主流操作系统上的安装流程、API Key 配置方法以及首条指令的运行验证,帮助开发者在 5 分钟内完成从零到可用的部署。

关键词:OpenClaw, 安装, 部署, 快速上手, 配置, macOS, Windows, Linux, CLI

一、前置条件

在开始安装 OpenClaw 之前,请确保您的开发环境满足以下基本要求。无论使用何种操作系统,以下三项是必不可少的:

1.1 硬件要求

1.2 软件依赖

1.3 网络要求

快速检测环境

在终端中依次执行以下命令,确认环境就绪:

# 检查 Node.js 版本 node --version # 检查 npm 版本 npm --version # 检查 Git 版本 git --version

如果以上命令均返回版本号,说明基础环境已满足要求。

关键提示:Node.js 版本必须为 18 或以上。如果版本过低,请先通过 nodejs.org 下载安装 LTS 版本,或使用 nvm(Node Version Manager)进行版本管理。

二、macOS 安装

macOS 用户可通过以下两种方式之一完成 OpenClaw 的安装。推荐使用 npm 全局安装方式,最为简洁。

2.1 方式一:npm 全局安装(推荐)

打开终端(Terminal.app),执行以下命令:

npm install -g openclaw

安装完成后,验证是否成功:

openclaw --version

如果正确输出版本号(如 v1.2.0),即表示安装成功。

2.2 方式二:Homebrew 安装

对于习惯使用 Homebrew 的用户,也可以直接通过 brew 安装:

brew tap openclaw/tap brew install openclaw

2.3 macOS 权限说明

如果遇到 EACCES 权限错误,表示 npm 全局安装目录没有写入权限。解决方案:

macOS 用户提示

如果遇到 "不受信任的开发人员" 提示导致命令无法运行,请前往 系统设置 > 隐私与安全性,点击 "仍要打开" 以允许 OpenClaw 执行。

三、Windows 安装

Windows 用户可以使用 npm 全局安装或通过预编译的安装程序完成部署。

3.1 方式一:npm 安装(通用)

打开 PowerShell(建议以管理员身份运行),执行:

npm install -g openclaw

验证安装:

openclaw --version

3.2 方式二:Windows Installer 安装

从 OpenClaw 的 GitHub Releases 页面下载 OpenClaw-Setup-x64.exe,双击运行安装向导即可。安装程序会自动将 OpenClaw 添加到系统 PATH 中。

3.3 Windows 环境配置

常见错误:PowerShell 脚本禁用

如果在 PowerShell 中运行 openclaw 时出现 "无法加载文件...因为在此系统上禁止运行脚本" 的错误,请以管理员身份运行以下命令:

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

然后重新打开 PowerShell 即可。

四、Linux 安装

Linux 用户可通过 npm 或各发行版的包管理器进行安装。以下以 Ubuntu / Debian 和 CentOS / RHEL 为例。

4.1 npm 安装(通用)

所有 Linux 发行版均适用:

npm install -g openclaw

验证安装:

openclaw --version

4.2 apt 安装(Debian / Ubuntu)

curl -fsSL https://apt.openclaw.dev/gpg.key | sudo gpg --dearmor -o /usr/share/keyrings/openclaw-archive-keyring.gpg echo "deb [signed-by=/usr/share/keyrings/openclaw-archive-keyring.gpg] https://apt.openclaw.dev stable main" | sudo tee /etc/apt/sources.list.d/openclaw.list sudo apt update sudo apt install openclaw

4.3 yum / dnf 安装(CentOS / RHEL / Fedora)

# CentOS 7 / RHEL 7 使用 yum sudo yum install -y https://rpm.openclaw.dev/openclaw-latest.el7.x86_64.rpm # Fedora / RHEL 8+ 使用 dnf sudo dnf install -y https://rpm.openclaw.dev/openclaw-latest.el8.x86_64.rpm

4.4 Linux 权限说明

Linux 系统中全局安装 npm 包需要 root 权限,因此 npm install -g 命令前需要加 sudo。如果希望避免使用 sudo,可以参考以下步骤配置用户级 npm 全局目录:

mkdir -p ~/.npm-global npm config set prefix '~/.npm-global' # 将以下行添加到 ~/.bashrc 或 ~/.zshrc export PATH=~/.npm-global/bin:$PATH source ~/.bashrc

关键提示:Linux 环境下安装完成后,可能需要重新登录终端或执行 source ~/.bashrc(或 source ~/.zshrc)才能使 openclaw 命令生效。

五、首次启动与 API Key 配置

安装完成后,需要进行 API Key 配置才能正常使用 OpenClaw 与 AI 模型通信的能力。OpenClaw 支持多种大语言模型(LLM)的后端接入。

5.1 获取 API Key

5.2 配置 API Key

OpenClaw 支持三种配置方式,优先级从高到低排列:

方式 A:环境变量(推荐)

在终端中设置环境变量,配置后立即生效:

# macOS / Linux export ANTHROPIC_API_KEY=sk-ant-xxxxxxxxxxxx # Windows PowerShell $env:ANTHROPIC_API_KEY="sk-ant-xxxxxxxxxxxx"

为了让配置持久化,可以将上述命令添加到 Shell 配置文件(如 ~/.bashrc~/.zshrc 或 Windows 用户环境变量)中。

方式 B:配置文件

OpenClaw 会自动读取项目根目录下的 .env 文件:

# .env 文件内容 ANTHROPIC_API_KEY=sk-ant-xxxxxxxxxxxx OPENAI_API_KEY=sk-xxxxxxxxxxxx

方式 C:交互式配置

首次运行 OpenClaw 时,如果没有检测到 API Key,系统会以交互式方式引导您输入:

openclaw # 输出: # ? 未检测到 API Key,请选择您的 LLM 提供商: # ❯ Anthropic Claude # OpenAI # Google Gemini # Azure OpenAI

安全性建议

切勿将 API Key 硬编码在代码中或提交到版本控制系统。建议将 .env 文件添加到 .gitignore 中,并优先使用环境变量方式配置。

六、第一条指令示例

配置完成后,即可向 OpenClaw 发送第一条指令,验证整个部署链路是否正常。

6.1 启动交互模式

在终端中直接输入 openclaw 并回车,进入交互式对话界面:

$ openclaw ┌─────────────────────────────────────────────┐ │ Welcome to OpenClaw v1.2.0 │ │ Type "/help" for available commands │ └─────────────────────────────────────────────┘ You: 你好,请用中文介绍 OpenClaw 是什么? ───────────────────────────────────────────── OpenClaw 是一个开源的 AI Agent 智能体开发框架, 由 Anthropic 官方团队维护。它允许开发者通过 自然语言指令来创建、配置和运行 AI Agent, 支持工具调用、文件操作、代码执行等丰富功能。 ─────────────────────────────────────────────

6.2 运行一次性指令

OpenClaw 也支持非交互模式,直接执行单条指令并退出:

openclaw -p "列出当前目录下的所有文件"
openclaw -p "创建一个名为 hello.txt 的文件,内容为 Hello OpenClaw"

6.3 验证常见功能

成功运行首条指令后,建议进一步验证以下核心功能是否正常工作:

核心概念:Tool Use(工具调用)

OpenClaw 的核心能力在于 Tool Use。AI 模型可以在对话过程中自主决定调用哪些工具(如读写文件、执行命令、搜索网络等),从而完成复杂任务。开发者也可以通过自定义工具来扩展 OpenClaw 的能力边界。

七、常见安装问题排查表

以下表格汇总了安装过程中最常遇到的问题及其解决方案:

序号 问题现象 可能原因 解决方案
1 command not found: openclaw npm 全局安装目录未在 PATH 中 $(npm root -g)/bin 添加到 PATH;Windows 用户检查 %APPDATA%\npm
2 EACCES: permission denied 对 npm 全局目录没有写入权限 使用 sudo 安装,或配置 npm prefix 到用户目录
3 Error: Cannot find module 'xxx' npm 依赖安装不完整 执行 npm cache clean --force 后重新安装
4 安装速度极慢或超时 网络原因,npm 官方源访问慢 配置国内镜像源:npm config set registry https://registry.npmmirror.com
5 PowerShell 中脚本无法运行 Windows 执行策略限制 Set-ExecutionPolicy RemoteSigned -Scope CurrentUser
6 Node.js 版本过低 系统 Node.js 版本低于 18.x 使用 nvm 安装最新 LTS 版本:nvm install --lts
7 macOS "不受信任的开发者" 警告 Apple Gatekeeper 安全机制 前往 系统设置 > 隐私与安全性,点击 "仍要打开"
8 Linux 下 openclaw 命令找不到 Shell 会话未重新加载 执行 source ~/.bashrc 或重新登录终端

仍未解决?

如果上述方案均无法解决您的问题,请访问 OpenClaw 官方 GitHub 仓库提交 Issue,或在社区论坛中搜索类似问题。同时请确认您使用的 OpenClaw 版本与操作系统兼容。

八、核心要点总结

五分钟部署的核心流程回顾

  1. 环境准备:确保 Node.js ≥ 18.x、npm ≥ 9.x、Git 已安装
  2. 安装方式:全平台均支持 npm install -g openclaw,各发行版另有专属包管理器方式
  3. API Key 配置:优先使用环境变量方式,配置 Anthropic / OpenAI 等提供商的密钥
  4. 功能验证:运行 openclaw -p "你好" 测试首次指令,验证安装成功
  5. 问题排查:遇到 "command not found" 时优先检查 PATH 配置;权限错误使用 sudo 或配置用户级目录

关键提示:OpenClaw 的强大之处在于其工具调用(Tool Use)能力。完成基础部署后,建议进一步学习如何编写自定义工具、配置多模型切换以及使用会话管理功能,以充分发挥 OpenClaw 作为 AI Agent 开发框架的潜力。

后续学习路径建议

  • 深入学习 OpenClaw 的 Tool Use 机制与自定义工具开发
  • 探索 OpenClaw 的多会话管理和上下文持久化功能
  • 了解 OpenClaw 的安全沙箱和权限控制模型
  • 尝试将 OpenClaw 集成到 CI/CD 流水线中实现自动化任务
  • 阅读官方文档和社区最佳实践,掌握高级配置技巧