Puppeteer

To start, you need to install @replayio/puppeteer package to your project.

Puppeteer package is open-source and available on GitHub

• npm
• yarn
• pnpm
• bun

Terminal
npm i @replayio/puppeteer

In order to use Replay Browser in your Puppeteer scripts, you need to point your configuration to the Replay Browser binary. The getExecutablePath function will take care of locating the binary on your machine.

puppeteer.config.js
 1const puppeteer = require("puppeteer");
 2const { getExecutablePath } = require("@replayio/puppeteer");
 3
 4(async () => {
 5	const browser = await puppeteer.launch({
 6		headless: false,
 7		executablePath: getExecutablePath("chromium"),
 8	});
 9	const page = await browser.newPage();
10	await page.goto("https://replay.io");
11	await page.screenshot({ path: "replay.png" });
12
13	await page.close();
14	await browser.close();
15})();

With configration set up, you can run your tests the same way as before. After your run finishes, your recordings will be stored locally.

To download and install Replay CLI, run the following command:

• npm
• yarn
• pnpm
• bun

Terminal
npm i -g replayio

Upload your replays with the following command.

Terminal
replayio upload-all

You can use Replay CLI to manage and upload your recordings. To learn more see the docs on Replay CLI.

After you upload your recordings, you can view them in Test Suite Dashboard.