Skip to content

Document vibe-check init, diff, analyze --output, and the divisor-entropy agent #278

Description

@jflowers

The vibe-check toolkit (zero-dot-force/vibe-check) has added user-facing capabilities that need website/documentation coverage.

What to document

  • vibe-check init [path] — deploys the bundled Review Council agent assets into .opencode/agents/ of a target project. Flags: --force (overwrite existing), --json (machine-readable summary). Path defaults to .. Exit 0 on success (including all-skipped), exit 2 on invalid path / I/O failure.
  • vibe-check diff <base.json> <pr.json> — compares two ModuleGraph snapshots and reports the structural-entropy delta plus a verdict. Emits per-module deltas, new/resolved cycles, entropy direction (improving/stable/degrading), and a verdict (APPROVE / COMMENT / REQUEST_CHANGES). Protected gates: ΔInstability ≥ 0.15, ΔDistance ≥ 0.20, ΔLCOM ≥ 2, or a new circular dependency → REQUEST_CHANGES; smaller non-zero shifts → COMMENT; improving/flat → APPROVE; partial/unreliable input → COMMENT. Flags: --json, tighten-only --max-instability-delta/--max-distance-delta/--max-lcom-delta. Exit 0 when both inputs valid (verdict is in the payload; REQUEST_CHANGES still exits 0), exit 2 on invalid input or a looser-than-default override.
  • vibe-check analyze --output <file> / -o — writes the ModuleGraph JSON to a file instead of stdout (stdout remains the default). Exits 2 with no partial stdout if the file cannot be written.
  • Forced GOTOOLCHAIN=local in vibe-check analyze — analysis never downloads a toolchain named by a target module's go.mod. Trade-off: a trusted module whose go.mod toolchain directive requires a newer-than-local Go must be built/analyzed manually.
  • divisor-entropy Review Council agent — embedded in vibe-check and deployed by vibe-check init; measures the base↔PR structural-quality delta by running analyze + diff across an isolated git worktree. Runs on trusted refs only (never wire into untrusted-fork PR CI).

Context

Filed from the add-divisor-entropy-agent change per the Documentation/Website Sync gate (before PR merge). Source repo: zero-dot-force/vibe-check.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions