From 0e76e2e474e34156f9726430697a70cf7436b1e2 Mon Sep 17 00:00:00 2001 From: PJ Date: Mon, 8 Jun 2026 23:26:41 +0530 Subject: [PATCH] docs(cli): document ios-device doctor checks and the device flags The --ios-device flag now also selects a connected device; --ios-app-path covers the device install; the doctor gains an ios-device platform whose checks are devicectl, iproxy, a paired device, and signing credentials. Corrects the --clear-data default to true. --- docs/manual/cli.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/manual/cli.md b/docs/manual/cli.md index 0faf506..860b26e 100644 --- a/docs/manual/cli.md +++ b/docs/manual/cli.md @@ -19,11 +19,12 @@ Run a spec against an app for a fixed duration. | `--launcher-activity` | resolved | Optional `/` to launch. Overrides default resolution. | | `--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. | -| `--ios-device` | optional (ios) | iOS simulator name or UDID to boot if none is running. | +| `--ios-device` | optional (ios) | iOS target: a simulator name/UDID to boot, or a connected device's name, UDID, or CoreDevice id. | +| `--ios-app-path` | optional (ios) | Path to the `.app` bundle for clear-state reinstall (simulator via `simctl`, device via `devicectl`). | | `--duration` | `5m` | Total test duration (`30s`, `5m`, `2h`, `1d`). | | `--seed` | `0` | PRNG seed. `0` uses a random seed and records it in `meta.json`. | | `--output` | `./runs` | Output directory for traces. | -| `--clear-data` | `false` | Clear app data before launching so the run starts from a fresh install. | +| `--clear-data` | `true` | Clear app data before launching so the run starts from a fresh install. Pass `--clear-data=false` to resume prior state. | ## `sanderling replay [run-or-runs-dir]` @@ -42,7 +43,7 @@ See [the replay UI page](./replay/) for the panel reference and keyboard shortcu Check the host environment for a working sanderling setup. ``` -sanderling doctor [--platform web|android|ios|all] +sanderling doctor [--platform web|android|ios|ios-device|all] ``` `--platform` defaults to `all`, which runs every platform's checks (deduped). Pass a specific platform to scope the output. @@ -51,7 +52,8 @@ sanderling doctor [--platform web|android|ios|all] |---|---| | `web` | headless Chromium can launch (the bundled CDP surface boots a real browser). | | `android` | `adb` on PATH; `emulator` on PATH or under `ANDROID_HOME`; Java 17+; embedded native sidecar JAR is real. | -| `ios` | `xcrun` on PATH; `simctl` on PATH; Java 17+; embedded native sidecar JAR is real. | +| `ios` | `xcrun` on PATH; `simctl` on PATH. The simulator path drives the native companion with no JVM. | +| `ios-device` | the `ios` checks plus `devicectl`; `iproxy` on PATH; a connected, paired device; App Store Connect signing credentials present. | ## `sanderling version`