Connect your Playwright project to the TestRelic cloud platform in under 10 minutes — create an account, configure the reporter, and explore your first test run.

This guide takes you from zero to your first TestRelic cloud session in under 10 minutes: sign up, configure the Playwright reporter with your API key, run a test, and explore the result in the cloud platform.

Appium / mobile testing

For Appium/WDIO cloud setup, see the Appium Cloud Quickstart.

Prerequisites

Node.js ≥ 18 and npm/yarn/pnpm
An existing Playwright project with @testrelic/playwright-analytics installed (see Get Started)
A testrelic.ai account (free to create)

1. Create your account

Go to testrelic.ai and click Sign Up.
Enter your name, email address, and a password.
Check your inbox for a verification code and enter it on the verification screen.

What happens next

After verifying your email, the onboarding wizard walks you through setting your profile, choosing your framework, and generating your first API key. See Onboarding for the full walkthrough.

When runs appear in the cloud, wire the TestRelic MCP into your IDE so an assistant can query runs, coverage, and failures without copying logs.

2. Generate an API key

In the TestRelic platform, navigate to Settings → API Keys, click Create new key, and copy the value — it is shown only once. See API Keys for details.

3. Configure the reporter

AI Prompt — Add API key to playwright.config.ts

Update my playwright.config.ts to enable TestRelic cloud upload.

1. Add apiKey: process.env.TESTRELIC_API_KEY and repoId: process.env.TESTRELIC_REPO_ID
   to the @testrelic/playwright-analytics reporter options.
2. Create a .env file in the project root:
   TESTRELIC_API_KEY=my_key_here
   TESTRELIC_REPO_ID=my_repo_id_here
3. Add .env to .gitignore.

Show me the updated playwright.config.ts reporter section.

AI Prompt — GitHub Actions for Playwright cloud

Create a GitHub Actions workflow file at .github/workflows/playwright.yml that:
1. Runs on push and pull_request events
2. Uses node 20
3. Runs: npm ci
4. Runs: npx playwright install --with-deps
5. Runs: npx playwright test
6. Passes TESTRELIC_API_KEY and TESTRELIC_REPO_ID from GitHub secrets as environment variables

Show me the complete workflow file.

4. Run your tests

Terminal

npx playwright test

The reporter uploads data automatically after the run completes, printing a confirmation line:

✓ TestRelic: Run uploaded — https://platform.testrelic.ai/dashboards/test-runs/<runId>

5. Explore the result

Click the printed URL, or open Test Runs and select your run to open the Session Workspace — the full DevTools-style inspection view.

Troubleshooting

Symptom	What to try
"API key invalid"	Double-check `TESTRELIC_API_KEY` for extra spaces and confirm the key is active in API Keys.
No run appears in the dashboard	Ensure the network can reach `platform.testrelic.ai`; check for a proxy or firewall blocking outbound HTTPS.
Sessions are missing network data	Requires `includeNetworkStats: true` in the reporter options (default `true`).
Video is missing	Requires `video: 'on'` or `video: 'retain-on-failure'` in Playwright's `use` block.

Cloud Quickstart