Setting the file. One moment.
Subchapter 4.6
references/core-cli.mdMarkdown4 KBView on GitHub
Nuxt provides CLI commands via nuxi (or npx nuxt) for development, building, and project management.
# Interactive project creation
npx nuxi@latest init my-app
# With specific package manager
npx nuxi@latest init my-app --packageManager pnpm
# With modules
npx nuxi@latest init my-app --modules "@nuxt/ui,@nuxt/image"
# From template
npx nuxi@latest init my-app --template v3
# Skip module selection prompt
npx nuxi@latest init my-app --no-modulesOptions:
| Option | Description |
|---|---|
-t, --template | Template name |
--packageManager | npm, pnpm, yarn, or bun |
-M, --modules | Modules to install (comma-separated) |
--gitInit | Initialize git repository |
--no-install | Skip installing dependencies |
# Start development server (default: http://localhost:3000)
npx nuxt dev
# Custom port
npx nuxt dev --port 4000
# Open in browser
npx nuxt dev --open
# Listen on all interfaces (for mobile testing)
npx nuxt dev --host 0.0.0.0
# With HTTPS
npx nuxt dev --https
# Clear console on restart
npx nuxt dev --clear
# Create public tunnel
npx nuxt dev --tunnelOptions:
| Option | Description |
|---|---|
-p, --port | Port to listen on |
-h, --host | Host to listen on |
-o, --open | Open in browser |
--https | Enable HTTPS |
--tunnel | Create public tunnel (via untun) |
--qr | Show QR code for mobile |
--clear | Clear console on restart |
Environment Variables:
NUXT_PORT or PORT - Default portNUXT_HOST or HOST - Default host# Build for production
npx nuxt build
# Build with prerendering
npx nuxt build --prerender
# Build with specific preset
npx nuxt build --preset node-server
npx nuxt build --preset cloudflare-pages
npx nuxt build --preset vercel
# Build with environment
npx nuxt build --envName stagingOutput is created in .output/ directory.
# Generate static site (prerenders all routes)
npx nuxt generateEquivalent to nuxt build --prerender. Creates static HTML files for deployment to static hosting.
# Preview after build
npx nuxt preview
# Custom port
npx nuxt preview --port 4000# Generate TypeScript types and .nuxt directory
npx nuxt prepareRun after cloning or when types are missing.
# Run TypeScript type checking
npx nuxt typecheck# Analyze production bundle
npx nuxt analyzeOpens visual bundle analyzer.
# Remove generated files (.nuxt, .output, node_modules/.cache)
npx nuxt cleanup# Show environment info (useful for bug reports)
npx nuxt info# Upgrade Nuxt to latest version
npx nuxt upgrade
# Upgrade to nightly release
npx nuxt upgrade --nightly# Add a Nuxt module
npx nuxt module add @nuxt/ui
npx nuxt module add @nuxt/imageInstalls and adds to nuxt.config.ts.
# Build a Nuxt module
npx nuxt build-module# Enable DevTools globally
npx nuxt devtools enable
# Disable DevTools
npx nuxt devtools disable# Install dependencies and start dev
pnpm install
pnpm dev # or npx nuxt dev# Build and preview locally
pnpm build
pnpm preview
# Or for static hosting
pnpm generate# Install deps and prepare types
pnpm install
npx nuxt prepare# Development build
npx nuxt build --envName development
# Staging build
npx nuxt build --envName staging
# Production build (default)
npx nuxt build --envName productionCorresponds to $development, $env.staging, $production in nuxt.config.ts.
# Dev with additional layer
npx nuxt dev --extends ./base-layer
# Build with layer
npx nuxt build --extends ./base-layer