Skip to main content

Crate iphone_cli

Crate iphone_cli 

Source

Modules§

actions
The commands themselves, shared by the CLI, the MCP server, batch and scripts. Each takes JSON arguments and returns the fields of its result.
ax
client
Talk to the daemon over its socket (named pipe on Windows), starting it when needed.
clock
Wall-clock time for logs and file names.
config
~/.config/iph/config.toml.
connect
Register a paired phone’s direct address when usbmuxd discovery is empty.
daemon
The resident process (iph daemon, started on demand by the first iph call). It keeps the tunnel, the accessibility subscription and the input session open for one phone and serves requests from a Unix socket (a named pipe on Windows), one at a time.
ddi
The developer disk image. The accessibility, screen and input services iph uses come from it, and the phone forgets it when it restarts.
device
devices
iph devices: connected iPhones and whether each is ready.
diagnose
Collect an issue attachment without needing a selected or reachable phone.
dnd
iph dnd: Do Not Disturb on the phone.
doctor
iph doctor: check, in order, everything the phone needs for iph to work, and say in one line what the user must do for each thing that is missing.
events
Small, persistent connection events, including failures before a daemon exists. No pairing records or request payloads are logged here.
human
--human: the same results, laid out for a person reading a terminal.
i18n
Guidance text follows the Mac’s language: Korean on a Korean Mac, English otherwise. JSON keys and error codes stay English.
ipc
The channel between iph and its daemon: a Unix socket on macOS, a named pipe on Windows. Either way one connection carries one request line and one reply line.
keys
Key and hardware-button names → HID usages.
mcp
iph mcp: the commands as MCP tools over stdio (JSON-RPC 2.0, one message per line). Each tool forwards to the same daemon the CLI uses, so results have the same shape.
paths
Where iph keeps its files.
reply
The result shape every command shares: {ok, outcome, error?: {code, message, hint}, elapsed_ms, …}.
script
Scripts: JavaScript that drives the phone.
selector
Selectors: how a caller names an element on screen.
setup
iph setup: run the doctor, explain what is missing, wait for the user to fix it on the phone, and check again.
steps
Steps: the pieces iph batch runs from a JSON list, and that scripts call as waitFor, readField and readList.
tcp
A userspace TCP stack that runs over any ReadWrite transport.

Macros§

fields
Build the fields of a successful result, in json! object syntax.