Skip to main content

Installation

Choose the reporter that matches your testing framework and follow the installation instructions below.

Playwright Reporter​

Install the Playwright reporter for automatically uploading your Playwright test results.

npm install --save-dev @testream/playwright-reporter

Or with other package managers:

# Yarn
yarn add --dev @testream/playwright-reporter

# pnpm
pnpm add --save-dev @testream/playwright-reporter

Next Step: Configure the reporter in your playwright.config.ts - see Playwright Documentation.

Cypress Reporter​

Install the Cypress reporter for automatically uploading your Cypress test results.

npm install --save-dev @testream/cypress-reporter cypress-ctrf-json-reporter

Or with other package managers:

# Yarn
yarn add --dev @testream/cypress-reporter cypress-ctrf-json-reporter

# pnpm
pnpm add --save-dev @testream/cypress-reporter cypress-ctrf-json-reporter

Next Step: Configure the reporter in your cypress.config.ts or use the CLI - see Cypress Documentation.

Jest Reporter​

Install the Jest reporter for automatically uploading your Jest test results.

npm install --save-dev @testream/jest-reporter

Or with other package managers:

# Yarn
yarn add --dev @testream/jest-reporter

# pnpm
pnpm add --save-dev @testream/jest-reporter

Next Step: Configure the reporter in your jest.config.js - see Jest Documentation.

.NET Reporter​

Install the .NET reporter CLI globally for seamlessly uploading your .NET test results.

npm install -g @testream/dotnet-reporter

Or use npx without installation:

npx @testream/dotnet-reporter --file TestResults.trx

Supported Formats:

  • xUnit XML
  • NUnit XML
  • MSTest TRX
  • Generic TRX format

Next Step: Learn how to use the CLI - see .NET Documentation.

WebdriverIO Reporter​

Install the WebdriverIO reporter for automatically uploading your WebdriverIO test results.

npm install --save-dev @testream/webdriverio-reporter wdio-ctrf-json-reporter

Or with other package managers:

# Yarn
yarn add --dev @testream/webdriverio-reporter wdio-ctrf-json-reporter

# pnpm
pnpm add --save-dev @testream/webdriverio-reporter wdio-ctrf-json-reporter

Next Step: Configure the reporter in your wdio.conf.ts - see WebdriverIO Documentation.

Mocha Reporter​

Install the Mocha reporter for automatically uploading your Mocha test results.

npm install --save-dev @testream/mocha-reporter

Or with other package managers:

# Yarn
yarn add --dev @testream/mocha-reporter

# pnpm
pnpm add --save-dev @testream/mocha-reporter

Next Step: Configure the reporter in your .mocharc.js - see Mocha Documentation.

Requirements​

Node.js Version​

All reporters and tools require Node.js 18 or later.

Check your Node.js version:

node --version

If you need to upgrade, visit nodejs.org.

API Key​

You'll need a Testream API key to upload test results.

To get your API key:

  1. Visit testream.app
  2. Sign up or log in to your account
  3. Navigate to Dashboard → Projects
  4. Create a new API key
  5. Copy and store it securely (e.g., GitHub Secrets, Key Vaults,environment variables)

What's Next?​