Skip to content

CLI Reference

CommandDescription
probe initScaffold probe.yaml and tests/ directory
probe test [path]Run .probe test files
probe lint [path]Validate .probe files for syntax errors
probe device listList connected devices/simulators
probe device startStart an emulator/simulator
probe recordRecord user interactions as ProbeScript
probe reportGenerate HTML report from test results
probe migrateConvert Maestro YAML flows to ProbeScript
probe generateAI-assisted test generation
probe studioLaunch interactive test studio

Run .probe test files against a connected device.

Terminal window
probe test [path] [flags]
FlagDefaultDescription
--device <serial>autoTarget device UDID or serial
--tag <tag>Run only tests matching this tag
--timeout <duration>30sPer-step timeout
--format <fmt>terminalOutput format: terminal, junit, json
-o, --output <path>Output file path for reports
-v, --verbosefalseVerbose output
-y, --yesfalseAuto-confirm destructive ops + auto-grant permissions
--watchfalseWatch mode — re-run on file changes
--videofalseEnable video recording per test
--video-resolution720x1280Android screenrecord resolution
--video-framerate2Video framerate (fps)
--visual-threshold0.5Max allowed pixel diff % for visual regression
--visual-pixel-delta8Pixel color delta tolerance
--port <int>48686Agent WebSocket port
--dial-timeout30sWebSocket connection timeout
--token-timeout30sAgent auth token wait timeout
--reconnect-delay2sPost-restart reconnect delay
--app-path <path>Install app before testing
--adb <path>adbOverride ADB binary path
--flutter <path>flutterOverride Flutter binary path
--config <path>probe.yamlConfig file path
--shard <N/M>Run shard N of M (for parallel CI)
--dry-runfalseParse and validate without executing
Terminal window
# Run all tests verbosely
probe test tests/ -v
# Run with custom timeout and auto-confirm
probe test tests/ --device emulator-5554 --timeout 60s -y
# Generate JUnit report for CI
probe test tests/ --format junit -o reports/results.xml
# Parallel CI sharding
probe test tests/ --shard 1/3
probe test tests/ --shard 2/3
probe test tests/ --shard 3/3

Validate .probe files without executing them.

Terminal window
probe lint tests/
probe lint tests/smoke/login.probe

Record user interactions and generate ProbeScript.

Terminal window
probe record --device <UDID> --output tests/my_flow.probe
probe record --timeout 60s -o tests/flow.probe

Generate an HTML report from JSON test results.

Terminal window
probe report --input reports/results.json -o reports/report.html
probe report --input reports/results.json -o reports/report.html --open

Manage connected devices and emulators.

Terminal window
probe device list
probe device start --platform android
probe device start --platform ios

Standalone tool for converting tests from other frameworks. See probe-convert for full documentation.

Terminal window
probe-convert <file|dir> [flags]
probe-convert catalog [lang]
probe-convert formats