ai-review-pipeline

v3.0.0

Published

15 days ago

AI-powered code review & quality pipeline CLI. Review → Auto-fix → Re-review → Test → Report.

0High
0Medium
0Low

conorliu

ai code-review pipeline openai quality cli review auto-fix testing devtools

ai-review-pipeline

AI 驱动的代码质量流水线 CLI —— Review → 测试 → 报告，一条命令搞定。加 --fix 启用自动修复循环。

English | 中文

特性

零依赖 — 无 required dependencies，npx 秒级执行
多 AI 模型 — OpenAI / DeepSeek / Claude / 通义千问 / Gemini / Ollama，自动识别
统一流水线 — 默认 Review + 测试 + 报告（只读），--fix 启用自动修复循环
灵活目标 — 支持文件、文件夹、逗号分隔多目标
--full 完整审查 — 无需 git 改动，直接对完整文件做质量审查
HTML 可视化报告 — 评分 + 问题列表 + 修复建议，可附到 PR
项目配置化 — .ai-pipeline.json 团队共享，clone 即生效
CI 友好 — --json 输出 + exit code，直接接 GitHub Actions / GitLab CI
多语言 — 默认中文，--lang en 切英文
多语言代码支持 — TypeScript / JavaScript / Vue / Python / Go / Rust / Java / Swift / PHP / Kotlin

快速开始

# 1. 配置 API Key（任选一种模型服务，写入 .env.local）

# OpenAI
echo 'OPENAI_API_KEY=sk-xxx' >> .env.local

# DeepSeek（国内推荐，便宜好用）
echo 'DEEPSEEK_API_KEY=sk-xxx' >> .env.local

# Claude
echo 'ANTHROPIC_API_KEY=sk-ant-xxx' >> .env.local

# 通义千问
echo 'DASHSCOPE_API_KEY=sk-xxx' >> .env.local

# Google Gemini
echo 'GEMINI_API_KEY=xxx' >> .env.local

# 本地 Ollama（无需 Key，启动 ollama serve 即可）
echo 'AI_REVIEW_PROVIDER=ollama' >> .env.local

# 2. 默认流水线（Review + 测试 + 报告，不修改代码）
npx ai-review-pipeline

# 3. 自动修复流水线（Review → 修复 → 再审 → 测试 → 报告 → 提交）
npx ai-review-pipeline --fix

安装

# 方式一：项目级安装（推荐团队使用）
npm install -D ai-review-pipeline

# 方式二：全局安装
npm install -g ai-review-pipeline

# 方式三：不安装，npx 直接用
npx ai-review-pipeline

安装后可使用短名 ai-rp 替代 ai-review-pipeline。

流程设计

默认模式（Review + Test + Report）

① AI Review（1 轮，只读不改码）
       │
② AI 测试用例生成（功能/对抗/边界）
       │
③ 生成 HTML 报告
       │
④ Exit（有 🔴 问题 → exit 1 阻断；无 🔴 → exit 0）

`--fix` 模式（Review + Fix Loop + Test + Report）

① AI Review（评分 + 问题列表）
       │
       ├─ 达标 ──→ ④ 测试
       │
       └─ 未达标 → ② AI 自动修复（展示 git diff）
                        │
                        └→ ③ 再次 Review（最多 N 轮）
                                │
                                ├─ 达标 → ④
                                └─ maxRounds 到了 → ④（照样出测试和报告）

④ AI 测试用例生成
       │
⑤ 生成 HTML 报告
       │
⑥ 自动 git commit（仅通过时）
       │
⑦ Exit（通过 → exit 0；未通过 → exit 1 阻断）

完整命令手册

命令

| 命令 | 说明 | |------|------| | ai-rp | 默认：Review + 测试 + 报告（只读） | | ai-rp review | 同上（别名） | | ai-rp fix | 等价 ai-rp --fix（Review + 修复循环 + 测试 + 报告） | | ai-rp test | 独立 AI 测试用例生成 | | ai-rp init | 初始化配置文件 |

核心参数

| 参数 | 说明 | |------|------| | --fix | 启用自动修复模式（循环 review+fix） | | --file <path> | 指定目标文件/文件夹/多目标（逗号分隔） | | --full | 配合 --file 使用，审查完整文件内容（无需 git 改动） | | --lang <zh\|en> | 输出语言（默认中文） | | --help / -h | 显示帮助 | | --version / -v | 显示版本 |

Review 参数

| 参数 | 说明 | |------|------| | --staged | 只 review git staged 改动 | | --branch <base> | 对比分支（如 main） | | --json | JSON 格式输出（CI/CD 用） | | --no-report | 不生成 HTML 报告 |

Fix 参数

| 参数 | 说明 | |------|------| | --threshold <n> | 质量阈值（默认 95，0-100） | | --max-rounds <n> | 最大修复轮次（默认 5） | | --no-commit | 修复后不自动 git commit | | --no-test | 跳过测试用例生成 | | --skip <levels> | 跳过修复级别（如 green,yellow） |

Exit Code

| 场景 | Exit Code | |------|-----------| | Review 通过（无 red 且分数达标） | 0 | | Review 未通过（有 red 问题） | 1 | | --fix 通过 | 0 | | --fix maxRounds 用完仍未通过 | 1（阻断 CI/Hook，但报告照出） |

`--file` vs `--full` 区别

# 只 review 该文件的 git 改动部分
ai-rp --file src/utils.ts

# review 完整文件内容（不管有没有 git 改动）
ai-rp --file src/utils.ts --full

# 不带 --file：review 所有 staged / HEAD 的 git 变动
ai-rp

`test` — AI 测试用例生成

为指定文件生成三类测试用例。

| 参数 | 说明 | |------|------| | --file <path> | 指定文件 | | --staged | 为 staged 文件生成测试 |

ai-rp test --file src/utils.ts
ai-rp test --staged

生成三类用例

| 类型 | 说明 | |------|------| | ✅ 功能用例 | 正常业务流程：CRUD、状态流转、组件渲染 | | ⚔️ 对抗用例 | 异常输入：XSS、注入、越权、重复提交 | | 🔲 边界用例 | 边界条件：空值、0、极大值、超时 |

`init` — 初始化配置

ai-rp init    # 在项目根目录生成 .ai-pipeline.json

支持的 AI 模型

| Provider | 默认模型 | 环境变量 | 说明 | |----------|---------|---------|------| | OpenAI | gpt-4o-mini | OPENAI_API_KEY | 默认 Provider | | DeepSeek | deepseek-chat | DEEPSEEK_API_KEY | 国内推荐，性价比高 | | Claude | claude-sonnet-4-20250514 | ANTHROPIC_API_KEY | 代码能力强 | | 通义千问 | qwen-plus | DASHSCOPE_API_KEY | 阿里云 | | Gemini | gemini-2.0-flash | GEMINI_API_KEY | Google | | Ollama | qwen2.5-coder | 无需 Key | 本地部署，隐私安全 | | 自定义 | — | AI_REVIEW_API_KEY | 任何 OpenAI 兼容 API |

自动识别

工具会自动识别 Provider：

sk-ant- 开头的 Key → Claude
DEEPSEEK_API_KEY → DeepSeek
ANTHROPIC_API_KEY → Claude
DASHSCOPE_API_KEY → 通义千问
GEMINI_API_KEY → Gemini

也可手动指定：

# .env.local
AI_REVIEW_PROVIDER=deepseek
DEEPSEEK_API_KEY=sk-xxx

# 或自定义兼容 API
AI_REVIEW_PROVIDER=custom
AI_REVIEW_API_KEY=sk-xxx
AI_REVIEW_BASE_URL=https://your-api.com/v1
AI_REVIEW_MODEL=your-model

Ollama 本地部署

# 1. 安装 Ollama: https://ollama.com
# 2. 拉取模型
ollama pull qwen2.5-coder

# 3. 配置
echo 'AI_REVIEW_PROVIDER=ollama' >> .env.local

# 4. 使用
npx ai-review-pipeline --file src/utils.ts --full

配置文件

运行 ai-rp init 生成 .ai-pipeline.json，提交到 git 团队共享：

{
  "review": {
    "threshold": 95,           // 质量阈值（0-100）
    "maxRounds": 5,            // --fix 模式最大修复轮数
    "model": "",               // 指定模型（默认 gpt-4o-mini）
    "maxDiffLines": 1500,      // diff 超过此行数自动截断
    "customRules": [           // 项目自定义审查规则
      "禁止使用 any 类型",
      "API Key / Secret 不得硬编码"
    ]
  },
  "fix": {
    "safetyMinRatio": 0.5      // 修复后文件不能低于原文件 50%（防截断）
  },
  "test": {
    "stack": "auto",           // 自动检测技术栈，或手动指定
    "maxCases": 8              // 最大测试用例数
  },
  "report": {
    "outputDir": ".ai-reports",
    "open": true               // 生成后自动打开报告
  }
}

评分标准

| 级别 | 含义 | 扣分 | |------|------|------| | 🔴 必修 | 逻辑错误、安全漏洞、数据风险 | -15/个 | | 🟡 建议 | 边界未处理、类型问题、错误处理缺失 | -5/个 | | 🟢 优化 | 代码重复、命名不清、性能隐患 | -2/个 |

环境变量

| 变量 | 说明 | |------|------| | OPENAI_API_KEY | OpenAI API Key | | DEEPSEEK_API_KEY | DeepSeek API Key | | ANTHROPIC_API_KEY | Anthropic Claude API Key | | DASHSCOPE_API_KEY | 阿里通义千问 API Key | | GEMINI_API_KEY | Google Gemini API Key | | AI_REVIEW_API_KEY | 通用 Key（优先级最高，覆盖以上所有） | | AI_REVIEW_PROVIDER | 手动指定 Provider（openai/deepseek/claude/qwen/gemini/ollama/custom） | | AI_REVIEW_BASE_URL | 自定义 API 地址 | | AI_REVIEW_MODEL | 覆盖默认模型 | | HTTPS_PROXY | HTTP 代理（需安装 https-proxy-agent） |

支持 .env.local 和 .env 文件自动加载。只需配置对应 Provider 的 Key，工具自动识别。

CI/CD 集成

GitHub Actions

- name: AI Code Review
  run: npx ai-review-pipeline --json
  env:
    OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}

GitLab CI

ai-review:
  script:
    - npx ai-review-pipeline --json
  variables:
    OPENAI_API_KEY: $OPENAI_API_KEY
  allow_failure: false

Git Hook（lefthook）

# lefthook.yml
pre-push:
  commands:
    ai-review:
      run: npx ai-rp --fix --max-rounds 3

在 package.json 中配置 scripts

{
  "scripts": {
    "review": "ai-rp",
    "review:full": "ai-rp --file src/ --full",
    "review:fix": "ai-rp --fix",
    "review:fix:full": "ai-rp --fix --file src/ --full",
    "test:ai": "ai-rp test --staged"
  }
}

常用命令速查

# ── 默认模式（Review + 测试 + 报告，只读） ──
ai-rp                                          # review git 变动
ai-rp --file src/a.vue                         # 指定文件
ai-rp --file src/a.vue --full                  # review 完整文件
ai-rp --file src/views --full                  # review 整个文件夹
ai-rp --branch main                            # 对比分支
ai-rp --staged --json                          # CI 模式

# ── 修复模式（Review + 自动修复 + 测试 + 报告） ──
ai-rp --fix                                    # 完整修复流水线
ai-rp fix                                      # 同上（命令别名）
ai-rp --fix --file src/a.vue --full            # 修复指定文件
ai-rp fix --threshold 90 --max-rounds 3        # 自定义参数
ai-rp fix --no-commit --skip green             # 不提交，只修红黄

# ── 独立测试 ──
ai-rp test --file src/utils.ts                 # 生成测试
ai-rp test --staged                            # staged 文件测试

# ── 初始化 ──
ai-rp init                                     # 生成配置文件

English

What is this?

An AI-powered code quality CLI tool. Default: Review + Test + Report in one command. Add --fix for auto-fix loop. Supports OpenAI, DeepSeek, Claude, Qwen, Gemini, Ollama and any OpenAI-compatible API.

Quick Start

# Any ONE of these (tool auto-detects provider)
echo 'OPENAI_API_KEY=sk-xxx' >> .env.local        # OpenAI
echo 'DEEPSEEK_API_KEY=sk-xxx' >> .env.local       # DeepSeek (cheap & good)
echo 'ANTHROPIC_API_KEY=sk-ant-xxx' >> .env.local   # Claude
echo 'AI_REVIEW_PROVIDER=ollama' >> .env.local      # Local Ollama (no key)

npx ai-review-pipeline                                # Review + Test + Report
npx ai-review-pipeline --fix                          # Auto-fix pipeline
npx ai-review-pipeline --file src/a.vue --full        # Review full file

Commands

| Command | Description | |---------|-------------| | ai-rp | Default: Review + Test + Report (read-only) | | ai-rp review | Same as default (alias) | | ai-rp --fix / ai-rp fix | Review + Auto-fix loop + Test + Report | | ai-rp test --file <path> | Standalone test case generation | | ai-rp init | Create .ai-pipeline.json config |

Core Options

| Option | Description | |--------|-------------| | --fix | Enable auto-fix mode (review+fix loop) | | --file <path> | Target file/folder/multi-path (comma-separated) | | --full | Review full file content, use with --file | | --json | JSON output for CI | | --lang <zh\|en> | Output language (default: zh) |

Exit Codes

| Scenario | Code | |----------|------| | Review passed (no red issues) | 0 | | Review failed (red issues found) | 1 | | --fix passed | 0 | | --fix maxRounds exhausted, still failing | 1 (blocks CI, but report is still generated) |

Supported Providers

| Provider | Default Model | Env Var | |----------|--------------|---------| | OpenAI | gpt-4o-mini | OPENAI_API_KEY | | DeepSeek | deepseek-chat | DEEPSEEK_API_KEY | | Claude | claude-sonnet-4-20250514 | ANTHROPIC_API_KEY | | Qwen | qwen-plus | DASHSCOPE_API_KEY | | Gemini | gemini-2.0-flash | GEMINI_API_KEY | | Ollama | qwen2.5-coder | No key needed | | Custom | — | AI_REVIEW_API_KEY + AI_REVIEW_BASE_URL |

Install

npm install -D ai-review-pipeline   # Project-level
npm install -g ai-review-pipeline   # Global
npx ai-review-pipeline              # No install needed

Use --lang en for English output.

License

MIT

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

ai-review-pipeline

特性

快速开始

安装

流程设计

默认模式（Review + Test + Report）

--fix 模式（Review + Fix Loop + Test + Report）

完整命令手册

命令

核心参数

Review 参数

Fix 参数

Exit Code

--file vs --full 区别

test — AI 测试用例生成

生成三类用例

init — 初始化配置

支持的 AI 模型

自动识别

Ollama 本地部署

配置文件

评分标准

环境变量

CI/CD 集成

GitHub Actions

GitLab CI

Git Hook（lefthook）

在 package.json 中配置 scripts

常用命令速查

English

What is this?

Quick Start

Commands

Core Options

Exit Codes

Supported Providers

Install

License

`--fix` 模式（Review + Fix Loop + Test + Report）

`--file` vs `--full` 区别

`test` — AI 测试用例生成

`init` — 初始化配置