Getting started
Requirements
Use Node.js 22 or newer, pnpm 11, FFmpeg and FFprobe, and a separately built native CEF browser. The engine is a pinned CEF 156 build on the Chromium 156 beta channel.
Linux x64 and macOS ARM64 are qualified separately. macOS is qualified on 27.0.1 with Apple silicon; older releases and Intel Macs aren't. Windows runtime packaging isn't implemented.
Install
The Kokoro voice model is stored with Git LFS, so install it before cloning. Then build the TypeScript packages.
git lfs install
git clone https://github.com/skyaara/suitecut.git
cd suitecut
git lfs pull
pnpm install --frozen-lockfile
pnpm build
Follow the native build instructions for the CEF browser, then point suitecut at it. install downloads checksum-verified
FFmpeg and FFprobe; set SUITECUT_FFMPEG_PATH and SUITECUT_FFPROBE_PATH
to use your own. doctor checks the setup.
export SUITECUT_NATIVE_EXECUTABLE="/absolute/path/to/suitecut-browser"
node dist/cli.js install
node dist/cli.js doctor
Record a flow
import { record, renderSuiteCut } from 'suitecut'
const result = await record('Native tour', async ({ page, suitecut }) => {
await page.goto('https://example.com')
await suitecut.highlight(page.locator('h1'))
await suitecut.narrate('Welcome to the tour.')
await suitecut.checkpoint('Opening screen')
}, {
native: { width: 1920, height: 1080, framesPerSecond: 120 },
capture: { framesPerSecond: 60, audio: true },
})
await renderSuiteCut({
manifestPath: result.manifestPath,
outputPath: '.suitecut/tour.mp4',
config: { output: { framesPerSecond: 60 } },
})
Run and render
The recorder closes its primary browser, saves source clips and writes a manifest. The renderer composes selected intervals and mixes page audio with narration.
Render quality
Choose output dimensions, a frame rate up to 120 (fractional rates such as 29.97 work), quality profiles and supported FFmpeg encoders. Higher output rates can repeat captured images; they don't create motion the browser didn't capture.