GitHub

Guidelines to add and index your GitHub Knowledge Source

Indexing GitHub Knowledge Source

You can use GitHub as a knowledge source to index files from your repositories. This works for both public and private repositories.

Step 1: Add your first Knowledge Source

  • Navigate to AI > Knowledge Sourcesarrow-up-right from the left sidebar in the ClearFeed WebApp.

  • Select GitHub from the "Add Knowledge Source" dropdown menu in the top right corner.

  • Complete the configuration form in the side drawer:

    • Name: Enter a descriptive title for this Knowledge Source

    • Tags: These are identifiers linked with every Knowledge Source, aiding in categorization and structuring. (GitHub will be included by default)

    • Auto Reindex Regularly: Enable this option to automatically update the knowledge source every 24 hours

  • After saving your addition, the Knowledge Source will appear in the list.

Step 2: Upload/Connect GitHub Repository

  • Click the Upload/Connect button next to the GitHub knowledge source you just created.

Click Upload/Connect to link your GitHub repository
  • Follow the on-screen flow to authenticate with GitHub using a GitHub personal access token (PAT) and choose the repository you want ClearFeed to use as a knowledge source.

  • After connecting, the Knowledge Source will either start indexing immediately (reflected by an In Progress status) or will be picked soon (reflected with an Pending status). Get more details on Managing Knowledge Sources here.

  • Reindexing GitHub Repository - To reindex the GitHub repository, manually reindex the knowledge source by clicking the "Reindex" button next to it.

Using AI Agents

Once you've configured the knowledge sources, learn how to build and use AI Agents

screwdriver-wrenchBuild AI Agentschevron-rightrobotUse AI Agentschevron-right

Manage Knowledge Sources

Once the status of the knowledge source has been indexed, learn more on how to manage the knowledge source below.

Managechevron-right

Last updated