Skip to content
xcross
Documentation menu

Quick start

From an installed xcross to a running Flutter or Compose Multiplatform app on a real iPhone.

Assumes xcross is installed. Pick your framework once, and every tab on the site follows.

1. One-time setup

  1. 1
    Install host tools
    $xcross setup
  2. 2
    Extract the iOS SDK
    $xcross sdk install ~/Downloads/Xcode.xip
    Takes a while. See Darwin SDK.
  3. 3
    Sign in
    $xcross auth --apple-id you@example.com
    A free Apple ID works. See Authentication.

2. Check everything

xcross flutter doctor

Read-only, from your project root. Checks the project, toolchain, SDK, auth and devices, grouped by section. Fix anything red.

3. Connect and run

  1. 1
    Start the tunnel (once per reconnect)
    $xcross tunnel
    Admin PowerShell on Windows, sudo on Linux. Add --wifi for wireless.
  2. 2
    Run with hot reload
    $xcross flutter run

While it runs

rHot reload
RHot restart
qCtrl-CQuit

TipSeveral iPhones? You get a picker. In CI, pass -u <UDID>.

On the first device run xcross asks whether to register the original bundle id or an XCR- prefixed one, and saves the answer as bundle_id in your project. Commit it so CI and IDE runs agree. See App ID on first device run.

After that first online run, the app keeps signing and installing without a network. See Working offline.

Next

IDE debuggingF5, breakpoints, DevTools.Go wirelessPair once, drop the cable.Compose guideWatch mode, caching, limits.TroubleshootingWhen a step fails.
Edit on GitHubReport an issue
ESC