QUICKSTART · 安装 → 配 LLM → 评审
十分钟，跑起
第一场评审。
三种安装方式任选其一，配置一个 LLM，然后对本地分支发起第一场评审。
INSTALL · 三选一
装一个静态二进制。
curl -fsSL https://raw.githubusercontent.com/Liewzheng/ReviewEngine/main/install.sh | bash
自动检测平台、解析最新稳定版、校验 sha256，落位 ~/.local/bin 并创建 reng 符号链接。若该目录不在 PATH，请追加 export PATH="$HOME/.local/bin:$PATH"。
brew install liewzheng/tap/review-engine
docker pull ghcr.io/liewzheng/review-engine:v0.9.12 # 或 :latest 跟随最新版 curl -fsSL -o docker-compose.yml https://raw.githubusercontent.com/Liewzheng/ReviewEngine/main/deploy/standalone-compose.yml echo "REVIEW_BOOTSTRAP_KEY=$(openssl rand -hex 16)" >> .env # 非 loopback 访问需要一次性引导 key docker compose up -d # 打开 http://<宿主IP>:18080 → 引导界面设 API token → Configuration 填 GitLab/LLM
git clone https://github.com/Liewzheng/ReviewEngine.git
cd ReviewEngine && cp .env.example .env # 填 REVIEW_API_TOKEN 等；REVIEW_ENGINE_VERSION=v0.9.12
docker compose build review-engine && docker compose up -d
LLM CONFIG · 任选其一
接一个 LLM 提供商。
支持 OpenAI、Anthropic、DeepSeek，以及任意 OpenAI 兼容端点。两种配置方式：环境变量 LLM_CONFIG，或 reng init 生成 .code-audit-config.toml 后编辑 [[llm]] 段。
export LLM_CONFIG='[{"provider":"openai","model":"deepseek-chat","api_key":"sk-your-key","api_base":"https://api.deepseek.com/v1","max_tokens":4096,"temperature":0.3}]'
reng init # 生成 .code-audit-config.toml，再编辑 [[llm]] 段
api_key，不要把真实密钥提交进版本库。
FIRST REVIEW
跑第一条评审命令。
# 评审当前分支相对 main 的改动
reng review --local-path . --base main
输出一份 Markdown 报告：加权总分、风险等级、每位专家的 finding。同一份二进制里， review 与 audit 分工明确。
COMMANDS
小命令集，各司其职。
| 命令 | 用途 |
|---|---|
| review | 对 MR / PR / 本地 diff 跑一轮 CodeReview Board 评审 |
| audit | 整仓健康审计（repo-review 的别名），适合定期巡检 |
| describe | 由 diff 生成摘要或 MR/PR 描述 |
| improve | 针对 diff 给出具体的代码改进建议 |
| ask | 就 diff 提问 |
| update_changelog | 依据近期提交生成或更新 changelog |
| serve | 启动 REST API 与 webhook 服务 |
| upgrade | 自升级（--check / --yes / --rollback） |
| validate | 校验 .code-audit-config.toml |
| init | 为新项目生成初始配置 |
| default | 打印内置默认配置 |
| generate-token | 为 reng serve 生成随机 API token |
INTEGRATIONS · 多个入口
嵌进现有的工作流。
评审 MR 并把报告回贴讨论区： reng review --mr-url https://gitlab.com/owner/repo/-/merge_requests/42；配置 webhook 后，MR 评论可直接触发 /review。
评审 PR 并可选回写评论： reng review --mr-url https://github.com/owner/repo/pull/123；token 只需读权限即可拉取 diff，加 --publish 才写回讨论。
评审工作区、暂存区或 commit 区间，无需远程： reng review --local-path . --staged 或 --since HEAD~3 --until HEAD。
作为 GitLab CI、GitHub Actions 或任意流水线的一步运行，输出 Markdown 或 JSON（ --format markdown）。
reng serve 启动服务后， POST /api/v1/reviews 触发评审，Web UI 在 http://localhost:18080。
reng generate-token 生成随机 token；请求带 Authorization: Bearer <token> 或 X-API-Key: <token>。鉴权使用恒定时间比较；绑定非回环地址时强制要求 token，否则拒绝启动。前端首次访问会提示输入 token（保存于浏览器 localStorage，key 为 review_engine_api_token），之后每次 /api/v1/* 请求自动附带。
GITLAB_TOKEN / GITHUB_TOKEN 环境变量传 token，避免从命令行参数泄漏进 shell 历史或进程列表。