Nuxt SEO

https://nuxtseo.com/docs/
Admin
Nuxt SEO is a comprehensive module that provides sitemaps, robots.txt, meta tags, Schema.org, and OG...
Tokens:392,114
Snippets:3,346
Trust Score:7.5
Update:3 days ago
Show doc for...
Tokens:
Raw
### get_module_setup

Source: https://nuxtseo.com/docs/nuxt-seo/guides/mcp.md

Gets the installation guide for a Nuxt SEO module. Returns the install command, the guide content, and the navigation tree.

```APIDOC
## get_module_setup

### Description
Get the installation guide for a Nuxt SEO module. Returns the install command, the guide content, and the navigation tree.

### Parameters
- **module** (string) - Required - One of: `nuxt-seo`, `robots`, `sitemap`, `og-image`, `schema-org`, `link-checker`, `seo-utils`, `site-config`, `ai-ready`, `skew-protection`

### Request Example
```ts
get_module_setup({ module: 'schema-org' })
```

### Response
Returns the install command, the guide content, and the navigation tree.
```

--------------------------------

### get_module_setup tool usage

Source: https://nuxtseo.com/docs/nuxt-seo/guides/mcp.md

Retrieves the installation guide and navigation tree for a specific Nuxt SEO module.

```ts
get_module_setup({ module: 'schema-org' })
```

--------------------------------

### Install Neon database dependencies

Source: https://nuxtseo.com/docs/ai-ready/api/config.md

Example command to install drizzle-orm and the required Neon serverless client.

```bash
npx nypm add drizzle-orm@1.0.0-rc.4 @neondatabase/serverless
```

--------------------------------

### Install Ably SDK

Source: https://nuxtseo.com/docs/skew-protection/providers/external.md

Install the ably package to use the Ably adapter.

```bash
npx nypm add ably
```

--------------------------------

### Start development server

Source: https://nuxtseo.com/docs/seo-utils/releases/v9.md

Command to start the development server to check for rendering and head warnings.

```bash
nuxt dev
```

--------------------------------

### Example status output

Source: https://nuxtseo.com/docs/ai-ready/guides/cli.md

Shortened example output showing the indexing progress.

```text
AI Ready Status
Total pages: 50
Indexed: 45
Pending: 5
```

--------------------------------

### Install Pusher SDK

Source: https://nuxtseo.com/docs/skew-protection/providers/external.md

Install the pusher-js package to use the Pusher adapter.

```bash
npx nypm add pusher-js
```

--------------------------------

### Install @nuxtseo/cli globally

Source: https://nuxtseo.com/docs/nuxt-seo-pro/guides/cli.md

Install the CLI globally using npm and verify the installation by checking the version.

```sh
npm install --global @nuxtseo/cli
nuxtseo --version
```

--------------------------------

### Install sharp dependency

Source: https://nuxtseo.com/docs/seo-utils/guides/cli.md

Install the sharp library as a dev dependency to enable image processing for icon generation.

```bash
pnpm add -D sharp
```

--------------------------------

### CI/CD Integration Example

Source: https://nuxtseo.com/docs/ai-ready/guides/cli.md

Example GitHub Actions workflow step to index pages using environment secrets.

```yaml
- name: Index pages
  env:
    NUXT_APP_SECRET: ${{ secrets.NUXT_APP_SECRET }}
    SITE_URL: ${{ vars.SITE_URL }}
  run: npx nuxt-ai-ready poll --all --url "$SITE_URL"
```

--------------------------------

### Example restore output

Source: https://nuxtseo.com/docs/ai-ready/guides/cli.md

Shortened example output showing the results of a restore operation.

```text
Restoring database at http://localhost:3000...
Restored: 50 pages
Cleared: true existing pages
```

--------------------------------

### Product Page Schema.org recipe

Source: https://nuxtseo.com/docs/schema-org/guides/content.md

Example configuration for a Product node.

```md
---
title: 'Product'
schemaOrg:
  - "@type": "Product"
    name: "Product XYZ"
    description: "A high-quality product that meets your needs."
    offers:
      "@type": "Offer"
      price: "29.99"
      priceCurrency: "USD"
---
```

--------------------------------

### Install optional devtools host

Source: https://nuxtseo.com/docs/schema-org/getting-started/installation.md

Install the nuxtseo-devtools-host package to enable the Schema.org tab in Nuxt DevTools. Restart the development server after installation to load the module.

```bash
pnpm add -D nuxtseo-devtools-host@^1
```

--------------------------------

### Install nuxtseo-devtools-host

Source: https://nuxtseo.com/docs/ai-ready/releases/v3.md

Install the devtools host package as a dev dependency to maintain the AI Ready tab in DevTools.

```bash
pnpm add -D nuxtseo-devtools-host
```

--------------------------------

### Install Upstash Redis client

Source: https://nuxtseo.com/docs/skew-protection/guides/storage-configuration.md

Install the required dependency for using Upstash Redis as a storage driver.

```bash
npx nypm add @upstash/redis
```

--------------------------------

### reindex example output

Source: https://nuxtseo.com/docs/ai-ready/guides/cli.md

Shortened example output from a reindex command, showing the route being indexed and whether content changed.

```text
Reindexing /about at http://localhost:3000...
✔ Indexed: /about
Content changed: yes
```

--------------------------------

### Install nuxt-skew-protection v1

Source: https://nuxtseo.com/docs/skew-protection/releases/v1.md

Commands to install the v1 release of the module using pnpm, npm, or yarn.

```bash
# pnpm
pnpm add nuxt-skew-protection@^1

# npm
npm install nuxt-skew-protection@^1

# yarn
yarn add nuxt-skew-protection@^1
```

--------------------------------

### Runtime indexing endpoint request and response examples

Source: https://nuxtseo.com/docs/ai-ready/guides/runtime-indexing.md

Illustrative examples of various status, poll, prune, and reindex requests and their corresponding JSON responses.

```text
# Check indexing progress (requires the Bearer header)
GET /__ai-ready/status
# Returns: { total: 50, indexed: 45, pending: 5 }

# Trigger batch indexing (requires the Bearer header)
POST /__ai-ready/poll
# Returns: { indexed: 20, remaining: 25, errors: [], duration: 1234, complete: false }

# Process one bounded batch with a timeout check
POST /__ai-ready/poll?all=true&timeout=30000
# Returns: { indexed: 45, remaining: 0, errors: [], duration: 28500, complete: true }

# Prune stale routes (dry run, preview what would be pruned)
POST /__ai-ready/prune?dry=true&ttl=604800
# Returns: { routes: ["/old-page"], count: 1, ttl: 604800, dry: true }

# Prune stale routes (execute, requires Authorization: Bearer <token> header)
POST /__ai-ready/prune?ttl=604800
# Returns: { pruned: 1, ttl: 604800, dry: false }

# Reindex a single route, e.g. after a CMS publish (requires Authorization: Bearer <token> header)
POST /__ai-ready/reindex?route=/about
# Returns: { route: "/about", indexed: true, contentChanged: true }

# Reindex only when the page is older than the TTL
POST /__ai-ready/reindex?route=/about&force=false
# Returns: { route: "/about", indexed: false, skipped: true }

# A failed fetch or convert answers 502
POST /__ai-ready/reindex?route=/broken
# Returns: { route: "/broken", indexed: false, error: "Failed to fetch HTML for /broken" }
```

--------------------------------

### Deployment Safety Check Example

Source: https://nuxtseo.com/docs/skew-protection/api/use-active-connections.md

A TypeScript example showing how to calculate the number of users on outdated versions to verify migration progress during deployments.

```ts
const { total, versions } = useActiveConnections()

const usersOnOldVersions = computed(() => {
  const currentBuildId = useRuntimeConfig().app.buildId
  return Object.entries(versions.value)
    .filter(([id]) => id !== currentBuildId)
    .reduce((sum, [, count]) => sum + count, 0)
})

watch(usersOnOldVersions, (count) => {
  if (count === 0) {
    console.log('All users migrated to latest version!')
  }
})
```

--------------------------------

### Install MCP Toolkit and dependencies

Source: https://nuxtseo.com/docs/ai-ready/getting-started/installation.md

Install the MCP toolkit and the required drizzle-orm package to expose indexed pages to remote agents.

```bash
npx nuxt module add @nuxtjs/mcp-toolkit
npx nypm add drizzle-orm@1.0.0-rc.4
```

--------------------------------

### prune dry run example output

Source: https://nuxtseo.com/docs/ai-ready/guides/cli.md

Example output from a prune dry run, showing the number of routes that would be pruned and a sample list.

```text
Previewing stale routes at http://localhost:3000...
Would prune: 5 routes
  • /old-page-1
  • /old-page-2
  • /removed-feature
  ... and 2 more
```

--------------------------------

### Blog Post Schema.org recipe

Source: https://nuxtseo.com/docs/schema-org/guides/content.md

Example configuration for a BlogPosting node.

```md
---
title: 'My Blog Post'
schemaOrg:
  - "@type": "BlogPosting"
    headline: "How to Use Our Product"
    author:
      "@type": "Person"
      name: "Jane Smith"
    datePublished: "2023-10-01"
---
```

--------------------------------

### Contact Page Schema.org recipe

Source: https://nuxtseo.com/docs/schema-org/guides/content.md

Example configuration for a ContactPage node.

```md
---
title: 'Contact'
schemaOrg:
  "@type": "ContactPage"
  mainEntity:
    "@type": "ContactPoint"
    contactType: "Customer Service"
    telephone: "+1-800-555-5555"
    email: "support@example.com"
---
```

--------------------------------

### Example File Structure: public/_robots.txt

Source: https://nuxtseo.com/docs/robots/releases/v3.md

Shows the file structure for the new robots.txt configuration. Place the file at public/_robots.txt.

```bash
public/_robots.txt
```

--------------------------------

### GET /api/v1/sites/{siteId}/research

Source: https://nuxtseo.com/docs/api/openapi.json

Returns retained competitor and keyword-gap evidence already collected for the Site. It never starts provider work and does not consume metered units.

```APIDOC
## GET /api/v1/sites/{siteId}/research

### Description
Returns retained competitor and keyword-gap evidence already collected for the Site. It never starts provider work and does not consume metered units.

### Method
GET

### Endpoint
/api/v1/sites/{siteId}/research

### Parameters
#### Path Parameters
- **siteId** (string) - Required - The ID of the site.

### Response
#### Success Response (200)
- **data** (object) - The research data.
- **meta** (object) - Metadata including request ID and version.

#### Response Example
{
  "data": {
    "competitors": [],
    "evidence": {
      "_tag": "stored",
      "collectedAt": null,
      "provider": "dataforseo"
    },
    "subject": null,
    "summary": {
      "competitorCount": 0,
      "quickWins": 0,
      "totalSharedKeywords": 0,
      "totalTrafficValue": 0
    }
  },
  "meta": {
    "requestId": "req_01JXYZ",
    "version": "1.0"
  }
}

### Error Responses
- **400** - Stable errors: invalid_request.
- **401** - Stable errors: unauthorized, auth_expired.
- **403** - Stable errors: forbidden.

### Headers
- **RateLimit** (string) - Remaining quota and reset metadata.
- **RateLimit-Policy** (string) - Active quota policy.
- **Retry-After** (integer) - Delay in seconds before a retry.
- **X-NuxtSEO-Operation** (string) - Operation identifier.
- **X-NuxtSEO-Version** (string) - API version.
- **X-Request-Id** (string) - Request ID.

### Security
- sessionAuth
- bearerAuth

### Tags
- Research
```

--------------------------------

### GET /api/v1/sites/{siteId}/performance/scans/{scanId}

Source: https://nuxtseo.com/docs/api/openapi.json

Returns one Scan with the evidence behind its scores: wasteful assets, cache policy, third-party scripts, LCP element, and failing accessibility and best-practices checks. It also includes why the Scan started, the Lighthouse version, and comparison with the previous Scan.

```APIDOC
## GET /api/v1/sites/{siteId}/performance/scans/{scanId}

### Description
Returns one Scan with the evidence behind its scores: the wasteful assets, the repeat-visit cache policy, the third-party scripts, the LCP element, and every failing accessibility and best-practices check with the CSS selectors and DOM snippets that failed. It also returns why the Scan started, the Lighthouse version, and the comparison with the previous Scan of the same Page.

### Method
GET

### Endpoint
/api/v1/sites/{siteId}/performance/scans/{scanId}

### Parameters
#### Path Parameters
- **scanId** (string) - Required - The scan identifier.
- **siteId** (string) - Required - The site identifier.

### Response
#### Success Response (200)
- **data** (object) - The scan details.
  - **id** (string) - Scan identifier.
  - **status** (string) - Status of the scan (e.g., complete).
  - **url** (string) - The scanned URL.
  - **strategy** (string) - Mobile or desktop.
  - **scores** (object) - Performance scores (a11y, bestPractices, perf, seo).
  - **lighthouseVersion** (string) - Version of Lighthouse used.
  - **trigger** (string) - How the scan was triggered.
  - **completedAt** (string) - Completion timestamp.
  - **coverage** (object) - Coverage information for checks and elements.
  - **crux** (object) - CrUX data for the URL and origin.
  - **comparison** (object) - Comparison with previous scan.
  - **error** (string|null) - Error message if failed.
  - **failureKind** (string|null) - Failure kind if failed.
- **meta** (object) - Metadata including requestId and version.

#### Response Example
{
  "data": {
    "id": "scan_01JXYZ",
    "status": "complete",
    "url": "https://example.com/pricing",
    "strategy": "mobile",
    "scores": {
      "a11y": 96,
      "bestPractices": 92,
      "perf": 82,
      "seo": 98
    },
    "lighthouseVersion": "13.5.0",
    "trigger": "scheduled",
    "completedAt": "2026-08-10T01:00:00.000Z",
    "coverage": {
      "accessibilityChecksTotal": 0,
      "bestPracticesChecksTotal": 0,
      "perCheckElementCap": 5,
      "perScanCheckCap": 12,
      "possiblyTruncated": false
    },
    "crux": {
      "capturedAt": "2026-08-10T00:58:00.000Z",
      "formFactor": "PHONE",
      "origin": {
        "_tag": "measured",
        "cls": {"p75": 0.05, "rating": "good"},
        "inp": {"p75": 180, "rating": "good"},
        "lcp": {"p75": 2100, "rating": "good"},
        "target": "https://example.com"
      },
      "url": {
        "_tag": "no_data",
        "target": "https://example.com/pricing"
      }
    },
    "comparison": {
      "_tag": "compared",
      "changes": [
        {"current": 2200, "delta": 700, "metric": "lcp", "previous": 1500, "severity": "regression"},
        {"current": 82, "delta": -3, "metric": "perf", "previous": 85, "severity": "neutral"}
      ],
      "previousScanId": "scan_01JXXX",
      "severity": "regression"
    },
    "error": null,
    "failureKind": null
  },
  "meta": {
    "requestId": "req_01JXYZ",
    "version": "1.0"
  }
}

### Error Responses
#### 400 Bad Request
- **description**: Stable errors: invalid_request.

### Authentication
- sessionAuth
- bearerAuth

### Rate Limit
- 50 requests per 60 seconds

### Headers
- RateLimit: Remaining quota and reset metadata.
- RateLimit-Policy: Active quota policy.
- Retry-After: Delay in seconds before retry.
- X-NuxtSEO-Operation: page.performance.scan
- X-NuxtSEO-Version: 1.0
- X-Request-Id: Request identifier.
```

--------------------------------

### Example SKILL.md File

Source: https://nuxtseo.com/docs/ai-ready/guides/agent-skills.md

A complete skill file including frontmatter and content.

```md
---
name: seo-audit
description: Audit a site for critical SEO issues.
---

# SEO audit

Check indexability, metadata, canonical URLs, and structured data.
```

--------------------------------

### GET /api/v1/sites/{siteId}/mentions

Source: https://nuxtseo.com/docs/api/openapi.json

Returns retained pages and posts that name the Site without linking to it, newest first. Dismissed and lost Mentions are excluded. Pass includeFiltered=1 to keep the ones AI triage marked a false positive. It never starts provider work and does not consume metered units.

```APIDOC
## GET /api/v1/sites/{siteId}/mentions

### Description
Returns retained pages and posts that name the Site without linking to it, newest first. Dismissed and lost Mentions are excluded. Pass includeFiltered=1 to keep the ones AI triage marked a false positive. It never starts provider work and does not consume metered units.

### Method
GET

### Endpoint
/api/v1/sites/{siteId}/mentions

### Parameters
#### Path Parameters
- **siteId** (string) - Required - The ID of the site to list mentions for.

#### Query Parameters
- **includeFiltered** (string) - Optional - Set to "1" to include mentions marked as false positives by AI triage. Example: "0".
- **limit** (integer) - Optional - Maximum number of mentions to return. Example: 100.

### Response
#### Success Response (200)
- **data** (object) - Contains the list of mentions.
  - **items** (array) - List of mention objects.
    - **id** (string) - Mention ID.
    - **author** (string) - Author name.
    - **authorHandle** (string) - Author handle.
    - **domain** (string) - Domain of the mention.
    - **domainRank** (integer) - Domain rank.
    - **engagement** (integer) - Engagement count.
    - **publishedAt** (string) - Publication timestamp.
    - **sentiment** (string) - Sentiment (e.g., positive).
    - **snippet** (string) - Text snippet.
    - **source** (string) - Source (e.g., hackernews).
    - **title** (string) - Title of the mention.
    - **url** (string) - URL of the mention.
  - **limit** (integer) - The limit used.
  - **page** (object) - Pagination info.
    - **hasMore** (boolean) - Whether more results exist.
    - **limit** (integer) - Page limit.
    - **offset** (integer) - Page offset.
    - **total** (integer) - Total number of mentions.
  - **rows** (array) - Alias for items.
  - **total** (integer) - Total count.
- **meta** (object) - Contains request metadata.
  - **requestId** (string) - Request ID.
  - **version** (string) - API version.

#### Response Example
{
  "data": {
    "items": [
      {
        "author": "Ada Lovelace",
        "authorHandle": "ada",
        "domain": "news.ycombinator.com",
        "domainRank": 812,
        "engagement": 142,
        "id": "mn_01JXYZ",
        "publishedAt": "2026-08-01T09:12:00.000Z",
        "sentiment": "positive",
        "snippet": "We moved to example.com last week",
        "source": "hackernews",
        "title": "Show HN: a sitemap module",
        "url": "https://news.ycombinator.com/item?id=1"
      }
    ],
    "limit": 100,
    "page": {
      "hasMore": false,
      "limit": 100,
      "offset": 0,
      "total": 1
    },
    "rows": [
      {
        "author": "Ada Lovelace",
        "authorHandle": "ada",
        "domain": "news.ycombinator.com",
        "domainRank": 812,
        "engagement": 142,
        "id": "mn_01JXYZ",
        "publishedAt": "2026-08-01T09:12:00.000Z",
        "sentiment": "positive",
        "snippet": "We moved to example.com last week",
        "source": "hackernews",
        "title": "Show HN: a sitemap module",
        "url": "https://news.ycombinator.com/item?id=1"
      }
    ],
    "total": 1
  },
  "meta": {
    "requestId": "req_01JXYZ",
    "version": "1.0"
  }
}

### Error Responses
- **400** - Stable errors: invalid_request.

### Authentication
Requires sessionAuth or bearerAuth. Minimum role: viewer. Scopes: analytics:read.

### Headers
- **X-NuxtSEO-Operation** - Always "mentions.list".
- **X-NuxtSEO-Version** - Always "1.0".
- **X-Request-Id** - Request ID.
- **RateLimit** - Remaining quota and reset metadata.
- **RateLimit-Policy** - Active quota policy.
- **Retry-After** - Delay in seconds before retry when retryable.
```

--------------------------------

### Define System Environment Configuration

Source: https://nuxtseo.com/docs/site-config/getting-started/how-it-works

Example of setting environment variables for system-level configuration at build time.

```javascript
export default {
  env: import.meta.envName || process.env.NODE_ENV,
}
```

--------------------------------

### Select site and inspect page

Source: https://nuxtseo.com/docs/nuxt-seo-pro/guides/cli.md

Set a default site and inspect a specific URL.

```sh
nuxtseo sites use site_123
nuxtseo page inspect https://example.com/about
```

--------------------------------

### Example poll output

Source: https://nuxtseo.com/docs/ai-ready/guides/cli.md

Shortened example output showing the results of a poll operation.

```text
Triggering poll at http://localhost:3000...
Indexed: 10 pages
Remaining: 25
Duration: 1234ms
```

--------------------------------

### Install SEO DevTools host

Source: https://nuxtseo.com/docs/nuxt-seo/migration-guide/v5-to-v6.md

Add the optional SEO DevTools host as a development dependency.

```bash
npx nypm add -D nuxtseo-devtools-host
```

--------------------------------

### Install RAG script dependencies

Source: https://nuxtseo.com/docs/ai-ready/advanced/rag-example.md

Install the necessary packages for OpenAI, SQLite, and vector operations.

```bash
pnpm add -D openai better-sqlite3 sqlite-vec tsx @types/better-sqlite3
```

--------------------------------

### Verify installation with curl

Source: https://nuxtseo.com/docs/ai-ready/getting-started/installation.md

Request a page as Markdown to verify the development server is correctly serving content.

```bash
curl http://localhost:3000/about.md
```

--------------------------------

### Component Naming Convention

Source: https://nuxtseo.com/docs/og-image/renderers.md

Example of the required directory structure and filename suffixes for OG Image components.

```bash
components/OgImage/
  MyTemplate.takumi.vue    # Takumi renderer (recommended)
  MyTemplate.satori.vue    # Satori renderer
  Screenshot.browser.vue   # Browser renderer
```

--------------------------------

### FAQ Page Schema.org recipe

Source: https://nuxtseo.com/docs/schema-org/guides/content.md

Example configuration for an FAQPage node with multiple questions.

```md
---
title: 'FAQ'
schemaOrg:
  "@type": "FAQPage"
  mainEntity:
    - "@type": "Question"
      name: "What is your return policy?"
      acceptedAnswer:
        "@type": "Answer"
        text: "You can return any item within 30 days of purchase."
    - "@type": "Question"
      name: "Do you offer technical support?"
      acceptedAnswer:
        "@type": "Answer"
        text: "Yes, we offer 24/7 technical support."
---
```

--------------------------------

### Verify installed version

Source: https://nuxtseo.com/docs/nuxt-seo/guides/updating-modules.md

Run the nuxt info command to verify the installed version of @nuxtjs/seo in your project.

```bash
npx nuxt info
```

--------------------------------

### Install @nuxtjs/seo via CLI

Source: https://nuxtseo.com/docs/nuxt-seo/getting-started/introduction.md

Use the npx command to add the @nuxtjs/seo package to your project.

```bash
npx nuxt module add @nuxtjs/seo
```

--------------------------------

### Install nuxt-skew-protection v2

Source: https://nuxtseo.com/docs/skew-protection/releases/v2.md

Commands to install the v2 version of the nuxt-skew-protection package using pnpm, npm, or yarn.

```bash
# pnpm
pnpm add nuxt-skew-protection@^2

# npm
npm install nuxt-skew-protection@^2

# yarn
yarn add nuxt-skew-protection@^2
```

--------------------------------

### Install Nuxt Robots

Source: https://nuxtseo.com/docs/skew-protection/getting-started/installation.md

Install the optional Nuxt Robots module to exclude bots from WebSocket and SSE connections.

```bash
npx nuxt module add @nuxtjs/robots
```

--------------------------------

### 'ai-ready:llms-txt'

Source: https://nuxtseo.com/docs/ai-ready/api/nuxt-hooks.md

Runs during module setup, before llms.txt configuration is finalized. Add sections or notes to the supplied payload.

```APIDOC
## Hook: 'ai-ready:llms-txt'

### Description
Runs during module setup, before llms.txt configuration is finalized. Add sections or notes to the supplied payload.

### Type
(payload: { sections: LlmsTxtSection[] | undefined, notes: string[] }) => void | Promise<void>

### Payload
- **sections** (LlmsTxtSection[] | undefined) - Sections with title, description, links
- **notes** (string[]) - Heading-free context rendered before file-list sections

### Usage
Use in nuxt.config.ts. Mutate the supplied payload; return values are ignored.

### Example
```ts [nuxt.config.ts]
export default defineNuxtConfig({
  hooks: {
    'ai-ready:llms-txt': (payload) => {
      payload.sections ??= []
      payload.sections.push({
        title: 'Custom APIs',
        description: 'Additional endpoints',
        links: [
          { title: 'Search', href: '/api/search', description: 'Search endpoint' }
        ]
      })
      payload.notes.push('Built with Nuxt AI Ready')
    }
  }
})
```

### Notes
Change the arrays directly. This hook does not run for each HTTP request.
```

--------------------------------

### Install zod dependency

Source: https://nuxtseo.com/docs/nuxt-seo/guides/nuxt-content.md

Install zod as a direct dependency to ensure schema functions resolve correctly in content.config.ts.

```bash
npx nypm add zod
```

--------------------------------

### Define Path-Specific Content-Signal Rules in robots.txt

Source: https://nuxtseo.com/docs/robots/guides/ai-directives.md

Example showing how to apply different Content-Signal policies to specific site paths.

```txt
User-agent: *
Allow: /
Content-Signal: ai-train=no, search=yes
Content-Signal: /docs/ ai-input=yes
Content-Signal: /api/ ai-train=no, ai-input=no, search=no
```

--------------------------------

### Run CLI command without global install

Source: https://nuxtseo.com/docs/nuxt-seo-pro/guides/cli.md

Execute a single command using npx without installing the package globally.

```sh
npx @nuxtseo/cli sites list
```

--------------------------------

### Real-time Stats Display Example

Source: https://nuxtseo.com/docs/skew-protection/api/use-active-connections.md

A Vue component example that calculates and displays the percentage of users currently on the latest build version.

```vue
<script setup lang="ts">
const { total, versions } = useActiveConnections()
const buildId = useRuntimeConfig().app.buildId

const stats = computed(() => {
  const current = versions.value[buildId] || 0
  const outdated = total.value - current
  return {
    current,
    outdated,
    percentCurrent: total.value ? Math.round((current / total.value) * 100) : 0
  }
})
</script>

<template>
  <div class="stats">
    <span>{{ stats.current }} current</span>
    <span>{{ stats.outdated }} outdated</span>
    <span>{{ stats.percentCurrent }}% up to date</span>
  </div>
</template>
```

--------------------------------

### Development Workflow Commands

Source: https://nuxtseo.com/docs/ai-ready/guides/cli.md

Commands to start the development server, check status, and manually trigger indexing.

```bash
# Start dev server
nuxi dev

# In another terminal, check status
npx nuxt-ai-ready status

# Manually trigger indexing
npx nuxt-ai-ready poll --all
```
Tokens:
Raw