Loading source
Pulling the file list, source metadata, and syntax-aware rendering for this listing.
Source from repo
Comprehensive Nuxt 3.x reference covering SSR, file-based routing, auto-imports, server routes, and Nitro deployment.
Files
Skill
Size
Entrypoint
Format
Open file
Syntax-highlighted preview of this file as included in the skill package.
references/core-cli.md
1---2name: cli-commands3description: Nuxt CLI commands for development, building, and project management4---5# CLI Commands7Nuxt provides CLI commands via `nuxi` (or `npx nuxt`) for development, building, and project management.9## Project Initialization11### Create New Project13```bash15# Interactive project creation16npx nuxi@latest init my-app17# With specific package manager19npx nuxi@latest init my-app --packageManager pnpm20# With modules22npx nuxi@latest init my-app --modules "@nuxt/ui,@nuxt/image"23# From template25npx nuxi@latest init my-app --template v326# Skip module selection prompt28npx nuxi@latest init my-app --no-modules29```30**Options:**32| Option | Description |33|--------|-------------|34| `-t, --template` | Template name |35| `--packageManager` | npm, pnpm, yarn, or bun |36| `-M, --modules` | Modules to install (comma-separated) |37| `--gitInit` | Initialize git repository |38| `--no-install` | Skip installing dependencies |39## Development41### Start Dev Server43```bash45# Start development server (default: http://localhost:3000)46npx nuxt dev47# Custom port49npx nuxt dev --port 400050# Open in browser52npx nuxt dev --open53# Listen on all interfaces (for mobile testing)55npx nuxt dev --host 0.0.0.056# With HTTPS58npx nuxt dev --https59# Clear console on restart61npx nuxt dev --clear62# Create public tunnel64npx nuxt dev --tunnel65```66**Options:**68| Option | Description |69|--------|-------------|70| `-p, --port` | Port to listen on |71| `-h, --host` | Host to listen on |72| `-o, --open` | Open in browser |73| `--https` | Enable HTTPS |74| `--tunnel` | Create public tunnel (via untun) |75| `--qr` | Show QR code for mobile |76| `--clear` | Clear console on restart |77**Environment Variables:**79- `NUXT_PORT` or `PORT` - Default port80- `NUXT_HOST` or `HOST` - Default host81## Building83### Production Build85```bash87# Build for production88npx nuxt build89# Build with prerendering91npx nuxt build --prerender92# Build with specific preset94npx nuxt build --preset node-server95npx nuxt build --preset cloudflare-pages96npx nuxt build --preset vercel97# Build with environment99npx nuxt build --envName staging100```101Output is created in `.output/` directory.103### Static Generation105```bash107# Generate static site (prerenders all routes)108npx nuxt generate109```110Equivalent to `nuxt build --prerender`. Creates static HTML files for deployment to static hosting.112### Preview Production Build114```bash116# Preview after build117npx nuxt preview118# Custom port120npx nuxt preview --port 4000121```122## Utilities124### Prepare (Type Generation)126```bash128# Generate TypeScript types and .nuxt directory129npx nuxt prepare130```131Run after cloning or when types are missing.133### Type Check135```bash137# Run TypeScript type checking138npx nuxt typecheck139```140### Analyze Bundle142```bash144# Analyze production bundle145npx nuxt analyze146```147Opens visual bundle analyzer.149### Cleanup151```bash153# Remove generated files (.nuxt, .output, node_modules/.cache)154npx nuxt cleanup155```156### Info158```bash160# Show environment info (useful for bug reports)161npx nuxt info162```163### Upgrade165```bash167# Upgrade Nuxt to latest version168npx nuxt upgrade169# Upgrade to nightly release171npx nuxt upgrade --nightly172```173## Module Commands175### Add Module177```bash179# Add a Nuxt module180npx nuxt module add @nuxt/ui181npx nuxt module add @nuxt/image182```183Installs and adds to `nuxt.config.ts`.185### Build Module (for module authors)187```bash189# Build a Nuxt module190npx nuxt build-module191```192## DevTools194```bash196# Enable DevTools globally197npx nuxt devtools enable198# Disable DevTools200npx nuxt devtools disable201```202## Common Workflows204### Development206```bash208# Install dependencies and start dev209pnpm install210pnpm dev # or npx nuxt dev211```212### Production Deployment214```bash216# Build and preview locally217pnpm build218pnpm preview219# Or for static hosting221pnpm generate222```223### After Cloning225```bash227# Install deps and prepare types228pnpm install229npx nuxt prepare230```231## Environment-specific Builds233```bash235# Development build236npx nuxt build --envName development237# Staging build239npx nuxt build --envName staging240# Production build (default)242npx nuxt build --envName production243```244Corresponds to `$development`, `$env.staging`, `$production` in `nuxt.config.ts`.246## Layer Extension248```bash250# Dev with additional layer251npx nuxt dev --extends ./base-layer252# Build with layer254npx nuxt build --extends ./base-layer255```256<!--258Source references:259- https://nuxt.com/docs/api/commands/dev260- https://nuxt.com/docs/api/commands/build261- https://nuxt.com/docs/api/commands/generate262- https://nuxt.com/docs/api/commands/init263-->264