Skip to content
miu-cr

Introduction

miu-cr

miu-cr (MIU Code Review) is AI code review for the CLI, CI, and MCP hosts, built on a deterministic + agent engine. Review your own changes locally before you open a PR, gate them in CI, review GitHub PRs with inline comments, or drive the engine from any MCP-capable agent host (Claude Code, Codex, …). One review path, four ways to run it, a stable JSON envelope on stdout.

Latest release: v0.42.0 — a single static binary; credentials are passed at runtime and never persisted.

Diff-only review misses cross-file bugs; bare-agent review drifts and burns tokens. miu-cr keeps the correctness-critical parts deterministic — file selection, context assembly, line-anchoring, severity gating, dedupe — and uses the LLM only where judgment helps: finding bugs and proposing fixes.

Start here

Section titled “Start here”
Getting started Install → miucr init → first review → use it in your editor and CI.
Install install.sh, Homebrew, go install, or a Windows zip.
Usage Review modes, flags, the severity gate, output formats, and exit codes.
GitHub PR review Inline comments, an idempotent summary, cross-push dedupe, suggest & approve.
Serve & Action HMAC webhook daemon, opt-in poll trigger, and the reusable GitHub Action.
MCP integration Run review_run / review_get as first-class tools in Claude Code or Codex.
Review history Every review auto-saves; browse with miucr history, history show, and history prune.
How it works The deterministic engine and drift-reject line-anchoring.

What you get

Section titled “What you get”

Review where you work

Section titled “Review where you work”
  • Local review — Usage · Use cases
    • Run staged, range, or commit reviews: --staged, --from + --to, --commit.
    • Deterministic select → context → single LLM pass → line-anchor → gate → dedupe.
    • CI-friendly exit codes at or above --gate severity.
  • GitHub PR review — GitHub PR review
    • Head-SHA-anchored inline comments, including multi-line ranges.
    • One idempotent summary, or a required GitHub Check Run with --mode checks.
    • --filter-mode, SARIF export, cross-push dedupe, --suggest, and --approve-clean.

Project context

Section titled “Project context”
  • Project rules — Project rules
    • .miu/cr/rules/*.md frontmatter selects context by changed-file glob.
    • Built-in, user, and repo layers; repo rules are trust-fenced on fork PRs.
  • Semantic code-recall — Semantic code-recall
    • Optional embeddings + pgvector recall prior findings as advisory context.
    • Off by default.

Automation and integrations

Section titled “Automation and integrations”
  • serve · poll · Action — Serve & Action
    • HMAC webhook daemon, opt-in poll trigger, and reusable GitHub Action.
    • All three funnel into the same review path.
  • MCP server — MCP integration
    • miucr mcp exposes review_run / review_get over stdio.
  • REST API + GitHub App — REST API & GitHub App
    • MIUCR_API_TOKEN registers /v1/reviews.
    • [github] mode = app swaps PAT auth for App installation auth.

Storage and packaging

Section titled “Storage and packaging”
  • Review history — Review history
    • Every review auto-saves findings, stats, transcript, and raw I/O.
    • Browse with miucr history, miucr history show <id>, and miucr history prune.
  • Store backends — Store backends
    • SQLite by default; opt into Postgres via [store] backend + MIUCR_PG_DSN.
  • Single static binary
    • Credentials are passed at runtime and never persisted.

A 30-second tour

Section titled “A 30-second tour”
Terminal window
export ANTHROPIC_API_KEY=...                       # bring your own key (--provider auto detects OpenAI too)
miucr login --provider openai                      # or: review on your ChatGPT plan
miucr review --staged                              # review staged changes
miucr review --from main --to HEAD -o pretty       # review a range, human-readable
miucr review --commit HEAD~1 --gate high           # exit 2 if a high+ finding lands
miucr review --pr owner/repo#123 --no-post -o json # dry-run a GitHub PR
miucr mcp                                          # serve the engine over MCP (stdio)

Every command emits the stable miucr.cli/v1 JSON envelope by default (-o pretty for a human table). New here? Start with Getting started, then browse copy-paste starters (rules, GitHub Action, MCP setup, Docker) in examples/. It is Apache-2.0 licensed; the source of truth is the repository.