Replay CLI

To download and install Replay CLI, run the following command. We recommend installing Replay CLI globally.

• npm
• yarn
• pnpm
• bun

Terminal
npm i -g replayio

Replay CLI will automatically notify you whenever there is a new version released. Running any command will show you a message letting you know that an update is available. This notification appears maximum once per 24 hours.

Terminal
A new version of replayio is available!
  Installed version: 0.0.2
  New version: 0.0.4

To upgrade, run the following:
  npm install -g replayio

Press any key to continue

Replay CLI requires you to log in when uploading your recordings. In a local environment, you can use replayio login command that opens a login page in a browser. When in a CI/CD environment, it’s not possible to use the same approach, but you can create an API key in Replay DevTools and add it to your CI/CD environment. Learn more in the docs on how to generate API key.

You can pass -h or --help option into any of the commands to get more info.

Displays information about installed Replay dependencies. This includes version of the Replay CLI package as well as the Replay Browser information.

Terminal
Currently using replayio@1.0.2

Replay Chromium
• Release date: 4/11/2024
• Forked version: 108.0.0

replayio list command will output a list all your local recordings. It will display all your uploaded and local (Recorded) replays. To upload a local replay, see upload command.

Terminal
ID         Host               Process  Date     Duration  Status
170a0e99…  localhost:3000              2h ago   7.2s      Uploaded
174a0bef…  localhost:52301             3h ago   7.1s      Uploaded
5721971d…  www.overboard.dev           1d ago   8.6s      Uploaded
875811eb…  localhost:4322              1d ago   7s        Recorded
9db33843…  localhost:4321              1w ago   5s        Uploaded