# code-analyzer

**Repository Path**: nbedk/code-analyzer

## Basic Information

- **Project Name**: code-analyzer
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-08-21
- **Last Updated**: 2026-08-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 🏛️ RepoArchitect - 开源项目架构深度分析与 AFFiNE 归档引擎

> **面向企业技术架构师与技术委员会的 GitHub 开源项目评估、C4 架构建模、技术落地可行性论证与 AFFiNE 知识库一键归档系统。**

[![Google AI Studio](https://img.shields.io/badge/Google%20AI%20Studio-Gemini%203.7-orange.svg)](https://aistudio.google.com/)
[![Rate Limit Fallback](https://img.shields.io/badge/Failover-Auto%20429%20Switch-brightgreen.svg)](#-限流自动故障转移机制)
[![License: MIT](https://img.shields.io/badge/License-MIT-purple.svg)](LICENSE)

---

## 🌟 Google AI Studio 官方入口与 0 成本使用

- **🌐 Google AI Studio 官网入口**：[https://aistudio.google.com/](https://aistudio.google.com/)
- **🔑 免费 API Key 申请（无需绑定信用卡）**：[https://aistudio.google.com/app/apikey](https://aistudio.google.com/app/apikey)
- **📚 官方开发者文档**：[https://ai.google.dev/](https://ai.google.dev/)

> [!TIP]
> **免费层主力推荐**：**`gemini-3.7-flash`**，在 Google AI Studio 免费层下拥有高达 **15 RPM / 100万 TPM / 1500 RPD** 的极高额度，整套 5 阶段架构流水线 10 秒内即可完成，0 成本无限畅享。

---

## 🛡️ 限流 (429) 智能自动故障转移机制

系统内置了企业级的 **Rate-Limit Failover（自动降级切换）引擎**：
- 当主模型（如 `gemini-3.7-flash` 或 `gemini-3.7-pro`）触发 `429 / ResourceExhausted / QuotaExceeded` 速率限制时；
- 系统会自动捕获异常并在控制台输出告警，**无缝平滑切换至下一顺位备选模型**（`gemini-2.5-flash` ➔ `gemini-3.7-pro` ➔ `gemini-2.5-pro` ➔ `gemini-1.5-flash`）继续完成生成，**确保架构报告生成过程绝不中断**！

---

## 🎯 架构师核心诉求与解决的问题

作为公司的**技术架构师**或**技术选型决策者**，在评估引入一个 GitHub 开源项目时，经常面临以下痛点：
1. **源码复杂，调研成本高**：手动梳理目录树、技术栈依赖和核心调用链极其耗时。
2. **缺乏标准化的架构全景**：缺少符合 C4 Model（Context/Container/Component）标准的规范架构图与时序图。
3. **落地风险与暗坑难识别**：难以一眼看穿项目潜在的技术债、高并发瓶颈、内存泄漏隐患与企业级功能缺失（如多租户/RBAC/监控）。
4. **决策文档与知识沉淀割裂**：调研结果散落，无法快速归档到企业统一知识库（如 **AFFiNE**）。

**RepoArchitect** 专门针对上述场景设计，一键输出 5 维标准架构文档体系，并一键打包为 AFFiNE 知识库。

---

## 📑 生成的架构文档体系

分析完成后，系统会自动生成以下标准文档包（并打包为 `.zip` 供 AFFiNE 导入）：

```
📁 [项目名]_AFFiNE_Archive/
├── 📑 00_README_AFFiNE导入指南.md    # AFFiNE 客户端快速导入指引与目录索引
├── 📑 01_项目总览与架构师评级.md       # 项目一句话定位、多维雷达打分表、CTO 一页纸决策摘要
├── 📑 02_技术调研报告.md             # 业务背景、生态健康度、开源协议合规、技术栈矩阵、竞品对比
├── 📑 03_系统架构与C4全景设计.md      # C4 Context/Container 图、Mermaid 时序流、核心设计模式
├── 📑 04_核心功能与优缺点深度剖析.md   # 核心亮点拆解、Pros/Cons 对照、潜在技术债与避坑指南 (Callouts)
├── 📑 05_企业级技术落地与演进方案.md   # 高可用部署拓扑、企业集成改造、POC 验证清单、演进甘特图
├── 📑 06_完整全景架构白皮书.md        # 单文件汇总版（方便打印或全文阅读）
└── 📊 scan_metadata.json             # 结构化数据元数据
```

---

## 📥 如何导入到本地 AFFiNE 知识库

1. **一键导入**：
   - 打开本地安装的 **AFFiNE** 桌面客户端（或访问网页端）。
   - 在左侧工作区侧边栏点击 **`···` -> Import -> Markdown**。
   - 选中输出目录中的全部 `.md` 文件或直接拖拽导入。
2. **原生特性支持**：
   - ✅ 自动解析 YAML Frontmatter 元数据标签与更新时间。
   - ✅ 原生渲染 Mermaid 架构图、时序图与甘特图。
   - ✅ 原生呈现 GitHub 风格 Callout 警告块（`> [!WARNING]`, `> [!NOTE]`）。
   - ✅ 内置页面间相互跳转导航栏。

---

## 🚀 快速上手

### 1. 环境准备与安装

```bash
# 克隆/进入项目目录
cd d:/gitcode3/code-analyzer

# 安装依赖
pip install -r requirements.txt
```

### 2. 配置环境变量

复制 `.env.example` 为 `.env` 并填写 API Key：

```bash
cp .env.example .env
```

编辑 `.env`：
```ini
# Google AI Studio (推荐)
GEMINI_API_KEY=AIzaSy...
GEMINI_MODEL=gemini-2.5-pro

# 或者配置 OpenAI / DeepSeek
OPENAI_API_KEY=sk-...
OPENAI_BASE_URL=https://api.openai.com/v1
OPENAI_MODEL=gpt-4o
```

---

## 💻 运行方式

### 方式一：启动交互式可视化 Web 仪表盘 (推荐)

```bash
python run_web.py
```
> 打开浏览器访问 **http://localhost:8501**，即可在可视化界面输入 GitHub 仓库地址，查看实时架构图渲染并一键下载 AFFiNE 压缩包。

---

### 方式二：使用 Rich 终端命令行 (CLI)

```bash
# 1. 使用 Google AI Studio (Gemini) 分析远程 GitHub 仓库
python run_cli.py analyze https://github.com/fastapi/fastapi

# 2. 指定模型提供商与输出目录
python run_cli.py analyze vllm-project/vllm --provider gemini --model gemini-2.5-pro -o ./my_affine_docs

# 3. 分析本地源码工程
python run_cli.py analyze D:/gitcode3/my-service

# 4. 离线规则模式 (无需 API Key 快速体验)
python run_cli.py analyze https://github.com/gin-gonic/gin --mock
```

---

## 🏗️ 核心架构全景

```mermaid
flowchart TD
    subgraph Input ["输入层"]
        A1["GitHub 仓库 URL"]
        A2["本地代码目录"]
    end

    subgraph CoreEngine ["RepoArchitect 核心引擎"]
        B1["Git / GitHub API 提取器"]
        B2["多语言依赖解析器 (npm/maven/go/cargo/pip)"]
        B3["AST 代码结构与架构特征扫描器"]
    end

    subgraph Pipeline ["架构师 AI 评估流水线"]
        C1["技术调研分析器 (Survey)"]
        C2["C4 架构建模与 Mermaid 引擎 (Architecture)"]
        C3["功能矩阵与技术债挖掘 (Pros & Cons)"]
        C4["企业落地实施规划 (Landing Roadmap)"]
        C5["CTO 一页纸决策摘要 (Executive Briefing)"]
    end

    subgraph Exporter ["AFFiNE 归档引擎"]
        D1["AFFiNE Markdown Formatter"]
        D2["TOC 导航与 Frontmatter 注入"]
        D3["Zip 压缩与本地归档打包"]
    end

    Input --> CoreEngine --> Pipeline --> Exporter
```

---

## 🧪 运行测试套件

```bash
pytest tests/ -v
```

---

## 📄 License

MIT License © 2026 RepoArchitect Team.