AXedocs
Install

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.

axe list-simulators

List every simulator with its UDID and state.

discoveryno UDID
axe list-devices

List the physical iPhones and iPads that Xcode knows, with any readiness problems.

discoveryno UDIDphysical devices
axe doctor

Check whether a simulator is booted, or a device is paired, in Developer Mode, connected, unlocked and ready.

discoveryrequires UDIDphysical devices
FlagTypeDefaultDescription
--udid requiredstring—UDID of the simulator or physical device.
  • A failed check exits nonzero; its error code is the check's ID, such as developerModeDisabled.
axe displays

Show a simulator's screens, their sizes in points and orientation, the active one and the hinge angle.

discoveryrequires UDID
FlagTypeDefaultDescription
--udid requiredstring—UDID of the simulator.
--verboseflag—Print the full display measurements as JSON, including pixels and boot identity.
  • Waits for a fold or rotation to finish before reading.
axe describe-ui

Print the accessibility tree as JSON, or the element at one point. With --agent, a compact capture with refs.

discoveryrequires UDID--agentphysical devices
FlagTypeDefaultDescription
--udid requiredstring—UDID of the simulator or physical device.
--pointx,y—Describe only the element at this point.
--agentflag—Agent mode: act on snapshot refs and print JSON results.
--viewnavigation|reading|fullreadingAgent only: detail of the returned capture.
--snapshot-idstring—Agent only: snapshot ID from the latest capture.
--refstring—Agent only: a ref from that snapshot, such as e12.
--expected-pidint—Selected or agent: require this frontmost app PID.
--row-offsetint 0–12288—Agent only: first row to return; pass --snapshot-id for later pages.
--row-limitint 1–6464Agent only: rows to return.
--read-refstring—Agent only: read one field of this ref without input.
--text-fieldlabel|value|id|custom-actionslabel--read-ref field.
--text-offset / --text-limitint0 / 1024--read-ref chunk position and size, in Unicode scalars.
--since-screen-hashstring—Agent only: return a short unchanged result while the screen has this hash.
--input-modelegacy|selectedlegacyselected binds one screen and app and checks the target before input. Simulators.
--screen-id / --screen-uuidstring—Selected input: refuse unless this screen, from axe displays, is active. Pass both.
axe tap

Tap a point or an element found by accessibility; long press, double tap or two-finger tap.

interactionrequires UDIDbatch step--agentphysical devices
FlagTypeDefaultDescription
-x / -ypoints—Tap point. Pass both.
--idstring—Tap the element with this accessibility identifier.
--labelstring—Tap the element with this accessibility label.
--valuestring—Tap the element with this accessibility value.
--element-typestring—Only match elements of this type, such as Button or Switch.
--holdseconds—Keep the finger down, above 0 to 10: a long press.
--count1|212 is a double tap.
--touches1|212 is a two-finger tap, 40 points apart.
--tap-styleautomatic|simulator|physicalautomaticautomatic touches switches and sends a simulator tap otherwise. Physical by default with --agent or selected input.
--wait-timeoutseconds0Wait for an --id, --label or --value match to appear.
--poll-intervalseconds0.25Seconds between accessibility reads while waiting.
--label-contains / --label-regexstring—Agent only: match a label substring or regular expression.
--frameminX=…,maxY=…—Agent only: keep selector matches inside these bounds.
--semantic-pressflag—Press a native CheckBox with this --id through accessibility and confirm its value changed.
--pre-delayseconds—Wait before the input, 0 to 10.
--post-delayseconds—Wait after the input, 0 to 10.
--udid requiredstring—UDID of the simulator or physical device.
--agentflag—Agent mode: act on snapshot refs and print JSON results.
--viewnavigation|reading|fullreadingAgent only: detail of the returned capture.
--snapshot-idstring—Agent only: snapshot ID from the latest capture.
--refstring—Agent only: a ref from that snapshot, such as e12.
--expected-pidint—Selected or agent: require this frontmost app PID.
--input-modelegacy|selectedlegacyselected binds one screen and app and checks the target before input. Simulators.
--screen-id / --screen-uuidstring—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.
axe slider

Set a slider to a percentage or an endpoint and confirm the new value.

interactionrequires UDID--agent
FlagTypeDefaultDescription
--id / --labelstring—Find the slider. Pass exactly one.
--element-typestring—Only match this exact type, usually Slider.
--value0–100—Target value as a percentage.
--endpointminimum|maximum—Selected input or --agent only: move to an end.
--wait-timeoutseconds0Wait for the slider to appear.
--poll-intervalseconds0.25Seconds between reads while waiting.
--udid requiredstring—UDID of the simulator.
--agentflag—Agent mode: act on snapshot refs and print JSON results.
--viewnavigation|reading|fullreadingAgent only: detail of the returned capture.
--snapshot-idstring—Agent only: snapshot ID from the latest capture.
--refstring—Agent only: a ref from that snapshot, such as e12.
--expected-pidint—Selected or agent: require this frontmost app PID.
--input-modelegacy|selectedlegacyselected binds one screen and app and checks the target before input. Simulators.
--screen-id / --screen-uuidstring—Selected input: refuse unless this screen, from axe displays, is active. Pass both.
  • A selected batch accepts slider --endpoint steps.
axe swipe

Swipe in a straight line, optionally until an element is on screen.

interactionrequires UDIDbatch step--agentphysical devices
FlagTypeDefaultDescription
--start-x / --start-ypoints—Start point.
--end-x / --end-ypoints—End point.
--durationseconds1How long the swipe takes.
--deltapoints50Distance between touch samples.
--until-idstring—Repeat the scroll until the element with this identifier is on screen.
--until-labelstring—Repeat the scroll until an element with this label is on screen.
--max-swipesint 1–5010With --until-id or --until-label: the most scrolls to make.
--directionup|down|left|right—Agent only: swipe inside the --ref element; finger direction.
--distance0–11Agent only: fraction of the element to cross.
--pre-delayseconds—Wait before the input, 0 to 10.
--post-delayseconds—Wait after the input, 0 to 10.
--udid requiredstring—UDID of the simulator or physical device.
--agentflag—Agent mode: act on snapshot refs and print JSON results.
--viewnavigation|reading|fullreadingAgent only: detail of the returned capture.
--snapshot-idstring—Agent only: snapshot ID from the latest capture.
--refstring—Agent only: a ref from that snapshot, such as e12.
--expected-pidint—Selected or agent: require this frontmost app PID.
--input-modelegacy|selectedlegacyselected binds one screen and app and checks the target before input. Simulators.
--screen-id / --screen-uuidstring—Selected input: refuse unless this screen, from axe displays, is active. Pass both.
axe drag

Drag from one point to another with explicit touch moves, optionally resting first to reorder.

interactionrequires UDID--agentphysical devices
FlagTypeDefaultDescription
--start-x / --start-ypoints—Start point. With --agent, use --ref instead.
--end-x / --end-y requiredpoints—End point.
--durationseconds0.6How long the movement takes.
--stepsint 1–100060Number of touch moves.
--holdseconds 0–100.05Rest on the start before moving; about 0.6 starts a reorder.
--pre-delayseconds—Wait before the input, 0 to 10.
--post-delayseconds—Wait after the input, 0 to 10.
--udid requiredstring—UDID of the simulator or physical device.
--agentflag—Agent mode: act on snapshot refs and print JSON results.
--viewnavigation|reading|fullreadingAgent only: detail of the returned capture.
--snapshot-idstring—Agent only: snapshot ID from the latest capture.
--refstring—Agent only: a ref from that snapshot, such as e12.
--expected-pidint—Selected or agent: require this frontmost app PID.
--input-modelegacy|selectedlegacyselected binds one screen and app and checks the target before input. Simulators.
--screen-id / --screen-uuidstring—Selected input: refuse unless this screen, from axe displays, is active. Pass both.
  • A selected batch accepts drag steps; a plain batch does not.
axe draw

Move one finger through 2 to 1,000 points to draw a line or shape.

interactionrequires UDIDbatch stepphysical devices
FlagTypeDefaultDescription
points requiredx,y …—2 to 1000 points in the current orientation.
--durationseconds1How long the whole stroke takes, at most 30.
--closeflag—Return to the first point at the end.
--pre-delayseconds—Wait before the input, 0 to 10.
--post-delayseconds—Wait after the input, 0 to 10.
--udid requiredstring—UDID of the simulator or physical device.
--input-modelegacy|selectedlegacyselected binds one screen and app and checks the target before input. Simulators.
--screen-id / --screen-uuidstring—Selected input: refuse unless this screen, from axe displays, is active. Pass both.
axe touch

Touch down, up, or both at one point.

interactionrequires UDIDbatch step--agentphysical devices
FlagTypeDefaultDescription
-x / -ypoints—Touch point. With --agent, use --ref instead.
--downflag—Touch down.
--upflag—Touch up.
--delayseconds 0–100.1Time between down and up; needs both.
--contact-tokenuuid—Selected input: the token printed by an earlier --down.
--udid requiredstring—UDID of the simulator or physical device.
--agentflag—Agent mode: act on snapshot refs and print JSON results.
--viewnavigation|reading|fullreadingAgent only: detail of the returned capture.
--snapshot-idstring—Agent only: snapshot ID from the latest capture.
--refstring—Agent only: a ref from that snapshot, such as e12.
--expected-pidint—Selected or agent: require this frontmost app PID.
--input-modelegacy|selectedlegacyselected binds one screen and app and checks the target before input. Simulators.
--screen-id / --screen-uuidstring—Selected input: refuse unless this screen, from axe displays, is active. Pass both.
  • Physical devices need both --down and --up.
axe gesture

Run a preset swipe or scroll, or a pinch, rotate, double tap or two-finger gesture.

interactionrequires UDIDbatch step--agentphysical devices
FlagTypeDefaultDescription
gesture requiredpreset 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.
--distance0.05–0.95200 pointsScroll presets: length as a fraction of the screen.
--until-idstring—Repeat the scroll until the element with this identifier is on screen.
--until-labelstring—Repeat the scroll until an element with this label is on screen.
--max-swipesint 1–5010With --until-id or --until-label: the most scrolls to make.
--inside-id / --inside-labelstring—Scroll presets: scroll inside this element, not the screen. Simulators.
--edge-insetpoints20Edge presets: start distance from the edge.
-x / -ypoints—Centre or first contact.
--x2 / --y2points—Two-finger gestures: second contact.
--end-x / --end-y / --end-x2 / --end-y2points—two-finger-swipe: end points.
--radiuspoints—pinch, rotate: start radius.
--scalenumber, not 1—pinch: above 1 zooms in.
--degrees-360–360—rotate: clockwise angle.
--holdseconds—Seconds each touch is held; required for two-finger-hold.
--intervalseconds0.1double-tap: time between taps.
--screen-width / --screen-heightpoints—Presets: override the measured screen size.
--duration / --deltaseconds / points—Motion time and sample spacing; defaults depend on the gesture.
--pre-delayseconds—Wait before the input, 0 to 10.
--post-delayseconds—Wait after the input, 0 to 10.
--udid requiredstring—UDID of the simulator or physical device.
--agentflag—Agent mode: act on snapshot refs and print JSON results.
--viewnavigation|reading|fullreadingAgent only: detail of the returned capture.
--snapshot-idstring—Agent only: snapshot ID from the latest capture.
--refstring—Agent only: a ref from that snapshot, such as e12.
--expected-pidint—Selected or agent: require this frontmost app PID.
--input-modelegacy|selectedlegacyselected binds one screen and app and checks the target before input. Simulators.
--screen-id / --screen-uuidstring—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.
axe type

Type text with the US keyboard layout, from an argument, stdin or a file.

keyboardrequires UDIDbatch step--agentphysical devices
FlagTypeDefaultDescription
textpositional—Text to type.
--stdinflag—Read the text from standard input.
--filepath—Read the text from this file.
--focusflag—Agent only: tap the --ref field and wait for focus before typing.
--focus-idstring—ID of the focused text field; required with selected input.
--udid requiredstring—UDID of the simulator or physical device.
--agentflag—Agent mode: act on snapshot refs and print JSON results.
--viewnavigation|reading|fullreadingAgent only: detail of the returned capture.
--snapshot-idstring—Agent only: snapshot ID from the latest capture.
--refstring—Agent only: a ref from that snapshot, such as e12.
--expected-pidint—Selected or agent: require this frontmost app PID.
--input-modelegacy|selectedlegacyselected binds one screen and app and checks the target before input. Simulators.
--screen-id / --screen-uuidstring—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.
axe key

Press one key by HID key code.

keyboardrequires UDIDbatch step--agentphysical devices
FlagTypeDefaultDescription
keycode requiredint 0–255—HID key code.
--durationseconds—Hold the key, up to 10; not with --agent.
--focus-idstring—ID of the focused text field; required with selected input.
--udid requiredstring—UDID of the simulator or physical device.
--agentflag—Agent mode: act on snapshot refs and print JSON results.
--viewnavigation|reading|fullreadingAgent only: detail of the returned capture.
--snapshot-idstring—Agent only: snapshot ID from the latest capture.
--refstring—Agent only: a ref from that snapshot, such as e12.
--expected-pidint—Selected or agent: require this frontmost app PID.
--input-modelegacy|selectedlegacyselected binds one screen and app and checks the target before input. Simulators.
--screen-id / --screen-uuidstring—Selected input: refuse unless this screen, from axe displays, is active. Pass both.
axe key-sequence

Press up to 100 keys in order.

keyboardrequires UDIDbatch step--agentphysical devices
FlagTypeDefaultDescription
--keycodes requiredcomma-separated 0–255—HID key codes, at most 100.
--delayseconds 0–50.1Time between keys.
--focus-idstring—ID of the focused text field; required with selected input.
--udid requiredstring—UDID of the simulator or physical device.
--agentflag—Agent mode: act on snapshot refs and print JSON results.
--viewnavigation|reading|fullreadingAgent only: detail of the returned capture.
--snapshot-idstring—Agent only: snapshot ID from the latest capture.
--refstring—Agent only: a ref from that snapshot, such as e12.
--expected-pidint—Selected or agent: require this frontmost app PID.
--input-modelegacy|selectedlegacyselected binds one screen and app and checks the target before input. Simulators.
--screen-id / --screen-uuidstring—Selected input: refuse unless this screen, from axe displays, is active. Pass both.
axe key-combo

Press a key while holding up to eight modifier keys.

keyboardrequires UDIDbatch step--agentphysical devices
FlagTypeDefaultDescription
--modifiers requiredcomma-separated 0–255—Modifiers held in order and released in reverse, at most 8.
--key requiredint 0–255—Key pressed while the modifiers are held.
--focus-idstring—ID of the focused text field; required with selected input.
--udid requiredstring—UDID of the simulator or physical device.
--agentflag—Agent mode: act on snapshot refs and print JSON results.
--viewnavigation|reading|fullreadingAgent only: detail of the returned capture.
--snapshot-idstring—Agent only: snapshot ID from the latest capture.
--refstring—Agent only: a ref from that snapshot, such as e12.
--expected-pidint—Selected or agent: require this frontmost app PID.
--input-modelegacy|selectedlegacyselected binds one screen and app and checks the target before input. Simulators.
--screen-id / --screen-uuidstring—Selected input: refuse unless this screen, from axe displays, is active. Pass both.
axe button

Press a hardware button: home, lock, side-button, siri or apple-pay.

devicerequires UDIDbatch stepphysical devices
FlagTypeDefaultDescription
button-type requiredhome|lock|side-button|siri|apple-pay—Button to press.
--durationseconds—Hold the button, up to 10.
--allow-lockflag—Allow the lock button on a physical device.
--udid requiredstring—UDID of the simulator or physical device.
--input-modelegacy|selectedlegacyselected binds one screen and app and checks the target before input. Simulators.
--screen-id / --screen-uuidstring—Selected input: refuse unless this screen, from axe displays, is active. Pass both.
--verboseflag—Print the full input receipt as JSON where available.
  • Physical devices support home, lock and siri.
axe rotate

Rotate the iPhone Duo simulator or a physical device left or right and wait for the new orientation.

devicerequires UDIDphysical devices
FlagTypeDefaultDescription
direction requiredleft|right—Direction to rotate.
--udid requiredstring—UDID of the simulator or physical device.
--screen-id / --screen-uuidstring—iPhone Duo: refuse unless this screen is active.
--timeoutseconds 0.5–158How long to wait for the rotation.
--verboseflag—iPhone Duo: print the full reply as JSON.
  • Not the two-finger gesture rotate.
axe hinge read

Show the iPhone Duo simulator's hinge angle and posture.

devicerequires UDID
FlagTypeDefaultDescription
--udid requiredstring—UDID of the simulator.
axe hinge set

Move the iPhone Duo simulator's hinge and show the new angle and active screen.

devicerequires UDID
FlagTypeDefaultDescription
angle required0–180|closed|tabletop|open—Target angle; names mean 0, 90 and 180.
--no-waitflag—Return when the hinge reaches the angle, without waiting for the screens.
--tolerancedegrees 0–10.5How close the hinge must get.
--timeoutseconds 0.5–158Bound on the move.
--udid requiredstring—UDID of the simulator.
axe settings show

Show appearance, text size, accessibility display settings and VoiceOver.

devicerequires UDIDphysical devices
FlagTypeDefaultDescription
--udid requiredstring—UDID of the simulator or physical device.
  • Needs Xcode 27 or later.
axe settings set

Change one or more settings, then show them all.

devicerequires UDIDphysical devices
FlagTypeDefaultDescription
--appearancelight|dark—Light or dark mode.
--text-sizeextra-small … accessibility-extra-extra-extra-large—Dynamic Type size.
--increase-contrast / --reduce-motion / --reduce-transparency / --show-borderson|off—Accessibility display settings.
--liquid-glassclear|tinted—Liquid Glass style.
--liquid-glass-opacity0–1—Liquid Glass opacity.
--color-filteroff|grayscale|protanopia|deuteranopia|tritanopia—Colour filter.
--color-filter-intensity0.25–1—Colour filter intensity.
--voiceoveron|off—VoiceOver.
--udid requiredstring—UDID of the simulator or physical device.
axe settings location

Set, play or clear a simulated location: set, scenarios, scenario <name>, clear.

devicerequires UDIDphysical devices
FlagTypeDefaultDescription
--latitude / --longitudedegrees—location set: the coordinate.
--udid requiredstring—UDID of the simulator or physical device.
axe settings status-bar

Override the simulator status bar: preset, set, clear.

devicerequires UDID
FlagTypeDefaultDescription
presetscreenshot|low-battery|no-service|charging—status-bar preset: a ready-made status bar.
--time / --wifi-bars / --cellular-bars / --battery-level / --battery-statevalues—status-bar set: individual overrides.
--udid requiredstring—UDID of the simulator.
axe shutdown

Shut down one simulator and confirm that it stopped.

devicerequires UDID
FlagTypeDefaultDescription
--udid requiredstring—UDID of the simulator; names and booted are not accepted.
axe clipboard copy

Copy 1 to 65,536 bytes of UTF-8 text from stdin to a booted simulator's clipboard, verified by readback.

devicerequires UDID
FlagTypeDefaultDescription
--stdin requiredflag—Read the text from standard input.
--udid requiredstring—UDID of the simulator.
  • It does not paste.
axe screenshot

Save a PNG screenshot and print its path.

mediarequires UDIDphysical devices
FlagTypeDefaultDescription
--udid requiredstring—UDID of the simulator or physical device.
--outputpath—PNG file path or existing directory; default a timestamped name here.
--screen-id / --screen-uuidstring—Simulators: capture this screen only if it is active.
--verboseflag—With --screen-id: print the full capture receipt.
axe record-video

Record the screen to an H.264 MP4 until Ctrl+C.

mediarequires UDIDphysical devices
FlagTypeDefaultDescription
--udid requiredstring—UDID of the simulator or physical device.
--fpsint 1–3010Frames per second, an upper limit.
--qualityint 1–10080Encoding quality.
--scale0.1–11.0Frame scale factor.
--outputpath—MP4 path or directory; default axe-video-<timestamp>.mp4.
--follow-active-displayflag—Simulators: follow folds and rotations in one fixed-size video.
--screen-id / --screen-uuidstring—Simulators: record this screen; fail if it stops being active.
--verboseflag—Print the full recording receipt.
axe stream-video

Stream frames to stdout as MJPEG, JPEG, BGRA, or native H.264 from a device.

mediarequires UDIDphysical devices
FlagTypeDefaultDescription
--udid requiredstring—UDID of the simulator or physical device.
--formatmjpeg|raw|ffmpeg|bgra|h264mjpegStream format; h264 on physical devices.
--fpsint 1–3010Frames per second; not with h264.
--qualityint 1–10080JPEG quality; not with h264.
--scale0.1–11Frame scale factor; not with h264.
--screen-id / --screen-uuidstring—Simulators: stream this screen; stop if it changes.
  • stdout is binary; pipe or redirect it. --output json is refused.
axe mirror

Host one booted simulator for paired AXe Mirror viewers on an iPhone or iPad, until Ctrl+C.

mediarequires UDID
FlagTypeDefaultDescription
--udid requiredstring—UDID of the booted simulator.
--relay-urlurl—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.
axe mirror pair

Show a one-time code and QR code for a viewer to scan or type, and pair with the viewer that uses it.

mediano UDID
FlagTypeDefaultDescription
--namestringthe Mac's nameThe name the viewer shows for this Mac.
--jsonflag—Print JSON lines instead of the QR code: one with the code, one when a viewer has paired.
--relay-urlurl—Pair through this relay; by default AXe picks from its published list.
  • The code works once, for ten minutes.
axe mirror viewers

List the viewers paired with this Mac.

mediano UDID
FlagTypeDefaultDescription
--jsonflag—Print the list as JSON.
axe mirror unpair

Remove a paired viewer by its name or ID.

mediano UDID
FlagTypeDefaultDescription
viewer requiredpositional—The viewer's name, its ID, or the first characters of its ID, as shown by axe mirror viewers.
axe batch

Run input steps in order in one command, or a checked JSON batch of taps and types with --agent.

automationrequires UDID--agentphysical devices
FlagTypeDefaultDescription
--stepstring, repeatable—One step, such as "tap --id Save".
--filepath—Steps, one per line, or the JSON document with --agent.
--stdinflag—Read steps from standard input.
--steps-jsonJSON—Agent only: the JSON document inline, at most 16384 bytes.
--ax-cacheperBatch|perStep|noneperBatchWhen selector taps reuse the accessibility tree.
--type-submissionchunked|compositechunkedHow type steps send key events.
--type-chunk-sizeint200Key events per chunk.
--tap-styleautomatic|simulator|physicalautomaticDefault style of tap steps.
--continue-on-errorflag—Simulators: run the remaining steps after a failed step.
--wait-timeoutseconds0How long selector taps wait for their element.
--poll-intervalseconds0.25Seconds between reads while waiting.
--verboseflag—Log progress to stderr; with selected input, print each step's receipt.
--udid requiredstring—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-modelegacy|selectedlegacyselected binds one screen and app and checks the target before input. Simulators.
--screen-id / --screen-uuidstring—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.
axe agent

Reach a plain-language goal on a simulator with TypeSafe AI's Jev model, one checked action at a time.

automationrequires UDID
FlagTypeDefaultDescription
goal requiredpositional—The outcome to reach, in plain language.
--udid requiredstring—UDID of the simulator.
--max-stepsint 1–20040Most actions before stopping.
--modelstringjev-latestTypeSafe model.
--base-urlurlhttps://api.typesafe.aiTypeSafe API root; HTTPS unless on this Mac.
--minimum-action-probability0–10Refuse actions the model rates below this.
--tracepath—Write a JSON decision trace.
--jsonflag—Print only the final result as JSON.
  • Needs TYPESAFE_API_KEY.
axe init

Install, uninstall or print the AXe skill for AI clients.

automationno UDID
FlagTypeDefaultDescription
--clientauto|claude|agentsautoauto installs for every client found.
--destpath—Install into this skills directory instead.
--forceflag—Replace an installed skill.
--uninstallflag—Remove the installed skill.
--printflag—Print SKILL.md to stdout.
  • Without a terminal, pass --client, --dest or --print.

Discovery and readiness#

list-simulators and list-devices#

shell
axe list-simulators
axe list-devices

list-simulators prints every simulator with its UDID and state. list-devices lists the iPhones and iPads that Xcode knows, with any readiness problems.

doctor#

shell
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#

shell
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#

shell
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#

shell
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#

shell
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#

shell
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#

shell
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"

See Keyboard & Text Input.

Device#

button#

shell
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#

shell
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#

shell
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#

shell
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#

shell
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#

shell
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.h264

See Screenshots & Video.

Mirror#

shell
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#

shell
axe batch --udid "$UDID" \
  --step "tap --id Email" \
  --step "type 'cam@example.com'" \
  --step "key 40"

See Batch Automation.

agent#

shell
axe agent "Open Settings and turn on Airplane Mode" --udid "$UDID"

See Autonomous Agent.

init#

shell
axe init
axe init --client claude --force
axe init --print

See AI Skill.