Complete reference for configuring the Euriqa Playwright reporter, including all options, environment variables, and advanced settings.
Below is the complete configuration object with all available options and their defaults. Add this to your playwright.config.ts file.
import { defineConfig } from '@playwright/test';
export default defineConfig({
reporter: [
['@euriqa/euriqa-playwright', {
// Required — API key from your Euriqa dashboard
apiKey: process.env.EURIQA_API_KEY,
// Required — Project ID from your Euriqa dashboard
projectId: process.env.EURIQA_PROJECT_ID,
// API endpoint (default: https://app.euriqa.dev/api)
apiUrl: 'https://app.euriqa.dev/api',
// Reporting mode
realTimeStreaming: false, // Stream results as tests complete (paid)
allowLocalRuns: false, // Enable reporting from local dev (paid)
runTitle: undefined, // Custom title for the test run
// Artifact uploads
uploadScreenshots: true, // Upload test screenshots
uploadTraces: true, // Upload Playwright trace files
uploadVideos: true, // Upload test video recordings
uploadHtmlReport: false, // Upload full HTML report
htmlReportPath: 'playwright-report', // Path to HTML report folder
// File size limits (in bytes)
fileSizeLimits: {
screenshot: 5 * 1024 * 1024, // 5 MB
video: 100 * 1024 * 1024, // 100 MB
trace: 50 * 1024 * 1024, // 50 MB
htmlReport: 200 * 1024 * 1024, // 200 MB
},
// Performance
requestTimeout: 30000, // API request timeout (30s)
uploadTimeout: 300000, // File upload timeout (5min)
includeOutput: true, // Include stdout/stderr
debug: false, // Enable verbose logging
// Step categories to track (default: all)
stepCategories: ['action', 'assertion', 'hook', 'fixture'],
// Proxy configuration for corporate environments
proxy: {
protocol: 'http',
host: 'proxy.company.com',
port: 8080,
auth: {
username: 'user',
password: 'pass',
},
},
}],
// Keep your existing reporters
['html'],
],
});All configuration options can also be set via environment variables. Environment variables take precedence over config file values, making them ideal for CI/CD pipelines.
EURIQA_API_KEYstringRequiredyour-api-key are rejected.EURIQA_PROJECT_IDstringRequiredEURIQA_API_URLstringhttps://app.euriqa.dev/api. HTTPS is required except for localhost during development.EURIQA_REAL_TIME_STREAMINGbooleanfalse.EURIQA_ALLOW_LOCAL_RUNSbooleanfalse.EURIQA_RUN_TITLEstringEURIQA_BRANCHstringGIT_BRANCH.EURIQA_COMMIT_SHAstringGIT_COMMIT, CI_COMMIT_SHA.EURIQA_COMMIT_MESSAGEstringGIT_COMMIT_MESSAGE.EURIQA_AUTHORstringGIT_AUTHOR.EURIQA_UPLOAD_SCREENSHOTSbooleantrue.EURIQA_UPLOAD_TRACESbooleantrue.EURIQA_UPLOAD_VIDEOSbooleantrue.EURIQA_UPLOAD_HTML_REPORTbooleanfalse.EURIQA_DEBUGbooleanfalse.By default, the reporter tracks all step categories: actions, assertions, hooks, and fixtures. You can customize which categories are tracked to reduce noise or focus on specific areas.
reporter: [
['@euriqa/euriqa-playwright', {
apiKey: process.env.EURIQA_API_KEY,
projectId: process.env.EURIQA_PROJECT_ID,
// Default: all categories tracked
stepCategories: ['action', 'assertion', 'hook', 'fixture'],
}],
]reporter: [
['@euriqa/euriqa-playwright', {
apiKey: process.env.EURIQA_API_KEY,
projectId: process.env.EURIQA_PROJECT_ID,
// Only track user actions and assertions
stepCategories: ['action', 'assertion'],
}],
]Available step categories:
click, fill, goto, typeexpect calls and assertionsbeforeEach, afterEach, beforeAll, afterAllEach artifact type has a default size limit and a set of allowed file extensions. Files exceeding the size limit are logged with a warning and skipped — they will not cause the reporter to fail.
| Artifact Type | Default Limit | Allowed Extensions |
|---|---|---|
| Screenshots | 5 MB | .png, .jpg, .jpeg, .webp, .gif |
| Videos | 100 MB | .webm, .mp4, .avi, .mov |
| Traces | 50 MB | .zip |
| HTML Reports | 200 MB | .zip (entire report directory) |
| Generic Attachments | 10 KB inline / URL for larger | .png, .jpg, .json, .txt, .log, .zip, .html |
You can customize size limits using the fileSizeLimits option:
reporter: [
['@euriqa/euriqa-playwright', {
apiKey: process.env.EURIQA_API_KEY,
projectId: process.env.EURIQA_PROJECT_ID,
fileSizeLimits: {
screenshot: 10 * 1024 * 1024, // 10 MB
video: 200 * 1024 * 1024, // 200 MB
trace: 100 * 1024 * 1024, // 100 MB
htmlReport: 500 * 1024 * 1024, // 500 MB
},
}],
]The reporter supports three distinct modes for sending test results to the Euriqa platform.
By default, test results are collected during the run and sent as a single batch after all tests complete. This is the most efficient mode and is included in all plans.
reporter: [
['@euriqa/euriqa-playwright', {
apiKey: process.env.EURIQA_API_KEY,
projectId: process.env.EURIQA_PROJECT_ID,
// Batch mode is the default — no additional config needed
}],
]Stream test results to the dashboard as each test completes. See results live without waiting for the full run to finish. This is a paid feature.
reporter: [
['@euriqa/euriqa-playwright', {
apiKey: process.env.EURIQA_API_KEY,
projectId: process.env.EURIQA_PROJECT_ID,
realTimeStreaming: true,
}],
]By default, the reporter only sends results when running in a CI environment. Enable local runs to report results from your development machine. This is a paid feature.
reporter: [
['@euriqa/euriqa-playwright', {
apiKey: process.env.EURIQA_API_KEY,
projectId: process.env.EURIQA_PROJECT_ID,
allowLocalRuns: true,
}],
]allowLocalRuns is disabled (default), running tests locally will silently skip reporting. No errors are thrown — your tests run normally.The reporter automatically detects whether it is running in a CI environment by checking for the presence of common CI environment variables. If any of the following variables are set, the reporter considers the environment as CI:
CICONTINUOUS_INTEGRATIONBUILD_NUMBERGITHUB_ACTIONSGITLAB_CICIRCLECITRAVISJENKINS_URLTEAMCITY_VERSIONBUILDKITEBITBUCKET_PIPELINE_UUIDAZURE_PIPELINESCODEBUILD_BUILD_IDEven outside of CI, the reporter automatically detects Git metadata using the following commands. Each command has a 5-second timeout to avoid delays, and non-git environments are handled gracefully.
# Branch name
git rev-parse --abbrev-ref HEAD
# Commit SHA
git rev-parse HEAD
# Commit message
git log -1 --format=%s
# Author name
git log -1 --format=%anAll auto-detected values can be overridden using environment variables (EURIQA_BRANCH, EURIQA_COMMIT_SHA, EURIQA_COMMIT_MESSAGE, EURIQA_AUTHOR) or via the reporter configuration object.
For corporate environments that require a proxy for outbound connections, configure the proxy option in the reporter settings.
reporter: [
['@euriqa/euriqa-playwright', {
apiKey: process.env.EURIQA_API_KEY,
projectId: process.env.EURIQA_PROJECT_ID,
proxy: {
protocol: 'http', // 'http' or 'https'
host: 'proxy.company.com',
port: 8080,
auth: { // Optional authentication
username: 'proxyuser',
password: 'proxypass',
},
},
}],
]Enable debug mode to get verbose logging from the reporter. This is useful for troubleshooting connectivity issues, upload failures, or unexpected behavior.
reporter: [
['@euriqa/euriqa-playwright', {
apiKey: process.env.EURIQA_API_KEY,
projectId: process.env.EURIQA_PROJECT_ID,
debug: true,
}],
]Or enable via environment variable:
EURIQA_DEBUG=true npx playwright testWhen debug mode is enabled, the reporter logs detailed information including:
eur_****abcd instead of the full key.After tests complete, the reporter prints a summary to the console with key information about the run:
Euriqa Reporter
────────────────────────────────────
Tests: 42 passed, 3 failed, 2 skipped, 1 flaky
Run ID: run_abc123def456
Project: proj_xyz789
Playwright: 1.48.0 (4 workers)
CI: GitHub Actions
Branch: feature/login-flow
Commit: a1b2c3d
Screenshots: 5 uploaded
Videos: 3 uploaded
Traces: 3 uploaded
View results: https://app.euriqa.dev/runs/run_abc123def456
────────────────────────────────────The reporter includes several security measures to protect your data: