GitHub
The GitHub integration lets Qodex understand your repository and participate in pull request review. After you install the Qodex GitHub App and link a repo to a project, Qodex can inspect code, run PR review workflows, post inline findings, publish Check Runs, and sync generated tests when you choose to send them back.What Qodex can do with GitHub
| Capability | What it means |
|---|---|
| Read repository code | Qodex can clone and analyze linked repos so reviews and tests have project context. |
| Review pull requests | Qodex can post a walkthrough comment, inline findings, and a Check Run. |
| Route one repo to projects | A GitHub install can be granted to more than one Qodex project. |
| Sync tests | Generated scripts can be pushed through the opt-in Sync to GitHub flow. |
How setup works
1. Install the GitHub App
Install the Qodex GitHub App on the account or organization that owns your repo. Choose the repositories Qodex is allowed to access. Qodex uses short-lived GitHub App installation tokens, not a personal access token.2. Link a repo to your Qodex project
In Qodex, open Settings > Integrations > GitHub and choose a repo from the picker. The project can link up to 10 repos. Repos larger than 500 MB are rejected at link time.3. Let Qodex analyze the repo
After linking, Qodex starts a background analysis job. It reads the repo, discovers routes and project structure, and seeds project memory so later agent work has useful context. You can manually refresh a linked repo later. Refreshes are rate-limited to avoid repeatedly cloning the same repo.Pull request review
When PR review is enabled, Qodex reacts to PR activity through GitHub webhooks. For each tracked PR, Qodex can:- Read the PR diff and relevant surrounding code.
- Post a walkthrough comment.
- Add inline findings where the issue appears.
- Run verification probes when needed.
- Publish a Check Run that can be used for merge gating.
Install the GitHub App
First-time install for an account or organization.
How a review fires
See the webhook-to-review lifecycle.
Check Run and merge gating
Use review status in your PR rules.
Limits and caveats
Understand diff limits, costs, drafts, and opt-out behavior.
Permissions
The GitHub App requests the permissions needed for review:| Permission | Why Qodex needs it |
|---|---|
| Contents read | Clone and inspect files. |
| Metadata read | List and identify repositories. |
| Pull requests write | Post PR comments and inline findings. |
| Checks write | Publish Check Runs. |
Next steps
PR review overview
Learn the full PR review workflow.
Sync tests to GitHub
Send generated tests back into your repo.
.qodex.yaml reference
Configure repo-level PR review behavior.
Integrations
Return to all integrations.