Quickstart - Revyl Documentation

Prerequisites

A Revyl account
Your mobile app project

Install the CLI

curl -fsSL https://revyl.com/install.sh | sh
revyl auth login

Run init

revyl init

revyl init creates .revyl/config.yaml and helps you connect the project to the right Revyl app.

Configure the build

Configure the build commands in .revyl/config.yaml:

Expo
React Native
iOS
Android

build:
  platforms:
    ios:
      commands:
        - bun install
        - bunx expo prebuild --platform ios
        - cd ios && pod install
        - cd ios && xcodebuild -workspace YourApp.xcworkspace -scheme YourApp -configuration Release -sdk iphonesimulator -destination 'generic/platform=iOS Simulator' -derivedDataPath build ARCHS=arm64
      output: ios/build/Build/Products/Release-iphonesimulator/*.app
      app_id: "<your-ios-app-uuid>"
    android:
      commands:
        - bun install
        - bunx expo prebuild --platform android
        - cd android && ./gradlew assembleRelease
      output: android/app/build/outputs/apk/release/*.apk
      app_id: "<your-android-app-uuid>"

build:
  platforms:
    ios:
      commands:
        - npm install
        - cd ios && pod install
        - cd ios && xcodebuild -workspace YourApp.xcworkspace -scheme YourApp -configuration Release -sdk iphonesimulator -destination 'generic/platform=iOS Simulator' -derivedDataPath build ARCHS=arm64
      output: ios/build/Build/Products/Release-iphonesimulator/*.app
      app_id: "<your-ios-app-uuid>"
    android:
      commands:
        - npm install
        - cd android && ./gradlew assembleRelease
      output: android/app/build/outputs/apk/release/*.apk
      app_id: "<your-android-app-uuid>"

build:
  platforms:
    ios:
      commands:
        - xcodebuild -project YourApp.xcodeproj -scheme YourApp -configuration Release -sdk iphonesimulator -destination 'generic/platform=iOS Simulator' -derivedDataPath build ARCHS=arm64
      output: build/Build/Products/Release-iphonesimulator/*.app
      app_id: "<your-ios-app-uuid>"

build:
  platforms:
    android:
      commands:
        - ./gradlew assembleRelease
      output: app/build/outputs/apk/release/*.apk
      app_id: "<your-android-app-uuid>"

For the full set of build options — artifact requirements, environment variables, toolchain images, and more — see Configuration.

Run the build

revyl build --remote --platform ios

Useful variations:

revyl build --remote --platform ios --debug     # stream full build logs
revyl build --remote --platform android --json  # machine-readable result
revyl build --remote --platform ios --detach    # queue and return a build ID

For a detached build:

revyl build status <build-job-id> --follow
revyl build cancel <build-job-id>

Use the build

The new version is registered on your app and set as current. Boot a device with it and run a test:

revyl device start --platform ios --app-id <your-ios-app-uuid>
revyl test run <test-alias>

If the build fails

Check the log tail printed by revyl build. You can also run:

revyl build status <build-id>

That shows where the build failed and the most recent logs.

Next steps

Configuration

Multiple build streams, env vars, repo-backed source, all CLI flags.

Caching

Make the second build much faster than the first.

Toolchain Images

Pin the Xcode or Android toolchain version.

GitHub Integration

Build every pull request automatically.

​Prerequisites

​If the build fails

​Next steps