Skip to content

Documentation

Connect something in four minutes.

ReadyForUsers needs no test scripts and no instrumentation to start. These pages cover the paths that do need setup: CI, invariants and webhooks.

QUICK STARTYour first simulationROLLING OUT
$ npx readyforusers connect https://staging.example.com
✓ reachable · 200 OK · staging detected
✓ product twin built · 37 screens · 8 apis
$ npx readyforusers run --mode launch-check
→ 1,000 modeled users released
→ 24 incidents · 3 critical · confidence 86%

No config file, no selectors, no fixtures. The hosted CLI and app are rolling out to early-access workspaces. Request access and we will switch yours on.

01Quick Start4 MIN

Connect an application and run your first simulation.

02Connect Web App3 PAGES

URLs, test logins, environment detection and overrides.

03Connect GitHub5 PAGES

Repository scopes, branches, preview deployments and PR checks.

PRIVATE BETA
04Connect Mobile4 PAGES

APK and IPA uploads, device pools, permission simulation.

PRIVATE BETA
05API12 PAGES

REST reference for runs, incidents, packets and verification.

06CLI6 PAGES

readyforusers connect, run, watch and export for local and CI use.

07SDK5 PAGES

Optional in-app hooks for richer state capture.

08CI/CD7 PAGES

GitHub Actions, GitLab CI and generic webhook triggers.

PRIVATE BETA
09Invariants8 PAGES

Writing rules your product must never break, in plain English.

10Repair Packets6 PAGES

Schema, destinations and building your own consumer.

ROLLING OUT
11Webhooks4 PAGES

Run lifecycle, incident and verification events.

Start here

Connect your first application2 MIN
Read what ReadyForUsers discovered1 MIN
Run a Launch Check24 MIN
Send your first Repair Packet1 MIN

Repair Packet schema

The packet is provider-neutral and versioned. If you build your own repair pipeline, this is the contract.

packet/v2.schema.json

Language ReadyForUsers uses

SimulationOne release of a population into your product. Not a test run.
ActorAn individual synthetic person with goals, traits and memory.
WorldThe shared environment actors occupy together.
MutationA generated neighbouring scenario around a known failure.
Repair PacketAI-ready fix context: reproduction, evidence, strategy, risks.
Product TwinReadyForUsers's accumulated understanding of your application.