vigiles 9.0.0 → 10.0.0

package/README.md

@@ -3,42 +3,55 @@
   This file is the FRONT DOOR + a marketing asset for someone who already lives
   in Claude Code / Codex. Optimize for a phone-skimmer.
 
-  1. LEAD WITH BENEFITS, not mechanics or vocabulary. Say what the user GETS
-     (a guard that can't silently fail; a CLAUDE.md that stops lying) before how.
-  1b. NEVER OPEN WITH A NEGATIVE, APOLOGY, OR CAVEAT. A bolded lead-in is the
-     FIRST thing a skimmer reads, so it must be the benefit/on-ramp, never a
-     deficiency or competitor: write "Start in plain markdown", NOT "No
-     TypeScript?". Put the STRONGEST proof (e.g. 2/7→7/7) on its OWN line, never
-     buried mid-paragraph, and END a section on the win, not the caveat (demote
-     trade-offs to a trailing aside). Break run-on em-dash/semicolon chains — a
-     paragraph is ≤ ~3 lines, one idea.
-  1c. LEAD WITH THE CONCRETE PAIN the reader already feels — named in THEIR
-     situation, with the SPECIFIC silent failure, not an abstraction. "You
-     installed plugins and wrote skills — but do they actually work? A skill that
-     never fires, a hook that blocks nothing, a CLAUDE.md full of dead refs" beats
-     "reliability for your harness"; "a library with no tests" is the anchoring
-     analogy. This is NOT a 1b violation: a pain about the READER's situation is a
-     hook, not an apology — 1b bans opening with vigiles's OWN deficiency, a
-     caveat, or a competitor, never the user's pain. SAME FOR THE SUBDOCS: open
-     every guide with the concrete pain, THEN the "what this doc is" line + the
-     README uplink (per docs-quality in CLAUDE.md).
-  2. SPEC-FIRST IS THE DEFAULT — but easy, never intimidating. `init` adopts your
-     existing CLAUDE.md INTO a spec, and model-invocable skills (edit-spec /
-     strengthen / test-harness) author + edit it, so you rarely hand-write a
-     .spec.ts and hooks auto-compile on save. Present the typed spec as the default
-     the agent manages for you, NOT an advanced opt-in or a "step up". Inline
-     markdown is the ZERO-TS FLOOR for anyone who skips `init` (progressive
-     adoption) — the on-ramp, not the default starting point. `eject` always
-     reverses. NEVER a wall.
-  3. THE INSTRUMENTS stay first-class — including Eval (measuring whether a skill
-     actually helps is core, not optional). NOTE: Guard / compiled hooks is PARKED
-     FOR LAUNCH (commented out below; see research/roadmap.md "Launch readiness") —
-     so the live set is Lint/Test/Eval ("three instruments"); re-add Guard post-HN.
-  4. SCANNABLE + SHORT — ~200-line cap; punchy table cells, bullets, runnable
-     blocks; benefits over jargon. Push depth into docs/ and LINK it.
-  5. NO INTERNAL VOCABULARY (moat / measurement-authority / flywheel) and NO
-     research/ links — name the user benefit (see public-vs-internal-docs +
-     readme-brevity in CLAUDE.md).
+  SPINE = CONCEPT 5 (proof/demo-led). Lead with REAL, screenshotable catches on
+  plugins people actually ship, THEN explain the mechanism. The proofs are not
+  illustrative — every block traces to a real dogfood run captured in
+  research/dogfood/. TWO COMMUNITY catches, anonymized (a skill-description collision
+  → wrong-skill-fires (claude-flow, Triggering F), an AskUserQuestion-never-available
+  tool) — both real GRADED defects that REPRODUCE on current main. NEVER replace a
+  real catch with a fabricated one. (Proof 1 was a missing-SKILL.md/Truthfulness
+  catch, swapped 2026-06-28: its source (superpowers) is clean on current main and NO
+  reproducible dead-file-ref exists in popular OSS — those are an adopt+strengthen
+  payoff, see research/oss-audit-render-findings.md.)
+
+  WHY ONLY TWO (decided 2026-06-28): the earlier Proofs 3-4 leaned on
+  pr-review-toolkit's "review agents inherit all tools" as an official-plugin
+  defect. But inherit-all (a subagent with no `tools:` line) is now ADVISORY, not a
+  graded penalty — omitting the tool contract is a near-universal, legitimate
+  authoring style (an OSS sweep of 122 plugins found 109 whose only finding was
+  this), so penalizing it cried wolf. With that change the official plugins are all
+  a clean A, so a "even Anthropic has bugs" proof would be dishonest — Proofs 3-4
+  were DROPPED rather than reframed. The leaderboard feature still exists; it just
+  isn't a headline proof.
+
+  DON'T SHAME OSS: community catches are real but ANONYMIZED in public copy (no
+  obra/superpowers, madappgang by name) — real names live only in research/dogfood/.
+  If an official/vendor proof returns, punch UP (name Anthropic's own); never name a
+  volunteer's repo to show its bug.
+
+  1. LEAD WITH BENEFITS / the reader's CONCRETE PAIN, never an apology, caveat, or
+     competitor. A bolded lead-in is the first thing read — make it the hook/win.
+     End a section on the win, not the trade-off. A paragraph is ≤ ~3 lines.
+  2. PROOF FIRST, mechanism second. The three instruments (Lint/Test/Eval) come
+     AFTER the proof stack as "how it does it", not as a competing front door.
+  3. SPEC-FIRST IS THE DEFAULT but easy — `init` ADOPTS your CLAUDE.md into a spec,
+     skills edit it, you rarely hand-write .spec.ts. Give it ONE home (Quick start),
+     not five scattered mentions. `eject` always reverses. Inline markdown is the
+     zero-TS floor.
+  4. Guard / compiled hooks is PARKED FOR LAUNCH (see research/roadmap.md). Live set
+     is Lint/Test/Eval. Do NOT make the 2/7→7/7 battery the hero — re-add post-HN.
+  5. SCANNABLE + SHORT — ~200-line cap; punchy cells, bullets, runnable blocks.
+     Push depth into docs/ and LINK it.
+  6. NO INTERNAL VOCABULARY (moat / measurement-authority / flywheel) and NO
+     research/ links — name the user benefit.
+  7. ASSETS: the hero vigiles-audit.png is a REAL current report (a community
+     plugin rendered as "my-plugin" to anonymize) — A 92 with four rings and an
+     inline subagent-tool-contract fix; no dialect-drift banner (HTML report is
+     terminal-banner-free by design). Re-render via headless Chromium on the React
+     report if the UI changes. (vigiles-demo.gif was removed
+     from Proof 1 — it rendered as a frozen half-typed terminal and was redundant
+     with the code block; if a lint demo returns, it belongs in the Lint section
+     with a non-frozen asset.)
 -->
 
 <p align="center">
@@ -48,7 +61,7 @@
 <h1 align="center">vigiles</h1>
 
 <p align="center">
-  <strong>Make the harness your AI agent runs on reliable.</strong>
+  <strong>The tests your AI agent harness never had.</strong>
 </p>
 
 <p align="center">
@@ -60,148 +73,80 @@
 ---
 
 **You installed a bunch of plugins and wrote a few skills — but do they actually work?**
-A skill that never fires, a subagent wired to a tool that doesn't exist, a CLAUDE.md
-full of dead references — your harness fails **silently**, and you find out mid-task.
+A skill that never fires, two skills the agent can't tell apart, a subagent wired to
+a tool that doesn't exist — your harness fails **silently**, and you find out mid-task.
 
-**It's a library with no tests.**
-
-**One command shows you — like a Lighthouse report for your harness:**
+**It's a library with no tests.** One command runs them — no key, no config, safe on
+any repo:
 
 ```bash
-npx vigiles audit          # no key, no config, safe to run anywhere
+npx vigiles audit
 ```
 
-It **reads** your harness deterministically — every reference checked, four categories
-scored, each finding's fix inline — and writes a shareable HTML report:
+Here's what it found on real, popular plugins. ↓
+
+## The report
 
 <p align="center">
-  <img src="vigiles-audit.png" width="760" alt="vigiles audit report: an overall score with four category rings — Truthfulness, Triggering, Structure, Tested — and fix cards" />
+  <img src="vigiles-audit.png" width="760" alt="vigiles audit report: an overall A (92/100) score with four category rings — Truthfulness, Triggering, Structure, Tested — and an inline fix card for a subagent declaring a tool that doesn't exist" />
 </p>
 
-| Ring                | What it proves                                                        |
-| ------------------- | --------------------------------------------------------------------- |
-| **🔎 Truthfulness** | Every path / script / symbol / linter rule in your CLAUDE.md resolves |
-| **🎯 Triggering**   | Skills fire on the right prompts and don't collide                    |
-| **🔧 Structure**    | Tool contracts, MCP servers & frontmatter are sound                   |
-| **🧪 Tested**       | Every surface ships a test                                            |
-
-Like Lighthouse, `audit` is a **local report you run on your machine** — a
-deterministic read, safe on any repo (even one wired to prod), identical on every
-OS. **Not a CI step** (CI uses `lint`, the deterministic gate). The **executing
-checks** (resolve MCP live · **do your skills fire?** · **what would vigiles
-catch in your repo?**) run only when there's a human to consent: `audit` **asks
-once** at a terminal and remembers. **[Audit a harness →](docs/for-plugin-authors.md)**
-
-`Agent = Model + Harness` — the model gets the headlines, the harness is the half you
-own. vigiles[^name] is how you make it prove itself: `audit` is the dashboard, and
-**three instruments** fix and prove what it finds —
-
-|             |                                                                                                                                                 |
-| ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
-| **🔎 Lint** | Your CLAUDE.md stops lying — every path, script, symbol & linter rule checked against **reality**. **[→](docs/verifying-instruction-files.md)** |
-| **🧪 Test** | Prove your hooks, skills & subagents do their job — **free, no API key**. **[→](docs/harness-testing.md)**                                      |
-| **📊 Eval** | Know if a skill helps or just costs — **A/B on real tasks**, on your own subscription. **[→](docs/measuring-skills.md)**                        |
-
-<!-- PARKED FOR LAUNCH — Guard / compiled hooks. Re-add this row + the ④ section below post-HN. See research/roadmap.md "Launch readiness".
-| **🛡 Guard** | A safety hook that **can't silently fail open** — write a typed function, get a guard that blocks. **[→](docs/compiled-hooks.md)** |
--->
-
-**Two ways in** — pick the pain that's yours:
-
-- **Run agents on your own repo?** `npx vigiles audit`, then `npx vigiles init`.
-- **Ship plugins to a marketplace?** `npx vigiles audit ./plugins/*/` ranks a whole
-  marketplace (0–100, A–F) — see the **[plugin-author guide →](docs/for-plugin-authors.md)**.
+Four deterministic rings, **each finding's fix inline**, and a shareable HTML report.
+Like Lighthouse, `audit` is a **local report you run on your machine** — safe on any
+repo (even one wired to prod), identical on every OS. **Not a CI step** (CI uses
+`lint`). **[Audit a harness →](docs/for-plugin-authors.md)**
 
-**Your agent writes the spec — and you can always eject.** Skills author the
-`.spec.ts` for you, **`init` adopts an existing CLAUDE.md non-destructively**
-(untouched until you compile), and plain markdown + inline `<!-- vigiles:enforce -->`
-comments work with zero TypeScript. Works with **Claude Code and Codex**
-([`vigiles/codex`](docs/harnesses.md)) or [your own harness](docs/authoring-an-adapter.md).
-
-## Quick start
-
-**Paste into Claude Code or Codex:**
+## Proof 1 — two skills your agent can't tell apart
 
 ```text
-Set up vigiles in this repo: run `npx vigiles init` and accept the defaults. If I
-already have a CLAUDE.md or AGENTS.md, adopt it into a spec and show me which
-references are stale. Then install the dep, compile, and write + run one harness
-test for a hook or skill of mine. Don't enforce a spec-per-file or add a real-model
-eval without asking me first.
+✗ Triggering   0
+    └ 45 near-identical skill descriptions — the selector can't tell them apart,
+      so the wrong one fires  (e.g. "agent-coder" ↔ "agent-tester", 83% alike)
 ```
 
-The same prompt works in Codex.
+A real, popular plugin ships **45 skill pairs** described so similarly the model
+can't reliably pick between them — so it fires the **wrong** skill. Valid markdown;
+the selector chooses by description, and near-identical text collides.
+**[How triggering works →](docs/measuring-skills.md)**
 
-Or do it yourself:
+## Proof 2 — a tool your subagent silently can't call
 
-```bash
-npx vigiles init   # sets up lint + test: spec + harness test + CI + plugin
+```text
+✗ tester — Tool "AskUserQuestion" is never available to a subagent.
+    → remove or correct it — it's silently dropped from the contract.
 ```
 
-Interactive in a terminal, non-interactive for agents/CI (or `--yes`).
-
-**You don't hand-write any of this — your agent does.** `init` installs
-model-invocable skills, so a plain-English ask does the work (it edits the source
-and recompiles on save; you never touch it by hand):
-
-- _"test my skills"_ → scaffolds **and runs** a trigger/behaviour test (`test-harness`)
-- _"harden my rules"_ → upgrades prose guidance into enforced linter rules (`strengthen`)
-- _"add a rule to my CLAUDE.md"_ → edits the source and recompiles (`edit-spec`)
-
-<details>
-<summary>What <code>init</code> sets up</summary>
-
-- **Both lint and test** by default; scope with `--lint` / `--test`.
-- **Already have a CLAUDE.md / AGENTS.md? `init` adopts it** into a spec faithfully and **non-destructively** — your file is left untouched until you choose to `compile` (and `eject` undoes it).
-- Adds `vigiles` to `devDependencies`; installs the Claude Code plugin (skills + hooks) via the marketplace — globally, never vendored.
-- Wires CI as a `zernie/vigiles@v1` workflow (a composite over the same CLI) that posts a sticky PR comment + a `valid` output.
-
-Prefer to write tests yourself? They can be JS **or** TS
-(`*.harness.{mjs,ts}`) — run them with `npx vigiles test`.
-
-</details>
-
-## ① Lint — your CLAUDE.md lies to your agent
+A real upstream subagent declares a tool the harness **silently drops**, so it loses
+a capability it thinks it has. vigiles flags it _and_ hands you the one-line fix —
+**free, no model.** That's the difference from a markdown linter: it checks your
+harness against **reality**, not style — every file path, script, code symbol, and
+linter rule across **7 catalogs** (ESLint, Ruff, Clippy + four more), each verified
+to **exist _and_ be enabled**. **[Full guide →](docs/verifying-instruction-files.md)**
 
-**Your CLAUDE.md drifts the moment you refactor.** It points the agent at
-`src/auth/login.ts` and says run `npm run check` — but the file moved six commits
-ago and the script was renamed. The agent trusts the stale claim and acts on
-fiction. `npx vigiles lint` resolves every reference against reality:
+Two real catches, both **free and model-less** — and audit ranks a whole
+marketplace the same way. **[Audit a marketplace →](docs/for-plugin-authors.md)**
 
-```text
-CLAUDE.md:
-  ✗ src/auth/login.ts — no such file (renamed or moved?)
-  ✗ npm run check — not in package.json. Did you mean: "check:types"?
-  ✓ @typescript-eslint/no-floating-promises — exists and enabled in eslint config
-```
-
-<p align="center">
-  <img src="vigiles-demo.gif" width="720" alt="vigiles lint catching a file that moved and a script that was renamed" />
-</p>
-<!-- Regenerate the GIF: `python3 scripts/make-demo-gif.py` (output is verbatim CLI; see scripts/demo.sh for a live asciinema recording). -->
+> **And it grades itself: 100/100, A, all four rings green** — and CI gates every
+> commit with `lint` + `test`. We eat what we cook.
 
-File paths, scripts, code symbols — plus linter rules across **7 linters**
-(ESLint, Ruff, Clippy + four more): each rule exists **and is enabled**.
+## How it does it — three instruments
 
-**Your agent writes the spec — `init` adopts your existing CLAUDE.md into one,
-faithfully and non-destructively.** Prefer zero new files? Plain markdown + one
-inline `<!-- vigiles:enforce -->` comment lints too — no spec, no TypeScript. And
-`vigiles eject` hands a spec back to markdown anytime.
-**[Full guide →](docs/verifying-instruction-files.md)**
+`Agent = Model + Harness`[^name]. The model gets the headlines; the **harness** is the
+half you own. `audit` is the dashboard — these fix and prove what it finds.
 
-> **Want more? Bad states can stop compiling.** Opt in deeper and a broken
-> hand-off between agents becomes a build error instead of a runtime surprise —
-> graduated like TypeScript's `strict`, on only when you want it.
-> **[How →](docs/compiled-hooks.md)**
+### 🔎 Lint — your CLAUDE.md stops lying
 
-## ② Test — does your harness do its job?
+Every path, script, symbol & linter rule resolved against reality (the catches
+above). **You don't write any of it** — `npx vigiles init` **adopts your existing
+CLAUDE.md _and every skill and subagent_ into verified specs**, non-destructively
+(untouched until you `compile`; `eject` reverses). After that, plain-English asks
+edit them for you. **[How →](docs/verifying-instruction-files.md)**
 
-**You wired the hook — but does it actually block?** A skill's description can fail
-to trigger, or hijack unrelated prompts; injected context can silently never reach
-the model. All of it passes a naive "did it run?" check. vigiles tests the
-assembled harness for real.
+### 🧪 Test — does the harness actually do its job?
 
-Start with the cheapest tier — a hook, called directly. No model, no key:
+A hook that blocks nothing, a skill that hijacks unrelated prompts, injected context
+that never reaches the model — all pass a naive "did it run?" check. Start at the
+cheapest tier: a hook, called directly. **No model, no key:**
 
 ```typescript
 import { runHook } from "vigiles/testing";
@@ -214,102 +159,79 @@ const r = runHook(guard, {
 assert(r.blocked); // a red ✗ means your guard silently lets it through
 ```
 
-It goes well past _"did it fire?"_:
+Hooks **block** · skills **trigger** (recall _and_ precision) · subagents **finish**
+in the outcome they promised (no LLM judge) · **safety holds** — `interceptTools`
+catches a push or paid-API call as an _attempt_, so the side effect never happens.
+Almost every tier runs with **no model and no key**, on every commit.
+**[How testing works →](docs/harness-testing.md)**
 
-- **Hooks block** what they must — `runHook`, or the real agent CLI via `runHarnessTest`.
-- **Skills trigger** on the right prompts and stay quiet on the wrong ones — recall _and_ precision (`measureTriggerRate`).
-- **Subagents finish right** — assert a subagent ended in the success (or error) outcome it promised, with a plain check, no LLM judge (`assertAgentOk` / `assertAgentErr`).
-- **Behaviour is good** — score a skill's output, or A/B it on-vs-off for the real lift (`measure` / `runEval`, with significance testing).
-- **Safety holds** — the agent _didn't_ push to the wrong branch or hit a paid API; `interceptTools` catches the attempt so the side effect never happens.
+### 📊 Eval — does a skill help, or just cost more?
 
-Almost every tier runs with **no model and no API key** — milliseconds, on every
-commit; only the real-model tier needs a model, on your own `claude` CLI.
-**[How it works →](docs/harness-testing.md)**
+_"65% fewer tokens." Says who?_ vigiles A/Bs the claim on real coding tasks and reports
+the **bill**, the **target it claims to move**, and the **blast radius** (did the code
+still work?).
 
-## ③ Eval — does it actually help, or just cost more?
+**The eval you can actually afford:** promptfoo / DeepEval hit a metered API and bill
+**per token, every run**. vigiles answers most questions with **no model at all**, and
+runs the rest on your own **Claude Pro/Max subscription — $0 extra.**
+**[Measure a skill →](docs/measuring-skills.md)**
 
-**"65% fewer tokens." "3× faster." Says who?** A skill claims it, a plugin promises
-it — stars and vibes, **zero measurement**. vigiles A/Bs the claim on real coding
-tasks, the harness loaded exactly as it ships, and reports **three numbers**:
+## Quick start
 
-```typescript
-import { measureArms } from "vigiles/testing";
+**Paste into Claude Code or Codex:**
 
-const r = await measureArms({
-  fixture: { "in.txt": "Implement a slug helper." },
-  task: "Read in.txt, write slugify() to slug.js, explain. Stop.",
-  arms: { baseline: {}, skill: { files: { "SKILL.md": THE_SKILL } } },
-  measure: (ctx) => ({ cost: ctx.usage.costUsd, correct: check(ctx) }),
-});
+```text
+Set up vigiles in this repo: run `npx vigiles init` and accept the defaults. If I
+already have a CLAUDE.md or AGENTS.md, adopt it into a spec and show me which
+references are stale. Then install the dep, compile, and write + run one harness
+test for a hook or skill of mine. Don't enforce a spec-per-file or add a real-model
+eval without asking me first.
 ```
 
-- **The bill (`costUsd`)** — weights cache ~0.1× / output 1×, so a "saved tokens" headline can't hide behind cheap cache.
-- **The target** — whatever the skill claims to move (output tokens, latency, tool calls), verified on its own terms.
-- **The blast radius** — correctness, a deterministic 1/0. A token win that breaks the code is **not a win**.
-
-**Safe to repeat.** Each real-model run is sandboxed (ephemeral dir, egress blocked
-or allow-listed), and `interceptTools` catches an irreversible external — a push, a
-paid API — as an _attempt_, never running it. **[Safety, sandboxing & FAQ →](docs/safety.md)**
-
-**The eval you can actually afford.** promptfoo / DeepEval hit a metered API and
-bill **per token, every run**. vigiles answers most questions with **no model at
-all**, and runs the rest on your own **Claude Pro/Max subscription — $0 extra**. So
-you can measure on every change. **[Eval a skill →](docs/measuring-skills.md)** · **[Why it's affordable →](docs/eval-architecture.md)**
+Or do it yourself:
 
-<!-- PARKED FOR LAUNCH — Guard / compiled hooks. Re-add this whole section (and the table row above) post-HN. See research/roadmap.md "Launch readiness".
+```bash
+npx vigiles init   # lint + test: spec + harness test + CI + plugin
+```
 
-## ④ Guard — a safety hook that can't silently fail open
+Interactive in a terminal, non-interactive for agents/CI (or `--yes`).
 
-**Your safety hook looks like it blocks — and doesn't.** A guard is your last stop
-before something irreversible, but a hand-written one **fails open** without telling
-you. _(Already write safety hooks? This is the power tool.)_ Write a pure typed
-function instead; vigiles emits the exit code, the JSON, and an AST-backed matcher:
+**You don't hand-write any of this — your agent does.** `init` installs
+model-invocable skills, so a plain-English ask does the work:
 
-```typescript
-import { defineHook, tool, deny, allow } from "vigiles/hook";
-
-export default defineHook({
-  on: "PreToolUse",
-  match: tool("Bash"),
-  decide: (e) =>
-    e.command.runs("git push", { force: true })
-      ? deny("no force-push to a protected branch")
-      : allow(),
-});
-```
+- _"test my skills"_ → scaffolds **and runs** a trigger/behaviour test (`test-harness`)
+- _"harden my rules"_ → upgrades prose guidance into enforced linter rules (`strengthen`)
+- _"add a rule to my CLAUDE.md"_ → edits the source and recompiles (`edit-spec`)
 
-**The proof:** a widely-copied OSS safety hook blocks **2/7** of the disaster
-battery. The compiled rewrite blocks **7/7** — measured, not asserted.
+<details>
+<summary>What <code>init</code> sets up</summary>
 
-You never hand-write the exit code or JSON field (the usual false confidence), the
-matcher is **AST-backed** (it catches the `cd x && git push -f` a glob misses), and
-the artifact is **stamped** so a later hand-edit is refused.
+- **Both lint and test** by default; scope with `--lint` / `--test`.
+- **Already have a CLAUDE.md / AGENTS.md, skills, or subagents? `init` adopts them all** into specs faithfully and **non-destructively** — untouched until you `compile` (and `eject` undoes it).
+- Adds `vigiles` to `devDependencies`; installs the Claude Code plugin (skills + hooks) via the marketplace — globally, never vendored.
+- Wires CI as a `zernie/vigiles@v1` workflow that posts a sticky PR comment + a `valid` output.
 
-_Scope: this fixes a hook's logic, not the harness's delivery — a subagent's tool
-calls still bypass any PreToolUse hook
-([#34692](https://github.com/anthropics/claude-code/issues/34692)), so it's a strong
-default, not an unbypassable wall._
-**[Compiled hooks — bug classes + trade-offs →](docs/compiled-hooks.md)**
+Works with **Claude Code and Codex** ([`vigiles/codex`](docs/harnesses.md)) or
+[your own harness](docs/authoring-an-adapter.md). Prefer to write tests yourself?
+JS **or** TS (`*.harness.{mjs,ts}`) — run with `npx vigiles test`.
 
--->
+</details>
 
 ## FAQ
 
 - **Isn't this just a markdown linter?** No — it checks whether your instruction file is _true_ (every path/script/symbol/rule exists and is enabled), then tests and measures your harness. A style linter can't do any of that.
-- **Do I have to write TypeScript?** No — your agent writes the spec (`init` adopts your CLAUDE.md into one). Prefer zero new files? Plain markdown lints too. The deeper compiler-grade guarantees are the gradual, opt-in part — like TS's `strict`.
-- **Does it overwrite my files?** No. `init` adopts an existing CLAUDE.md _non-destructively_ — untouched until you `compile`, and `eject` reverses it.
-- **Need an API key?** No for almost everything (free, every commit). Real-model evals run on your Claude Pro/Max subscription — $0 metered tokens.
+- **Do I have to write TypeScript?** No — your agent writes the spec (`init` adopts your CLAUDE.md into one), or plain markdown lints with zero new files. Compiler-grade guarantees are opt-in, like TS's `strict`.
 - **Non-JS repo?** `npx vigiles lint` verifies your CLAUDE.md with no install (Ruff/Clippy/Pylint/… too).
 
 **[Full FAQ →](docs/faq.md)**
 
 ## More
 
-- **[CLI →](docs/cli.md)** — every command and the plugin · **[GitHub Action →](docs/github-action.md)** — run it in CI. The full **[lint rules matrix →](docs/verifying-instruction-files.md#the-validation-rules--the-full-matrix)** lives with the linting guide.
+- **[CLI →](docs/cli.md)** · **[GitHub Action →](docs/github-action.md)** · the full **[lint rules matrix →](docs/verifying-instruction-files.md#the-validation-rules--the-full-matrix)** lives with the linting guide.
 - **[Skills →](docs/skills.md)** — the skills `init` installs, and how the model-invocable ones trigger.
-- **[Ship plugins? The plugin-author guide →](docs/for-plugin-authors.md)** — scan a draft for structural health, make your skills fire for users, then rank a whole marketplace (0–100, A–F, worst issues first) — **no key**.
-- **[Docs index →](docs/README.md)** · **[API reference →](https://zernie.github.io/vigiles/)** · **[Related tools →](docs/related-tools.md)** (ast-grep, Dependency Cruiser, Ruler, rulesync).
-- **[Stability →](STABILITY.md)** — 0.x: the CLI is stable; the library API is still evolving; experimental surfaces are marked.
+- **[Ship plugins? The plugin-author guide →](docs/for-plugin-authors.md)** — scan a draft, make your skills fire, rank a whole marketplace — no key.
+- **[Docs index →](docs/README.md)** · **[API reference →](https://zernie.github.io/vigiles/)** · **[Related tools →](docs/related-tools.md)**.
+- **[Stability →](STABILITY.md)** — 0.x: the CLI is stable; the library API is still evolving.
 - **Not for you if** you want a model/capability benchmark or runtime guardrails in the request path — vigiles is build-/CI-time.
 - Companion to [Feedback Loop Is All You Need](https://zernie.com/blog/feedback-loop-is-all-you-need).
 

package/dist/audit-html.d.ts

@@ -5,16 +5,27 @@ import type { AuditReport } from "./audit-report.js";
  * we use `__dirname`, not `import.meta`.
  */
 export declare function templatePath(): string | null;
+/**
+ * Live-server info injected into the report when it's served by `audit --serve`
+ * (not a static file): the per-run token the report must send on every adopt
+ * POST. Absent for a plain static report — the buttons fall back to copy-command.
+ */
+export interface ServeInfo {
+    readonly token: string;
+}
 /**
  * Inject the report JSON into a template by replacing the quoted placeholder
  * string with the JSON object literal. Pure — the testable core. Throws if the
- * template is missing the placeholder.
+ * template is missing the placeholder. When `serve` is given (the `--serve`
+ * path), also sets `window.__VIGILES_SERVE__` so the report's adopt buttons POST
+ * to the local server instead of copying the command.
  */
-export declare function injectReportData(template: string, report: AuditReport): string;
+export declare function injectReportData(template: string, report: AuditReport, serve?: ServeInfo): string;
 /**
  * Render the self-contained HTML report (React template + injected data). Throws
  * if the template hasn't been built — the caller (writeAuditHtml) catches that and
- * skips the HTML, since the JSON + terminal report don't depend on it.
+ * skips the HTML, since the JSON + terminal report don't depend on it. Pass
+ * `serve` to render the live (`--serve`) variant whose buttons POST.
  */
-export declare function renderAuditHtml(report: AuditReport): string;
+export declare function renderAuditHtml(report: AuditReport, serve?: ServeInfo): string;
 //# sourceMappingURL=audit-html.d.ts.map

package/dist/audit-html.js

@@ -37,25 +37,34 @@ function escapeForScript(json) {
 /**
  * Inject the report JSON into a template by replacing the quoted placeholder
  * string with the JSON object literal. Pure — the testable core. Throws if the
- * template is missing the placeholder.
+ * template is missing the placeholder. When `serve` is given (the `--serve`
+ * path), also sets `window.__VIGILES_SERVE__` so the report's adopt buttons POST
+ * to the local server instead of copying the command.
  */
-function injectReportData(template, report) {
+function injectReportData(template, report, serve) {
     const re = new RegExp(`(["'])${PLACEHOLDER}\\1`);
     if (!re.test(template)) {
         throw new Error("audit report template is missing the data placeholder");
     }
-    return template.replace(re, escapeForScript(JSON.stringify(report)));
+    let out = template.replace(re, escapeForScript(JSON.stringify(report)));
+    if (serve) {
+        // Prepend the serve global onto the same statement that carries the data, so
+        // it's set before the app bundle reads it. The token is hex, but escape anyway.
+        out = out.replace("window.__VIGILES_DATA__", `window.__VIGILES_SERVE__=${escapeForScript(JSON.stringify(serve))};window.__VIGILES_DATA__`);
+    }
+    return out;
 }
 /**
  * Render the self-contained HTML report (React template + injected data). Throws
  * if the template hasn't been built — the caller (writeAuditHtml) catches that and
- * skips the HTML, since the JSON + terminal report don't depend on it.
+ * skips the HTML, since the JSON + terminal report don't depend on it. Pass
+ * `serve` to render the live (`--serve`) variant whose buttons POST.
  */
-function renderAuditHtml(report) {
+function renderAuditHtml(report, serve) {
     const p = templatePath();
     if (!p) {
         throw new Error("audit report template not built — run `npm run build` (builds report/), or use --json / --no-html");
     }
-    return injectReportData((0, node_fs_1.readFileSync)(p, "utf-8"), report);
+    return injectReportData((0, node_fs_1.readFileSync)(p, "utf-8"), report, serve);
 }
 //# sourceMappingURL=audit-html.js.map