> ## 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.

# Revyl CLI

> The power tool for you and your agents

<Note>
  **Give the CLI to your agent.** Point Cursor, Claude Code, Codex, or any coding agent at the Revyl CLI and it can create tests, upload builds, drive live devices, and run your suite end-to-end. Point it at your app and let it test.
</Note>

The Revyl CLI brings the full platform to your terminal. Local-first, git-friendly, and built for automation.

<Card title="CLI Documentation on GitHub" icon="github" href="https://github.com/RevylAI/revyl-cli/tree/main/docs">
  Full guides for authentication, project setup, tests, dev loop, device commands, and more.
</Card>

## Install

```bash theme={null}
curl -fsSL https://revyl.com/install.sh | sh
```

Or use a package manager:

<CodeGroup>
  ```bash Homebrew (macOS) theme={null}
  brew install RevylAI/tap/revyl
  ```

  ```bash pipx (cross-platform) theme={null}
  pipx install revyl
  ```

  ```bash uv theme={null}
  uv tool install revyl
  ```

  ```bash pip theme={null}
  pip install revyl
  ```
</CodeGroup>

The PyPI package is CLI-only and includes the native Revyl binary for the
selected platform. It does not download a binary when `revyl` first runs.

## Quick Start

```bash theme={null}
revyl doctor          # check your environment
revyl auth login      # authenticate
revyl init            # initialize your project
revyl build           # build and upload a dev binary
revyl dev             # start the dev loop
```

## What You Can Do

Every surface of Revyl is available from the terminal.

* **Tests**: create, sync, edit, and run tests from YAML files stored alongside your code
* **Builds**: upload iOS and Android binaries, pin versions, sync with CI builds
* **Devices**: spin up cloud iOS and Android sessions, drive them with tap/swipe/type, set GPS, open deep links
* **Dev Loop**: iterate on tests with hot reload against a live device
* **Workflows**: trigger test suites, watch runs, pull results
* **Reports**: download video, logs, and network traces
* **Library**: manage modules, global variables, launch vars, scripts, and files

See the full [command reference](https://github.com/RevylAI/revyl-cli/blob/main/docs/COMMANDS.md).

## Built for Agents

The CLI is designed to be delegated to an AI agent. Give your agent access to the CLI and it gains full control of your mobile testing stack.

**What agents can do with Revyl:**

* Bootstrap a new test suite from scratch by exploring your app on a live device
* Debug failing tests by reading reports, reproducing on a device, and fixing the steps
* Write tests that match feature PRs and add them to your workflow
* Upload builds, pin versions, and trigger regression suites
* Scrape device logs and network traces to root-cause flakes

## Key Resources

<CardGroup cols={2}>
  <Card title="Getting Started" icon="rocket" href="https://github.com/RevylAI/revyl-cli/blob/main/docs/getting-started.md">
    First-time setup walkthrough
  </Card>

  <Card title="Command Reference" icon="book" href="https://github.com/RevylAI/revyl-cli/blob/main/docs/COMMANDS.md">
    Every CLI command and flag
  </Card>

  <Card title="Dev Loop" icon="bolt" href="https://github.com/RevylAI/revyl-cli/blob/main/docs/developer_loop/dev-loop.md">
    Hot reload with live devices
  </Card>

  <Card title="GitHub Repository" icon="github" href="https://github.com/RevylAI/revyl-cli">
    Source, releases, and README
  </Card>

  <Card title="CI/CD" icon="code-branch" href="https://github.com/RevylAI/revyl-cli/blob/main/docs/ci-cd.md">
    Run tests from your pipelines
  </Card>
</CardGroup>