学习路径指南
难度等级
初级
预计时长
2-3小时
适合人群
对代码分析和AI编程助手感兴趣的开发者,希望快速理解新项目代码结构或提升AI辅助编程的准确性。无需深入了解知识图谱或MCP协议即可开始使用。

学习目标:学会使用GitNexus的Web界面快速探索代码仓库,并掌握其CLI工具的基本安装与配置,让AI编程助手(如Cursor、Claude Code)获得代码库的架构视图。

前置知识

Node.js与npm 了解

GitNexus的CLI工具通过npm安装,需要Node.js运行环境。

Git基础 了解

项目主要分析Git仓库,了解基本的仓库概念(如clone)有助于使用。

TypeScript/JavaScript 了解 (可选)

项目本身用TypeScript编写,但作为使用者,只需能看懂简单的代码示例即可。

学习步骤

1

环境准备与初体验

30分钟

安装Node.js

访问Node.js官网(https://nodejs.org/)下载并安装LTS版本。安装后,在终端运行 `node --version` 和 `npm --version` 确认安装成功。

如果你已经安装过,可以跳过此步。

体验Web界面(最快上手)

在浏览器中打开 https://gitnexus.vercel.app。这是了解GitNexus核心功能最直接的方式。你可以尝试拖入一个GitHub仓库URL或本地的ZIP代码压缩包,观察它如何生成知识图谱并与代码对话。

首次体验建议选择一个文件数量较少(如个人小项目)的仓库,避免浏览器内存限制。

2

CLI工具安装与基础使用

1小时

安装GitNexus CLI

在终端中运行命令:`npm install -g gitnexus`。安装完成后,运行 `gitnexus --version` 或 `gitnexus --help` 验证安装。

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

索引你的第一个代码库

进入一个你想分析的本地Git仓库目录,或者使用 `git clone` 克隆一个公开仓库。在该仓库根目录下,运行 `npx gitnexus index`。此命令会分析代码并构建本地知识图谱数据库。

第一次运行可能会下载一些依赖(如Tree-sitter),请耐心等待。完成后会生成 `AGENTS.md` 等文件。

运行本地MCP服务

在终端中运行 `gitnexus serve`。这将启动一个本地服务器,为AI编辑器提供代码图谱数据。保持此终端运行。

注意终端输出的地址(通常是 http://localhost:3000)。Web UI的“Bridge mode”可以连接到此服务。

3

集成AI编程助手(以Claude Code为例)

30分钟

运行自动配置

在终端中运行 `npx gitnexus setup`。此命令会尝试自动检测你已安装的编辑器(如Cursor、Claude Code)并配置MCP。

只需运行一次。如果自动配置失败,可以参考下一步进行手动配置。

(可选)手动配置Claude Code

如果自动配置未生效,在Claude Code中,打开设置(Settings),搜索“MCP”,找到配置MCP服务器的部分。添加一个新的服务器配置,名称填“GitNexus”,命令行填写 `npx gitnexus serve`。

具体路径可能因编辑器版本而异,请参考项目README中的代码块示例。

验证集成

在已配置的AI编辑器(如Claude Code)中,打开一个已被GitNexus索引过的项目。尝试向AI提问关于代码架构、依赖关系的问题,观察AI是否能够调用GitNexus的工具(如 `listrepos`, `query`)来获取更准确的答案。

可以尝试提问:“这个项目的主要模块有哪些?”或“修改这个函数会影响到哪些其他地方?”

4

探索核心功能与资源

30分钟

学习MCP工具

回顾README中“What Your AI Agent Gets”部分的7个工具表格。理解每个工具(如 `query`, `impact`, `detectchanges`)的用途。尝试在AI对话中明确请求使用这些工具。

例如,你可以对AI说:“请使用GitNexus的 `impact` 工具分析一下我刚刚修改的这段代码的影响范围。”

访问上下文资源

在AI编辑器中,尝试打开或引用README中“Resources for instant context”列出的URI,如 `gitnexus://repos` 或 `gitnexus://repo/{项目名}/clusters`。这些是AI可以读取的静态上下文文件。

这些资源文件在你运行 `npx gitnexus index` 时已生成在项目目录中。

连接Web UI与本地服务(Bridge Mode)

确保 `gitnexus serve` 正在运行。然后在Web UI (gitnexus.vercel.app) 中,它应该能自动检测到本地服务器。此时,你可以在Web UI中浏览所有已通过CLI索引的本地仓库,无需再次上传。

这结合了CLI的本地处理能力和Web UI的可视化优势,是推荐的工作流。

推荐资源

项目GitHub README 必看

最核心的文档,包含了所有安装、配置、命令和功能说明。

GitHub Issues 和 Discussions 推荐

遇到问题时可以在这里搜索或提问,查看其他用户的反馈和解决方案。

MCP (Model Context Protocol) 官方介绍 可选

如果你想深入了解GitNexus与AI编辑器集成的底层协议。

学习路径常见错误

1

在未安装Node.js的情况下尝试安装CLI。

务必先安装Node.js LTS版本,并验证 `npm` 命令可用。

2

在Web UI中上传过大的仓库导致浏览器卡顿或崩溃。

Web UI受浏览器内存限制(约5000个文件)。对于大仓库,优先使用CLI本地索引,然后通过“Bridge mode”在Web UI中连接查看。

3

运行 `gitnexus index` 或 `gitnexus serve` 时不在正确的项目目录下。

确保终端当前路径是你想要分析的Git仓库的根目录。使用 `pwd` 和 `ls` 命令确认。

4

配置AI编辑器后,没有在对应的项目目录下工作。

GitNexus的图谱是按项目索引的。确保你的AI编辑器打开的是已经被 `gitnexus index` 处理过的项目文件夹,AI才能获取到该项目的上下文。

学习路径下一步步骤

学完基础后可以继续探索的方向:1. 深入研究 `cypher` 工具,学习使用Cypher查询语言直接查询知识图谱,进行更自定义的分析。2. 探索如何将GitNexus集成到你的CI/CD流程中,用于自动化代码变更影响分析。3. 研究项目源码结构,了解其如何利用Tree-sitter解析代码、构建图谱,为可能的贡献做准备。4. 尝试为其他支持MCP的AI工具(如Windsurf, OpenCode)进行配置。

助手