Installation

Install Flowcorder in any web app.

Add the CLI as a dev dependency, initialize Flowcorder files, verify local dependencies, and capture your first demo flow.

Add The CLI

Install Flowcorder beside the app you want to record. The CLI runs as a local sidecar and writes generated output to .flowcorder/.

pnpm add -D flowcorder

# npm
npm install --save-dev flowcorder

# yarn
yarn add --dev flowcorder

Initialize

Init creates the project files agents and developers should edit: config, flows, auth setup, and fixture folders.

pnpm flowcorder init
my-app/
  flowcorder.config.ts
  flowcorder/
    auth/
      login.setup.ts
    fixtures/
    flows/
      example.flow.ts
  .flowcorder/

First Capture

Run doctor before your first capture. It should check app reachability, Playwright browsers, FFmpeg, auth setup, fixture files, and write access to the output directory.

pnpm flowcorder doctor
pnpm flowcorder list
pnpm flowcorder run example

Open Composer

After a successful capture, open the local Studio and use Composer to trim, add camera movement, apply frames, and export a video.

pnpm flowcorder open

# or compose directly from the CLI
pnpm flowcorder compose <capture-id>