@ainyc/aeo-audit
v1.3.2
Published
The most comprehensive open-source Answer Engine Optimization (AEO) audit tool. Scores websites across 13 ranking factors that determine AI citation.
Maintainers
Readme
@ainyc/aeo-audit
The most comprehensive open-source Answer Engine Optimization (AEO) audit tool. Scores any website across 13 ranking factors that determine whether AI answer engines — ChatGPT, Perplexity, Gemini, Claude — will cite your content.
Website: ainyc.ai
Quick Start
npx @ainyc/aeo-audit https://example.comLocal Development
pnpm install
pnpm run typecheck
pnpm run build
pnpm run test
pnpm run lint
# Smoke test the compiled CLI from this repo
node bin/aeo-audit.js https://example.com --format jsonThe package source lives in src/*.ts and publishes compiled ESM plus declarations from dist/.
Why AEO?
AI answer engines are replacing traditional search for millions of queries. Getting cited by ChatGPT or Perplexity requires different signals than ranking in Google:
- Structured data (JSON-LD) with FAQPage schema shows 2.7x higher citation rates
- llms.txt files help AI systems understand your site at a glance
- E-E-A-T signals (author credentials, trust pages) determine citation trustworthiness
- Content extractability — clean, well-structured content gets cited; paywalled content doesn't
13 Scoring Factors
| Factor | Weight | What It Checks | |--------|--------|---------------| | Structured Data (JSON-LD) | 12% | Presence of LocalBusiness, FAQPage, Service, HowTo schemas | | Content Depth | 10% | Word count, heading hierarchy, paragraph structure, lists | | AI-Readable Content | 10% | llms.txt, llms-full.txt, robots.txt, sitemap.xml availability | | E-E-A-T Signals | 8% | Author meta, Person schema credentials, trust pages, reviews | | FAQ Content | 8% | FAQPage schema, details/summary blocks, question-style headings | | Citations & Authority | 8% | External links, authoritative domains, sameAs references | | Schema Completeness | 8% | Property depth per schema type vs recommended properties | | Entity Consistency | 7% | Name consistency across schema, title, og:title; contact alignment | | Content Freshness | 7% | dateModified, Last-Modified header, sitemap lastmod, copyright year | | Content Extractability | 6% | Content-to-boilerplate ratio, citation-ready blocks, paywall detection | | Definition Blocks | 6% | "What is", "How to" headings, step lists, HowTo schema, dl elements | | Named Entities | 6% | Brand mentions, knowsAbout/founder signals, proper noun density | | AI Crawler Access | 4% | Per-bot robots.txt rules for GPTBot, ClaudeBot, PerplexityBot, etc. |
Optional: Geographic Signals (7%) — LocalBusiness geo data, address, areaServed. Enable with --include-geo.
CLI Usage
# Colored terminal output (default)
npx @ainyc/aeo-audit https://example.com
# JSON output (for CI/CD)
npx @ainyc/aeo-audit https://example.com --format json
# Markdown report
npx @ainyc/aeo-audit https://example.com --format markdown
# Run specific factors only
npx @ainyc/aeo-audit https://example.com --factors structured-data,faq-content
# Include geographic signals
npx @ainyc/aeo-audit https://example.com --include-geoExit code 0 for score >= 70, 1 for < 70 (CI-friendly).
Programmatic Usage
import { runAeoAudit } from '@ainyc/aeo-audit'
const report = await runAeoAudit('https://example.com', {
includeGeo: false, // Include geographic signals (default: false)
factors: null, // Run all factors (or pass array of factor IDs)
})
console.log(report.overallGrade) // 'A+'
console.log(report.overallScore) // 98
console.log(report.factors) // Array of factor results with scores, findings, recommendationsTypeScript declaration files are included automatically.
Claude Code / ClawHub Skill
This package now ships one umbrella skill source at skills/aeo/SKILL.md.
Command: /aeo
Modes:
auditfor grading and diagnosisfixfor code changes after an auditschemafor JSON-LD validationllmsforllms.txtandllms-full.txtmonitorfor before/after tracking or competitor comparisons
Examples:
/aeo audit https://example.com/aeo fix https://example.com/aeo schema https://example.com/aeo llms https://example.com/aeo monitor https://site-a.com --compare https://site-b.com
ClawHub package: arberx/aeo
If you are testing the skill from this repository instead of the published package, build first and use the local CLI:
pnpm run build
node bin/aeo-audit.js https://example.com --format jsonInstall Skills
# Personal install
git clone https://github.com/AINYC/aeo-audit.git /tmp/aeo-audit
cp -r /tmp/aeo-audit/skills/aeo ~/.claude/skills/
# Or project-level
cp -r /tmp/aeo-audit/skills/aeo .claude/skills/Grading Scale
| Grade | Score | Meaning | |-------|-------|---------| | A+ | 97-100 | Exceptional AEO readiness | | A / A- | 90-96 | Strong foundation | | B+/B/B- | 80-89 | Good with clear gaps | | C+/C/C- | 70-79 | Moderate, needs work | | D+/D/D- | 60-69 | Weak | | F | <60 | Critical |
Contributing
See CONTRIBUTING.md for guidelines.
License
MIT
