Quickstart

This guide takes you from a fresh account to seeing your first run in the dashboard.

1. Create an account.

   Sign up at nijam.dev. You’ll land on your organizations screen.

2. Create an organization.

   An organization holds your projects, runs, and team. Create one (or accept an invite to an existing one). Every new account can create up to 2 organizations.

3. Create a project and copy its ID.

   Inside your org, create a project — one per Playwright suite/repo. Copy its Project ID (a UUID); the reporter needs it.

4. Generate an API key.

   In the project’s settings, generate an API key. Treat it like a password — store it as a CI secret, not in your repo.

   Caution

   The API key authorizes uploads to your project. Keep it in CI secrets (e.g. NIJAM_API_KEY) — never commit it.

5. Install the reporter.

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

   Using pnpm or yarn? See Installation for those commands.

6. Add it to playwright.config.ts.

   playwright.config.ts

   import { defineConfig } from '@playwright/test';
   
   export default defineConfig({
     reporter: [
       ['@nijam/pw-reporter', {
         apiKey: process.env.NIJAM_API_KEY,
         projectId: '<your-project-uuid>',
       }],
     ],
   });

   Keep your existing reporters too — Playwright accepts a list, so Nijam runs alongside list, html, etc.

7. Run your tests.

   NIJAM_API_KEY=... npx playwright test

   On a real CI run, commit/branch/PR/author are detected automatically — no extra config.

8. Open the dashboard.

   Back in nijam.dev, open your project. Your run is there, with its results, any failure traces, and the start of your test history.

Where to go next

• Reporter configuration — every option explained.
• CI integration — wiring it into GitHub Actions, GitLab, CircleCI, Bitbucket.
• Core concepts — how orgs, projects, and runs relate.