@nuxt/docs 3.17.4 → 4.0.0-alpha.1

package/3.api/2.composables/use-preview-mode.md

@@ -103,8 +103,8 @@ const { data } = await useFetch('/api/preview', {
 Now you can generate your site and serve it:
 
 ```bash [Terminal]
-npx nuxi generate
-npx nuxi preview
+npx nuxt generate
+npx nuxt preview
 ```
 
 Then you can see your preview page by adding the query param `preview` to the end of the page you want to see once:
@@ -114,5 +114,5 @@ Then you can see your preview page by adding the query param `preview` to the en
 ```
 
 ::note
-`usePreviewMode` should be tested locally with `nuxi generate` and then `nuxi preview` rather than `nuxi dev`. (The [preview command](/docs/api/commands/preview) is not related to preview mode.)
+`usePreviewMode` should be tested locally with `nuxt generate` and then `nuxt preview` rather than `nuxt dev`. (The [preview command](/docs/api/commands/preview) is not related to preview mode.)
 ::

package/3.api/4.commands/add.md

@@ -1,5 +1,5 @@
 ---
-title: "nuxi add"
+title: "nuxt add"
 description: "Scaffold an entity into your Nuxt application."
 links:
   - label: Source
@@ -10,7 +10,7 @@ links:
 
 <!--add-cmd-->
 ```bash [Terminal]
-npx nuxi add <TEMPLATE> <NAME> [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--force]
+npx nuxt add <TEMPLATE> <NAME> [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--force]
 ```
 <!--/add-cmd-->
 
@@ -39,74 +39,74 @@ Some templates support additional modifier flags to add a suffix (like `.client`
 
 ```bash [Terminal]
 # Generates `/plugins/sockets.client.ts`
-npx nuxi add plugin sockets --client
+npx nuxt add plugin sockets --client
 ```
 
-## `nuxi add component`
+## `nuxt add component`
 
 * Modifier flags: `--mode client|server` or `--client` or `--server`
 
 ```bash [Terminal]
 # Generates `components/TheHeader.vue`
-npx nuxi add component TheHeader
+npx nuxt add component TheHeader
 ```
 
-## `nuxi add composable`
+## `nuxt add composable`
 
 ```bash [Terminal]
 # Generates `composables/foo.ts`
-npx nuxi add composable foo
+npx nuxt add composable foo
 ```
 
-## `nuxi add layout`
+## `nuxt add layout`
 
 ```bash [Terminal]
 # Generates `layouts/custom.vue`
-npx nuxi add layout custom
+npx nuxt add layout custom
 ```
 
-## `nuxi add plugin`
+## `nuxt add plugin`
 
 * Modifier flags: `--mode client|server` or `--client`or `--server`
 
 ```bash [Terminal]
 # Generates `plugins/analytics.ts`
-npx nuxi add plugin analytics
+npx nuxt add plugin analytics
 ```
 
-## `nuxi add page`
+## `nuxt add page`
 
 ```bash [Terminal]
 # Generates `pages/about.vue`
-npx nuxi add page about
+npx nuxt add page about
 ```
 
 ```bash [Terminal]
 # Generates `pages/category/[id].vue`
-npx nuxi add page "category/[id]"
+npx nuxt add page "category/[id]"
 ```
 
-## `nuxi add middleware`
+## `nuxt add middleware`
 
 * Modifier flags: `--global`
 
 ```bash [Terminal]
 # Generates `middleware/auth.ts`
-npx nuxi add middleware auth
+npx nuxt add middleware auth
 ```
 
-## `nuxi add api`
+## `nuxt add api`
 
 * Modifier flags: `--method` (can accept `connect`, `delete`, `get`, `head`, `options`, `patch`, `post`, `put` or `trace`) or alternatively you can directly use `--get`, `--post`, etc.
 
 ```bash [Terminal]
 # Generates `server/api/hello.ts`
-npx nuxi add api hello
+npx nuxt add api hello
 ```
 
-## `nuxi add layer`
+## `nuxt add layer`
 
 ```bash [Terminal]
 # Generates `layers/subscribe/nuxt.config.ts`
-npx nuxi add layer subscribe
+npx nuxt add layer subscribe
 ```

package/3.api/4.commands/analyze.md

@@ -1,5 +1,5 @@
 ---
-title: "nuxi analyze"
+title: "nuxt analyze"
 description: "Analyze the production bundle or your Nuxt application."
 links:
   - label: Source
@@ -10,7 +10,7 @@ links:
 
 <!--analyze-cmd-->
 ```bash [Terminal]
-npx nuxi analyze [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--dotenv] [--name=<name>] [--no-serve]
+npx nuxt analyze [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--dotenv] [--name=<name>] [--no-serve]
 ```
 <!--/analyze-cmd-->
 

package/3.api/4.commands/build-module.md

@@ -1,5 +1,5 @@
 ---
-title: 'nuxi build-module'
+title: 'nuxt build-module'
 description: 'Nuxt command to build your Nuxt module before publishing.'
 links:
   - label: Source
@@ -10,7 +10,7 @@ links:
 
 <!--build-module-cmd-->
 ```bash [Terminal]
-npx nuxi build-module [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--build] [--stub] [--sourcemap] [--prepare]
+npx nuxt build-module [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--build] [--stub] [--sourcemap] [--prepare]
 ```
 <!--/build-module-cmd-->
 

package/3.api/4.commands/build.md

@@ -1,5 +1,5 @@
 ---
-title: "nuxi build"
+title: "nuxt build"
 description: "Build your Nuxt application."
 links:
   - label: Source
@@ -10,7 +10,7 @@ links:
 
 <!--build-cmd-->
 ```bash [Terminal]
-npx nuxi build [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--prerender] [--preset] [--dotenv] [--envName]
+npx nuxt build [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--prerender] [--preset] [--dotenv] [--envName]
 ```
 <!--/build-cmd-->
 

package/3.api/4.commands/cleanup.md

@@ -1,5 +1,5 @@
 ---
-title: 'nuxi cleanup'
+title: 'nuxt cleanup'
 description: 'Remove common generated Nuxt files and caches.'
 links:
   - label: Source
@@ -10,7 +10,7 @@ links:
 
 <!--cleanup-cmd-->
 ```bash [Terminal]
-npx nuxi cleanup [ROOTDIR] [--cwd=<directory>]
+npx nuxt cleanup [ROOTDIR] [--cwd=<directory>]
 ```
 <!--/cleanup-cmd-->
 

package/3.api/4.commands/dev.md

@@ -1,5 +1,5 @@
 ---
-title: 'nuxi dev'
+title: 'nuxt dev'
 description: The dev command starts a development server with hot module replacement at http://localhost:3000
 links:
   - label: Source
@@ -10,7 +10,7 @@ links:
 
 <!--dev-cmd-->
 ```bash [Terminal]
-npx nuxi dev [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--dotenv] [--envName] [--no-clear] [--no-fork] [-p, --port] [-h, --host] [--clipboard] [-o, --open] [--https] [--publicURL] [--qr] [--public] [--tunnel] [--sslCert] [--sslKey]
+npx nuxt dev [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--dotenv] [--envName] [--no-clear] [--no-fork] [-p, --port] [-h, --host] [--clipboard] [-o, --open] [--https] [--publicURL] [--qr] [--public] [--tunnel] [--sslCert] [--sslKey]
 ```
 <!--/dev-cmd-->
 
@@ -50,7 +50,7 @@ Option | Default | Description
 
 The port and host can also be set via NUXT_PORT, PORT, NUXT_HOST or HOST environment variables.
 
-Additionally to the above options, `nuxi` can pass options through to `listhen`, e.g. `--no-qr` to turn off the dev server QR code. You can find the list of `listhen` options in the [unjs/listhen](https://github.com/unjs/listhen) docs.
+Additionally to the above options, `@nuxt/cli` can pass options through to `listhen`, e.g. `--no-qr` to turn off the dev server QR code. You can find the list of `listhen` options in the [unjs/listhen](https://github.com/unjs/listhen) docs.
 
 This command sets `process.env.NODE_ENV` to `development`.
 

package/3.api/4.commands/devtools.md

@@ -1,5 +1,5 @@
 ---
-title: "nuxi devtools"
+title: "nuxt devtools"
 description: The devtools command allows you to enable or disable Nuxt DevTools on a per-project basis.
 links:
   - label: Source
@@ -10,11 +10,11 @@ links:
 
 <!--devtools-cmd-->
 ```bash [Terminal]
-npx nuxi devtools <COMMAND> [ROOTDIR] [--cwd=<directory>]
+npx nuxt devtools <COMMAND> [ROOTDIR] [--cwd=<directory>]
 ```
 <!--/devtools-cmd-->
 
-Running `nuxi devtools enable` will install the Nuxt DevTools globally, and also enable it within the particular project you are using. It is saved as a preference in your user-level `.nuxtrc`. If you want to remove devtools support for a particular project, you can run `nuxi devtools disable`.
+Running `nuxt devtools enable` will install the Nuxt DevTools globally, and also enable it within the particular project you are using. It is saved as a preference in your user-level `.nuxtrc`. If you want to remove devtools support for a particular project, you can run `nuxt devtools disable`.
 
 ## Arguments
 

package/3.api/4.commands/generate.md

@@ -1,5 +1,5 @@
 ---
-title: "nuxi generate"
+title: "nuxt generate"
 description: Pre-renders every route of the application and stores the result in plain HTML files.
 links:
   - label: Source
@@ -10,11 +10,11 @@ links:
 
 <!--generate-cmd-->
 ```bash [Terminal]
-npx nuxi generate [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--preset] [--dotenv] [--envName]
+npx nuxt generate [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--preset] [--dotenv] [--envName]
 ```
 <!--/generate-cmd-->
 
-The `generate` command pre-renders every route of your application and stores the result in plain HTML files that you can deploy on any static hosting services. The command triggers the `nuxi build` command with the `prerender` argument set to `true`
+The `generate` command pre-renders every route of your application and stores the result in plain HTML files that you can deploy on any static hosting services. The command triggers the `nuxt build` command with the `prerender` argument set to `true`
 
 ## Arguments
 

package/3.api/4.commands/info.md

@@ -1,5 +1,5 @@
 ---
-title: "nuxi info"
+title: "nuxt info"
 description: The info command logs information about the current or specified Nuxt project.
 links:
   - label: Source
@@ -10,7 +10,7 @@ links:
 
 <!--info-cmd-->
 ```bash [Terminal]
-npx nuxi info [ROOTDIR] [--cwd=<directory>]
+npx nuxt info [ROOTDIR] [--cwd=<directory>]
 ```
 <!--/info-cmd-->
 

package/3.api/4.commands/init.md

@@ -1,5 +1,5 @@
 ---
-title: "nuxi init"
+title: "create nuxt"
 description: The init command initializes a fresh Nuxt project.
 links:
   - label: Source
@@ -10,11 +10,11 @@ links:
 
 <!--init-cmd-->
 ```bash [Terminal]
-npx nuxi init [DIR] [--cwd=<directory>] [-t, --template] [-f, --force] [--offline] [--preferOffline] [--no-install] [--gitInit] [--shell] [--packageManager]
+npm create nuxt@latest [DIR] [--cwd=<directory>] [-t, --template] [-f, --force] [--offline] [--preferOffline] [--no-install] [--gitInit] [--shell] [--packageManager]
 ```
 <!--/init-cmd-->
 
-The `init` command initializes a fresh Nuxt project using [unjs/giget](https://github.com/unjs/giget).
+The `create-nuxt` command initializes a fresh Nuxt project using [unjs/giget](https://github.com/unjs/giget).
 
 ## Arguments
 

package/3.api/4.commands/module.md

@@ -1,5 +1,5 @@
 ---
-title: "nuxi module"
+title: "nuxt module"
 description: "Search and add modules to your Nuxt application with the command line."
 links:
   - label: Source
@@ -8,13 +8,13 @@ links:
     size: xs
 ---
 
-Nuxi provides a few utilities to work with [Nuxt modules](/modules) seamlessly.
+Nuxt provides a few utilities to work with [Nuxt modules](/modules) seamlessly.
 
-## nuxi module add
+## nuxt module add
 
 <!--module-add-cmd-->
 ```bash [Terminal]
-npx nuxi module add <MODULENAME> [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--skipInstall] [--skipConfig] [--dev]
+npx nuxt module add <MODULENAME> [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--skipInstall] [--skipConfig] [--dev]
 ```
 <!--/module-add-cmd-->
 
@@ -47,14 +47,14 @@ When running the command, it will:
 Installing the [`Pinia`](/modules/pinia) module
 
 ```bash [Terminal]
-npx nuxi module add pinia
+npx nuxt module add pinia
 ```
 
-## nuxi module search
+## nuxt module search
 
 <!--module-search-cmd-->
 ```bash [Terminal]
-npx nuxi module search <QUERY> [--cwd=<directory>] [--nuxtVersion=<2|3>]
+npx nuxt module search <QUERY> [--cwd=<directory>] [--nuxtVersion=<2|3>]
 ```
 <!--/module-search-cmd-->
 
@@ -80,5 +80,5 @@ The command searches for Nuxt modules matching your query that are compatible wi
 **Example:**
 
 ```bash [Terminal]
-npx nuxi module search pinia
+npx nuxt module search pinia
 ```

package/3.api/4.commands/prepare.md

@@ -1,5 +1,5 @@
 ---
-title: 'nuxi prepare'
+title: 'nuxt prepare'
 description: The prepare command creates a .nuxt directory in your application and generates types.
 links:
   - label: Source
@@ -10,7 +10,7 @@ links:
 
 <!--prepare-cmd-->
 ```bash [Terminal]
-npx nuxi prepare [ROOTDIR] [--dotenv] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--envName]
+npx nuxt prepare [ROOTDIR] [--dotenv] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--envName]
 ```
 <!--/prepare-cmd-->
 

package/3.api/4.commands/preview.md

@@ -1,5 +1,5 @@
 ---
-title: "nuxi preview"
+title: "nuxt preview"
 description: The preview command starts a server to preview your application after the build command.
 links:
   - label: Source
@@ -10,7 +10,7 @@ links:
 
 <!--preview-cmd-->
 ```bash [Terminal]
-npx nuxi preview [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--envName] [--dotenv] [-p, --port]
+npx nuxt preview [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--envName] [--dotenv] [-p, --port]
 ```
 <!--/preview-cmd-->
 
@@ -39,5 +39,5 @@ Option | Default | Description
 This command sets `process.env.NODE_ENV` to `production`. To override, define `NODE_ENV` in a `.env` file or as command-line argument.
 
 ::note
-For convenience, in preview mode, your [`.env`](/docs/guide/directory-structure/env) file will be loaded into `process.env`. (However, in production you will need to ensure your environment variables are set yourself.)
+For convenience, in preview mode, your [`.env`](/docs/guide/directory-structure/env) file will be loaded into `process.env`. (However, in production you will need to ensure your environment variables are set yourself. For example, with Node.js 20+ you could do this by running `node --env-file .env .output/server/index.mjs` to start your server.)
 ::

package/3.api/4.commands/typecheck.md

@@ -1,5 +1,5 @@
 ---
-title: "nuxi typecheck"
+title: "nuxt typecheck"
 description: The typecheck command runs vue-tsc to check types throughout your app.
 links:
   - label: Source
@@ -10,7 +10,7 @@ links:
 
 <!--typecheck-cmd-->
 ```bash [Terminal]
-npx nuxi typecheck [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>]
+npx nuxt typecheck [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>]
 ```
 <!--/typecheck-cmd-->
 

package/3.api/4.commands/upgrade.md

@@ -1,5 +1,5 @@
 ---
-title: "nuxi upgrade"
+title: "nuxt upgrade"
 description: The upgrade command upgrades Nuxt to the latest version.
 links:
   - label: Source
@@ -10,7 +10,7 @@ links:
 
 <!--upgrade-cmd-->
 ```bash [Terminal]
-npx nuxi upgrade [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--dedupe] [-f, --force] [-ch, --channel=<stable|nightly>]
+npx nuxt upgrade [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--dedupe] [-f, --force] [-ch, --channel=<stable|nightly>]
 ```
 <!--/upgrade-cmd-->
 

package/3.api/5.kit/11.nitro.md

@@ -117,7 +117,7 @@ export default defineNuxtModule({
 
 ```ts twoslash
 // @errors: 2391
-import type { NitroDevEventHandler } from 'nitropack'
+import type { NitroDevEventHandler } from 'nitropack/types'
 // ---cut---
 function addDevServerHandler (handler: NitroDevEventHandler): void
 ```

package/3.api/5.kit/7.pages.md

@@ -149,7 +149,7 @@ export default defineNuxtModule({
 
     addRouteMiddleware({
       name: 'auth',
-      path: resolve('runtime/auth.ts'),
+      path: resolve('runtime/auth'),
       global: true,
     }, { prepend: true })
   },

package/3.api/6.advanced/1.hooks.md

@@ -68,7 +68,7 @@ Hook                     | Arguments                  | Description
 `nitro:build:public-assets`     | `nitro`                    | Called after copying public assets. Allows modifying public assets before Nitro server is built.
 `prerender:routes`       | `ctx`                      | Allows extending the routes to be pre-rendered.
 `build:error`            | `error`                    | Called when an error occurs at build time.
-`prepare:types`          | `options`                  | Called before Nuxi writes `.nuxt/tsconfig.json` and `.nuxt/nuxt.d.ts`, allowing addition of custom references and declarations in `nuxt.d.ts`, or directly modifying the options in `tsconfig.json`
+`prepare:types`          | `options`                  | Called before `@nuxt/cli` writes `.nuxt/tsconfig.json` and `.nuxt/nuxt.d.ts`, allowing addition of custom references and declarations in `nuxt.d.ts`, or directly modifying the options in `tsconfig.json`
 `listen`                 | `listenerServer, listener` | Called when the dev server is loading.
 `schema:extend`          | `schemas`                  | Allows extending default schemas.
 `schema:resolved`        | `schema`                   | Allows extending resolved schema.