More details in the ReadMe section of our NPM package download instructions: https://www.npmjs.com/package/@replayio/replay
CLI tool and Node module for managing and uploading Replay recordings and installing Replay Browsers.
When using the Replay plugins to record automated tests or the Replay version of Node, recordings which are created are saved to disk, by default in $HOME/.replay. This package is used to manage these recordings and upload them to the record/replay web service so that they can be viewed.
Check out the "Recording Automated Tests Guide" to get started with recording Cypress or Playwright tests.
npm i @replayio/replay --global
npx @replayio/replay <command>
Possible commands are given below. These may be used with the --directory <dir> option to override the default recording directory, or --server <address> to override the default server address. When uploading, an API key is required, which can be passed via --api-key <key> or by setting the RECORD_REPLAY_API_KEY environment variable.
View information about all known recordings.
Options:
-all: Include uploaded, crashUploaded and unusable recordings in the output.-filter: Filter the recordings to upload using a JSONata-compatible filter function. If used with -all, the filter is applied after including all status values.-json: Prints a JSON array with one descriptor element for each recording.Recording descriptors have the following required properties:
id: ID used to refer to this recording in other commands.createTime: Time when the recording was created.