让Cursor更懂你的代码库:CodeGraph完整接入教程
2026/8/30 20:39:56 网站建设 项目流程

让Cursor更懂你的代码库: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

CodeGraph 是一款 100% 本地运行的代码知识图谱工具,通过 MCP 协议为 Cursor、Claude Code、Codex 等 AI 编程助手提供语义级代码智能。本文将带你完成 CodeGraph 完整接入流程:3 步安装配置,让 Cursor 更少地盲搜文件,直接回答结构问题,实现更少的 token 消耗与工具调用。

为什么需要 CodeGraph 代码知识图谱?

AI 编程助手(如 Cursor)在回答"这个功能是怎么实现的"这类问题时,默认做法是用grep+Read逐个文件盲扫。文件多、调用链长时,token 消耗爆炸,答案还常常漏掉关键路径。

CodeGraph 的思路是预建索引

  • 用 tree-sitter 解析代码,把每个函数、类、路由、组件存入本地 SQLite 数据库
  • 把调用、导入、继承等关系建成知识图谱
  • 通过 MCP 协议暴露给 Cursor 等 Agent,一次调用即可拿到带行号的源码 + 调用路径 + 影响面

官方在 7 个真实开源仓库上的实测数据:

指标提升
工具调用次数减少 58%
回答速度快 22%
文件读取接近零

📍 原理详解可参考 knowledge-graph.md 与 how-it-works.md

一键安装 CodeGraph:三种方式任选

方式一:npx 一条命令(推荐新手)

npx @colbymchenry/codegraph

方式二:npm 全局安装(已有 Node.js 的用户)

npm i -g @colbymchenry/codegraph codegraph install

方式三:shell 脚本(macOS / Linux,无需 Node)

安装脚本源码:install.sh、install.ps1

CodeGraph 自带运行时,无需编译、无原生依赖,Windows、macOS、Linux 全平台支持(x64 与 arm64)。随时可用codegraph upgrade升级。

接入 Cursor 的完整配置步骤

安装完成后,执行交互安装器:

codegraph install

它会自动完成以下工作(无需手动改配置):

  1. 自动检测已安装的 Agent——Cursor、Claude Code、Codex CLI、Gemini 等,勾选你要接入的
  2. 写入 MCP 服务器配置——将 CodeGraph 接入 Cursor 的 MCP 配置
  3. 处理 Cursor 的特殊问题——Cursor 启动 MCP 子进程时工作目录不正确,安装器会自动注入--path参数修复,手动配置时需注意这一点

⚠️codegraph install只负责连接 Agent,不会索引任何代码。索引代码是下一步的事。

也可以用非交互方式显式指定目标:

codegraph install --target=cursor,claude --yes

Cursor 对应的安装器目标实现位于 src/installer/targets/cursor.ts,支持的 Agent 清单见 targets/registry.ts。

初始化项目:构建你的代码图谱

进入你的项目目录,执行初始化:

cd your-project codegraph init

一条命令即完成:创建本地.codegraph/目录,并构建完整的代码知识图谱。之后Agent 会检测到.codegraph/目录并自动启用 CodeGraph 工具——你什么都不用改。

全局安装一次codegraph install后,每个项目只需单独执行一次codegraph init

零同步:代码改动自动更新图谱

这是最省心的一点:自动同步默认开启。CodeGraph 会监视项目文件变化——无论你是用 Cursor 改代码,还是自己新增、修改、删除文件,图谱都会实时增量更新。

  • 索引永远不会过期
  • 不需要手动重跑任何命令
  • 同步机制实现见 src/sync/watcher.ts 与 watch-policy.ts

接入后 Cursor 如何提问才最有效?

CodeGraph 默认只暴露一个 MCP 工具:codegraph_explore。用法很简单——直接给自然语言问题或符号名

"登录接口是怎么鉴权的?" "checkout 流程经过哪些组件?"

它会返回:

  • 相关符号的逐行号源码(按文件分组,与 Read 工具同构)
  • 符号间的调用路径——包括 grep 跟不上的动态分发(回调、React 重渲染、JSX 子组件)
  • 影响面摘要:哪些代码依赖这些符号

也就是说,问"X 是怎么工作的"这类问题,1 次调用通常就够了。MCP 服务器实现位于 src/mcp/tools.ts,工具协议说明见 mcp-server.md。

除 MCP 外,每个工具都有 CLI 等价命令(codegraph explore/node/callers/impact等),方便脚本调用。CLI 完整参考:cli.md。

常见问题速查

接入后 Cursor 没反应?重启 Cursor 让 MCP 服务器加载;确认项目根目录存在.codegraph/(即已执行codegraph init)。

支持哪些语言?TypeScript、JavaScript、Python、Go、Rust、Java、Kotlin、Swift、C/C++ 等 30+ 语言,完整清单见 languages.md。

数据安全吗?100% 本地——没有 API key、没有外部服务,数据只存在本地 SQLite 文件中。

想卸载?codegraph uninstall一条命令从所有 Agent 中移除配置;项目索引可用codegraph uninit单独清理。

总结:3 步让 Cursor 升级

  1. npm i -g @colbymchenry/codegraph
  2. codegraph install(自动接入 Cursor)
  3. :项目内codegraph init

之后无需任何维护——改动自动同步,Agent 自动使用。更多集成细节可查阅 integrations.md 与 troubleshooting.md。

【免费下载链接】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),仅供参考

需要专业的网站建设服务?

联系我们获取免费的网站建设咨询和方案报价,让我们帮助您实现业务目标

立即咨询