CodeGraph 安装指南:跨平台部署与 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
CodeGraph 是为 AI 编程助手准备的本地知识图谱:它预先解析整个仓库的符号、调用边与依赖,让 Claude Code、Cursor 等助手一次查询就能拿到精准上下文。本文带你完成跨平台的 CodeGraph 安装:装好 CLI、接入助手、建立项目的第一份索引,全程约 10 分钟。
作者在 7 个真实开源仓库上做了有 / 无对比:工具调用次数最多减少88%,回答平均快53%,Token 消耗少62%,成本平均省44%,七个项目的文件读取全部降为零。
环境要求
| 平台 | 架构 | 安装方式 |
|---|---|---|
| macOS | x64 / arm64 | Shell 脚本或 npm |
| Linux | x64 / arm64 | Shell 脚本或 npm |
| Windows | x64 / arm64 | PowerShell 脚本或 npm |
所有发行版都内置了 Node 运行时,无需额外安装 Node.js,也不涉及编译。只需联网下载安装包;索引数据只写入项目内的.codegraph/目录,全程不出本机。
一行命令装好 CLI
安装脚本会自动识别操作系统与 CPU 架构,拉取匹配的构建。
macOS 与 Linux
curl -fsSL https://raw.githubusercontent.com/colbymchenry/codegraph/main/install.sh | sh # 若本机已装 Node.js,也可走 npm 渠道 npm i -g @colbymchenry/codegraphWindows(PowerShell)
irm https://raw.githubusercontent.com/colbymchenry/codegraph/main/install.ps1 | iex⚠️ 脚本不会改写当前 Shell 的环境变量,打开一个新终端再执行后续命令。做完后你会在新终端里运行codegraph version并看到版本号。
把 MCP 接入你的 AI 助手
这一步是 CodeGraph 安装流程中最容易被漏掉的一环:codegraph install会自动检测已装的助手(Claude Code、Cursor、Codex CLI、opencode、Hermes Agent、Gemini CLI、Antigravity、Kiro、GitHub Copilot),并逐个写入 MCP 服务器配置。
codegraph install脚本化或 CI 场景可加参数跳过确认,例如codegraph install --yes --init(顺带初始化当前项目)。⚠️ 这一步只配置助手,不索引任何代码。做完后你会看到安装器列出已写入配置的助手清单,重启对应助手后 MCP 服务即生效。
初始化项目并建立代码图谱
每个项目只需执行一次。codegraph init同时完成生成.codegraph/目录与构建完整图谱两件事。
cd your-project codegraph init拿 2.7 万文件的 Swift 编译器仓库做参照,全量建图约需 100 秒,此后单文件改动的增量同步只要 4 秒左右。做完后你会看到索引进度输出,以及最终的节点、边、文件统计。
保持索引自动同步
自动同步默认开启:原生文件事件(macOS FSEvents、Linux inotify、Windows ReadDirectoryChangesW)捕获每次增删改,默认 2 秒防抖把成批改动合并成单次同步,助手重连时还会快速对账补上离线改动。做完后你保存文件几秒内,codegraph status里就不会再出现待同步文件。
验证 CodeGraph 安装是否就绪
在项目目录运行:
codegraph status预期输出包含节点 / 边 / 文件数量、活跃后端与日志模式(journal 应为wal),如有未同步文件会单独列出。再跑一条codegraph explore "how does login work",返回相关源码与调用路径即说明图谱可查。💡 也可以运行codegraph version确认已装版本。
常见问题
终端提示codegraph: command not found— 这是安装后的典型现象:脚本没有改写当前 Shell 的环境。打开一个新终端重试;仍失败就检查PATH是否包含~/.local/bin。
提示 "CodeGraph not initialized"— 该项目还没有建过图谱。先在项目根目录执行codegraph init。
MCP 报database is locked或Transport closed— 项目位于 Windows 挂载盘(/mnt/c一类路径)时,跨边界的 SQLite 锁不稳定。建议迁到 Linux 原生磁盘;Windows 与 WSL 共用同一仓库时,给其中一侧设置CODEGRAPH_DIR=.codegraph-win各建各的索引。
索引特别慢— 通常是超大目录未被排除。依赖与构建目录(如node_modules)默认都会被跳过;输出冗长时可加--quiet。
想卸载怎么办—codegraph uninstall可一次清掉所有助手配置和 CLI 本体,执行前会先列出将删除的内容;加--keep-cli只清助手配置;codegraph uninit单独移除某个项目的索引。
一次完整的 CodeGraph 安装到此结束:助手一旦发现.codegraph/文件夹存在,就会自动改用图谱工具,索引也随代码改动实时保持新鲜。想进一步了解符号如何跨文件关联,可阅读 工作原理 与 完整 CLI 参考。
【免费下载链接】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),仅供参考