AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
Nuxt is a full-stack Vue framework designed for universal deployment. This skill provides essential guidance on Nuxt 5, covering its directory structure, file-based routing, server-side rendering, and Nitro-based server engine. It includes best practices for data fetching, state management, and modular architecture, helping developers leverage features like auto-imports and hybrid rendering.
What it does
- Explains the Nuxt 5 directory structure and configuration conventions.
- Details file-based routing, including typed and case-sensitive routes.
- Provides guidance on data fetching using useFetch and $fetch.
- Covers server-side rendering, hybrid rendering, and Nitro server integration.
- Explains how to extend applications using Nuxt Layers and modules.
- Outlines lifecycle hooks for build-time and runtime customization.
When to use it
- When starting a new full-stack project with Vue and Nuxt.
- When migrating existing projects to Nuxt 5 and Nitro v3.
- When implementing server-side rendering or hybrid rendering strategies.
- When creating reusable application layers or custom Nuxt modules.
- When optimizing data fetching patterns and state management in SSR environments.
Advantages
- Provides standardized patterns for Nuxt 5 development.
- Simplifies complex concepts like Nitro server integration and lifecycle hooks.
- Offers clear guidance on project structure and file-based routing.
- Supports efficient code reuse through the Nuxt Layers system.
Usage examples
- “How do I structure my Nuxt 5 project directory?”
- The agent explains the default app/ directory structure for Vue code and the root-level placement for server/, public/, and nuxt.config.ts files.
- “Explain how to use layers to share components between projects.”
- The agent provides instructions on using the extends property in nuxt.config.ts to import layers from local directories, git repositories, or npm packages.
- “How do I hook into the page navigation lifecycle?”
- The agent shows how to use nuxtApp.hook('page:finish', ...) within a plugin to execute code after navigation completes.
Install
Download the skill as a ZIP:
https://mp-staging.autogineer.com/agent-skills/antfu/nuxt/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip nuxt.zip -d .agents/skills
Documentation by Anthony Fu
Nuxt is a full-stack Vue framework that provides server-side rendering, file-based routing, auto-imports, and a powerful module system. It uses Nitro as its server engine for universal deployment across Node.js, serverless, and edge platforms.
The skill is based on Nuxt 5.x (
5.0.0-0), generated at 2026-11-05.
Directory layout: the default
srcDirisapp/— Vue app code (app.vue,components/,composables/,pages/, etc.) lives underapp/, whileserver/,shared/,public/,modules/,layers/andnuxt.config.tsstay at the project root. The~/@aliases point atapp/; use~~/@@for the root.
Nuxt 5 note: Nuxt 5 makes many former experimental flags the default. The biggest shifts for agents: server code moves to Nitro v3 (h3 v2, Web-standard
Request/Response), server utilities import fromnuxt/serverand are no longer auto-imported by default,$fetch/useFetchare typed from generated route types, routing is case-sensitive and typed by default, and the bundler is Vite 8 (Rolldown). Nuxt 5 requires Node22.19/24.11+. A Nitro v2 compatibility layer (nitroLegacy) keeps older server code building during migration. See individual references for details.
Core
| Topic | Description | Reference |
|---|---|---|
| Directory Structure | Nuxt 4 app/ srcDir, shared/, aliases, conventions | core-directory-structure |
| Configuration | nuxt.config.ts, app.config.ts, aliases, Nuxt 5 defaults, jiti removal, experimental | core-config |
| CLI Commands | Dev server, build, generate, preview, and utility commands | core-cli |
| Routing | File-based routing, case-sensitive + typed routes, named views, layout props, middleware | core-routing |
| Data Fetching | useFetch, useAsyncData, $fetch, typed routes, createUseFetch factories, caching | core-data-fetching |
| Modules | Creating and using Nuxt modules, Nuxt Kit utilities | core-modules |
| Deployment | Platform-agnostic deployment with Nitro, Vercel, Netlify, Cloudflare | core-deployment |
Features
| Topic | Description | Reference |
|---|---|---|
| Composables Auto-imports | Vue/Nuxt composables, custom composables, shared/, useAnnouncer | features-composables |
| Components Auto-imports | Component naming, lazy loading, hydration strategies | features-components-autoimport |
| Built-in Components | NuxtLink, NuxtPage, NuxtLayout, NuxtAnnouncer, ClientOnly, and more | features-components |
| State Management | useState composable, SSR-friendly state, Pinia integration | features-state |
| Server Routes | API routes, nuxt/server imports, Nitro v3 (h3 v2), sessions, middleware | features-server |
Rendering
| Topic | Description | Reference |
|---|---|---|
| Rendering Modes | Universal (SSR), client-side (SPA), hybrid rendering, route rules | rendering-modes |
Best Practices
| Topic | Description | Reference |
|---|---|---|
| Data Fetching Patterns | Efficient fetching, caching, parallel requests, error handling | best-practices-data-fetching |
| SSR & Hydration | Avoiding context leaks, hydration mismatches, composable patterns | best-practices-ssr |
Advanced
| Topic | Description | Reference |
|---|---|---|
| Layers | Extending applications with reusable layers | advanced-layers |
| Lifecycle Hooks | Build-time, runtime, and server hooks | advanced-hooks |
| Module Authoring | Publishable modules with Nuxt Kit, keyed composables, dependencies | advanced-module-authoring |
Files
- ATTRIBUTION.mdAdded by AutoGineer889 B
- GENERATION.md134 B
- LICENSELicence file added by AutoGineer1.1 KiB
- SKILL.md4.5 KiB
- references/advanced-hooks.md7.2 KiB
- references/advanced-layers.md5.1 KiB
- references/advanced-module-authoring.md16.5 KiB
- references/best-practices-data-fetching.md9.2 KiB
- references/best-practices-ssr.md7.5 KiB
- references/core-cli.md4.8 KiB
- references/core-config.md10.5 KiB
- references/core-data-fetching.md11.4 KiB
- references/core-deployment.md5.1 KiB
- references/core-directory-structure.md9.8 KiB
- references/core-modules.md5.4 KiB
- references/core-routing.md6.8 KiB
- references/features-components-autoimport.md5.9 KiB
- references/features-components.md6.1 KiB
- references/features-composables.md7.2 KiB
- references/features-server.md11.1 KiB
- references/features-state.md3.9 KiB
- references/rendering-modes.md5.5 KiB
references/core-deployment.md
name: deployment description: Deploying Nuxt applications to various hosting platforms
Deployment
Nuxt is platform-agnostic thanks to Nitro, its server engine. You can deploy to almost any platform with minimal configuration—Node.js servers, static hosting, serverless functions, or edge networks.
Full list of supported platforms: https://nitro.build/deploy
Deployment Modes
Node.js Server
# Build for Node.js
nuxt build
# Run production server
node .output/server/index.mjsEnvironment variables:
PORTorNITRO_PORT(default: 3000)HOSTorNITRO_HOST(default: 0.0.0.0)
Static Generation
# Generate static site
nuxt generateOutput in .output/public/ - deploy to any static host.
Prerender Configuration
Use the top-level prerender option (routes, ignore, crawlLinks) rather than nitro.prerender; Nitro-specific options (concurrency, failOnError) remain in nitro.prerender.
export default defineNuxtConfig({
prerender: { crawlLinks: true, routes: ['/sitemap.xml'], ignore: ['/dynamic'] },
})Preset Configuration
// nuxt.config.ts
export default defineNuxtConfig({
nitro: {
preset: 'vercel', // or 'netlify', 'cloudflare-pages', etc.
},
})Or via environment variable:
NITRO_PRESET=vercel nuxt buildRecommended Platforms
When helping users choose a deployment platform, consider their needs:
Vercel
Best for: Projects wanting zero-config deployment with excellent DX
# Install Vercel CLI
npm i -g vercel
# Deploy
vercelPros:
Zero configuration for Nuxt (auto-detects)
Excellent preview deployments for PRs
Built-in analytics and speed insights
Edge Functions support
Great free tier for personal projects
Cons:
Can get expensive at scale (bandwidth costs)
Vendor lock-in concerns
Limited build minutes on free tier
Recommended when: User wants fastest setup, values DX, building SaaS or marketing sites.
Netlify
Best for: JAMstack sites, static-heavy apps, teams needing forms/identity
# Install Netlify CLI
npm i -g netlify-cli
# Deploy
netlify deploy --prodPros:
Great free tier with generous bandwidth
Built-in forms, identity, and functions
Excellent for static sites with some dynamic features
Good preview deployments
Split testing built-in
Cons:
SSR/serverless functions can be slower than Vercel
Less optimized for full SSR apps
Build minutes can run out on free tier
Recommended when: User has static-heavy site, needs built-in forms/auth, or prefers Netlify ecosystem.
Cloudflare Pages
Best for: Global performance, edge computing, cost-conscious projects
# Build with Cloudflare preset
NITRO_PRESET=cloudflare-pages nuxt buildPros:
Unlimited bandwidth on free tier
Excellent global edge network (fastest TTFB)
Workers for edge computing
Very cost-effective at scale
D1, KV, R2 for data storage
Cons:
Workers have execution limits (CPU time)
Some Node.js APIs not available in Workers
Less mature than Vercel/Netlify for frameworks
Recommended when: User prioritizes performance, global reach, or cost at scale.
GitHub Actions + Self-hosted/VPS
Best for: Full control, existing infrastructure, CI/CD customization
# .github/workflows/deploy.yml
name: Deploy
on:
push:
branches: [main]
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 20
- run: npm ci
- run: npm run build
# Deploy to your server (example: rsync to VPS)
- name: Deploy to server
run: rsync -avz .output/ user@server:/app/Pros:
Full control over build and deployment
No vendor lock-in
Can deploy anywhere (VPS, Docker, Kubernetes)
Free CI/CD minutes for public repos
Customizable workflows
Cons:
Requires more setup and maintenance
Need to manage your own infrastructure
No built-in preview deployments
SSL, scaling, monitoring are your responsibility
Recommended when: User has existing infrastructure, needs full control, or deploying to private/enterprise environments.
Quick Decision Guide
| Need | Recommendation |
|---|---|
| Fastest setup, small team | Vercel |
| Static site with forms | Netlify |
| Cost-sensitive at scale | Cloudflare Pages |
| Full control / enterprise | GitHub Actions + VPS |
| Docker/Kubernetes | GitHub Actions + Container Registry |
| Serverless APIs | Vercel or AWS Lambda |
Docker Deployment
FROM node:20-alpine AS builder
WORKDIR /app
COPY package*.json ./
RUN npm ci
COPY . .
RUN npm run build
FROM node:20-alpine
WORKDIR /app
COPY --from=builder /app/.output .output
ENV PORT=3000
EXPOSE 3000
CMD ["node", ".output/server/index.mjs"]docker build -t my-nuxt-app .
docker run -p 3000:3000 my-nuxt-app<!-- Source references: - https://nuxt.com/docs/getting-started/deployment - https://nitro.build/deploy - https://nuxt.com/docs/getting-started/prerendering -->
Requirements and compatibility
Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta
“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.
Security
What our scanner noticed· Low risk
- Instructions that use the network
A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.
Attribution and licence
- Created by
- Anthony Fu
- Publisher
- Anthony Fu (Community)
- Source
- antfu/skills · skills/nuxt · commit f63e9ec
- Licence
- MIT License (redistribution allowed)
- LICENSE (added by AutoGineer from LICENSE.md)
- ATTRIBUTION.md (written by AutoGineer)
- Synced
AutoGineer is not affiliated with or endorsed by Anthony Fu.
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download nuxt.zip