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 - continue with Google or GitHub, or use your email and a password. You’ll land on your organizations screen.

   Tip

   These all sign you into the same account when they share an email - sign up with a password and later “continue with Google”, or vice versa, and you land in the same place. (To add a password to a Google/GitHub-only account, use Forgot password to set one.)

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 test suite/repo (Playwright, pytest, or Vitest). 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.

   Note

   This is an ingestion key (nij_sk_…) - it can only upload, never read. To let AI agents query your runs, create a separate read-only key and follow the MCP server guide.

5. Install the reporter and wire it up.

   Pick your framework. (For pnpm/yarn and the full reference, see Installation.)

   Playwright

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

   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>',
       }],
     ],
   });

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

   pytest

   pip install pytest-nijam

   pytest-nijam is a plugin - it auto-loads, no code changes. Configure it in pytest.ini (or [tool.pytest.ini_options] in pyproject.toml) and set the API key as an env var:

   pytest.ini

   [pytest]
   nijam_project_id = <your-project-uuid>

   export NIJAM_API_KEY=...

   Vitest

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

   vitest.config.ts

   import { defineConfig } from 'vitest/config';
   import NijamReporter from '@nijam/vitest-reporter';
   
   export default defineConfig({
     test: {
       includeTaskLocation: true, // required to capture the failing line
       reporters: [
         'default',
         new NijamReporter({
           apiKey: process.env.NIJAM_API_KEY,
           projectId: '<your-project-uuid>',
         }),
       ],
     },
   });

6. Run your tests.

   Playwright

   NIJAM_API_KEY=... npx playwright test

   pytest

   NIJAM_API_KEY=... pytest

   Vitest

   NIJAM_API_KEY=... npx vitest run

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

   Tip

   The reporter prints a link to the run straight to your terminal (and your CI logs) - once when it starts and again when it finishes, so it’s there to click without scrolling back:

   [nijam] run started - view it at https://www.nijam.dev/...
   ...
   [nijam] run finalized (12/14 passed) - view it at https://www.nijam.dev/...

   Click it to jump to the run in the dashboard - no need to go hunting for it. (Set silent: true to suppress all [nijam] output.)

7. Open the dashboard.

   Back in nijam.dev, open your project. Your run is there, with its results, any failures (and traces, on Playwright), 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.