The nuxt-ai-ready CLI provides commands for managing runtime indexing and IndexNow sync from your terminal.
The CLI is included with the module. Run it via npx:
npx nuxt-ai-ready <command>
Or add a script to your package.json:
{
"scripts": {
"ai-ready": "nuxt-ai-ready"
}
}
The CLI automatically reads the secret from node_modules/.cache/nuxt/ai-ready/secret, which is generated when you run nuxi dev or nuxi build.
nuxi dev or nuxi build at least once before using the CLI to generate the auth secret.Show indexing status and IndexNow sync progress.
npx nuxt-ai-ready status
npx nuxt-ai-ready status --url https://mysite.com
Options:
| Option | Alias | Default | Description |
|---|---|---|---|
--url | -u | http://localhost:3000 | Site URL |
--cwd | . | Working directory |
Output:
AI Ready Status
Total pages: 50
Indexed: 45
Pending: 5
IndexNow:
Pending: 10
Total submitted: 500
Last submitted: 2025-01-15T10:30:00.000Z
Trigger page indexing for pending pages.
# Index up to 10 pages (default)
npx nuxt-ai-ready poll
# Index up to 50 pages
npx nuxt-ai-ready poll --limit 50
# Index all pending pages
npx nuxt-ai-ready poll --all
Options:
| Option | Alias | Default | Description |
|---|---|---|---|
--url | -u | http://localhost:3000 | Site URL |
--limit | -l | 10 | Max pages to process |
--all | -a | false | Process all pending pages |
--cwd | . | Working directory |
Output:
Triggering poll at http://localhost:3000...
Indexed: 20 pages
Remaining: 25
Duration: 1234ms
Restore database from prerendered dump. Useful for resetting to the build-time state.
# Restore and clear existing pages
npx nuxt-ai-ready restore
# Restore without clearing (merge)
npx nuxt-ai-ready restore --no-clear
Options:
| Option | Alias | Default | Description |
|---|---|---|---|
--url | -u | http://localhost:3000 | Site URL |
--clear | true | Clear existing pages first | |
--cwd | . | Working directory |
Output:
Restoring database at http://localhost:3000...
Restored: 50 pages
Cleared: 45 existing pages
Remove stale routes that are no longer in the sitemap.
# Preview what would be pruned (dry run)
npx nuxt-ai-ready prune --dry
# Prune routes older than 7 days
npx nuxt-ai-ready prune --ttl 604800
# Preview with custom TTL
npx nuxt-ai-ready prune --dry --ttl 86400
Options:
| Option | Alias | Default | Description |
|---|---|---|---|
--url | -u | http://localhost:3000 | Site URL |
--dry | -d | false | Preview without deleting |
--ttl | pruneTtl config | Prune routes older than this (seconds) | |
--cwd | . | Working directory |
Output (dry run):
Previewing stale routes at http://localhost:3000...
Would prune: 5 routes
• /old-page-1
• /old-page-2
• /removed-feature
... and 2 more
Trigger IndexNow sync to notify search engines of changes.
# Submit up to 100 URLs (default)
npx nuxt-ai-ready indexnow
# Submit up to 500 URLs
npx nuxt-ai-ready indexnow --limit 500
Options:
| Option | Alias | Default | Description |
|---|---|---|---|
--url | -u | http://localhost:3000 | Site URL |
--limit | -l | 100 | Max URLs to submit |
--cwd | . | Working directory |
Output:
Triggering IndexNow sync at http://localhost:3000...
Submitted: 50 URLs
Remaining: 150
# Start dev server
nuxi dev
# In another terminal, check status
npx nuxt-ai-ready status
# Manually trigger indexing
npx nuxt-ai-ready poll --all
# After deployment, index all pages
npx nuxt-ai-ready poll --all --url https://mysite.com
# Notify search engines
npx nuxt-ai-ready indexnow --url https://mysite.com
# Clean up old routes weekly
npx nuxt-ai-ready prune --ttl 604800 --url https://mysite.com
Add to your deployment pipeline:
- name: Index pages
run: npx nuxt-ai-ready poll --all --url ${{ vars.SITE_URL }}
- name: Notify search engines
run: npx nuxt-ai-ready indexnow --url ${{ vars.SITE_URL }}
The CLI needs an auth secret generated by the module. Run nuxi dev or nuxi build first:
nuxi dev
# or
nuxi build
Ensure the dev server or production site is running and accessible at the specified URL:
# Check if server is running
curl http://localhost:3000/__ai-ready/status
If running from a different directory, specify --cwd:
npx nuxt-ai-ready status --cwd /path/to/project