IntroductionQuick Start
Install on GitHub
To install Burg AI on your GitHub repositories, follow these steps:
Step 1: Install the GitHub App
- Go to the Burg AI GitHub App page.
- Click Install.
- Choose where to install the app:
- Organization — Install for all or selected org repos.
- Personal account — Install for your personal repositories.
Step 2: Select Repositories
You can choose to enable Burg AI on:
- All repositories — Current and future repos.
- Only select repositories — Pick specific repos.
Step 3: Authorize Permissions
The app requires these GitHub permissions:
| Permission | Access Level | Why It's Needed |
|---|---|---|
| Contents | Read | To analyze PR diffs and file changes |
| Pull requests | Read & Write | To receive PR events and post review comments |
| Issues | Read | To access PR discussion context |
| Metadata | Read | Basic repository access (required for all GitHub apps) |
Step 4: Add Your API Key
After installing the app:
- Log in to the Burg AI Dashboard .
- Go to Settings → API Keys.
- Add your LLM provider API key:
- OpenAI
- Anthropic
- OpenRouter
- Google Gemini
Your key is encrypted and only used when processing your PRs. You can delete your key at any time.
What Happens After Install
Once the app is installed:
- Burg AI listens for PR events on enabled repositories.
- When a PR is opened or updated, a review job is queued.
- Reviews are posted as inline comments on the PR.
Org vs Personal Install
| Aspect | Organization | Personal |
|---|---|---|
| Scope | All org repos (or selected) | Your personal repos only |
| Admin required | Yes, for org-wide install | No |
| Billing | Personal account (org billing coming soon) | Personal account |