> ## Documentation Index
> Fetch the complete documentation index at: https://docs.coderabbit.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# CodeRabbit Verify

> CodeRabbit Verify tests pull requests and user journeys against your running app in an isolated sandbox, and reports bugs and blockers with screenshots and recordings.

GitHub Cloud (Verify is available on GitHub Cloud. GitHub Enterprise Server is not supported.) GitLab.com (Verify is available on GitLab.com. GitLab self-managed is not supported.) Bitbucket Cloud (Verify is available on Bitbucket Cloud. Bitbucket Data Center is not supported.) | Cloud Only (This feature is available on CodeRabbit Cloud only. It is not available on self-hosted CodeRabbit deployments.) Open Beta (Verify is in beta and free during the beta.)

CodeRabbit Verify tests how your application behaves, not only how its code reads. It starts your app in an isolated sandbox prepared from a [coding environment](https://docs.coderabbit.ai/code/environments.md), uses it the way a user would, mostly through a browser, and through its CLI or HTTP API when the change calls for that. It reports what it found: bugs with reproduction steps, blockers that kept it from testing, and the screenshots and session recordings behind each result.

## Two ways to run Verify

| Run type | What Verify tests | How it starts | Where results appear |
| - | - | - | - |
| Pull request run | Scenarios that Verify writes from the pull request's changes | An `@coderabbitai verify` comment, or automatically when a pull request opens or gets new commits, if you turn that on | A Verify comment on the pull request, and the pull request's [Change Stack](https://docs.coderabbit.ai/change-stack.md) |
| User journey run | User journeys saved in the repository's library | **Run tests** on the repository's **User journeys** page in the CodeRabbit app, or a schedule | The repository's run history and the Activity page |

Pull request runs don't use your saved user journeys, and user journey runs don't post on pull requests. See [Test pull requests](https://docs.coderabbit.ai/verify/pull-requests.md) and [User journeys](https://docs.coderabbit.ai/verify/user-journeys.md).

## How a run works

A run moves through these stages. On the Activity page, a waiting run shows **Queued**, then **In progress** with the stage name.

1. **Queued**: the run waits for its turn, for example while another run on the same pull request finishes or while a sandbox becomes available.
2. **Inspecting** and **Preparing**: Verify finds the repository's environment and restores its prepared snapshot in a new sandbox, with the code to test checked out.
3. **Generating** (pull request runs only): Verify reads the diff and explores the repository, and writes test scenarios for the behavior the change affects. If the change has no material effect, Verify can select no scenarios, and the run is **Skipped**.
4. **Testing**: Verify starts your app with the environment's startup script, confirms that it is ready, and works through each scenario or user journey. It takes screenshots and records the browser session as it goes.
5. **Aggregating** and **Publishing**: Verify gives each scenario or journey one outcome, links each bug to the same bug found in earlier runs of the repository, and publishes the results.

## Key concepts

| Term | Meaning |
| - | - |
| Environment | A prepared [coding environment](https://docs.coderabbit.ai/code/environments.md) that installs your app's dependencies and starts it. Verify shares environments with Coding Agent and with [runtime verification](https://docs.coderabbit.ai/security/runtime-verification.md). |
| User journey | A saved test of an important flow in your app: who the user is, their goal, the steps they take, and the assertions that must hold. |
| Scenario | A test that Verify writes for one pull request from its changes. You can review and revise a pull request's scenarios in Change Stack. |
| Bug | A product defect supported by test evidence, with reproduction steps and the expected and actual behavior. |
| Blocker | Something that kept Verify from testing, such as missing credentials, permissions, integrations, or test data, with its impact and a suggested fix. |
| Outcome | The one primary result of a run or scenario, such as **Bugs**, **Blockers**, **Passed**, or **Inconclusive**. See [Results and bugs](https://docs.coderabbit.ai/verify/results.md#outcomes). |

## Where Verify lives

* **In the CodeRabbit app**: select **Verify** in the sidebar to open the list of repositories you've added. A repository's page has two groups: **Pull Requests**, with **PR runs** and **Settings**, and **Journey Testing**, with **User journeys**, **Run history**, **Bugs**, **Blockers**, **Schedules**, and **Settings**.
* **Pull request testing settings**: select **Review** > **Verify** in the sidebar, or **Pull Requests** > **Settings** on the repository's page.
* **Activity**: runs and outcomes across all your repositories, at [app.coderabbit.ai/verify/activity](https://app.coderabbit.ai/verify/activity).
* **On the pull request**: one **CodeRabbit Verify** comment that Verify keeps up to date, with links to the pull request's **Verify** tab in Change Stack.

Verify has no `.coderabbit.yaml` settings. You add and configure each repository in the app.

## Availability

* Verify is available on CodeRabbit Cloud for GitHub Cloud, GitLab.com, and Bitbucket Cloud repositories. See [Access and billing](https://docs.coderabbit.ai/verify/access-and-billing.md#platform-support).
* Verify tests web apps and services. Native mobile apps aren't supported.
* Verify is in beta and free during the beta. The sidebar shows **Free during beta** next to **Verify**.
* Verify uses the Coding Agent permissions. Admins and Members can use it by default; users with the Billing Admin role can't. See [Permissions](https://docs.coderabbit.ai/verify/access-and-billing.md#permissions).
* If **Verify** doesn't appear in your sidebar, it isn't available for your organization yet. See [Troubleshooting](https://docs.coderabbit.ai/verify/troubleshooting.md).

## What's next

> [card] [Set up Verify](https://docs.coderabbit.ai/verify/setup.md)
>
> Prepare an environment, add a repository, and choose when Verify runs.

> [card] [Test pull requests](https://docs.coderabbit.ai/verify/pull-requests.md)
>
> Start a run with a comment or automatically, and read the Verify comment.

> [card] [User journeys](https://docs.coderabbit.ai/verify/user-journeys.md)
>
> Build a library of critical flows and test them on demand or on a schedule.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.