Skip to content
Rollberry
Docs

CLI Options

Exact command syntax for Rollberry's current capture and render subcommands.

Commands#

npx rollberry capture <url...> [options]
npx rollberry render <project.json> [options]

Capture options#

OptionTypeDefaultNotes
--outstring./rollberry.mp4Output video path
--viewportstring1440x900WIDTHxHEIGHT
--fpsnumber60Maximum 120
--durationnumber | autoautoScroll duration
--motionease-in-out-sine | linearease-in-out-sineScroll easing
--timeoutnumber30000Total navigation timeout in ms
--wait-forload | selector:<css> | ms:<n>loadStart condition
--hide-selectorstringnoneRepeatable
--forceflagfalseOverwrite existing output
--debug-frames-dirstringnoneSave PNG frames
--page-gapnumber0Pause between URLs
--manifeststring<out>.manifest.jsonOverride manifest path
--log-filestring<out>.log.jsonlOverride log path

Render options#

OptionTypeDefaultNotes
--outputstringall outputsRepeatable named output filter
--forceflagfalseOverwrite configured output files

Most render behavior lives in the project JSON file, not on the command line.

Examples#

Capture one page#

npx rollberry capture https://example.com --out ./artifacts/example.mp4

Capture multiple pages into one file#

npx rollberry capture \
  https://example.com \
  https://example.com/pricing \
  --page-gap 1.5 \
  --out ./artifacts/tour.mp4

Capture localhost and wait for a selector#

npx rollberry capture http://localhost:3000 \
  --out ./artifacts/local.mp4 \
  --wait-for selector:#app

Render a project#

npx rollberry render ./rollberry.project.json

Render a subset of outputs#

npx rollberry render ./rollberry.project.json --output desktop --output mobile