Install Nuxt Robots · Nuxt Robots · Nuxt SEO

-
-
-
-

[1.4K](https://github.com/harlan-zw/nuxt-seo)

[Nuxt SEO on GitHub](https://github.com/harlan-zw/nuxt-seo)

Robots

-
-
-
-
-
-
-
-
-
-

Search…```k`` /`

v6.0.7

- Playgrounds
- [Discord Support](https://discord.com/invite/275MBUBvgP)

### Getting Started

-
-
-

### Core Concepts

-
-
-
-
-
-
-
-
-

### Advanced

-
-
-

Getting Started

# Install Nuxt Robots

[Copy for LLMs](https://nuxtseo.com/docs/robots/getting-started/installation.md)

## [Setup Module](#setup-module)

Want to know why you need this module? Check out the

.

To get started with Nuxt Robots, you need to install the dependency and add it to your Nuxt config.

nuxt

npm

yarn

pnpm

bun

bash

`npx nuxt module add robots`

bash

`npm i @nuxtjs/robots`

You will need to manually add the module to your Nuxt config.

nuxt.config.ts

```
export default defineNuxtConfig({
  modules: [
    '@nuxtjs/robots',
  ],
})
```

bash

`yarn add @nuxtjs/robots`

You will need to manually add the module to your Nuxt config.

nuxt.config.ts

```
export default defineNuxtConfig({
  modules: [
    '@nuxtjs/robots',
  ],
})
```

bash

`pnpm i @nuxtjs/robots`

You will need to manually add the module to your Nuxt config.

nuxt.config.ts

```
export default defineNuxtConfig({
  modules: [
    '@nuxtjs/robots',
  ],
})
```

bash

`bun i @nuxtjs/robots`

You will need to manually add the module to your Nuxt config.

nuxt.config.ts

```
export default defineNuxtConfig({
  modules: [
    '@nuxtjs/robots',
  ],
})
```

## [Verifying Installation](#verifying-installation)

To ensure the module is behaving as expected, you should first check [`/robots.txt`](http://localhost:3000/robots.txt) is being generated.

It should show that the site is disallowed from indexing, this is good as development environments should not be indexed by search engines.

However, we want to see what a production environment would look like.

For this, it's recommended to use the Nuxt DevTools Robots tab to see the current configuration and how it's being applied.

The DevTools will show you that in production we're just serving a minimal robots.txt file.

robots.txt

```
User-agent: *
Disallow:
```

This allows all search engines to index the site.

## [Configuration](#configuration)

Every site is different and will require their own unique configuration, to give you a head start you may consider the following areas to configure.

- - If you have non-production environments you should disable indexing for these environments, while this works out-of-the-box for most providers, it's good to verify this is working as expected.
- - You should consider excluding pages that are not useful to search engines, for example any routes which require authentication should be ignored.

Make sure you understand the differences between robots.txt vs robots meta tag with the

 guide.

## [Next Steps](#next-steps)

You've successfully installed Nuxt Robots and configured it for your project.

Documentation is provided for module integrations, check them out if you're using them.

- - Disallows are automatically expanded to your configured locales.
- - Configure robots from your markdown files.

Next check out the

 guide for some inspiration.

[Edit this page](https://github.com/nuxt-modules/robots/edit/main/docs/content/1.getting-started/1.installation.md)

[Markdown For LLMs](https://nuxtseo.com/docs/robots/getting-started/installation.md)

Did this page help you?

On this page

- [Setup Module](#setup-module)
- [Verifying Installation](#verifying-installation)
- [Configuration](#configuration)
- [Next Steps](#next-steps)

[GitHub](https://github.com/harlan-zw/nuxt-seo) [ Discord](https://discord.com/invite/275MBUBvgP)

###

-
-

Modules

-
-
-
-
-
-
-
-
-

###

-
-
-

###

Nuxt

-
-
-
-
-

Vue

-
-
-
-
-
-
-
-

###

-
-
-
-
-
-
-
-
-
-

Copyright © 2023-2026 Harlan Wilton - [MIT License](https://github.com/harlan-zw/nuxt-seo/blob/main/license) · [mdream](https://mdream.dev)