Documentation

Indxel Documentation

Developer-first SEO infrastructure for Next.js. Validate metadata, guard deploys, monitor scores — from your terminal.

Quick Start

Get up and running in 30 seconds. Install the SDK and CLI, scaffold your config, and run your first audit.

Installbash
npm install indxel           # TypeScript SDK
npm install -g indxel-cli    # CLI tool
Initializebash
npx indxel-cli init
# Creates: seo.config.ts, sitemap.ts, robots.ts
Audit your sitebash
npx indxel-cli check         # Static analysis of Next.js pages
npx indxel-cli crawl mysite.com  # Live site crawl
Guard deploysbash
npx indxel-cli check --ci    # Exit 1 on SEO errors — add to your CI pipeline

Zero config

The CLI auto-detects your Next.js project structure. No configuration file required for basic checks.

Components

Indxel is modular. Use what you need.

How It Works

Indxel validates your SEO metadata against 15 rules and scores each page 0–100.

1

Define your SEO config

Use defineSEO() to set site-wide defaults: siteName, titleTemplate, defaultOGImage, etc.

2

Generate metadata per page

Use createMetadata() in your generateMetadata() to produce canonical URLs, OG tags, Twitter cards, and hreflang.

3

Validate on every deploy

Add `npx indxel-cli check --ci` to your build. Broken SEO fails the build — no silent regressions.

4

Monitor over time

Push crawl results to the dashboard. Track scores, diff between deploys, catch regressions.

Scoring

Every page gets a 0–100 score based on 15 rules, weighted by impact.

GradeScoreMeaning
A90–100Excellent — production ready
B80–89Good — minor improvements possible
C70–79Needs work — some issues to fix
D60–69Poor — significant issues
F< 60Critical — broken SEO

See the full validation rules reference for all 15 rules with weights and examples.

LLM-Optimized Documentation

This documentation is designed for both humans and AI. If you're building with an LLM assistant, point it to:

Explore the docs