CodeGraph 使用入门:给 AI 一个本地代码索引

文章发布时间:

CodeGraph 给代码仓库建本地索引。它用 tree-sitter 解析源码,把函数、类、方法、调用关系和文件结构存进 SQLite,之后可以通过 CLI 或 MCP 查询。接手陌生项目、追调用链,或是在改共享逻辑前找影响范围时,这些查询比逐个翻文件方便。

CodeGraph 初始化示意图

用 Codex、Claude Code 或 Cursor 时,也可以让它们通过 MCP 查代码结构。比如先找某个接口的定义,再看调用方,不用让 AI 在整个仓库里盲翻。

安装

要接入 AI 工具,可以先运行交互式安装器:

1
npx @colbymchenry/codegraph

安装器会列出 Claude Code、Cursor、Codex CLI、Gemini CLI 等工具,并写入选中工具的 MCP 配置。

只装 CLI 则用:

1
npm install -g @colbymchenry/codegraph

如果配置了 MCP,安装后要重启对应的 AI 工具。

初始化项目

进入要建立索引的项目目录:

1
2
cd your-project
codegraph init -i

init -i 会创建 .codegraph/ 目录,并为当前代码建索引。如果之后用 codegraph serve --mcp 启动,CodeGraph 会监听文件变化,增量更新索引。

用 status 确认索引是否建好:

1
codegraph status

如果看到 “CodeGraph not initialized”,当前项目还没有初始化。

常用查询

命令 / 工具 用途
codegraph files 看项目文件结构
codegraph query UserService 按名字找符号
codegraph context "fix login bug" 让 CodeGraph 帮你组装相关代码上下文
codegraph callers login 看谁调用了某个函数
codegraph callees login 看某个函数调用了谁
codegraph impact login 看改动影响范围

在 AI 工具里使用 MCP 时,可以调用 codegraph_search、codegraph_context、codegraph_trace、codegraph_callers、codegraph_callees、codegraph_impact。

例如:

1
用 CodeGraph 看一下登录流程从 route 到 service 是怎么走的

查改动范围时,可以问:

1
查一下 updateUser 这个函数的调用方和影响范围