"""
GitHub Content Source for Knowledge
====================================
Load files and folders from GitHub repositories into your Knowledge base.
Supports both public and private repositories using fine-grained personal access tokens or GitHub App auth.
Features:
- Load single files or entire folders recursively
- Works with public repos (no token needed) or private repos (token required)
- Automatic file type detection and reader selection
- Rich metadata stored for each file (repo, branch, path)
Requirements:
- For private repos: GitHub fine-grained PAT with "Contents: read" permission
- For GitHub App auth: PyJWT with cryptography and a PEM private key
- `private_key` must start with `-----BEGIN RSA PRIVATE KEY-----` or `-----BEGIN PRIVATE KEY-----`
Usage:
1. Configure GitHubConfig with repo and optional token or GitHub App credentials
2. Register the config on Knowledge via content_sources
3. Use .file() or .folder() to create content references
4. Insert into knowledge with knowledge.insert()
Run this cookbook:
python cookbook/07_knowledge/cloud/github.py
"""
from os import getenv
from agno.knowledge.knowledge import Knowledge
from agno.knowledge.remote_content import GitHubConfig
from agno.vectordb.pgvector import PgVector
# Configure GitHub content source
# For private repos, set GITHUB_TOKEN env var to a fine-grained PAT with "Contents: read"
# For GitHub App auth, set GITHUB_APP_ID, GITHUB_INSTALLATION_ID, GITHUB_PRIVATE_KEY
github_config = GitHubConfig(
id="my-repo",
name="My Repository",
repo="private/repo", # Format: owner/repo
token=getenv("GITHUB_TOKEN"), # Optional for public repos
app_id=getenv("GITHUB_APP_ID"),
installation_id=getenv("GITHUB_INSTALLATION_ID"),
private_key=getenv("GITHUB_PRIVATE_KEY"),
branch="main", # Default branch
)
# Create Knowledge with GitHub as a content source
knowledge = Knowledge(
name="GitHub Knowledge",
vector_db=PgVector(
table_name="github_knowledge",
db_url="postgresql+psycopg://ai:ai@localhost:5532/ai",
),
content_sources=[github_config],
)
if __name__ == "__main__":
# Insert a single file
print("Inserting single file from GitHub...")
knowledge.insert(
name="README",
remote_content=github_config.file("README.md"),
)
# Insert an entire folder (recursive)
# Use trailing slash or just the folder name - both work
print("Inserting folder from GitHub...")
knowledge.insert(
name="Cookbook Examples",
remote_content=github_config.folder("cookbook/01_basics"),
)
# Insert from a different branch
print("Inserting from specific branch...")
knowledge.insert(
name="Dev Docs",
remote_content=github_config.file("docs/index.md", branch="dev"),
)
