repobrain

环境要求

• 已安装并登录的 AI 编程工具：Claude Code 或 Codex CLI（推荐），Cursor / Trae / Windsurf 等亦可
• Python 环境，pip 与 pipx 可用（手动安装或 Codex 安装时需要）
• 如需使用托管模型，准备 OpenAI / DeepSeek / Groq / 阿里灵积 / NVIDIA NIM 等 OpenAI 兼容 API Key（可选，
• Git（用于拉取仓库形式的安装包）

安装与启动步骤

1. 1插件市场安装

   在 Claude Code 中先添加 marketplace，再安装 repobrain 插件；首次会话会自动装好 rb CLI 与引擎。

   /plugin marketplace add study8677/repobrain
   /plugin install repobrain@repobrain

   复制

2. 2首次配置后端

   每个项目运行一次。交互式选择已登录的本地 CLI（免密钥）或 API Key 提供商，并写入 .env。

   /repobrain:rb-setup

   复制

3. 3构建知识库

   为当前代码库建立语义索引，rb-ask 的问答质量依赖这一步的完成结果。

   /repobrain:rb-refresh

   复制

4. 4提问代码问题

   用自然语言提问，答案基于真实代码并附带文件路径与行号。

   /repobrain:rb-ask "How does auth work?"

   复制

5. 5Codex CLI 安装

   Codex 需手动装引擎与 CLI，再添加插件市场；命令不加 repobrain: 前缀。

   pipx install "git+https://github.com/study8677/repobrain.git#subdirectory=engine"
   pipx inject --force --include-apps repobrain-engine "git+https://github.com/study8677/repobrain.git#subdirectory=cli"
   codex plugin marketplace add study8677/repobrain

   复制

6. 6手动 pip 安装

   不使用插件时的备选方案，分别从 cli 与 engine 两个子目录安装。

   pip install "git+https://github.com/study8677/repobrain.git#subdirectory=cli"
   pip install "git+https://github.com/study8677/repobrain.git#subdirectory=engine"

   复制

7. 7让 AI 代安装

   已在登录状态的 AI IDE 中，把这一行贴给助手，它会自动检测 CLI、配置零密钥后端并自测。

   Read https://github.com/study8677/repobrain/blob/main/AI_INSTALL.md and follow it to install RepoBrain in this project.

   复制

关键配置

如何确认成功

运行 /repobrain:rb-ask "How does auth work?"，若能返回带文件路径与行号的真实代码答案即成功。

常见问题

注意事项

• rb-setup 会把 .env 写到项目根目录并自动加入 .gitignore，注意不要把密钥提交进仓库。
• 手动安装需要分别安装 cli 与 engine 两个子目录包，缺一不可。
• Codex CLI 的 hooks 尚未支持，必须手动安装引擎后才能使用。
• 首次构建知识库需等 rb-refresh 跑完，索引未完成时问答结果可能不完整。