best-review 0.5.6 → 0.5.8

package/README.md

@@ -7,10 +7,10 @@
 - 本地审查未提交变更、提交范围、指定文件或完整文件内容。
 - GitLab MR 远程审查，并把问题回评到 MR 行内 discussion。
 - 内置 `general`、`bug-hunter`、`security-scan`、`performance-check`、`consistency-check`、`validation` Agent。
-- 支持项目规则、全局规则、共享 `extends` 规则包和项目级 `skills/` 审查增强。
+- 支持用户级规则、共享 `extends` 规则包和项目级 `skills/` 审查增强。
 - 默认执行置信度过滤、去重、validation 复核，减少泛泛建议和误报。
 - 支持显式自动修复严重风险，先生成 unified diff，并通过 `git apply --check` 后才写入。
-- 生成本地 JSON 报告，可选上报到内部效能统计系统。
+- 生成本地 JSON 报告；本地 `review` 可显式开启历史归档，`review-mr` 只回评 MR。
 
 ## 快速开始
 
@@ -56,6 +56,11 @@ best-review review --base main
 best-review review --branch .
 best-review review --branch feature/login --base main
 
+# 审查单个 commit 或连续多个 commit
+best-review review --commit HEAD
+best-review review --commit abc1234
+best-review review --commit-range HEAD~3..HEAD
+
 # 只审查指定文件的 Git 变更
 best-review review --files src/auth.ts
 best-review review --files src/auth.ts,src/user.ts --base main
@@ -90,7 +95,7 @@ best-review review --log-steps
 # 显式自动修复严重风险
 best-review review --fix-critical
 best-review review --fix-severity critical,high --fix-dry-run
-best-review review --fix-critical --fix-max-issues 3 --fix-patch-file .best-review/fix.patch
+best-review review --fix-critical --fix-max-issues 3 --fix-patch-file ~/.best-review/fix.patch
 
 # GitLab MR 远程审查
 GITLAB_TOKEN=<token> best-review review-mr https://gitlab.example.com/group/project/-/merge_requests/123
@@ -207,7 +212,6 @@ POST <llm.baseUrl>/chat/completions
     "domain-review": { "enabled": true }
   },
   "reporting": {
-    "localDir": ".best-review/reports",
     "enabled": false,
     "includeDiffs": false,
     "failOnError": false
@@ -283,6 +287,8 @@ flowchart LR
 关键行为：
 
 - `filterReviewableDiffs()` 默认跳过二进制、生成物、文档和命中排除规则的文件。
+- 本地 review 支持未提交变更、`--base/--head`、`--branch`、`--commit`、`--commit-range`、`--files` 和 `--full`；互斥或不完整的参数组合会在进入 pipeline 前直接拒绝。
+- `--commit <ref>` 等价于比较 `<ref>^` 和 `<ref>`；`--commit-range <oldest>..<newest>` 会包含两端 commit，要求 `<oldest>` 是 `<newest>` 的祖先。
 - 本地 review 会补充变更文件全文和一层相对依赖上下文，避免模型只看 diff。
 - diff 输入默认压缩，只保留 hunk 行号、变更行和少量上下文。
 - 默认是多 Agent 独立审查；设置 `BEST_REVIEW_MULTI_AGENT=false` 可把多个专业 Agent 合并成一次快速审查。
@@ -309,7 +315,6 @@ flowchart LR
 自定义规则可以放在：
 
 ```text
-.best-review/rules/*.md
 ~/.best-review/rules/*.md
 ```
 
@@ -332,14 +337,13 @@ agent: security-scan
 自定义 Agent 可以放在：
 
 ```text
-.best-review/agents/*.md
 ~/.best-review/agents/*.md
 ```
 
 规则和 Agent 加载优先级：
 
 ```text
-defaults < extends < user < project
+defaults < extends < user
 ```
 
 共享规则包：
@@ -389,7 +393,7 @@ best-review review --fix-critical
 best-review review --fix-severity critical,high --fix-dry-run
 
 # 限制修复数量，并保存补丁
-best-review review --fix-critical --fix-max-issues 3 --fix-patch-file .best-review/fix.patch
+best-review review --fix-critical --fix-max-issues 3 --fix-patch-file ~/.best-review/fix.patch
 ```
 
 安全约束：
@@ -460,40 +464,52 @@ best-review review --base origin/main --json
 
 ## Reporting
 
-每次 review 都会尽量生成本地报告，默认目录：
+每次 `best-review review` 都会保存一份本地 JSON 报告，默认目录：
 
 ```text
-.best-review/reports/
+~/.best-review/reports/
 ```
 
-报告包含仓库信息、base/head、模型、Agent 结果、阶段结果、风险结论、质量评分、issue audit trail、最终问题和 diff 摘要。默认不保存完整 diff。
+报告包含仓库信息、模型、风险结论、质量评分、最终问题和 diff 摘要。默认不保存完整 diff。
+
+如果想把本地 review 结果归档到 Git 仓库，开启历史归档并配置自己的仓库地址：
 
-配置上报：
+```bash
+BEST_REVIEW_HISTORY=true
+BEST_REVIEW_HISTORY_REMOTE=git@git.example.com:team/review-history.git
+BEST_REVIEW_HISTORY_BRANCH=review-log
+```
+
+上传后的文件会按项目和 GitLab 用户分组：
+
+```text
+projects/<group>/<project>/<gitlab-user>/<timestamp>-<run-id>.json
+```
+
+历史归档只上传 `best-review review` 的本地结果；`best-review review-mr` 不会上传到历史仓库。
+
+上传成功后，本地 JSON 会被删除，避免长期占用磁盘；上传失败时会保留本地文件，方便排查。
+
+也可以通过用户级 `~/.best-review/config.json` 配置：
 
 ```json
 {
   "reporting": {
-    "localDir": ".best-review/reports",
-    "enabled": true,
-    "url": "https://efficiency.example.com/api/ai-review/usages",
-    "token": "replace-with-token",
-    "includeDiffs": false,
-    "failOnError": false
+    "historyEnabled": true,
+    "historyRemote": "git@git.example.com:team/review-history.git",
+    "historyBranch": "review-log"
   }
 }
 ```
 
-环境变量覆盖：
+如果还需要把报告 POST 到内部效能系统，再配置 Reporting URL：
 
 ```bash
-BEST_REVIEW_REPORT_DIR=.best-review/reports
 BEST_REVIEW_REPORT_URL=https://efficiency.example.com/api/ai-review/usages
 BEST_REVIEW_REPORT_TOKEN=replace-with-token
-BEST_REVIEW_REPORT_INCLUDE_DIFFS=false
-BEST_REVIEW_REPORT_FAIL_ON_ERROR=false
 ```
 
-上报失败默认不阻断 review；如果 CI 要求上报失败即失败，设置 `failOnError: true` 或 `BEST_REVIEW_REPORT_FAIL_ON_ERROR=true`。
+默认上报失败不会阻断 review。CI 里想让上报失败直接失败，可以设置 `BEST_REVIEW_REPORT_FAIL_ON_ERROR=true`。
 
 ## 审查质量评测
 
@@ -556,8 +572,8 @@ BEST_REVIEW_DISABLE_SMART_ROUTING=true best-review review
 默认缓存目录：
 
 ```text
-.best-review/cache/review
-.best-review/cache/validation
+~/.best-review/cache/review
+~/.best-review/cache/validation
 ```
 
 缓存 key 包含模型、base URL、temperature、prompt、规则和 diff 输入。相同输入会复用成功结果，并在终端/JSON 中统计缓存命中和节省 token。