Files
sanderling/docs/manual/cli.md
T
pj dd54c24c4e feat: --clear-data flag + typed attribute selectors (#48)
* feat(test): add --clear-data flag to clear app data on launch

* test+docs: cover --clear-data flag in CLI parser test and reference

* feat(spec): type AttrSelector with known attribute names

Replace AttrSelector = Record<string, string> with KnownAttrSelectors
plus a string|boolean index signature, so authors get autocomplete and
type-checking on testTag / focused / clickable / etc. while raw driver
attributes still type-check via the fallback. Boolean state attributes
accept native booleans; goja stringifies them at the marshal boundary.

AccessibilityElement.attrs becomes RawAttrs (typed string-valued shape
of the same canonical names) so element.attrs.testTag autocompletes.

* test(verifier): native boolean selector value matches focused=true

* docs+folio: use native boolean for focused selector and document typed attrs
2026-04-27 01:02:21 +07:00

2.1 KiB

title
title
CLI reference

CLI reference

sanderling <command> [flags]

sanderling test

Run a spec against an app for a fixed duration.

Flag Default Description
--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: 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.
--output ./runs Output directory for traces.
--clear-data false Clear app data before launching so the run starts from a fresh install.

sanderling inspect [run-or-runs-dir]

Serve a local web UI for browsing traces. The positional argument is optional and may point at either a runs directory (the parent of many runs) or a single run directory (auto-detected by the presence of meta.json). Defaults to ./runs.

Flag Default Description
--port 0 (ephemeral) TCP port to listen on.
--no-open false Skip opening the default browser on startup.
--dev false Reverse-proxy non-API requests to the Vite dev server on 127.0.0.1:5173.

See the inspect UI page for the panel reference and keyboard shortcuts.

sanderling doctor

Check the host environment for a working sanderling setup: Go toolchain, JDK, Maestro availability, emulator reachability, SDK linkage hints.

sanderling version

Print the CLI version.

Flags coming in v0.1.0

  • --permissions to pre-set OS-level permissions (for example --permissions location=allow,notifications=deny).
  • --max-steps hard cap on step count.
  • --exit-on-violation stop the run on the first property violation.

Tracked in issue #4.