Knowledge Base
GitHub
Index GitHub repositories, documentation folders, READMEs, and source code with automatic webhook sync.
Overview
The GitHub Integration connects your public or private repositories directly to Asiyst. Whenever your engineering team merges a pull request updating documentation or code schemas, the knowledge base updates automatically.
Connecting GitHub Repositories
- In the Asiyst dashboard, go to Knowledge > Sources > Add Source > GitHub.
- Click Install GitHub App and select the GitHub organization or user account.
- Choose the repositories you want to grant Asiyst read access to.
- Select the target repository and default branch (e.g.,
main).
Repository Path Filters & Branch Selection
You can restrict indexing to specific documentation folders or file patterns:
- Target Folder:
docs/orcontent/
- File Inclusions:
*.md,*.mdx,openapi.json,schema.graphql
- Exclude:
node_modules/,test/,*.spec.ts
Real-Time Webhook Synchronization
The Asiyst GitHub App registers a webhook listener for push and release events:
- When code is pushed to your default branch, Asiyst calculates file diffs.
- Only added or modified files are re-embedded, keeping token usage minimal.
- Deleted files have their vector chunks purged from the index within 30 seconds.
Security & Private Repo Access
- Asiyst requests strictly read-only access to repository contents.
- Repository source code is never cached in raw text; it is stored only as mathematical vector embeddings in encrypted databases.