Warpway documentation
Warpway reviews every eligible pull request through configurable lenses, resolves what AI can, and turns what is left into specific questions for the right people. These docs cover installing it, how a review works, every configuration option, and how your data is handled.
Get started
- Getting startedInstall the GitHub App, pick repositories, and see your first Warpway review on a pull request.
- GitHub installationInstall the Warpway GitHub App on an organization or account, choose repositories, and change them later.
- GitHub permissionsEvery permission and webhook event the Warpway GitHub App uses, and why.
- Slack installationConnect Slack so Warpway can ask subject-matter experts questions in a direct message.
How Warpway works
- How reviews workThe life of a Warpway review: from webhook to plan, lenses, evidence, human tasks, policy and the GitHub check.
- LensesThe eight built-in lenses, the four states every lens ends in, and how to write custom lenses.
- Human tasksHow unresolved questions become bounded tasks, how answers are checked, and what happens next.
- RoutingHow Warpway picks the person to ask, explains why, and reroutes when it picked wrong.
- Trust levelsObserve, Assist, Gate, Clear and Auto-approve: what each level allows and who can change it.
Configure
- Configuration as codeThe complete .warpway.yml reference, the base-branch rule, and organization locks.
- Merge gatingMake Warpway / Review a required check and understand every conclusion it can report.
- Runtime verificationLet Warpway run approved test profiles in your own GitHub Actions and use the results as evidence.
- Auto-approvalThe deterministic conditions Warpway checks before it may approve a pull request, and how to enable it.
Security and data
- SecurityHow Warpway protects tokens, tenants, webhooks and reviews, including prompt-injection defenses.
- Data handlingWhat Warpway stores, for how long, what it sends to Slack and to the model provider, and how deletion works.
- Model providersWhich models review your code, what they receive, and why your code is not used for training.
Account
- BillingPlans, the Team trial, usage limits, seats, and what changes when you upgrade, downgrade or cancel.
- Uninstall and deletionRemove repositories, disconnect Slack, uninstall the GitHub App and delete your organization’s data.
- TroubleshootingFixes for missing checks, configuration errors, incomplete lenses, Slack delivery and auto-approval.
Can’t find what you need? Email marcus@cmglabs.ai.