Skip to content
Archi edited this page Oct 18, 2026 · 2 revisions

DemoFlow

DemoFlow turns a short JSON scenario into a verified, polished demo video of a web feature. It drives your app in Chromium, checks that the feature works as described, and renders an MP4 with a drawn cursor, zoom, captions and masked secrets. You can run it from the command line or let an AI agent such as Claude Code run it through MCP.

What it does today

  • Runs a scenario against your app (demoflow run), starting the app first when devCommand is configured.
  • Verifies the feature with assertVisible and assertText steps; a failed check fails the run and the video says so.
  • Renders the recording with an FFmpeg compositor: the page in a rounded window on a background, a smooth cursor, click rings, camera zoom, captions, idle compression and key badges.
  • Masks secrets: values read from environment variables never reach disk or logs, and their fields are blurred in the video.
  • Records a scenario by clicking (demoflow record) instead of writing JSON by hand.
  • Serves MCP (demoflow mcp) so Claude Code can generate a demo, poll it and get the video path back.

Everything runs on your machine. There is no account, upload or cloud service yet; see Status and Roadmap.

flowchart LR
  S["Scenario<br/>*.demo.json"] --> R["demoflow run"]
  A["Claude Code"] -->|MCP| M["demoflow mcp"] --> R
  R --> B["Chromium<br/>runs and verifies"]
  B --> T["source.webm<br/>timeline.json"]
  T --> F["FFmpeg compositor"]
  F --> V["render/ffmpeg.mp4"]
Loading

Where to start

If you want to… Read
make a first video in five minutes Getting Started
understand the stages of a run How a Demo Flows
write or record scenarios Scenarios, Recording Scenarios
tune the look of the video Rendering and Effects, Project Configuration
connect Claude Code MCP Server
look up a command or exit code CLI Reference
work on DemoFlow itself Architecture, Contributing

Pages

Start — Getting Started · How a Demo Flows · Architecture

Features — Scenarios · Recording Scenarios · Running Demos · Rendering and Effects · Secrets and Masking · Run Artifacts · MCP Server

Operate — Installing · Project Configuration · Security and Access · Deployment and Releases · Contributing

Reference — CLI Reference · Status and Roadmap · Glossary · FAQ

Note

This wiki describes the develop branch. The npm release demoflow@0.1.0 predates demoflow record, the press step, starting the app from devCommand, key badges and the window frame; they ship in the next release.

Elsewhere

Clone this wiki locally