GitHub

To enable Qodo Aware to index your repositories, you’ll need to create and configure a GitHub App.

Important Note:

These steps must be completed by a GitHub organization administrator.

1. GitHub App Setup

1. Go to your GitHub Organization Settings

   • Click your profile picture on the top right, then choose Your Organizations.

   • Select your organization then go to Settings.

2. Navigate to GitHub Apps

   • In the left sidebar, click Developer settings → GitHub Apps

   • Click New GitHub App.

3. Configure a new GitHub App

   • Fill in the following details:

     • GitHub App name: Qodo RAG Indexer

     • Homepage URL: https://qodo.ai

     • Webhook: leave unchecked

     • Repository Permissions: grant read only access to the Contents permission

     • Under Where can this GitHub App be installed? select Any Account

4. Click Create GitHub App.

5. Save the generated App ID for later.

---

2. Install GitHub App

1. Generate a private key and store it somewhere safe.

2. Go to the GitHub App you've setup before, and click Install App.

3. Choose the relevant organization.

4. When prompted to select repositories:

   • Select only the repositories that should be indexed

   • Do not choose “All repositories”

5. Click Install.

6. Note the installation ID from the URL.

   • For example, in https://github.com/organizations/YOUR_ORG/settings/installations/2, the installation ID is 2.

---

3. Send relevant information to Qodo

After the setup, share the following credentials with the Qodo team:

[github_app]
private_key="""\
... private key goes here...
PRIVATE_KEY
"""
app_id = ""
installation_id = ""