CodeGraph完整安装与使用指南
·
我帮你把安装、配置、核心命令、工作流程全部梳理成清晰、可直接上手的版本,你直接照着用就行。
一、安装 CodeGraph
全局安装,命令行直接执行:
npm install -g @colbymchenry/codegraph
安装完成后,终端输入 codegraph -v 能看到版本号,说明安装成功。
二、MCP 配置(必须配置,才能正常使用)
创建配置文件 mcp.json,内容直接复制以下代码:
{
"mcpServers": {
"codegraph": {
"type": "stdio",
"command": "codegraph",
"args": ["serve", "--mcp"]
}
}
}
这个配置是让 CodeGraph 以 MCP 服务模式运行,对接代码分析工具。
三、核心使用命令(4个高频命令)
所有命令都在你的项目根目录下执行,CodeGraph 会自动扫描项目代码。
1. 创建索引
cd your-project
codegraph init -i
2. 查找指定符号(类/函数/变量)
用途:快速定位代码中 UserService 相关的所有定义、引用
codegraph query UserService --limit 10
query:搜索符号关键词--limit 10:限制返回结果数量(避免过多)
3. 查谁调用了目标函数
用途:分析上游调用方,知道哪些函数/文件在用 createOrder
codegraph callers createOrder
4. 查目标函数调用了谁
用途:分析下游依赖,知道 createOrder 内部调用了哪些函数
codegraph callees createOrder
4. 分析代码改动的影响范围(最核心!)
用途:修改 createOrder 前,查所有受影响的代码、调用链、模块
codegraph impact createOrder
四、标准工作流程(修改代码前必做)
按照这个顺序操作,精准评估代码风险:
1. **先搜索符号**:确认目标代码位置
codegraph_search 目标符号
2. **再查调用关系**:
- 查谁调用它:`codegraph_callers`
- 查它调用谁:`codegraph_callees`
3. **最后查影响范围**:
codegraph_impact 目标函数
4. **兜底方案**:如果 CodeGraph 图谱结果不全,再用 `grep/read` 手动读文件
五、常用命令速查表
| 需求 | 命令 |
|---|---|
| 搜索类/函数/变量 | codegraph query 符号名 --limit 10 |
| 查函数的调用方 | codegraph callers 函数名 |
| 查函数的被调用方 | codegraph callees 函数名 |
| 查代码改动影响面 | codegraph impact 函数名 |
六、更新索引方法
全量重新索引:运行codegraph index或codegraph index --force命令。后者会强制重新构建索引,忽略之前的索引状态。
增量索引:codegraph index --incremental命令,它会只索引修改过的文件。
实时更新索引:运行codegraph watch命令,自动监控文件变化,实时更新索引。
总结
- 安装:
npm install -g @colbymchenry/codegraph - 配置:固定
mcp.json配置文件 - 核心4命令:
query/callers/callees/impact - 工作流:搜索 → 查调用 → 查影响 → 兜底grep
更多推荐


所有评论(0)