Skip to main content

​
System requirements

webreel requires Node.js version 18 or higher. 
node --version
If you need to upgrade Node.js, visit nodejs.org to download the latest LTS version.

​
Install webreel

Install webreel using your preferred package manager: 
npm install webreel
For global installation, use npm install -g webreel to access the webreel command from anywhere.

​
Automatic dependency installation

webreel requires Chrome and ffmpeg to record videos. Both are automatically downloaded on first use to ~/.webreel if not already installed.
The first time you run webreel record, it will download:
  • Chrome: Headless browser for automation (approximately 150MB)
  • ffmpeg: Video encoding library (approximately 50MB)
This one-time download may take a few minutes depending on your connection speed.

​
Manual installation (optional)

If you want to pre-install Chrome and ffmpeg without running a recording, use: 
webreel install
If you encounter issues with corrupted or broken binaries, force a reinstall: 
webreel install --force

​
Verify installation

Check that webreel is installed correctly: 
webreel --version
You should see the version number and available commands.

​
Next steps

Now that webreel is installed, you’re ready to record your first video:

Quickstart

Follow the quickstart guide to record your first video

CLI commands

Learn about all available webreel commands

Build docs developers (and LLMs) love

Get started for freeTalk to us