---
title: "Install Nuxt Site Config · Nuxt Site Config · Nuxt SEO"
canonical_url: "https://nuxtseo.com/docs/site-config/getting-started/installation"
last_updated: "2026-08-14T21:00:58.792Z"
meta:
  description: "Get started with Nuxt Site Config by installing the dependency to your project."
  "og:description": "Get started with Nuxt Site Config by installing the dependency to your project."
  "og:title": "Install Nuxt Site Config · Nuxt Site Config · Nuxt SEO"
---

Nuxt SEO on GitHub

Switch to Site ConfigSwitch to Nuxt SEOSwitch to RobotsSwitch to SitemapSwitch to OG ImageSwitch to Schema.orgSwitch to Link CheckerSwitch to SEO UtilsSwitch to Skew ProtectionSwitch to AI Ready

**Getting Started**

# **Install Nuxt Site Config**

## Setup Module

`npx nuxt module add site-config`

Generate an Agent Skill for this package using [**~~skilld~~**](https://github.com/harlan-zw/skilld):

```bash
npx skilld add nuxt-site-config
```

## Verifying Installation

After installing the module, visit `**/__site-config__/debug.json**` to see the current site config, or check the Site Config tab in Nuxt DevTools.

## Module Kit Usage

Use the install function in your module:

modules.ts

```ts
import { installNuxtSiteConfig, updateSiteConfig } from 'nuxt-site-config/kit'

export default defineNuxtModule({
  // ...
  async setup(options) {
    await installNuxtSiteConfig()

    // Optional: set some site config from your modules options
    // This is not recommended, only to keep supporting your modules options
    updateSiteConfig({
      _context: 'my-module',
      url: options.siteUrl,
    })
  }
})
```

That's it. Explore the documentation to learn more.

## Next Steps

You've successfully installed Nuxt Site Config. Here's the recommended reading path:

1. **[**~~Recommended Config~~**](https://nuxtseo.com/docs/site-config/guides/setting-site-config)** - Set your site `**url**`, `**env**`, and `**name**`
2. **[**~~How it works~~**](https://nuxtseo.com/docs/site-config/guides/how-it-works)** - Understand config resolution order
3. **[**~~Runtime Site Config~~**](https://nuxtseo.com/docs/site-config/guides/runtime-site-config)** - Set config dynamically per-request

**Was this page helpful?**

### **Related **

[**Recommended Config**](https://nuxtseo.com/docs/site-config/guides/setting-site-config)

[**How it works**](https://nuxtseo.com/docs/site-config/guides/how-it-works)

[**Understanding Site Config**](https://nuxtseo.com/docs/nuxt-seo/guides/site-config)

[**Introduction** Learn about the motivation behind Nuxt Site Config and a bit about how it works.](https://nuxtseo.com/docs/site-config/getting-started/introduction) [**Troubleshooting** Debug Nuxt Site Config issues using DevTools, config options, and minimal reproductions.](https://nuxtseo.com/docs/site-config/getting-started/troubleshooting)