eggai-tech/qualops
GitHub: eggai-tech/qualops
一款基于 Claude AI 的自动化 PR 代码审查工具，支持跨文件语义分析和 CI/CD 集成，帮助团队在代码合并前发现质量与安全问题。
Stars: 2 | Forks: 1
# @eggai/qualops
为你的 PR 提供基于 AI 的代码审查。
## 功能
- **自动化 PR 审查** - AI 分析变更文件并将结果作为 PR 评论发布
- **两种审查模式** - 逐文件模式（速度快，处理量大）或 Agentic 模式（使用 Claude Agent SDK 进行跨文件分析）
- **GitHub Checks 集成** - 在 "Files changed" 选项卡中直接显示内联注释
- **多阶段流水线** - 分析 → 审查 → 修复 → 报告 → 评估
- **感知框架** - 检测 Angular、React、Node.js 并加载相关上下文
- **可定制** - 可配置严重性阈值、提示词、AI 提供商和自定义 Agent
- **适配 CI/CD** - 支持 GitHub Actions 和 GitLab CI
## 快速开始
### GitHub Actions（推荐）
添加到 `.github/workflows/qualops.yml`：
```
name: QualOps Review
on:
pull_request:
branches: [main]
permissions:
contents: read
pull-requests: write
checks: write
jobs:
review:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: eggai-tech/qualops@stable
with:
anthropic-api-key: ${{ secrets.ANTHROPIC_API_KEY }}
github-token: ${{ secrets.GITHUB_TOKEN }}
```
### 命令行使用
```
# 安装
npm install -g @eggai/qualops
# 对已更改的文件运行
qualops --base=main --head=HEAD
# 对指定文件运行
qualops --files="src/**/*.ts"
```
## AI 辅助设置
使用 Claude Code 交互式地为你的项目配置 QualOps：
```
npx @eggai/qualops init-claude
```
然后在 Claude Code 中使用 `/setup-qualops`。AI 将根据你的项目框架和需求指导你完成配置。
## 配置
在你的项目中创建 `.qualops/.qualopsrc.json`：
### 逐文件模式（默认）
```
{
"ai": {
"reviewStage": {
"provider": "anthropic",
"model": "claude-sonnet-4-20250514"
}
},
"review": {
"minConfidence": 4
},
"github": {
"postComments": true,
"maxInlineComments": 50
}
}
```
### Agentic 模式（跨文件分析）
```
{
"jobs": {
"security-audit": {
"mode": "agentic",
"agentic": {
"maxTurns": 20,
"contextMode": "auto",
"enabledSubagents": ["security-analyzer", "dependency-tracer"],
"systemPrompt": "Focus on security vulnerabilities and injection risks"
}
}
}
}
```
完整配置参考请参见 [qualops-llm.txt](./qualops-llm.txt)。
## 环境变量
```
# Anthropic (推荐)
ANTHROPIC_API_KEY=sk-ant-...
# 或 AWS Bedrock
AWS_REGION=us-east-1
AWS_ACCESS_KEY_ID=...
AWS_SECRET_ACCESS_KEY=...
```
## 流水线阶段
| 阶段 | 描述 |
|-------|-------------|
| **analyze** | 检测 git refs 之间的变更文件 |
| **review** | AI 结合特定框架上下文审查代码 |
| **fix** | 为高置信度问题生成修复建议 |
| **report** | 创建包含审查结果的 HTML 报告 |
| **judge** | 根据阈值评估质量 |
## 审查模式
| 模式 | 最适用场景 | 工作原理 |
|------|----------|--------------|
| **file-by-file** | 处理量大、快速扫描 | 使用配置的审查规则独立审查每个文件 |
| **agentic** | 复杂分析、跨文件问题 | Agent 使用工具探索代码库并追踪依赖关系 |
为 Agentic 模式内置的子 Agent：
- `dependency-tracer` - 跨文件导入分析
- `breaking-change-detector` - API 兼容性检查
- `security-analyzer` - 漏洞检测
- `pattern-validator` - 代码库模式一致性检查
## 命令行选项
```
qualops [options]
Options:
-b, --base Base branch for comparison (default: main)
-h, --head Head ref for comparison (default: HEAD)
-f, --files Specific files to analyze (glob patterns)
-s, --stages Stages to run (default: all)
-n, --name Session name for reports
--fix-apply Apply fixes automatically
--skip-cache Force fresh analysis
```
## 自定义提示词
在你的项目中创建自定义审查提示词：
```
prompts/
review-system-message.md # Core review instructions
validation.md # False positive filtering rules
deduplication.md # Duplicate detection rules
```
在 `.qualopsrc.json` 中引用：
```
{
"review": {
"prompt": "prompts/review-system-message.md"
}
}
```
## 许可证
MIT
标签：AI代码审查, Angular, Anthropic, CI/CD工具, CIS基准, Claude Agent SDK, CLI, DevSecOps, GitHub Actions, GitHub集成, GitLab CI, GNU通用公共许可证, Grype, MITM代理, Node.js, React, SAST, SOC Prime, Syscalls, WiFi技术, 上游代理, 人工智能, 多阶段审查流水线, 开发工具, 框架感知, 用户模式Hook绕过, 盲注攻击, 研发效能, 自动化PR审查, 自动化攻击, 自动笔记, 跨文件分析, 错误基检测, 静态代码分析