Quickstart

Prerequisites

Playwright already runs in your repo
Node.js available locally and in CI
A Sentinel token only if you want uploads into your own Sentinel workspace

1. Install the Playwright package

bash

npm install -D @sentinelqa/playwright-reporter

2. Wrap your Playwright config

Sentinel preserves your existing Playwright outputs and only fills in the reporters or paths that are missing.

import { defineConfig } from "@playwright/test";
import { withSentinel } from "@sentinelqa/playwright-reporter";

export default withSentinel(
  defineConfig({
    reporter: [["line"]],
    outputDir: "test-results",
    use: {
      trace: "retain-on-failure",
      screenshot: "only-on-failure",
      video: "retain-on-failure"
    }
  }),
  {
    project: "my-app"
  }
);

3. Run Playwright normally

bash

npx playwright test

Sentinel uploads a hosted debugging report and prints the shareable Sentinel link in the terminal.

Optional: offline mode (no upload)

If you want everything to stay local, enable offline mode. Sentinel will generate a local HTML report and will not upload.

bash

SENTINEL_MODE=offline

Local report path: `./sentinel-report/index.html`
CLI prints a local `file://` share link
Uploads are skipped
Telemetry is enabled by default. Set `SENTINEL_TELEMETRY_DISABLED=1` to disable it.

4. Optional: connect your Sentinel workspace

Add this in CI or locally if you want uploads in your own Sentinel workspace:

bash

SENTINEL_TOKEN=your_project_ingest_token

If `SENTINEL_TOKEN` is set, Sentinel uploads into your workspace instead of the free hosted public flow.

What actually happens

No `SENTINEL_TOKEN`: Sentinel uploads to a hosted public debugging page and prints a shareable link.
`SENTINEL_TOKEN` set: Sentinel uploads to your workspace.
Your normal `npx playwright test` command does not change.

Modes

Free Hosted Mode: generates a hosted public debugging report with no account required.
Offline Mode: generates a local report and skips uploads.
Workspace Mode: uploads runs to Sentinel for private history, recurring issues, and team access.

Plans

Free hosted report: no account required.
Free workspace: 200 runs included.
Workspace plan: paid upgrade for private history, recurring issue tracking, and team access.

CI setup

You only need to provide `SENTINEL_TOKEN` in your CI platform if you want uploads into your own Sentinel workspace. Your test command stays the same.

Decision guide

Use the free hosted mode if you want a shareable debugging link immediately.
Use a workspace if you need private history and recurring issue tracking.
Upgrade after 200 runs if you want to keep uploading into your workspace.

The result is intentionally simple: install one package, update `playwright.config.ts`, keep running `npx playwright test`, and choose later whether you want the free hosted report or a full Sentinel workspace.