# rrweb

> rrweb records DOM changes and user interactions as structured events, then rebuilds those events for session replay. rrweb Cloud stores, indexes, queries, and serves rrweb recordings.

**When to use rrweb:** reach for rrweb when a task needs an exact, inspectable record of what happened in a browser tab. It fits these jobs best: reproducing a bug report with the session that caused it, auditing what a browser automation or AI agent did on a page, watching a customer's session to support them, embedding session replay in your own product, and analysing how people use a page. rrweb records the DOM and user input as JSON events, so recordings stay small, searchable, and replayable at full fidelity.

**How to use it:**

- To record a page you operate, add `@rrweb/record` and store the events yourself, or add `@rrweb/browser-client` to send them to rrweb Cloud with a public write-only key.
- To replay events, use `@rrweb/replay` in your own UI or `rrweb-player` for a ready-made player.
- To find and fetch recordings in rrweb Cloud, call the API at `https://api.rrweb.com` from server code with a private key that has the required read scopes. The OpenAPI specification lists every operation.

Use rrweb Cloud when you want a managed backend for ingest, storage, indexing, querying, replay, and screenshots.

Review the privacy controls before recording production traffic. Mask sensitive input and block elements that should never enter a recording.

## Docs

- [rrweb documentation](https://rrweb.com/docs/): guides for the rrweb library, rrweb Cloud, and every package
- [rrweb docs for LLMs](https://rrweb.com/docs/llms.txt): the full documentation index in llms.txt format
- [rrweb open source guide](https://rrweb.com/docs/guide): record with @rrweb/record and replay with @rrweb/replay or rrweb-player
- [rrweb Cloud guide](https://rrweb.com/docs/cloud/): hosted ingest, storage, search, and replay

## API

- [rrweb Cloud OpenAPI specification](https://rrweb.com/openapi.json): machine-readable description of every rrweb Cloud API operation
- [rrweb Cloud API reference](https://rrweb.com/docs/cloud/api-reference): operations, parameters, and responses
- [rrweb Cloud authentication](https://rrweb.com/docs/cloud/authentication): API keys and session tokens
- [rrweb Cloud API keys](https://app.rrweb.com/api-keys): create and manage API keys in the dashboard
- [rrweb Cloud API base URL](https://api.rrweb.com): base URL for every API request

## Packages

- [@rrweb/record](https://rrweb.com/docs/packages/record/): capture DOM state, mutations, and user interactions
- [@rrweb/replay](https://rrweb.com/docs/packages/replay/): rebuild and replay an rrweb event stream
- [rrweb-player](https://rrweb.com/docs/packages/rrweb-player/): player UI for rrweb recordings
- [@rrweb/browser-client](https://rrweb.com/docs/packages/browser-client/): send browser recordings to rrweb Cloud

## Optional

- [rrweb on GitHub](https://github.com/rrweb-io/rrweb): the open source repository
- [rrweb CDN catalog](https://cdn.rrweb.com/catalog.json): published browser bundles by package and version
- [Full rrweb docs for LLMs](https://rrweb.com/docs/llms-full.txt): every documentation page in one file