> ## Documentation Index
> Fetch the complete documentation index at: https://docs.revyl.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Get up and running with Revyl in 5 minutes

<img src="https://mintcdn.com/cognisim/fQuvYyuV8mxPZ97a/images/diagrams/quickstart-flow.png?fit=max&auto=format&n=fQuvYyuV8mxPZ97a&q=85&s=4998b0858c00205ab85d783dc1ea5079" alt="Quickstart flow" width="1800" height="680" data-path="images/diagrams/quickstart-flow.png" />

## 1. Create an App

Head to **Apps** and click **Create app**. Give it a name, pick iOS or Android, and upload your first build.

* **Android**: `.apk` or `.zip` containing an `.apk`
* **iOS**: simulator `.app` bundle (from Xcode with `"simulator": true`)

Or [connect Expo](/builds/expo-sync) to auto-sync every EAS build.

See [Apps](/builds/index) for more, or the [framework guides](/builds/frameworks) for platform-specific build instructions.

## 2. Pick Your Path

What do you want to do next?

<Tabs>
  <Tab title="Write a test">
    Great for QA engineers and anyone writing regression tests.

    <Steps>
      <Step title="Create a test">
        Go to **Tests**, click **Create test**, give it a name, and pick the app you just uploaded.
      </Step>

      <Step title="Add steps">
        In the [test editor](/tests/creating-tests/test-editor), add natural-language steps:

        * `Instruction`: "Tap the Sign In button"
        * `Validation`: "The home screen is visible"
        * `Extraction`: "Save the order number to \{\{order\_id}}"
      </Step>

      <Step title="Run it">
        Click **Run Steps**. The device boots and the AI agent executes each step against your app.
      </Step>

      <Step title="Read the report">
        Every run produces a [report](/tests/reports): pass/fail, video replay, step-by-step results, device logs, network traces, and an AI-generated summary.
      </Step>
    </Steps>

    **Next:** learn about [step types](/appendix/step-types), [modules](/library/modules), and [workflows](/tests/workflows) to group tests together.
  </Tab>

  <Tab title="Explore on a live device">
    Great for developers and product folks who want a real device in their browser.

    <Steps>
      <Step title="Start a session">
        Go to **Sessions**, click **Start session**, and select your app. Your app boots on a real simulator streamed to your browser.
      </Step>

      <Step title="Interact">
        Tap, swipe, type, set GPS, open deep links. It's a real device, just remote.
      </Step>

      <Step title="Stop and analyze">
        When you're done, stop the session. Every session produces a [report](/tests/reports) with video replay, device logs, network traces, and performance metrics. Dig in to see exactly what happened.
      </Step>

      <Step title="(Optional) Compile to a test">
        Click **Convert to test** on the session row. Revyl's AI turns your interactions into structured test steps. See [Session to Test](/tests/creating-tests/recording).
      </Step>
    </Steps>

    **Next:** learn about [session sources](/develop/index) (UI, CLI, API) and [recording mode](/tests/creating-tests/recording) inside the test editor.
  </Tab>

  <Tab title="CLI / CI/CD">
    Great for automation engineers and anyone who wants tests in their pipeline.

    <Steps>
      <Step title="Install the CLI">
        ```bash theme={null}
        curl -fsSL https://revyl.com/install.sh | sh
        ```

        Or use `brew`, `pipx`, `uv`, or `pip`. See [CLI install](/cli/index).
      </Step>

      <Step title="Authenticate and init">
        ```bash theme={null}
        revyl auth login
        revyl init
        ```

        Creates a `.revyl/` directory with your project config and test YAMLs.
      </Step>

      <Step title="Sync and run">
        ```bash theme={null}
        revyl tests sync        # pull tests from Revyl to your repo
        revyl tests run my-test # run a test from the terminal
        ```

        Commit the YAML to git. CI can now run `revyl tests run` on every PR.
      </Step>

      <Step title="Dev loop">
        For iteration, `revyl dev` gives you hot reload against a live device. Edit the YAML, save, and it re-runs. See the [Dev Loop guide](/develop/dev-loop-overview).
      </Step>
    </Steps>

    **Next:** see [CI/CD integration](/guides/run-tests-ci-cd) and the full [command reference](/cli/configuration).
  </Tab>

  <Tab title="Agent-driven">
    Great for developers who want their coding agent to handle the testing.

    <Steps>
      <Step title="Install the CLI">
        ```bash theme={null}
        curl -fsSL https://revyl.com/install.sh | sh
        ```
      </Step>

      <Step title="Authenticate">
        ```bash theme={null}
        revyl auth login
        ```
      </Step>

      <Step title="Point your agent at it">
        Open your project in Cursor, Claude Code, Codex, or any coding agent. Prompt it with something like:

        ```
        Revyl is installed. My app is uploaded as "MyApp". Write a test
        that covers the login flow, run it, and iterate until it passes.
        ```

        The agent uses the CLI to start sessions, explore your app, write tests, run them, and debug failures.
      </Step>
    </Steps>

    **What agents can do with Revyl:**

    * Bootstrap a new test suite from scratch
    * Write tests for feature PRs
    * Debug failing tests by reading reports and reproducing on a device
    * Trigger regression suites after changes

    Revyl also provides [MCP tools](/cli/mcp-setup) for device-backed app development.

    **Next:** see the [CLI overview](/cli/index) for everything agents can do.
  </Tab>
</Tabs>

<CardGroup cols={2}>
  <Card title="Core Concepts" icon="book" href="/get-started/concepts">
    The mental model for Revyl
  </Card>

  <Card title="CLI" icon="terminal" href="/cli/index">
    Install and use from the terminal
  </Card>
</CardGroup>