Replay docs

Install Replay package

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

Terminal
npm i replayio

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

wdio.config.js
 1import { getBrowserPath } from "replayio";
 2
 3const chromiumPath = getBrowserPath();
 4
 5exports.config = {
 6  specs: ["./test/*.js"],
 7  automationProtocol: 'devtools',
 8  capabilities: [{
 9    maxInstances: 1,
10    browserName: 'chrome',
11    acceptInsecureCerts: true,
12    'goog:chromeOptions': {
13        binary: chromiumPath,
14        args: [ '--disable-infobars', '--window-size=1920,1080']
15    }
16  }],
17};

You need to set up automationProtocol: 'devtools' option in your config instead of default webdriver protocol for now. This may change in future updates.

Run your tests

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

Upload your replays

Upload your replays with the following command:

Terminal
replayio upload --all

To learn more see the docs on Replay CLI.

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

You can try this out on your own, by forking this example repository.

Learn how to manage your recordings, debug your app using Replay DevTools and more

WebdriverIO

Because Replay Browser lets you record anything that happens inside it, you can simply just point your test script to the Replay Browser binary and you are all set up.

Install Replay package

Set up the browser binary

Run your tests

Upload your replays

Manage your recordings

Replay DevTools

Setting up a team

Test Suite Management