[ Documentation ]
Quick Start

Quick Start

Try it before installing

The rnxsim.com home page runs the real simulator, not a video of one. Press play and it drives the built-in demo apps, ending on the real Bluesky bundle: scroll a feed, open native pickers, swipe between apps. Everything below gives you that same simulator pointed at your own app.

Install rnx

curl -fsSL https://rnxsim.com/install.sh | sh

The public script downloads a standalone Bun-compiled executable. Installing and running the CLI needs no Node.js, npm, or Bun installation. Guided setup then installs the engine runtime and offers the background daemon without sudo or changes to your app. The daemon keeps the bridge running so every later CLI command is much faster.

See Installation to inspect the script, pin an exact version, choose another install directory, or configure CI.

Open the simulator

From your app project root, start its Metro, Expo, React Native, or One server with the command you already use. rnx does not start or replace that server. Then, from the same directory, open ConnectRN:

terminal
rnx

ConnectRN shows available local React Native development servers. Choose your app there, or use rnx open 8081 when you already know the port.

No per-app install is needed, and no iOS or Android native build is needed. Metro, Expo, or One running locally is enough. Running open from the project root is recommended because the directory is rnx’s fallback for discovering custom fonts, splash screens, and other app configuration. The command can still load the bundle when you run it elsewhere, but those project details may be missing.

Choose an iOS or Android device profile with rnx open 8081 --device pixel-8 or another model from rnx device list.

If no bridge is running, rnx open starts the lightweight local HTTP and WebSocket bridge as needed. The background service keeps that bridge and the runtime ready between commands. This makes agent inspection, interaction, and test commands much faster. First-run onboarding recommends it; enable it later with rnx daemon install if you initially decline. It serves the simulator at http://localhost:7668/ by default, and you can load that URL in any browser. The registered daemon is recommended for local work and is not needed in CI.

First-run onboarding also offers the packaged Desktop app. The CLI shows download progress, installs the macOS DMG’s rnx.app, runs the Windows installer, or installs the matching Linux AppImage. You can install it later with rnx desktop install.

Run rnx --help to get an overview of common commands.

Install the bundled agent skills with rnx skill install, then restart the agent session so it discovers them. Run rnx compat when you want to scan package compatibility. If it finds a concrete gap, rnx report-issue can send the scan only after you explicitly approve it.

Run a Maestro test

Create .maestro/smoke.yaml:

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

Run it with:

terminal
rnx maestro test .maestro/smoke.yaml

Want a shareable preview link? Sign in once, then run the flow with --preview. It records the run, uploads it, and prints a shareable /preview/<id> link (--preview-open also opens it in your browser):

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

Next

  • +
    Your First Test covers Maestro and Detox side by side.
  • +
    Testing takes the same flow through CI and into run results in the dashboard.
  • +
    Contrast quick start shows the browser workspace that uses rnx for every native preview.