pip install revyl[sdk]           # Python SDK (includes CLI)

export REVYL_BINARY=./revyl-cli/tmp/revyl

revyl auth login                # Browser-based login (stores credentials locally)
export REVYL_API_KEY=rev_...    # Or set an API key

from revyl import RevylCLI, RevylError

cli = RevylCLI()                                        # Uses auto-resolved binary
cli = RevylCLI(binary_path="/usr/local/bin/revyl")      # Explicit path

version = cli.run("version")                            # Returns stdout as string
tests = cli.run("test", "list", json_output=True)       # Returns parsed JSON

from revyl import DeviceClient

# start() blocks until the device is API-ready (default).
# Report URL auto-prints when the session closes.
with DeviceClient.start(platform="ios", app_url=url) as device:
    device.screenshot(out="screen.png")
    device.tap(target="Login button")
    device.type_text(target="Email", text="[email protected]")

from revyl import DeviceClient

with DeviceClient.start(platform="android") as device:
    device.tap(target="Get Started")
    device.swipe(target="feed", direction="down")
# Session is stopped automatically on exit; report URL is printed.

# For advanced users who want to do parallel setup work.
device = DeviceClient.start(platform="ios", app_url=url, wait_for_ready=False)
# ... do other setup ...
device.wait_for_device_ready()   # block when you need the device
device.screenshot(out="screen.png")
device.stop_session()

device = DeviceClient(session_index=1)
device.tap(target="Settings tab")

device.tap(target="Sign In button")           # Grounded (recommended)
device.tap(x=540, y=960)                      # Coordinates
device.type_text(target="Email", text="...")   # Grounded
device.type_text(x=540, y=400, text="...")     # Coordinates

device = DeviceClient.start(platform="ios", app_url=url, wait_for_ready=False)
# ... parallel setup ...
device.wait_for_device_ready(timeout=90)

report = device.wait_for_report(timeout=30)
print(report["report_url"])

device.code_execution(script_id="seed-db")                           # saved script
device.code_execution(file_path="scripts/seed.py", runtime="python") # local file
device.code_execution(code="print('hello')", runtime="python")       # inline code

report = device.report()
print(report["report_url"])   # Browser link to the full report
print(report["video_url"])    # Recording of the session
print(report["total_steps"], report["passed_steps"], report["failed_steps"])

all_targets = DeviceClient.targets()
ios_targets = DeviceClient.targets(platform="ios")

recent = DeviceClient.history(limit=5)

with DeviceClient.start(platform="ios", app_url=url) as device:
    whep_url = device.wait_for_stream(timeout=30)
    if whep_url:
        print(f"Stream ready: {whep_url}")

whep_url = device.wait_for_stream(timeout=30)

session = device.info()
whep_url = session.get("whep_url")

from revyl import ScriptClient

scripts = ScriptClient()              # Uses default CLI runner
scripts = ScriptClient(cli=my_cli)    # Custom CLI runner

scripts.create("seed-db", file_path="scripts/seed.py", runtime="python", description="Seeds test data")

from revyl import ModuleClient

modules = ModuleClient()              # Uses default CLI runner
modules = ModuleClient(cli=my_cli)    # Custom CLI runner

modules.create("login-flow", blocks_file="modules/login.yaml", description="Standard login sequence")

from revyl import BuildClient

builds = BuildClient()              # Uses default CLI runner
builds = BuildClient(cli=my_cli)    # Custom CLI runner

builds.upload(app_name="my-app", platform="android")
builds.upload(skip_build=True)  # upload existing artifact without rebuilding

from revyl import DeviceModel

# iOS models
model: DeviceModel = "iPhone 16"
model: DeviceModel = "iPhone 17 Pro Max"
model: DeviceModel = "iPad Pro 13-inch (M4)"

# Android models
model: DeviceModel = "Pixel 7"

from revyl import OsVersion

version: OsVersion = "iOS 18.5"
version: OsVersion = "iOS 26.3.1"
version: OsVersion = "Android 14"

from revyl import DeviceClient, RevylError

try:
    device = DeviceClient.start(platform="ios")
    device.tap(target="Login button")
except RevylError as e:
    print(f"Command failed: {e}")

import { execFileSync } from "node:child_process";

class RevylDevice {
  constructor(platform: string) {
    this.run("device", "start", "--platform", platform);
  }

  private run(...args: string[]): Record<string, unknown> {
    const out = execFileSync("revyl", [...args, "--json"], {
      encoding: "utf-8",
    });
    return out.trim() ? JSON.parse(out) : {};
  }

  tap(target: string) {
    return this.run("device", "tap", "--target", target);
  }

  typeText(target: string, text: string) {
    return this.run("device", "type", "--target", target, "--text", text);
  }

  swipe(target: string, direction: "up" | "down" | "left" | "right") {
    return this.run("device", "swipe", "--target", target, "--direction", direction);
  }

  instruction(step: string) {
    return this.run("device", "instruction", step);
  }

  validation(step: string) {
    return this.run("device", "validation", step);
  }

  screenshot(out?: string) {
    const args = ["device", "screenshot"];
    if (out) args.push("--out", out);
    return this.run(...args);
  }

  stop() {
    return this.run("device", "stop");
  }
}