Index integration for GitHub

Connect your GitHub account to Index using a Personal Access Token

Overview

Index supports connecting to GitHub via a Personal Access Token (PAT). Once connected, Index can access your repositories to enable codebase-related features.

Generating a Personal Access Token

To connect GitHub, you will need a Personal Access Token:

  1. Go to github.com/settings/tokens
  2. Click Generate new token (classic)
  3. Give the token a descriptive name (e.g. "Index")
  4. Select the repo scope (full control of private repositories)
  5. Click Generate token
  6. Copy the token — you will not be able to see it again

Set up

To connect GitHub in Index:

  1. Go to Settings via the top left of the Index app
  2. Select Codebase from the sidebar
  3. Click on GitHub
  4. Paste your Personal Access Token into the token field
  5. Click Save

Once saved, a green checkmark will appear confirming the connection is active.

Disconnecting

To disconnect the GitHub integration:

  1. Go to Settings > Codebase > GitHub
  2. Click Disconnect

This will remove the stored token. You can reconnect at any time by entering a new token.

Troubleshooting

  • Token not saving: Ensure the token starts with ghp_ (classic tokens) or github_pat_ (fine-grained tokens) and has the required repo scope.
  • Permission errors: Verify that the token has not expired and that the repo scope is selected.
  • Need to rotate a token: Disconnect the existing integration and reconnect with a new token.