# Command reference Every `baguette` command and flag, generated from the binary. For how to use a feature, start at the [docs index](README.md). **Common flag** (on every simulator command, not repeated below): `--device-set `: a custom device set (defaults to Xcode's default set). **Exit codes:** `0` on success, `1` on any error, `3` when an iPhone Duo `orientation` or `hinge` change is unconfirmed: its guest helper timed out, so the change may have landed and will not land later. Errors print `{"ok":false,"error":"…"}`, so parse stdout, not just the exit code. **Commands:** [list](#baguette-list) · [boot](#baguette-boot) · [shutdown](#baguette-shutdown) · [lifetime](#baguette-lifetime) · [input](#baguette-input) · [stream](#baguette-stream) · [tap](#baguette-tap) · [double-tap](#baguette-double-tap) · [swipe](#baguette-swipe) · [pinch](#baguette-pinch) · [pan](#baguette-pan) · [press](#baguette-press) · [key](#baguette-key) · [type](#baguette-type) · [paste](#baguette-paste) · [clipboard](#baguette-clipboard) · [chrome](#baguette-chrome) · [screenshot](#baguette-screenshot) · [record](#baguette-record) · [render-3d](#baguette-render-3d) · [describe-ui](#baguette-describe-ui) · [logs](#baguette-logs) · [serve](#baguette-serve) · [orientation](#baguette-orientation) · [hinge](#baguette-hinge) · [shake](#baguette-shake) · [status-bar](#baguette-status-bar) · [interface](#baguette-interface) · [location](#baguette-location) · [motion](#baguette-motion) · [network](#baguette-network) · [install](#baguette-install) · [add-media](#baguette-add-media) · [openurl](#baguette-openurl) · [schemes](#baguette-schemes) · [plugin](#baguette-plugin) · [bakery](#baguette-bakery) · [diag-digitizer-trackpad](#baguette-diag-digitizer-trackpad) · [heal](#baguette-heal) ## baguette list List simulators in the default or a custom device set ``` baguette list [--json] ``` | Flag | Required | Default | Description | |---|---|---|---| | `--json` | | | Emit one running/available JSON envelope (matches /simulators.json) | ## baguette boot Boot a simulator headlessly ``` baguette boot --udid [--no-heal] ``` | Flag | Required | Default | Description | |---|---|---|---| | `--udid` | yes | | Simulator UDID | | `--no-heal` | | | Leave the input surface alone even if Xcode 27's Device Hub has shadowed it (see `baguette heal`). | ## baguette shutdown Shut down a booted simulator ``` baguette shutdown --udid ``` | Flag | Required | Default | Description | |---|---|---|---| | `--udid` | yes | | Simulator UDID | ## baguette lifetime Show or change whether Simulator.app leaves devices booted ``` baguette lifetime [--detach] [--shutdown] ``` | Flag | Required | Default | Description | |---|---|---|---| | `--detach` | | | Leave devices booted when a window closes or Simulator.app quits. | | `--shutdown` | | | Restore Apple's default: closing a window or quitting shuts the device down. | ## baguette input Read newline-delimited JSON gestures from stdin, ack each on stdout ``` baguette input --udid [--display ] [--require-existing-display] [--expected-screen ] ``` | Flag | Required | Default | Description | |---|---|---|---| | `--udid` | yes | | Simulator UDID | | `--display` | | | Target display plane: phone \| carplay | | `--require-existing-display` | | | Require the target display to be attached; never enable CarPlay implicitly | | `--expected-screen` | | | Require fresh observations to match this describe-ui screen JSON before coordinate input | ## baguette stream Stream framebuffer to stdout (mjpeg / avcc). Reads runtime config commands from stdin. ``` baguette stream --udid [--format ] [--fps ] [--quality ] [--bitrate ] [--scale ] ``` | Flag | Required | Default | Description | |---|---|---|---| | `--udid` | yes | | Simulator UDID | | `--format` | | `mjpeg` | Output format: mjpeg \| avcc | | `--fps` | | `60` | Frames per second | | `--quality` | | `0.7` | JPEG quality (0.0 – 1.0) | | `--bitrate` | | `8000000` | H.264 average bitrate (bps) | | `--scale` | | `1` | Integer downscale divisor (1 = native) | ## baguette tap Single tap at a point ``` baguette tap --udid --x --y --width --height [--duration ] [--edge ] ``` | Flag | Required | Default | Description | |---|---|---|---| | `--udid` | yes | | Simulator UDID | | `--x` | yes | | | | `--y` | yes | | | | `--width` | yes | | | | `--height` | yes | | | | `--duration` | | `0.05` | Hold duration in seconds | | `--edge` | | | Screen edge the tap lands on: left \| top \| right \| bottom. Omit for an interior tap. | ## baguette double-tap Two taps at one point — fires UITapGestureRecognizer / TapGesture(count: 2) ``` baguette double-tap --udid --x --y --width --height [--interval ] [--duration ] ``` | Flag | Required | Default | Description | |---|---|---|---| | `--udid` | yes | | Simulator UDID | | `--x` | yes | | | | `--y` | yes | | | | `--width` | yes | | | | `--height` | yes | | | | `--interval` | | `0.05` | Gap between tap-1-up and tap-2-down, seconds | | `--duration` | | `0.08` | Hold duration per tap, seconds | ## baguette swipe One-finger drag from start to end ``` baguette swipe --udid --start-x --start-y --end-x --end-y --width --height [--duration ] ``` | Flag | Required | Default | Description | |---|---|---|---| | `--udid` | yes | | Simulator UDID | | `--start-x` | yes | | | | `--start-y` | yes | | | | `--end-x` | yes | | | | `--end-y` | yes | | | | `--width` | yes | | | | `--height` | yes | | | | `--duration` | | `0.25` | | ## baguette pinch Two-finger pinch / spread around a centre point ``` baguette pinch --udid --cx --cy --start-spread --end-spread --width --height [--duration ] ``` | Flag | Required | Default | Description | |---|---|---|---| | `--udid` | yes | | Simulator UDID | | `--cx` | yes | | | | `--cy` | yes | | | | `--start-spread` | yes | | | | `--end-spread` | yes | | | | `--width` | yes | | | | `--height` | yes | | | | `--duration` | | `0.6` | | ## baguette pan Two-finger parallel drag ``` baguette pan --udid --x1 --y1 --x2 --y2 --dx --dy --width --height [--duration ] ``` | Flag | Required | Default | Description | |---|---|---|---| | `--udid` | yes | | Simulator UDID | | `--x1` | yes | | | | `--y1` | yes | | | | `--x2` | yes | | | | `--y2` | yes | | | | `--dx` | yes | | | | `--dy` | yes | | | | `--width` | yes | | | | `--height` | yes | | | | `--duration` | | `0.5` | | ## baguette press Press-and-release a hardware button (home \| lock \| power \| volume-up \| volume-down \| action \| digital-crown \| side-button \| left-side-button \| app-switcher \| swipe-to-app-switcher \| swipe-to-home \| pull-down-to-lock-screen \| pull-down-to-notification-center) ``` baguette press --udid --button [--duration ] ``` | Flag | Required | Default | Description | |---|---|---|---| | `--udid` | yes | | Simulator UDID | | `--button` | yes | | Hardware button: home \| lock \| power \| volume-up \| volume-down \| action \| digital-crown \| side-button \| left-side-button \| app-switcher \| swipe-to-app-switcher \| swipe-to-home \| pull-down-to-lock-screen \| pull-down-to-notification-center | | `--duration` | | `0.0` | Hold duration in seconds (0 = short tap) | ## baguette key Press a single keyboard key with optional modifiers ``` baguette key --udid --code [--modifiers ] [--duration ] ``` | Flag | Required | Default | Description | |---|---|---|---| | `--udid` | yes | | Simulator UDID | | `--code` | yes | | W3C KeyboardEvent.code — KeyA-Z, Digit0-9, Enter, Escape, Backspace, Tab, Space, Arrow*, common punctuation | | `--modifiers` | | | Comma-separated modifiers (shift,control,option,command) | | `--duration` | | `0.0` | Hold duration in seconds (0 = short tap) | ## baguette type Type a string of US-ASCII text into the focused field ``` baguette type --udid --text ``` | Flag | Required | Default | Description | |---|---|---|---| | `--udid` | yes | | Simulator UDID | | `--text` | yes | | Text to type. Non-ASCII / dead-key characters are rejected. | ## baguette paste Paste text into the focused field via the simulator's pasteboard ``` baguette paste --udid --text [--press] [--no-press] ``` | Flag | Required | Default | Description | |---|---|---|---| | `--udid` | yes | | Simulator UDID | | `--text` | yes | | Text to paste. Any unicode — emoji and accents included. | | `--press` | | `--press` | Press Cmd+V after setting the pasteboard. | | `--no-press` | | | Press Cmd+V after setting the pasteboard. | ## baguette clipboard Read the simulator's pasteboard, or sync it to/from the host ### baguette clipboard get Print the simulator's pasteboard text to stdout ``` baguette clipboard get --udid ``` | Flag | Required | Default | Description | |---|---|---|---| | `--udid` | yes | | Simulator UDID | ### baguette clipboard sync Copy the host Mac's pasteboard onto the simulator (images included) ``` baguette clipboard sync --udid ``` | Flag | Required | Default | Description | |---|---|---|---| | `--udid` | yes | | Simulator UDID | ### baguette clipboard copy Copy the simulator's pasteboard onto the host Mac (images included) ``` baguette clipboard copy --udid ``` | Flag | Required | Default | Description | |---|---|---|---| | `--udid` | yes | | Simulator UDID | ## baguette chrome Read DeviceKit chrome (bezel) data for a simulator ### baguette chrome layout Print the chrome layout JSON for the named device ``` baguette chrome layout [--udid ] [--device-name ] [--panel ] ``` | Flag | Required | Default | Description | |---|---|---|---| | `--udid` | | | Simulator UDID (resolved via CoreSimulator) | | `--device-name` | | | Device-type name, e.g. "iPhone 17 Pro" | | `--panel` | | | Panel of a foldable: cover \| unfolded (default: the lit one) | ### baguette chrome composite Write the rasterized composite bezel PNG to stdout ``` baguette chrome composite [--udid ] [--device-name ] [--panel ] ``` | Flag | Required | Default | Description | |---|---|---|---| | `--udid` | | | Simulator UDID (resolved via CoreSimulator) | | `--device-name` | | | Device-type name, e.g. "iPhone 17 Pro" | | `--panel` | | | Panel of a foldable: cover \| unfolded (default: the lit one) | ## baguette screenshot Capture one frame from a simulator's screen ``` baguette screenshot --udid [--output

] [--metadata-output ] [--quality ] [--scale ] [--size ] [--fit ] [--background ] [--format ] [--display ] ``` | Flag | Required | Default | Description | |---|---|---|---| | `--udid` | yes | | Simulator UDID | | `--output` | | | Output file (defaults to stdout) | | `--metadata-output` | | | Write this frame's pixel geometry as JSON to a separate file | | `--quality` | | `0.85` | JPEG quality (0.0 – 1.0); ignored for PNG | | `--scale` | | `1` | Integer downscale divisor (1 = native) | | `--size` | | `native` | Output size: WIDTHxHEIGHT, W:H, or one of: native \| appstore-6.9 \| appstore-6.5 \| appstore-ipad-13 \| square \| 16:9 \| 9:16 \| 4:3 \| 4:5 | | `--fit` | | `contain` | How the frame fills the size: contain, cover, stretch | | `--background` | | `#ffffff` | Letterbox background: transparent or #RRGGBB | | `--format` | | | Image format: png \| jpg (defaults to the --output extension, else jpg) | | `--display` | | | Target display plane: phone \| carplay | ## baguette record Record a simulator's screen to an H.264 video file ``` baguette record --udid --output

[--size ] [--fit ] [--background ] [--fps ] [--duration ] [--bitrate ] ``` | Flag | Required | Default | Description | |---|---|---|---| | `--udid` | yes | | Simulator UDID | | `--output` | yes | | Output video file — .mp4 or .mov | | `--size` | | `native` | Output size: native \| appstore-6.9 \| appstore-6.5 \| appstore-ipad-13 \| square \| 16:9 \| 9:16 \| 4:3 \| 4:5, WIDTHxHEIGHT, or W:H | | `--fit` | | `contain` | Frame placement: contain \| cover \| stretch | | `--background` | | `#ffffff` | Letterbox background as #RRGGBB (video has no alpha) | | `--fps` | | `30` | Frames per second (1 – 120) | | `--duration` | | | Stop N seconds after launch (omit to record until Ctrl-C) | | `--bitrate` | | `8000000` | H.264 average bitrate (bps) | ## baguette render-3d Render a simulator screen on an installed 3D device model ``` baguette render-3d [--udid ] [--screen ] [--device ] [--screen-orientation ] [--hinge-degrees ] [--variant …] [--rotation ] [--size ] [--fit ] [--background ] [--screen-glass] [--output

] ``` | Flag | Required | Default | Description | |---|---|---|---| | `--udid` | | | Simulator UDID to capture | | `--screen` | | | Existing PNG or JPEG screen image | | `--device` | | | Installed 3D model definition ID | | `--screen-orientation` | | | With --screen: the interface orientation the capture was taken in, so it renders upright. One of: portrait, landscape-left, landscape-right, portrait-upside-down. | | `--hinge-degrees` | | | With --screen and a foldable model: fold angle, 0 through 180 degrees | | `--variant` | | | Model variant as SET=CHOICE (repeatable) | | `--rotation` | | `0,0,0` | Device rotation as X,Y,Z degrees | | `--size` | | | Output size: WIDTHxHEIGHT, W:H, or one of: native \| appstore-6.9 \| appstore-6.5 \| appstore-ipad-13 \| square \| 16:9 \| 9:16 \| 4:3 \| 4:5 (defaults to the captured screen size) | | `--fit` | | `cover` | Screen placement: cover, contain, or stretch | | `--background` | | `transparent` | Canvas background: transparent or #RRGGBB | | `--screen-glass` | | | Composite a reflective cover glass over the screen | | `--output` | | | Output PNG file (defaults to stdout) | ## baguette describe-ui Dump the simulator's accessibility tree as JSON ``` baguette describe-ui --udid [--x ] [--y ] [--output

] ``` | Flag | Required | Default | Description | |---|---|---|---| | `--udid` | yes | | Simulator UDID | | `--x` | | | Hit-test x coordinate (device points). Pair with --y. | | `--y` | | | Hit-test y coordinate (device points). Pair with --x. | | `--output` | | | Output file (defaults to stdout) | ## baguette logs Stream the booted simulator's unified log to stdout ``` baguette logs --udid [--level ] [--style