Skip to main content

Getting started

License key

Get your key

ReportForge requires an active subscription to generate PDFs. Start a 7-day free trial at reportforge.org/pricing (card required, no charge until day 8).

After signup you receive a license key for each supported test runner by email, and they are all listed in your dashboard. Keys have the format RFXX-XXXX-XXXX-XXXX-XXXX, where the first four characters identify the runner: RFPW Playwright on Node, RFPY Playwright on Python, RFNT Playwright on .NET, and RFCY Cypress.

Use the key that matches the runner you are configuring. Each key carries its own machine allowance, so a key used on the wrong runner is refused with a message naming both.

Set as environment variable

# Linux / macOS  (RFPW shown; use your runner's key)export RF_LICENSE_KEY=RFPW-XXXX-XXXX-XXXX-XXXX# Windows (PowerShell)$env:RF_LICENSE_KEY = "RFPW-XXXX-XXXX-XXXX-XXXX"# Windows (Command Prompt)set RF_LICENSE_KEY=RFPW-XXXX-XXXX-XXXX-XXXX

In CI, add RF_LICENSE_KEY as a secret in your CI provider (GitHub Actions Secrets, GitLab Variables, etc.).

In playwright.config.ts

Alternatively, pass the key directly via the licenseKey option:

reporter: [['@reportforge/playwright-pdf', {  licenseKey: process.env.RF_LICENSE_KEY,}]]

Without a valid key the reporter logs a one-line warning and skips PDF generation; your tests still run normally. See Licensing & offline behaviour for the full lifecycle.