pj/sanderling
1
0 Fork 0
mirror of https://github.com/priyanshujain/sanderling.git synced 2026-10-02 19:17:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(cli): document ios-device doctor checks and the device flags

Browse Source 
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.
This commit is contained in:
pj committed 2026-06-08 23:26:41 +05:30
1 parent c60e4ac2f4
commit 0e76e2e474
1 file changed
+6 -4
Download Patch File Download Diff File Expand all files Collapse all files
docs/manual/cli.md
+6 -4
View File
@@ -19,11 +19,12 @@ Run a spec against an app for a fixed duration.
| `--launcher-activity` | resolved | Optional `<pkg>/<activity>` to launch. Overrides default resolution. | | `--launcher-activity` | resolved | Optional `<pkg>/<activity>` to launch. Overrides default resolution. |
| `--platform` | `android` | Target platform: `android`, `ios`, or `web`. | | `--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. | | `--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`). | | `--duration` | `5m` | Total test duration (`30s`, `5m`, `2h`, `1d`). |
| `--seed` | `0` | PRNG seed. `0` uses a random seed and records it in `meta.json`. | | `--seed` | `0` | PRNG seed. `0` uses a random seed and records it in `meta.json`. |
| `--output` | `./runs` | Output directory for traces. | | `--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]` ## `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. 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. `--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). | | `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. | | `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` ## `sanderling version`