Installation

@nijam/pw-reporter is the Playwright reporter that ships your runs to Nijam. It’s open source (MIT), zero-dependency, and fail-soft — it never breaks your test run.

Install

npm

npm install --save-dev @nijam/pw-reporter

pnpm

pnpm add -D @nijam/pw-reporter

yarn

yarn add -D @nijam/pw-reporter

It declares @playwright/test (>= 1.40) as a peer dependency, so it uses the Playwright you already have.

Add it to playwright.config.ts

Playwright’s reporter field takes a list, so add Nijam alongside any reporters you already use:

playwright.config.ts

import { defineConfig } from '@playwright/test';

export default defineConfig({
  reporter: [
    ['list'], // keep your existing reporters
    ['@nijam/pw-reporter', {
      apiKey: process.env.NIJAM_API_KEY,
      projectId: '<your-project-uuid>',
    }],
  ],
});

The two required options are apiKey and projectId — see Configuration for the full list and where to find them.

Tip

Put NIJAM_API_KEY in your CI secrets and reference it via process.env. Don’t hard-code the key in the config file.

Verify

Run your suite. If Nijam is reachable and the credentials are valid, the run shows up in your project in the dashboard. If something’s off (bad key, wrong project, network), the reporter prints a [nijam] warning and your tests still pass/fail exactly as before.

Next: Configuration →