Revyl Documentation

Get started

Quickstart

Prove your first pull request in a live session, or start from the CLI.

Pick the path that matches how you work. Each one runs your app in a cloud session, in a Web browser or on a mobile simulator or emulator, and leaves evidence you can open in Revyl. Web is in alpha. To add it to your organization, email support@revyl.ai. Each path starts with its own setup prompt for your coding agent.

Choose a path

Revyl opens each pull request's build in a session, exercises the changed behavior, and posts a verdict on the PR. It works for Web, iOS, and Android apps, and it's the fastest way to see Revyl work on your own code.

Set up with an agent

Paste one prompt and your coding agent does the rest.

Setup prompt

Turn on Revyl proof of changes for this repository and prove one pull request.

Read https://docs.revyl.com/quickstart.md and follow it. It's the current Revyl guide for this, so prefer it over anything you remember about Revyl.

Run `revyl github connect --no-open --no-wait --json` and give me its `install_url`; I'll install the GitHub App. Run `revyl init -y` if the project has no `.revyl/config.yaml`. `revyl github setup` is interactive, so ask me to run it in this project from my own terminal; it gives each pull request a build Revyl can open: a Web bundle or preview URL, or a simulator or emulator build for iOS and Android. Then open one small pull request that changes something visible on the first screen. Don't make it a draft: Revyl skips drafts by default.

You're done when Revyl's verdict comment is on that pull request and you've given me its link.

Ask me before anything that needs my login or approval.

Install the Revyl GitHub App

In the dashboard, open Integrations → GitHub and install the app on your repository. From a terminal, revyl github connect does the same.

Configure a project root

Select the repository and configure its first project root: how each pull request is built for Web, iOS, or Android, and the app that receives each build. New project roots turn on proof of changes with the Revyl agent. From a terminal, run revyl github setup in your project instead.

Open a pull request

Revyl opens the pull request's build in a session, and an agent exercises what the pull request changed.

Read the verdict

One comment on the pull request carries the verdict, a verification confidence score, screenshots, and a link to the session recording. Cloud Agents → Proof of Changes lists your organization's proof runs.

Next: Proof of changes covers verdicts, sign-in, and which agent runs the proof. GitHub covers project roots and build profiles. On GitLab, follow the GitLab tutorial.

Keep going

On this page