Installation

Install the plugin with your preferred package manager.

npm

Package Managers

Requirements

Register the Plugin

Add the plugin to your sanity.config.ts (or .js) file:

import { defineConfig } from 'sanity'
import seofields from 'sanity-plugin-seofields'

export default defineConfig({
  name: 'your-project',
  title: 'Your Project',
  projectId: 'your-project-id',
  dataset: 'production',
  plugins: [
    seofields(),  // Add the SEO fields plugin
    // ... other plugins
  ],
  schema: {
    types: [
      // ... your schema types
    ],
  },
})

Required: License Key for Dashboard

To use the SEO Health Dashboard, you need a valid license key. The good news: it's completely free right now! During the current period (1–2 months), simply grab a free key at no cost. When we transition to a paid model, your existing key will remain valid for a one-time $10 fee.

Get your free key at the Get License page →

See Dashboard docs for setup instructions and configuration options.