Setup Module

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

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

@nuxtjs/seo includes this module. If your app uses @nuxtjs/seo, skip this step.

npx nuxt module add robots

Use Nuxt 4.6 or Nuxt 5. Use Node 22.22.3+, Node 24.15.0+, or Node 26+.

Import app functions from #robots/app. Import server functions from #robots/server. If you use Nuxt Content, use version 3.

Using an AI agent? Get the @nuxtjs/robots Skill on skilld.dev/gh/nuxt-modules/robots.

Verifying Installation

To ensure the module is behaving as expected, you should first check /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 panel needs the nuxtseo-devtools-host package. Install it as a dev dependency with pnpm add -D nuxtseo-devtools-host, then restart the dev server. You do not add it to modules.

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

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

  • Disabling Site Indexing - 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.
  • Disable Page Indexing - 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 Controlling Web Crawlers guide.

Next Steps

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

  1. Disabling Site Indexing - If you have non-production environments you should disable indexing for these environments.
  2. Disable Page Indexing - Consider excluding pages that are not useful to search engines, for example any routes which require authentication.
  3. Robots.txt Recipes - Common patterns for blocking bad bots, AI crawlers, and search results.

Using other Nuxt modules?

  • Nuxt I18n - Disallows are automatically expanded to your configured locales.
  • Nuxt Content - Configure robots from your markdown files.
Was this page helpful?