getseatbelt 0.0.1

package/README.md

@@ -0,0 +1,122 @@
+# getseatbelt
+
+> **QA for AI-coded apps, before you merge.**
+
+Seatbelt is a local-first CLI. AI made code changes — Seatbelt maps your app's critical
+flows, replays them in a **real, visible browser**, captures evidence (video, screenshots,
+console, network), and returns a merge verdict plus a paste-ready **LLM fix prompt** for
+Claude, Cursor, or Codex. So you can trust an AI-generated change before you commit or merge it.
+
+- **Package:** `getseatbelt`
+- **Command:** `seatbelt`
+- **Website:** https://getseatbelt.ai · **Docs:** https://getseatbelt.ai/docs
+
+## Quick start
+
+Requires **Node 18+**.
+
+```bash
+npm install getseatbelt   # add Seatbelt to your project
+npx seatbelt init         # set up Seatbelt and map your app's critical flows
+```
+
+`seatbelt init` writes a small `seatbelt.config.yaml`, scaffolds a starter flow set in
+`qa-flows/`, and — at the end of setup — offers to run your first browser replay right away
+and to set up a clean test user. After that, run Seatbelt whenever AI changes your app:
+
+```bash
+npx seatbelt run          # replay your QA flows in a visible browser, then open the report
+```
+
+The first time a command needs your Seatbelt account, the CLI opens your browser to connect —
+you never paste a token. Local runs and reports work with no account at all.
+
+## What you get
+
+- **A visible browser replay.** Seatbelt drives a real browser through your flows so you can
+  watch it happen — not a green check you take on faith.
+- **A clean test user each run.** Seatbelt can add a safe reset so every run starts from a
+  known-clean account/state (run `seatbelt setup-reset`, or say yes during `seatbelt init`).
+- **Evidence, saved locally.** Video, screenshots, trace, console, and network for every run,
+  in a self-contained `report.html` that opens automatically.
+- **A merge verdict.** `MERGE` / `MERGE WITH CAUTION` / `DO NOT MERGE`, with the failed step
+  and an LLM fix prompt you can paste straight back into your coding agent.
+- **A QA-certified flow map.** A local, per-project map of your critical flows and their status,
+  kept in sync as your app changes.
+
+## Commands
+
+| Command | What it does |
+|---|---|
+| `seatbelt init` (alias `on`) | Set up Seatbelt in your repo, scaffold starter flows, seed the flow map. Offers to run the first browser QA and to set up a clean test user. |
+| `seatbelt run [target]` | Detect + start your app, run your clean-test-user reset, replay eligible `qa-flows/*.yaml` in a fresh visible browser, capture evidence, write + open the report, update the flow map. `target` can be a flow id or `all`. |
+| `seatbelt certify [--run]` | Show the QA-certified flow map. With `--run`, verify every eligible flow and record certification. |
+| `seatbelt refresh-flows` | Restore missing starter templates and flag stale flows. With `--ai`, ask Seatbelt for refreshed YAML suggestions. |
+| `seatbelt generate-flows` | Inspect your app and generate flow YAML suggestions. |
+| `seatbelt setup-reset` | Generate a reset-hook prompt for your coding agent (never executes anything). |
+| `seatbelt lint` | Run your detected lint / typecheck / build / test scripts (no browser). |
+| `seatbelt doctor` | Plain-language pre-flight of your setup. |
+| `seatbelt report` | Reopen the latest report without re-running. |
+| `seatbelt login` / `logout` / `whoami` | Manage your Seatbelt connection (usually automatic). |
+| `seatbelt status` / `billing` | Show your plan/access, or open the billing portal. |
+
+**Run flags:** `--headed` / `--headless` (headed is the default — the visible browser is the
+point), `--no-open`, `--yes`. Great for CI while keeping the visible browser as the everyday default.
+
+## Configuration
+
+`seatbelt init` writes a minimal `seatbelt.config.yaml`. Everything omitted falls back to
+sensible defaults.
+
+```yaml
+version: 1
+app:
+  name: My app
+
+server:
+  baseUrl: http://localhost:3000
+  reuseExistingServer: true
+
+browser:
+  headed: true          # visible browser — the trust layer
+  freshSession: true    # fresh context, cleared storage each run
+  video: true
+  trace: false
+
+report:
+  formats:
+    - html
+  openOnFinish: true
+
+flows:
+  dir: qa-flows
+  autoRefresh: prompt
+
+# Clean test user (optional but recommended — add via `seatbelt setup-reset`):
+# reset:
+#   command: npm run qa:reset-user   # Seatbelt runs this before your flows
+#   required: true                   # true = block browser QA (DO NOT MERGE) if it fails
+#   timeoutMs: 30000
+#   allowNonLocal: false             # safety: refuse to reset a non-localhost baseUrl
+```
+
+## Flows
+
+Flows are simple YAML in `qa-flows/`. Each flow lists deterministic steps for one critical
+path — login, checkout, billing, entitlements, onboarding, uploads, or whatever matters in your
+app. Not every app has every flow; delete the templates you don't need. Steps include `goto`,
+`click`, `fill` (`value` or `valueFromEnv` — secrets never live in the flow file), `press`,
+`selectOption`, `upload`, `waitFor*`, `expect*`, and `screenshot`. Credentials come from your
+`.env.local` by variable name; values are never printed or uploaded.
+
+## Privacy
+
+Browser QA runs on your machine, against your local app; artifacts are stored in your local
+project directory and are not uploaded by default. When you use AI to generate or maintain
+flows, Seatbelt sends a **sanitized summary** of your app (framework, scripts, routes, dependency
+names, redacted snippets, and env var names only) — never your `.env` secret values. Run with
+`--local-only` to keep everything offline (this disables AI flow generation and refresh).
+
+## License
+
+MIT. By using Seatbelt you agree to the Terms and Privacy Policy at https://getseatbelt.ai/terms.

package/dist/cli.d.ts

@@ -0,0 +1 @@
+#!/usr/bin/env node