(注:实际使用时请替换为真实仓库地址)
安装前确认
检查命令:
python3 --version # 应输出 3.8.x 或更新
git --version # 应输出 2.20+
如果缺失,从 和 下载安装。
安装 OpenClaw克隆代码并进入目录
git clone https://github.com/yourusername/OpenClaw.git
cd OpenClaw
创建并激活虚拟环境
python3 -m venv venv
# Linux/macOS:
source venv/bin/activate
# Windows:
venv\Scripts\activate
安装依赖
pip install -r requirements.txt
如果报错 torch 安装失败,先按 PyTorch 官网推荐方式安装对应 CUDA 版本的 torch(或 CPU 版),再重试。运行配置脚本
python configure.py
它会提示你设置:
启动服务
python start_server.py
默认监听 :5000。终端出现 INFO: Started server 即表示就绪。
验证是否跑通:
curl http://localhost:5000/api/v1/ping
# 返回:{"status": "pong", "version": "0.3.1"}
常用功能实操文档摘要
传入一段文本,返回精炼摘要:
import requests
data = {"text": """
OpenClaw 是一个离线优先的 AI 助手框架。它支持文本理解、代码补全、图像描述等能力,
所有模型均可在消费级显卡或 CPU 上运行。设计目标是可控、可审计、不联网。
"""}
res = requests.post("http://localhost:5000/api/v1/summarize", json=data)
print(res.json()["summary"])
# 输出类似:OpenClaw 是离线优先的 AI 助手框架,支持文本、代码、图像处理,可在消费级硬件运行。
代码辅助
给一段不完整的函数,返回补全建议或优化提示:
import requests
data = {
"code": "def calculate_tax(amount, rate):\n return",
"language": "python"
}
res = requests.post("http://localhost:5000/api/v1/code_assist", json=data)
print(res.json()["suggestions"][0])
# 输出类似:return amount * rate / 100
多模态指令(纯文本场景)
即使没图像,也能处理带上下文的自然语言指令:
import requests
data = {
"input": "把下面这段 Markdown 转成 HTML:Hello
",
"type": "text"
}
res = requests.post("http://localhost:5000/api/v1/multimodal", json=data)
print(res.json()["response"])
# 输出:Hello
加载自定义插件

OpenClaw 的插件是标准 Python 模块,放在任意目录下,通过 --plugins 参数加载。
写一个简单插件
创建文件 plugins/weather.py:
def get_weather(city="Beijing"):
# 实际项目中可对接本地天气 API 或 mock 数据
return f"Weather in {city}: Sunny, 26°C"
启动时加载
python start_server.py --plugins plugins
插件函数会自动注册为 /api/v1/plugin/weather 端点,调用方式:
curl -X POST http://localhost:5000/api/v1/plugin/weather \
-H "Content-Type: application/json" \
-d '{"city": "Shanghai"}'
排查常见问题现象可能原因解法
pip install -r requirements.txt 报 torch 缺失
系统未预装 PyTorch
先运行 pip3 install torch torchvision torchaudio --index-url (CPU 版)或按官网选 CUDA 版
start_server.py 启动后立即退出
配置文件损坏或端口被占
查看终端最后一行错误;改端口:python start_server.py --port 5001;或 lsof -i :5000(macOS/Linux)/ `netstat -ano \
findstr :5000`(Windows)杀占用进程
插件调用返回 404
插件名含非法字符或未加 .py 后缀
插件文件名必须全小写、下划线分隔、以 .py 结尾(如 my_tool.py → /api/v1/plugin/my_tool)
摘要返回空或乱码
输入文本过短(
用 repr(text) 检查输入,过滤 \x00 等二进制字符
下一步
所有改动都不需要重新编译——OpenClaw 是纯 Python 实现,改完即生效。