Orca-Code-Review/rules
AnKaifeng 5dae0d66b5
feat: review locally with your own agent as the engine (#51)
* feat: review locally with your own agent as the engine

`review plan` prints everything a reviewer needs — files in scope with the
reasons for exclusions, per-language checklists, the P0-P3 rubric, the output
shape, the project's conventions — and `review submit` verifies positions,
dedupes, applies the gate and reports, in text, markdown or JSON. Nothing in
this path talks to OrcaRouter or needs a key; the thinking is the agent's.

- `--pr <n>` reviews a pull request by number without checking it out
- `--lang` follows the user's language through the plan, findings and report
- file selection is Open Code Review's own rules, vendored as data under
  vendor/open-code-review (Apache-2.0) with a JS port of its matcher — no
  `ocr` binary to install
- `.orcacode-review.json` holds a repo's block_on / language / exclude / rules;
  `review config` shows what applies and `review config init` writes it; the
  plan offers to create it once, after the first review
- exit 0 for a review that ran; `--fail-on-block` for hooks that want a 1;
  2 for an unusable result is never suppressed

Skills are renamed to orca-review and orca-review-action; installing the new
names retires our old ones beside them. The installer now asks how you will
use it — local, Action, or both — and `--mode` answers that for scripts.
rules/output-shape.md shows a wrong/right title pair, because a real PR got a
sixteen-word imperative title with a semicolon.

* docs: three demos — install, Action setup, local review — and a README that shows each

Recorded with vhs against a throwaway repo (docs/tapes/README.md says how).
Every prompt takes its recommended answer. The old combined demo is retired;
the two features get their own GIF, with the 3x-speed mp4 linked beside each.

* docs: README talks to the person, not the terminal

Drop the '3x · mp4' captions under the GIFs, and the menus of npx subcommands
and flags. The product is the two skills; you tell your agent what to review
and it drives the CLI. The one command that stays is the install. Flags and
the review contract are documented where a scripter looks, in --help and
skills/orca-review/references/contract.md.

* release: 2.1.0

package.json, plugin.json and marketplace.json move together, as the publish
workflow insists. The tarball check now also names the local-review files —
harness, selection, config, the vendored rules, both skills — so a files:
regression in package.json fails the release instead of shipping a plan with
no rubric.
History 2026-09-03 10:27:13 +08:00
..
conventions-directive.md Feed repo conventions (AGENTS.md/CLAUDE.md) to the review engine (#5) 2026-07-17 18:46:47 +08:00
output-shape.md feat: review locally with your own agent as the engine (#51) 2026-09-03 10:27:13 +08:00
severity-instruction.md P3 severity + summary pinned to top of PR description (#4) 2026-07-16 19:07:27 +08:00