Skip to main content
seofields
docs

Setup & License

The SEO Health Dashboard requires a valid license key. Getting one is free during the current period — follow the three steps below.

🔓

Free for the next 1–2 months

Grab your key today at no cost. When paid access launches, your existing key stays active for a one-time $10 fee. No subscription, no recurring charges.

Step-by-step Setup

1

Install the plugin

If you haven't already installed the plugin, add it to your project:

$npm install sanity-plugin-seofields

Then register it in your sanity.config.ts. See the Installation guide →

2

Get your free license key

Visit the Get License page. Enter your email address and your Sanity project ID. Your key is generated instantly and sent to your inbox.

Email

The address your license key will be sent to.

Sanity Project ID

Found in your Sanity project dashboard or sanity.config.ts.

Get License Key — Free →
3

Add the key to your config

Copy the SEOF-XXXX-XXXX-XXXX key from your email and paste it into sanity.config.ts under healthDashboard.licenseKey:

sanity.config.ts
import { defineConfig } from 'sanity'
import seofields from 'sanity-plugin-seofields'

export default defineConfig({
  // ... your project config
  plugins: [
    seofields({
      healthDashboard: {
        licenseKey: 'SEOF-XXXX-XXXX-XXXX', // ← paste here
      },
    }),
  ],
})

After saving, restart your Studio. The 📊 SEO Health tab will appear in the Studio's navigation panel.

Don't want the dashboard?

The dashboard is enabled by default. If you don't need it, you can remove it from your Studio entirely:

sanity.config.ts
seofields({
  healthDashboard: false, // removes the SEO Health tab from Studio
})

All other SEO field features (preview, schema types, etc.) remain fully functional.

Was this page helpful?