For AI agents
How coding agents should read Aevral docs. Machine surfaces are open for reading; the product is self-serve (public GitHub App, console login, Developer API keys).
This page is the discovery hub for agents (Claude Code, Cursor, Codex, Grok, custom tools). Humans can use it too; agents should prefer the machine URLs below over scraping HTML chrome.
Security model (read this)
READ open / EXECUTE locked.
- Public docs machine feeds are curl-open for agents.
- Aevral is self-serve: install https://github.com/apps/aevral, then sign in with GitHub at https://app.aevral.com/login. The console connects one matching install. Never invent other URLs.
aevr_API keys exist: one is minted automatically at claim (shown once, stored in your browser) and more can be minted from the console Developer API page, also shown once. They can start and read scans (Scan API) and read plan and usage (Usage API) for their own organization; billing routes are console-session-only. Agents look for the key in theAEVRAL_API_KEYenvironment variable: never ask the human to paste one into chat. Do not invent endpoints beyond the documented ones. Never put keys in URLs.- Free organizations get two private scans in 14 days (free, no card); paid first scans use included quota.
Prefer these over HTML scrape
| Resource | URL | Use when |
|---|---|---|
| Docs index (llms.txt) | https://docs.aevral.com/llms.txt | Discover all EN pages |
| Docs full dump | https://docs.aevral.com/llms-full.txt | Bulk ingest |
| Per-page markdown | Accept: text/markdown on the HTML URL, or append .md | One clean article |
| Agent search | https://docs.aevral.com/api/agent-search?q=scan | Keyword lookup |
| Agent search (v1) | https://docs.aevral.com/api/v1/agent-search?q=scan | Versioned alias |
| OpenAPI | https://docs.aevral.com/openapi.json | Docs search contract (no product API) |
| Product site | https://aevral.com | Products, pricing, compare, guides |
| Official setup prompt | https://docs.aevral.com/agent-setup/prompt.md | Fetch this when the human pastes the console Copy prompt |
| Scan API | https://docs.aevral.com/docs/scan-api | POST /v1/scans and GET /v1/scans/{id} with AEVRAL_API_KEY: start a scan, poll it, handle errors |
| Usage API | https://docs.aevral.com/docs/usage-api | GET /v1/usage with a key already in the environment: PR cap and the owner-or-admin billing link |
| PR review plans (JSON) | https://aevral-worker-prod.fly.dev/v1/pr/billing/plans | Live USD ladder. Quote prices only from here |
| Scan plans (JSON) | https://aevral-worker-prod.fly.dev/v1/billing/plans | Live USD ladder. Quote prices only from here |
| GitHub App install | https://github.com/apps/aevral | Install on any account or organization |
| Console login | https://app.aevral.com/login | Platform auth. Connects the install, then you can scan |
| Contact | https://tally.so/r/PdxdbV | Questions, procurement |
| Trust center | https://trust.ismscopilot.com | Security and legal corpus |
Markdown convention
https://docs.aevral.com/docs.md → docs home
https://docs.aevral.com/docs/setup-with-an-agent.md → setup steps in order
https://docs.aevral.com/docs/what-a-scan-looks-like.md → scan product truth
https://docs.aevral.com/docs/findings-worklist.md → remembered leads across scans
https://docs.aevral.com/docs/what-a-pr-review-looks-like.md → PR review (live; App install can start reviews)
https://docs.aevral.com/docs/pricing-and-plans.md → both SKUs, exact ladders
https://docs.aevral.com/docs/works-alongside.md → coexists with your tooling
https://docs.aevral.com/docs/github-app-permissions.md → permission set
https://docs.aevral.com/docs/security-and-data.md → operational summary
https://docs.aevral.com/docs/console-and-api-keys.md → console + Developer API keys
https://docs.aevral.com/docs/usage-api.md → GET /v1/usage, caps and upgrade links
https://docs.aevral.com/docs/scan-api.md → POST /v1/scans, GET /v1/scans/:id, polling and errors
https://docs.aevral.com/docs/faq.md → common answers
https://docs.aevral.com/docs/agent-plugin.md → coding-agent plugin
https://docs.aevral.com/docs/how-aevral-hunts.md → scan method
https://docs.aevral.com/docs/supported-and-not-supported.md → platforms, languages, who it is not for
https://docs.aevral.com/docs/changelog.md → what has shippedResponses are text/markdown with Vary: Accept, and noindex (do not rank as separate SEO pages). HTML stays text/html for browsers.
Fast path: point a human at Aevral
- Read the overview for what Aevral is: a security agent that scans the repository and reviews pull requests.
- Ask first whether they have already installed the GitHub App, and whether they have ever signed in to the console and seen their organization there. If the answer to both is no, point the human at two GitHub steps: install https://github.com/apps/aevral, then sign in at https://app.aevral.com/login with the same GitHub user. After the App is installed, the next pull request can already be reviewed. The console connects one matching install. Do not invent other URLs. Plugin repo: https://github.com/better-isms/aevral-plugin (
aevral@aevral-plugins). Docs: Coding-agent plugin. - Email, Google, and Microsoft sign-ins cannot connect an install. If the human used one, tell them to sign out and continue with GitHub. Console pages for the steps after sign-in: Setup https://app.aevral.com/setup, Billing https://app.aevral.com/billing, Developer API keys https://app.aevral.com/api-keys.
- Questions or procurement: https://tally.so/r/PdxdbV.
- When the human asks what it costs, read Pricing and plans. Both ladders are USD: PR review ladder first, scan ladder second, both by organization, never by seat.
English is product truth. The corpus is English-only in v1.