title:Integrating CodeRabbit with GitHub.com

title:Integrate with GitHub.com

description:Learn how to integrate CodeRabbit and add to your GitHub workflow.

sidebar_label:GitHub.com

sidebar_position:1

This is a step-by-step guide to integrate CodeRabbit with your GitHub repositories.

For an overview of how CodeRabbit integrates with Git platforms, see

[Add CodeRabbit to your repository](/platforms).

For a hands-on tutorial with CodeRabbit performing code reviews on a live

GitHub repository that you create, see[Quickstart](/getting-started/quickstart).

It preprocesses the PR content, builds context, leverages Large Language Models for analysis,andthen post-processes the AI response before posting the review back to GitHub. This streamlined workflow ensures thorough AI-powered code reviews without manual intervention.

You need to have a GitHub account,andownership-level permissions of at least one repository associated with that account.


If you want to authorizeCodeRabbitto write code reviews for a repository contained in a GitHub organization, then you need ownership-level permission with that organization, as well.

Before you can you use CodeRabbit with GitHub, you need to

authorize CodeRabbit with your GitHub account. To do this, follow these steps:

Visit the[CodeRabbit login](https://app.coderabbit.ai/login?free-trial) page. You'll see all the authentication options, select "**Login with GitHub**" to proceed.

1.Visit[the CodeRabbit login page](https://app.coderabbit.ai/login).


1. Click**Login with GitHub**. Your browser navigates to GitHub.com.

When you choose**Login with GitHub** in step1, you'll be prompted to authorize CodeRabbit.

1. GitHub displays a summary of the information that CodeRabbit needs in order to integrate with your

GitHub account. This includes read-only access to the following:

Upon Authorization, Ifyou're part of multiple organizations, you'll have the opportunitytochoose which one you want to associate withCodeRabbit. This ensures that you're setting up the tool for the correct team or project.

Afteryou complete these steps, your browser navigatestotheCodeRabbit web interface.


Now that you've integrated CodeRabbit with your GitHub account, you need to giveCodeRabbit additional permissions to work with your code repositories. To do this, see the next section.

Upon successful authorization, you'll be logged into the CodeRabbit user interface.

Even after you've integrated CodeRabbit with your GitHub account, you need to

separately grant CodeRabbit the permissions that it needs to post code reviews and

create pull requests in your repositories.

Here, you can add repositories and configure CodeRabbit config settings for each repository.

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 of the repositories associated with a GitHub organization, or limit its access to a select list.

If you opt to authorize all repositories during setup, CodeRabbit will automatically include any new repositories you create on GitHub in the future. This saves you the hassle of manual additions down the line.

CodeRabbit requires the following permissions to work with your repositories:

You can configure CodeRabbit through a YAML file or using the[App's UI](https://app.coderabbit.ai/login?free-trial).

- Read-and-write access to code, commit statuses, issues, and pull requests.

You can tailorCodeRabbit's functionality using the`.coderabbit.yaml` file, which you place directly inyourGitHubrepository. This file mirrors the options available in the CodeRabbit user interface, with each setting in the YAML correspondingtoa specific toggle in the UI. ConfigureCodeRabbiteither through the coderabbit.yaml file or the interface, depending on your preference.

CodeRabbit requests read and write access toyour repository in order for its code review, issue management, and pull request generation featurestowork.CodeRabbitnever stores your code. For more information, see[the CodeRabbit Trust Center](https://trust.coderabbit.ai).

If a`.coderabbit.yaml` file exists in your GitHub repository, it takes precedence over any UI settings. Choose either the YAML fileorUI configuration - you don't need to use both.**Refer CodeRabbit YAML schema[here](https://storage.googleapis.com/coderabbit_public_assets/schema.v2.json)**

To give CodeRabbit access to oneormore of your repositories, follow these steps:

Once your`.coderabbit.yaml` file is prepared according to your needs, simply place it in your GitHub repository, and you're all set — CodeRabbit is now integrated.

1. Make sure that the correct GitHub organization for the repository is displayed

at the top of the web interface. To change the organization, click**Change

Organization** and select a different organization from the list.

Iftherepositories that you want to add are associated directly with your GitHub account,andnot aseparate organization, then select your account name astheorganization.

Let's see a few examples of CodeRabbit's review comments from a specific pull request in one of the projects.

If the organization containing the repository doesn't appear in the list, then you might

need to refresh the list of organizations that CodeRabbit has associated with your

GitHub account. For more information, see[Add organizations](/getting-started/adding-organizations).

This particular PR involved in changingthelanguage model from LLaMA 2 to LLaMA 3, for testing purposes. These examples will showcase how CodeRabbit analyzed and commented on this significant model switch.

1. Clickthe**Add Repositories** button. Your browser navigates to GitHub.com.

If the selected organization has no repositories registered withCodeRabbit, then your browser displays a CodeRabbit permissions dialog for setting up a new integration. Proceed to the next step.

CodeRabbit automatically generates a PR summary highlighting key changes.

Otherwise, your browser displays a GitHub settings page for your organization's existing CodeRabbit integration. Scroll down to the section titled**Repository access**, and then proceed to the next step.


1. Select which repositories you'd like to allowCodeRabbitto write code reviews for.

This image shows CodeRabbit's review status for another pull request. It highlights that**12 actionable comments** were generated, and the reviewalsoincludes additional comments on specific files, demonstrating CodeRabbit's comprehensive analysis ofthecode changes.

To give CodeRabbit access to all repositories in the organization, select**All repositories**. Thisalsoautomatically grants CodeRabbit access to all repositories added to the organization inthefuture.


To giveCodeRabbit access to specific, limited list of repositories, select**Only select repositories**, and then choose repositories from the list.

You can also use[CodeRabbit commands](https://docs.coderabbit.ai/guides/commands/) to chat with the AI code Reviewer.

You can change this setting later.

:::

CodeRabbit could generate a**code sequence diagram** when you request a full review.

-**Install & Authorize**, if this organization has no repositories integrated with CodeRabbit, and you are an owner of this organization.

-**Save**, if this organization already has repositories integrated with CodeRabbit

The sequence diagram illustrates the precise flow of interactions between theobjects inthesystem.

1. If you are integrating an organization with CodeRabbit for thefirst time, then your browser navigates back totheCodeRabbit web interface.


Otherwise, your browser remains on your GitHub settings page, and you can manually navigate[back to theCodeRabbitweb interface](https://app.coderabbit.ai/settings/repositories).

In addition to providing reviews and summaries,**CodeRabbit** can also detect configuration issues.

CodeRabbit automatically detects and alerts you about configuration conflicts.


CodeRabbit generates detailed statistics and test plans for each pull request.



Whether you manage a popular repository or are working on a smaller project, whether it's hosted on**GitLab, GitHub, or self-hosted GitHub or GitLab**, CodeRabbit can help streamline your development process. This AI Code Review assistant is designed to save you time by automating code reviews and offering insightful feedback.

-[Review pull requests](/guides/code-review-overview)

title:Integrate with Git platforms

description:Overviewof CodeRabbit's supportedGitplatforms.

title:Add CodeRabbit to your repository

description:Conceptual overviewofintegratingCodeRabbit with yourGitplatform

CodeRabbit supports various Git platforms to provide code review for your repositories. For the cloud-hosted Git platforms, you can[login][login] to CodeRabbit and add your repositories. The following platforms are supported:

This page presents an overview of integrating CodeRabbit with your Git platform.

For a conceptual overview of CodeRabbit, see[Introduction](/).

| Host| Support|

| ------------------------| ----------------------------------------|

| GitHub.com|[Supported](github-com.md)|

| GitHub Enterprise Server|[Supported](github-enterprise-server.md)|

CodeRabbit integrates with the following Git platforms:

-[GitHub.com](/platforms/github-com)

-[GitHub Enterprise Server](/platforms/github-enterprise-server)

-[GitLab.com](/platforms/gitlab-com)

-[Self-managed GitLab](/platforms/self-hosted-gitlab)

-[Azure DevOps](/platforms/azure-devops)

-[BitBucket Cloud](/platforms/bitbucket-cloud)

| Host| Support|

| -------------------| ----------------------------------|

| GitLab.com|[Supported](gitlab-com.mdx)|

| GitLab Self Managed|[Supported](self-hosted-gitlab.md)|

The exact steps for each platform are outlined in the pages linked above. That said, integrating any

Git platform with CodeRabbit follows this general pattern:

| Host| Support|

| ------------| ----------------------------|

| Azure DevOps|[Supported](azure-devops.md)|

1. Add the organizations containing the repositories that you want CodeRabbit to work with. You generally need ownership-level permissions with these organizations. (Different Git platforms might call their organizations different

things, such as "groups" in GitLab and "workspaces" in BitBucket.)

1. Create a dedicated CodeRabbit service account on your Git platform, if needed. We handle

this step for you on some platforms, such as GitHub.com.

| Host| Support|

| --------------------| ----------------------------------------|

| Bitbucket Datacenter|[Supported](../self-hosted/bitbucket.md)|

| Bitbucket Cloud|[Supported](./bitbucket-cloud.md)|

1. Grant CodeRabbit the permissions that it needs to work with one or more

of the repositories that you have ownership-level access to.

[login]:https://app.coderabbit.ai/login?free-trial

After you finish integrating CodeRabbit with one or more repositories, you can[start using CodeRabbit immediately](/guides/code-review-overview) using its default configuration, which automatically reviews or summarizes new pull requests. You can also[customize CodeRabbit’s configuration](/guides/configuration-overview) to suit your team's needs.

-[Integrate CodeRabbit with GitHub.com](/platforms/github-com)

-[Integrate CodeRabbit with GitHub Enterprise Server](/platforms/github-enterprise-server)

-[Integrate CodeRabbit with GitLab.com](/platforms/gitlab-com)

-[Integrate CodeRabbit with Self-managed GitLab](/platforms/self-hosted-gitlab)

-[Integrate CodeRabbit with Azure DevOps](/platforms/azure-devops)

-[Integrate CodeRabbit with BitBucket Cloud](/platforms/bitbucket-cloud)