Documentation
Getting started
From one URL to your first prioritized plan, in four steps.
Last updated: 2026-11-05·By Kestralia editorial team
1. Preview audit
Enter your URL on the audit page. Up to 10 public HTML pages are crawled with robots.txt respected. The preview includes Search Health, the top findings and a detected profile.
2. Create a workspace
Signing up creates a workspace and a project. The free plan is enough to start: 1 project, 10 pages per crawl.
3. Full audit and plan
Press Run audit. The engine crawls, stores findings with evidence, scores them, clusters keywords and generates AI monitoring prompts.
4. Execute and verify
Fix findings, produce content, then re-crawl. A fixed finding must disappear in the next crawl; that is the only real measure of success.
Implementation status
This table reflects actual state, not intentions:
| Capability | Status | Note |
|---|---|---|
| Safe crawler and SEO analysis | Implemented and tested | 38 finding types |
| Transparent scoring | Implemented | v1.0.0 |
| GEO readiness | Implemented | 9 weighted checks |
| Direct AI measurement | Needs authorized key | Gemini / OpenAI / Perplexity |
| Keywords and clusters | Implemented | No invented volume |
| Content generation | Implemented | Deterministic + optional AI |
| CMS publishing | Implemented (WordPress/Shopify/REST) | Requires customer credentials |
| Billing | Mock + Stripe adapter | Requires Stripe keys |
| Google Search Console | Adapter, no client keys | Server config needed |
Local setup
Requires Node.js 20+ and SQLite (bundled with the OS).
npm install
cp .env.example .env # generate AUTH_SECRET and ENCRYPTION_KEY
npx prisma migrate deploy
npm run dev # web on :3000
npm run worker # background jobs (optional second terminal)For PostgreSQL, see DATABASE.md in the repository root.