rcf-lite 0.0.1 → 0.7.1

package/README.md

@@ -1,8 +1,96 @@
 # rcf-lite
 
-This package name is reserved for RCF Lite, the Requirements Confidence Framework lite suite from Stravica.
+[![ci](https://github.com/Stravica/rcf-lite/actions/workflows/ci.yml/badge.svg)](https://github.com/Stravica/rcf-lite/actions/workflows/ci.yml)
+[![npm version](https://img.shields.io/npm/v/rcf-lite)](https://www.npmjs.com/package/rcf-lite)
+[![license](https://img.shields.io/badge/license-Apache--2.0-blue)](./LICENSE)
+[![node](https://img.shields.io/badge/node-%3E%3D24-brightgreen)](https://nodejs.org)
 
-The first real release lands here as version 0.7.1, a repackage of the current published suite. Until then, install `@stravica-ai/rcf-build-lite`.
+Build software with an AI coding agent without losing the plot.
 
-- Source: https://github.com/Stravica/rcf-lite
-- About RCF: https://stravica.ai
+Anyone who has shipped with a coding agent knows the failure mode: the code arrives fast, but what the product is supposed to do lives in prompt history, and prompt history is not a spec. Three weeks later nobody can say what is covered, what is tested, or what breaks when something changes.
+
+RCF Lite keeps those answers machine-checkable. It maintains a live chain from what you asked for, through requirements, user stories, acceptance criteria and tests, into the code itself, as plain JSON files in your own repository. Your agent works the chain instead of improvising; `rcf validate` catches drift the moment it happens; and when your app is deployed, `rcf verify` sends an independent verifier at it before anything gets called done.
+
+It is the tooling for the [Requirements Confidence Framework (RCF)](https://stravica.ai/rcf-methodology): a method for keeping AI-built software honest.
+
+## Start here
+
+Three steps before you start your coding agent, then one prompt inside the session.
+
+1. Install the CLI:
+
+   ```sh
+   npm install -g rcf-lite
+   ```
+
+   That single install brings both the build-stage CLI (`rcf`) and the ship-gate verifier (`rcf verify`, plus the transition-grace `rcf-verify` alias) in one package.
+
+2. In your project directory, run `rcf init` (or `npx rcf-lite init` without the install). One command sets everything up: the requirements files, the MCP server entry and your agent's instructions.
+
+3. Start your coding agent session in that directory (or restart the one you have open, so it picks up the new configuration).
+
+Then hand your agent this prompt, filled in. The setup you just ran has already taught it how to work; all it needs from you is the idea:
+
+```text
+I want to build [describe your product idea in a sentence or two].
+Let's get started.
+```
+
+If you'd rather drive it by hand, [docs/getting-started.md](docs/getting-started.md) covers the same ground at human pace. Prerequisites, install checks and agent-harness wiring live in [docs/install.md](docs/install.md).
+
+## Migrating from the pre-0.7.1 packages
+
+If your project pinned one of the pre-consolidation packages, replace it with `rcf-lite`:
+
+| Old pin                              | New pin                                |
+|--------------------------------------|----------------------------------------|
+| `@stravica-ai/rcf-build-lite`        | `rcf-lite`                             |
+| `@stravica-ai/rcf-verify-lite`       | `rcf-lite` (verify is a subcommand now) |
+| `@stravica-ai/rcf-lite-core`         | `rcf-lite` (core is an internal module) |
+
+Invocation:
+
+- `rcf init` / `rcf validate` / `rcf build` / `rcf finalise` are unchanged.
+- Prefer `rcf verify <run|report|provision|cleanup|mcp>` over the legacy `rcf-verify` bin. The alias still works (identical dispatch, one-line stderr deprecation notice on direct invocation; suppress with `RCF_QUIET=1`).
+
+The full migration story, the ratified ruling sheet and the registry runbook live at the repo root under [`docs/`](../../docs/).
+
+## This repo runs on it
+
+The umbrella's own PRD, requirements, user stories, acceptance criteria, architecture and build queue live as JSON under [`rcf/`](./rcf), validated against the open [`@stravica-ai/rcf-schemas`](https://github.com/Stravica/rcf-schemas). The build queue in there is the one that drove the tool's own development. The artefacts are the demo.
+
+See them the way you'd see your own project's:
+
+```sh
+git clone https://github.com/Stravica/rcf-lite.git
+cd rcf-lite && pnpm install
+cd packages/rcf-lite
+pnpm rcf view     # the tree this tool was built from, rendered live in your browser
+```
+
+Then scaffold your own: [docs/getting-started.md](docs/getting-started.md).
+
+## Docs
+
+| Doc | One line |
+|---|---|
+| [docs/install.md](docs/install.md) | Prerequisites, install, verify, wire into an agent harness |
+| [docs/getting-started.md](docs/getting-started.md) | Empty directory to a validated, queried, building RCF project |
+| [docs/how-it-works.md](docs/how-it-works.md) | The document chain, the files, the verbs, the agent contract |
+| [docs/why-it-exists.md](docs/why-it-exists.md) | The confidence gap, and why files plus a CLI is the answer |
+| [docs/code-nodes.md](docs/code-nodes.md) | The spec-to-code bridge: Code Nodes, staleness detection, the mark-complete gate, honest limits |
+| [docs/verify-reference.md](docs/verify-reference.md) | The verify subcommand tree (run, report, provision, cleanup, mcp) in detail |
+
+[docs/README.md](docs/README.md) is the index; `rcf help <verb>` is the flag reference; [guidance/](guidance/README.md) is the agent-facing method pack.
+
+## Under the hood
+
+The chain does not stop at the tests. **Code Nodes** make source files first-class nodes in the same graph, so a dangling spec-to-code link fails `rcf validate` exactly the way a dangling spec-to-spec one does. `rcf trace` walks backward from a source file to the requirements it serves; `rcf impact` extends a change's blast radius into the code that implements it. Spec-only trees work unchanged; the code layer is additive. Full detail, deliberate limits and the roadmap beyond them: [docs/code-nodes.md](docs/code-nodes.md).
+
+## Contributing
+
+Not accepting external code contributions at this stage of the project. Bug reports and feature discussion via [Issues](https://github.com/Stravica/rcf-lite/issues) are welcome. [CONTRIBUTING.md](./CONTRIBUTING.md) covers the development setup and house rules that will apply when that changes.
+
+## License
+
+Apache 2.0. See [LICENSE](./LICENSE).

package/bin/rcf-verify.js

@@ -0,0 +1,122 @@
+#!/usr/bin/env node
+// The `rcf-verify` alias bin. Post 0.7.1 packaging consolidation the
+// unified `rcf` CLI grew a `verify` subcommand that dispatches to the
+// same handlers this file wires up; `rcf-verify` remains as a
+// transition-grace alias (see docs/2026-08-06_packaging-consolidation-
+// proposal.md R3). When run directly (as `rcf-verify <verb>` rather
+// than through the routing `rcf verify <verb>`), the entrypoint emits
+// a one-line stderr deprecation notice; behaviour is otherwise
+// unchanged.
+//
+// Argv layout: `rcf-verify <subcommand> [args...]`. The first positional
+// selects the subcommand handler; global --version / --help short-circuit
+// before dispatch. The `main` export is also imported by bin/rcf.js as
+// the `verify` subcommand handler, so the dispatcher lives in one place.
+
+import { realpathSync } from 'node:fs';
+import { readFile } from 'node:fs/promises';
+import { dirname, resolve } from 'node:path';
+import process from 'node:process';
+import { fileURLToPath, pathToFileURL } from 'node:url';
+
+import { main as runMain } from '../src/verify/cli/run.js';
+import { main as reportMain } from '../src/verify/cli/report.js';
+import { main as provisionMain } from '../src/verify/cli/provision.js';
+import { main as cleanupMain } from '../src/verify/cli/cleanup.js';
+import { main as mcpMain } from '../src/verify/cli/mcp.js';
+import { main as helpMain, TOP_LEVEL_HELP } from '../src/verify/cli/help.js';
+
+const here = dirname(fileURLToPath(import.meta.url));
+
+const SUBCOMMANDS = {
+  run: runMain,
+  report: reportMain,
+  provision: provisionMain,
+  cleanup: cleanupMain,
+  mcp: mcpMain,
+  help: helpMain,
+};
+
+/**
+ * @param {string[]} argv - argv minus node + script
+ * @param {object} [deps]
+ * @returns {Promise<number>}
+ */
+export async function main(argv, deps = {}) {
+  const stdout = deps.stdout ?? process.stdout;
+  const stderr = deps.stderr ?? process.stderr;
+
+  if (argv.length === 0) {
+    stdout.write(TOP_LEVEL_HELP);
+    return 0;
+  }
+  const first = argv[0];
+  if (first === '--version' || first === '-v') {
+    stdout.write(`rcf-verify ${await readPackageVersion()}\n`);
+    return 0;
+  }
+  if (first === '--help' || first === '-h') {
+    stdout.write(TOP_LEVEL_HELP);
+    return 0;
+  }
+  const handler = SUBCOMMANDS[first];
+  if (!handler) {
+    stderr.write(`[error] usage unknown subcommand: ${first}\n`);
+    stderr.write(TOP_LEVEL_HELP);
+    return 2;
+  }
+  return await handler(argv.slice(1), deps);
+}
+
+async function readPackageVersion() {
+  try {
+    const pkgPath = resolve(here, '..', 'package.json');
+    const pkg = JSON.parse(await readFile(pkgPath, 'utf8'));
+    return pkg.version ?? '0.0.0';
+  } catch {
+    return '0.0.0';
+  }
+}
+
+/**
+ * Symlink-safe entry-point compare (mirrors build's bin/rcf.js). macOS `/tmp`
+ * is a symlink to `/private/tmp` and every `pnpm link` shim is a symlink;
+ * without realpath the isMain gate breaks and main() never runs.
+ *
+ * @param {string} metaUrl
+ * @param {string} argvPath
+ * @returns {boolean}
+ */
+export function isSameEntryPoint(metaUrl, argvPath) {
+  try {
+    const metaPath = fileURLToPath(metaUrl);
+    return realpathSync(metaPath) === realpathSync(argvPath);
+  } catch {
+    try {
+      return metaUrl === pathToFileURL(argvPath).href;
+    } catch {
+      return false;
+    }
+  }
+}
+
+const isMain = process.argv[1] && isSameEntryPoint(import.meta.url, process.argv[1]);
+if (isMain) {
+  // Transition-grace deprecation notice per proposal R3. Only fires when
+  // the alias bin is invoked directly (not when bin/rcf.js routes the
+  // `verify` subcommand through the exported `main`, since the isMain
+  // guard is false in that case). Suppressible via RCF_QUIET=1 for
+  // scripted callers who cannot tolerate stderr chatter.
+  if (!process.env.RCF_QUIET) {
+    process.stderr.write(
+      '[rcf-verify] deprecation: prefer `rcf verify` (the umbrella CLI subcommand). ' +
+      'The `rcf-verify` alias will be removed in a future major. Set RCF_QUIET=1 to silence.\n',
+    );
+  }
+  main(process.argv.slice(2))
+    .then((code) => process.exit(code))
+    .catch((err) => {
+      process.stderr.write(`[rcf-verify] unexpected failure: ${err.message}\n${err.stack}\n`);
+      process.exit(1);
+    });
+}

package/bin/rcf.js

@@ -0,0 +1,174 @@
+#!/usr/bin/env node
+// Unified `rcf` binary. Phase 4 §D1 / §D23: replaces the standalone
+// `bin/rcf-view.js` and adds init / validate / create / read / update /
+// delete / link / unlink / help subcommands. Zero external deps.
+//
+// Argv layout: `rcf <subcommand> [args...]`. The first positional is
+// the subcommand; everything after is handed to that subcommand's
+// handler (`src/cli/<subcommand>.js`). Global `--version` and `--help`
+// short-circuit before dispatch.
+
+import { realpathSync } from 'node:fs';
+import { readFile } from 'node:fs/promises';
+import { dirname, resolve } from 'node:path';
+import process from 'node:process';
+import { fileURLToPath, pathToFileURL } from 'node:url';
+
+import { main as buildMain } from '../src/cli/build.js';
+import { main as coverageMain } from '../src/cli/coverage.js';
+import { main as createMain } from '../src/cli/create.js';
+import { main as deleteMain } from '../src/cli/delete.js';
+import { main as doctorMain } from '../src/cli/doctor.js';
+import { main as finaliseMain } from '../src/cli/finalise.js';
+import { main as guidanceMain } from '../src/cli/guidance.js';
+import { main as helpMain, TOP_LEVEL_HELP } from '../src/cli/help.js';
+import { main as impactMain } from '../src/cli/impact.js';
+import { main as initMain } from '../src/cli/init.js';
+import { main as linkMain } from '../src/cli/link.js';
+import { main as mcpMain } from '../src/cli/mcp.js';
+import { main as preflightMain } from '../src/cli/preflight.js';
+import { main as readMain } from '../src/cli/read.js';
+import { main as reviewMain } from '../src/cli/review.js';
+import { main as fbsMain } from '../src/cli/fbs.js';
+import { main as testSuiteMain } from '../src/cli/test-suite.js';
+import { main as traceMain } from '../src/cli/trace.js';
+import { main as uiBaselineMain } from '../src/cli/ui-baseline.js';
+import { main as uiClassifyMain } from '../src/cli/ui-classify.js';
+import { main as designMain } from '../src/cli/design.js';
+import { main as browserVerifyMain } from '../src/cli/browser-verify.js';
+import { main as updateMain } from '../src/cli/update.js';
+import { main as validateMain } from '../src/cli/validate.js';
+import { main as viewMain } from '../src/cli/view.js';
+// Track C+D (elicitation-and-playbook-hardening-0.7.0) verbs.
+import { main as reqClassifyMain } from '../src/cli/req-classify.js';
+import { main as reqBaselineMain } from '../src/cli/req-baseline.js';
+import { main as intakeMain } from '../src/cli/intake.js';
+// 0.7.1 packaging consolidation: `rcf verify <verb>` routes through the
+// same dispatcher the `rcf-verify` alias bin exposes. One place to wire
+// the verify subcommands; two entry points.
+import { main as verifyMain } from './rcf-verify.js';
+
+const here = dirname(fileURLToPath(import.meta.url));
+
+export const SUBCOMMANDS = {
+  init: initMain,
+  view: viewMain,
+  validate: validateMain,
+  create: createMain,
+  read: readMain,
+  update: updateMain,
+  delete: deleteMain,
+  link: (argv, deps) => linkMain(argv, { ...deps, remove: false }),
+  unlink: (argv, deps) => linkMain(argv, { ...deps, remove: true }),
+  coverage: coverageMain,
+  trace: traceMain,
+  impact: impactMain,
+  build: buildMain,
+  finalise: finaliseMain,
+  doctor: doctorMain,
+  guidance: guidanceMain,
+  mcp: mcpMain,
+  preflight: preflightMain,
+  review: reviewMain,
+  fbs: fbsMain,
+  'test-suite': testSuiteMain,
+  'ui-classify': uiClassifyMain,
+  'ui-baseline': uiBaselineMain,
+  design: designMain,
+  'browser-verify': browserVerifyMain,
+  // Track C+D (elicitation-and-playbook-hardening-0.7.0) verbs.
+  'req-classify': reqClassifyMain,
+  'req-baseline': reqBaselineMain,
+  intake: intakeMain,
+  // 0.7.1 packaging consolidation (R3, ratified 2026-08-06): the verify
+  // suite lives under `rcf verify <run|report|provision|cleanup|mcp>`.
+  // Dispatches to the same handlers as the `rcf-verify` alias bin.
+  verify: verifyMain,
+  help: helpMain,
+};
+
+/**
+ * Entry point. Reads argv (minus node + script), dispatches on the
+ * first positional. Returns a Promise resolving to an exit code.
+ *
+ * @param {string[]} argv
+ * @param {object} [deps]
+ * @returns {Promise<number>}
+ */
+export async function main(argv, deps = {}) {
+  const stdout = deps.stdout ?? process.stdout;
+  const stderr = deps.stderr ?? process.stderr;
+
+  if (argv.length === 0) {
+    stdout.write(TOP_LEVEL_HELP);
+    return 0;
+  }
+  const first = argv[0];
+  if (first === '--version' || first === '-v') {
+    const version = await readPackageVersion();
+    stdout.write(`rcf ${version}\n`);
+    return 0;
+  }
+  if (first === '--help' || first === '-h') {
+    stdout.write(TOP_LEVEL_HELP);
+    return 0;
+  }
+  const handler = SUBCOMMANDS[first];
+  if (!handler) {
+    stderr.write(`[error] usage unknown subcommand: ${first}\n`);
+    stderr.write(TOP_LEVEL_HELP);
+    return 2;
+  }
+  return await handler(argv.slice(1), deps);
+}
+
+async function readPackageVersion() {
+  try {
+    const pkgPath = resolve(here, '..', 'package.json');
+    const pkg = JSON.parse(await readFile(pkgPath, 'utf8'));
+    return pkg.version ?? '0.0.0';
+  } catch {
+    return '0.0.0';
+  }
+}
+
+/**
+ * Compare `import.meta.url` to `process.argv[1]` in a symlink-safe way.
+ * On macOS `/tmp` is a symlink to `/private/tmp`, and any `npm link` /
+ * `pnpm link` install exposes the bin via a symlink. `import.meta.url`
+ * always resolves via realpath; `process.argv[1]` is the raw string the
+ * shell/OS passed. Normalise both via `fs.realpathSync` before compare.
+ * Falls back to the raw compare if realpath fails (e.g. path removed).
+ *
+ * @param {string} metaUrl - `import.meta.url`
+ * @param {string} argvPath - `process.argv[1]`
+ * @returns {boolean}
+ */
+export function isSameEntryPoint(metaUrl, argvPath) {
+  try {
+    const metaPath = fileURLToPath(metaUrl);
+    return realpathSync(metaPath) === realpathSync(argvPath);
+  } catch {
+    // realpath failed on one side — fall back to the raw URL compare.
+    try {
+      return metaUrl === pathToFileURL(argvPath).href;
+    } catch {
+      return false;
+    }
+  }
+}
+
+// isMain gate — normalise both sides via realpath. Without this, macOS symlinks
+// like `/tmp` -> `/private/tmp` and every `npm link` / `pnpm link` shim break
+// the compare and main() silently never runs. See BUG-001.
+const isMain = process.argv[1] && isSameEntryPoint(import.meta.url, process.argv[1]);
+if (isMain) {
+  main(process.argv.slice(2))
+    .then((code) => process.exit(code))
+    .catch((err) => {
+      // Exit 1 is the "unexpected" escape hatch (§D15). Stack is not
+      // suppressed even under --quiet - operator needs the raw failure.
+      process.stderr.write(`[rcf] unexpected failure: ${err.message}\n${err.stack}\n`);
+      process.exit(1);
+    });
+}

package/bin/view-supervisor-child.mjs

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+// Detached view-supervisor child entry point (spec §9.3).
+//
+// Spawned by `rcf view start --detach`; the parent CLI process
+// invokes `child_process.spawn` on this file with `detached: true` and
+// unrefs. The child reads its config from env vars set by the parent,
+// then hands off to the supervisor loop.
+
+import { runDetachedChild } from '../src/view-supervisor/index.js';
+
+runDetachedChild().catch((err) => {
+  process.stderr.write(`[view-supervisor-child] unexpected failure: ${err.message}\n${err.stack}\n`);
+  process.exit(1);
+});

package/fixtures/canary-manifest.json

@@ -0,0 +1,103 @@
+{
+  "registerCanary": [
+    {
+      "id": "rc-2026-08-12-001",
+      "createdAt": "2026-08-12T10:45:12.561Z",
+      "buildVersion": "0.7.1-mockdriver",
+      "fixturePromptId": "canary-prompt-01",
+      "responseWordCount": 55,
+      "grades": {
+        "internalRuleCitation": {
+          "verdict": "pass",
+          "matches": []
+        },
+        "unglossedJargon": {
+          "verdict": "pass",
+          "matches": []
+        },
+        "redundantPermissionAsk": {
+          "verdict": "pass",
+          "matches": []
+        },
+        "bypassOffer": {
+          "verdict": "pass",
+          "matches": []
+        },
+        "wordCountBudget": {
+          "verdict": "pass",
+          "target": 200,
+          "actual": 55,
+          "matches": []
+        }
+      },
+      "verdict": "fail",
+      "shipDespiteFailReason": "mock canary driver used; no real subagent was dispatched. This record verifies canary infrastructure only, not the register itself."
+    },
+    {
+      "id": "rc-2026-08-12-002",
+      "createdAt": "2026-08-12T10:45:12.562Z",
+      "buildVersion": "0.7.1-mockdriver",
+      "fixturePromptId": "canary-prompt-02",
+      "responseWordCount": 55,
+      "grades": {
+        "internalRuleCitation": {
+          "verdict": "pass",
+          "matches": []
+        },
+        "unglossedJargon": {
+          "verdict": "pass",
+          "matches": []
+        },
+        "redundantPermissionAsk": {
+          "verdict": "pass",
+          "matches": []
+        },
+        "bypassOffer": {
+          "verdict": "pass",
+          "matches": []
+        },
+        "wordCountBudget": {
+          "verdict": "pass",
+          "target": 200,
+          "actual": 55,
+          "matches": []
+        }
+      },
+      "verdict": "fail",
+      "shipDespiteFailReason": "mock canary driver used; no real subagent was dispatched. This record verifies canary infrastructure only, not the register itself."
+    },
+    {
+      "id": "rc-2026-08-12-003",
+      "createdAt": "2026-08-12T10:45:12.562Z",
+      "buildVersion": "0.7.1-mockdriver",
+      "fixturePromptId": "canary-prompt-03",
+      "responseWordCount": 55,
+      "grades": {
+        "internalRuleCitation": {
+          "verdict": "pass",
+          "matches": []
+        },
+        "unglossedJargon": {
+          "verdict": "pass",
+          "matches": []
+        },
+        "redundantPermissionAsk": {
+          "verdict": "pass",
+          "matches": []
+        },
+        "bypassOffer": {
+          "verdict": "pass",
+          "matches": []
+        },
+        "wordCountBudget": {
+          "verdict": "pass",
+          "target": 200,
+          "actual": 55,
+          "matches": []
+        }
+      },
+      "verdict": "fail",
+      "shipDespiteFailReason": "mock canary driver used; no real subagent was dispatched. This record verifies canary infrastructure only, not the register itself."
+    }
+  ]
+}

package/guidance/README.md

@@ -0,0 +1,25 @@
+# Agent guidance pack
+
+This directory is the product's agent-facing guidance layer: what an AI agent needs to run the RCF method well. The CLI referees the tree; these files teach the method the referee assumes. Everything here is static markdown, served to agents over MCP and readable in place.
+
+## What each file is
+
+| File | Consumer | Channel |
+|---|---|---|
+| [overview.md](overview.md) | Any agent or MCP client needing orientation | resource `rcf://docs/overview` |
+| [document-model.md](document-model.md) | Agents authoring or editing tree documents | resource `rcf://docs/document-model` |
+| [build-cycle.md](build-cycle.md) | Agents in the build loop; the normative cycle statement | resource `rcf://docs/build-cycle` |
+| [harness-template.md](harness-template.md) | Adopters wiring an agent harness; agents self-installing | resource `rcf://docs/harness-template` |
+| [build-cycle-playbook.md](build-cycle-playbook.md) | The operating agent executing FBS items | prompt `rcf_execute_build_cycle` |
+| [elicitation-playbook.md](elicitation-playbook.md) | The eliciting agent starting a project with a human | prompt `rcf_elicit_requirements` |
+| [manifest.json](manifest.json) | The MCP server; the drift tests | machine channel map |
+
+The playbooks are prompts (instructions to a model); the reference docs are resources (context a client attaches). Each file has one canonical MCP address. Slugs are the filename minus `.md`, so the mapping is guessable without the manifest.
+
+## Adoption in three steps
+
+1. Install the package so the `rcf` binary and this pack are on hand.
+2. Run `rcf init` in your project BEFORE starting the agent session - it scaffolds the tree, registers the MCP server in `.mcp.json` and writes the fragment from [harness-template.md](harness-template.md) into your project's CLAUDE.md and AGENTS.md (both, on a fresh project; an existing instructions file is refreshed in place). Manual paste of the fragment is the fallback for non-standard harnesses.
+3. Start your agent session and have the agent run `rcf build --next`, executing the runbook the bundle prints.
+
+That is the whole loop. The playbooks add depth when the agent needs it; the bundle's built-in runbook is enough to start.