iOS app for pi-remote-control sidecar
Go to file
jay 413c94601f feat(ios): add piRemoteUITests XCUITest target with smoke test
- New target 'piRemoteUITests' (bundle.ui-testing) in project.yml
- TEST_TARGET_NAME=piRemote, deploymentTarget 17.0
- Added to scheme 'piRemote' test targets
- UITests/SmokeUITests.swift: @MainActor smoke test verifying app launches
- Verified: xcodebuild test -only-testing:piRemoteUITests passes (5.8s)
2026-05-16 16:59:26 +02:00
Sources feat(ios): .onOpenURL handler for pi-remote:// deep-link pairing (sim convenience) 2026-05-16 12:42:12 +02:00
Tests/CoreTests test(T-2.4/2.5/2.9): ModifierState, ScrollbackCache, DeviceTokenRegistrar tests 2026-05-15 19:03:56 +02:00
UITests feat(ios): add piRemoteUITests XCUITest target with smoke test 2026-05-16 16:59:26 +02:00
docs docs: simulator UI automation guide (verified) 2026-05-16 13:04:16 +02:00
piRemote.xcodeproj feat: app wiring — ContentView + AppState + MainTerminalView 2026-05-16 02:48:08 +02:00
.gitignore feat(T-2.0): Xcode project scaffold — SwiftUI shell, SwiftTerm + Starscream SPM deps 2026-05-15 13:19:48 +02:00
README.md docs: update status table — T-2.0..T-2.5+T-2.9 done 2026-05-16 02:42:02 +02:00
project.yml feat(ios): add piRemoteUITests XCUITest target with smoke test 2026-05-16 16:59:26 +02:00

README.md

pi-remote iOS

Native iOS app for the pi-remote-control sidecar.

Requirements

  • Xcode 16.4+
  • iOS 17.0+ device
  • pi-remote-control sidecar running (Phase 1)

Building

# Open in Xcode (first time: Xcode downloads device support files automatically)
open piRemote.xcodeproj

# Or via CLI (after first Xcode open with device connected):
xcodebuild build -project piRemote.xcodeproj -scheme piRemote \
  -destination "platform=iOS,name=<YourPhone>" \
  CODE_SIGNING_STYLE=Automatic DEVELOPMENT_TEAM=KNXX8R3648

Project structure

Sources/
├── App/          — @main entry, ContentView, Assets
├── Core/
│   ├── Network/  — WebSocketClient, FrameCodec, ResumeCursor, TLS pinning
│   ├── Auth/     — Keychain, Pairing (QR exchange)
│   ├── Sessions/ — SessionRegistry, SessionConnection, PreConnectPool
│   ├── Push/     — APNs NotificationDelegate, DeviceTokenRegistrar
│   └── Persistence/ — ScrollbackCache, Preferences
└── UI/
    ├── Terminal/ — SwiftTerm wrapper, themes, fonts
    ├── Input/    — ModifierBar, sticky Ctrl, paste sheet
    ├── Status/   — StatusBar (pi state)
    ├── Sessions/ — SessionSwitcher
    ├── Pairing/  — QR scanner flow
    └── Settings/ — Face-ID gate, sidecar info

Dependencies (via SPM)

Apple Developer setup (one-time)

  1. In Apple Developer Portal:
    • Create App ID: de.vpsj.pi-remote, enable Push Notifications
    • Generate an APNs Auth Key (.p8) — download once, keep safe
    • Note your Key ID and Team ID (KNXX8R3648)
  2. Copy .p8 key to ~/.local/share/pi-remote/apns/AuthKey_<KeyID>.p8
  3. Update [apns] section in pi-remote-control config

Status

Phase 2 — in progress.

Task Status
T-2.0 Xcode scaffold done
T-2.1 WebSocketClient + FrameCodec + ResumeCursor done
T-2.2 Pairing + Keychain + QRScanner done
T-2.3 TerminalView + ThemeStore + FontStore done
T-2.4 ModifierBar + ModifierState + PasteSheet done
T-2.5 SessionConnection (IC-2.1) + ScrollbackCache done
T-2.9 APNs NotificationDelegate + DeviceTokenRegistrar done
T-2.6 SessionRegistry + SessionSwitcher UI next
T-2.7 PreConnectPool after T-2.6
T-2.8 StatusBar + Side-channel next
T-2.10 Background lifecycle todo
T-2.11 Face-ID gate + Settings next
T-2.12 TestFlight pipeline todo
T-2.13 MVP smoke test last

App runs on device: iOS 26, wireless, Xcode 16.4 Intel Mac.
111 unit tests across FrameCodec, ResumeCursor, Pairing, Keychain, Theme, ModifierState, ScrollbackCache, DeviceTokenRegistrar.

See pi-remote-control/docs/PHASE-2-ios-mvp.md for full spec.