🔍 代码审查自动化

使用 Claude 大语言模型（LLM）自动审查 GitHub Pull Request

自动分析 GitHub Pull Request，提供基于 Claude AI 的智能代码审查、安全扫描与风格检查。

✨ 功能特性

• PR 列表 — 查看仓库中的所有 Pull Request
• PR 详情 — 获取任意 PR 的完整信息
• 文件变更 — 精确查看哪些文件发生了变更
• PR 搜索 — 按关键词搜索 PR
• 仓库信息 — 获取仓库通用统计信息
• Claude 分析 — 基于 Claude LLM 的 AI 驱动代码审查
• 代码质量评分 — 自动化质量评估（0–100 分）
• 安全扫描 — 自动化安全漏洞检测
• 风格检查 — 自动化代码风格与 linting 检查
• 完整审查 — 执行全部检查项的综合审查
• 可配置性 — 通过 .reviewrc 文件自定义规则

🚀 快速开始

1. 安装依赖

uv pip install PyGithub anthropic rich typer python-dotenv

2. 配置 GitHub API Token

获取你的 GitHub Personal Access Token（PAT）：

1. 进入 GitHub Settings → Developer settings → Personal access tokens
2. 生成一个具备 repo 权限范围的新 Token
3. 创建 .env 文件：

GITHUB_TOKEN=your_github_pat_here

3. 审查 Pull Request

# 列出待合并的 PR
code-review list-prs owner/repo

# 查看 PR 详细信息
code-review pr-info owner/repo 123

# 查看 PR 中变更的文件
code-review pr-files owner/repo 123

# 使用 Claude AI 分析 PR
code-review review-pr owner/repo 123

📋 命令说明

list-prs

列出指定仓库的 Pull Request。

code-review list-prs owner/repo

选项：

• --state：PR 状态（open、closed、all），默认为 open
• --limit：最多显示的 PR 数量，默认为 10

pr-info

显示某一个 PR 的详细信息。

code-review pr-info owner/repo 123

显示内容包括：

• 标题与描述
• 作者与时间戳
• 文件变更统计
• 标签与合并状态

pr-files

显示 PR 中变更的文件列表。

code-review pr-files owner/repo 123

显示内容包括：

• 变更文件名
• 变更状态（added、modified、deleted）
• 各文件的新增/删除行数

search-prs

按关键词搜索 Pull Request。

code-review search-prs owner/repo --query "bug"

选项：

• --query：搜索关键词（必填）
• --state：PR 状态（open、closed、all），默认为 open
• --limit：最多显示的 PR 数量，默认为 10

repo-info

显示仓库通用信息。

code-review repo-info owner/repo

显示内容包括：

• 仓库名称与描述
• 主要编程语言
• Star 与 Fork 数量
• 未关闭 Issues 与 PR 数量
• 创建与最后更新时间

review-pr

使用 Claude AI 分析 Pull Request。

code-review review-pr owner/repo 123

输出内容包括：

• AI 驱动的代码审查意见
• 代码质量评分（0–100）
• 安全注意事项
• 最佳实践建议
• 具体改进建议

前置要求：

• GITHUB_TOKEN 已配置在 .env 文件中
• ANTHROPIC_API_KEY 已配置在 .env 文件中

security-scan

对 Pull Request 进行安全漏洞扫描。

code-review security-scan owner/repo 123

检测内容包括：

• 泄露的密钥（API keys、tokens、passwords）
• SQL 注入漏洞
• 命令注入漏洞
• 硬编码凭证
• 弱加密算法（MD5、SHA1、RC4、DES）
• 不安全反序列化（如 pickle）

选项：

• --config：配置文件路径

style-check

对 Pull Request 进行代码风格与 linting 检查。

code-review style-check owner/repo 123

检查内容包括：

• 行长度超限
• 命名规范违规
• 导入顺序错误
• 空行缺失或冗余
• 空白字符问题（缩进、尾部空格等）
• 缺失 docstring

选项：

• --config：配置文件路径

full-review

对 Pull Request 执行完整代码审查（LLM + 安全 + 风格）。

code-review full-review owner/repo 123

整合以下三类检查：

• LLM 分析（含代码质量评分）
• 安全扫描
• 风格检查

选项：

• --config：配置文件路径
• --skip-llm：跳过 LLM 分析
• --skip-security：跳过安全扫描
• --skip-style：跳过风格检查

config-init

初始化默认配置文件。

code-review config-init --output .reviewrc

生成一个 .reviewrc 文件，支持自定义以下设置：

• 安全扫描规则
• 风格检查规则
• LLM 分析参数

🔧 技术细节

GitHub API 集成

• 基于 PyGithub 库实现
• 使用 Personal Access Token 认证
• 自动处理 GitHub API 调用频次限制（rate limit）

LLM 集成

• 调用 Claude API 进行代码分析
• 生成智能代码审查评论
• 提供上下文感知的改进建议
• 输出结构化代码质量评分

安全扫描

• 基于静态分析识别常见漏洞
• 采用模式匹配方式进行检测
• 按严重程度（critical/high/medium/low）分类结果
• 支持通过配置文件自定义规则

风格检查

• PEP8 合规性检查
• 命名规范校验（如变量、函数、类名）
• 行长度强制约束（默认 88 字符）
• 导入语句顺序验证
• 空白字符一致性检查（缩进、空行、结尾空格等）

配置管理

• 支持 YAML 或 JSON 格式配置文件
• 支持项目级独立配置
• 可自定义各项检查阈值（如评分下限、漏洞等级过滤）
• 原生支持 .reviewrc 文件加载

📊 使用示例

# 执行完整审查
code-review full-review facebook/react 34567

# 仅执行安全扫描
code-review security-scan owner/repo 123

# 仅执行风格检查
code-review style-check owner/repo 123

# 仅执行 AI 分析
code-review review-pr owner/repo 123

# 列出所有已关闭的 PR（最多 20 条）
code-review list-prs owner/repo --state closed --limit 20

# 初始化配置文件
code-review config-init

🔐 安全说明

• GitHub PAT 存储于 .env 文件中（严禁提交至版本控制）
• 运行过程中不记录、不输出任何敏感信息（如密钥、token）
• 建议在可信网络环境中部署，并启用 IP 白名单策略

🚧 路线图

v0.2.0 — Claude 集成（已完成）

• Claude API 集成
• PR 自动化分析流程
• 智能审查评论生成
• 代码质量评分机制

v0.3.0 — 安全与风格检查（当前版本）

• 安全漏洞扫描模块
• 代码风格与 linting 检查模块
• 自动化修复建议（初步支持）
• 配置文件（.reviewrc）支持
• full-review 命令统一入口

v1.0.0（规划中）

• 多平台支持（GitLab、Bitbucket）
• CI/CD 流水线集成（GitHub Actions、GitLab CI 等）
• 团队协作功能（评审分配、状态追踪、审批流）
• 可视化审查仪表盘（Dashboard）

📄 许可证

MIT

🙋 支持

如遇问题或疑问，请参考以下方式：

• 查阅项目文档
• 在 GitHub 上提交 Issue