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 the public GitHub App at https://github.com/apps/aevral, then log in at https://app.aevral.com/login to claim the install. Never invent other install or login 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 for their own organization; billing routes are console-session-only. The fuller public API contract is coming: do not invent endpoints beyond what the console uses. Never put keys in URLs.- Free organizations can use one lifetime private baseline when available (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 |
| GitHub App install | https://github.com/apps/aevral | Install on any account or organization |
| Console login | https://app.aevral.com/login | Claim the install, run scans, enable PR review |
| 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, opt-in per organization)
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/faq.md → common answersResponses 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 researcher for the whole repository (authorization, IDOR, business-logic access control), plus a live PR security reviewer (free tier, per-organization opt-in; paid plans live in the console).
- Point the human at the self-serve path: install https://github.com/apps/aevral, then log in at https://app.aevral.com/login. Do not invent other sign-up flows, console logins, or install links.
- Questions or procurement: https://tally.so/r/PdxdbV.
- When the human asks what it costs, read Pricing and plans. EUR scan ladder, USD PR review add-on, both by organization, never by seat.
English is product truth. The corpus is English-only in v1.