CodeRabbit Documentation - AI code reviews on pull requests, IDE, and CLI
Skip to main content
For an overview of how CodeRabbit integrates with Git platforms, see Add CodeRabbit to your repository.For a hands-on tutorial with CodeRabbit performing code reviews on a live GitHub repository that you create, see Quickstart.GitHub Enterprise Cloud users on *.ghe.com should use the Self-Hosted GitHub guide.

​
Prerequisites

Required permissionsYou need to have a GitHub account with owner-level permissions for at least one repository associated with that account.If you want to authorize CodeRabbit for repositories in a GitHub organization, you need organization owner permissions as well.

​
Authorize CodeRabbit with your GitHub account

1

Visit CodeRabbit login page

Navigate to the CodeRabbit login page.
2

Initiate GitHub login

Click Login with GitHub. Your browser will redirect to GitHub.com.
3

Sign in to GitHub (if required)

If GitHub prompts you to sign in, enter your GitHub login credentials as you normally would.
4

Review and authorize permissions

GitHub displays a summary of the information that CodeRabbit needs to integrate with your account. This includes read-only access to:
  • Organizations and teams associated with your GitHub account
  • Email addresses associated with your GitHub account
Click Authorize coderabbitai to grant these permissions.
5

Select an organization

Choose the organization where you want to install CodeRabbit.
  • If you belong to multiple organizations, select from the list
  • For personal repositories, select your account name
If your organization doesn’t appear in the list, add it from the organization switcher. If you select an organization with no repositories connected yet, CodeRabbit guides you through Grant GitHub bot access and Select repositories. See Adding organizations for details.
6

Install and authorize CodeRabbit

Configure repository access and review the permissions CodeRabbit needs.

​
Choose repository access

Select which repositories CodeRabbit can access:All repositories: Grants access to all current and future repositories owned by this organization, including public repositories.Only select repositories: Limits access to specific repositories you choose from the list.
You can change this setting later if needed.

​
Review permissions

CodeRabbit requires the following permissions to perform code reviews and manage pull requests:Read-only access:
  • Actions, checks, discussions, members, and metadata
Read-and-write access:
  • Code, commit statuses, issues, and pull requests
CodeRabbit requests read and write access to your repository for its code review, issue management, and pull request generation features to work. CodeRabbit does not retain your source code after review, except when review caching is enabled to speed up future reviews. For more information, see the CodeRabbit Trust Center.

​
Complete installation

Click Install & Authorize (for new integrations) or Save (for existing integrations).
7

Trigger your first review (optional)

After installation, you can immediately see CodeRabbit in action or skip to configure settings first.Option 1: Trigger a review
  1. Select a repository from your list
  2. Choose an existing pull request
  3. CodeRabbit will perform a code review on that pull request
Option 2: Skip to dashboardClick Skip to App to access the CodeRabbit dashboard and configure settings before your first review.

​
Troubleshooting

When you switch to a GitHub organization that is blocked by its IP allow list, CodeRabbit keeps you in your previous organization. The error identifies the blocked organization and its GitHub IP allow list.Access can be blocked for one or both of these reasons: one or more CodeRabbit egress IP addresses are missing from the organization’s allow list, or CodeRabbit is experiencing a connectivity or routing problem. Verify that all documented CodeRabbit egress IP addresses are allowed.IP allow list configuration:
  1. Ask a GitHub organization owner to open the organization’s IP allow list settings.
  2. Add CodeRabbit’s outbound IP addresses:
  1. Save the policy changes, then switch to the organization again in CodeRabbit.
If CodeRabbit detects intermittent access, it sends an action-required email with the subject “CodeRabbit is intermittently unable to access your GitHub organization” and the action “Review IP allowlist”. Once access is consistently restored, CodeRabbit automatically sends a recovery email with the subject “CodeRabbit can access your GitHub organization again”. This email confirms that no further action is required.
If the organization remains blocked after updating its IP allow list, contact our support team.