create-agent-rig 0.4.0 → 0.6.0

package/templates/agent-os/universal/.claude/scripts/detect-missed-gate.mjs

@@ -104,6 +104,26 @@ export const parseElevatedPaths = (markdown) => {
   );
 };
 
+/**
+ * A decision record: `docs/decisions/<name>` at any depth, so both the root
+ * copy and the vendored template source match.
+ *
+ * Exported because `decision-router.mjs` needs the same notion, and two regexes
+ * for one invariant is the case `invariants.md` legislates against — the copy
+ * nobody is looking at is the one that goes wrong.
+ *
+ * `decisions` is matched as a whole path SEGMENT under a `docs` segment, never
+ * as a substring: `docs/decisions-overview.md` is ordinary documentation and
+ * must keep the cheap lane. Widening this to a substring would quietly pull
+ * every `docs/decisions*` name into the expensive gate.
+ *
+ * 🔴 Case-SENSITIVE, deliberately, and the caller decides. `normalizePath` in
+ * this file does not fold either — a sweep that folded would report a path the
+ * repository does not have. `decision-router.mjs` folds before calling this,
+ * because there folding can only escalate; here it could only mislabel.
+ */
+export const isDecisionRecord = (path) => /(^|\/)docs\/decisions\/[^/]/.test(path);
+
 /**
  * Paths that provision nothing and configure nothing, whatever directory they sit
  * in — EXCEPT the rulebook itself. Declaring `.claude/` as elevated was a no-op
@@ -121,13 +141,56 @@ export const parseElevatedPaths = (markdown) => {
  */
 const isRulebook = (path) =>
   path === 'CLAUDE.md' ||
+  path === 'AGENTS.md' ||
   path.endsWith('/CLAUDE.md') ||
+  path.endsWith('/AGENTS.md') ||
   path.startsWith('.claude/') ||
-  path.includes('/.claude/');
+  path.includes('/.claude/') ||
+  path.startsWith('.agents/') ||
+  path.includes('/.agents/') ||
+  path.startsWith('.codex/') ||
+  path.includes('/.codex/') ||
+  // The rationale extracted out of the rulebook is still rulebook. It left
+  // `.claude/` for `docs/decisions/` so that sessions stop paying to load it —
+  // not so that it stops being reviewed like the rule it explains.
+  isDecisionRecord(path);
+
+/**
+ * A document, for the sweep's question: *does this need a reviewer?* Both
+ * markdown flavours qualify — an `.mdx` page still needs no gate.
+ */
+const isDocument = (path) => /\.mdx?$/.test(path);
+
+/**
+ * A file that **executes nothing**, for the ration's question: *can a merge of
+ * this compound into a broken runtime overnight?* (`queue/state.mjs`, and
+ * `docs/decisions/spacing-rations-mechanisms.md` for why the ration asks that
+ * question at all.)
+ *
+ * 🔴 **It is `.md` only, and the missing `x` is the whole point.** MDX carries
+ * components and imports: it is a program that renders, not a document that is
+ * read — which is exactly why `decision-router.mjs` sends `.mdx` down the code
+ * lane (`docs/decisions/review-lanes.md`). A ration that called it prose would
+ * clear the spacing hold on a file this same rig treats as a program, and it
+ * would do so on the permissive side, which is the one direction that costs
+ * something.
+ *
+ * So **this file** carries two markdown predicates on purpose, side by side so
+ * they cannot drift apart, answering questions that genuinely differ: *needs no
+ * reviewer* is not *executes nothing*.
+ *
+ * ⚠ That is a statement about this file, **not** about the rig. Other markdown
+ * sets exist deliberately and must stay where they are — `decision-router.mjs`
+ * keeps its own, and `docs/decisions/review-lanes.md` exists precisely to stop
+ * someone consolidating them. Read that record before adding a fourth or
+ * "tidying" any of them: each mechanism's question is different, and every
+ * consolidation attempted so far would have silently downgraded a real review.
+ */
+export const executesNothing = (path) => /\.md$/.test(path);
 
 const isInert = (path) =>
   !isRulebook(path) &&
-  (/\.mdx?$/.test(path) ||
+  (isDocument(path) ||
   /(^|\/)(test|tests|__tests__)\//.test(path) ||
   /\.(test|spec)\.[cm]?[jt]sx?$/.test(path));
 

package/templates/agent-os/universal/.claude/scripts/doctor.mjs

@@ -0,0 +1,351 @@
+#!/usr/bin/env node
+// doctor — the harness audits itself (AR-5).
+//
+//   node .claude/scripts/doctor.mjs                 # the report, ready to paste
+//   node .claude/scripts/doctor.mjs --root <dir>    # audit another checkout
+//   node .claude/scripts/doctor.mjs --json
+//
+// One question, asked of every hook this project runs: **does the hook the
+// project OWNS have a test beside it?** The three-part pattern in
+// `.claude/rules/invariants.md` — a stated rule, a mechanical check, a test for
+// the check — is decoration with any part missing, and the part a rig loses
+// first is the third: the shipped hooks arrive with their tests in the generator
+// that produced them, and the moment one is edited its test is the rig's own.
+//
+// Ownership is read from `.claude/.rig-manifest.json`, the install manifest the
+// generator writes (its `files` map is install-relative path → sha256 of the
+// bytes it wrote). It is evidence, and three answers come out of it:
+//
+//   - `shipped`  — the bytes on disk still hash to the manifest's entry: the
+//                  hook is the generator's, tested upstream. Not a finding.
+//   - `owned`    — the hash differs, or the manifest has no entry for the file:
+//                  authored or edited here, so its test is this project's.
+//   - `unknown`  — there is no manifest to read (a pre-0.4.0 rig, or the
+//                  generator's own checkout). A hook with a test beside it still
+//                  passes — the test is there whoever owns it; one without is
+//                  reported `unknown`, never as a pass: "could not look" is not
+//                  "it is fine".
+//
+// The manifest is the only ownership source this script reads. The generator's
+// CLI also carries a hash history of every release for manifest-less rigs; it
+// lives in the CLI, and a rig script that re-implemented it would be a second
+// copy of a table nobody here maintains (`invariants.md`, "one mechanism, one
+// implementation"). A rig without a manifest gets `unknown` on every untested
+// hook and the advice to run `upgrade`, which writes one.
+//
+// A test neighbour is `<hook>.test.mjs` in the same directory — the shape
+// `.claude/skills/new-invariant/guard-invariant.example.test.mjs` prescribes and
+// `node --test` runs. Exemptions are an explicit file list with reasons, in
+// `.claude/doctor-exemptions.json` (`{ "<rel path>": "<reason>" }`): an exempt
+// hook is reported as `exempt` with its reason, an exemption with no reason is a
+// finding, and an exemption naming a file that is not there is a finding too —
+// a list that outlives what it exempts is how a check goes quiet by accident.
+//
+// Scope: every `.mjs` directly in `.claude/hooks/` (not `*.test.mjs`, not
+// `lib/`), and EVERY file directly in `.husky/` when that directory exists — a
+// husky hook is never in the manifest, so it is `owned` whenever ownership can
+// be read at all, and a stray file there (a README, a dotfile) is audited like a
+// hook — the generator's `test/template/doctor.test.ts` › "audits every file in
+// .husky/ as a hook — a stray README there is a finding until it is exempted
+// with a reason" pins it: exempt it with a reason rather than teaching this
+// script which names are not hooks. One entry that cannot be stat'ed (a
+// dangling symlink) is reported by name and the rest of the listing survives —
+// › "a dangling symlink among the hooks is reported by name as unreadable, and
+// never nulls the listing". A `.claude/hooks/` that is missing or unreadable is a FAIL and the
+// run is STOP — a doctor that looked nowhere must never say clean — and so is
+// an exemption file that is present but not readable JSON. When `.husky/` is absent the report says so rather than
+// staying silent about a directory it never looked at — the generator's
+// `test/template/doctor.test.ts` › "names an absent .husky/ instead of staying
+// silent about it" pins the line.
+//
+// 🔴 What this script does NOT check is printed at the end of every report, the
+// same way `preflight.mjs` prints its unchecked items: a script that half-checks
+// is only safe while the boundary is visible.
+import { createHash } from 'node:crypto';
+import { existsSync, readdirSync, readFileSync, realpathSync, statSync } from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+export const MANIFEST_REL = '.claude/.rig-manifest.json';
+export const EXEMPTIONS_REL = '.claude/doctor-exemptions.json';
+export const HOOKS_DIR = '.claude/hooks';
+export const HUSKY_DIR = '.husky';
+
+/** What this script cannot decide from the file system alone. */
+export const UNCHECKED = [
+  'that the neighbour test exercises the hook it sits beside — a file named ' +
+    '`<hook>.test.mjs` that asserts nothing satisfies this check; run `node --test` on it',
+  'that the hook is wired in .claude/settings.json (or .codex/hooks.json) — an ' +
+    'unwired hook passes its own test and guards nothing',
+  'that a `shipped` hook still matches the rule it enforces — the manifest says ' +
+    'the bytes are the generator’s, not that the generator’s rule is this project’s',
+];
+
+export const sha256 = (data) => createHash('sha256').update(data).digest('hex');
+
+/**
+ * Who owns a hook, from the manifest's evidence.
+ *
+ * `recorded` is the manifest's hash for the file, `undefined` when the manifest
+ * has no entry, and `null` when there is no manifest at all — three inputs that
+ * must stay three, because collapsing "no entry" into "no manifest" would read
+ * an authored hook as unknowable, and the reverse would read a manifest-less
+ * rig's every hook as authored here.
+ */
+export const ownershipOf = ({ recorded, actual }) => {
+  if (recorded === null) return 'unknown';
+  if (typeof recorded === 'string' && recorded === actual) return 'shipped';
+  return 'owned';
+};
+
+/** The test neighbour's path: `guard-x.mjs` → `guard-x.test.mjs`, `pre-commit` → `pre-commit.test.mjs`. */
+export const neighbourOf = (rel) => {
+  const dir = path.posix.dirname(rel);
+  const base = path.posix.basename(rel);
+  const stem = base.endsWith('.mjs') ? base.slice(0, -'.mjs'.length) : base;
+  return path.posix.join(dir, `${stem}.test.mjs`);
+};
+
+/** The same ladder `preflight.mjs` uses: any FAIL stops, any unknown cautions. */
+export const verdictOf = (marks) => {
+  if (marks.some((mark) => mark === 'FAIL')) return 'STOP';
+  if (marks.some((mark) => mark === 'unknown')) return 'CAUTION';
+  return 'GO';
+};
+
+/**
+ * Control bytes stripped before a string from a repo file reaches the terminal
+ * (the same concern `queue/core.mjs` › printable has): an exemption reason
+ * carrying an escape sequence could repaint the line above it. Printable
+ * Unicode stays — a reason is prose.
+ */
+// eslint-disable-next-line no-control-regex -- the control range IS the subject of this regex
+export const printable = (text) => String(text).replace(/[\x00-\x1F\x7F-\x9F]/g, '');
+
+const reasonOf = (exemptions, rel) => {
+  if (!exemptions || typeof exemptions !== 'object' || Array.isArray(exemptions)) return undefined;
+  return Object.prototype.hasOwnProperty.call(exemptions, rel) ? exemptions[rel] : undefined;
+};
+
+/**
+ * The audit, pure: hooks in, marks out. Each hook is `{ rel, ownership,
+ * hasTest }`; each result adds `mark` (`pass` | `FAIL` | `unknown` | `exempt`)
+ * and a `detail` a reader can act on.
+ *
+ * Bounded by construction: one pass over the hooks, one over the exemptions.
+ */
+export const auditHooks = ({ hooks = [], exemptions = {} } = {}) => {
+  const seen = new Set();
+  const results = [];
+  for (const hook of hooks) {
+    const { rel, ownership, hasTest } = hook;
+    seen.add(rel);
+    const reason = reasonOf(exemptions, rel);
+    const exempt = reason !== undefined;
+    let mark;
+    let detail;
+    if (exempt && (typeof reason !== 'string' || reason.trim() === '')) {
+      mark = 'FAIL';
+      detail = `exempted without a reason in ${EXEMPTIONS_REL} — an exemption is a file AND why`;
+    } else if (hasTest) {
+      mark = 'pass';
+      detail =
+        ownership === 'shipped'
+          ? `test neighbour ${neighbourOf(rel)} (and the generator’s upstream tests)`
+          : `test neighbour ${neighbourOf(rel)}`;
+    } else if (ownership === 'shipped') {
+      mark = 'pass';
+      detail = 'unchanged since install — tested upstream, in the generator that produced it';
+    } else if (exempt) {
+      mark = 'exempt';
+      detail = `no test neighbour; exempt — ${printable(reason.trim())}`;
+    } else if (ownership === 'owned') {
+      mark = 'FAIL';
+      detail =
+        `owned here (${'edited or authored in this project'}) and no ${neighbourOf(rel)} — ` +
+        'copy .claude/skills/new-invariant/guard-invariant.example.test.mjs beside it';
+    } else {
+      mark = 'unknown';
+      detail =
+        `no ${MANIFEST_REL} to say who owns it, and no ${neighbourOf(rel)} — ` +
+        'not a pass; `upgrade` writes a manifest, or add the test';
+    }
+    results.push({ rel, ownership, hasTest, mark, detail });
+  }
+  if (exemptions && typeof exemptions === 'object' && !Array.isArray(exemptions)) {
+    for (const rel of Object.keys(exemptions)) {
+      if (seen.has(rel)) continue;
+      results.push({
+        rel: printable(rel),
+        ownership: 'absent',
+        hasTest: false,
+        mark: 'FAIL',
+        detail: `stale-exemption: ${EXEMPTIONS_REL} names a file this audit did not find — remove the entry`,
+      });
+    }
+  }
+  return { verdict: verdictOf(results.map((r) => r.mark)), hooks: results };
+};
+
+// --- the file-system half -----------------------------------------------------
+
+const readJson = (file) => {
+  try {
+    return JSON.parse(readFileSync(file, 'utf8'));
+  } catch {
+    return null;
+  }
+};
+
+/** The manifest's `files` map, or `null` when there is nothing trustworthy to read. */
+export const manifestFilesOf = (root) => {
+  const parsed = readJson(path.join(root, ...MANIFEST_REL.split('/')));
+  const files = parsed?.files;
+  if (!files || typeof files !== 'object' || Array.isArray(files)) return null;
+  return files;
+};
+
+/**
+ * The files directly in `dir`: `{ names, unreadable }`, or `null` when the
+ * directory itself cannot be listed. One entry that cannot be stat'ed (a dangling
+ * symlink) is reported by name, never allowed to null the whole listing.
+ */
+const listFiles = (dir) => {
+  let entries;
+  try {
+    entries = readdirSync(dir).sort();
+  } catch {
+    return null;
+  }
+  const names = [];
+  const unreadable = [];
+  for (const name of entries) {
+    try {
+      if (statSync(path.join(dir, name)).isFile()) names.push(name);
+    } catch {
+      unreadable.push(name);
+    }
+  }
+  return { names, unreadable };
+};
+
+/** A finding the audit itself raises — a scope it could not read. */
+const problem = (rel, detail) => ({ rel, ownership: 'absent', hasTest: false, mark: 'FAIL', detail });
+
+/** Every hook in scope, as `{ rel, ownership, hasTest }`, plus the scopes it looked at. */
+export const collectHooks = (root) => {
+  const files = manifestFilesOf(root);
+  const hooks = [];
+  const scopes = [];
+  const problems = [];
+  const hookDir = listFiles(path.join(root, ...HOOKS_DIR.split('/')));
+  scopes.push({ dir: HOOKS_DIR, present: hookDir !== null });
+  if (hookDir === null) {
+    // Not a rig, or not the directory the caller meant: never a clean report.
+    problems.push(problem(HOOKS_DIR, `not found or unreadable under ${root} — nothing was audited`));
+  }
+  for (const name of hookDir?.names ?? []) {
+    if (!name.endsWith('.mjs') || name.endsWith('.test.mjs')) continue;
+    hooks.push(`${HOOKS_DIR}/${name}`);
+  }
+  const husky = listFiles(path.join(root, HUSKY_DIR));
+  scopes.push({ dir: HUSKY_DIR, present: husky !== null });
+  for (const name of husky?.names ?? []) {
+    if (name.endsWith('.test.mjs')) continue;
+    hooks.push(`${HUSKY_DIR}/${name}`);
+  }
+  for (const [dir, listing] of [
+    [HOOKS_DIR, hookDir],
+    [HUSKY_DIR, husky],
+  ]) {
+    for (const name of listing?.unreadable ?? []) {
+      problems.push(problem(`${dir}/${printable(name)}`, 'cannot be read (a dangling symlink?) — not audited, not a pass'));
+    }
+  }
+  return {
+    scopes,
+    problems,
+    hooks: hooks.map((rel) => {
+      const actual = sha256(readFileSync(path.join(root, ...rel.split('/'))));
+      const recorded = files === null ? null : files[rel];
+      return {
+        rel,
+        ownership: ownershipOf({ recorded, actual }),
+        hasTest: existsSync(path.join(root, ...neighbourOf(rel).split('/'))),
+      };
+    }),
+  };
+};
+
+export const report = (root) => {
+  const { hooks, scopes, problems } = collectHooks(root);
+  // One read, two outcomes: absent is an empty list, present-but-unreadable is a
+  // finding. Testing for existence first and reading second would be two truths.
+  let exemptions = {};
+  let raw = null;
+  try {
+    raw = readFileSync(path.join(root, ...EXEMPTIONS_REL.split('/')), 'utf8');
+  } catch (error) {
+    if (error?.code !== 'ENOENT') {
+      problems.push(problem(EXEMPTIONS_REL, `present but unreadable — ${error?.code ?? 'read failed'}`));
+    }
+  }
+  if (raw !== null) {
+    let parsed;
+    try {
+      parsed = JSON.parse(raw);
+    } catch {
+      parsed = null;
+    }
+    if (parsed && typeof parsed === 'object' && !Array.isArray(parsed)) exemptions = parsed;
+    else problems.push(problem(EXEMPTIONS_REL, 'present but unreadable — not JSON, or not an object of path → reason'));
+  }
+  const audited = auditHooks({ hooks, exemptions });
+  const all = [...problems, ...audited.hooks];
+  const audit = { verdict: verdictOf(all.map((r) => r.mark)), hooks: all };
+  const absent = scopes.filter((scope) => !scope.present && scope.dir !== HOOKS_DIR).map((scope) => scope.dir);
+  const lines = [
+    `**doctor** — verdict: ${audit.verdict}`,
+    '',
+    // Names come from the file system, reasons from a repo file; both are
+    // stripped of control bytes here, once, where they reach the terminal.
+    ...audit.hooks.map((hook) => `- ${hook.mark} · ${printable(hook.rel)} — ${printable(hook.detail)}`),
+    ...(absent.length > 0
+      ? ['', `_Not present, so not audited: ${absent.join(', ')}._`]
+      : []),
+    '',
+    `_Not checked by this script — still yours (${UNCHECKED.length}):_`,
+    ...UNCHECKED.map((item) => `- ${item}`),
+  ];
+  return { ...audit, scopes, unchecked: UNCHECKED, rendered: lines.join('\n') };
+};
+
+const invokedDirectly = () => {
+  if (!process.argv[1]) return false;
+  const real = (p) => {
+    try {
+      return realpathSync(p);
+    } catch {
+      return p;
+    }
+  };
+  return real(fileURLToPath(import.meta.url)) === real(process.argv[1]);
+};
+
+if (invokedDirectly()) {
+  const args = process.argv.slice(2);
+  const rootIndex = args.indexOf('--root');
+  const rootArg = rootIndex === -1 ? null : args[rootIndex + 1];
+  if (rootIndex !== -1 && (rootArg === undefined || rootArg.startsWith('--'))) {
+    process.stderr.write('doctor: --root needs a directory — auditing the working directory instead would be a guess\n');
+    process.exit(1);
+  }
+  const root = path.resolve(rootArg ?? process.cwd());
+  const result = report(root);
+  process.stdout.write(
+    args.includes('--json')
+      ? `${JSON.stringify({ verdict: result.verdict, hooks: result.hooks, scopes: result.scopes, unchecked: result.unchecked }, null, 2)}\n`
+      : `${result.rendered}\n`,
+  );
+  process.exit(result.verdict === 'STOP' ? 1 : 0);
+}

package/templates/agent-os/universal/.claude/scripts/git-env.mjs

@@ -0,0 +1,49 @@
+/**
+ * The environment a child `git` should run with — one implementation, imported.
+ *
+ * 🔴 **Why this is not inlined at each call site.** A process started under a
+ * git hook inherits `GIT_DIR` and `GIT_INDEX_FILE`, and any child then answers
+ * confidently about a repository its caller is not in — `rev-parse` comparing
+ * another repo's refs, `fetch` writing into it. This repository has the scar:
+ * NOTES.md's `GIT_DIR` incident, 19 junk commits across two branches.
+ *
+ * ⚠ **Both forms occur, and assuming either one is how this gets skipped.**
+ * Measured on git 2.47.1: a hook in the main checkout exports
+ * `GIT_INDEX_FILE=.git/index` — relative, so a child that changes directory
+ * resolves it against the wrong root. A hook in a **linked worktree** exports
+ * an absolute `GIT_DIR=/…/.git/worktrees/<name>`, which redirects the child
+ * **whatever its `cwd` is**. So "my child runs in the same directory" is not a
+ * reason to skip sanitising, and the worktree case — the one the queue seam
+ * exists for — is precisely the absolute one.
+ *
+ * 🔴 **The list is explicit, and a `GIT_*` prefix sweep is the wrong shape.**
+ * Only repository *location* is stripped. `GIT_SSH_COMMAND`, `GIT_ASKPASS` and
+ * `GIT_TERMINAL_PROMPT` are the caller's environment and none of our business,
+ * and `GIT_CONFIG_GLOBAL` / `GIT_CONFIG_COUNT` are how containers and CI inject
+ * `safe.directory` for a checkout owned by another uid — sweep those away and
+ * git exits 128 on *dubious ownership*, which a caller that falls back quietly
+ * turns straight back into the bug it was guarding against.
+ *
+ * ⚠ **Limit, stated because it bounds what this buys you:** sanitising here
+ * protects only the spawns that call it. A call site that forgets is
+ * unprotected and nothing in this module can detect that —
+ * `test/template/git-env.test.ts` sweeps for exactly that, and a new git spawn
+ * belongs on its list the day it is written.
+ */
+
+export const GIT_LOCATION_VARS = Object.freeze([
+  'GIT_DIR',
+  'GIT_WORK_TREE',
+  'GIT_INDEX_FILE',
+  'GIT_COMMON_DIR',
+  'GIT_OBJECT_DIRECTORY',
+  'GIT_ALTERNATE_OBJECT_DIRECTORIES',
+  'GIT_NAMESPACE',
+  'GIT_PREFIX',
+]);
+
+export const withoutGitLocation = (env = process.env) => {
+  const sanitised = { ...env };
+  for (const key of GIT_LOCATION_VARS) delete sanitised[key];
+  return sanitised;
+};