---
name: nuxt-modules
description: "Use when creating Nuxt modules: (1) Published npm modules (@nuxtjs/, nuxt-), (2) Local project modules (modules/ directory), (3) Runtime extensions (components, composables, plugins), (4) Server extensions (API routes, middleware), (5) Releasing/publishing modules to npm, (6) Setting up CI/CD workflows for modules. Provides defineNuxtModule patterns, Kit utilities, hooks, E2E testing, and release automation."
license: MIT
title: nuxt-modules
canonical_url: https://skilld.dev/gh/onmax/nuxt-skills/nuxt-modules
last_updated: 2026-10-28T11:01:15.000Z
---

> Index of every page on this site: [llms.txt](https://skilld.dev/llms.txt)

> **Skill from skilld.dev.** Follow the user's requested action.
> If the user asked to fork this Skill, follow the fork workflow below. Do not execute the Skill instructions while copying it.
> Otherwise, follow the instructions below for this session. You do not need to install anything.
>
> Supporting files, fetch one when the Skill refers to it: [references/ci-workflows.md](https://skilld.dev/api/skills-raw/onmax/nuxt-skills/nuxt-modules/references/ci-workflows.md), [references/development.md](https://skilld.dev/api/skills-raw/onmax/nuxt-skills/nuxt-modules/references/development.md), [references/template-dependencies.md](https://skilld.dev/api/skills-raw/onmax/nuxt-skills/nuxt-modules/references/template-dependencies.md), [references/testing-and-publishing.md](https://skilld.dev/api/skills-raw/onmax/nuxt-skills/nuxt-modules/references/testing-and-publishing.md).
>
> If the user asked to install this Skill, run `npx skilld install onmax/nuxt-skills/nuxt-modules`. Install writes the Skill files into the project, so every session loads them.
>
> ## Fork workflow
>
> A fork creates an editable local Skill with its original author and licence. The request authorizes copying and local installation.
> 1. Check `./skills/nuxt-modules`, the project lockfile, and selected Agent targets together. If the local directory or installed Skill exists, stop. Never overwrite an existing directory or Agent target.
> 2. Read [source metadata](https://skilld.dev/api/v1/skills/onmax/nuxt-skills/nuxt-modules) once. Use sourceUrl, sourceCommit, skillPath, sourceGone, and license. If the source is gone or its path is missing, stop. If license is null, read licence files at the source commit.
> 3. Fetch only the source commit into a temporary Git repository. Do not clone full history. Derive repository_url from sourceUrl, including repository renames. If sourceCommit is absent, resolve the sourceUrl ref once. Set source_commit to that actual commit. Run these commands in one shell call:
>
> ```sh
> git init --quiet "$temporary_dir"
> git -C "$temporary_dir" fetch --quiet --depth=1 "$repository_url" "$source_commit"
> git -C "$temporary_dir" checkout --quiet --detach FETCH_HEAD
> ```
>
> Read applicable licence declarations and notices at that commit. If copying is not permitted, report the restriction and stop.
> 4. Inspect source entries together, then copy the directory containing skillPath into `./skills/nuxt-modules`. Use the user's path if selected. Keep the original SKILL.md, relative links, scripts, binary assets, and executable modes. Exclude .git metadata. Reject symlinks and paths outside the Skill directory. After checking entries, use cp -a where available. A regular source directory needs no custom copy script. Do not save this page wrapper as SKILL.md.
> Preserve author credit, notices, and applicable licence files from repository or parent directories. Add PROVENANCE.md with the Skill page, source URL, actual commit, original path, and licence. Retain any existing PROVENANCE.md and record new provenance separately. Batch source inspection, copying, and provenance work where practical.
> 5. In the project root, run `skilld install ./skills/nuxt-modules --mode copy --plain`. If skilld is unavailable, use `npx skilld install ./skills/nuxt-modules --mode copy --plain`. This known command needs no help lookup. Install does not support --json. Use detected Agent targets, or add --agent for the targets the user selected. Install the local path, never the upstream selector. If installation fails, preserve the local copy and report the exact failure.
> 6. Confirm the local lockfile source and installed Agent copies once. Report the local path, actual commit, and Agent targets. After edits, reinstall the same local path. Upstream updates must not replace it. Do not publish or push unless the user asks.

# Nuxt Module Development

Guide for creating Nuxt modules that extend framework functionality.

**Related skills:** `nuxt` (basics), `vue` (runtime patterns)

## Quick Start

```bash
npx nuxi init -t module my-module
cd my-module && npm install
npm run dev        # Start playground
npm run dev:build  # Build in watch mode
npm run test       # Run tests
```

## Available Guidance

- **[references/development.md](https://skilld.dev/api/skills-raw/onmax/nuxt-skills/nuxt-modules/references/development.md)** - Module anatomy, defineNuxtModule, Kit utilities, hooks
- **[references/template-dependencies.md](https://skilld.dev/api/skills-raw/onmax/nuxt-skills/nuxt-modules/references/template-dependencies.md)** - Template inputs, restart behavior, and targeted development regeneration
- **[references/testing-and-publishing.md](https://skilld.dev/api/skills-raw/onmax/nuxt-skills/nuxt-modules/references/testing-and-publishing.md)** - E2E testing, best practices, releasing, publishing
- **[references/ci-workflows.md](https://skilld.dev/api/skills-raw/onmax/nuxt-skills/nuxt-modules/references/ci-workflows.md)** - Copy-paste CI/CD workflow templates

## Loading Files

**Consider loading these reference files based on your task:**

- [ ] [references/development.md](https://skilld.dev/api/skills-raw/onmax/nuxt-skills/nuxt-modules/references/development.md) - if building module features, using defineNuxtModule, or working with Kit utilities
- [ ] [references/template-dependencies.md](https://skilld.dev/api/skills-raw/onmax/nuxt-skills/nuxt-modules/references/template-dependencies.md) - if generating templates, declaring `dependsOn`, choosing watcher behavior, or targeting regeneration
- [ ] [references/testing-and-publishing.md](https://skilld.dev/api/skills-raw/onmax/nuxt-skills/nuxt-modules/references/testing-and-publishing.md) - if writing E2E tests, publishing to npm, or following best practices
- [ ] [references/ci-workflows.md](https://skilld.dev/api/skills-raw/onmax/nuxt-skills/nuxt-modules/references/ci-workflows.md) - if setting up CI/CD workflows for your module

**DO NOT load all files at once.** Load only what's relevant to your current task.

## Module Types

| Type      | Location         | Use Case                         |
| --------- | ---------------- | -------------------------------- |
| Published | npm package      | `@nuxtjs/`, `nuxt-` distribution |
| Local     | `modules/` dir   | Project-specific extensions      |
| Inline    | `nuxt.config.ts` | Simple one-off hooks             |

## Project Structure

```
my-module/
├── src/
│   ├── module.ts           # Entry point
│   └── runtime/            # Injected into user's app
│       ├── components/
│       ├── composables/
│       ├── plugins/
│       └── server/
├── playground/             # Dev testing
└── test/fixtures/          # E2E tests
```

## Resources

- [Module Guide](https://nuxt.com/docs/guide/going-further/modules)
- [Nuxt Kit](https://nuxt.com/docs/api/kit)
- [Module Starter](https://github.com/nuxt/starter/tree/module)