Files
sanderling/docs/manual/cli.md
T
pj d0578dbaaa fix(runner): warn on malformed screen snapshot (#13)
* fix(runner): warn on malformed screen snapshot

screenFromSnapshot swallowed json.Unmarshal errors, so a non-string
screen value silently became "" in the step log and trace while the
verifier still saw the raw JSON. Return the error and warn at the
call site, matching the hierarchy warning pattern.

* docs: clarify --avd is optional for uatu test

The CLI accepts --avd as an empty-string default (cmd/uatu/main.go:49)
and only requires it when no device is connected and multiple AVDs
exist (cmd/uatu/android_env.go:63). Docs and examples that showed it
as required or always-passed were misleading.
2026-04-18 17:14:31 +07:00

1.4 KiB

title
title
CLI reference

CLI reference

uatu <command> [flags]

uatu 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. Only android in the current alpha.
--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.

uatu doctor

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

uatu 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.
  • uatu inspect command for browsing traces in the built-in UI.

Tracked in issue #4.