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
Before you can use CodeRabbit with GitHub, you need to 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
After completing these steps, your browser will navigate to the CodeRabbit web interface. You’re now ready to configure repository access permissions.
Configure repository access
Even after you’ve integrated CodeRabbit with your GitHub account, you need to separately grant CodeRabbit the permissions needed to post code reviews and create pull requests in your repositories.You need to authorize CodeRabbit separately for each GitHub organization whose repositories you want it to work with. You can give CodeRabbit permission to work with all repositories in an organization, or limit access to a select list.
Required permissions
CodeRabbit requires the following permissions to work with your repositories: 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.
Grant repository permissions
1
Access repository settings
Visit the CodeRabbit web interface.
2
Select the correct organization
Ensure the correct GitHub organization is displayed at the top of the interface.
- To change organizations, click Change Organization and select from the list
- For personal repositories, select your account name as the organization
- If your organization doesn’t appear, you may need to refresh your organization list
3
Add repositories
Click the Add Repositories button. Your browser will navigate to GitHub.com.You’ll see either:
- A CodeRabbit permissions dialog (for new integrations)
- GitHub settings page for existing integrations (scroll to Repository access section)
4
Configure repository access
Choose your repository access level:All repositories: Grants access to all current and future repositories in the organizationOnly select repositories: Limits access to specific repositories you choose from the list
You can change this setting later if needed.
5
Complete the integration
Click the appropriate button at the bottom:
- Install & Authorize (for new organization integrations)
- Save (for existing integrations)