@a1knowhow/demo-maker 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,104 @@
+# demo-maker
+
+🎬 **Demo videos as code** — configure once, re-run forever. YAML + Playwright → polished, consistent product feature videos.
+
+Turn versioned scenario configs into consistent product feature videos — reconfigure, re-run, no manual re-recording.
+
+## Why?
+
+Product UIs keep changing, so demo videos go stale. Re-recording by hand (or asking an agent to “just make a video”) is slow, costly, and still needs a human check.
+
+With demo-maker you version the walkthrough as YAML: edit steps, re-run, get the same MP4. Fragments and imports make flows reusable; you or an agent can maintain the scripts like code.
+
+**Side effect:** writing stable locators surfaces real UI gaps—missing labels, duplicate accessible names, hard-to-target list rows—so you often fix accessibility while building the demo.
+
+## Requirements
+
+- **Node.js** 20+
+- **Playwright Chromium** (`npx playwright install chromium`)
+- **ffmpeg** on `PATH` (MP4 re-encode, `cut_video` splice, background audio)
+
+## Install
+
+Published on npm as [`@a1knowhow/demo-maker`](https://www.npmjs.com/package/@a1knowhow/demo-maker):
+
+```bash
+npm install -D @a1knowhow/demo-maker
+npx playwright install chromium
+```
+
+Or from a clone:
+
+```bash
+npm install
+npx playwright install chromium
+```
+
+The package ships TypeScript source and runs via `tsx`. Library imports (`import … from "@a1knowhow/demo-maker"`) need a TypeScript-capable toolchain (tsx, Vitest, or a bundler). See [Security](./SECURITY.md) for runtime capabilities.
+
+## Quick start
+
+```bash
+npx demo-maker run examples/smoke.yaml --headless --fast
+```
+
+Step-by-step (install → first MP4 → record → fragments): **[docs/getting-started.md](./docs/getting-started.md)**
+
+## Example walkthrough
+
+Intro tour: open this repo on GitHub and walk getting-started → actions → locators (imports, title cards, captions, pacing):
+
+```bash
+npx demo-maker run examples/demo1-introduction.yaml
+```
+
+<video src="https://github.com/user-attachments/assets/4f1ded4a-5874-43f9-9d67-17843164ac61" controls width="720"></video>
+
+[View logs](./examples/files/demo1-introduction-run.log)
+
+Richer CI walkthrough (Actions → green run → test job):
+
+```bash
+npx demo-maker run examples/demo2-github-actions.yaml
+```
+
+([`examples/demo1-introduction.yaml`](./examples/demo1-introduction.yaml) · [`examples/demo2-github-actions.yaml`](./examples/demo2-github-actions.yaml) · [`examples/smoke.yaml`](./examples/smoke.yaml) for a minimal check)
+
+## Documentation
+
+
+| Topic                   | Link                                                         |
+| ----------------------- | ------------------------------------------------------------ |
+| Index                   | [docs/README.md](./docs/README.md)                           |
+| Getting started         | [docs/getting-started.md](./docs/getting-started.md)         |
+| CLI                     | [docs/cli.md](./docs/cli.md)                                 |
+| Actions                 | [docs/actions.md](./docs/actions.md)                         |
+| Locators                | [docs/locators.md](./docs/locators.md)                       |
+| Video & pacing          | [docs/video-and-pacing.md](./docs/video-and-pacing.md)       |
+| Recording               | [docs/recording.md](./docs/recording.md)                     |
+| Repair after UI changes | [docs/repairing-scenarios.md](./docs/repairing-scenarios.md) |
+
+
+Typed schema: `[src/types.ts](./src/types.ts)`.
+
+## Commands
+
+
+| Command                            | Purpose                                 |
+| ---------------------------------- | --------------------------------------- |
+| `demo-maker run <scenario.yaml>`   | Execute scenario (optional video)       |
+| `demo-maker check <scenario.yaml>` | `run` with `--fail-fast --fast`         |
+| `demo-maker record`                | Live-record actions to YAML             |
+| `demo-maker import`                | Convert DevTools / recorder JSON → YAML |
+| `demo-maker export-chapters`       | Timing JSON → YouTube chapter lines     |
+
+
+
+
+## Security
+
+Report vulnerabilities privately — see [SECURITY.md](./SECURITY.md). Do not open public issues for security bugs.
+
+## License
+
+Apache License 2.0 — see [LICENSE](./LICENSE).

package/SECURITY.md

@@ -0,0 +1,33 @@
+# Security Policy
+
+## Supported versions
+
+Security fixes are applied to the latest release on the default branch (`main`). Older versions are not patched.
+
+## Runtime capabilities
+
+demo-maker is a CLI that runs only when invoked (there are **no** `preinstall` / `install` / `postinstall` scripts). When you run it, it may:
+
+- Drive a browser via Playwright (network access to the URLs in your scenarios)
+- Read named auth env vars or an `--env-file` for login steps
+- Substitute `{{ placeholders }}` from that env file, scenario-referenced env keys, and `BASE_URL` (it does **not** copy the entire process environment into templates)
+- Spawn `ffmpeg` on your `PATH` for video processing
+- Read/write scenario files and video output on the local filesystem
+
+Install Playwright browsers separately (`npx playwright install chromium`); this package does not download browsers at install time.
+
+## Reporting a vulnerability
+
+**Do not open a public GitHub issue** for security vulnerabilities.
+
+Please report privately using [GitHub private vulnerability reporting](https://github.com/a1knowhow/demo-maker/security/advisories/new).
+
+Include:
+
+- Affected version / commit
+- Description and impact
+- Steps to reproduce (PoC welcome)
+
+We aim to acknowledge reports within **7 days** and share a remediation plan when we confirm the issue. Coordinated disclosure is preferred (typical window: up to 90 days).
+
+Thank you for helping keep demo-maker and its users safe.

package/bin/demo-maker.mjs

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+import { spawnSync } from "node:child_process";
+import { createRequire } from "node:module";
+import { dirname, join } from "node:path";
+import { fileURLToPath } from "node:url";
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const require = createRequire(import.meta.url);
+const tsxCli = require.resolve("tsx/cli");
+const entry = join(__dirname, "../src/main.ts");
+const result = spawnSync(process.execPath, [tsxCli, entry, ...process.argv.slice(2)], {
+  stdio: "inherit",
+});
+process.exit(result.status ?? 1);

package/docs/README.md

@@ -0,0 +1,35 @@
+# Documentation
+
+Purpose: Index for humans and AI agents working with `@a1knowhow/demo-maker`.
+
+**Read this first:** [Getting started](./getting-started.md) (install → first run → first MP4).
+
+Typed schema source of truth: [`src/types.ts`](../src/types.ts).
+
+## Topic map
+
+| Doc | When to open it |
+|-----|-----------------|
+| [Getting started](./getting-started.md) | Zero → first successful run and video |
+| [CLI](./cli.md) | Commands and flags |
+| [Scenario schema](./scenario-schema.md) | Top-level YAML fields |
+| [Actions](./actions.md) | What each `action:` does |
+| [Locators](./locators.md) | Targeting UI elements |
+| [Variables](./variables.md) | `{{ }}` and filename template functions |
+| [Imports and fragments](./imports-and-fragments.md) | Reusable YAML composition |
+| [Recording](./recording.md) | Live record, continue-from, import |
+| [Video and pacing](./video-and-pacing.md) | MP4, captions, title cards, cut_video |
+| [Repairing scenarios](./repairing-scenarios.md) | Fix YAML after UI changes |
+| [Library API](./library-api.md) | Use from TypeScript |
+| [URL capture](./url-capture.md) | Capture IDs from page URLs into `{{ vars }}` |
+
+## Agent loading tips
+
+- Prefer opening **one topic file** over the whole tree.
+- For a new scenario: getting-started → actions → locators → video-and-pacing.
+- For a failing step: repairing-scenarios → locators.
+- For composition: imports-and-fragments.
+
+## Similar tools (brief)
+
+Demo-maker is in the “demo as code” family: declarative steps → Playwright → video. Close peers include [demo-machine](https://github.com/45ck/demo-machine), [Clipwise](https://github.com/kwakseongjae/clipwise), and [SceneForge](https://github.com/jhandel/sceneforge). Strengths here: composable imports, locator abstraction, storage-state auth, captions/chapters, and a repair loop (`record --continue-from`).

package/docs/actions.md

@@ -0,0 +1,160 @@
+# Actions
+
+Purpose: Reference for every `action:` value in scenario steps. Schema: [`src/types.ts`](../src/types.ts).
+
+Any step may include optional `caption:` (overlay/log) and `timeout_ms:` (default 10000 unless overridden by `action_timeout_ms`).
+
+## Action table
+
+| Action | Required | What it does |
+|--------|----------|--------------|
+| **navigate** | `url` | Opens a URL (relative to `base_url`). Waits for DOM ready, rAF paint, then `navigate_hold_ms`. |
+| **click** | `locator` | Clicks the matched element. Optional `settle_until` after click. Then `post_click_delay_ms`. |
+| **drag** | `locator`, `offset_x` | Press at element center, drag by `offset_x` / `offset_y` (default `offset_y: 0`), release. Honors pre/post click delays. |
+| **type** | `locator`, `value` | Clears then types character-by-character (unless `clear_before_type: false`). Real input events. `{{ variables }}` in `value`. Optional per-step `typing_delay_ms`. |
+| **fill** | `locator`, `value` | Sets value in one go (faster; fewer input events). `{{ variables }}` supported. |
+| **wait** | see modes | Fixed delay, URL match, or until locator hidden (optional page refresh). |
+| **expect_visible** | `locator` | Waits until element is visible; fails if not within timeout. |
+| **screenshot** | `screenshots.dir` | HD PNG of page or `locator`. Optional `screenshot: { file, full_page, omit_background, scale }`. |
+| **pause** | — | Wait for Enter in terminal. Skipped in `--headless`. |
+| **log** | `message` | Log line (use `── Scene N: …` for chapter export). |
+| **title_card** | `text` | Full-screen scene title (fade/hold). Optional `hold_ms` (default 1800), `fade_ms` (default 400). |
+| **transition** | — | Fade-to-black. Optional `fade_ms` (default 500). Optional `hold_ms` holds black (outro). |
+| **cut_video** | `steps` | Run nested steps in browser but splice them out of the final video (ffmpeg). Optional `placeholder` (`title_card`). |
+| **repeat_while_visible** | `locator`, `steps` | Loop nested steps while locator visible; optional `max_iterations` (default 100). |
+
+## Wait modes
+
+| Mode | YAML | Use when |
+|------|------|----------|
+| Fixed delay | `wait` + `timeout_ms` only | Video pacing, brief pause |
+| URL | `until: url` + `url_pattern` | SPA navigation finished |
+| Until hidden | `until: hidden` + `locator` + `timeout_ms` | Poll until no matches |
+| Hidden + refresh | above + `refresh_every_ms` (≥ 500) | SPA status that only updates on reload |
+
+`url_pattern` supports `{{ variables }}`. If the string is slash-wrapped (`"/edit-doc/"`), the inner part is the RegExp source. Optional flags: `/pattern/gimsuy`. Uses `waitUntil: "commit"` for SPA client navigations.
+
+```yaml
+- action: wait
+  timeout_ms: 2000
+
+- action: wait
+  until: url
+  url_pattern: "/dashboard"
+
+- action: wait
+  until: hidden
+  locator:
+    selector: '[aria-label="Document status: Processing"]'
+  timeout_ms: 180000
+  refresh_every_ms: 5000
+```
+
+## `settle_until` (click only)
+
+Exactly one of:
+
+- `settle_until: { locator: … }` — wait until that element is **visible**
+- `settle_until: { text: "Exact visible string" }` — exact text (`getByText` exact); supports `{{ variables }}`
+
+```yaml
+- action: click
+  locator: { role: button, name: Create }
+  settle_until:
+    locator: { label: Name }
+```
+
+## `select_confirm` (`fill` / `type` on `<select>`)
+
+When `select_confirm: true` on a fill/type targeting a `<select>`:
+
+1. Wait until an `<option>` exists whose visible text or `value` equals the step `value`
+2. Select (label-first, then value)
+3. Verify selection applied
+
+Use for dynamic dropdowns where options load asynchronously.
+
+## `drag`
+
+```yaml
+- action: drag
+  locator:
+    selector: .splitpanes--vertical .splitpanes__splitter
+  offset_x: -180
+- action: wait
+  timeout_ms: 400
+```
+
+Negative `offset_x` drags left.
+
+## Screenshots
+
+```yaml
+screenshots:
+  dir: "output/screenshots"
+device_scale_factor: 2
+
+steps:
+  - action: navigate
+    url: "/app"
+  - action: screenshot
+    caption: "Main list"
+    screenshot:
+      file: "list.png"
+      scale: device
+  - action: screenshot
+    locator: { role: heading, name: Settings }
+    screenshot:
+      file: "heading.png"
+```
+
+## `cut_video` and `video_exclude`
+
+Run long waits in the browser but keep them out of the MP4:
+
+```yaml
+- action: cut_video
+  placeholder:
+    action: title_card
+    text: "Indexing…"
+    hold_ms: 2000
+  steps:
+    - action: wait
+      timeout_ms: 2000
+    - action: wait
+      until: hidden
+      locator:
+        selector: '[aria-label="Status: Processing"]'
+      timeout_ms: 180000
+      refresh_every_ms: 5000
+```
+
+Single-step exclude: set `video_exclude: true` on any step. Requires ffmpeg. See [Video and pacing](./video-and-pacing.md).
+
+## `repeat_while_visible`
+
+```yaml
+- action: repeat_while_visible
+  locator: { role: button, name: /Delete/i }
+  max_iterations: 50
+  steps:
+    - action: click
+      locator: { role: button, name: /Delete/i }
+    - action: click
+      locator: { role: button, name: /Confirm/i }
+```
+
+## Pause (debug)
+
+```yaml
+- action: pause
+  caption: "Inspect the page, then press Enter."
+```
+
+Skipped in `--headless`. Prefer `wait` + `timeout_ms` for video pacing.
+
+## Related
+
+- [Locators](./locators.md)
+- [Scenario schema](./scenario-schema.md)
+- [Video and pacing](./video-and-pacing.md)

package/docs/cli.md

@@ -0,0 +1,73 @@
+# CLI
+
+Purpose: Commands and flags for the `demo-maker` binary.
+
+```bash
+demo-maker --help
+demo-maker <command> …
+```
+
+## Commands
+
+| Command | Purpose |
+|---------|---------|
+| `run <scenario.yaml>` | Execute a scenario (optional video) |
+| `check <scenario.yaml>` | Same as `run --fail-fast --fast` (runtime smoke) |
+| `record` | Live-record browser actions to YAML |
+| `import <recording.json> -o <out.yaml>` | Convert recorder / DevTools JSON → YAML |
+| `export-chapters <timing.json\|dir>` | Emit YouTube chapter lines |
+
+Back-compat: if the first argument ends in `.yaml` / `.yml`, it is treated as `run`.
+
+## `run` / `check` flags
+
+| Flag | Purpose |
+|------|---------|
+| `--env-file=PATH` | Load `KEY=value` for auth and `{{ VAR }}`; `BASE_URL` overrides scenario `base_url` |
+| `--base-url=URL` | Override `base_url` (wins over env `BASE_URL`) |
+| `--headless` | No browser window |
+| `--fast` | Zero/minimal pacing delays |
+| `--fail-fast` | Stop on first step failure |
+| `--end-step=N` | Run only steps 1..N (1-based inclusive) |
+| `--pause-at-end` | Headed: wait for Enter before closing browser |
+| `--debug-dir=PATH` | Save PNG on step failure |
+| `--storage-state=PATH` | Load Playwright storage state (cookies/localStorage) |
+| `--save-storage-state=PATH` | Save storage state after the run |
+| `--capture-from-url VAR=regex` | Capture first regex group from page URLs into `{{ VAR }}` (repeatable) |
+| `--url-capture-file=PATH` | JSON array of `{ variable, pattern }` rules (see [URL capture](./url-capture.md)) |
+
+Examples:
+
+```bash
+npx demo-maker run scenarios/demo.yaml --env-file scenarios/u2.env --fast
+demo-maker check scenarios/demo.yaml --env-file scenarios/u2.env --storage-state=scenarios/session.json
+npx demo-maker run scenarios/demo.yaml --end-step=7 --pause-at-end --env-file scenarios/u2.env
+```
+
+## `record` flags (summary)
+
+| Flag | Purpose |
+|------|---------|
+| `--save-to=PATH` | Output YAML path |
+| `--save-json=PATH` | Also write raw recording JSON |
+| `--url=URL` / `--base-url=URL` | Start URL / base |
+| `--continue-from=PATH` | Replay YAML then record additional steps |
+| `--from=PATH` | Import from JSON instead of live record |
+| `--fast` | Fast replay when using `--continue-from` |
+| `--env-file=PATH` | Env for replay auth / variables |
+| `--end-step=N` | With continue-from: replay only 1..N |
+
+See [Recording](./recording.md).
+
+## `export-chapters`
+
+```bash
+demo-maker export-chapters path/to/video.timing.json
+demo-maker export-chapters output/videos   # newest *.timing.json in dir
+```
+
+## Requirements
+
+- Node 20+
+- Playwright Chromium (`npx playwright install chromium`)
+- ffmpeg on `PATH` for `.mp4`, `cut_video` splice, background audio