AuditKit docs
nirholas / AuditKit

AuditKit

Full-stack website and GitHub repo auditor: scores performance, SEO, accessibility, security, structured data and AI readiness, then generates a ready-to-run AI agent fix brief.

v0.1.0SEE LICENSE IN LICENSETypeScript
git clone https://github.com/nirholas/AuditKit.git

What it does

Capabilities documented in this repository.

What it checks

See the full documentation for details.

The killer feature

See the full documentation for details.

Tech stack

See the full documentation for details.

Project structure

See the full documentation for details.

APIs used

See the full documentation for details.

Roadmap

See the full documentation for details.

Get started

Install it, then run your first command.

git clone https://github.com/nirholas/AuditKit.git
CommandRuns
npm run devturbo run dev
npm run buildturbo run build
npm run lintturbo run lint
npm run testturbo run test

Read the full getting started guide

Examples

Taken directly from this repository's documentation.

auditkit-brief-yoursite.com/
├── AGENTS.md              ← master brief with all issues + fix instructions
├── CLAUDE.md              ← Claude Code-specific instructions
├── GEMINI.md              ← Gemini-specific instructions
├── llms.txt               ← template to add to your site
├── .agents/skills/
│   ├── performance/SKILL.md
│   ├── seo/SKILL.md
│   ├── security/SKILL.md
│   └── ...                ← one per affected pillar
├── checklists/            ← per-pillar fix checklists
└── ready-to-deploy/
    ├── robots.txt         ← generated, ready to commit
    ├── security-headers.next.js
    └── structured-data.jsonld
# Clone
git clone https://github.com/nirholas/AuditKit
cd AuditKit

# Install
pnpm install

# Configure
cp .env.example .env
# Every key is optional. AuditKit runs with none of them.
# GOOGLE_API_KEY  raises the PageSpeed Insights quota
# GITHUB_TOKEN    raises the GitHub API rate limit (60/hr -> 5,000/hr)
# GROQ_API_KEY    enables the AI Insights panel shown after each audit

# Run
pnpm dev
# → http://localhost:3000
auditkit/
├── apps/web/              ← Next.js 15 frontend + API routes
├── packages/
│   ├── collectors/        ← one file per data source (pagespeed, crux, github, etc.)
│   ├── scorer/            ← converts raw data → pillar scores + issues
│   ├── analyzer/          ← orchestrates collectors in parallel
│   └── generator/         ← converts scores → AI agent brief ZIP

More examples

Reference