Skip to content

iOS Agent Setup

The iOS agent runs on a Mac and streams simulator screens to the relay.

Prerequisites

  • macOS
  • Xcode with iOS Simulator Runtime installed
  • Node.js ≥ 20

Start the agent

sh
tapflow agent start --relay wss://your-relay-url

The agent connects outbound — no inbound firewall rules needed.

Options

OptionDefaultDescription
--relayws://localhost:4000Relay WebSocket URL
--devicefirst bootedSimulator name or UDID to use
--platformauto-detectios | android | all

List available simulators

sh
tapflow devices

Boot a specific simulator

sh
tapflow boot "iPhone 16 Pro"

Multiple simulators

Each Mac supports 2–4 simultaneous simulators depending on available RAM. The agent reports available slots automatically. See Scaling Mac Resources to add more hosts.

Troubleshooting

Run tapflow doctor to diagnose common issues:

Common
  ✓ Node v20.x

iOS
  ✓ Xcode 16.2
  ✓ xcrun simctl
  ✓ Simulator booted: iPhone 16 Pro

See Troubleshooting for more detailed solutions.

Released under the MIT License.