GitDiagram – 快速概览

它能做什么 – 将任何公开或私有的 GitHub 仓库转换为交互式架构图（Mermaid）和一段简短的带旁白视频，全面讲解代码库结构。

为何重要 – 理解一个项目的结构通常需要阅读大量文件。GitDiagram 自动化这一过程，让开发者和 AI 代理能立即看到各部分的连接关系，并直接跳转到源码。

---

核心功能（如 README 所述）

功能	你将获得	如何工作（高层次）
交互式图表	基于 Mermaid 的文件/文件夹可视化，点击可跳转至 GitHub 上对应代码。	服务克隆仓库，分析目录树和导入语句，生成 Mermaid 语法并在网站上渲染。
一分钟旁白视频	一段简短视频（横屏或竖屏），解释仓库目的、主要组件和一个设计决策，内嵌字幕。	使用 Claude 或 GPT 生成脚本，Claude/GPT 进行场景规划，OpenRouter 的 Gemini 3.8 Flash TTS 生成语音。
导出选项	图表的 PNG 导出或原始 Mermaid 源码复制粘贴。	简单的 UI 按钮；Mermaid 源码存储在服务器上，可下载。
私有仓库支持	在 UI 顶部输入 GitHub 个人访问令牌，即可访问私有仓库。	令牌发送至后端，后端在后台克隆仓库。
AI 代理集成（MCP 服务器）	提供远程 MCP 端点（https://gitdiagram.com/mcp），返回架构数据、组件列表、连接关系、Mermaid 源码和视频 URL。	无需认证；代理可查询端点并接收结构化 JSON 说明。
本地开发	使用 Next.js + Bun 自行运行整个服务，需 Cloudflare R2、Upstash Redis 和 OpenAI/OpenRouter 密钥。	bun install → 复制 .env.example → 填写密钥 → bun run dev。

---

如何使用

1. Web UI – 访问 https://gitdiagram.com/owner/repo（或在任意 GitHub URL 中将 hub 替换为 diagram）。页面显示交互式图表和一个 Video 按钮。
2. AI 代理 – 将 MCP 服务器 URL 添加到 Claude、Cursor、VS Code、Gemini CLI、Copilot CLI 等工具中。然后提问如 “How is fastapi/fastapi structured?”，代理将获取图表和解释。
3. 自托管 – 克隆仓库，安装 Bun，设置所需云服务（R2、Redis）和 API 密钥，运行 bun run dev。在 .env 中启用 VIDEO_EXPLAINER_ENABLED 和语音 API 密钥即可开启视频生成。

---

技术栈（来自 README）

• 前端：Next.js、React、TypeScript、Tailwind CSS、Mermaid 用于图表渲染。
• 后端：基于 Bun（快速 JavaScript 运行时）运行，生成资产存储于 Cloudflare R2，元数据缓存于 Upstash Redis。
• AI 组件：OpenAI/OpenRouter 用于代码分析提示，Claude/GPT 用于脚本生成，Gemini 3.8 Flash 用于文本转语音。
• 部署：Vercel 主机，Railway/Docker 作为故障转移备用方案。

---

哪些人可能受益？

• 开发者 – 加入新代码库时，快速获得视觉地图和视频导览。
• 代码审查者 – 可直接从图表节点跳转到对应文件。
• AI 驱动工具 – 需要结构概览的代理可调用 MCP 端点。
• 教育者 / 文档撰写者 – 以最小努力为开源项目生成视觉和视频资产。

---

快速入门（快速检查清单）

1. 访问在线服务 – https://gitdiagram.com/owner/repo。
2. 添加私有仓库 – 点击头部的 Private Repos，粘贴 GitHub 令牌。
3. 观看视频 – 点击 Video 或在 URL 后添加 /video。
4. 导出 – 使用 PNG 或 Copy Mermaid 按钮。
5. 与 AI 集成 – 将 MCP URL 添加到您偏好的 AI 客户端（Claude、Cursor、VS Code 等）。

---

许可与支持

• 许可证：MIT（参见 LICENSE）。
• 资助：Ko-fi 链接和 Sent（短信/WhatsApp API）的赞助徽章。

---

以上所有信息均直接来自仓库的 README；未添加任何外部假设。