Node.js CLI for Playwright

@testdino/playwright streams Playwright test results to TestDino as a run executes. Results appear on the dashboard during the run, with no separate upload step. Paste the AI prompt below, or follow Installation and Set up.

Prerequisites

Node.js >= 18.0.0
@playwright/test >= 1.52.0
TestDino API token (generate one)
Git initialized repository (for commit and branch metadata)

Set up with an AI agent

Use this pre-built prompt to integrate @testdino/playwright into your project.

Open in Cursor

Quick Reference

Topic	Link	Best for
Install the package	Installation	First-time setup
Add TestDino to your config	Set up	Streaming results
CLI flags	CLI flags	Passing options on `tdpw`
Config file	Config file	`testdino.config.ts` and reporter options
Label a run	Run-level tags	`--tags` on `tdpw`, not Playwright
Group sharded runs	Sharded runs	CI with shards
Merge separate CI jobs	Split mode	Hand-partitioned jobs
Code coverage	Code coverage	Istanbul coverage

Installation

npm install @testdino/playwright

View the package on npm: @testdino/playwright ↗.

Set up

Add TestDino to the reporter array in your Playwright config. This is the only entry TestDino needs. Other reporters (html, list) are optional and yours to keep.

playwright.config.ts

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

export default defineConfig({
  reporter: [
    ['@testdino/playwright', {
      token: process.env.TESTDINO_TOKEN,
    }],
  ],
});

Set your token and run tests the way you already do. Results stream to TestDino as the run executes.

export TESTDINO_TOKEN="$TESTDINO_TOKEN"
npx playwright test

Prefer not to edit your config?

Run tdpw test instead of npx playwright test. Same result, no config change.

npx tdpw test -t "$TESTDINO_TOKEN"

It wraps npx playwright test, so any Playwright flag passes through, for example npx tdpw test --project=chromium --shard=1/3.

CLI flags

Set the token with -t or the TESTDINO_TOKEN environment variable. All other flags are optional.

npx tdpw test -t "$TESTDINO_TOKEN" --tags "regression,smoke"

These flags belong to tdpw test. Playwright does not define them, except --debug, which tdpw consumes for TestDino logs. Pass Playwright flags through tdpw as usual: npx tdpw test --tags regression,smoke --project=chromium.

Flag	Environment variable	Config file / reporter	Description
`-t, --token <token>`	`TESTDINO_TOKEN`	`token`	API token. Required.
`--ci-run-id <id>`	`TESTDINO_CI_RUN_ID`	`ciRunId`	Group sharded jobs into a single test run.
`--split <current/total>`	-	-	This job’s split position, for example `1/3`. Command only.
`--split-id <id>`	`TESTDINO_SPLIT_ID`	`splitId`	Group ID shared by every job of one split run. Required with `--split`.
`--tags <csv>`	`TESTDINO_TAGS`	`tags`	Run labels, comma-separated.
`--coverage`	-	`coverage.enabled`	Collect Istanbul code coverage.
`--no-artifacts`	-	`artifacts: false`	Skip screenshot, video, and trace uploads.
`--debug`	`TESTDINO_DEBUG`	`debug`	Print TestDino debug logs. Not forwarded to Playwright.

First non-empty source wins: CLI flag, then testdino.config.ts, then Playwright reporter options, then the environment variable. --split has no config or env equivalent. --coverage on the CLI only sets enabled; include, exclude, and thresholds stay in config. Learn how to set run labels in Run-level tags. Learn how to partition jobs in Split mode.

error: unknown option '--tags'

You passed a TestDino flag to npx playwright test. Playwright does not define --tags, --token, --ci-run-id, --split, --split-id, --coverage, or --no-artifacts, so it exits before the test run starts.Use the TestDino wrapper:

npx tdpw test -t "$TESTDINO_TOKEN" --tags "regression,smoke"

To keep npx playwright test, set the matching environment variable or config field from the table above. --split has no alternative: it is tdpw only.

--debug did not open the Playwright Inspector

tdpw consumes --debug for TestDino logs. It does not forward it to Playwright.

npx tdpw test -- --debug

TESTDINO_DEBUG=1 npx tdpw test -- --debug enables both.

Config file

Place testdino.config.ts or testdino.config.js in the project root. The same fields work as options on ['@testdino/playwright', { ... }] in playwright.config.

testdino.config.ts

export default {
  token: process.env.TESTDINO_TOKEN,
  tags: ['regression', 'smoke'],
  debug: false,
  artifacts: true,
  coverage: {
    enabled: true,
    include: ['src/**'],
    exclude: ['**/node_modules/**'],
    thresholds: {
      lines: 80,
      branches: 60,
      functions: 80,
      statements: 80,
    },
  },
};

Field	Type	Description
`token`	`string`	API token. Required unless `TESTDINO_TOKEN` or `-t` is set.
`ciRunId`	`string`	Group sharded jobs into a single test run.
`splitId`	`string`	Group ID for split mode. Does not set `--split`.
`tags`	`string[]`	Run labels. Empty values are dropped.
`debug`	`boolean`	Print TestDino debug logs. Default `false`.
`artifacts`	`boolean`	Upload screenshots, videos, and traces. Default `true`.
`coverage`	`object`	Istanbul collection. `enabled` is required when the object is present.
`coverage.enabled`	`boolean`	Turn collection on or off.
`coverage.include`	`string[]`	Glob patterns to include.
`coverage.exclude`	`string[]`	Glob patterns to exclude.
`coverage.thresholds`	`object`	`lines`, `branches`, `functions`, `statements` percents.

Learn coverage setup in Code Coverage.

Run-level tags

--tags labels the whole test run in TestDino. It does not select which test cases Playwright executes. Test-case tags (@smoke in test code, --grep) stay on Playwright.

npx tdpw test -t "$TESTDINO_TOKEN" --tags "regression,smoke"

--tags is a tdpw flag. To keep npx playwright test, set the same labels from the environment or config.

npx playwright test --tags exits with error: unknown option '--tags'. Use npx tdpw test --tags, TESTDINO_TAGS, or tags in config.

Environment
testdino.config.ts
playwright.config.ts

TESTDINO_TAGS=regression,smoke npx playwright test

testdino.config.ts

export default {
  token: process.env.TESTDINO_TOKEN,
  tags: ['regression', 'smoke'],
};

playwright.config.ts

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

export default defineConfig({
  reporter: [
    ['@testdino/playwright', {
      token: process.env.TESTDINO_TOKEN,
      tags: ['regression', 'smoke'],
    }],
  ],
});

Source	When it applies
`npx tdpw test --tags <csv>`	Command-line flag on the TestDino wrapper
`tags` in `testdino.config.ts`	Config file in the project root
`tags` in Playwright reporter options	`npx playwright test` with the reporter installed
`TESTDINO_TAGS`	Comma-separated env var for `npx playwright test` or `tdpw`

First non-empty source wins: CLI flag, then testdino.config.ts, then Playwright reporter options, then TESTDINO_TAGS. These labels appear as run-level chips on Test Runs. They are separate from test annotations.

Sharded runs

Pass the same --ci-run-id to every shard. TestDino groups them into a single logical run on the dashboard.

npx tdpw test --ci-run-id "$CI_RUN_ID" -- --shard=1/4

In the config path, set ciRunId or TESTDINO_CI_RUN_ID and pass --shard to npx playwright test as usual.

Split mode

Sharding needs every job to run the same command. When your jobs differ, for example an API project on one runner and browser tests on another, use split mode instead. Each job tags its results with --split i/N and a shared --split-id, and TestDino merges them into one test run.

npx tdpw test -t "$TESTDINO_TOKEN" \
  --split 1/2 --split-id "$SPLIT_ID" --ci-run-id "$SPLIT_ID-1" \
  --project=api tests/checkout-api.spec.ts

--split labels the results. It does not select which test cases run, so assign them yourself with spec paths, --project, or --grep. Requires version 2.3.0 or later. Learn how to build a CI matrix and read the Splits panel in Split mode.

Code coverage

Instrument your app with Istanbul so it exposes window.__coverage__, import the TestDino fixture in your tests, then enable coverage:

npx tdpw test --coverage

Coverage merges across shards automatically. Learn more in Code Coverage.

Environment variables

Variable	Config field	Description
`TESTDINO_TOKEN`	`token`	Authentication token
`TESTDINO_CI_RUN_ID`	`ciRunId`	Group sharded jobs into a single test run
`TESTDINO_SPLIT_ID`	`splitId`	Group ID for split mode
`TESTDINO_TAGS`	`tags`	Comma-separated run labels
`TESTDINO_DEBUG`	`debug`	Set to `true` or `1` to print TestDino debug logs

There is no environment variable for --split or --coverage. --split is command-only. Coverage include, exclude, and thresholds stay in the config file.

What gets collected

Category	Data
Git	Branch, commit hash, author, message, repository URL
CI	Provider, build ID, PR details
System	OS, CPU, memory, Node.js version
Playwright	Version, workers, projects, shard info
Artifacts	Screenshots, videos, traces (unless `--no-artifacts`)
Annotations	`testdino:` annotations from test metadata (guide)

Use in CI/CD

Set TESTDINO_TOKEN as a CI secret, keep TestDino in your playwright.config, and run npx playwright test. Each guide below has a full pipeline config with sharding and troubleshooting.

GitHub Actions

GitLab

TeamCity

Azure DevOps

CircleCI

AWS CodeBuild

Jenkins

Troubleshooting

Token is required but not provided

Set the token via --token, the TESTDINO_TOKEN environment variable, or the reporter option in playwright.config. Confirm it is set:

echo $TESTDINO_TOKEN

Generate a new token from API Keys if the issue persists.

Execution limit reached

Your account reached its monthly quota. Tests continue to run normally. Only streaming to TestDino pauses until the quota resets.Upgrade your plan or wait for the monthly reset.

Stream dropped, switched to HTTP fallback

Expected behavior. If the streaming connection drops, events fall back to HTTP delivery automatically. Your tests are never affected.

Real-Time Test Streaming

How real-time streaming works and when to use it

Generate API Keys

Create and manage tokens for the CLI and CI

Getting Started

Installation & Setup

AI & MCP

Guides

Project

Test Management

Organization

Integrations

Data Privacy

Resources

Prerequisites

Set up with an AI agent

Quick Reference

Installation

Set up

CLI flags

Config file

Run-level tags

Sharded runs

Split mode

Code coverage

Environment variables

What gets collected

Use in CI/CD

GitHub Actions

GitLab

TeamCity

Azure DevOps

CircleCI

AWS CodeBuild

Jenkins

Troubleshooting

Real-Time Test Streaming

Generate API Keys

​Prerequisites

​Set up with an AI agent

​Quick Reference

​Installation

​Set up

​CLI flags

​Config file

​Run-level tags

​Sharded runs

​Split mode

​Code coverage

​Environment variables

​What gets collected

​Use in CI/CD

GitHub Actions

GitLab

TeamCity

Azure DevOps

CircleCI

AWS CodeBuild

Jenkins

​Troubleshooting

​Related

Real-Time Test Streaming

Generate API Keys

Prerequisites

Set up with an AI agent

Quick Reference

Installation

Set up

CLI flags

Config file

Run-level tags

Sharded runs

Split mode

Code coverage

Environment variables

What gets collected

Use in CI/CD

Troubleshooting

Related