# XCodeReviewer - 您的智能代码审计伙伴 🚀

<div style="width: 100%; max-width: 600px; margin: 0 auto;">
  <img src="public/images/logo.png" alt="XCodeReviewer Logo" style="width: 100%; height: auto; display: block; margin: 0 auto;">
</div>

<div align="center">
  <p>
    <a href="README.md">中文</a> •
    <a href="README_EN.md">English</a>
  </p>
</div>

<div align="center">

[![Version](https://img.shields.io/badge/version-1.2.0-blue.svg)](https://github.com/lintsinghua/XCodeReviewer/releases)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![React](https://img.shields.io/badge/React-18-61dafb.svg)](https://reactjs.org/)
[![TypeScript](https://img.shields.io/badge/TypeScript-5.7-3178c6.svg)](https://www.typescriptlang.org/)
[![Vite](https://img.shields.io/badge/Vite-5.1-646cff.svg)](https://vitejs.dev/)
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/lintsinghua/XCodeReviewer)

[![Stars](https://img.shields.io/github/stars/lintsinghua/XCodeReviewer?style=social)](https://github.com/lintsinghua/XCodeReviewer/stargazers)
[![Forks](https://img.shields.io/github/forks/lintsinghua/XCodeReviewer?style=social)](https://github.com/lintsinghua/XCodeReviewer/network/members)

[![Sponsor](https://img.shields.io/badge/Sponsor-赞助-blueviolet)](https://github.com/lintsinghua/lintsinghua.github.io/issues/1)
</div>

<div style="width: 100%; max-width: 600px; margin: 0 auto;">
  <a href="https://github.com/lintsinghua/XCodeReviewer">
    <img src="public/star-me-cn.svg" alt="Star this project" style="width: 100%; height: auto; display: block; margin: 0 auto;" />
  </a>
</div>

**XCodeReviewer** 是一个由大型语言模型（LLM）驱动的现代化代码审计平台，旨在为开发者提供智能、全面且极具深度的代码质量分析和审查服务。

#### 🌐 在线演示

无需部署，直接访问在线演示（数据存储在浏览器本地，支持所有核心功能）：

**[https://xcodereviewer-preview.vercel.app](https://xcodereviewer-preview.vercel.app)**

## 🌟 为什么选择 XCodeReviewer？

在快节奏的软件开发中，保证代码质量至关重要。传统代码审计工具规则死板、效率低下，而人工审计则耗时耗力。XCodeReviewer 借助 LLM 的强大能力，彻底改变了代码审查的方式：

![系统架构图](public/diagram.svg)

<div div align="center">
  <em>
    XCodeReviewer系统架构图
  </em>
</div>

---

- **AI 驱动的深度分析**：超越传统静态分析，理解代码意图，发现深层逻辑问题。
- **多维度、全方位评估**：从**安全性**、**性能**、**可维护性**到**代码风格**，提供 360 度无死角的质量评估。
- **清晰、可行的修复建议**：独创 **What-Why-How** 模式，不仅告诉您"是什么"问题，还解释"为什么"，并提供"如何修复"的具体代码示例。
- **多平台LLM/本地LLM支持**: 已实现 10+ 主流平台API调用功能（Gemini、OpenAI、Claude、通义千问、DeepSeek、智谱AI、Kimi、文心一言、MiniMax、豆包、Ollama本地大模型），支持用户自由配置和切换。
- **可视化运行时配置**：无需重新构建镜像，直接在浏览器中配置所有 LLM 参数和 API Keys，支持 API 中转站，配置保存在本地浏览器，安全便捷。
- **现代化、高颜值的用户界面**：基于 React + TypeScript 构建，提供流畅、直观的操作体验。

## 🎬 项目演示

### 主要功能界面

#### 智能仪表盘
![智能仪表盘](public/images/example1.png)
*实时展示项目统计、质量趋势和系统性能，提供全面的代码审计概览*

#### 即时分析
![即时分析](public/images/example2.png)
*支持代码片段快速分析，提供详细的 What-Why-How 解释和修复建议*

#### 项目管理
![项目管理](public/images/example3.png)
*集成 GitHub/GitLab 仓库，支持多语言项目审计和批量代码分析*

## 🚀 快速开始

### ☁️ Vercel 一键部署

适合快速部署和体验，无需服务器，全球 CDN 加速。

#### 方式一：一键部署按钮（推荐）⭐

点击下方按钮直接部署到 Vercel：

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/lintsinghua/XCodeReviewer)

#### 方式二：通过 Vercel CLI 部署

```bash
# 1. 安装 Vercel CLI
npm i -g vercel

# 2. 登录 Vercel
vercel login

# 3. 部署项目
vercel

# 4. 部署到生产环境
vercel --prod
```

#### 方式三：通过 Vercel Dashboard 部署

1. 访问 [Vercel Dashboard](https://vercel.com/dashboard)
2. 点击 "Add New..." → "Project"
3. 导入你的 GitHub 仓库
4. Vercel 会自动检测 Vite 项目配置
5. 配置环境变量（至少需要）：
   ```
   VITE_LLM_PROVIDER=your_llm_provider
   VITE_LLM_API_KEY=your_api_key_here
   VITE_USE_LOCAL_DB=true
   ```
6. 点击 "Deploy"

**✨ Vercel 部署优势**：
- ✅ 全球 CDN 加速，访问速度快
- ✅ 自动 HTTPS 和域名配置
- ✅ 零配置，开箱即用
- ✅ 支持自定义域名
- ✅ 自动部署（Git 推送后自动更新）

**✨ 数据库模式**：
- 默认自动使用**本地数据库模式**（IndexedDB），数据存储在浏览器中
- 无需配置任何数据库，开箱即用
- 如需使用 Supabase 云端数据库，可在环境变量中配置

**⚠️ 注意事项**：
- Vercel 主要用于前端部署，后端 API 需单独部署
- 部署后可在 `/admin` 页面进行运行时配置

---

### 🐳 Docker 部署（推荐生产环境）

#### 方式一：使用发布的镜像（最简单）⭐

直接使用最新发布的 Docker 镜像，支持 x86、ARM64（Mac M系列）、ARMv7 架构：

```bash
# 1. 拉取最新版本镜像
docker pull ghcr.io/lintsinghua/xcodereviewer:latest

# 2. 运行容器
docker run -d \
  -p 8888:80 \
  --name xcodereviewer \
  --restart unless-stopped \
  ghcr.io/lintsinghua/xcodereviewer:latest

# 3. 访问应用
# 浏览器打开 http://localhost:8888
```

**使用特定版本**：
```bash
# 拉取指定版本（如 v1.1.0）
docker pull ghcr.io/lintsinghua/xcodereviewer:v1.1.0

# 运行
docker run -d -p 8888:80 --name xcodereviewer ghcr.io/lintsinghua/xcodereviewer:v1.1.0
```

#### 方式二：本地构建（可选）

如果需要自定义构建：

```bash
# 1. 克隆项目
git clone https://github.com/lintsinghua/XCodeReviewer.git
cd XCodeReviewer

# 2. 使用 Docker Compose 构建并启动
docker-compose up -d

# 3. 访问应用
# 浏览器打开 http://localhost:8888
```

**✨ 运行时配置（推荐）**

Docker 部署后，您可以直接在浏览器中配置所有设置，无需重新构建镜像：

1. 访问 `http://localhost:8888/admin`（系统管理页面）
2. 在"系统配置"标签页中配置 LLM API Keys 和其他参数
3. 点击保存并刷新页面即可使用

> 📖 **详细配置说明请参考**：[系统配置使用指南](#系统配置首次使用必看)

### 💻 本地开发部署

适合需要开发或自定义修改的场景。

#### 环境要求
- Node.js 18+
- pnpm 8+ (推荐) 或 npm/yarn

#### 快速启动

```bash
# 1. 克隆项目
git clone https://github.com/lintsinghua/XCodeReviewer.git
cd XCodeReviewer

# 2. 安装依赖
pnpm install  # 或 npm install / yarn install

# 3. 配置环境变量
cp .env.example .env
# 编辑 .env 文件，配置必要参数（见下方配置说明）

# 4. 启动开发服务器
pnpm dev

# 5. 访问应用
# 浏览器打开 http://localhost:5173
```

#### 核心配置说明

编辑 `.env` 文件，配置以下必需参数：

```env
# ========== 必需配置 ==========
# LLM 提供商选择 (gemini|openai|claude|qwen|deepseek|zhipu|moonshot|baidu|minimax|doubao|ollama)
VITE_LLM_PROVIDER=gemini
# 对应的 API Key
VITE_LLM_API_KEY=your_api_key_here

# ========== 数据库配置（三选一）==========
# 方式1：本地数据库（推荐，开箱即用）
VITE_USE_LOCAL_DB=true

# 方式2：Supabase 云端数据库（支持多设备同步）
# VITE_SUPABASE_URL=https://your-project.supabase.co
# VITE_SUPABASE_ANON_KEY=your_anon_key

# 方式3：演示模式（不配置任何数据库，数据不持久化）

# ========== 可选配置 ==========
# GitHub 集成（用于仓库分析）
# VITE_GITHUB_TOKEN=your_github_token

# 输出语言（zh-CN: 中文 | en-US: 英文）
VITE_OUTPUT_LANGUAGE=zh-CN

# 分析参数调优
VITE_MAX_ANALYZE_FILES=40    # 单次最大分析文件数
VITE_LLM_CONCURRENCY=2       # 并发请求数
VITE_LLM_GAP_MS=500          # 请求间隔(ms)
```

#### 高级配置

遇到超时或连接问题时，可调整以下参数：

```env
VITE_LLM_TIMEOUT=300000                      # 增加超时时间
VITE_LLM_BASE_URL=https://your-proxy.com/v1 # 使用代理或中转服务
VITE_LLM_CONCURRENCY=1                       # 降低并发数
VITE_LLM_GAP_MS=1000                         # 增加请求间隔
```

**自定义请求头示例**（针对特殊中转站）：

```env
# JSON 格式字符串
VITE_LLM_CUSTOM_HEADERS='{"X-API-Version":"v1","X-Custom-Auth":"token123"}'
```

### 常见问题

<details>
<summary><b>如何快速切换 LLM 平台？</b></summary>

**方式一：浏览器配置（推荐）**

1. 访问 `http://localhost:8888/admin` 系统管理页面
2. 在"系统配置"标签页选择不同的 LLM 提供商
3. 填入对应的 API Key
4. 保存并刷新页面

**方式二：环境变量配置**

修改 `.env` 中的配置：

```env
# 切换到 OpenAI
VITE_LLM_PROVIDER=openai
VITE_OPENAI_API_KEY=your_key

# 切换到通义千问
VITE_LLM_PROVIDER=qwen
VITE_QWEN_API_KEY=your_key
```
</details>

<details>
<summary><b>遇到请求超时怎么办？</b></summary>

1. 增加超时时间：`VITE_LLM_TIMEOUT=300000`
2. 使用代理：配置 `VITE_LLM_BASE_URL`
3. 切换到国内平台：通义千问、DeepSeek、智谱AI 等
4. 降低并发：`VITE_LLM_CONCURRENCY=1`
</details>

<details>
<summary><b>数据库模式如何选择？</b></summary>

**本地模式（推荐）**：数据存储在浏览器 IndexedDB，开箱即用，隐私安全
```env
VITE_USE_LOCAL_DB=true
```

**云端模式**：数据存储在 Supabase，支持多设备同步
```env
VITE_SUPABASE_URL=https://your-project.supabase.co
VITE_SUPABASE_ANON_KEY=your_key
```

**演示模式**：不配置任何数据库，数据不持久化
</details>

<details>
<summary><b>如何使用 Ollama 本地大模型？</b></summary>

```bash
# 1. 安装 Ollama
curl -fsSL https://ollama.com/install.sh | sh  # macOS/Linux
# Windows: 访问 https://ollama.com/download

# 2. 拉取模型
ollama pull llama3  # 或 codellama、qwen2.5、deepseek-coder

# 3. 配置 XCodeReviewer
# 在 .env 中设置：
VITE_LLM_PROVIDER=ollama
VITE_LLM_MODEL=llama3
VITE_LLM_BASE_URL=http://localhost:11434/v1
```

推荐模型：`llama3`（综合）、`codellama`（代码专用）、`qwen2.5`（中文）
</details>

<details>
<summary><b>百度文心一言的 API Key 格式？</b></summary>

百度需要同时提供 API Key 和 Secret Key，用冒号分隔：
```env
VITE_LLM_PROVIDER=baidu
VITE_BAIDU_API_KEY=your_api_key:your_secret_key
```
获取地址：https://console.bce.baidu.com/qianfan/
</details>

<details>
<summary><b>如何使用 API 中转站？</b></summary>

许多用户使用 API 中转服务来访问 LLM（更稳定、更便宜）。配置方法：

1. 访问系统管理页面（`/admin`）
2. 在"系统配置"标签页中：
   - 选择 LLM 提供商（如 OpenAI）
   - **API 基础 URL**: 填入中转站地址（如 `https://your-proxy.com/v1`）
   - **API Key**: 填入中转站提供的密钥（而非官方密钥）
3. 保存并刷新页面

**注意**：
- 中转站 URL 通常以 `/v1` 结尾（OpenAI 兼容格式）
- 使用中转站的 API Key，不是官方的
- 确认中转站支持你选择的 AI 模型
</details>

<details>
<summary><b>如何备份本地数据库？</b></summary>

本地数据存储在浏览器 IndexedDB 中：
- 在应用的"系统管理"页面导出为 JSON 文件
- 通过导入 JSON 文件恢复数据
- 注意：清除浏览器数据会删除所有本地数据
</details>

<details>
<summary><b>如何设置输出语言？</b></summary>

```env
VITE_OUTPUT_LANGUAGE=zh-CN  # 中文（默认）
VITE_OUTPUT_LANGUAGE=en-US  # 英文
```
</details>

<details>
<summary><b>如何配置多个平台并快速切换？</b></summary>

在 `.env` 中预配置所有平台的 Key，切换时只需修改 `VITE_LLM_PROVIDER`：
```env
VITE_LLM_PROVIDER=gemini  # 当前使用的平台

# 预配置所有平台
VITE_GEMINI_API_KEY=key1
VITE_OPENAI_API_KEY=key2
VITE_QWEN_API_KEY=key3
```
</details>

<details>
<summary><b>如何查看系统日志和调试信息？</b></summary>

XCodeReviewer 内置了日志系统，记录核心操作和错误：

**查看日志**：
- 导航栏 -> 系统日志
- 或访问：`http://localhost:5173/logs` (开发) / `http://localhost:8888/logs` (生产)

**记录内容**：
- ✅ 用户核心操作（创建项目、审计任务、修改配置等）
- ✅ API 请求失败和错误
- ✅ 控制台错误（自动捕获）
- ✅ 未处理的异常

**功能特性**：
- 日志筛选、搜索
- 导出日志（JSON/CSV）
- 错误详情查看

**手动记录用户操作**：
```typescript
import { logger, LogCategory } from '@/shared/utils/logger';

// 记录用户操作
logger.logUserAction('创建项目', { projectName, projectType });
logger.logUserAction('开始审计', { taskId, fileCount });
```

</details>

### 🔑 获取 API Key

#### 支持的 LLM 平台

XCodeReviewer 支持 10+ 主流 LLM 平台，可根据需求自由选择：

| 平台类型 | 平台名称 | 特点 | 获取地址 |
|---------|---------|------|---------|
| **国际平台** | Google Gemini | 免费配额充足，推荐 | [获取](https://makersuite.google.com/app/apikey) |
| | OpenAI GPT | 稳定可靠，性能最佳 | [获取](https://platform.openai.com/api-keys) |
| | Anthropic Claude | 代码理解能力强 | [获取](https://console.anthropic.com/) |
| | DeepSeek | 性价比高 | [获取](https://platform.deepseek.com/) |
| **国内平台** | 阿里云通义千问 | 国内访问快 | [获取](https://dashscope.console.aliyun.com/) |
| | 智谱AI (GLM) | 中文支持好 | [获取](https://open.bigmodel.cn/) |
| | 月之暗面 Kimi | 长文本处理 | [获取](https://platform.moonshot.cn/) |
| | 百度文心一言 | 企业级服务 | [获取](https://console.bce.baidu.com/qianfan/) |
| | MiniMax | 多模态能力 | [获取](https://www.minimaxi.com/) |
| | 字节豆包 | 高性价比 | [获取](https://console.volcengine.com/ark) |
| **本地部署** | Ollama | 完全本地化，隐私安全 | [安装](https://ollama.com/) |

#### 配置示例

```env
# 通用配置（推荐）
VITE_LLM_PROVIDER=gemini
VITE_LLM_API_KEY=your_api_key_here

# 或使用平台专用配置
VITE_GEMINI_API_KEY=your_gemini_key
VITE_OPENAI_API_KEY=your_openai_key
# ... 更多平台配置见 .env.example
```

#### Supabase 配置（可选）

如需云端数据同步：
1. 访问 [Supabase](https://supabase.com/) 创建项目
2. 获取 URL 和匿名密钥
3. 在 Supabase SQL 编辑器执行 `supabase/migrations/full_schema.sql`
4. 在 `.env` 中配置相关参数

## ✨ 核心功能

<details>
<summary><b>🚀 项目管理</b></summary>

- **一键集成代码仓库**：无缝对接 GitHub、GitLab 等主流平台。
- **多语言“全家桶”支持**：覆盖 JavaScript, TypeScript, Python, Java, Go, Rust 等热门语言。
- **灵活的分支审计**：支持对指定代码分支进行精确分析。
</details>

<details>
<summary><b>⚡ 即时分析</b></summary>

- **代码片段“随手贴”**：直接在 Web 界面粘贴代码，立即获得分析结果。
- **10+ 种语言即时支持**：满足您多样化的代码分析需求。
- **毫秒级响应**：快速获取代码质量评分和优化建议。
</details>

<details>
<summary><b>🧠 智能审计</b></summary>

- **AI 深度代码理解**：支持多个主流 LLM 平台（Gemini、OpenAI、Claude、通义千问、DeepSeek 等），提供超越关键词匹配的智能分析。
- **五大核心维度检测**：
  - 🐛 **潜在 Bug**：精准捕捉逻辑错误、边界条件和空指针等问题。
  - 🔒 **安全漏洞**：识别 SQL 注入、XSS、敏感信息泄露等安全风险。
  - ⚡ **性能瓶颈**：发现低效算法、内存泄漏和不合理的异步操作。
  - 🎨 **代码风格**：确保代码遵循行业最佳实践和统一规范。
  - 🔧 **可维护性**：评估代码的可读性、复杂度和模块化程度。
</details>

<details>
<summary><b>💡 可解释性分析 (What-Why-How)</b></summary>

- **What (是什么)**：清晰地指出代码中存在的问题。
- **Why (为什么)**：详细解释该问题可能带来的潜在风险和影响。
- **How (如何修复)**：提供具体的、可直接使用的代码修复示例。
- **精准代码定位**：快速跳转到问题所在的行和列。
</details>

<details>
<summary><b>📊 可视化报告</b></summary>

- **代码质量仪表盘**：提供 0-100 分的综合质量评估，让代码健康状况一目了然。
- **多维度问题统计**：按类型和严重程度对问题进行分类统计。
- **质量趋势分析**：通过图表展示代码质量随时间的变化趋势。
</details>

<details>
<summary><b>⚙️ 系统管理</b></summary>

访问 `/admin` 页面，提供完整的系统配置和数据管理功能：

- **🔧 可视化配置管理**（运行时配置）：
  - 🎯 **LLM 配置**：在浏览器中直接配置 API Keys、模型、超时等参数
  - 🔑 **平台密钥**：管理 10+ LLM 平台的 API Keys，支持快速切换
  - ⚡ **分析参数**：调整并发数、间隔时间、最大文件数等
  - 🌐 **API 中转站支持**：轻松配置第三方 API 代理服务
  - 💾 **配置优先级**：运行时配置 > 构建时配置，无需重新构建镜像
  
- **💾 数据库管理**：
  - 🏠 **三种模式**：本地 IndexedDB / Supabase 云端 / 演示模式
  - 📤 **导出备份**：将数据导出为 JSON 文件
  - 📥 **导入恢复**：从备份文件恢复数据
  - 🗑️ **清空数据**：一键清理所有本地数据
  - 📊 **存储监控**：实时查看存储空间使用情况
  
- **📈 数据概览**：
  - 项目、任务、问题的完整统计
  - 可视化图表展示质量趋势
  - 存储使用情况分析
</details>

## 🛠️ 技术栈

| 分类 | 技术 | 说明 |
| :--- | :--- | :--- |
| **前端框架** | `React 18` `TypeScript` `Vite` | 现代化前端开发栈，支持热重载和类型安全 |
| **UI 组件** | `Tailwind CSS` `Radix UI` `Lucide React` | 响应式设计，无障碍访问，丰富的图标库 |
| **数据可视化** | `Recharts` | 专业的图表库，支持多种图表类型 |
| **路由管理** | `React Router v6` | 单页应用路由解决方案 |
| **状态管理** | `React Hooks` `Sonner` | 轻量级状态管理和通知系统 |
| **AI 引擎** | `多平台 LLM` | 支持 Gemini、OpenAI、Claude、通义千问、DeepSeek 等 10+ 主流平台 |
| **数据存储** | `IndexedDB` `Supabase` `PostgreSQL` | 本地数据库 + 云端数据库双模式支持 |
| **HTTP 客户端** | `Axios` `Ky` | 现代化的 HTTP 请求库 |
| **代码质量** | `Biome` `Ast-grep` `TypeScript` | 代码格式化、静态分析和类型检查 |
| **构建工具** | `Vite` `PostCSS` `Autoprefixer` | 快速的构建工具和 CSS 处理 |

## 📁 项目结构

```
XCodeReviewer/
├── src/
│   ├── app/                # 应用配置
│   │   ├── App.tsx         # 主应用组件
│   │   ├── main.tsx        # 应用入口点
│   │   └── routes.tsx      # 路由配置
│   ├── components/         # React 组件
│   │   ├── layout/         # 布局组件 (Header, Footer, PageMeta)
│   │   ├── ui/             # UI 组件库 (基于 Radix UI)
│   │   ├── system/         # 系统配置组件
│   │   ├── database/       # 数据库管理组件
│   │   └── debug/          # 调试组件
│   ├── pages/              # 页面组件
│   │   ├── Dashboard.tsx   # 仪表盘
│   │   ├── Projects.tsx    # 项目管理
│   │   ├── InstantAnalysis.tsx # 即时分析
│   │   ├── AuditTasks.tsx  # 审计任务
│   │   └── AdminDashboard.tsx # 系统管理
│   ├── features/           # 功能模块
│   │   ├── analysis/       # 分析相关服务
│   │   │   └── services/   # AI 代码分析引擎
│   │   └── projects/       # 项目相关服务
│   │       └── services/   # 仓库扫描、ZIP 文件扫描
│   ├── shared/             # 共享工具
│   │   ├── config/         # 配置文件
│   │   │   ├── database.ts      # 数据库统一接口
│   │   │   ├── localDatabase.ts # IndexedDB 实现
│   │   │   └── env.ts           # 环境变量配置
│   │   ├── types/          # TypeScript 类型定义
│   │   ├── hooks/          # 自定义 React Hooks
│   │   ├── utils/          # 工具函数
│   │   │   └── initLocalDB.ts   # 本地数据库初始化
│   │   └── constants/      # 常量定义
│   └── assets/             # 静态资源
│       └── styles/         # 样式文件
├── supabase/
│   └── migrations/         # 数据库迁移文件
├── public/
│   └── images/             # 图片资源
├── scripts/                # 构建和设置脚本
└── rules/                  # 代码规则配置
```

## 🎯 使用指南

### 系统配置（首次使用必看）

访问 `/admin` 系统管理页面，在"系统配置"标签页中配置：

#### 1. **配置 LLM 提供商**
- 选择您要使用的 LLM 平台（Gemini、OpenAI、Claude 等）
- 填入 API Key（支持通用 Key 或平台专用 Key）
- 可选：配置模型名称、API 基础 URL（用于中转站）

#### 2. **配置 API 中转站**（如果使用）
- 在"API 基础 URL"中填入中转站地址（如 `https://your-proxy.com/v1`）
- 填入中转站提供的 API Key
- 保存配置

#### 3. **调整分析参数**（可选）
- 最大分析文件数、并发请求数、请求间隔
- 输出语言（中文/英文）

**配置完成后点击"保存所有更改"并刷新页面即可使用。**

### 即时代码分析
1. 访问 `/instant-analysis` 页面
2. 选择编程语言（支持 10+ 种语言）
3. 粘贴代码或上传文件
4. 点击"开始分析"获得 AI 分析结果
5. 查看详细的问题报告和修复建议

### 项目管理
1. 访问 `/projects` 页面
2. 点击"新建项目"创建项目
3. 配置仓库 URL 和扫描参数
4. 启动代码审计任务
5. 查看审计结果和问题统计

### 审计任务
1. 在项目详情页创建审计任务
2. 选择扫描分支和排除模式
3. 配置分析深度和范围
4. 监控任务执行状态
5. 查看详细的问题报告

### 审计报告导出
1. 在任务详情页点击"导出报告"按钮
2. 选择导出格式：
   - **JSON 格式**：结构化数据，适合程序处理和集成
   - **PDF 格式**：专业报告，适合打印和分享（通过浏览器打印功能）
3. JSON 报告包含完整的任务信息、问题详情和统计数据
4. PDF 报告提供美观的可视化展示，支持中文显示
5. 报告内容包括：项目信息、审计统计、问题详情（按严重程度分类）、修复建议等

**PDF 导出提示：**
- 点击"导出 PDF"后会弹出浏览器打印对话框
- 建议在打印设置中**取消勾选"页眉和页脚"选项**，以获得更干净的报告（避免显示 URL 等信息）
- 在打印对话框中选择"另存为 PDF"即可保存报告文件

### 构建和部署

```bash
# 开发模式
pnpm dev

# 构建生产版本
pnpm build

# 预览构建结果
pnpm preview

# 代码检查
pnpm lint
```

### 环境变量说明

#### 核心LLM配置
| 变量名 | 必需 | 默认值 | 说明 |
|--------|------|--------|------|
| `VITE_LLM_PROVIDER` | ✅ | `gemini` | LLM提供商：`gemini`\|`openai`\|`claude`\|`qwen`\|`deepseek`\|`zhipu`\|`moonshot`\|`baidu`\|`minimax`\|`doubao`\|`ollama` |
| `VITE_LLM_API_KEY` | ✅ | - | 通用API Key（优先级高于平台专用配置） |
| `VITE_LLM_MODEL` | ❌ | 自动 | 模型名称（不指定则使用各平台默认模型） |
| `VITE_LLM_BASE_URL` | ❌ | - | 自定义API端点（**支持所有平台的中转站**、代理或私有部署） |
| `VITE_LLM_TIMEOUT` | ❌ | `150000` | 请求超时时间（毫秒） |
| `VITE_LLM_TEMPERATURE` | ❌ | `0.2` | 温度参数（0.0-2.0），控制输出随机性 |
| `VITE_LLM_MAX_TOKENS` | ❌ | `4096` | 最大输出token数 |
| `VITE_LLM_CUSTOM_HEADERS` | ❌ | - | 自定义HTTP请求头（JSON格式字符串），用于特殊中转站或自建服务 |

> 💡 **API 格式支持**：XCodeReviewer 支持三种主流 API 格式：
> - **OpenAI 兼容格式**（最常见）：适用于大多数中转站和 OpenRouter
> - **Gemini 格式**：Google Gemini 官方及兼容服务
> - **Claude 格式**：Anthropic Claude 官方及兼容服务
> 
> 配置时只需选择对应的 LLM 提供商，填入中转站地址和 Key 即可。自定义请求头功能可满足特殊中转站的额外要求。

#### 平台专用API Key配置（可选）
| 变量名 | 说明 | 特殊要求 |
|--------|------|---------|
| `VITE_GEMINI_API_KEY` | Google Gemini API Key | - |
| `VITE_GEMINI_MODEL` | Gemini模型 (默认: gemini-1.5-flash) | - |
| `VITE_OPENAI_API_KEY` | OpenAI API Key | - |
| `VITE_OPENAI_MODEL` | OpenAI模型 (默认: gpt-4o-mini) | - |
| `VITE_OPENAI_BASE_URL` | OpenAI自定义端点 | 用于中转服务 |
| `VITE_CLAUDE_API_KEY` | Anthropic Claude API Key | - |
| `VITE_CLAUDE_MODEL` | Claude模型 (默认: claude-3-5-sonnet-20241022) | - |
| `VITE_QWEN_API_KEY` | 阿里云通义千问 API Key | - |
| `VITE_QWEN_MODEL` | 通义千问模型 (默认: qwen-turbo) | - |
| `VITE_DEEPSEEK_API_KEY` | DeepSeek API Key | - |
| `VITE_DEEPSEEK_MODEL` | DeepSeek模型 (默认: deepseek-chat) | - |
| `VITE_ZHIPU_API_KEY` | 智谱AI API Key | - |
| `VITE_ZHIPU_MODEL` | 智谱模型 (默认: glm-4-flash) | - |
| `VITE_MOONSHOT_API_KEY` | 月之暗面 Kimi API Key | - |
| `VITE_MOONSHOT_MODEL` | Kimi模型 (默认: moonshot-v1-8k) | - |
| `VITE_BAIDU_API_KEY` | 百度文心一言 API Key | ⚠️ 格式: `API_KEY:SECRET_KEY` |
| `VITE_BAIDU_MODEL` | 文心模型 (默认: ERNIE-3.5-8K) | - |
| `VITE_MINIMAX_API_KEY` | MiniMax API Key | - |
| `VITE_MINIMAX_MODEL` | MiniMax模型 (默认: abab6.5-chat) | - |
| `VITE_DOUBAO_API_KEY` | 字节豆包 API Key | - |
| `VITE_DOUBAO_MODEL` | 豆包模型 (默认: doubao-pro-32k) | - |

#### 数据库配置（可选）
| 变量名 | 必需 | 说明 |
|--------|------|------|
| `VITE_SUPABASE_URL` | ❌ | Supabase项目URL（用于数据持久化） |
| `VITE_SUPABASE_ANON_KEY` | ❌ | Supabase匿名密钥 |

> 💡 **提示**：不配置Supabase时，系统以演示模式运行，数据不持久化

#### Git仓库集成配置
| 变量名 | 必需 | 说明 |
|--------|------|------|
| `VITE_GITHUB_TOKEN` | ✅ | GitHub Personal Access Token |
| `VITE_GITLAB_TOKEN` | ✅ | GitLab Personal Access Token 或 Project Access Token |

#### 分析行为配置
| 变量名 | 默认值 | 说明 |
|--------|--------|------|
| `VITE_MAX_ANALYZE_FILES` | `40` | 单次分析的最大文件数 |
| `VITE_LLM_CONCURRENCY` | `2` | LLM并发请求数（降低可避免频率限制） |
| `VITE_LLM_GAP_MS` | `500` | LLM请求间隔（毫秒，增加可避免频率限制） |

#### 应用配置
| 变量名 | 默认值 | 说明 |
|--------|--------|------|
| `VITE_APP_ID` | `xcodereviewer` | 应用标识符 |

## 🤝 贡献指南

我们热烈欢迎所有形式的贡献！无论是提交 issue、创建 PR，还是改进文档，您的每一次贡献对我们都至关重要。请联系我们了解详细信息。

### 开发流程

1.  **Fork** 本项目
2.  创建您的功能分支 (`git checkout -b feature/AmazingFeature`)
3.  提交您的更改 (`git commit -m 'Add some AmazingFeature'`)
4.  推送到分支 (`git push origin feature/AmazingFeature`)
5.  创建一个 **Pull Request**

## 🙏 致谢

### 核心技术支持
- **[React](https://reactjs.org/)** & **[Vite](https://vitejs.dev/)**: 提供现代化的前端开发体验
- **[TypeScript](https://www.typescriptlang.org/)**: 提供类型安全保障
- **[Tailwind CSS](https://tailwindcss.com/)**: 提供现代化的 CSS 框架
- **[Radix UI](https://www.radix-ui.com/)**: 提供无障碍的 UI 组件库

### AI 平台支持
- **[Google Gemini AI](https://ai.google.dev/)**: 提供强大的 AI 分析能力
- **[OpenAI](https://openai.com/)**: GPT系列模型支持
- **[Anthropic Claude](https://www.anthropic.com/)**: Claude模型支持
- **[DeepSeek](https://www.deepseek.com/)**: 国产AI大模型支持
- **[阿里云通义千问](https://tongyi.aliyun.com/)**: 企业级AI服务
- **[智谱AI](https://www.zhipuai.cn/)**: GLM系列模型
- **[Moonshot AI](https://www.moonshot.cn/)**: Kimi模型支持
- **[Ollama](https://ollama.com/)**: 本地模型部署方案

### 数据存储
- **[Supabase](https://supabase.com/)**: 提供便捷的后端即服务支持
- **[IndexedDB](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API)**: 浏览器本地存储方案

### 功能组件
- **[Recharts](https://recharts.org/)**: 提供专业的图表组件
- **[Lucide Icons](https://lucide.dev/)**: 提供精美的图标库
- **[Sonner](https://sonner.emilkowal.ski/)**: 提供优雅的通知组件
- **[fflate](https://github.com/101arrowz/fflate)**: ZIP文件处理

### 特别感谢
- 感谢所有为本项目提交 Issue 和 Pull Request 的贡献者
- 感谢所有 Star 本项目的开发者
- 感谢开源社区的无私分享精神
- 以及所有本项目所使用的开源软件的作者们！

## 👥 贡献者

感谢以下优秀的贡献者们，他们让 XCodeReviewer 更强大！

[![Contributors](https://contrib.rocks/image?repo=lintsinghua/XCodeReviewer)](https://github.com/lintsinghua/XCodeReviewer/graphs/contributors)

## 📞 联系我们

- **项目链接**: [https://github.com/lintsinghua/XCodeReviewer](https://github.com/lintsinghua/XCodeReviewer)
- **问题反馈**: [Issues](https://github.com/lintsinghua/XCodeReviewer/issues)
- **作者邮箱**: lintsinghua@qq.com（合作请注明来意）

## 🎯 未来计划（正在加急中）

目前 XCodeReviewer 定位为快速原型验证阶段，功能需要逐渐完善，根据项目后续发展和大家的建议，未来开发计划如下（尽快实现）：

- **✅ 多平台LLM支持**: 已实现 10+ 主流平台API调用功能（Gemini、OpenAI、Claude、通义千问、DeepSeek、智谱AI、Kimi、文心一言、MiniMax、豆包、Ollama本地大模型），支持用户自由配置和切换
- **✅ 本地模型支持**: 已加入对 Ollama 本地大模型的调用功能，满足数据隐私需求
- **✅ 可视化配置管理**: 已实现运行时配置系统，支持在浏览器中直接配置所有 LLM 参数、API Keys，支持 API 中转站，无需重新构建镜像
- **✅ 专业报告文件生成**: 根据不同的需求生成相关格式的专业审计报告文件，支持文件报告格式定制等
- **✅ 全平台中转站支持**: 所有 LLM 平台均支持 API 中转站、自建服务和 OpenRouter，支持自定义请求头，覆盖 99.9% 的使用场景
- **🚧 CI/CD 集成与 PR 自动审查**: 计划实现 GitHub/GitLab CI 集成，支持 PR 自动触发审查、智能评论、质量门禁、增量分析等完整的代码审查工作流
- **Multi-Agent Collaboration**: 考虑引入多智能体协作架构，实现`Agent+人工对话`反馈功能，包括多轮对话流程展示、人工干预等，以获得更清晰、透明、可监督的审计过程
- **审计标准自定义**: 支持通过 YAML/JSON 定义团队特定的编码规范和审计规则，提供常见框架的最佳实践模板，结合强化学习和监督学习微调，获得更符合需求和标准的审计结果
---


⭐ 如果这个项目对您有帮助，请给我们一个 **Star**！您的支持是我们不断前进的动力！

[![Star History](https://api.star-history.com/svg?repos=lintsinghua/XCodeReviewer&type=Date)](https://star-history.com/#lintsinghua/XCodeReviewer&Date)
---

## 📄 免责声明 (Disclaimer)

本免责声明旨在明确用户使用本开源项目的相关责任和风险，保护项目作者、贡献者和维护者的合法权益。本开源项目提供的代码、工具及相关内容仅供参考和学习使用。

#### 1. **代码隐私与安全警告 (Code Privacy and Security Warning)**
- ⚠️ **重要提示**：本工具通过调用第三方LLM服务商API进行代码分析，**您的代码将被发送到所选择的LLM服务商服务器**。
- **严禁上传以下类型的代码**：
  - 包含商业机密、专有算法或核心业务逻辑的代码
  - 涉及国家秘密、国防安全或其他保密信息的代码
  - 包含敏感数据（如用户数据、密钥、密码、token等）的代码
  - 受法律法规限制不得外传的代码
  - 客户或第三方的专有代码（未经授权）
- 用户**必须自行评估代码的敏感性**，对上传代码及其可能导致的信息泄露承担全部责任。
- **建议**：对于敏感代码，请等待本项目未来支持本地模型部署功能，或使用私有部署的LLM服务。
- 项目作者、贡献者和维护者**对因用户上传敏感代码导致的任何信息泄露、知识产权侵权、法律纠纷或其他损失不承担任何责任**。

#### 2. **非专业建议 (Non-Professional Advice)**
- 本工具提供的代码分析结果和建议**仅供参考**，不构成专业的安全审计、代码审查或法律意见。
- 用户必须结合人工审查、专业工具及其他可靠资源，对关键代码（尤其是涉及安全、金融、医疗等高风险领域）进行全面验证。

#### 3. **无担保与免责 (No Warranty and Liability Disclaimer)**
- 本项目以“原样”形式提供，**不附带任何明示或默示担保**，包括但不限于适销性、特定用途适用性及非侵权性。
- 作者、贡献者和维护者**不对任何直接、间接、附带、特殊、惩戒性或后果性损害承担责任**，包括但不限于数据丢失、系统中断、安全漏洞或商业损失，即使已知此类风险存在。

#### 4. **AI 分析局限性 (Limitations of AI Analysis)**
- 本工具依赖 Google Gemini 等 AI 模型，分析结果可能包含**错误、遗漏或不准确信息**，无法保证100% 可靠性。
- AI 输出**不能替代人类专家判断**，用户应对最终代码质量及应用后果全权负责。

#### 5. **第三方服务与数据隐私 (Third-Party Services and Data Privacy)**
- 本项目集成 Google Gemini、OpenAI、Claude、通义千问、DeepSeek 等多个第三方LLM服务，以及 Supabase、GitHub 等服务，使用时须遵守其各自服务条款和隐私政策。
- **代码传输说明**：用户提交的代码将通过API发送到所选LLM服务商进行分析，传输过程和数据处理遵循各服务商的隐私政策。
- 用户需自行获取、管理 API 密钥，本项目**不存储、传输或处理用户的API密钥和敏感信息**。
- 第三方服务的可用性、准确性、隐私保护、数据留存政策或中断风险，由服务提供商负责，本项目作者不承担任何连带责任。
- **数据留存警告**：不同LLM服务商对API请求数据的留存和使用政策各不相同，请用户在使用前仔细阅读所选服务商的隐私政策和使用条款。

#### 6. **用户责任 (User Responsibilities)**
- 用户在使用前须确保其代码不侵犯第三方知识产权，不包含保密信息，并严格遵守开源许可证及相关法规。
- 用户**对上传代码的内容、性质和合规性承担全部责任**，包括但不限于：
  - 确保代码不包含敏感信息或商业机密
  - 确保拥有代码的使用和分析权限
  - 遵守所在国家/地区关于数据保护和隐私的法律法规
  - 遵守公司或组织的保密协议和安全政策
- **严禁将本工具用于非法、恶意或损害他人权益的活动**，用户对所有使用后果承担全部法律与经济责任。作者、贡献者和维护者对此类活动及其后果**不承担任何责任**，并保留追究滥用者的权利。

#### 7. **开源贡献 (Open Source Contributions)**
- 贡献者的代码、内容或建议**不代表项目官方观点**，其准确性、安全性及合规性由贡献者自行负责。
- 项目维护者保留审查、修改、拒绝或移除任何贡献的权利。

如有疑问，请通过 GitHub Issues 联系维护者。本免责声明受项目所在地法律管辖。
