Node.js CLI

Install and configure @testdino/playwright to stream Playwright results in real time.

@testdino/playwright is a real-time streaming reporter and CLI for Playwright. Test results appear on the TestDino dashboard as each test executes.

Quick Reference

Topic	Link
Installation	npm install @testdino/playwright
CLI usage	npx tdpw test
Playwright reporter	Add to playwright.config.ts
Configuration	Options, config file, priority order
CI/CD	GitHub Actions, GitLab CI

Prerequisites

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

Installation

npm install @testdino/playwright

---

Usage

There are two ways to use the package. Pick one based on your workflow.

Method	When to use
CLI (tdpw test) (Recommended)	Wraps npx playwright test. Fastest setup.
Playwright reporter	Add to playwright.config.ts. Works with existing scripts.

Both methods provide real-time streaming, artifact uploads, and metadata collection.

Usage: CLI

The tdpw test command wraps npx playwright test and streams results to TestDino.

npx tdpw test [testdino-options] [playwright-options] [test-files]

1. Set your API token

   export TESTDINO_TOKEN="your-api-token"
   
2. Run tests

   npx tdpw test
   

   Or pass the token inline:

   npx tdpw test --token="your-api-token"
   
3. Run a specific file

   npx tdpw test tests/login.spec.ts
   

All Playwright CLI options pass through. Any flag that works with npx playwright test also works with npx tdpw test.

npx tdpw test --headed --project=chromium --workers=4
npx tdpw test --shard=1/4
npx tdpw test --grep="login" --retries=2
npx tdpw test --tag="regression,smoke"

Usage: Playwright Reporter

Add @testdino/playwright as a reporter in your Playwright config. This provides the same streaming behavior without changing your test command.

playwright.config.ts

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

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

Then run tests normally:

npx playwright test

TestDino works alongside HTML, JUnit, or any other Playwright reporter.

---

Configuration

TestDino Options

These options apply to both CLI and reporter usage.

Option	CLI Flag	Description
token	--token, -t	Authentication token (required)
debug	--debug	Enable debug logging
ciRunId	--ci-run-id	Group sharded test runs into a single run
artifacts	--no-artifacts	Disable artifact uploads (enabled by default)
coverage	--coverage	Enable code coverage collection
coverageReport	--coverage-report	Generate a local Istanbul HTML report after tests
coverageReportDir	--coverage-report-dir	Output directory for the local report (default: ./coverage)
tag	--tag	Comma-separated tags to attach to the test run (e.g., regression,smoke)

Set --ci-run-id when running sharded tests across multiple machines. This ensures all shards merge into a single test run on the dashboard.

Environment Variables

Variable	Description
TESTDINO_TOKEN	Authentication token
TESTDINO_DEBUG	Set to true to enable debug logging

Config File

Create testdino.config.ts (or .js) in your project root for persistent settings.

TypeScript

testdino.config.ts

export default {
  token: process.env.TESTDINO_TOKEN,
  debug: false,
  artifacts: true,
  coverage: {
    enabled: true,
    localReport: true,
    localReportDir: './coverage-report',
  },
};

JavaScript

testdino.config.js

module.exports = {
  token: process.env.TESTDINO_TOKEN,
  debug: false,
  artifacts: true,
  coverage: {
    enabled: true,
    localReport: true,
    localReportDir: './coverage-report',
  },
};

Dynamic

testdino.config.ts

export default function () {
  return {
    token: process.env.TESTDINO_TOKEN,
    debug: !process.env.CI,
    coverage: {
      enabled: !!process.env.COVERAGE,
    },
  };
}

---

CI/CD Integration

Streaming works the same in CI as locally.

GitHub Actions

.github/workflows/test.yml

name: Playwright Tests
on: [push, pull_request]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - uses: actions/setup-node@v4
        with:
          node-version: '20'

      - name: Install dependencies
        run: npm ci

      - name: Install Playwright
        run: npx playwright install --with-deps

      - name: Run Playwright Tests
        env:
          TESTDINO_TOKEN: ${{ secrets.TESTDINO_TOKEN }}
        run: npx tdpw test

GitHub Actions (Sharded)

.github/workflows/test-sharded.yml

name: Playwright Tests (Sharded)
on: [push, pull_request]

jobs:
  test:
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        shard: [1/3, 2/3, 3/3]
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - uses: actions/setup-node@v4
        with:
          node-version: '20'

      - name: Install dependencies
        run: npm ci

      - name: Install Playwright
        run: npx playwright install --with-deps

      - name: Run Playwright Tests
        env:
          TESTDINO_TOKEN: ${{ secrets.TESTDINO_TOKEN }}
        run: npx tdpw test --shard=${{ matrix.shard }}

GitLab CI

.gitlab-ci.yml

e2e-tests:
  image: mcr.microsoft.com/playwright:v1.50.0-jammy
  script:
    - npm ci
    - npx tdpw test
  variables:
    TESTDINO_TOKEN: $TESTDINO_TOKEN

---

What Gets Collected

The reporter collects metadata automatically. Collection is non-blocking.

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, console output
Coverage	Per-file statement, branch, function, and line metrics (when enabled)
Annotations	testdino: annotations from test metadata (guide)

---

Troubleshooting

Token is required but not provided

Verify the token is set:

echo $TESTDINO_TOKEN

Pass it directly to confirm:

npx tdpw test --token="your-api-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.

WebSocket connection failed

TestDino falls back to HTTP when WebSocket connections fail. Test execution is not affected. Check your network or firewall if warnings persist.

Enable debug logging

npx tdpw test --debug

Or set the environment variable:

export TESTDINO_DEBUG=true
npx tdpw test

Related

Explore test results, optimize your CI pipeline, and manage API keys.

View Test Runs

Explore test results in the platform

CI Optimization

Optimize your CI pipeline

Python CLI

Use TestDino with pytest

Code Coverage

Collect coverage from Playwright tests