项目简介
OpenClaw 是一个开源、可编程的AI智能体框架,旨在模拟“小龙虾”的感知-决策-行动循环,其核心特点是模块化、可扩展、支持工具调用(Function Calling)和长上下文工作流,常用于自动化脚本、数据分析、网页交互和复杂任务分解。

前置要求
- 系统: Linux / macOS (推荐) 或 WSL2 (Windows)
- Python: 版本 3.10 - 3.12
- 包管理:
pip(推荐使用虚拟环境) - 版本控制:
git - (可选)CUDA: 如需本地运行大模型,需NVIDIA GPU和对应CUDA环境。
第一步:获取源代码
建议从官方仓库克隆,以便于后续更新和贡献。
git clone https://github.com/openclaw/OpenClaw.git cd OpenClaw
第二步:配置Python虚拟环境
强烈建议使用虚拟环境隔离依赖。
# 激活虚拟环境 # Linux/macOS source .venv/bin/activate # Windows (CMD/PowerShell) .venv\Scripts\activate # 升级pip和setuptools pip install --upgrade pip setuptools
第三步:安装核心依赖
项目通常提供 requirements.txt 或 pyproject.toml。
# 方式1:安装核心包(最简) pip install openclaw-core # 方式2:从源码安装(开发模式,可修改代码) pip install -e . # 如果项目根目录有 setup.py 或 pyproject.toml # 方式3:安装指定功能组的依赖(如果项目提供) # pip install "openclaw[web]" # 增加网页自动化支持 # pip install "openclaw[all]" # 安装所有可选依赖
注意: 如果遇到依赖冲突,特别是 pydantic、 typing-extensions 等,可以尝试先安装一个宽松的基础版本,再根据项目文档调整。
第四步:配置API密钥与环境变量
OpenClaw通常需要接入大模型API(如OpenAI、Anthropic、智谱、DeepSeek等)以及工具API(如搜索引擎、GitHub等)。
-
复制环境变量模板:
cp .env.example .env
-
编辑
.env文件,填入你的密钥:# 模型提供商 OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx OPENAI_BASE_URL=https://api.openai.com/v1 # 或指向代理地址 # 国内模型示例 (根据支持情况选择) ZHIPUAI_API_KEY=your_zhipu_key DASHSCOPE_API_KEY=your_dashscope_key # 阿里通义千问 # 工具API示例 SERPAPI_API_KEY=your_serpapi_key # 谷歌搜索 GITHUB_TOKEN=your_github_personal_access_token # 应用配置 OPENCLAW_LOG_LEVEL=INFO # 日志级别: DEBUG, INFO, WARN OPENCLAW_CACHE_DIR=./.cache # 向量缓存/工具缓存目录
-
安全提示: 将
.env添加到.gitignore,切勿提交密钥。
第五步:验证安装
创建一个简单的测试脚本 test_openclaw.py:
import os
from dotenv import load_dotenv
from openclaw import OpenClaw
from openclaw.tools import Calculator, WebSearch # 示例工具
# 加载环境变量
load_dotenv()
# 初始化OpenClaw智能体,指定模型和工具
agent = OpenClaw(
model="gpt-4-turbo-preview", # 或 "claude-3-sonnet", "glm-4"
tools=[Calculator(), WebSearch()], # 赋予它计算和搜索能力
system_prompt="你是一个乐于助人的AI助手,擅长使用工具解决问题。"
)
# 运行一个简单任务
response = agent.run("请计算圆周率π的平方根,然后搜索一下最近关于AI智能体架构的新闻,并总结。")
print(response)
运行脚本:
python test_openclaw.py
如果看到模型调用、工具使用和最终输出,则安装成功。
第六步:高级配置与开发
-
自定义工具: 在
tools/目录下创建my_tool.py:from openclaw.tools import BaseTool from pydantic import Field class MyCustomTool(BaseTool): """一个自定义工具的简短描述。""" param1: str = Field(description="参数1的描述") def execute(self): """工具的执行逻辑。""" # 你的代码 here result = f"处理了 {self.param1}" return result然后在初始化时引入:
tools=[..., MyCustomTool()] -
配置本地模型: 如果想使用
Ollama或vLLM等本地部署的模型:agent = OpenClaw( model="local/llama3:8b", # Ollama模型名 base_url="http://localhost:11434/v1", # Ollama的兼容API端点 api_key="ollama" # 可为任意非空字符串 )或使用
LM Studio、OpenAI-Compatible API的本地服务。 -
配置向量数据库: 如需使用记忆或RAG功能:
pip install "openclaw[vectorstore]" # 安装向量存储依赖,如chromadb
在代码中配置:
from openclaw.memory import VectorMemory memory = VectorMemory( embedding_model="text-embedding-ada-002", # 或本地embedding模型 persist_dir="./memory_db" ) agent = OpenClaw(memory=memory, ...)
常见问题排查 (Troubleshooting)
| 问题 | 可能原因 | 解决方案 |
|---|---|---|
ImportError |
依赖缺失或版本冲突 | 确认虚拟环境已激活。 运行 pip install -r requirements.txt --force-reinstall。检查Python版本兼容性。 |
ModuleNotFoundError: No module named 'xxx' |
可选依赖未安装 | 安装对应功能组:pip install "openclaw[xxx]" |
| API连接超时/错误 | 网络问题 API密钥错误 Base URL配置错误 |
检查网络代理。 确认密钥有效且.env文件已加载。 检查 OPENAI_BASE_URL 等变量。 |
| 工具调用失败 | 工具参数不符合模型预期 | 启用详细日志 OPENCLAW_LOG_LEVEL=DEBUG 查看交互过程,检查工具的Schema描述。 |
| 性能慢 | 默认模型较大或网络延迟高 | 换用更快的模型(如 gpt-3.5-turbo)。考虑本地部署轻量模型。 启用流式输出以获得即时反馈。 |
后续步骤
- 查阅官方文档:仔细阅读
docs/目录下的文档,了解核心概念(Agent, Planner, Tools, Memory)。 - 运行示例:研究
examples/目录下的示例代码,快速上手各种场景。 - 参与贡献:发现问题或想添加功能?请阅读
CONTRIBUTING.md,提交Issue或Pull Request。 - 加入社区:关注项目的Discord、Slack或论坛,与其他开发者交流。
一句话总结安装:克隆源码 -> 创建虚拟环境 -> pip install -e . -> 配置 .env -> 编写Agent脚本运行。 祝你在AI智能体开发中玩得愉快!