CodeGraph 安装指南:3 条命令、5 分钟搭好 AI 代码知识图谱
【免费下载链接】codegraphPre-indexed code knowledge graph, auto syncs on code changes, for Claude Code, Codex, Gemini, Cursor, OpenCode, AntiGravity, Kiro, CoPilot, and Hermes Agent — fewer tokens, fewer tool calls, 100% local项目地址: https://gitcode.com/GitHub_Trending/co0degr/codegraph
让 AI 读代码别再靠 grep 了。大多数 Agent 现在理解代码的方式是逐个文件翻、正则搜关键字,慢且烧 token。CodeGraph 的做法相反:它先把整个仓库的符号、调用边、依赖关系建成一张本地知识图谱,Agent 一次查询就能拿到精准上下文,全程 100% 本地运行、无需 API 密钥。官方在 7 个真实开源项目上的实测结果:
| 指标 | 无 CodeGraph | 有 CodeGraph |
|---|---|---|
| 工具调用次数 | 最多 43 次 | 减少88% |
| 回答问题速度 | 基线 | 平均快53% |
| Token 消耗 | 基线 | 少62% |
| 成本 | 基线 | 平均省44% |
| 文件读取次数 | 最多 19 个文件 | 0 次 |
承诺很具体:装好并接入只需要3 条命令,从第一条命令执行到图谱可查5 分钟内完成,之后零维护——索引自动同步,你只管写代码。
装好 CLI 并验证版本
本节解决"机器上能不能装、装完怎么确认"的问题。
先确认支持范围。所有发行版都是自包含构建(内置 Node 运行时),无需安装 Node.js、无需编译,只要网络能访问安装包下载地址即可:
| 平台 | 架构 | 安装方式 |
|---|---|---|
| macOS | Intel (x64) / Apple Silicon (arm64) | Shell 脚本 或 npm |
| Linux | x64 / arm64 | Shell 脚本 或 npm |
| Windows | x64 / arm64 | PowerShell 脚本 或 npm |
安装脚本会自动识别操作系统和 CPU 架构,下载对应构建。macOS 和 Linux 用这条命令(脚本详见 安装脚本):
curl -fsSL https://raw.githubusercontent.com/colbymchenry/codegraph/main/install.sh | sh程序会装到~/.codegraph,并在~/.local/bin创建codegraph启动链接。Windows 在 PowerShell 中执行(脚本逻辑一致,见 安装脚本):
irm https://raw.githubusercontent.com/colbymchenry/codegraph/main/install.ps1 | iex机器上已有 Node.js 的话,也可以直接用 npm 装:
npm i -g @colbymchenry/codegraph⚠️ 安装脚本不会修改当前 Shell 的环境变量。请打开一个新终端再执行下面的验证命令,否则会出现
codegraph: command not found。
验证只需一条命令,确认版本号正常输出即代表装好了:
codegraph version一条命令把 MCP 接入你的 Agent
本节解决"Agent 怎么用上 CodeGraph"的问题。
在新终端里运行安装器,它会把 CodeGraph 的 MCP 服务器写进你正在用的 Agent:
codegraph install安装器自动检测并配置:Claude Code、Cursor、Codex CLI、opencode、Hermes Agent、Gemini CLI、Antigravity IDE、Kiro,以及 GitHub Copilot(VS Code / Copilot CLI / JetBrains IDE),完成后重启 Agent 使 MCP 服务生效。这一步只接 Agent,不索引任何代码。
脚本化或 CI 环境需要非交互参数时:
codegraph install --yes # 自动检测,全局安装 codegraph install --target=cursor,claude --yes # 指定目标 codegraph install --yes --init # 顺便初始化当前项目各参数完整说明见 CLI 参考。
构建第一张代码图谱,然后忘记它
本节解决"项目图谱怎么建、之后要不要手动同步"的问题。
每个项目跑一次 init 即可:
cd your-project codegraph init这条命令一步做两件事:创建本地.codegraph/目录 + 构建完整代码图谱。量级参考:数万文件的 Swift 编译器仓库,首次完整索引约100 秒;之后单文件编辑的重新同步约4 秒。索引建好后,Agent 检测到项目里有.codegraph/目录就会自动切换使用 CodeGraph 工具,无需任何额外设置。
自动同步默认开启、零配置,机制有三点:
- 原生文件监听(macOS FSEvents / Linux inotify / Windows ReadDirectoryChangesW)捕获每次文件增删改;
- 防抖窗口(默认 2 秒)把批量编辑合并为一次同步;
- Agent 每次连接时做一次快速对账,补上离线期间的改动。
结论放在这里:你或 Agent 保存文件后几秒内,图谱就是最新的——从此不再需要手动同步。随时可用两条命令确认状态:
codegraph status # 查看索引统计与待同步文件 codegraph version # 查看已安装版本日常命令速查、排障与卸载
本节解决"用得多的高频命令、卡住了怎么办、想撤怎么办"三个问题。
高频命令速查
| 命令 | 用途 |
|---|---|
codegraph explore <问题> | 一次返回相关源码 + 调用路径 + 影响范围 |
codegraph impact <符号> | 改动前分析受影响代码 |
codegraph affected src/xx.ts | 找出受改动的测试文件 |
codegraph upgrade | 一键升级到最新版本 |
codegraph telemetry off | 关闭匿名使用统计(默认关闭可用DO_NOT_TRACK=1) |
完整命令列表见 快速上手指南。
症状 | 原因 | 处理
| 症状 | 原因 | 处理 |
|---|---|---|
codegraph: command not found | 安装脚本不改当前 Shell 环境变量 | 打开新终端;确认~/.local/bin在PATH中(macOS/Linux) |
| 提示 "CodeGraph not initialized" | 项目还没建过索引 | 在项目目录里跑codegraph init |
| 索引速度慢 | 大目录未被排除或输出过多 | node_modules、dist默认已排除;用--quiet减少输出 |
| MCP 提示 database is locked | 老版本(0.9 之前)缺内置运行时;WSL2 项目在/mnt/c等 Windows 盘上锁行为异常 | 重装获取内置运行时;WSL2 建议把项目移到 Linux 原生文件系统 |
| WSL2 与 Windows 共用一个仓库 | 两侧索引锁互相冲突 | Windows 侧设置环境变量CODEGRAPH_DIR=.codegraph-win,各自建独立索引 |
更多细节见官方 故障排查文档。
想撤?命令也是现成的
反悔只需一条命令,会从所有已配置的 Agent 中移除 CodeGraph 配置并删除 CLI 本体(删除前先展示清单):
codegraph uninstall # 完整卸载 codegraph uninstall --keep-cli # 只移除 Agent 配置,保留 CLI codegraph uninit # 删除单个项目的 .codegraph/ 索引收尾
回顾一遍:一行命令装好 CLI,codegraph install接入 Agent,codegraph init建好图谱,自动同步接管剩下的事——3 条命令,5 分钟,之后零维护。工具调用减少 88%、文件读取降为零,这笔账算得过来。想深挖图谱如何解析、符号如何跨文件关联,看 工作原理 和 知识图谱概念 两篇文档。
【免费下载链接】codegraphPre-indexed code knowledge graph, auto syncs on code changes, for Claude Code, Codex, Gemini, Cursor, OpenCode, AntiGravity, Kiro, CoPilot, and Hermes Agent — fewer tokens, fewer tool calls, 100% local项目地址: https://gitcode.com/GitHub_Trending/co0degr/codegraph
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考