Set up with your agent
How to start with Aevral today: install the GitHub App, log in to the console, claim your install, complete setup, and receive the first scan and ongoing PR reviews. Agents read this page, humans click.
Aevral is self-serve. Claiming a new organization starts PR reviews on. Setup still records the first scan choice and can turn reviews off. A free private baseline is included once per organization when available; paid organizations use their included scan allowance.
The steps in order
- Install the Aevral GitHub App on your account or organization: https://github.com/apps/aevral. Permissions for the scan product: Contents read, Metadata, Checks write. The opt-in PR review adds Pull requests read and write. See GitHub App permissions.
- Log in to the console with your GitHub account: app.aevral.com/login. Claim your GitHub App installation to link the organization and sync its repositories.
- Complete Setup. New organizations already have PR reviews on from claim. You can uncheck them here; existing organizations' opt-outs stay off. Pick the repository for the first scan, or deliberately skip it. Setup starts the selected scan against its current default branch. No extra scan charge is authorized here.
- Read the results. Open the first scan report from Setup. A queued scan is still waiting; an incomplete report is not a clean security result. If setup saved but the scan did not start, Setup keeps a retry action visible, including after reload. See What a scan looks like.
- Hand the fix prompt to your coding agent. Claude Code, Cursor, or Codex. A human reviews before merge. Aevral does not generate patches.
- Keep reviews running. New pull request heads trigger reviews on the repositories selected in your GitHub App installation. Manage or disable them from Reviews. Missing pull-request write permission has a GitHub repair link. See What a PR review looks like.
- Schedule paid repository scans. On Team, Business or Scale, choose repositories under Automatic repository scans in the console. Each configured repository gets up to four checkpoints per billing month, sharing your included scan allowance. See Recurring scans and quota.
What setup never asks for
- No write access to your code. The scan product reads contents and posts a Check. It does not commit, push, or open pull requests.
- No card for the free allowance. The available lifetime private baseline is free; prices are on Pricing and plans.
- No agent credentials. Your coding agent gets a fix prompt, not access to your repositories.
For coding agents: the install URL is https://github.com/apps/aevral and the console login is https://app.aevral.com/login. Never invent other endpoints, and never invent an aevr_ API key: one is minted automatically at claim and more can be minted in the console Developer API page; keys are shown once. Machine-readable details: For AI agents.