Installation
How to install and set up SEOX in your Next.js project
Installation
Requirements
| Requirement | Version |
|---|---|
| Node.js | >=18.0.0 |
| Bun | >=1.0.0 (recommended) |
| Next.js | >=14.0.0 |
| React | >=18.0.0 |
| TypeScript | >=5.0.0 |
Package Installation
bun add seoxnpm install seoxpnpm add seoxyarn add seoxProject Setup
After installation, initialize your project with the CLI:
bunx seox initThis creates a seox.config.ts file in your project root:
import type { SEOXConfig } from 'seox';
export const config: SEOXConfig = {
siteName: 'My Website',
siteUrl: 'https://example.com',
defaultTitle: 'My Website',
titleTemplate: '%s | My Website',
defaultDescription: 'Welcome to my website',
};Setup Flow
TypeScript Configuration
SEOX is written in TypeScript and provides full type support. No additional configuration required.
Available Imports
// Types from main package
import type { SEOXConfig } from 'seox';
// Components and classes from Next.js package
import { SEOX, JsonLd } from 'seox/next';Verify Installation
Run the doctor command to verify your setup:
bunx seox doctorExpected output:
🔍 Running SEOX diagnostics...
✓ Configuration file found
✓ Site name is configured
✓ Site URL is valid
✓ Title template is valid
✓ Description is configured
📊 Summary: 5 passed, 0 warnings, 0 errors