前言
GitNexus 是一款基于 Node.js 的代码知识图谱工具,支持解析代码库生成依赖 / 调用关系图谱,并可通过 MCP 协议对接 AI 编辑器(如 TRAE、Claude Code、Cursor)。本文将从零开始,完整讲解 Windows 环境下的安装、配置及网页版 GUI 使用方法,全程无需复杂配置,新手也能一次成功。
本文所使用的 GitNexus 为 GitHub 开源项目,本文仅提供本地部署、安装配置与使用教程,非官方文档,所有代码版权归原作者所有。 项目开源地址:https://github.com/abhigyanpatwari/GitNexus
本教程仅用于学习和技术交流,使用前请遵守项目开源协议,请勿用于商业用途或二次分发。
一、前置环境准备
1. 基础依赖安装
- Node.js 18+ :GitNexus 必须依赖的运行环境,推荐安装 LTS 稳定版下载地址:https://nodejs.org/zh-cn/安装时务必勾选「Add to PATH」选项,避免后续环境变量问题
- Git :用于部分依赖的拉取,如未安装可从 https://git-scm.com/ 下载安装
- 终端工具:Windows 自带 PowerShell 或 Git Bash 均可,建议以「管理员身份」运行,避免权限问题
2. 环境校验
打开终端,执行以下命令验证环境是否正常:
bash
# 验证 Node.js 版本
node -v
# 验证 npm 版本
npm -v
# 验证 Git 版本
git --version
若均能正常输出版本号,说明环境准备完成。
二、全局安装 GitNexus(推荐方式)
1. 执行安装命令
在终端中执行全局安装,同时添加 --legacy-peer-deps 跳过依赖版本校验(解决 Windows 常见的依赖冲突问题):
bash
npm install -g gitnexus --legacy-peer-deps
等待安装完成,终端输出 added XXX packages in XXs 即表示安装成功。
2. 配置环境变量(解决「命令未找到」问题)
安装完成后,若执行 gitnexus --version 提示「无法识别命令」,则需手动配置环境变量:
1. 执行以下命令获取 npm 全局安装路径:
bash
npm config get prefix
输出示例:C:\Users\你的用户名\AppData\Roaming\npm
2. 按下 Win + R,输入 sysdm.cpl 打开「系统属性」,切换到「高级」→「环境变量」
3. 在「用户变量」中找到 Path,双击打开,点击「新建」,粘贴上一步获取的 npm 路径
4. 一路点击「确定」保存,重启终端使配置生效
3. 安装验证
重启终端后,执行以下命令验证安装是否成功:
bash
# 查看版本号,正常输出 1.6.1 即成功
gitnexus --version
# 查看帮助文档,验证命令可用性
gitnexus --help
三、项目代码索引(核心步骤)
GitNexus 必须先对目标项目生成索引,才能解析代码并生成图谱,步骤如下:
1. 解压你的代码压缩包,进入包含源码文件(如 src/、package.json)的根目录
注意:需进入真正包含代码的子目录,不要在解压的外层总目录执行
2. 执行索引命令:
bash
# 基础索引命令
gitnexus analyze
# 若索引失败,可强制重建索引
gitnexus analyze --force
3. 执行完成后,项目根目录会生成 .gitnexus 文件夹,包含代码依赖、调用链等图谱数据
四、网页版 GUI 使用教程
若暂时不想对接 AI 编辑器,可直接使用官方在线网页版 GUI 查看图谱,步骤如下:
1. 启动本地服务
在终端中进入已索引的项目目录,执行以下命令启动本地服务:
bash
gitnexus serve
终端输出例如 Server running on http://localhost:4747 即表示服务启动成功,请勿关闭该终端窗口。
2. 访问在线网页版
在浏览器中打开 GitNexus 官方在线 UI 地址:
3. 加载项目图谱
1. 在线 UI 会自动连接本地服务,顶部下拉框选择你已索引的项目名称
2. 加载完成后,即可查看交互式代码图谱:
左侧「Explorer」:文件目录树,可快速定位代码文件
中间画布:代码节点与调用关系连线,支持拖拽、缩放
右侧「Query」:内置 AI 问答,可直接提问如「项目入口文件是哪个?」「XX 函数被哪些地方调用?」
4. 常见问题排查
- 问题 1:打开网页提示
Cannot GET /解决:无需访问本地地址,直接使用官方在线 UI 即可,本地服务仅提供 API 接口,无静态页面 - 问题 2:网页提示超时(Request timed out)解决:
- 检查终端中
gitnexus serve是否正常运行,重启服务 - 验证端口是否被占用,执行
netstat -ano | findstr :4747查看进程,结束占用后重启服务
- 检查终端中
- 问题 3:网页显示「No files loaded」解决:确认已在项目目录执行
gitnexus analyze,并在顶部下拉框选择正确的项目名称
下篇文章预告
本文重点讲解 GitNexus 安装 + 网页版 GUI 可视化使用。
在下一篇文章中,我将带来:✅ GitNexus + TRAE AI 编辑器集成✅ MCP 协议完整配置✅ 让 AI 自动理解项目架构、函数调用、依赖关系✅ 一键生成项目文档、架构分析、代码优化建议
需要的小伙伴可以关注我,下篇即将发布!