# ai-code-reviewer

**Repository Path**: blues_c/ai-code-reviewer

## Basic Information

- **Project Name**: ai-code-reviewer
- **Description**: 一个基于 Gradio + OpenAI 兼容接口的 AI 代码审查助手，支持单个或多个文件、整个项目目录审查
- **Primary Language**: Python
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-04-08
- **Last Updated**: 2026-04-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

一个基于 Gradio + OpenAI 兼容接口的 AI 代码审查助手，支持：

- 单个或多个文件审查
- 整个项目目录审查


![alt text](image.png)

## 功能特点

- 兼容 OpenAI 风格接口，支持自定义 `base_url`
- 支持选择模型、温度、最大输出 tokens
- 项目级审查支持本地目录或 ZIP 包输入
- 支持包含文件模式、排除目录、文件数和文件大小限制
- 大项目会自动分批审查并生成最终汇总报告
- 输出中文审查建议，并展示实际发送给模型的 prompt 预览

## 环境准备

### Windows PowerShell

```powershell
python -m venv .venv
.\.venv\Scripts\Activate.ps1
pip install -r requirements.txt
```

### Windows CMD

```bat
python -m venv .venv
.\.venv\Scripts\activate.bat
pip install -r requirements.txt
```

### macOS / Linux

```bash
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
```

## 启动

```bash
python app.py
```

也可以使用包入口：

```bash
python -m ai_reviewer
```

## 使用方式

### 1. 文件审查

- 上传一个或多个代码文件
- 填写审查重点
- 配置 `base_url`、`api_key`、`model`
- 点击“开始文件审查”

### 2. 整个项目审查

- 填写本地项目目录路径，或直接上传一个 ZIP 项目包
- 配置包含文件模式，例如 `*.py, *.js, *.ts, *.md`
- 配置排除目录，例如 `.git, node_modules, dist`
- 调整最多读取文件数、每个文件最多读取字符数
- 点击“开始项目审查”

说明：

- 如果项目较大，程序会自动拆成多个批次分别审查，再生成最终汇总报告
- 这样比单次把所有文件直接塞进 prompt 更稳定，也更适合长上下文场景

## 项目结构

```text
.
├── ai_reviewer/
│   ├── __init__.py
│   ├── __main__.py
│   ├── reviewer.py
│   └── ui.py
├── app.py
├── reviewer.py
├── requirements.txt
└── README.md
```

## 说明

- 根目录 `app.py` 是兼容启动入口，方便继续使用 `python app.py`
- 根目录 `reviewer.py` 是兼容导出层，避免旧代码引用失效
- 实际应用代码已收敛到 `ai_reviewer/` 包中，便于后续扩展测试、CLI 或打包