❤️❤️❤️❤️❤️❤️ 我们已经正式推出微信小程序,在微信中搜索 TrendForge Pro 即可使用小程序,如果使用 Telegram 请搜索 trendforge_tg ❤️❤️❤️❤️❤️❤️

CodeGraph 5分钟快速开始

CodeGraph 为 AI 编程助手提供预索引的代码知识图谱,大幅减少工具调用次数,加速代码探索。

环境要求

支持的操作系统

macOS Windows Linux

运行环境

Node.js >=18 必需

所需工具

npm

安装 CodeGraph

必需

操作步骤

1

安装 CodeGraph

使用 npm 全局安装 CodeGraph 包。

全局安装 CodeGraph
npm install -g @colbymchenry/codegraph

预期结果::安装完成后显示版本号,如 '+ @colbymchenry/codegraph@x.x.x'

如果遇到权限问题,请使用 sudo(macOS/Linux)或以管理员身份运行终端(Windows)。

2

运行交互式安装器

在项目根目录下运行安装器,自动配置 AI 代理。

启动交互式安装器
codegraph install

预期结果::安装器会询问要配置的代理(如 Claude Code、Cursor 等)、安装位置(全局/本地)等,按提示选择即可。

如果希望非交互式安装,可使用 --target all --location global --yes 参数。

3

初始化项目索引

为当前项目构建知识图谱索引。

初始化项目索引
codegraph init

预期结果::显示索引进度,完成后出现 'CodeGraph initialized' 提示。

索引时间取决于项目大小,大型项目可能需要几分钟。

4

重启 AI 代理

重启你的 AI 编程助手(如 Claude Code、Cursor 等),使其加载 CodeGraph MCP 服务器。

预期结果::代理启动后,CodeGraph 工具自动可用。

如果代理没有自动识别,请检查 MCP 配置文件是否正确生成。

验证成功

在 AI 代理中询问一个关于代码库的问题,观察工具调用次数是否显著减少。

代理使用 codegraphexplore 工具
工具调用次数少于 10 次
响应时间明显缩短

快速提示

使用

使用 codegraph init 为每个新项目建立索引

功能

CodeGraph 支持 19+ 编程语言,自动检测

配置

索引数据存储在 .codegraph/ 目录中,可加入 .gitignore

常见问题

1

安装失败,提示权限错误

使用 sudo npm install -g @colbymchenry/codegraph(macOS/Linux)或以管理员身份运行(Windows)。

2

codegraph 命令未找到

确保 npm 全局安装路径在 PATH 环境变量中。可运行 npm config get prefix 查看路径。

3

AI 代理未使用 CodeGraph 工具

重启代理;检查 MCP 配置文件(如 ~/.claude.json)是否包含 CodeGraph 配置;确认项目根目录存在 .codegraph/ 目录。

下一步

阅读文档

访问 GitHub 仓库了解高级用法和配置选项。

贡献代码

在 GitHub 上提交 Issue 或 Pull Request。

助手