Skip to main content
The Revyl CLI brings AI-powered mobile testing to your terminal. Create, sync, and run tests locally without leaving your development environment.

Why Use the CLI?

  • Local-first workflow - Edit tests in your IDE, sync with the cloud
  • CI/CD ready - Integrate testing into your build pipelines
  • Fast iteration - Run tests directly from your terminal
  • Version control - Store test definitions alongside your code

Installation

Install the CLI using your preferred method:
brew install RevylAI/tap/revyl
The CLI binary auto-downloads on first use when installed via pip, pipx, or uv.
On macOS, Homebrew is the recommended installation method. It handles updates automatically via brew upgrade revyl.

Direct download

Download the binary for your platform from GitHub Releases. Available builds:
PlatformArchitectureAsset
macOSarm64 (Apple Silicon)revyl-darwin-arm64
macOSamd64 (Intel)revyl-darwin-amd64
Linuxarm64revyl-linux-arm64
Linuxamd64revyl-linux-amd64
Windowsamd64revyl-windows-amd64.exe
After downloading, make the binary executable (macOS/Linux) and place it on your PATH.

Verify Installation

revyl version
You should see output like:
revyl version 1.x.x

Run Diagnostics

Check that everything is configured correctly:
revyl doctor
This command verifies:
  • CLI version and updates
  • Authentication status
  • API connectivity
  • Project configuration
  • Build system detection

Quick Start

Get up and running in 5 commands:
# 1. Install the CLI
brew install RevylAI/tap/revyl    # or: pipx install revyl

# 2. Authenticate with your API key
revyl auth login

# 3. Initialize your project
cd your-app
revyl init

# 4. Pull existing tests from Revyl
revyl test pull

# 5. Run a test
revyl test run login-flow
If you don’t have tests yet, create one in the Revyl dashboard first, then use revyl test pull to download it locally.

Updating the CLI

Use the upgrade command that matches how you installed:
brew upgrade revyl
If you installed via direct download, revyl upgrade performs a self-update (downloads the latest binary, verifies checksums, and replaces the executable). To check for updates without installing, use:
revyl upgrade --check

Global Flags

These flags work with any command:
FlagDescription
--debugEnable debug logging
--devUse local development servers
--jsonOutput results as JSON
--quiet, -qSuppress non-essential output

Next Steps

For focused device session and action workflows, see Device Automation.

Authentication

Set up your API key

Project Setup

Initialize your project

Managing Tests

Sync and manage tests

Running Tests

Execute tests locally

Dev Loop

Iterate quickly with revyl dev

Device Automation

Start, control, and debug cloud devices