From 9776e9f5b7448b678d83f1cbd126daf46bba9f25 Mon Sep 17 00:00:00 2001 From: PJ Date: Tue, 9 Jun 2026 14:47:23 +0530 Subject: [PATCH] docs(getting-started): document physical iOS device setup Lists the iproxy requirement and the App Store Connect signing env vars (SANDERLING_IOS_TEAM, ASC_API_*) a device run needs, plus the test-ios-device recipe and the doctor check. --- docs/manual/getting-started.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/manual/getting-started.md b/docs/manual/getting-started.md index b0fe8e4..473eb04 100644 --- a/docs/manual/getting-started.md +++ b/docs/manual/getting-started.md @@ -65,6 +65,21 @@ IOS_DEVICE="iPhone 15" just test-ios # pick a different simulator `just test-ios` boots the simulator if needed, builds and installs the app, then runs `sanderling test --platform ios`. +#### 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`): + +```sh +SANDERLING_IOS_TEAM=<10-char team id> +ASC_API_KEY_ID= +ASC_API_ISSUER_ID= +ASC_API_KEY_PATH= + +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. + ### Web From either example. For the KMP wasmJs build, use `examples/folio`: