openvibe

环境要求

• Python 环境与 pip（需可执行 pip install）
• 项目源码目录（pip install -e 为可编辑安装，须在仓库根目录执行）
• Anthropic API Key（形如 sk-...）
• 可访问 LLM 服务的网络环境

安装与启动步骤

1. 1克隆项目仓库

   把 openvibe 源码下载到本地并进入仓库根目录，后续安装与配置都在此目录进行。

   git clone https://github.com/vitalops/openvibe.git
   cd openvibe

   复制

2. 2安装依赖

   在仓库根目录执行可编辑安装，同时安装开发依赖组（[dev]），以便使用 openvibe 命令。

   pip install -e ".[dev]"

   复制

3. 3设置 API Key

   按 README 要求导出 ANTHROPIC_API_KEY 环境变量，值换成自己的真实密钥；建议写入 shell 配置文件避免每次重设。

   export ANTHROPIC_API_KEY=sk-xxxxxxxx

   复制

4. 4创建配置文件

   在项目根目录新建 openvibe.json，指定模型提供方、模型 ID、默认代理与工具权限策略。

   {
     "model": { "provider_id": "anthropic", "model_id": "claude-sonnet-4-5" },
     "default_agent": "build",
     "permission": [
       { "tool": "bash", "action": "ask" },
       { "tool": "write", "action": "ask" }
     ]
   }

   复制

5. 5校验模型列表

   运行 models 子命令确认配置的模型已被正确识别，能列出模型说明 Key 与 openvibe.json 生效。

   openvibe models

   复制

6. 6启动服务

   以服务模式启动 openvibe，默认监听 4096 端口；如需长期运行建议放到后台或进程管理器中。

   openvibe serve

   复制

7. 7一次性执行任务

   用 run 子命令直接下达单次提示词，适合快速验证代理能否完成任务，无需常驻服务。

   openvibe run "fix the failing tests"

   复制

8. 8管理会话

   用 session 子命令查看历史会话列表，并按 session-id 查看某次会话的详细执行过程。

   openvibe session list
   openvibe session show <session-id>

   复制

关键配置

如何确认成功

运行 openvibe models 能列出可用模型；openvibe serve 启动后默认占用 4096 端口。

常见问题

注意事项

• openvibe serve 默认端口为 4096，被占用时需自行释放端口。
• permission 中 action 设为 ask 时，代理执行 bash、write 等工具前会等待确认。
• 密钥属于敏感信息，不要提交到 Git 仓库或公开分享。
• 项目内置 bash、read、write、edit、glob、grep、web_fetch、todo 等工具，可按需调整权限。