docs(ios): device tunnel uses native usbmux, nothing to install

This commit is contained in:
pj committed 2026-06-09 16:51:03 +05:30
1 parent a03d74b3a8
commit 4bf591cad5
3 files changed
+5 -5

No files matched your search

+1 -1
View File
@@ -53,7 +53,7 @@ sanderling doctor [--platform web|android|ios|ios-device|all]
| `web` | headless Chromium can launch (the bundled CDP surface boots a real browser). | | `web` | headless Chromium can launch (the bundled CDP surface boots a real browser). |
| `android` | `adb` on PATH; `emulator` on PATH or under `ANDROID_HOME`; Java 17+; embedded native sidecar JAR is real. | | `android` | `adb` on PATH; `emulator` on PATH or under `ANDROID_HOME`; Java 17+; embedded native sidecar JAR is real. |
| `ios` | `xcrun` on PATH; `simctl` on PATH. The simulator path drives the native companion with no JVM. | | `ios` | `xcrun` on PATH; `simctl` on PATH. The simulator path drives the native companion with no JVM. |
| `ios-device` | the `ios` checks plus `devicectl`; `iproxy` on PATH; a connected, paired device; App Store Connect signing credentials present. | | `ios-device` | the `ios` checks plus `devicectl`; the macOS `usbmuxd` socket; a connected, paired device; App Store Connect signing credentials present. |
## `sanderling version` ## `sanderling version`
+2 -2
View File
@@ -67,7 +67,7 @@ IOS_DEVICE="iPhone 15" just test-ios # pick a different simulator
#### Physical device #### Physical device
A connected iPhone is driven over a usbmux tunnel by a runner the driver builds and signs at run time. It needs `iproxy` (libimobiledevice) on PATH and App Store Connect signing credentials in the environment (a gitignored `.env` is loaded by `just`): A connected iPhone is driven over a usbmux tunnel by a runner the driver builds and signs at run time. The tunnel talks to macOS's own `usbmuxd`, so nothing extra is installed beyond Xcode. It needs App Store Connect signing credentials in the environment (a gitignored `.env` is loaded by `just`):
```sh ```sh
SANDERLING_IOS_TEAM=<10-char team id> SANDERLING_IOS_TEAM=<10-char team id>
@@ -78,7 +78,7 @@ ASC_API_KEY_PATH=<absolute path to AuthKey_*.p8>
IOS_DEVICE="iPhone" just test-ios-device # name, UDID, or CoreDevice id IOS_DEVICE="iPhone" just test-ios-device # name, UDID, or CoreDevice id
``` ```
Run `sanderling doctor --platform ios-device` to check `devicectl`, `iproxy`, a connected and paired device, and the signing credentials before a run. Run `sanderling doctor --platform ios-device` to check `devicectl`, the `usbmuxd` socket, a connected and paired device, and the signing credentials before a run.
### Web ### Web
+2 -2
View File
@@ -10,8 +10,8 @@ import (
) )
// Device is a physical iOS device resolved from devicectl. A device carries two // Device is a physical iOS device resolved from devicectl. A device carries two
// identifiers: HardwareUDID feeds xcodebuild -destination and iproxy -u, while // identifiers: HardwareUDID feeds xcodebuild -destination and the usbmux device
// CoreDeviceID feeds devicectl install/uninstall. // match, while CoreDeviceID feeds devicectl install/uninstall.
type Device struct { type Device struct {
Name string Name string
HardwareUDID string HardwareUDID string