@ralphralphai/playwright 0.2.0 → 1.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -4,12 +4,8 @@ Turn your Playwright tests into a map of your app for
 [Ralph](https://ralphralph.ai).
 
 Tag a test with `@ralph` and every page it visits is recorded: a full-page
-screenshot, the URL, and the position of every element carrying a
-`data-track-id`. Ralph builds a navigation graph from those recordings and
-overlays real user interactions on the screenshots as heatmaps.
-
-Your tests keep driving the app exactly as they do today. Untagged tests are
-untouched, and recording is off unless you turn it on.
+screenshot, the URL, and the position of every element with a `data-track-id`.
+Untagged tests are untouched, and recording is off unless you turn it on.
 
 ## Install
 
@@ -22,8 +18,7 @@ pnpm exec playwright install chromium
 
 ## Quick start
 
-**1. Add a `ralph.jsonc`** next to `playwright.config.ts`, listing the screen
-sizes to record at:
+**1. Add a `ralph.jsonc`** next to `playwright.config.ts`:
 
 ```jsonc
 {
@@ -33,9 +28,9 @@ sizes to record at:
 ```
 
 See [`@ralphralphai/config`](https://www.npmjs.com/package/@ralphralphai/config)
-for everything the file can declare.
+for all fields.
 
-**2. Import `test` from this package and tag the tests to record:**
+**2. Import `test` from this package and tag tests with `@ralph`:**
 
 ```ts
 import { test, expect } from '@ralphralphai/playwright';
@@ -47,24 +42,28 @@ test('checkout', { tag: '@ralph' }, async ({ page }) => {
 });
 ```
 
-Every URL the test reaches is recorded automatically. You don't need to call
-anything.
+**3. Add the Ralph reporter** in `playwright.config.ts`:
+
+```ts
+export default defineConfig({
+  reporter: [['list'], ['@ralphralphai/playwright/reporter']],
+});
+```
 
-**3. Run with recording on:**
+**4. Run:**
 
 ```sh
 RALPH_MODE=local pnpm exec playwright test
 ```
 
-Recordings are saved into Playwright's test output directory. To send them to
-Ralph instead, see [Uploading to Ralph](#uploading-to-ralph).
+The merged graph for the run is written to `test-results/ralph/`. To send it to
+Ralph, see [Uploading to Ralph](#uploading-to-ralph).
 
 ## Tag your elements
 
-Ralph records the position of every visible element with a `data-track-id`, so
-it can place heatmap data on the screenshot. Use the same ids your
+Add `data-track-id` to elements, using the same ids as your
 [`@ralphralphai/tracker`](https://www.npmjs.com/package/@ralphralphai/tracker)
-setup uses:
+setup:
 
 ```html
 <button data-track-id="add-to-cart">Add to cart</button>
@@ -72,21 +71,15 @@ setup uses:
 
 ## Recording pages
 
-### Automatically, on every URL change
-
-In a `@ralph` test, Ralph records a page whenever the URL changes in any tab of
-the test's browser context:
+### Automatically
 
-- full page loads, redirects (the final page), and SPA route changes
-- query-string and hash changes
-- new tabs and popups
+A page is recorded whenever the URL changes in any tab of the test: page loads,
+redirects (the final page), SPA route changes, query and hash changes, and new
+tabs and popups. Reloads, iframes, `about:blank`, and changes that keep the URL
+are not recorded.
 
-It does not record `about:blank`, iframes, reloads of the same URL, or changes
-to the page that don't change the URL.
-
-Each recording waits for the DOM to load, then another 150 ms (`settleMs`) for
-the page to render. If your app needs longer, use the `ready` option to say when
-a page is ready:
+Each recording waits for the DOM to load plus `settleMs` (150 ms). If your app
+needs longer, use `ready`:
 
 ```ts
 ralphOptions: {
@@ -96,10 +89,13 @@ ralphOptions: {
 },
 ```
 
+CSS animations and transitions are frozen for the screenshot. For animations
+driven from JavaScript, set `reduceMotion` if your app honors
+`prefers-reduced-motion`.
+
 ### Explicitly, for states at the same URL
 
-Dialogs, menus, and tabs often change the page without changing the URL. Record
-them with `ralph.recordNode`:
+For dialogs, menus, and tabs, call `ralph.recordNode` after your assertions:
 
 ```ts
 test('shipping options', { tag: '@ralph' }, async ({ page, ralph }) => {
@@ -114,98 +110,111 @@ test('shipping options', { tag: '@ralph' }, async ({ page, ralph }) => {
 });
 ```
 
-`recordNode` records the page as it is right now, without waiting for it to
-settle, so call it after your assertions. The `url` option only changes what is
-recorded; the browser doesn't navigate. Relative URLs resolve against the
-current page.
+`url` only changes what is recorded; the browser doesn't navigate.
 
-### Waiting for recordings
+### Waiting for capture
 
-Recording runs in the background, so your test isn't slowed down. If the test
-moves on before a screenshot finishes, that recording is marked `superseded`
-rather than attributed to the wrong page. When you need a page recorded before
-leaving it, wait for pending recordings first:
+Recordings run in the background. If the test leaves a page before its
+screenshot is done, the page is `uncaptured`: it's in the graph without a
+screenshot. To make sure a page is captured before leaving it:
 
 ```ts
 await page.goto('https://example.com/pricing');
-await ralph.flush(); // make sure /pricing is recorded
+await ralph.waitForCapture();
 await page.goto('https://example.com/signup');
 ```
 
-### Browser contexts you create yourself
+### Pausing capture
+
+To leave steps out of the graph:
+
+```ts
+await page.goto('https://example.com/a');
+ralph.pause();
+await page.goto('https://example.com/b'); // not recorded
+await page.goto('https://example.com/c'); // not recorded
+ralph.resume();
+await page.goto('https://example.com/d'); // recorded, linked from /a
+```
+
+This works across tabs. While paused, `recordNode` does nothing. `resume` does
+not record the current page.
 
-The standard `context` and `page` fixtures are recorded for you. For a context
-you create yourself, enroll it, and flush before closing it:
+### Browser contexts you create yourself
 
 ```ts
 const context = await browser.newContext();
 ralph.observe(context);
 // ...
-await ralph.flush();
+await ralph.waitForCapture();
 await context.close();
 ```
 
 ### When recording fails
 
-- An explicit `recordNode` call that fails rejects, like any other failing
-  step.
-- A failed automatic recording fails an otherwise passing test at the end, so
-  missing pages don't go unnoticed. The reason is recorded with the results.
-- A superseded recording, or a page whose layout moved during its screenshot,
-  doesn't fail the test.
+- A failed `recordNode` call rejects.
+- A failed automatic recording fails the test at the end.
+- Pages left before capture, and pages whose layout moved during the
+  screenshot, don't fail the test.
 
 ## Modes
 
-Set the mode with `RALPH_MODE` or the `mode` option:
-
-| Mode     | What happens                                                                                                                             |
-| -------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
-| `off`    | Default. Nothing is recorded, no Ralph config or credentials are needed, and `ralph.recordNode` does nothing.                              |
-| `local`  | `@ralph` tests are recorded into Playwright's output directory.                                                                          |
-| `upload` | As `local`, and each test's recordings are uploaded to Ralph when it finishes. Chosen automatically when `RALPH_UPLOAD_KEY` is set and no mode is. |
+Set with `RALPH_MODE` or the `mode` option:
 
-Tests without the `@ralph` tag are never recorded, in any mode. In `local` or
-`upload` mode, calling `ralph.recordNode` in an untagged test throws a reminder
-to add the tag.
+| Mode     | What happens                                                                                        |
+| -------- | --------------------------------------------------------------------------------------------------- |
+| `off`    | Default. Nothing is recorded, and no config or credentials are needed.                              |
+| `local`  | `@ralph` tests are recorded, and the reporter writes the merged graph locally.                      |
+| `upload` | As `local`, and the reporter uploads the graph once the run ends. Default when `RALPH_UPLOAD_KEY` is set. |
 
-Tests that import from `@playwright/test` directly keep working alongside Ralph
-tests.
+Untagged tests are never recorded. In `local` or `upload` mode, calling
+`ralph.recordNode` in an untagged test throws.
 
 ## Uploading to Ralph
 
-1. Create an upload key for your Ralph project with the authenticated
-   `/api/project/key/create` endpoint. One key covers every app in the project.
-   Keep it in your CI secrets.
-2. Set these, as environment variables or options:
+1. Create an upload key for your project with `/api/project/key/create`, and
+   keep it in your CI secrets.
+2. Set these as environment variables, or `apiUrl` and `appId` as
+   [reporter options](#reporter-options):
 
-   | Variable           | Option   | Value                                  |
-   | ------------------ | -------- | -------------------------------------- |
-   | `RALPH_UPLOAD_KEY` |          | The upload key. Environment only.      |
-   | `RALPH_API_URL`    | `apiUrl` | Your Ralph server, e.g. `https://…`    |
-   | `RALPH_APP_ID`     | `appId`  | The app these recordings belong to     |
+   | Variable           | Value                                           |
+   | ------------------ | ----------------------------------------------- |
+   | `RALPH_UPLOAD_KEY` | The upload key. Environment only.               |
+   | `RALPH_API_URL`    | Your Ralph server. HTTPS, or HTTP on localhost. |
+   | `RALPH_APP_ID`     | The app the recordings belong to.               |
 
 3. Run:
 
    ```sh
-   RALPH_MODE=upload RALPH_API_URL=https://your-ralph-server.example RALPH_APP_ID=<app id> \
-     pnpm exec playwright test
+   RALPH_MODE=upload pnpm exec playwright test
    ```
 
-Each attempt of a `@ralph` test uploads once when it finishes. The upload
-receipt is attached to the test as `ralph-upload-receipt`, and its `resultId`
-opens the upload in the Ralph dashboard at `/uploads/<resultId>`. The upload key
-is never written to the results or the receipt.
+The reporter uploads the whole run once and prints the link:
 
-`RALPH_API_URL` must be HTTPS. Plain HTTP is accepted only for `localhost`,
-`127.x.x.x`, and `[::1]`, for local development.
+```
+Ralph: uploaded the run's raw graph. https://dash.ralphralph.ai/uploads/0f6c6a2e-…
+```
+
+- Retried tests contribute only their final attempt.
+- Every test in a run must use the same Ralph config, `runId`, and `buildId`.
+- If the upload fails, the run fails.
+
+### Sharded runs
 
-If an upload fails, the test fails.
+Use the `blob` reporter on each shard, then merge with the Ralph reporter:
+
+```sh
+# Each shard (no upload credentials needed):
+RALPH_MODE=upload pnpm exec playwright test --shard=1/4 --reporter blob
+
+# Once, after collecting every shard's blob-report/ into all-blob-reports/:
+RALPH_MODE=upload RALPH_UPLOAD_KEY=… RALPH_API_URL=… RALPH_APP_ID=… \
+  pnpm exec playwright merge-reports --reporter @ralphralphai/playwright/reporter ./all-blob-reports
+```
 
 ## Screen sizes
 
-A browser context's viewport is fixed, so each entry in `screenSizes` becomes
-its own Playwright project. `ralphProjects` expands one project into one per
-size:
+Use `ralphProjects` to create one project per entry in `screenSizes`:
 
 ```ts
 import { defineConfig, devices } from '@playwright/test';
@@ -213,10 +222,8 @@ import { ralphProjects, type RalphFixtures } from '@ralphralphai/playwright';
 
 export default defineConfig<RalphFixtures>({
   projects: [
-    // Ordinary tests keep their single project.
     { name: 'chromium', grepInvert: /@ralph\b/, use: devices['Desktop Chrome'] },
-    // With screenSizes 375x812 and 1280x720, this creates the projects
-    // "chromium 375x812" and "chromium 1280x720".
+    // Creates "chromium 375x812", "chromium 1280x720", …
     ...ralphProjects({
       name: 'chromium',
       grep: /@ralph\b/,
@@ -226,34 +233,23 @@ export default defineConfig<RalphFixtures>({
 });
 ```
 
-`ralphProjects` reads `ralph.jsonc` from the current directory. If Playwright
-runs from elsewhere, pass `{ root: import.meta.dirname }` (or `__dirname`), or
-an inline `config`, as the second argument. Keep it pointing at the same config
-as `ralphOptions`.
+`ralphProjects` reads `ralph.jsonc` from the current directory. Otherwise pass
+`{ root: import.meta.dirname }` or an inline `config` as the second argument.
 
-A test runs at every size by default. A mobile flow is usually a different test
-from its desktop flow, so tag a test or `describe` block with
-`@ralph-screen:WIDTHxHEIGHT`, once per size, to run it only at those sizes:
+A test runs at every size. To run it only at some sizes, tag it or its
+`describe` block with `@ralph-screen:WIDTHxHEIGHT`, once per size:
 
 ```ts
-test(
-  'mobile navigation',
-  { tag: ['@ralph', '@ralph-screen:375x812'] },
-  async ({ page }) => {
-    await page.getByRole('button', { name: 'Menu' }).click();
-  },
-);
+test('mobile navigation', { tag: ['@ralph', '@ralph-screen:375x812'] }, async ({ page }) => {
+  await page.getByRole('button', { name: 'Menu' }).click();
+});
 
 test.describe('desktop layouts', { tag: '@ralph-screen:1280x720' }, () => {
   test('sidebar', { tag: '@ralph' }, async ({ page }) => {});
 });
 ```
 
-- Tags on a `describe` block and its tests combine.
-- Screen tags apply in every mode, because they choose which tests run.
-- A size missing from `screenSizes` fails the test, so a typo can't silently
-  skip it.
-- Projects not created by `ralphProjects` ignore screen tags.
+A size missing from `screenSizes` fails the test.
 
 To run one size: `playwright test --project "chromium 375x812"`.
 
@@ -262,55 +258,46 @@ To run one size: `playwright test --project "chromium 375x812"`.
 Set `ralphOptions` in `playwright.config.ts`, or per file with `test.use`:
 
 ```ts
-import { defineConfig } from '@playwright/test';
-import type { RalphFixtures } from '@ralphralphai/playwright';
-
 export default defineConfig<RalphFixtures>({
   use: {
-    ralphOptions: {
-      mode: 'local',
-      configPath: './ralph.jsonc',
-      buildId: process.env.GIT_SHA,
-      settleMs: 300,
-    },
+    ralphOptions: { mode: 'local', buildId: process.env.GIT_SHA, settleMs: 300 },
   },
 });
 ```
 
-| Option            | Default               | What it does                                                                                     |
-| ----------------- | --------------------- | ------------------------------------------------------------------------------------------------ |
-| `mode`            | `RALPH_MODE`, else `off` | `off`, `local`, or `upload`. See [Modes](#modes).                                              |
-| `configPath`      | `ralph.jsonc`         | Path to the config, relative to the Playwright config's directory.                               |
-| `config`          |                       | An inline config instead of a file.                                                              |
-| `apiUrl`          | `RALPH_API_URL`       | Your Ralph server, for uploads.                                                                  |
-| `appId`           | `RALPH_APP_ID`        | The app recordings belong to, for uploads.                                                       |
-| `uploadTimeoutMs` | 30000                 | How long an upload may take.                                                                     |
-| `buildId`         | `RALPH_BUILD_ID`      | Your app's build, so recordings line up with the analytics from that build.                      |
-| `runId`           | `RALPH_RUN_ID`        | Groups the tests of one CI run.                                                                  |
-| `settleMs`        | 150                   | How long to wait after the DOM loads before an automatic recording.                              |
-| `recordTimeoutMs` | 5000                  | How long one recording may take, including settling and `ready`. Must be more than `settleMs`.   |
-| `ready`           |                       | `(page, signal) => Promise<void>`. Waits for your app to be ready before an automatic recording. |
-
-`ready` is bounded by `recordTimeoutMs`. Ralph stops waiting when time runs out
-but can't cancel your code, so honor `signal` or use Playwright operations with
-their own timeouts.
-
-Config files accept comments and trailing commas, and are validated when the
-first `@ralph` test in a worker starts. Keep the config unchanged during a run.
-
-For an inline config, the type is re-exported:
+| Option            | Default                  | What it does                                                                                    |
+| ----------------- | ------------------------ | ----------------------------------------------------------------------------------------------- |
+| `mode`            | `RALPH_MODE`, else `off` | `off`, `local`, or `upload`. See [Modes](#modes).                                               |
+| `configPath`      | `ralph.jsonc`            | Path to the config, relative to the Playwright config.                                          |
+| `config`          |                          | An inline config instead of a file (type: `WebRalphConfig`).                                    |
+| `buildId`         | `RALPH_BUILD_ID`         | Your app's build, to line up recordings with its analytics.                                     |
+| `runId`           | `RALPH_RUN_ID`           | Identifies the CI run.                                                                          |
+| `settleMs`        | 150                      | Wait after the DOM loads before an automatic recording.                                         |
+| `recordTimeoutMs` | 5000                     | Budget for one recording, including `settleMs` and `ready`. Must exceed `settleMs`.             |
+| `ready`           |                          | `(page, signal) => Promise<void>`. Waits for your app before an automatic recording. Honor `signal`. |
+| `reduceMotion`    | `false`                  | Emulates `prefers-reduced-motion: reduce` and waits for finite animations before recording.     |
 
-```ts
-import type { WebRalphConfig } from '@ralphralphai/playwright';
+## Reporter options
 
-const config: WebRalphConfig = { screenSizes: [{ width: 1280, height: 720 }] };
+```ts
+reporter: [['list'], ['@ralphralphai/playwright/reporter', { appId: 'my-app' }]],
 ```
 
+| Option            | Default                                           | What it does                                    |
+| ----------------- | ------------------------------------------------- | ----------------------------------------------- |
+| `mode`            | `RALPH_MODE`, else `upload` if `RALPH_UPLOAD_KEY` | `upload` uploads the run.                       |
+| `apiUrl`          | `RALPH_API_URL`                                   | Your Ralph server.                              |
+| `appId`           | `RALPH_APP_ID`                                    | The app the recordings belong to.               |
+| `uploadTimeoutMs` | 120000                                            | Upload timeout.                                 |
+| `outputDir`       | `ralph/` in the first project's output directory  | Where the merged graph is written.              |
+
+The run is also uploaded when any test ran in `upload` mode.
+
 ## Limits
 
-Per test attempt: 500 screenshots, 64 MiB of screenshots, 2 MiB of recorded
-data besides the screenshots, and 64 MiB compressed. The server accepts up to
-5,000 recorded pages. Split larger flows into several tests.
+Per run: 5,000 screenshots, 256 MiB of screenshots, 16 MiB of other recorded
+data, 256 MiB compressed, 20,000 recorded pages, and 5,000 recorded pages per
+test.
 
 ## License