Documentation

From install to first PDF in under five minutes.

ReportForge turns Playwright and Cypress runs into designed PDF reports: the same three templates from Node.js, Python, .NET, and Cypress, on one subscription.

Pick your runner

Playwright · Node.js→npm install, three lines in playwright.config.ts.
Playwright · Python→pip install, pytest --pdf, defaults in pyproject.toml.
Playwright · .NET→One logger flag on dotnet test: NUnit, MSTest, xUnit.
Cypress→One plugin in setupNodeEvents; commands become repro steps.

Getting started · Node.js

Install→Add the package and peer deps to your project.
Quick start→Wire up the reporter and generate your first PDF.
License keys→Where RF_LICENSE_KEY comes from and how to set it in CI, for every runner.
Running tests→Chrome paths, OS-specific setup, and verifying output.

Other runners

Python→PDF reports for pytest-playwright runs, configured from pyproject.toml.
.NET→PDF reports for NUnit, MSTest, and xUnit Playwright runs via the VSTest logger.
Cypress→PDF reports for Cypress runs, with your test commands as the Steps to Reproduce.

Integration

CI/CD→GitHub Actions, GitLab, and Azure Pipelines configs.

Reference

Configuration→Every reporter option with types and defaults.
Templates→minimal, detailed, executive, and multi-template runs.

Advanced

Live runs→Stream per-test progress to a shared watch link while tests run.
Shard merging→Merge parallel shard JSON into one PDF without re-running tests.
Webhook notifications→Post Slack, Teams, or Discord summaries after each run.
History trending→Track pass-rate trends across runs with a local JSON store.
Failure analysis→Classify failures into root-cause categories and clusters in the detailed PDF.
Custom templates→Render your own Handlebars .hbs file with full context and helpers.
Data protection→Password-encrypt PDFs and redact credentials/PII from report content.

Licensing→How offline license validation and JWT caching work.
Troubleshooting→Debug logging, Chrome not found, license errors, and more.

Getting started · Node.js

Other runners

Integration

Reference

Advanced

More