docs(manual): add web prerequisites and folio-web example

Update --platform flag to list android, ios, web. Add web prerequisites
section (Chrome, no SDK needed) and folio-web quick-start to
getting-started.
This commit is contained in:
pj committed 2026-04-23 00:05:58 +07:00
1 parent 69aa833720
commit 229f642f54
2 files changed
+23 -2

No files matched your search

+1 -1
View File
@@ -17,7 +17,7 @@ Run a spec against an app for a fixed duration.
| `--spec` | required | Path to the TypeScript spec. |
| `--bundle-id` | required | Target app bundle ID (Android: applicationId). |
| `--launcher-activity` | resolved | Optional `<pkg>/<activity>` to launch. Overrides default resolution. |
| `--platform` | `android` | Target platform. Only `android` in the current alpha. |
| `--platform` | `android` | Target platform: `android`, `ios`, or `web`. |
| `--avd` | optional (android) | Android AVD name to boot if no device is connected. Required only when no device is connected and multiple AVDs exist. |
| `--duration` | `5m` | Total test duration (`30s`, `5m`, `2h`, `1d`). |
| `--seed` | `0` | PRNG seed. `0` uses a random seed and records it in `meta.json`. |
+22 -1
View File
@@ -8,10 +8,17 @@ Install the CLI, link the SDK into your debug build, run a spec.
## Prerequisites
- An Android emulator with API level 30 or newer.
**Android / iOS:**
- An Android emulator with API level 30 or newer (or a connected device).
- The app under test built as a debug variant with the sanderling Android SDK linked in.
- `adb` on your PATH.
**Web:**
- Chrome installed. sanderling drives it via CDP; no other setup required.
- No in-app SDK needed.
Run `sanderling doctor` to check the host environment.
## Install
@@ -38,6 +45,8 @@ dependencies {
## Your first run
### Android
The repo ships a working sample at `examples/folio`, a Kotlin Multiplatform app with a TypeScript spec under `sanderling/spec.ts`. Install `just`, then from `examples/folio`:
```sh
@@ -53,6 +62,18 @@ AVD=Pixel_7 just test
Persistent settings can live in a `.env` alongside the justfile (`AVD=Pixel_7`, `DURATION=5m`, and so on).
### Web
The repo also ships a web sample at `examples/folio-web`, a React/Vite app with the same domain logic. From `examples/folio-web`:
```sh
just test # starts Chrome, runs the spec
```
No emulator or SDK setup needed.
### Trace output
When the run ends, the trace lands in `sanderling/runs/<timestamp>/`:
```