diff --git a/docs/manual/cli.md b/docs/manual/cli.md index c5b5bf2..c7980b1 100644 --- a/docs/manual/cli.md +++ b/docs/manual/cli.md @@ -16,7 +16,8 @@ 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 `/` to launch. Overrides default resolution. | +| `--device` | optional (android) | Android device serial, as `adb devices` reports it. Required when more than one device is attached. | +| `--android-app-path` | optional (android) | Path to the APK. Clear-state reinstalls from it instead of running `pm clear`. | | `--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 target: a simulator name/UDID to boot, or a connected device's name, UDID, or CoreDevice id. | @@ -24,6 +25,7 @@ Run a spec against an app for a fixed duration. | `--duration` | `5m` | Total test duration (`30s`, `5m`, `2h`, `1d`). | | `--max-steps` | `0` | Stop after this many steps (`0` = no cap, the duration governs). A step budget is what makes two generators comparable. | | `--exit-on-violation` | `false` | Stop the run at the first property violation and exit `2`. | +| `--arm` | optional | Experiment label recorded in the run's metadata. Used by the campaign tool to tell one sweep cell from another. | | `--seed` | `0` | PRNG seed. `0` uses a random seed and records it in `meta.json`. | | `--generator` | `seeded` | Who picks each action: `seeded` (the run's PRNG) or `llm` (a vision model). See [the LLM generator](../spec-language/#llm-generator). | | `--output` | `./runs` | Output directory for traces. | diff --git a/docs/manual/runs.md b/docs/manual/runs.md index cec7b05..847c0d1 100644 --- a/docs/manual/runs.md +++ b/docs/manual/runs.md @@ -13,7 +13,7 @@ A run is not a unit test. The closer picture is: boot a fuzzer for an hour and s ``` sanderling test --spec spec.ts --bundle-id com.example.app --duration 30m │ - ├── launch the app under test (pass --clear-data to wipe app data first) + ├── launch the app under test (wipes app data first unless --clear-data=false) ├── boot the sidecar (or connect to Chrome on web) ├── bundle the spec, load it into the JS runtime │ @@ -63,4 +63,6 @@ A run ends when: - `--duration` elapses, or - the process is interrupted (Ctrl+C). -Additional conditions (`--max-steps`, `--exit-on-violation`, hard crash handling) land in the [v0.1.0 milestone](https://github.com/priyanshujain/sanderling/milestone/1). +- `--max-steps` is reached, or `--exit-on-violation` was passed and a property was violated. + +Hard crash handling lands in the [v0.1.0 milestone](https://github.com/priyanshujain/sanderling/milestone/1).