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

# Install Qodo single-tenant on GitHub

> Quickly install and configure the GitHub integration using the built-in installation wizard.

<Check>
  Qodo can be integrated with all versions of GitHub Cloud. GitHub Enterprise Server, and GitHub Enterprise Cloud.
</Check>

This guide walks you through installing and configuring Qodo single-tenant for GitHub. You can start with a single repository and later expand the integration to additional repositories or entire organizations as needed.

Assuming your Qodo environment is already set up, configuration typically takes about 5 minutes.

Once installed, Qodo automatically processes pull requests and delivers actionable insights, such as code reviews, directly within your PRs, bringing automated pull request intelligence into your GitHub workflow.

### Prerequisites

Before you begin, ensure you have:

* Access to your Qodo single-tenant portal
* Sufficient permissions to create GitHub applications

### Installation

#### Step 1: Access the GitHub integration

<Steps>
  <Step>
    Log in to your [Qodo portal.](https://app.qodo.ai/signin)
  </Step>

  <Step>
    From the left-hand navigation menu, select **Integrations**.
  </Step>

  <Step>
    Locate the **GitHub** integration card.
  </Step>

  <Step>
    Click **Add installation** to launch the automatic setup wizard.
  </Step>
</Steps>

The wizard will guide you through the required configuration steps.

#### Step 2: Organization details

<Steps>
  <Step>
    Enter the homepage URL of the GitHub organization or GitHub Enterprise instance you want to connect.
  </Step>

  <Step>
    Click **Next**.

    <Frame>
      <img src="https://mintcdn.com/qodo/8f9QSVoLIbSaCs56/images/code-review/github-wizard-org-details.png?fit=max&auto=format&n=8f9QSVoLIbSaCs56&q=85&s=3e0ff16f8f7edeacbe3d2ec6ae5fbc22" alt="GitHub integration wizard step showing organization homepage URL field" width="975" height="744" data-path="images/code-review/github-wizard-org-details.png" />
    </Frame>
  </Step>
</Steps>

#### Step 3: Install the GitHub App

The wizard will now guide you through creating and installing the Qodo GitHub App.

<Steps>
  <Step>
    Review the **Manifest**, which defines the configurations and permissions Qodo requires.
  </Step>

  <Step>
    Review the **Installation guide**. It consists of steps you will configure in GitHub, including naming your app and selecting which repositories Qodo can access.

    If you have questions about permissions or need adjustments, contact your **Qodo Account Manager** before proceeding.
  </Step>

  <Step>
    Click **Install GitHub App**.

    You will now be redirected to GitHub.
  </Step>
</Steps>

#### In GitHub

<Steps>
  <Step>
    Enter a name for the GitHub App (for example, your organization name + Qodo).
  </Step>

  <Step>
    Click **Create GitHub App for Codium-AI**.
  </Step>

  <Step>
    Select the GitHub user account to authorize the app.

    * If the displayed account is correct, click **Continue**.
    * Otherwise, sign in with a different account.
  </Step>

  <Step>
    Select which repositories Qodo can access:

    * All repositories (recommended)
    * Selected repositories only

    Repository-level review settings can later be managed from the Qodo portal.

    <Frame>
      <img src="https://mintcdn.com/qodo/8f9QSVoLIbSaCs56/images/code-review/github-app-install-permissions.png?fit=max&auto=format&n=8f9QSVoLIbSaCs56&q=85&s=953a83b097ad8086d5a5762adc6b74e3" alt="GitHub App installation page showing repository access permission options" width="1024" height="1317" data-path="images/code-review/github-app-install-permissions.png" />
    </Frame>
  </Step>

  <Step>
    Click **Install**. After installation, you will be redirected back to the Qodo Portal.

    * **Successful:** You’ll see a *“GitHub installation successful”* message.
    * **Not successful:** You’ll see a *“Something went wrong”* message. Click **Test Connection** to retry. If it fails again, contact your **Qodo Account Manager**.
  </Step>

  <Step>
    Click **Next**.
  </Step>
</Steps>

#### Step 5: Configure Qodo logo in PRs

To ensure Qodo appears consistently and is easy to recognize in pull requests:

<Steps>
  <Step>
    Click **Download logo** to download the official Qodo logo.
  </Step>

  <Step>
    Click the provided link to open the GitHub App settings page.
  </Step>

  <Step>
    In the GitHub settings, upload the Qodo logo as the app logo and **Save.** You are redirected back to the Qodo portal wizard.
  </Step>

  <Step>
    Click **Next**.

    <Frame>
      <img src="https://mintcdn.com/qodo/8f9QSVoLIbSaCs56/images/code-review/github-wizard-display-step.png?fit=max&auto=format&n=8f9QSVoLIbSaCs56&q=85&s=faaecd164b699d4e6a278ace0cf8b291" alt="GitHub integration wizard display configuration step with logo upload option" width="979" height="735" data-path="images/code-review/github-wizard-display-step.png" />
    </Frame>
  </Step>
</Steps>

#### Step 6: Enable Qodo review capabilities

<Steps>
  <Step>
    Review capabilities enabled.
  </Step>

  <Step>
    Click **Finish Installation**.

    <Frame>
      <img src="https://mintcdn.com/qodo/8f9QSVoLIbSaCs56/images/code-review/github-wizard-finish-installation.png?fit=max&auto=format&n=8f9QSVoLIbSaCs56&q=85&s=57f88b7b9722bca0ce67cf363d372b69" alt="GitHub integration wizard final step with Finish Installation button" width="997" height="733" data-path="images/code-review/github-wizard-finish-installation.png" />
    </Frame>

    You will be redirected back to the **Integrations** page, where the GitHub card will show the number of connected organizations.

    <Frame>
      <img src="https://mintcdn.com/qodo/8f9QSVoLIbSaCs56/images/code-review/github-integration-card-orgs.png?fit=max&auto=format&n=8f9QSVoLIbSaCs56&q=85&s=803e82380c353cc6048690479238eb63" alt="GitHub integration card in Qodo portal showing number of connected organizations" width="250" height="151" data-path="images/code-review/github-integration-card-orgs.png" />
    </Frame>
  </Step>
</Steps>

### Verify the installation

<Steps>
  <Step>
    Open a new pull request in the configured repositories and confirm that Qodo is triggered automatically.
  </Step>

  <Step>
    Add a comment to the pull request using one of the supported commands to verify two-way communication:

    * `/agentic_describe`
    * `/describe_review`
  </Step>
</Steps>
