code-review-graph

环境要求

• Python 3.10 及以上
• pip 或 pipx，推荐额外安装 uv（MCP 配置会优先使用 uvx）
• 已安装任一受支持的 AI 编程工具（Cursor、Claude Code、Codex 等）
• 一个本地代码仓库用于构建图谱

安装与启动步骤

1. 1安装 CLI

   用 pip 或 pipx 安装 code-review-graph 命令行工具；安装后终端可直接调用该命令。

   pip install code-review-graph

   复制

2. 2自动配置工具

   该命令自动探测已安装的 AI 编程工具，写入对应的 MCP 配置并注入规则，装完需重启编辑器。

   code-review-graph install

   复制

3. 3指定单个平台

   若只想配置某一个平台，用 --platform 加上平台名，例如 cursor、claude-code、codex。

   code-review-graph install --platform cursor

   复制

4. 4构建代码图谱

   在项目目录中解析整个代码库并建立持久化语义图谱，500 文件项目首次约需 10 秒。

   code-review-graph build

   复制

5. 5查看图谱状态

   输出图谱统计信息，用于确认构建结果是否已写入本地图谱数据目录。

   code-review-graph status

   复制

6. 6监听自动更新

   watch 模式会在文件变化时自动增量更新图谱，省去手动重复执行 update。

   code-review-graph watch

   复制

7. 7启动 MCP 服务

   启动 MCP server，供 AI 编程工具通过 MCP 协议读取图谱上下文。

   code-review-graph serve

   复制

关键配置

如何确认成功

执行 code-review-graph status 能看到图谱统计；或重启编辑器后在 AI 助手里问“为本项目构建代码审查图谱”。

常见问题

注意事项

• 若已安装 uv，MCP 配置会优先使用 uvx，否则回退到 code-review-graph 命令本身。
• visualize 导出的 JSON 保留在本地图谱数据目录中（Git 默认忽略），其中可能含绝对路径与代码结构信息，对外发布前需检查并脱敏。
• uninstall 只删除 CRG 自身的文件与条目，不会动其他 MCP 服务器、钩子和 JSONC 注释。
• Python 版本必须为 3.10 及以上，否则无法运行。