❤️❤️❤️❤️❤️❤️ 我们已经正式推出微信小程序,在微信中搜索 TrendForge Pro 即可使用小程序,如果使用 Telegram 请搜索 trendforge_tg ❤️❤️❤️❤️❤️❤️
CodeGraph 5分钟快速开始
CodeGraph 为 AI 编程助手提供预索引的代码知识图谱,大幅减少工具调用次数,加速代码探索。
环境要求
支持的操作系统
运行环境
所需工具
安装 CodeGraph
操作步骤
安装 CodeGraph
使用 npm 全局安装 CodeGraph 包。
npm install -g @colbymchenry/codegraph
预期结果::安装完成后显示版本号,如 '+ @colbymchenry/codegraph@x.x.x'
如果遇到权限问题,请使用 sudo(macOS/Linux)或以管理员身份运行终端(Windows)。
运行交互式安装器
在项目根目录下运行安装器,自动配置 AI 代理。
codegraph install
预期结果::安装器会询问要配置的代理(如 Claude Code、Cursor 等)、安装位置(全局/本地)等,按提示选择即可。
如果希望非交互式安装,可使用 --target all --location global --yes 参数。
初始化项目索引
为当前项目构建知识图谱索引。
codegraph init
预期结果::显示索引进度,完成后出现 'CodeGraph initialized' 提示。
索引时间取决于项目大小,大型项目可能需要几分钟。
重启 AI 代理
重启你的 AI 编程助手(如 Claude Code、Cursor 等),使其加载 CodeGraph MCP 服务器。
预期结果::代理启动后,CodeGraph 工具自动可用。
如果代理没有自动识别,请检查 MCP 配置文件是否正确生成。
验证成功
在 AI 代理中询问一个关于代码库的问题,观察工具调用次数是否显著减少。
快速提示
使用 codegraph init 为每个新项目建立索引
CodeGraph 支持 19+ 编程语言,自动检测
索引数据存储在 .codegraph/ 目录中,可加入 .gitignore
常见问题
安装失败,提示权限错误
使用 sudo npm install -g @colbymchenry/codegraph(macOS/Linux)或以管理员身份运行(Windows)。
codegraph 命令未找到
确保 npm 全局安装路径在 PATH 环境变量中。可运行 npm config get prefix 查看路径。
AI 代理未使用 CodeGraph 工具
重启代理;检查 MCP 配置文件(如 ~/.claude.json)是否包含 CodeGraph 配置;确认项目根目录存在 .codegraph/ 目录。
下一步
阅读文档
访问 GitHub 仓库了解高级用法和配置选项。
贡献代码
在 GitHub 上提交 Issue 或 Pull Request。
相关项目推荐
freeCodeCamp/freeCodeCamp
freeCodeCamp.org开源代码库与课程体系,免费学习数学、编程与计算机科学
openclaw/openclaw
属于你个人的AI助手。全操作系统支持。全平台兼容。龙虾之道。🦞
nilbuild/developer-roadmap
交互式路线图、指南及其他教育内容,助力开发者职业成长。
kamranahmedse/developer-roadmap
提供交互式学习路线图、指南和其他教育内容,帮助开发者在职业生涯中成长。
vuejs/vue
此仓库为Vue 2版本。Vue 3版本请访问https://github.com/vuejs/core
n8n-io/n8n
具备原生AI能力的公平代码工作流自动化平台。支持可视化构建与自定义代码,可选自托管或云端部署,集成400多种服务。