GitHub

Guidelines to add and index your GitHub Knowledge Source

You can use GitHub as a Knowledge Source to index files from public or private repositories. ClearFeed uses the GitHub App connected to your account, so you do not need to provide a personal access token while adding the Knowledge Source.

Prerequisite: Connect GitHub for Knowledge Sources

Before adding a GitHub Knowledge Source, connect GitHub from Account Settings > Integrations > GitHub.

When connecting GitHub, choose Issues + Knowledge Source. This lets ClearFeed create and sync GitHub issues, and read the selected repositories for Knowledge Sources.

You may need a GitHub organization admin to approve or install the ClearFeed GitHub App. During installation, you can grant ClearFeed access to all repositories or only selected repositories.

For the full GitHub integration setup, see GitHub integration.

Add a GitHub Knowledge Source

1. Navigate to AI > Knowledge Sources from the left sidebar in the ClearFeed WebApp.

2. Click Add Knowledge Source and select GitHub.

3. Complete the configuration form:

   • Name: Enter a descriptive title for this Knowledge Source.

   • Tags: Add tags to categorize the source. GitHub is included by default.

   • Auto Reindex Regularly: Enable this option to automatically update the Knowledge Source every 24 hours.

   • Repository: Select the GitHub repository you want ClearFeed to index. If the repository isn't listed, paste its full URL, such as https://github.com/org/repository. The URL must belong to the connected GitHub organization, and the GitHub App must have access to the repository.

   • Folder Path: Optionally enter a folder path to index only a specific folder inside the repository. Leave this blank to index the whole repository.

4. Click Add.

After the Knowledge Source is added, ClearFeed starts indexing the configured repository. The status may show In Progress while indexing is running, or Initiated if it is queued.

If the GitHub App is not connected with Knowledge Source permissions, ClearFeed shows an Extended GitHub App Not Connected message while adding the source. Use Open Integrations from that message, reconnect GitHub with Issues + Knowledge Source, and then return to add the Knowledge Source.

Edit or reindex a GitHub Knowledge Source

You can edit an existing GitHub Knowledge Source to change the repository or folder path. Changing either value triggers ClearFeed to reindex the source using the updated configuration.

To manually reindex a GitHub Knowledge Source, click Reindex next to it. Get more details on managing Knowledge Sources here.

Using AI Agents

Once you've configured the Knowledge Source, learn how to build and use AI Agents.

Build AI AgentsUse AI Agents

Migrating a deprecated GitHub Knowledge Source to new Knowledge Source

If you have an older GitHub Knowledge Source, recreate it using the steps above to move it to ClearFeed's newer GitHub indexing.

Before recreating the Knowledge Source, verify that your GitHub integration is connected with Issues + Knowledge Source permissions. Go to Account Settings > Integrations > GitHub and choose Issues + Knowledge Source when reconnecting.

Once the new GitHub Knowledge Source has been created and indexed successfully, you can delete the old GitHub Knowledge Source. Deleting the old Knowledge Source only removes it from ClearFeed; it does not delete content from GitHub.