Installation

Requirements#

Rollberry currently requires:

• Node.js 24.12.0 or later
• ffmpeg available on PATH

Check your versions first:

node --version
ffmpeg -version

If ffmpeg is missing, install it with your platform package manager:

# macOS
brew install ffmpeg
 
# Ubuntu
sudo apt install ffmpeg
 
# Windows
winget install ffmpeg

Recommended: use npx#

The easiest way to run Rollberry is with npx:

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

This keeps the CLI version explicit in automation and avoids managing a global install.

To pin a version:

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

Optional: global install#

If you use Rollberry constantly on the same machine, you can also install it globally:

npm install -g rollberry

This makes the rollberry binary available globally, but this docs site keeps all command examples on the same npx form for consistency:

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

Chromium behavior#

Rollberry uses Playwright's Chromium browser. If Chromium is missing on first run, Rollberry attempts to install it automatically before capture starts.

You do not need to install Chrome manually for the normal workflow.

Verifying the installation#

Check the CLI version:

npx rollberry --version

Expected output:

0.1.9

Run a smoke test:

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

Successful runs produce:

• ./artifacts/smoke.mp4
• ./artifacts/smoke.manifest.json
• ./artifacts/smoke.log.jsonl

CI and automation#

For CI, npx is usually the safest option because the version can be pinned in the command itself:

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

Make sure the environment already has Node.js 24.12.0+ and ffmpeg available.

Next step#

Continue with Quick Start for the first capture and first project render.