Quickstart

This is the fastest way to get a working device session and take real actions safely.

1. Install and Authenticate

curl -fsSL https://revyl.com/install.sh | sh
brew install RevylAI/tap/revyl    # Homebrew (macOS)
pipx install revyl                # pipx (cross-platform)
uv tool install revyl             # uv
pip install revyl                 # pip

pip install revyl[sdk]

Then authenticate. The CLI prints an approval URL — open it in any browser and approve:

revyl auth login

You can also use an API key:

export REVYL_API_KEY="rev_..."

2. Start a Device Session

Run from the directory that owns .revyl/ (or a subdirectory of it) so project config is loaded.

revyl device start --platform android --timeout 600
revyl device info

from revyl import DeviceClient

device = DeviceClient.start(platform="android", timeout=600)
print(device.info())

If .revyl/config.yaml declares before_session and/or auth_bypass, the CLI mints and applies those values before the device boots — no --launch-var flags required. See Auth And Session Prep.

3. Install and Launch Your App

Use a direct build URL (APK or IPA). Launch defaults to the app you just installed, so you do not need to know its bundle ID — pass --bundle-id only to launch a different installed app.

revyl device install --app-url "https://example.com/app.apk"
revyl device launch

device.install_app(app_url="https://example.com/app.apk")
device.launch_app()

4. Use the Safe Action Loop

Always re-observe before and after important actions.

revyl device screenshot --out before.png
revyl device tap --target "Sign In button"
revyl device type --target "Email field" --text "[email protected]"
revyl device screenshot --out after.png

device.screenshot(out="before.png")
device.tap(target="Sign In button")
device.type_text(target="Email field", text="[email protected]")
device.screenshot(out="after.png")

5. Stop the Session

revyl device stop

device.stop_session()

Signed-in sessions: Auth And Session Prep
Full command coverage: Command Reference
Agent-driven device control: MCP Setup
CI orchestration APIs: API Quickstart

Getting Started

CLI

Builds

Tests

Develop

Atlas

Integrations

Appendix

1. Install and Authenticate

2. Start a Device Session

3. Install and Launch Your App

4. Use the Safe Action Loop

5. Stop the Session

Next

​1. Install and Authenticate

​2. Start a Device Session

​3. Install and Launch Your App

​4. Use the Safe Action Loop

​5. Stop the Session

​Next

1. Install and Authenticate

2. Start a Device Session

3. Install and Launch Your App

4. Use the Safe Action Loop

5. Stop the Session

Next