GitDiagram：可视化GitHub代码库结构，将代码仓库转换为交互式系统架构图

综合介绍

GitDiagram是一款创新的GitHub代码库可视化工具，能够将任何GitHub仓库快速转换为交互式系统架构图。它采用先进的AI技术（Claude 3.5 Sonnet），为开发者提供了一种全新的代码库浏览和理解方式。用户只需将GitHub URL中的"hub"替换为"diagram"，即可立即生成对应仓库的可视化图表。该工具不仅支持即时可视化转换，还提供了强大的交互功能，允许用户直接点击图表组件来导航至源代码文件和相关目录，大大提升了代码库的可读性和可理解性。GitDiagram采用现代化技术栈开发，包括Next.js、FastAPI和PostgreSQL等，确保了工具的高性能和可靠性。

体验地址：https://gitdiagram.com/

功能列表

• 即时可视化转换：将GitHub仓库结构快速转换为系统设计/架构图
• 智能交互导航：支持通过点击图表组件直接访问源文件和目录
• AI驱动生成：使用Claude 3.5 Sonnet确保图表生成的速度和准确性
• 自定义功能：支持根据用户指令修改和重新生成图表
• URL快捷访问：通过替换GitHub URL中的"hub"为"diagram"即可使用
• 完整API支持：提供公共API接口供集成使用（开发中）
• 实时更新：支持代码库结构变化的实时可视化更新
• 自定义部署：提供完整的自托管部署方案

使用帮助

基本使用流程

• 输入GitHub仓库URL或直接使用URL转换方式
• 等待系统自动生成交互式架构图
• 点击图表中的组件可直接导航到对应的源代码文件

使用限制说明

当前免费版本有以下使用限制：

• 每分钟限制1次图表生成请求
• 每天限制5次图表生成请求
• 如需突破限制，可选择自行部署方案

自托管部署指南

1. 环境准备

   git clone https://github.com/ahmedkhaleel2004/gitdiagram.git
   cd gitdiagram
   pnpm i
   

2. 配置环境变量
   • 复制.env.example为.env
   • 配置Anthropic API密钥
   • 可选配置GitHub个人访问令牌
3. 启动后端服务

   docker-compose up --build -d
   

   • 后端服务将在localhost:8000运行
   • 使用docker-compose logs -f查看日志
4. 数据库设置

   chmod +x start-database.sh
   ./start-database.sh
   pnpm db:push
   

   • 数据库将在localhost:5432运行
   • 使用pnpm db:studio可以查看和管理数据库
5. 启动前端服务

   pnpm dev
   

   • 访问localhost:3000即可使用本地部署版本

高级功能使用

1. 自定义指令
   • 可以通过界面提供自定义指令来修改图表生成方式
   • 支持针对特定代码库结构的可视化需求进行调整
2. API集成
   • 正在开发中的公共API将支持第三方系统集成
   • 可以通过API实现自动化的代码库可视化

使用技巧

1. 对于大型仓库
   • 建议首先关注主要模块的结构
   • 通过交互式导航逐步深入了解细节
2. 性能优化
   • 使用自托管方案可以突破默认限制
   • 考虑使用自己的Anthropic API密钥以获得更好的性能