Verify

Verify runs end-to-end checks in a real browser, iOS simulator, or Android emulator on Revyl. You describe what the agent should do and what must be true afterward, instead of maintaining selectors and coordinates that break when a screen changes. Use it from a script, a coding agent, or the test runner you already have. Mac and Linux computers are also available for commands, files, and screenshots, not natural-language steps.

Every run gives you a link to watch the target. The session keeps its report and available recording, and the SDK keeps instruction and validation results in order. A failed check leaves evidence you can inspect.

Install and run

npm install @revyl/verify

Save this as verify/check.mts:

import { open } from '@revyl/verify';

const session = await open({ platform: 'ios', app: { bundleId: 'com.apple.Preferences' } });
try {
  await session.instruction('Open General, then About');
  await session.validation('The screen shows the operating system version');
  await session.screenshot({ path: '.verify/about.png' });
} finally {
  await session.close();
}

Use appId when you want to target your own uploaded app.

Run the script:

node verify/check.mts

On the first interactive run, Verify opens the Revyl browser approval flow once and saves the login in ~/.revyl/credentials.json for the CLI and SDK to share.

Verify prints a live session URL and progress like this:

[verify] ios: starting ios session https://app.revyl.ai/sessions/…
[verify] ios: ready
[verify] ios: ✓ instruction "Open General, then About" (12.0s)
[verify] ios: ✓ validation "The screen shows the operating system version" (9.8s)
[verify] ios: closed

The URL is live during the run and keeps the report and available recording after it closes. A failed instruction or validation throws a typed error and includes the same URL. In CI, Verify never opens a browser: provide REVYL_API_KEY as a secret.

For Web, use open({ platform: 'web', app: { appId, url } }); for a computer, use open({ platform: 'mac' }). Web targets need Web enabled for your organization; new self-serve organizations don't have it yet. revyl app create --platform web reports Web is not enabled for this organization; contact Revyl to enable it.

Scaffold a config (optional)

Use init when you want named targets in verify.config.ts and a generated verify/example.ts script:

npx @revyl/verify init

init detects your package manager, asks before adding @revyl/verify as a dev dependency, creates verify.config.ts and verify/example.ts, and prints the command that runs the example. Use --yes to accept installation without a prompt, or --no-install when Verify is already installed. It is optional; installing the package is enough to use inline targets.

The generated project starts with a named target. Use --platform web, --platform ios, --platform android, or --platform mac when you want to skip the platform question. Web and mobile targets need a Revyl app id; a Mac target does not. The generated config is ordinary TypeScript, so edit it when the example needs a pinned build, a public Web URL, or a different target.

See the TypeScript getting-started guide, the Python SDK guide, and the Go SDK guide.

CI

For a normal GitHub Actions job, install from the lockfile with npm ci and pass REVYL_API_KEY from repository secrets to the script that runs Verify:

- uses: actions/checkout@v5
- uses: actions/setup-node@v5
  with:
    node-version: 24
    cache: npm
- run: npm ci
- run: node verify/example.ts
  env:
    REVYL_API_KEY: ${{ secrets.REVYL_API_KEY }}

On a revyl-macos job, currentComputer() attaches to the runner's existing computer without taking ownership. The runner releases the computer; closing the Verify attachment still cleans up hosted children. See the CI guide and computer API.

Reference authentication

Use manual setup when you need to control the package manager or keep the generated files out of the project:

revyl auth login
npx @revyl/verify whoami

The SDK resolves credentials in this order: a usable stored CLI login marked local_auth_override, REVYL_API_KEY, then another usable stored CLI login. In CI, use a secret manager rather than putting a key in source, command arguments, or logs. whoami checks the credentials without starting a session.

TypeScript

import { open } from '@revyl/verify';

const session = await open('ios');
try {
  await session.instruction('Open General, then About');
  await session.validation('The screen shows the operating system version');
} finally {
  await session.close();
}

For Web, use a public HTTPS URL in the target config. For iOS and Android, point the target at an app or build in Revyl. The API guide covers target options, step results, screenshots, reports, and cleanup.

Go

Inside a function returning error, with a bounded ctx:

session, err := verify.Open(ctx, verify.Target{Platform: verify.IOS, BundleID: "com.apple.Preferences"})
if err != nil {
    return err
}
defer func() { _ = session.Close(ctx) }()
if _, err := session.Instruction(ctx, "Open General, then About"); err != nil {
    return err
}
_, err = session.Validation(ctx, "The screen shows the operating system version")
return err

Go calls return errors instead of throwing. The Go reference covers context deadlines, screenshots, computer operations, and hosted sessions.

Python

The Python SDK isn't published to PyPI yet; install it from source using the instructions in the Python SDK guide.

from revyl_verify import Target, open

with open(Target(platform="ios", bundle_id="com.apple.Preferences")) as session:
    session.instruction("Open General, then About")
    session.validation("The screen shows the operating system version")

Python supports synchronous and asyncio APIs, but it has no bundled CLI. The Python reference covers both APIs and computer operations.

Platforms

Platform	Instructions / validations	Commands / files / processes	PNG screenshot
Web	Yes	—	Yes
iOS simulator	Yes	—	Yes
Android emulator	Yes	—	Yes
Mac computer	—	Yes	Yes
Linux computer	—	Yes	Yes

Computer targets are early access and use commands, files, processes, and screenshots rather than natural-language agent steps. They have a server-bounded lifetime. See computer setup.

Documentation

• Documentation index · API · CI · Coding agents
• End-to-end results and limitations
• Examples: Web store · Mobile Settings · Mac workspace
• Contributing · Security · Releasing

Troubleshooting

• NOT_AVAILABLE_ON_PLATFORM: the requested method is not available for that target. Computer targets do not run instruction or validation steps; Web and mobile targets do not expose computer commands or files.
• COMPUTER_LIMIT: computer admission was refused because of queued work or a concurrency limit. Verify does not retry creation or stop a definitely refused start.
• Blank first screen: mobile startup uses a bounded, best-effort blank-frame observation, not a rendered-readiness guarantee. Begin with an instruction that reaches the screen your workflow needs.
• A validation report looks successful but the assertion failed: inspect each step's effective_status and validation_result, and compare validations_passed with total_validations rather than transport counters.

License

Apache 2.0.