Quick Start

This page takes you from nothing to a shareable preview of your own app: try the simulator in the browser, install the CLI, open your app, run a flow, and upload it.

1. Try it in the browser

The peachsim.com home page runs the real simulator in your browser tab. Press play on the demo tour to watch it move through built-in sample apps and end on the real Bluesky app, or tap and scroll the phone yourself. No project of your own yet? Try Peach without a project has every no-setup path.

2. Install the CLI

The script downloads a standalone executable for macOS or Linux, installs the engine runtime and, on Apple silicon Macs with macOS 26 or later, the native desktop app, and turns on the background service that keeps later commands fast. It needs no Node.js, npm, Bun, or sudo. Open a new terminal afterwards so peach is on your PATH. See Installation to read the script first, pin a version, or set up CI.

3. Open your app

Pick the guide for what you build. Each one is a complete path for that kind of app:

your appguide
Expo, Metro, or One (React Native)Run your Expo app
Swift, with SwiftUI or UIKit (beta)Run a SwiftUI app
Kotlin, with Jetpack Compose (beta)Run a Compose app

For a React Native app, the short version: in your project root, start the dev server you already use, then point Peach at its port from the same directory.

React Native apps must enable the new architecture. It is the default from React Native 0.76; older versions need an explicit opt-in. Apps that opt out receive unsupported-architecture when opening.

terminal
npx expo start --port 8081
# in another terminal, same directory
peach open 8081

Peach does not start, configure or replace your dev server, and it needs no per-app install and no native build. Running peach open from the project root lets it find your fonts, splash screen and other app configuration.

Not sure of the port? Run peach with no arguments. It opens ConnectRN, which lists the local dev servers it finds so you can pick one.

Choose a device with --device:

terminal
peach open 8081 --device pixel-8 # an Android phone
peach open 8081 --device iphone-17-pro # an iPhone

peach device list prints every model. Before opening a large app for the first time, peach compat in its project root reports which of its packages Peach runs and what is missing.

4. Run a flow

Run peach describe to see the text and test IDs on the current screen. The example below assumes an app with Welcome, Get Started, and Home. Replace those with your own controls and destination, then save it as .maestro/smoke.yaml. Copy labels exactly: a non-breaking space (U+00A0) looks like a normal space but does not match one, so prefer a real testID with id: or a regex such as Get[\s\u00a0]Started.

- launchApp: {}
- extendedWaitUntil:
visible: 'Welcome'
timeout: 10000
- tapOn: 'Get Started'
- assertVisible: 'Home'
- takeScreenshot: home

Tests need a free Peach account. Run peach login, or set PEACH_API_KEY from peach auth key create or Billing → API Keys.

Run it:

terminal
peach test .maestro/smoke.yaml

The same flow runs in CI. See Your First Test for Maestro and Detox side by side.

5. Share it

Run the flow with --preview. Peach records the run, uploads it, and prints a /preview/<id> link. Add --preview-open to open it:

terminal
peach login
peach test .maestro/smoke.yaml --preview --preview-open

Whoever opens the link watches the recording, then can tap in and use your real app live, with nothing installed. A preview not tied to a GitHub repository starts private to your account; turn on Public link in the preview page’s share menu to hand it to anyone. See Preview uploads and sharing.

Next

  • +
    Simulating the device: permissions, location, camera, appearance and storage.
  • +
    Testing: flows in CI and run results in the dashboard.
  • +
    Agents setup: let a coding agent drive the simulator with peach skill install.