Repolode
ahmedkhaleel2004

ahmedkhaleel2004/gitdiagram

将任意 GitHub 仓库生成可交互的架构图或一分钟讲解视频,并提供给 AI 智能体使用的 MCP 服务。

Star
18,334
Fork
1,516
未关闭 Issue
52
最近提交
12小时前

这是什么?

GitDiagram 为 GitHub 仓库自动生成由 AI 撰写的架构图。只需把仓库 URL 中的 hub 换成 diagram 即可打开对应页面,图中组件可直接跳转到对应的文件或目录。支持通过 GitHub Token 访问私有仓库,图表可导出为 PNG,也可复制 Mermaid 源码。

项目还能生成约一分钟的旁白讲解视频,介绍项目的用途以及主要模块之间的关系。视频可下载为横版或竖版 MP4,并带有烧录字幕。制作新视频目前处于early access阶段,已有视频任何人都可以观看。

AI 智能体可以通过远程 MCP 服务 gitdiagram.com/mcp 免密钥接入,读取公开仓库的架构说明、组件、连接关系和 Mermaid 源码。前端基于 Next.js、React、TypeScript 和 Mermaid,可使用 Bun 在本地运行。

核心功能

  • 01为公开和私有 GitHub 仓库生成可交互的架构图
  • 02图中组件可直接跳转到对应源文件或目录
  • 03生成带字幕的一分钟旁白讲解视频
  • 04支持导出 PNG 或复制 Mermaid 源码
  • 05提供无需鉴权的远程 MCP 服务,供 AI 智能体调用

适用场景

  • 快速熟悉一个陌生的代码库
  • 向团队成员分享项目的整体架构概览
  • 让 AI 编程助手查询仓库的结构
  • 用短视频向他人讲解项目设计

快速上手

  1. 1

    克隆仓库

    git clone https://github.com/ahmedkhaleel2004/gitdiagram.git
  2. 2

    使用 Bun 安装依赖

    bun install
  3. 3

    复制示例环境变量文件,并按配置指南填写所需密钥

  4. 4

    启动开发服务器并打开 localhost:3000

    bun run dev

使用前须知

  • 本地运行需要 Cloudflare R2、Upstash Redis,以及 OpenAI 或 OpenRouter 的 API 密钥。
  • 制作新的讲解视频目前处于早期访问阶段,视频功能默认关闭。

标签

常见问题

gitdiagram 是什么?
将任意 GitHub 仓库生成可交互的架构图或一分钟讲解视频,并提供给 AI 智能体使用的 MCP 服务。 GitDiagram 为 GitHub 仓库自动生成由 AI 撰写的架构图。只需把仓库 URL 中的 hub 换成 diagram 即可打开对应页面,图中组件可直接跳转到对应的文件或目录。支持通过 GitHub Token 访问私有仓库,图表可导出为 PNG,也可复制 Mermaid 源码。
gitdiagram 可以免费使用吗?用的什么许可证?
gitdiagram 以 MIT 许可证开源。用于商业产品前,请先确认许可证条款。
gitdiagram 还在维护吗?
活跃维护中。gitdiagram 最近一次提交是在 2026年10月20日。
gitdiagram 适合用来做什么?
快速熟悉一个陌生的代码库 向团队成员分享项目的整体架构概览 让 AI 编程助手查询仓库的结构 用短视频向他人讲解项目设计
gitdiagram 怎么安装和运行?
克隆仓库: git clone https://github.com/ahmedkhaleel2004/gitdiagram.git 使用 Bun 安装依赖: bun install 复制示例环境变量文件,并按配置指南填写所需密钥 启动开发服务器并打开 localhost:3000: bun run dev
在哪里获取 gitdiagram?
源代码和安装说明在 GitHub 上:https://github.com/ahmedkhaleel2004/gitdiagram

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目