suitecut

Record, narrate and stream browser flows as finished videos.

npm package 2.1.0

suitecut, explained. Recorded, narrated and rendered by suitecut.

How it works

Write a product tour, a bug report or a test as a script. suitecut runs it in Chromium inside your own program and records it.

Every frame comes from the renderer as it paints, with the page’s own sound.

Narration, the cursor, highlights, zoom and captions are steps in the same script. suitecut keeps a timeline of all of them and renders a finished video, or streams the run live over RTMP.

your scriptclicks, typing,narrationChromiuminside yourprogramframesas they paintaudiofrom the pagetimelineevery stepfinishedvideolive streamRTMP

Your script drives Chromium inside your program. Frames, audio and a timeline come out of it, and become a finished video or a live stream.

Quick start

Terminal
npm install suitecut

Record a tour and render it

TypeScript
import { record, renderSuiteCut } from 'suitecut'

const run = await record('Tour', async ({ page, suitecut }) => {
  await page.goto('https://example.com')
  await suitecut.narrate('Welcome to the product tour.')
  await suitecut.click(page.getByRole('link', { name: 'Pricing' }))
  await suitecut.highlight(page.locator('h1'))
})

await renderSuiteCut({
  manifestPath: run.manifestPath,
  outputPath: 'tour.mp4',
})

What you get

  • Capture 1 to 120 frames a second, straight from the renderer
  • Output MP4 at any rate from 1 to 120, including 29.97 and 59.94
  • Audio Page audio and narration on whole-sample boundaries, so nothing drifts
  • Narration Kokoro 82M runs locally, with word-by-word captions
  • Effects Cursor, click ripples, highlight, spotlight and zoom
  • Streaming Up to four RTMP or RTMPS publishers, with reconnect
  • macOS IOSurface capture, Metal colour conversion and VideoToolbox H.264

Limits

  • Needs the suitecut browser runtime, which ships separately from npm.
  • Linux x64 and macOS on Apple silicon. Windows is not packaged.

Read more

Other packages

Next: @suitecut/browser-control