Skip to content

CLI

simdeck is the main entrypoint for opening the browser UI, managing the daemon, and scripting simulator actions.

Common Use

sh
simdeck
simdeck "iPhone 17 Pro Max"
simdeck -d
simdeck -k
simdeck -r

With no subcommand, SimDeck starts a foreground server and prints browser URLs. A single simulator name or UDID selects that device in the UI. The shorthand flags start, stop, and restart the detached project daemon.

Command Shape

sh
simdeck [SIMULATOR_NAME_OR_UDID]
simdeck [--server-url <url>] <command> [options]

Use simdeck use <udid> once per project directory to make that simulator the default for later device commands. Most commands accept [<udid>]; --device, SIMDECK_DEVICE, and SIMDECK_UDID override the saved project default when a one-off target is needed.

Use --server-url or SIMDECK_SERVER_URL when a script should target a specific daemon:

sh
SIMDECK_SERVER_URL=http://127.0.0.1:4310 simdeck list

Most-Used Commands

sh
simdeck list
simdeck use <udid>
simdeck boot <udid>
simdeck install /path/to/App.app
simdeck install /path/to/App.ipa
simdeck launch com.example.App
simdeck open-url https://example.com
simdeck tap --label "Continue" --wait-timeout-ms 5000
simdeck tap --id com.apple.settings.screenTime --expect-id BackButton
simdeck tap "Continue"
simdeck back
simdeck describe --format agent --max-depth 3 --interactive
simdeck press @e3
simdeck snapshot --format agent --max-depth 3 -i
simdeck screenshot --output screen.png
simdeck screenshot --with-bezel --output screen-bezel.png
simdeck record --seconds 5 --output screen-recording.mp4
simdeck logs --seconds 30 --limit 200
simdeck stats
simdeck sample --seconds 3

The explicit form still works, for example simdeck launch <udid> com.example.App. snapshot, press, and wait are aliases for describe, tap, and wait-for. Agent snapshots include refs like @e3 that can be reused by tap/press. Use tap --expect-* to fold a post-tap wait into the action, and back for app-owned back navigation.

Most successful commands print JSON so they can be piped into tools such as jq.

Help

sh
simdeck --help
simdeck tap --help
simdeck daemon start --help

Next

Released under the Apache-2.0 License.