zzop ( Zero Zone Of Pain )

Your AI coding agent can't read your whole codebase. zzop reads it — and answers the same way every time.

Point zzop at one repository, or at your frontend and backend together, and it returns a single JSON document describing what is actually there: which frontend calls reach which backend routes and which reach nothing, what looks risky, what is dead, where to refactor first — and what this run could not see. An agent starts from that instead of guessing from the handful of files it had room to open.

zzop does not write code. It makes the understanding a code generator works from accurate and repeatable — same commit in, byte-identical findings out — so what your agent writes rests on what your code does rather than on what it inferred from a partial read. The thing being improved is comprehension, not capability.

See it break something

Break a route is the whole product in one change: rename one backend route in a frontend/backend pair that share no code and no types. The frontend still compiles, its tests still pass — and zzop names both ends of the break, file and line (abridged here; the demo page shows the run's own format):

=== unprovided consumes ===
  "PUT /api/user"      @ fe-vite     src/pages/Settings.jsx:19    ← the call now hits nothing

=== unconsumed provides ===
  "PUT /api/users/me"  @ be-express  src/app/routes/auth/auth.controller.ts:61   ← the route nobody calls

That page is a narrated walkthrough: every command and the output it produced are written out, so it reads end to end without you running anything. The script behind it, docs/demo/break-a-route.sh, is a maintainer tool rather than a first-run command — it builds a cargo example (so it needs a source checkout, not a released binary) and analyzes two repositories you supply at corpus/oss/fe-vite and corpus/oss/be-express. corpus/oss/ is gitignored and nothing in this repo ships those trees — they are third-party checkouts, not ours to redistribute; see CONTRIBUTING.md on bringing your own corpus. (The synthetic corpus we did write is committed, at cases/ — every file of it but one, a fixture that has to carry a live vendor-token literal and so cannot be committed at all; its README says what that costs the benchmark score.)

Which of the two binaries do you want?

zzop ships as two Node-free binaries. Decide which one you need before you install anything:

Both binaries dispatch to the same shared handlers over the same engine, so a tool call and a CLI run against the same path give the identical answer. Neither one makes a network request of any kind — they carry no HTTP dependency at all (privacy).

• Documentation site: https://eezz4.github.io/zzop/ (authored in site-src/, generated by scripts/gen-site.mjs; site/ is the committed output — a guard rejects hand edits to it)
• Documentation (in-repo): docs/README.md
• How it works, in depth: docs/ARCHITECTURE.md
• External parser protocol: docs/NORMALIZED_AST.md

Quick start

Neither binary needs Node.js, npm, or a compiler. Get them one of four ways:

• Download the binaries. Grab the zzop-cli-<platform>[.exe] (CLI) and/or zzop-mcp-<platform>[.exe] (MCP server) assets for your platform from GitHub Releases and run them directly, or put them on PATH. Each release also carries a SHA256SUMS asset covering every one of those assets — from v0.30.0 onward; releases up to and including v0.29.1 do not have one, so on an older pin check that the file is there before relying on it. Verify with sha256sum -c SHA256SUMS --ignore-missing, or shasum -a 256 -c SHA256SUMS --ignore-missing on a macOS box that has no sha256sum. Its scope is narrow and worth stating: it catches a corrupted download, and it is a hook for anyone who obtained the digest through another channel. It does not defend against a compromised release origin — an attacker who can swap an asset can swap SHA256SUMS beside it — and TLS already refuses MITM.
• Claude Code plugin. /plugin marketplace add eezz4/zzop, then /plugin install zzop@zzop — see Use in Claude Code below. (Windows: the install hook needs a POSIX shell — Git for Windows is the supported path; details in packages/README.md.)
• Claude Desktop. One-click .mcpb bundle (drag-and-drop install) — what an installer should know BEFORE installing (updates are manual; on macOS the unsigned binary is expected to hit Gatekeeper; the privacy statement) is packages/mcpb/BUNDLE-README.md — bundles from releases after v0.32.0 carry that file as their own README; bundles up to and including v0.32.0 ship without it, which is exactly why the pre-install pointer here matters. Packaging internals: packages/mcpb/README.md.
• npm. npm i -g @zzop/cli installs the exact same zzop binary above, fetched for your platform as an npm dependency — every subcommand zzop help lists, byte-for-byte the same output, no Node runtime involved beyond a tiny launcher script and no separate JS implementation that could drift from the native binary. Convenient when a project already manages its toolchain through npm. See packages/cli/README.md.

Use in Claude Code (MCP plugin)

The agent-facing lane. zzop-mcp is a self-contained binary with an MCP server built in; you install it once and then ask questions in plain language — the agent picks the tool.

1. /plugin marketplace add eezz4/zzop — then /plugin install zzop@zzop (two separate steps).
2. Start a new session. The plugin downloads the binary for your platform on first run; nothing goes on PATH. That first session does not list the zzop tools yet — the tool list is settled before the download finishes — so restart Claude Code once and they appear (the hook says so on stdout too). Once installed, a newer release is reported to you, never installed behind your back.

The server exposes the tools analyze_repo, cross_repo, check_file, check_endpoint, analyze_envelope, validate_envelope, validate_rule_pack — plus the zzop://contract/* resources carrying the authoring contracts (among them the envelope schema, the DSL reference, the rule catalog, the config surface and an annotated starter config), so an adapter or rule pack can be written with nothing but the binary. zzop-mcp itself takes no analysis subcommands: bare or mcp serves stdio, and version/help are the only other forms.

See packages/README.md for the full install/tool/resource reference, and docs/modules/mcp.md for exact argument shapes.

Use in a terminal or CI (zzop CLI)

The human-facing lane. Write a zzop.config.jsonc and run it, ESLint-style. A config is required — every analysis lane refuses a tree that has none, on both binaries alike, because the names zzop would otherwise guess about your project (what you call your auth guards, which banners mark your generated files) live in that file, and a key you do not declare is a judgment zzop does not make:

zzop init                               # write the starter config — do this first, once per tree
zzop analyze .                          # analyze one repo/tree -> JSON findings summary
zzop analyze --config ci/zzop.config.jsonc   # same, for a config that does not sit at the tree root
zzop analyze . --severity critical --limit 10  # narrow the findings LIST (counts always cover everything)
zzop cross --config zzop.config.jsonc   # cross-layer join, driven by that config
zzop analyze . --fail-on critical       # THE CI GATE: exit 3 when anything at/above that severity exists
zzop <subcommand> --help                # that one subcommand's own line (exit 0); `zzop help` prints them all

zzop --help is the canonical subcommand list — this README does not repeat it.

The exit code is 0 unless you ask otherwise. Without --fail-on, a run answers only "did zzop run", so a tree full of criticals still exits 0; with it, findings at or above the named severity exit 3 (a third code, so a CI log can tell a broken config on 1 apart from a real finding) while the whole reply still goes to stdout. Check what your build does rather than this paragraph: zzop analyze . --fail-on critical; echo $?. The full code table, including the 2 a provably unmatchable --rule id lands on, is in docs/getting-started.md.

A run writes into the tree it analyzes. The first analysis creates .zzop/cache/ beside your config (the default cacheDir) and keeps the per-file analysis cache there — pure derived state, safe to delete, regenerated on the next run, and it grows with the tree rather than staying small (measure yours with du -sh .zzop; this repository's own is not a number worth printing here because it moves with every run). zzop init adds the anchored **/.zzop/ line to that directory's .gitignore for you; set "cacheDir": null to write nothing at all.

To track contract drift over time rather than at one instant, commit a structural manifest and diff a later run against it — the same shape a lint baseline file has, kept by you, not by zzop:

zzop manifest ./api ./web > contracts.json   # identity only: provides/edges/bucket membership
zzop diff contracts.json contracts.new.json  # read `transitions` first — a key that left `edges`
                                             # for `unprovidedConsumes` is a broken contract
zzop facts ./api ./web > facts.json          # post-assembly facts (per-tree CommonIr + the whole join,
                                             # uncapped) for your own rule program
zzop graph ./api ./web > join.mmd            # the cross-layer join as mermaid, for any renderer —
                                             # scoped with --scope/--top, every cap disclosed in the file
zzop graph . --domain dep > imports.mmd      # the FILE import graph instead — cycles drawn as hexagons
                                             # with thick arrows, from the engine's own circular findings
zzop graph . --domain risk > risk.mmd        # blast-radius hubs + extraction seams. The health SCORES
                                             # are NOT drawn — a table of numbers is not a graph
zzop graph . --domain posture               # the mutating attack surface and its guard status —
                                             # a box means GUARDED-OR-EXEMPT, never proven guarded
zzop graph . --domain cochange > churn.mmd   # which files keep changing TOGETHER, from git history —
                                             # not imports, so it finds the coupling no dep graph can see
zzop graph . --domain dep --fold 2           # the SAME import graph with each path's first 2 segments
                                             # drawn as one box — the module map you were trying to see
                                             # IS the picture, and every edge says how many file edges
                                             # it collapsed. --fold 1 for the top-level view

The manifest is deliberately uncapped and carries no file or line, so a pure refactor diffs empty while a route leaving the join cannot hide above a summary's caps. diff refuses two manifests from different zzop builds unless you pass --allow-tool-drift (which then discloses the drift), and tags a removal attributable to a source that lost coverage as blindnessSuspect rather than calling it a deletion.

facts is the other uncapped lane, and the consumer half of the custom-rule extension point: when the DSL cannot express your rule, zzop emits everything it knows after assembly and the cross-layer join — each tree's whole CommonIr plus every join bucket, verbatim — and your own program decides what counts as a problem. zzop neither runs your program nor reads its findings back; see docs/modules/facade.md for the shape. manifest, diff, facts, coverage, graph, explain and init are CLI-only lanes with no MCP tool twin.

The rest of the surface: analyze-envelope, validate-envelope, validate-rule-pack, endpoint, file (everything zzop knows about ONE file — its tree, symbols, io facts, dependency edges both ways, and every finding anchored there; its verdict says whether the file was ANALYZED, so an empty findings list is never mistaken for "clean" on a file nothing structural ran on), init (write the annotated starter zzop.config.jsonc; the same document MCP serves as the config-template resource), contract, explain, version, help. See packages/README.md for the full CLI and config reference.

To embed the engine instead of running either binary, call the zzop-facade/zzop-summary crates' JSON-in/JSON-out contract directly — they are workspace-internal and not published to crates.io, so an in-process Rust dependency means vendoring this workspace, not cargo add. Shelling out to the CLI's JSON subcommands needs no linkage at all:

let report: serde_json::Value =
    serde_json::from_str(&zzop_facade::analyze_json(r#"{"root":"."}"#)?)?;

Result (abridged)

This is what the two binaries above actually print — findings is a census object, not an array, because the reply is a shaped summary rather than a raw dump. The numbers below are a real run against this repository's own cases/trees/api-be fixture, measured with a zzop built from this checkout: zzop analyze --config cases/trees/api-be/zzop.config.jsonc.

Which binary you reproduce them with is part of the claim. zzop version prints the release number alone, and main keeps that number between releases — so an installed @zzop/cli and a build of this checkout can both answer 0.33.0 and legitimately report different findings, because they are different builds of one version string. zzop version --verbose is what tells them apart: it prints each parser's fingerprint and the engine hash. If your counts differ from the block below, compare that line before assuming either side is wrong.

(To the next editor: these numbers move whenever cases/trees/api-be changes and whenever a release changes what is measured — re-run that command and re-measure them, never patch one in isolation. Three of them were stale for exactly that second reason until 2026-08-11 — and the whole block was again on 2026-08-15, after v0.31.0 exported the code-hygiene pack out of the bundle and 114 findings became 85. It happened a THIRD time on 2026-08-21, and that time nothing about the fixture moved: a Prisma delegate-accessor fix changed what schema/unreferenced-field-name counts as referenced, one info finding went away, and 85 became 84 with this block untouched. The lesson the first two did not teach is in this paragraph's first sentence — "whenever a release changes what is measured" includes every rule change, not only the loud ones, and no guard here can catch it, because the only machine that knows the number is the run.

An outside reader reported 87/73 for this block on the same day and was NOT reading a stale README: they measured with the published @zzop/cli 0.33.0, a different BUILD of the same version string, and got a legitimately different answer. That is what the paragraph above this one is for. The disclosure line below is deliberately no longer one of these numbers: see its own comment.)

pain never travels alone. painMeasuredWeight / painTotalWeight is how much of the weight table this tree could actually be measured on, and pain: null means no metric had a population at all — absence of data, never a clean bill.

And pain is not a defect score. It contains no rule findings whatever: the run below reports 84 findings, 5 of them critical, while its defect pain is 0. painByAxis splits the number so that is visible instead of implied — defect (import cycles, the only entry), opinion (barrel discipline, FSD layering, SDP/Main Sequence, Newman modularity, LOC ceilings — a project that deliberately does the opposite is not wrong, it scores low), and history (rename churn, bus factor). The three sit on pain's own scale and sum to it. Read findings for defects; read pain for how much zzop disagrees with how the code is arranged.

{
  "fileCount": 84,
  "findings": {
    "total": 84,
    "bySeverity":  { "critical": 5, "warning": 71, "info": 8 },
    "byRule":      { "security/weak-crypto": 6, "db/unawaited-write": 1 },
    "shown":       [ /* 50 here — the listed slice, capped by --limit; each entry has ruleId, severity, file, line, message */ ]
  },
  "architecture": { "pain": 7.5, "painMeasuredWeight": 13.8, "painTotalWeight": 18.6,
                    "painByAxis": [ { "axis": "defect",  "pain": 0.0, "totalWeight": 3.0 },
                                    { "axis": "opinion", "pain": 7.5, "totalWeight": 15.0 },
                                    { "axis": "history", "pain": 0.0, "totalWeight": 0.6 } ],
                    "topRecommendation": null, "criticalTop": [],
                    /* + painMeaning / topRecommendationMeaning / criticalTopMeaning: the sentences
                       that say what each of the three above is, and is NOT, on the wire */ },
  "coverage":     { /* how much of the tree zzop actually saw, per extension */ },
  "coverageGaps": { /* which principal extensions reached no resolved import edge, always present —
                       each row's `kind` ("source" vs "data-config") is what says whether the zero
                       means a missing parser or a filetype you have to open to judge */ },
  "disclosure":   { /* the census of zzop's OWN known silent-failure classes, keyed
                       classes / asserted / partial / notYetDetected, plus the `note`,
                       `command` and `resource` that lead to the full text. No counts are
                       copied here: the reply carries its own, and the two that were copied
                       here went stale while the two beside them stayed right — which is
                       indistinguishable from correct until someone re-runs it. Read them
                       with `zzop contract disclosure-classes`, the command the field itself
                       names. */ },
  "warnings":     [ /* anything this run could not provide */ ]
}

Every finding carries a rule id, severity, a file:line location, and a message naming the config key that silences it — the records themselves ride in shown. bySeverity/byRule always count the WHOLE run, so a --limit that shortens that list never changes them; that split is why findings is an object.

The per-metric scores block, the health object and recommendations are not on this wire: the shaped summary folds them into the compact architecture object above. They exist in full only in the zzop-facade embedding lane (zzop_facade::analyze_json, the snippet just above) — see docs/modules/facade.md for that lane's own shape.

analyzeTrees (multi-tree) additionally returns crossLayerFindings — frontend fetch <-> backend route joins — which has no single-tree equivalent.

How it works

Each repository is parsed into one language-neutral IR, so a Python route and a TypeScript fetch end up as the same kind of fact. The headline move is the cross-repo join: frontend calls are exact-matched against backend routes across the repo boundary, and the leftovers are named rather than dropped — a casing or base-path difference, a version drift, a method mismatch each come back as a near-miss finding naming the dimension that differs, instead of a diff you have to do by hand. A near miss is judged on those axes, never on spelling: a plural or a typo (/api/userss against /api/users) is reported as an unmatched call, not paired with the route it probably meant — the per-rule scope is in the catalog. Alongside the join, the same engine runs a layered rule system (native whole-graph analyses plus declarative JSON rule packs) over each repo individually, adding structural findings, dependency/dead-code analysis, and health scores to the same JSON document.

Every run is deterministic — same code in, same findings out, byte-stable enough to diff two runs against each other. That is what makes zzop usable as a CI gate (fail a PR on contract drift by reading the JSON severity counts) and as a substrate an agent can re-run without chasing a moving answer. Just as important, a run reports its own blind spots: warnings and the per-tree coverage census say what did not run, so a short findings list can be told apart from a blind engine.

Full design: docs/ARCHITECTURE.md. Reading the output, severity semantics and suppression: docs/getting-started.md. When your stack does not match the defaults — a house extension, your own guard names, a gateway prefix, a rule that does not exist yet — docs/extending.md lists every plug-in point in the order you hit them.

Supported languages

Full precision-tier breakdown — exactly what each native parser extracts, Python's v1 scope note, and each parser's fingerprint — in docs/ARCHITECTURE.md. (Those fingerprints are not in zzop version's default output, which prints the bare release number so scripts can parse one token; zzop version --verbose — and zzop-mcp version --verbose, the identical string — prints them, and zzop manifest's tool field carries the same string inside the artifact.)

Rust carries one reporting rule no other language has: a finding whose line sits inside a #[cfg(test)]/#[test]-gated item is dropped, because Rust's unit tests live inside the shipping file where the path-shaped test exclusion every other language relies on (foo.test.ts, tests/test_foo.py) cannot see them. The credential-at-rest rules opt out and keep judging those regions — a committed key is leaked whether or not the compiler keeps it — and each says so in its own catalog row. Both halves: docs/rules/catalog.md.

A normal-sized file whose extension has no native parser also self-reports in the output's warnings — naming the extension, a file count, and a path sample — instead of vanishing silently; point it at an adapter (overlays: [...] in zzop.config.jsonc) if that language matters for the analysis.

Versioning & stability

zzop is pre-1.0 (0.x) and unstable — any release may change behavior, output, rules, or defaults, so pin an exact version (not a ^/~ range) and re-test before upgrading. Semantic Versioning begins at 1.0.0. What is promised before then is narrower, and is a promise about the record rather than the rate: a break to one of the surfaces VERSIONING.md names is written down, old and new spelling both, in CHANGELOG.md. VERSIONING.md is also where the properties inside those surfaces that are still moving get named — rule ids, SourceSymbol.id uniqueness, native id namespaces — rather than left for you to infer from a run.

Layout & development

Contributing, or just want the crate map? CONTRIBUTING.md carries both — the per-crate responsibility list and the build/test/measure commands. They live there rather than here because this page is read to DECIDE whether to adopt zzop, and a dependency graph answers a question nobody asks before installing.

License

MIT — see LICENSE.