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

# Install Rapid Review

> How to install the Rapid Review GitHub App, choose its repositories and understand its GitHub permissions; read this when you set Rapid Review up, add it to another account, wonder why an installed repository isn't reviewed, or want to know why it asks for write access.

## How do I install Rapid Review?

Rapid Review is a GitHub App. You install it on a GitHub account: a personal account or an organization.

<Steps>
  <Step title="Sign in to the app">
    Go to [https://rapidreview.dev](https://rapidreview.dev) and choose "Sign in with GitHub".
  </Step>

  <Step title="Start the installation">
    If Rapid Review isn't installed on any account you can see, the app shows "No accounts yet" and an "Install on GitHub" button. If it is, your accounts page has an "Install on another account" link.
  </Step>

  <Step title="Choose repositories on GitHub">
    Both take you to GitHub. There you install the App and choose which of the account's repositories it may access.
  </Step>
</Steps>

## Why isn't a repository reviewed even though the App is installed?

Two things decide whether Rapid Review reviews a repository:

1. **The App's installation on GitHub includes the repository.** Rapid Review only sees the repositories the installation covers. You can change which repositories it covers on GitHub.
2. **Reviews are switched on for the repository in Rapid Review.**

A repository that isn't switched on gets no `rapid-review` check and no comments.

## How long does the app take to show a new installation?

After you install the App, or change its repositories on GitHub, the Rapid Review app can take up to five minutes to show the change. "Read again" at the bottom of the page reads the list from GitHub straight away.

## Which GitHub permissions does Rapid Review ask for?

The Rapid Review GitHub App asks for these repository permissions:

* **Checks: read and write**, to run the `rapid-review` check on each push.
* **Pull requests: read and write**, to read pull requests and to post the review, its inline comments, the summary comment, and replies and reactions in its own threads.
* **Contents: read and write**, to read the code under review and to resolve the threads of findings that a later push fixed. GitHub doesn't let an App resolve threads with read-only access.
* **Issues: read and write**, to read the issues a pull request links to, and to react to a review request in a pull request's conversation.
* **Metadata: read-only.**

## Which GitHub events does Rapid Review receive?

Rapid Review subscribes to GitHub's pull request, check run, pull request review, pull request review comment and issue comment events. They tell it when a pull request is opened, pushed to, reopened, marked ready, edited or closed, when its check is re-run, when someone replies in its review threads, and when someone asks for a review in a pull request's conversation.

## Can Rapid Review approve or block a pull request?

Rapid Review's review is a plain comment. It never approves a pull request or requests changes.

The `rapid-review` check can block merging only if your branch protection requires it. A red check then blocks merging until a re-run reviews the change.


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