# x-review **Repository Path**: openkylin/x-review ## Basic Information - **Project Name**: x-review - **Description**: No description available - **Primary Language**: Unknown - **License**: Apache-2.0 - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2026-11-12 - **Last Updated**: 2026-11-17 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # xreview ![python](https://img.shields.io/badge/python-3.13%2B-blue) ![status](https://img.shields.io/badge/status-self--hosted%20%7C%20in%20production-green) 面向 [openkylin/x-kernel](https://gitee.com/openkylin/x-kernel) 的自托管 AI 代码评审:对每个 Gitee PR 做多阶段评审,每条意见经独立核验,随 PR 的新提交跟进复审,结果可回放、可统计、可写回。 > **English summary.** xreview is a self-hosted AI code review service for pull requests on > openkylin/x-kernel (Gitee). A webhook triggers a multi-stage pipeline (screening, cluster analysis, rule and > documentation review, independent verification of every finding, translation); follow-up rounds carry and > re-check earlier findings; authors can dispute them. Results are stored in one SQLite file, replayable, and > can be written back to the PR. The docs are in Chinese with English identifiers.

PR 复审链
PR 复审链:每轮的结论演进、意见台账、各轮耗时与 token、费用构成(看完整页面)。

## 截图 点击缩略图看大图。
流水线运行图:节点状态、会话、token 占比与模型
流水线运行图:节点状态、会话、token 占比与模型
候选意见与独立核验:触发条件、路径、反证与结论
候选意见与独立核验:触发条件、路径、反证与结论
公开 PR 页(无需登录):结论、发起评审、作者与 maintainer 的回应
公开 PR 页(无需登录):结论、发起评审、作者与 maintainer 的回应
意见台账:跨轮跟踪每条意见,筛选与批量改判
意见台账:跨轮跟踪每条意见,筛选与批量改判
运行 → 看板:费用、吞吐、缓存命中与质量
运行 → 看板:费用、吞吐、缓存命中与质量
窄屏布局(390 宽)
窄屏布局(390 宽)
## 功能 - **多阶段评审流水线**:筛选 → 簇分析 → 规则审查 → 独立核验 → 文档 / 豁免 / PR 描述审查 → 译文,各节点用量与模型在面板可见 - **每条意见独立核验**:核验会话沿证据链证实或驳回候选,驳回的留在「已排除」,不进结论 - **跟进复审**:新提交只评增量;上一轮的意见带入下一轮并复核(已修复 / 仍在 / 过时),意见链跨轮保留 - **评审规则来自被评审仓库**:仓库里的规则文件与评审视角随 PR 的 head 加载,规则会话按命中的代码逐条审 - **作者回应与 maintainer 改判**:作者可对意见提出异议(经一次争议核验才生效)、认可但不修;maintainer 可改判;全部记入台账与活动日志 - **参考资料**:Linux 主线全量历史(回合补丁比对)与依赖 crate 源码,评审会话可只读查阅 - **受控写回 Gitee**:每个 PR 一条原地更新的汇总评论;总闸、发布前批准、发布臂三道开关;可选「审查通过」与 PR 描述更新 - **完整可观测**:每轮的事件流与会话可逐步回放;费用、token、缓存命中、延迟的看板与只读统计 API - **记忆与夜间整理**:夜间统计评审结果,提出规则 / 反例 / 信号的改进提议,经人工批准才生效 - **回放评估**:用固定的标注集重放沿用与复核逻辑,改提示词前先量化影响,不花额度 ## 工作原理 ```mermaid flowchart LR W[Gitee webhook / 面板 / 兜底轮询] --> I[评审请求
head 幂等] I --> S[筛选
定计划] S --> C[簇分析] S --> R[规则审查] S --> D[文档 / 豁免 / PR 描述审查] C --> M[合并候选] R --> M M --> V[独立核验] V --> T[译文] D --> T T --> P[(SQLite
结果 + 事件流)] P --> G[面板 / 公开页 / API] P --> B[写回 Gitee
汇总评论] ``` 一个 PR 的新 head 到达后,服务端为本轮建独占 worktree,按计划并行起 Pi 侧车会话(只读、清空环境)。 候选意见合并后逐条核验,结论与意见台账、事件流一起落进 SQLite,再按开关写回 Gitee。服务端不替模型 判断对错,判断全在提示词与核验会话里。深入见 [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) 与 [docs/design-principles.md](docs/design-principles.md)。 ## 快速开始 需要 Python 3.13+、[uv](https://docs.astral.sh/uv/)、Node.js(前端与 Pi 侧车)、git。 ```bash uv sync (cd web && npm ci && npm run build) PORT=8300 XREVIEW_ADMIN_PASSWORD=<密码> XREVIEW_WEBHOOK_SECRET=<密钥> \ uv run python src/main.py ``` 打开 `http://127.0.0.1:8300`,用管理密码登录。然后: 1. 面板「配置 → 全局设置 → 凭据与密钥」保存 Gitee 令牌,配置模型(Pi 模型与密钥) 2. 在 Gitee 仓库加 webhook 指向 `/webhook/gitee`,Token 填 `XREVIEW_WEBHOOK_SECRET` 3. 在 PR 链页点「开始评审」,或等 webhook 触发 生产部署(容器镜像、`.env`、Linux 参考树、升级)见 [docs/deploy.md](docs/deploy.md)。 ## 配置 多数设置在面板「配置」里修改、即时生效;环境变量只提供默认值。最常用的: | 变量 | 默认 | 说明 | |---|---|---| | `XREVIEW_REVIEW_REPO` | `openkylin/x-kernel` | 评审的目标仓库 | | `XREVIEW_DB` | `data/xreview.db` | SQLite 文件,唯一需要备份的状态 | | `XREVIEW_ADMIN_PASSWORD` | 无 | 面板登录密码 | | `XREVIEW_WEBHOOK_SECRET` | 无 | webhook 鉴权 | | `XREVIEW_WRITEBACK` | `0` | 写回 Gitee 的总闸默认值 | | `XREVIEW_PUBLIC_URL` | 空 | 公开评审页的对外基址 | | `XREVIEW_LINUX_SOURCE` | `data/linux` | Linux 参考树位置 | | `HOST` / `PORT` | `127.0.0.1` / `8300` | 监听地址 | 完整清单见 [docs/configuration.md](docs/configuration.md)。 ## 使用 - **触发**:Gitee webhook(PR 新建 / 更新 / 重开)、面板「开始评审」、`POST /api/v1/prs/{n}/review`;webhook 漏掉的由兜底轮询补发 - **看结果**:工作台(PR 一览)→ PR 链页 → 评审详情(流水线运行图、候选与核验、文档问题、回放);无需登录的公开 PR 页给作者看 - **作者操作**:在公开页或 API 上发起评审、对意见说明理由、认可但不修;maintainer 在意见台账里改判 面板导航、触发细节、写回与审批、运维页的完整说明见 [docs/usage.md](docs/usage.md)。 ## API 只读评审 API 在 `/api/v1`(评审结果、PR 状态、作者操作),统计 API 供 CI 看板抓取。契约见 [docs/api-v1.md](docs/api-v1.md) 与 [docs/stats-api.md](docs/stats-api.md)。 ## 开发 ```bash scripts/check.sh # 提交 / 部署前:类型检查、vitest、sidecar、mypy、ruff、pytest、前端构建(约 35 秒) scripts/eval.sh # 改动沿用 / 复核逻辑前:重放评估,不花额度(docs/eval.md) ``` ``` src/server/ HTTP 层:路由、webhook、调度、写回与审批 src/review/ 评审领域:流水线节点、核验、规则、台账、写回渲染 src/store/ SQLite 持久层(唯一事实源) src/backend/ opencode 封装(编排者引擎) src/maintenance/ 维护任务与夜间整理 src/stats/ 统计与价格 sidecar/ Pi 侧车(Node):模型会话 web/ React 面板(Vite + Tailwind) docs/ 文档(索引见 docs/README.md) ``` 分层规则(server → review → backend 单向)由 `tests/test_layering.py` 检查。贡献与代理协作约定见 [AGENTS.md](AGENTS.md),领域词汇见 [CONTEXT.md](CONTEXT.md)。 ## 状态 在生产使用:评审 openkylin/x-kernel 的 PR,Gitee 写回已开。外部引擎 x-review-ng 已退役,代码保留 ([ADR-0001](docs/adr/0001-strangle-x-review-ng-through-an-external-engine.md))。变更与设计决定见 [docs/adr/](docs/adr/)。 ## 许可 仓库尚未声明开源许可证;使用与再分发请先联系 maintainer。 ## 致谢 承接 x-review-ng 的设计与评审方法论;模型会话运行在 Pi coding agent(npm 包 `@earendil-works/pi-coding-agent`) 上,编排者引擎使用 [opencode](https://opencode.ai)。 ## 许可证 本项目以 [Apache License 2.0](LICENSE) 发布。