Install Nuxt Link Checker · Nuxt Link Checker · Nuxt SEO

[NuxtSEO](https://nuxtseo.com/ "Home")

- [Modules](https://nuxtseo.com/docs/nuxt-seo/getting-started/introduction)
- [Tools](https://nuxtseo.com/tools)
- [Pro](https://nuxtseo.com/pro)
- [Learn SEO](https://nuxtseo.com/learn-seo/nuxt) [Releases](https://nuxtseo.com/releases)

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

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

[User Guides](https://nuxtseo.com/docs/link-checker/getting-started/introduction)

[API](https://nuxtseo.com/docs/link-checker/api/config)

[Releases](https://nuxtseo.com/docs/link-checker/releases/v5)

Link Checker

- [Switch to Link Checker](https://nuxtseo.com/docs/link-checker/getting-started/introduction)
- [Switch to Nuxt SEO](https://nuxtseo.com/docs/nuxt-seo/getting-started/introduction)
- [Switch to Robots](https://nuxtseo.com/docs/robots/getting-started/introduction)
- [Switch to Sitemap](https://nuxtseo.com/docs/sitemap/getting-started/introduction)
- [Switch to OG Image](https://nuxtseo.com/docs/og-image/getting-started/introduction)
- [Switch to Schema.org](https://nuxtseo.com/docs/schema-org/getting-started/introduction)
- [Switch to SEO Utils](https://nuxtseo.com/docs/seo-utils/getting-started/introduction)
- [Switch to Site Config](https://nuxtseo.com/docs/site-config/getting-started/introduction)
- [Switch to Skew Protection](https://nuxtseo.com/docs/skew-protection/getting-started/introduction)
- [Switch to AI Ready](https://nuxtseo.com/docs/ai-ready/getting-started/introduction)

Search…```k`` /`

v5.0.7

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

### Getting Started

- [Introduction](https://nuxtseo.com/docs/link-checker/getting-started/introduction)
- [Installation](https://nuxtseo.com/docs/link-checker/getting-started/installation)
- [Troubleshooting](https://nuxtseo.com/docs/link-checker/getting-started/troubleshooting)

### Core Concepts

- [Inspection Rules](https://nuxtseo.com/docs/link-checker/guides/rules)
- [Link Checker DevTools](https://nuxtseo.com/docs/link-checker/guides/live-inspections)
- [Checking Links on Build](https://nuxtseo.com/docs/link-checker/guides/build-scans)
- [Exclude Links](https://nuxtseo.com/docs/link-checker/guides/exclude-links)
- [Exclude Pages](https://nuxtseo.com/docs/link-checker/guides/exclude-pages)
- [Generate Reports](https://nuxtseo.com/docs/link-checker/guides/generating-reports)
- [ESLint Integration](https://nuxtseo.com/docs/link-checker/guides/eslint)

Getting Started

# Install Nuxt Link Checker

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

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

nuxt

npm

yarn

pnpm

bun

bash

`npx nuxt module add link-checker`

bash

`npm i nuxt-link-checker`

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

nuxt.config.ts

```
export default defineNuxtConfig({
  modules: [
    'nuxt-link-checker',
  ],
})
```

bash

`yarn add nuxt-link-checker`

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

nuxt.config.ts

```
export default defineNuxtConfig({
  modules: [
    'nuxt-link-checker',
  ],
})
```

bash

`pnpm i nuxt-link-checker`

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

nuxt.config.ts

```
export default defineNuxtConfig({
  modules: [
    'nuxt-link-checker',
  ],
})
```

bash

`bun i nuxt-link-checker`

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

nuxt.config.ts

```
export default defineNuxtConfig({
  modules: [
    'nuxt-link-checker',
  ],
})
```

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

```
npx skilld add nuxt-link-checker
```

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

Nuxt Link Checker provides a visualize integration in development through the Link Checker DevTools tab. Open up DevTools in your Nuxt site and navigate to the `Link Checker` tab to see live inspections of your links. See the [Link Checker DevTools](https://nuxtseo.com/docs/link-checker/guides/live-inspections) guide for more information.

When building your site, the module will check links of all prerendered pages, it's recommended to prerender any pages that you'd like to have the links checked on.

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

You've successfully installed Nuxt Link Checker and configured it for your site.

1. Check which [Inspection Rules](https://nuxtseo.com/docs/link-checker/guides/rules) are enabled by default
2. Use [Nuxt Sitemap](https://nuxtseo.com/docs/sitemap/getting-started/installation) so that all your page URLs are discovered automatically during link checking
3. Learn more about how [Controlling Crawlers](https://nuxtseo.com/learn-seo/nuxt/controlling-crawlers) interact with your site

[Sitemap v8.0.1110M421 Powerfully flexible XML Sitemaps that integrate seamlessly.](https://nuxtseo.com/docs/sitemap/getting-started/introduction)

[Edit this page](https://github.com/harlan-zw/nuxt-link-checker/edit/main/docs/content/0.getting-started/1.installation.md)

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

Did this page help you?

[Introduction Find and magically fix links that may be negatively affecting your Nuxt sites SEO.](https://nuxtseo.com/docs/link-checker/getting-started/introduction) [Troubleshooting Solve common link checking issues and create reproductions for bug reports.](https://nuxtseo.com/docs/link-checker/getting-started/troubleshooting)

On this page

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

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

### [NuxtSEO](https://nuxtseo.com/ "Home")

- [Getting Started](https://nuxtseo.com/docs/nuxt-seo/getting-started/introduction)
- [MCP](https://nuxtseo.com/docs/nuxt-seo/guides/mcp)

Modules

- [Robots](https://nuxtseo.com/docs/robots/getting-started/introduction)
- [Sitemap](https://nuxtseo.com/docs/sitemap/getting-started/introduction)
- [OG Image](https://nuxtseo.com/docs/og-image/getting-started/introduction)
- [Schema.org](https://nuxtseo.com/docs/schema-org/getting-started/introduction)
- [Link Checker](https://nuxtseo.com/docs/link-checker/getting-started/introduction)
- [SEO Utils](https://nuxtseo.com/docs/seo-utils/getting-started/introduction)
- [Site Config](https://nuxtseo.com/docs/site-config/getting-started/introduction)
- [Skew Protection](https://nuxtseo.com/docs/skew-protection/getting-started/introduction)
- [AI Ready](https://nuxtseo.com/docs/ai-ready/getting-started/introduction)

### [NuxtSEO Pro](https://nuxtseo.com/pro "Home")

- [Getting Started](https://nuxtseo.com/pro)
- [Dashboard](https://nuxtseo.com/pro/dashboard)
- [Pro MCP](https://nuxtseo.com/docs/nuxt-seo-pro/mcp/installation)

### [Learn SEO](https://nuxtseo.com/learn-seo "Learn SEO")

Nuxt

- [Mastering Meta](https://nuxtseo.com/learn-seo/nuxt/mastering-meta)
- [Controlling Crawlers](https://nuxtseo.com/learn-seo/nuxt/controlling-crawlers)
- [Launch & Listen](https://nuxtseo.com/learn-seo/nuxt/launch-and-listen)
- [Routes & Rendering](https://nuxtseo.com/learn-seo/nuxt/routes-and-rendering)
- [Staying Secure](https://nuxtseo.com/learn-seo/nuxt/routes-and-rendering/security)

Vue

- [Vue SEO Guide](https://nuxtseo.com/learn-seo/vue)
- [Mastering Meta](https://nuxtseo.com/learn-seo/vue/mastering-meta)
- [Controlling Crawlers](https://nuxtseo.com/learn-seo/vue/controlling-crawlers)
- [SPA SEO](https://nuxtseo.com/learn-seo/vue/spa)
- [SSR Frameworks](https://nuxtseo.com/learn-seo/vue/ssr-frameworks)
- [SEO Checklist](https://nuxtseo.com/learn-seo/checklist)
- [Pre-Launch Warmup](https://nuxtseo.com/learn-seo/pre-launch-warmup)
- [Backlinks & Authority](https://nuxtseo.com/learn-seo/backlinks)

### [Tools](https://nuxtseo.com/tools "SEO Tools")

- [Social Share Debugger](https://nuxtseo.com/tools/social-share-debugger)
- [Robots.txt Generator](https://nuxtseo.com/tools/robots-txt-generator)
- [Meta Tag Checker](https://nuxtseo.com/tools/meta-tag-checker)
- [HTML to Markdown](https://nuxtseo.com/tools/html-to-markdown)
- [XML Sitemap Validator](https://nuxtseo.com/tools/xml-sitemap-validator)
- [Schema.org Validator](https://nuxtseo.com/tools/schema-validator)
- [Keyword Research Pro](https://nuxtseo.com/tools/keyword-research)
- [SERP Analyzer Pro](https://nuxtseo.com/tools/serp-analyzer)
- [Domain Rankings Pro](https://nuxtseo.com/tools/domain-rankings)

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