vigiles 7.0.0 → 8.0.0

package/README.md

@@ -1,3 +1,44 @@
+<!--
+  README DIRECTION — read before editing; keep changes aligned.
+  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. COMPILED SPECS ARE EASY — reassure, never intimidate. You rarely hand-write
+     a .spec.ts: model-invocable skills (edit-spec / strengthen / test-harness)
+     author + edit it, and hooks auto-compile on save. Present the typed spec as
+     the SMOOTH, AUTO-ENFORCED next step you don't think about — the natural
+     evolution (JS→TS: gradual, strict opt-in), NEVER a wall. Markdown + inline
+     mode work with zero TS for anyone not there yet (progressive adoption).
+  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).
+-->
+
 <p align="center">
   <img src="logo.png" width="140" alt="vigiles logo" />
 </p>
@@ -8,10 +49,6 @@
   <strong>Make the harness your AI agent runs on reliable.</strong>
 </p>
 
-<p align="center">
-  Your CLAUDE.md, hooks, and skills steer the agent — but nothing checks they're <em>true</em>, nothing stops them entering a <em>bad state</em>, nothing tests they <em>work</em>, and nothing measures whether they actually <em>help</em>. vigiles does all four — deterministically, mostly with no API key.
-</p>
-
 <p align="center">
   <a href="https://www.npmjs.com/package/vigiles"><img src="https://img.shields.io/npm/v/vigiles?color=orange" alt="npm version" /></a>
   <a href="https://github.com/zernie/vigiles/actions"><img src="https://img.shields.io/github/actions/workflow/status/zernie/vigiles/ci.yml?branch=main" alt="CI" /></a>
@@ -20,47 +57,83 @@
 
 ---
 
-`Agent = Model + Harness`. The model gets the headlines; the **harness** — the
-instruction files, hooks, and skills you actually control — is the half that
-fails silently. vigiles[^name] turns that harness into a compilable, analyzable,
-testable object instead of vibes. Four instruments, adopt any:
+**You installed a bunch of plugins and wrote a few skills — but do they actually work?**
+A skill that never fires, a safety hook that blocks nothing, a CLAUDE.md full of dead
+references — your harness fails **silently**, and you find out mid-task.
 
-|              |                                                                                                                                                                                                                                                                                           |
-| ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **🔎 Lint**  | Every file path, script, code symbol, and linter rule your CLAUDE.md cites is checked against reality — a lint that asks _is this **true**_, not just _well-formed_ — so a renamed file or a disabled rule can't silently mislead the agent. **[→](docs/verifying-instruction-files.md)** |
-| **🛡 Guard** | Author a hook as a pure typed function and vigiles compiles it — making **whole classes of hook bugs unrepresentable** (the guard that silently doesn't block). **[→](docs/compiled-hooks.md)**                                                                                           |
-| **🧪 Test**  | Hooks, skills, and subagents are code. vigiles tests they _do their job_ — and almost all of it is **deterministic, no API key**; the real-model evals run on your **Claude subscription**, not metered tokens. **[→](docs/harness-testing.md)**                                          |
-| **📊 Eval**  | Does that skill or plugin actually help — or just add cost? **A/B it on real tasks** and read the bill + correctness, not the vendor's headline — the eval you can afford. The same engine ranks the hyped ecosystem: **what works vs hype**. **[→](docs/measuring-skills.md)**           |
+**It's a library with no tests.**
 
-Pick the one that hurts today. **Works with Claude Code and Codex**
-([`vigiles/codex`](docs/harnesses.md)), and you can
-[teach it your own harness](docs/authoring-an-adapter.md).
+`Agent = Model + Harness` — the model gets the headlines, the harness is the half you
+own. vigiles[^name] makes it prove itself **before the agent ever runs** — verify, test,
+measure. Mostly free, no API key — real-model checks run on your **Claude Pro/Max
+subscription, not metered tokens**.
+
+Three instruments, adopt any:
+
+|             |                                                                                                                                                 |
+| ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
+| **🔎 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)** |
+-->
+
+<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). -->
+
+**Two ways in** — pick the pain that's yours:
+
+- **Run agents on your own repo?** Start with **Lint** below, or `npx vigiles init`.
+- **Ship plugins to a marketplace?** **[`vigiles scan`](docs/for-plugin-authors.md)**
+  ranks structural health with no key — see the **[plugin-author guide →](docs/for-plugin-authors.md)**.
+
+**Your agent writes the spec — and you can always eject.** You rarely hand-write a
+`.spec.ts`: skills author it 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. **Claude Code and
+Codex** ([`vigiles/codex`](docs/harnesses.md)), or [your own
+harness](docs/authoring-an-adapter.md). _(New here? [the FAQ](docs/faq.md) covers the
+"do I write TypeScript / will it touch my files" questions.)_
 
 ## Quick start
 
 **Paste into Claude Code or Codex:**
 
 ```text
-Set up vigiles in this repo with good defaults (lint + test, non-interactive).
-Verify my CLAUDE.md / AGENTS.md references and show me what's stale, then write
-and run a harness test for one of my hooks or skills. Ask me first before gating
-it in CI, adding a real-model eval, or enforcing strictly (--strict).
+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 same prompt works in Codex.
+
 Or do it yourself:
 
 ```bash
 npx vigiles init   # sets up lint + test: spec + harness test + CI + plugin
 ```
 
-Interactive in a terminal, non-interactive for agents/CI (or `--yes`). It installs
-a model-invocable **`test-harness` skill** too, so you can then tell your agent
-_"test my skills"_ and it writes the test.
+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.
 
@@ -71,10 +144,10 @@ Prefer to write tests yourself? They can be JS **or** TS
 
 ## ① Lint — your CLAUDE.md lies to your agent
 
-Your CLAUDE.md points the agent at `src/auth/login.ts` and says to 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:
+**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:
 
 ```text
 CLAUDE.md:
@@ -83,57 +156,25 @@ CLAUDE.md:
   ✓ @typescript-eslint/no-floating-promises — exists and enabled in eslint config
 ```
 
-File paths, scripts, and code symbols — plus linter rules across **7 catalogs**
-(the rule exists **and is enabled**). Start with one inline comment, no new files;
-step up to a typed `.spec.ts` (compiled to CLAUDE.md) when you want it.
-**[Full guide →](docs/verifying-instruction-files.md)**
-
-> **Markdown is prose; a typed spec is a _program_.** Opt in and an agent that
-> leaks or hands off mismatched data is a **type error** — your multi-agent
-> pipeline won't compile if the handoffs don't line up. Others lint prose; vigiles
-> is a **compiler for harnesses**, graduated like `strict`. **[The moat →](research/typed-spec-moat.md)**
-
-**Same cross-reference, any plugin.** `npx vigiles scan` checks a plugin's
-_contracts_ — every subagent tool, `mcp__server__tool`, `mcp_tool` hook, hook
-event, and script path actually **exists and resolves**, not just parses (valid
-YAML ≠ a real tool). A **superset of `claude plugin validate`**, no key. **[Audit any plugin →](docs/cli.md#scan-dir)**
-
-## ② Guard — author a hook that can't be wrong
-
-A safety hook is the one place that can _stop_ the agent before something
-irreversible — yet hand-written hooks fail silently (`exit 1` not `2`, the wrong
-JSON field, a `grep` that misses `cd x && git push -f`): they look like a guard
-and block nothing. Write the hook as a pure typed function instead — vigiles
-compiles the protocol for you:
-
-```typescript
-import { defineHook, tool, deny, allow } from "vigiles/hook";
+File paths, scripts, code symbols — plus linter rules across **7 linters**
+(ESLint, Ruff, Clippy + four more): each rule exists **and is enabled**.
 
-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(),
-});
-```
+**Start with one inline comment — no new files.** Step up to a typed `.spec.ts`
+(your agent writes it; it compiles to CLAUDE.md) when you want compiler-grade
+guarantees — and `vigiles eject` hands it back to plain markdown anytime.
+**[Full guide →](docs/verifying-instruction-files.md)**
 
-This **eliminates an entire class of bugs**: you never write the exit code / JSON
-field (false confidence), the matcher is **AST-backed** (catches the compound
-bypass a glob misses), the only import allowed is `vigiles/hook` (capability = API
-surface), and the artifact is **stamped** (a later hand-edit is refused). A real,
-widely-copied OSS safety hook blocks **2/7** of the disaster battery; the compiled
-rewrite blocks **7/7**. Honest about the cons: 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)**
+> **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)**
 
-## ③ Test — does your harness do its job?
+## ② Test — does your harness do its job?
 
-A hook can be wired wrong; a skill's description can fail to trigger — or hijack
-unrelated prompts; injected context can never reach the model. All of it passes a
-naive "did it run?" check. vigiles tests the assembled harness for real:
+**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:
 
 ```typescript
 import { runHook } from "vigiles/testing";
@@ -157,11 +198,11 @@ Almost every tier runs with **no model and no API key** — milliseconds, on eve
 commit; only the real-model evals need a model, on your own `claude` CLI.
 **[How it works →](docs/harness-testing.md)**
 
-## ④ Eval — does it actually help, or just cost more?
+## ③ Eval — does it actually help, or just cost more?
 
-A skill claims "65% fewer tokens." A plugin promises "3× faster." Stars and
-vibes — **zero measurement**. vigiles A/Bs the claim on real coding tasks, the
-harness loaded exactly as it ships, and reports the **metric triple**:
+**"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 the **metric triple**:
 
 ```typescript
 import { measureArms } from "vigiles/testing";
@@ -178,20 +219,70 @@ const r = await measureArms({
 - **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**.
 
-The kicker: every run is **your own `claude` CLI on your Pro/Max subscription**,
-so you can measure on every change — and the same engine powers the **ecosystem
-benchmark** ("what works vs hype"). **[Eval a skill →](docs/measuring-skills.md)** · **[Why it's affordable →](docs/eval-architecture.md)**
+**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)**
+
+<!-- PARKED FOR LAUNCH — Guard / compiled hooks. Re-add this whole section (and the table row above) post-HN. See research/roadmap.md "Launch readiness".
+
+## ④ Guard — a safety hook that can't silently fail open
+
+**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:
+
+```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(),
+});
+```
+
+**The proof:** a widely-copied OSS safety hook blocks **2/7** of the disaster
+battery. The compiled rewrite blocks **7/7** — measured, not asserted.
+
+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.
+
+_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)**
+
+-->
+
+## 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. Lint your markdown with zero new files; when you want a spec, your agent writes it. It's gradual, 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.
+- **Non-JS repo?** `npx vigiles lint` verifies your CLAUDE.md with no install (Ruff/Clippy/Pylint/… too).
 
-**The eval you can actually afford.** promptfoo / DeepEval / … hit a metered API
-SDK and bill **per token, every run**; vigiles answers most questions with **no
-model at all** and runs the rest on **your Claude Pro/Max subscription — $0 extra**.
+**[Full FAQ →](docs/faq.md)**
 
 ## More
 
-- **[Plugin health leaderboard →](docs/cli.md#scan-dir)** — point `scan` at a marketplace (e.g. `wshobson/agents`) and it ranks every plugin by structural health (0–100, A–F), worst issues first — **no key**. Add `--trigger` for the model-gated column: do the skills actually fire?
-- **[CLI & GitHub Action →](docs/cli.md)** — every command (incl. compiled hooks via `compile`), the Action, and the plugin. 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)** — consumer skills installed as a Claude Code plugin. The model-invocable ones (`test-harness`, `strengthen`, `edit-spec`) fire on their own — ask _"test my skills"_ and the agent reaches for them.
-- **[Docs index →](docs/README.md)** · **[Research →](research/README.md)** · **[API reference →](https://zernie.github.io/vigiles/)** (generated) · **[Related tools →](docs/related-tools.md)** (ast-grep, Dependency Cruiser, Ruler, rulesync).
+- **[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.
+- **[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.
+- **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).
 
 ## License

package/dist/cli-commands.d.ts

@@ -11,7 +11,7 @@
  * recognizes exactly these, so this list can't silently drift from the code.
  */
 /** Human-facing verbs (printed in help; typed by a human/agent/CI). */
-export declare const VERBS: readonly ["init", "compile", "lint", "refs", "test", "eval", "scan", "measure", "explain", "scaffold-test", "generate-types", "generate-schema", "generate-harness", "hook-runtime"];
+export declare const VERBS: readonly ["init", "compile", "eject", "lint", "test", "eval", "scan", "scaffold-test", "generate", "hook-runtime"];
 /** Runtime entrypoint kinds under `vigiles hook-runtime <kind>` (emitted, not typed). */
 export declare const HOOK_RUNTIME_KINDS: readonly ["run-program", "agent", "agent-start", "agent-done", "skill", "skill-tool", "skill-start", "skill-done", "run-skill", "intercept-tool", "guard", "action", "refs", "effect-enter", "effect-exit"];
 export type Verb = (typeof VERBS)[number];

package/dist/cli-commands.js

@@ -17,17 +17,13 @@ exports.HOOK_RUNTIME_KINDS = exports.VERBS = void 0;
 exports.VERBS = [
     "init",
     "compile",
+    "eject",
     "lint",
-    "refs",
     "test",
     "eval",
     "scan",
-    "measure",
-    "explain",
     "scaffold-test",
-    "generate-types",
-    "generate-schema",
-    "generate-harness",
+    "generate",
     "hook-runtime",
 ];
 /** Runtime entrypoint kinds under `vigiles hook-runtime <kind>` (emitted, not typed). */

package/dist/cli.d.ts

@@ -6,7 +6,7 @@
  *   vigiles init            — scaffold a spec from scratch
  *   vigiles compile         — compile .spec.ts → .md with linter verification
  *   vigiles lint            — verify hashes, report coverage, detect duplicates
- *   vigiles generate-types  — emit .d.ts with types from project state
+ *   vigiles generate types  — emit .d.ts with types from project state
  */
 export {};
 //# sourceMappingURL=cli.d.ts.map