List every simulator with its UDID and state.
Command Reference
Every AXe command with its options and defaults, whether it is a batch step, whether it takes --agent, and whether it runs on physical devices. Run axe <command> --help for the same detail in your terminal.
List the physical iPhones and iPads that Xcode knows, with any readiness problems.
Check whether a simulator is booted, or a device is paired, in Developer Mode, connected, unlocked and ready.
| Flag | Type | Default | Description |
|---|---|---|---|
--udid required | string | — | UDID of the simulator or physical device. |
- A failed check exits nonzero; its error code is the check's ID, such as developerModeDisabled.
Show a simulator's screens, their sizes in points and orientation, the active one and the hinge angle.
| Flag | Type | Default | Description |
|---|---|---|---|
--udid required | string | — | UDID of the simulator. |
--verbose | flag | — | Print the full display measurements as JSON, including pixels and boot identity. |
- Waits for a fold or rotation to finish before reading.
Print the accessibility tree as JSON, or the element at one point. With --agent, a compact capture with refs.
| Flag | Type | Default | Description |
|---|---|---|---|
--udid required | string | — | UDID of the simulator or physical device. |
--point | x,y | — | Describe only the element at this point. |
--agent | flag | — | Agent mode: act on snapshot refs and print JSON results. |
--view | navigation|reading|full | reading | Agent only: detail of the returned capture. |
--snapshot-id | string | — | Agent only: snapshot ID from the latest capture. |
--ref | string | — | Agent only: a ref from that snapshot, such as e12. |
--expected-pid | int | — | Selected or agent: require this frontmost app PID. |
--row-offset | int 0–12288 | — | Agent only: first row to return; pass --snapshot-id for later pages. |
--row-limit | int 1–64 | 64 | Agent only: rows to return. |
--read-ref | string | — | Agent only: read one field of this ref without input. |
--text-field | label|value|id|custom-actions | label | --read-ref field. |
--text-offset / --text-limit | int | 0 / 1024 | --read-ref chunk position and size, in Unicode scalars. |
--since-screen-hash | string | — | Agent only: return a short unchanged result while the screen has this hash. |
--input-mode | legacy|selected | legacy | selected binds one screen and app and checks the target before input. Simulators. |
--screen-id / --screen-uuid | string | — | Selected input: refuse unless this screen, from axe displays, is active. Pass both. |
Tap a point or an element found by accessibility; long press, double tap or two-finger tap.
| Flag | Type | Default | Description |
|---|---|---|---|
-x / -y | points | — | Tap point. Pass both. |
--id | string | — | Tap the element with this accessibility identifier. |
--label | string | — | Tap the element with this accessibility label. |
--value | string | — | Tap the element with this accessibility value. |
--element-type | string | — | Only match elements of this type, such as Button or Switch. |
--hold | seconds | — | Keep the finger down, above 0 to 10: a long press. |
--count | 1|2 | 1 | 2 is a double tap. |
--touches | 1|2 | 1 | 2 is a two-finger tap, 40 points apart. |
--tap-style | automatic|simulator|physical | automatic | automatic touches switches and sends a simulator tap otherwise. Physical by default with --agent or selected input. |
--wait-timeout | seconds | 0 | Wait for an --id, --label or --value match to appear. |
--poll-interval | seconds | 0.25 | Seconds between accessibility reads while waiting. |
--label-contains / --label-regex | string | — | Agent only: match a label substring or regular expression. |
--frame | minX=…,maxY=… | — | Agent only: keep selector matches inside these bounds. |
--semantic-press | flag | — | Press a native CheckBox with this --id through accessibility and confirm its value changed. |
--pre-delay | seconds | — | Wait before the input, 0 to 10. |
--post-delay | seconds | — | Wait after the input, 0 to 10. |
--udid required | string | — | UDID of the simulator or physical device. |
--agent | flag | — | Agent mode: act on snapshot refs and print JSON results. |
--view | navigation|reading|full | reading | Agent only: detail of the returned capture. |
--snapshot-id | string | — | Agent only: snapshot ID from the latest capture. |
--ref | string | — | Agent only: a ref from that snapshot, such as e12. |
--expected-pid | int | — | Selected or agent: require this frontmost app PID. |
--input-mode | legacy|selected | legacy | selected binds one screen and app and checks the target before input. Simulators. |
--screen-id / --screen-uuid | string | — | Selected input: refuse unless this screen, from axe displays, is active. Pass both. |
- Pass -x and -y, or exactly one selector.
- --hold, --count 2 and --touches 2 need plain input, without --agent or selected input.
Set a slider to a percentage or an endpoint and confirm the new value.
| Flag | Type | Default | Description |
|---|---|---|---|
--id / --label | string | — | Find the slider. Pass exactly one. |
--element-type | string | — | Only match this exact type, usually Slider. |
--value | 0–100 | — | Target value as a percentage. |
--endpoint | minimum|maximum | — | Selected input or --agent only: move to an end. |
--wait-timeout | seconds | 0 | Wait for the slider to appear. |
--poll-interval | seconds | 0.25 | Seconds between reads while waiting. |
--udid required | string | — | UDID of the simulator. |
--agent | flag | — | Agent mode: act on snapshot refs and print JSON results. |
--view | navigation|reading|full | reading | Agent only: detail of the returned capture. |
--snapshot-id | string | — | Agent only: snapshot ID from the latest capture. |
--ref | string | — | Agent only: a ref from that snapshot, such as e12. |
--expected-pid | int | — | Selected or agent: require this frontmost app PID. |
--input-mode | legacy|selected | legacy | selected binds one screen and app and checks the target before input. Simulators. |
--screen-id / --screen-uuid | string | — | Selected input: refuse unless this screen, from axe displays, is active. Pass both. |
- A selected batch accepts slider --endpoint steps.
Swipe in a straight line, optionally until an element is on screen.
| Flag | Type | Default | Description |
|---|---|---|---|
--start-x / --start-y | points | — | Start point. |
--end-x / --end-y | points | — | End point. |
--duration | seconds | 1 | How long the swipe takes. |
--delta | points | 50 | Distance between touch samples. |
--until-id | string | — | Repeat the scroll until the element with this identifier is on screen. |
--until-label | string | — | Repeat the scroll until an element with this label is on screen. |
--max-swipes | int 1–50 | 10 | With --until-id or --until-label: the most scrolls to make. |
--direction | up|down|left|right | — | Agent only: swipe inside the --ref element; finger direction. |
--distance | 0–1 | 1 | Agent only: fraction of the element to cross. |
--pre-delay | seconds | — | Wait before the input, 0 to 10. |
--post-delay | seconds | — | Wait after the input, 0 to 10. |
--udid required | string | — | UDID of the simulator or physical device. |
--agent | flag | — | Agent mode: act on snapshot refs and print JSON results. |
--view | navigation|reading|full | reading | Agent only: detail of the returned capture. |
--snapshot-id | string | — | Agent only: snapshot ID from the latest capture. |
--ref | string | — | Agent only: a ref from that snapshot, such as e12. |
--expected-pid | int | — | Selected or agent: require this frontmost app PID. |
--input-mode | legacy|selected | legacy | selected binds one screen and app and checks the target before input. Simulators. |
--screen-id / --screen-uuid | string | — | Selected input: refuse unless this screen, from axe displays, is active. Pass both. |
Drag from one point to another with explicit touch moves, optionally resting first to reorder.
| Flag | Type | Default | Description |
|---|---|---|---|
--start-x / --start-y | points | — | Start point. With --agent, use --ref instead. |
--end-x / --end-y required | points | — | End point. |
--duration | seconds | 0.6 | How long the movement takes. |
--steps | int 1–1000 | 60 | Number of touch moves. |
--hold | seconds 0–10 | 0.05 | Rest on the start before moving; about 0.6 starts a reorder. |
--pre-delay | seconds | — | Wait before the input, 0 to 10. |
--post-delay | seconds | — | Wait after the input, 0 to 10. |
--udid required | string | — | UDID of the simulator or physical device. |
--agent | flag | — | Agent mode: act on snapshot refs and print JSON results. |
--view | navigation|reading|full | reading | Agent only: detail of the returned capture. |
--snapshot-id | string | — | Agent only: snapshot ID from the latest capture. |
--ref | string | — | Agent only: a ref from that snapshot, such as e12. |
--expected-pid | int | — | Selected or agent: require this frontmost app PID. |
--input-mode | legacy|selected | legacy | selected binds one screen and app and checks the target before input. Simulators. |
--screen-id / --screen-uuid | string | — | Selected input: refuse unless this screen, from axe displays, is active. Pass both. |
- A selected batch accepts drag steps; a plain batch does not.
Move one finger through 2 to 1,000 points to draw a line or shape.
| Flag | Type | Default | Description |
|---|---|---|---|
points required | x,y … | — | 2 to 1000 points in the current orientation. |
--duration | seconds | 1 | How long the whole stroke takes, at most 30. |
--close | flag | — | Return to the first point at the end. |
--pre-delay | seconds | — | Wait before the input, 0 to 10. |
--post-delay | seconds | — | Wait after the input, 0 to 10. |
--udid required | string | — | UDID of the simulator or physical device. |
--input-mode | legacy|selected | legacy | selected binds one screen and app and checks the target before input. Simulators. |
--screen-id / --screen-uuid | string | — | Selected input: refuse unless this screen, from axe displays, is active. Pass both. |
Touch down, up, or both at one point.
| Flag | Type | Default | Description |
|---|---|---|---|
-x / -y | points | — | Touch point. With --agent, use --ref instead. |
--down | flag | — | Touch down. |
--up | flag | — | Touch up. |
--delay | seconds 0–10 | 0.1 | Time between down and up; needs both. |
--contact-token | uuid | — | Selected input: the token printed by an earlier --down. |
--udid required | string | — | UDID of the simulator or physical device. |
--agent | flag | — | Agent mode: act on snapshot refs and print JSON results. |
--view | navigation|reading|full | reading | Agent only: detail of the returned capture. |
--snapshot-id | string | — | Agent only: snapshot ID from the latest capture. |
--ref | string | — | Agent only: a ref from that snapshot, such as e12. |
--expected-pid | int | — | Selected or agent: require this frontmost app PID. |
--input-mode | legacy|selected | legacy | selected binds one screen and app and checks the target before input. Simulators. |
--screen-id / --screen-uuid | string | — | Selected input: refuse unless this screen, from axe displays, is active. Pass both. |
- Physical devices need both --down and --up.
Run a preset swipe or scroll, or a pinch, rotate, double tap or two-finger gesture.
| Flag | Type | Default | Description |
|---|---|---|---|
gesture required | preset or name | — | scroll-up|down|left|right, swipe-from-left|right|top|bottom-edge, swipe-from-top-right-corner, pinch, double-tap, rotate, two-finger-tap, two-finger-hold, two-finger-swipe. |
--distance | 0.05–0.95 | 200 points | Scroll presets: length as a fraction of the screen. |
--until-id | string | — | Repeat the scroll until the element with this identifier is on screen. |
--until-label | string | — | Repeat the scroll until an element with this label is on screen. |
--max-swipes | int 1–50 | 10 | With --until-id or --until-label: the most scrolls to make. |
--inside-id / --inside-label | string | — | Scroll presets: scroll inside this element, not the screen. Simulators. |
--edge-inset | points | 20 | Edge presets: start distance from the edge. |
-x / -y | points | — | Centre or first contact. |
--x2 / --y2 | points | — | Two-finger gestures: second contact. |
--end-x / --end-y / --end-x2 / --end-y2 | points | — | two-finger-swipe: end points. |
--radius | points | — | pinch, rotate: start radius. |
--scale | number, not 1 | — | pinch: above 1 zooms in. |
--degrees | -360–360 | — | rotate: clockwise angle. |
--hold | seconds | — | Seconds each touch is held; required for two-finger-hold. |
--interval | seconds | 0.1 | double-tap: time between taps. |
--screen-width / --screen-height | points | — | Presets: override the measured screen size. |
--duration / --delta | seconds / points | — | Motion time and sample spacing; defaults depend on the gesture. |
--pre-delay | seconds | — | Wait before the input, 0 to 10. |
--post-delay | seconds | — | Wait after the input, 0 to 10. |
--udid required | string | — | UDID of the simulator or physical device. |
--agent | flag | — | Agent mode: act on snapshot refs and print JSON results. |
--view | navigation|reading|full | reading | Agent only: detail of the returned capture. |
--snapshot-id | string | — | Agent only: snapshot ID from the latest capture. |
--ref | string | — | Agent only: a ref from that snapshot, such as e12. |
--expected-pid | int | — | Selected or agent: require this frontmost app PID. |
--input-mode | legacy|selected | legacy | selected binds one screen and app and checks the target before input. Simulators. |
--screen-id / --screen-uuid | string | — | Selected input: refuse unless this screen, from axe displays, is active. Pass both. |
- With --agent, double-tap and pinch act on --ref.
- Physical devices do not support swipe-from-right-edge.
Type text with the US keyboard layout, from an argument, stdin or a file.
| Flag | Type | Default | Description |
|---|---|---|---|
text | positional | — | Text to type. |
--stdin | flag | — | Read the text from standard input. |
--file | path | — | Read the text from this file. |
--focus | flag | — | Agent only: tap the --ref field and wait for focus before typing. |
--focus-id | string | — | ID of the focused text field; required with selected input. |
--udid required | string | — | UDID of the simulator or physical device. |
--agent | flag | — | Agent mode: act on snapshot refs and print JSON results. |
--view | navigation|reading|full | reading | Agent only: detail of the returned capture. |
--snapshot-id | string | — | Agent only: snapshot ID from the latest capture. |
--ref | string | — | Agent only: a ref from that snapshot, such as e12. |
--expected-pid | int | — | Selected or agent: require this frontmost app PID. |
--input-mode | legacy|selected | legacy | selected binds one screen and app and checks the target before input. Simulators. |
--screen-id / --screen-uuid | string | — | Selected input: refuse unless this screen, from axe displays, is active. Pass both. |
- Give exactly one text source.
- Characters outside the US layout fail with invalidArguments before typing.
- Devices, agent and selected input send at most 256 UTF-8 bytes.
Press one key by HID key code.
| Flag | Type | Default | Description |
|---|---|---|---|
keycode required | int 0–255 | — | HID key code. |
--duration | seconds | — | Hold the key, up to 10; not with --agent. |
--focus-id | string | — | ID of the focused text field; required with selected input. |
--udid required | string | — | UDID of the simulator or physical device. |
--agent | flag | — | Agent mode: act on snapshot refs and print JSON results. |
--view | navigation|reading|full | reading | Agent only: detail of the returned capture. |
--snapshot-id | string | — | Agent only: snapshot ID from the latest capture. |
--ref | string | — | Agent only: a ref from that snapshot, such as e12. |
--expected-pid | int | — | Selected or agent: require this frontmost app PID. |
--input-mode | legacy|selected | legacy | selected binds one screen and app and checks the target before input. Simulators. |
--screen-id / --screen-uuid | string | — | Selected input: refuse unless this screen, from axe displays, is active. Pass both. |
Press up to 100 keys in order.
| Flag | Type | Default | Description |
|---|---|---|---|
--keycodes required | comma-separated 0–255 | — | HID key codes, at most 100. |
--delay | seconds 0–5 | 0.1 | Time between keys. |
--focus-id | string | — | ID of the focused text field; required with selected input. |
--udid required | string | — | UDID of the simulator or physical device. |
--agent | flag | — | Agent mode: act on snapshot refs and print JSON results. |
--view | navigation|reading|full | reading | Agent only: detail of the returned capture. |
--snapshot-id | string | — | Agent only: snapshot ID from the latest capture. |
--ref | string | — | Agent only: a ref from that snapshot, such as e12. |
--expected-pid | int | — | Selected or agent: require this frontmost app PID. |
--input-mode | legacy|selected | legacy | selected binds one screen and app and checks the target before input. Simulators. |
--screen-id / --screen-uuid | string | — | Selected input: refuse unless this screen, from axe displays, is active. Pass both. |
Press a key while holding up to eight modifier keys.
| Flag | Type | Default | Description |
|---|---|---|---|
--modifiers required | comma-separated 0–255 | — | Modifiers held in order and released in reverse, at most 8. |
--key required | int 0–255 | — | Key pressed while the modifiers are held. |
--focus-id | string | — | ID of the focused text field; required with selected input. |
--udid required | string | — | UDID of the simulator or physical device. |
--agent | flag | — | Agent mode: act on snapshot refs and print JSON results. |
--view | navigation|reading|full | reading | Agent only: detail of the returned capture. |
--snapshot-id | string | — | Agent only: snapshot ID from the latest capture. |
--ref | string | — | Agent only: a ref from that snapshot, such as e12. |
--expected-pid | int | — | Selected or agent: require this frontmost app PID. |
--input-mode | legacy|selected | legacy | selected binds one screen and app and checks the target before input. Simulators. |
--screen-id / --screen-uuid | string | — | Selected input: refuse unless this screen, from axe displays, is active. Pass both. |
Press a hardware button: home, lock, side-button, siri or apple-pay.
| Flag | Type | Default | Description |
|---|---|---|---|
button-type required | home|lock|side-button|siri|apple-pay | — | Button to press. |
--duration | seconds | — | Hold the button, up to 10. |
--allow-lock | flag | — | Allow the lock button on a physical device. |
--udid required | string | — | UDID of the simulator or physical device. |
--input-mode | legacy|selected | legacy | selected binds one screen and app and checks the target before input. Simulators. |
--screen-id / --screen-uuid | string | — | Selected input: refuse unless this screen, from axe displays, is active. Pass both. |
--verbose | flag | — | Print the full input receipt as JSON where available. |
- Physical devices support home, lock and siri.
Rotate the iPhone Duo simulator or a physical device left or right and wait for the new orientation.
| Flag | Type | Default | Description |
|---|---|---|---|
direction required | left|right | — | Direction to rotate. |
--udid required | string | — | UDID of the simulator or physical device. |
--screen-id / --screen-uuid | string | — | iPhone Duo: refuse unless this screen is active. |
--timeout | seconds 0.5–15 | 8 | How long to wait for the rotation. |
--verbose | flag | — | iPhone Duo: print the full reply as JSON. |
- Not the two-finger gesture rotate.
Show the iPhone Duo simulator's hinge angle and posture.
| Flag | Type | Default | Description |
|---|---|---|---|
--udid required | string | — | UDID of the simulator. |
Move the iPhone Duo simulator's hinge and show the new angle and active screen.
| Flag | Type | Default | Description |
|---|---|---|---|
angle required | 0–180|closed|tabletop|open | — | Target angle; names mean 0, 90 and 180. |
--no-wait | flag | — | Return when the hinge reaches the angle, without waiting for the screens. |
--tolerance | degrees 0–1 | 0.5 | How close the hinge must get. |
--timeout | seconds 0.5–15 | 8 | Bound on the move. |
--udid required | string | — | UDID of the simulator. |
Show appearance, text size, accessibility display settings and VoiceOver.
| Flag | Type | Default | Description |
|---|---|---|---|
--udid required | string | — | UDID of the simulator or physical device. |
- Needs Xcode 27 or later.
Change one or more settings, then show them all.
| Flag | Type | Default | Description |
|---|---|---|---|
--appearance | light|dark | — | Light or dark mode. |
--text-size | extra-small … accessibility-extra-extra-extra-large | — | Dynamic Type size. |
--increase-contrast / --reduce-motion / --reduce-transparency / --show-borders | on|off | — | Accessibility display settings. |
--liquid-glass | clear|tinted | — | Liquid Glass style. |
--liquid-glass-opacity | 0–1 | — | Liquid Glass opacity. |
--color-filter | off|grayscale|protanopia|deuteranopia|tritanopia | — | Colour filter. |
--color-filter-intensity | 0.25–1 | — | Colour filter intensity. |
--voiceover | on|off | — | VoiceOver. |
--udid required | string | — | UDID of the simulator or physical device. |
Set, play or clear a simulated location: set, scenarios, scenario <name>, clear.
| Flag | Type | Default | Description |
|---|---|---|---|
--latitude / --longitude | degrees | — | location set: the coordinate. |
--udid required | string | — | UDID of the simulator or physical device. |
Override the simulator status bar: preset, set, clear.
| Flag | Type | Default | Description |
|---|---|---|---|
preset | screenshot|low-battery|no-service|charging | — | status-bar preset: a ready-made status bar. |
--time / --wifi-bars / --cellular-bars / --battery-level / --battery-state | values | — | status-bar set: individual overrides. |
--udid required | string | — | UDID of the simulator. |
Shut down one simulator and confirm that it stopped.
| Flag | Type | Default | Description |
|---|---|---|---|
--udid required | string | — | UDID of the simulator; names and booted are not accepted. |
Copy 1 to 65,536 bytes of UTF-8 text from stdin to a booted simulator's clipboard, verified by readback.
| Flag | Type | Default | Description |
|---|---|---|---|
--stdin required | flag | — | Read the text from standard input. |
--udid required | string | — | UDID of the simulator. |
- It does not paste.
Save a PNG screenshot and print its path.
| Flag | Type | Default | Description |
|---|---|---|---|
--udid required | string | — | UDID of the simulator or physical device. |
--output | path | — | PNG file path or existing directory; default a timestamped name here. |
--screen-id / --screen-uuid | string | — | Simulators: capture this screen only if it is active. |
--verbose | flag | — | With --screen-id: print the full capture receipt. |
Record the screen to an H.264 MP4 until Ctrl+C.
| Flag | Type | Default | Description |
|---|---|---|---|
--udid required | string | — | UDID of the simulator or physical device. |
--fps | int 1–30 | 10 | Frames per second, an upper limit. |
--quality | int 1–100 | 80 | Encoding quality. |
--scale | 0.1–1 | 1.0 | Frame scale factor. |
--output | path | — | MP4 path or directory; default axe-video-<timestamp>.mp4. |
--follow-active-display | flag | — | Simulators: follow folds and rotations in one fixed-size video. |
--screen-id / --screen-uuid | string | — | Simulators: record this screen; fail if it stops being active. |
--verbose | flag | — | Print the full recording receipt. |
Stream frames to stdout as MJPEG, JPEG, BGRA, or native H.264 from a device.
| Flag | Type | Default | Description |
|---|---|---|---|
--udid required | string | — | UDID of the simulator or physical device. |
--format | mjpeg|raw|ffmpeg|bgra|h264 | mjpeg | Stream format; h264 on physical devices. |
--fps | int 1–30 | 10 | Frames per second; not with h264. |
--quality | int 1–100 | 80 | JPEG quality; not with h264. |
--scale | 0.1–1 | 1 | Frame scale factor; not with h264. |
--screen-id / --screen-uuid | string | — | Simulators: stream this screen; stop if it changes. |
- stdout is binary; pipe or redirect it. --output json is refused.
Host one booted simulator for paired AXe Mirror viewers on an iPhone or iPad, until Ctrl+C.
| Flag | Type | Default | Description |
|---|---|---|---|
--udid required | string | — | UDID of the booted simulator. |
--relay-url | url | — | Use this relay and no other; by default AXe picks from its published list. |
- Apple silicon Macs only.
- Prints one JSON line per event on stdout; logs go to stderr.
Show a one-time code and QR code for a viewer to scan or type, and pair with the viewer that uses it.
| Flag | Type | Default | Description |
|---|---|---|---|
--name | string | the Mac's name | The name the viewer shows for this Mac. |
--json | flag | — | Print JSON lines instead of the QR code: one with the code, one when a viewer has paired. |
--relay-url | url | — | Pair through this relay; by default AXe picks from its published list. |
- The code works once, for ten minutes.
List the viewers paired with this Mac.
| Flag | Type | Default | Description |
|---|---|---|---|
--json | flag | — | Print the list as JSON. |
Remove a paired viewer by its name or ID.
| Flag | Type | Default | Description |
|---|---|---|---|
viewer required | positional | — | The viewer's name, its ID, or the first characters of its ID, as shown by axe mirror viewers. |
Run input steps in order in one command, or a checked JSON batch of taps and types with --agent.
| Flag | Type | Default | Description |
|---|---|---|---|
--step | string, repeatable | — | One step, such as "tap --id Save". |
--file | path | — | Steps, one per line, or the JSON document with --agent. |
--stdin | flag | — | Read steps from standard input. |
--steps-json | JSON | — | Agent only: the JSON document inline, at most 16384 bytes. |
--ax-cache | perBatch|perStep|none | perBatch | When selector taps reuse the accessibility tree. |
--type-submission | chunked|composite | chunked | How type steps send key events. |
--type-chunk-size | int | 200 | Key events per chunk. |
--tap-style | automatic|simulator|physical | automatic | Default style of tap steps. |
--continue-on-error | flag | — | Simulators: run the remaining steps after a failed step. |
--wait-timeout | seconds | 0 | How long selector taps wait for their element. |
--poll-interval | seconds | 0.25 | Seconds between reads while waiting. |
--verbose | flag | — | Log progress to stderr; with selected input, print each step's receipt. |
--udid required | string | — | UDID of the simulator or physical device. |
--agent / --view / --expected-pid | — | Agent batch: 1 to 8 tap and type steps with refs from one snapshot. | |
--input-mode | legacy|selected | legacy | selected binds one screen and app and checks the target before input. Simulators. |
--screen-id / --screen-uuid | string | — | Selected input: refuse unless this screen, from axe displays, is active. Pass both. |
- Plain steps: tap, swipe, gesture, draw, touch, type, button, key, key-sequence, key-combo and sleep.
- Pass --udid once; a step with its own --udid is rejected.
Reach a plain-language goal on a simulator with TypeSafe AI's Jev model, one checked action at a time.
| Flag | Type | Default | Description |
|---|---|---|---|
goal required | positional | — | The outcome to reach, in plain language. |
--udid required | string | — | UDID of the simulator. |
--max-steps | int 1–200 | 40 | Most actions before stopping. |
--model | string | jev-latest | TypeSafe model. |
--base-url | url | https://api.typesafe.ai | TypeSafe API root; HTTPS unless on this Mac. |
--minimum-action-probability | 0–1 | 0 | Refuse actions the model rates below this. |
--trace | path | — | Write a JSON decision trace. |
--json | flag | — | Print only the final result as JSON. |
- Needs TYPESAFE_API_KEY.
Install, uninstall or print the AXe skill for AI clients.
| Flag | Type | Default | Description |
|---|---|---|---|
--client | auto|claude|agents | auto | auto installs for every client found. |
--dest | path | — | Install into this skills directory instead. |
--force | flag | — | Replace an installed skill. |
--uninstall | flag | — | Remove the installed skill. |
--print | flag | — | Print SKILL.md to stdout. |
- Without a terminal, pass --client, --dest or --print.
Discovery and readiness
list-simulators and list-devices
axe list-simulators
axe list-deviceslist-simulators prints every simulator with its UDID and state. list-devices lists the iPhones and iPads that Xcode knows, with any readiness problems.
doctor
axe doctor --udid "$UDID"Checks that a simulator is booted, or that a device is paired, in Developer Mode, connected, unlocked, with its developer disk image and screenshot service. A failed check exits nonzero.
displays
axe displays --udid "$UDID"Shows each screen's role, size in points, scale and orientation, which one is active, and the iPhone Duo's hinge angle. See iPhone Duo.
Reading the UI
describe-ui
axe describe-ui --udid "$UDID"
axe describe-ui --point 100,200 --udid "$UDID"
axe describe-ui --agent --view navigation --udid "$UDID"Prints the accessibility tree as JSON, or the element at one point. With --agent, a compact capture with refs; see Agent Mode.
Touch input
tap
axe tap -x 120 -y 240 --udid "$UDID"
axe tap --id SearchField --udid "$UDID"
axe tap --label "Continue" --element-type Button --wait-timeout 5 --udid "$UDID"
axe tap --label "Photo" --hold 1 --udid "$UDID"
axe tap --id Map --count 2 --udid "$UDID"
axe tap --id Canvas --touches 2 --udid "$UDID"Pass -x and -y, or exactly one of --id, --label or --value. See Reading & Tapping.
slider
axe slider --id volume --value 75 --udid "$UDID"Sets a slider to a percentage and checks the new value. Simulators only.
swipe, drag, draw, touch and gesture
axe swipe --start-x 200 --start-y 600 --end-x 200 --end-y 300 --udid "$UDID"
axe drag --start-x 200 --start-y 300 --end-x 200 --end-y 500 --hold 0.6 --udid "$UDID"
axe draw 100,400 300,400 300,600 --close --udid "$UDID"
axe touch -x 150 -y 250 --down --up --delay 1.0 --udid "$UDID"
axe gesture scroll-down --until-label "Privacy" --udid "$UDID"
axe gesture pinch --scale 2 --udid "$UDID"See Swipes, Gestures & Drawing.
Keyboard
axe type 'Hello, world!' --udid "$UDID"
printf 'Multi-line\ninput' | axe type --stdin --udid "$UDID"
axe key 40 --udid "$UDID"
axe key-sequence --keycodes 11,8,15,15,18 --delay 0.1 --udid "$UDID"
axe key-combo --modifiers 227 --key 4 --udid "$UDID"Device
button
axe button home --udid "$UDID"
axe button lock --duration 3 --udid "$UDID"
axe button lock --allow-lock --udid "$DEVICE_UDID"Buttons are home, lock, side-button, siri and apple-pay. A button acts on the whole device; capture the screen again after Home.
rotate and hinge
axe rotate left --udid "$UDID"
axe hinge read --udid "$UDID"
axe hinge set tabletop --udid "$UDID"rotate works on the iPhone Duo simulator and physical devices; hinge on the iPhone Duo simulator. See iPhone Duo Simulator.
settings
axe settings show --udid "$UDID"
axe settings set --udid "$UDID" --appearance dark --text-size large
axe settings location set --latitude 51.5 --longitude -0.12 --udid "$UDID"
axe settings status-bar preset screenshot --udid "$UDID"Needs Xcode 27 or later. See Device Settings.
shutdown
axe shutdown --udid "$UDID"Shuts down exactly one simulator by UUID and prints Shut down <udid> (was Booted) or <udid> was already shut down. JSON is {udid, initialState, outcome}.
clipboard copy
printf '%s' 'AXe sample' | axe clipboard copy --stdin --udid "$UDID"Stages 1 to 65,536 UTF-8 bytes in one booted simulator's clipboard, verifies them by readback and prints Copied N bytes to the clipboard of <udid> (sha256 …). JSON is {udid, bytes, sha256}. It does not paste. Both shutdown and clipboard copy report actionOutcomeUnknown when the effect could not be confirmed.
Capture
axe screenshot --output screen.png --udid "$UDID"
axe record-video --output run.mp4 --fps 15 --udid "$UDID"
axe stream-video --format mjpeg --fps 10 --udid "$UDID" > stream.mjpeg
axe stream-video --format h264 --udid "$DEVICE_UDID" > device.h264See Screenshots & Video.
Mirror
axe mirror pair
axe mirror --udid "$UDID"
axe mirror viewers
axe mirror unpair "$VIEWER_ID"mirror pair shows a one-time code for the AXe Mirror app on an iPhone or iPad. mirror hosts one booted simulator for paired viewers, mirror viewers lists them and mirror unpair removes one. Apple silicon Macs only. See AXe Mirror.
Automation
batch
axe batch --udid "$UDID" \
--step "tap --id Email" \
--step "type 'cam@example.com'" \
--step "key 40"See Batch Automation.
agent
axe agent "Open Settings and turn on Airplane Mode" --udid "$UDID"See Autonomous Agent.
init
axe init
axe init --client claude --force
axe init --printSee AI Skill.