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.
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
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, see Adding organizations.
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
- 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 never stores your code. 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
- Select a repository from your list
- Choose an existing pull request
- CodeRabbit will perform a code review on that pull request