CodeGraph 安装教程:一行命令部署本地代码知识图谱
【免费下载链接】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 助手查一个跨文件的 bug,它通常先 grep 两遍、再逐个读文件,工具调用堆了又堆,又慢又烧钱。CodeGraph 把整库的符号、调用边和依赖预先建成一张图,一次查询就能拿到精准上下文。这份 CodeGraph 安装教程从拿到 CLI 到给项目建图,照着敲完即可。
值不值:先看清这组实测数据
官方在 7 个真实开源项目上的结论:接入 CodeGraph 后,Agent 的工具调用和 token 消耗都明显下降。
| 对比项 | 没有 CodeGraph | 接入 CodeGraph |
|---|---|---|
| 工具调用次数 | 最高 43 次 | 减少 88% |
| 响应速度 | 基线 | 平均快 53% |
| Token 用量 | 基线 | 减少 62% |
| 单次提问成本 | 基线 | 平均省 44% |
| 读取文件数 | 最多 19 个 | 降到 0 |
而且你保存文件后图谱会自动跟上,索引不会过期,不用手动维护。
安装前自检:确认机器在支持范围内
三个桌面平台都提供自包含构建,内置 Node 运行时,装它之前不用先装 Node.js,只要网络能访问安装包下载地址即可。
| 平台 | 支持架构 | 安装渠道 |
|---|---|---|
| macOS | Intel (x64) / Apple Silicon (arm64) | Shell 脚本或 npm |
| Linux | x64 / arm64 | Shell 脚本或 npm |
| Windows | x64 / arm64 | PowerShell 脚本或 npm |
索引数据全部保存在项目里的.codegraph/目录中,不离开你的机器。
安装流程:三个环节
整个流程就三件事:拿 CLI、把 Agent 接上、给项目建图。
一行命令装好 CLI
安装脚本会自动识别你的操作系统和架构,下载对应构建。
macOS / Linux(Terminal):
curl -fsSL https://raw.githubusercontent.com/colbymchenry/codegraph/main/install.sh | shWindows(PowerShell):
irm https://raw.githubusercontent.com/colbymchenry/codegraph/main/install.ps1 | iex机器上已有 Node.js 的话,走 npm 也一样:
npm i -g @colbymchenry/codegraph脚本会把程序装到~/.codegraph,并在~/.local/bin建一个codegraph链接。
⚠️ 安装脚本不会修改当前 Shell 的环境变量。打开一个新终端再执行下一步,否则会提示找不到
codegraph命令。
MCP 自动接入你的 AI
这一步只负责把你机器上的 Agent 接进 CodeGraph,不碰代码:
codegraph install它会检测本机已安装的 Agent 并写入各自的 MCP 配置,覆盖 Claude Code、Cursor、Codex CLI、opencode、Hermes Agent、Gemini CLI、Antigravity IDE、Kiro 以及 GitHub Copilot(VS Code / CLI / JetBrains)。跑完后重启 Agent,MCP 服务才生效。
脚本化或 CI 场景可以带上参数,说明见 CLI 参考:
codegraph install --yes codegraph install --target=cursor,claude --yes给项目建索引
codegraph init一条命令同时完成建目录和建图,每个项目跑一次即可:
cd your-project codegraph init官方给过一个量级参考:数万文件的 Swift 编译器仓库,首次索引约 100 秒。Agent 检测到项目里有.codegraph/目录就会自动启用 CodeGraph 工具,不用再做任何配置。
自动同步默认开启:原生文件监听(macOS FSEvents / Linux inotify / Windows ReadDirectoryChangesW)捕获每次改动,2 秒防抖把批量编辑合并成一次同步,Agent 每次连接时还会再对账一次。
30 秒验证是否装对
两条命令就能确认:
codegraph version codegraph status判断标准很简单:version能打出具体版本号、status显示当前项目的索引统计且没有卡在待同步文件上,就说明装好了。
日常速查
装完之后日常就靠这几条命令:
| 命令 | 用途 |
|---|---|
codegraph explore <问题> | 一次返回相关源码、调用路径和影响范围 |
codegraph impact <符号> | 改动前分析受影响的代码 |
codegraph affected <文件> | 找出受改动的测试文件 |
codegraph status | 查看索引统计与待同步文件 |
codegraph upgrade | 一键升级到最新版 |
codegraph uninstall | 从各 Agent 移除配置并卸载 CLI |
codegraph uninit | 删除当前项目的.codegraph/索引 |
踩坑速查
高频问题基本都在下面这张表里,对号入座即可:
| 现象 | 原因 | 解法 |
|---|---|---|
codegraph: command not found | 当前终端没刷新 PATH | 打开新终端;确认~/.local/bin在PATH中 |
| 提示 "CodeGraph not initialized" | 该项目还没建过索引 | 在项目目录跑codegraph init |
| 索引速度慢 | 大目录没被排除 | 确认node_modules、dist已排除(gitignore 的默认排除);加--quiet减少输出 |
MCP 报database is locked | 0.9 之前的老版本没有内置运行时,或网络盘上 WAL 失效 | 重装最新版;把项目(含.codegraph/)移到本地磁盘 |
| WSL2 与 Windows 共用仓库互相锁死 | 两侧指向同一个.codegraph/ | Windows 侧设CODEGRAPH_DIR=.codegraph-win,两边各用独立索引 |
回到三个环节:一行命令装 CLI、codegraph install接上 Agent、每个项目codegraph init建图,之后的同步全自动。想弄清符号是怎么跨文件串起来的,可以翻 工作原理 和 知识图谱概念 两篇文档。
【免费下载链接】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),仅供参考