@nuxt/docs-nightly 4.3.0-29356103.2f7957ac → 4.3.0-29430576.f48ea4c8

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

@@ -1,47 +0,0 @@
----
-title: "nuxt build"
-description: "Build your Nuxt application."
-links:
-  - label: Source
-    icon: i-simple-icons-github
-    to: https://github.com/nuxt/cli/blob/main/packages/nuxi/src/commands/build.ts
-    size: xs
----
-
-<!--build-cmd-->
-```bash [Terminal]
-npx nuxt build [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--prerender] [--preset] [--dotenv] [--envName] [-e, --extends=<layer-name>]
-```
-<!--/build-cmd-->
-
-The `build` command creates a `.output` directory with all your application, server and dependencies ready for production.
-
-## Arguments
-
-<!--build-args-->
-Argument | Description
---- | ---
-`ROOTDIR="."` | Specifies the working directory (default: `.`)
-<!--/build-args-->
-
-## Options
-
-<!--build-opts-->
-Option | Default | Description
---- | --- | ---
-`--cwd=<directory>` |  | Specify the working directory, this takes precedence over ROOTDIR (default: `.`)
-`--logLevel=<silent\|info\|verbose>` |  | Specify build-time log level
-`--prerender` |  | Build Nuxt and prerender static routes
-`--preset` |  | Nitro server preset
-`--dotenv` |  | Path to `.env` file to load, relative to the root directory
-`--envName` |  | The environment to use when resolving configuration overrides (default is `production` when building, and `development` when running the dev server)
-`-e, --extends=<layer-name>` |  | Extend from a Nuxt layer
-<!--/build-opts-->
-
-::note
-This command sets `process.env.NODE_ENV` to `production`.
-::
-
-::note
-`--prerender` will always set the `preset` to `static`
-::

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

@@ -1,60 +0,0 @@
----
-title: 'nuxt dev'
-description: The dev command starts a development server with hot module replacement at http://localhost:3000
-links:
-  - label: Source
-    icon: i-simple-icons-github
-    to: https://github.com/nuxt/cli/blob/main/packages/nuxi/src/commands/dev.ts
-    size: xs
----
-
-<!--dev-cmd-->
-```bash [Terminal]
-npx nuxt dev [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--dotenv] [--envName] [-e, --extends=<layer-name>] [--clear] [--no-f, --no-fork] [-p, --port] [-h, --host] [--clipboard] [-o, --open] [--https] [--publicURL] [--qr] [--public] [--tunnel] [--sslCert] [--sslKey]
-```
-<!--/dev-cmd-->
-
-The `dev` command starts a development server with hot module replacement at [http://localhost:3000](https://localhost:3000)
-
-## Arguments
-
-<!--dev-args-->
-Argument | Description
---- | ---
-`ROOTDIR="."` | Specifies the working directory (default: `.`)
-<!--/dev-args-->
-
-## Options
-
-<!--dev-opts-->
-Option | Default | Description
---- | --- | ---
-`--cwd=<directory>` |  | Specify the working directory, this takes precedence over ROOTDIR (default: `.`)
-`--logLevel=<silent\|info\|verbose>` |  | Specify build-time log level
-`--dotenv` |  | Path to `.env` file to load, relative to the root directory
-`--envName` |  | The environment to use when resolving configuration overrides (default is `production` when building, and `development` when running the dev server)
-`-e, --extends=<layer-name>` |  | Extend from a Nuxt layer
-`--clear` | `false` | Clear console on restart
-`--no-f, --no-fork` |  | Disable forked mode
-`-p, --port` |  | Port to listen on (default: `NUXT_PORT \|\| NITRO_PORT \|\| PORT \|\| nuxtOptions.devServer.port`)
-`-h, --host` |  | Host to listen on (default: `NUXT_HOST \|\| NITRO_HOST \|\| HOST \|\| nuxtOptions.devServer?.host`)
-`--clipboard` | `false` | Copy the URL to the clipboard
-`-o, --open` | `false` | Open the URL in the browser
-`--https` |  | Enable HTTPS
-`--publicURL` |  | Displayed public URL (used for QR code)
-`--qr` |  | Display The QR code of public URL when available
-`--public` |  | Listen to all network interfaces
-`--tunnel` |  | Open a tunnel using https://github.com/unjs/untun
-`--sslCert` |  | (DEPRECATED) Use `--https.cert` instead.
-`--sslKey` |  | (DEPRECATED) Use `--https.key` instead.
-<!--/dev-opts-->
-
-The port and host can also be set via NUXT_PORT, PORT, NUXT_HOST or HOST environment variables.
-
-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`.
-
-::note
-If you are using a self-signed certificate in development, you will need to set `NODE_TLS_REJECT_UNAUTHORIZED=0` in your environment.
-::

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

@@ -1,42 +0,0 @@
----
-title: "nuxt generate"
-description: Pre-renders every route of the application and stores the result in plain HTML files.
-links:
-  - label: Source
-    icon: i-simple-icons-github
-    to: https://github.com/nuxt/cli/blob/main/packages/nuxi/src/commands/generate.ts
-    size: xs
----
-
-<!--generate-cmd-->
-```bash [Terminal]
-npx nuxt generate [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--preset] [--dotenv] [--envName] [-e, --extends=<layer-name>]
-```
-<!--/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 `nuxt build` command with the `prerender` argument set to `true`
-
-## Arguments
-
-<!--generate-args-->
-Argument | Description
---- | ---
-`ROOTDIR="."` | Specifies the working directory (default: `.`)
-<!--/generate-args-->
-
-## Options
-
-<!--generate-opts-->
-Option | Default | Description
---- | --- | ---
-`--cwd=<directory>` |  | Specify the working directory, this takes precedence over ROOTDIR (default: `.`)
-`--logLevel=<silent\|info\|verbose>` |  | Specify build-time log level
-`--preset` |  | Nitro server preset
-`--dotenv` |  | Path to `.env` file to load, relative to the root directory
-`--envName` |  | The environment to use when resolving configuration overrides (default is `production` when building, and `development` when running the dev server)
-`-e, --extends=<layer-name>` |  | Extend from a Nuxt layer
-<!--/generate-opts-->
-
-::read-more{to="/docs/4.x/getting-started/deployment#static-hosting"}
-Read more about pre-rendering and static hosting.
-::

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

@@ -1,33 +0,0 @@
----
-title: "nuxt info"
-description: The info command logs information about the current or specified Nuxt project.
-links:
-  - label: Source
-    icon: i-simple-icons-github
-    to: https://github.com/nuxt/cli/blob/main/packages/nuxi/src/commands/info.ts
-    size: xs
----
-
-<!--info-cmd-->
-```bash [Terminal]
-npx nuxt info [ROOTDIR] [--cwd=<directory>]
-```
-<!--/info-cmd-->
-
-The `info` command logs information about the current or specified Nuxt project.
-
-## Arguments
-
-<!--info-args-->
-Argument | Description
---- | ---
-`ROOTDIR="."` | Specifies the working directory (default: `.`)
-<!--/info-args-->
-
-## Options
-
-<!--info-opts-->
-Option | Default | Description
---- | --- | ---
-`--cwd=<directory>` |  | Specify the working directory, this takes precedence over ROOTDIR (default: `.`)
-<!--/info-opts-->

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

@@ -1,50 +0,0 @@
----
-title: "create nuxt"
-description: The init command initializes a fresh Nuxt project.
-links:
-  - label: Source
-    icon: i-simple-icons-github
-    to: https://github.com/nuxt/cli/blob/main/packages/nuxi/src/commands/init.ts
-    size: xs
----
-
-<!--init-cmd-->
-```bash [Terminal]
-npm create nuxt@latest [DIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [-t, --template] [-f, --force] [--offline] [--preferOffline] [--no-install] [--gitInit] [--shell] [--packageManager] [-M, --modules] [--no-modules] [--nightly]
-```
-<!--/init-cmd-->
-
-The `create-nuxt` command initializes a fresh Nuxt project using [unjs/giget](https://github.com/unjs/giget).
-
-## Arguments
-
-<!--init-args-->
-Argument | Description
---- | ---
-`DIR=""` | Project directory
-<!--/init-args-->
-
-## Options
-
-<!--init-opts-->
-Option | Default | Description
---- | --- | ---
-`--cwd=<directory>` | `.` | Specify the working directory
-`--logLevel=<silent\|info\|verbose>` |  | Specify build-time log level
-`-t, --template` |  | Template name
-`-f, --force` |  | Override existing directory
-`--offline` |  | Force offline mode
-`--preferOffline` |  | Prefer offline mode
-`--no-install` |  | Skip installing dependencies
-`--gitInit` |  | Initialize git repository
-`--shell` |  | Start shell after installation in project directory
-`--packageManager` |  | Package manager choice (npm, pnpm, yarn, bun)
-`-M, --modules` |  | Nuxt modules to install (comma separated without spaces)
-`--no-modules` |  | Skip module installation prompt
-`--nightly` |  | Use Nuxt nightly release channel (3x or latest)
-<!--/init-opts-->
-
-## Environment variables
-
-- `NUXI_INIT_REGISTRY`: Set to a custom template registry. ([learn more](https://github.com/unjs/giget#custom-registry)).
-  - Default registry is loaded from [nuxt/starter/templates](https://github.com/nuxt/starter/tree/templates/templates)

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

@@ -1,84 +0,0 @@
----
-title: "nuxt module"
-description: "Search and add modules to your Nuxt application with the command line."
-links:
-  - label: Source
-    icon: i-simple-icons-github
-    to: https://github.com/nuxt/cli/blob/main/packages/nuxi/src/commands/module/
-    size: xs
----
-
-Nuxt provides a few utilities to work with [Nuxt modules](/modules) seamlessly.
-
-## nuxt module add
-
-<!--module-add-cmd-->
-```bash [Terminal]
-npx nuxt module add <MODULENAME> [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--skipInstall] [--skipConfig] [--dev]
-```
-<!--/module-add-cmd-->
-
-<!--module-add-args-->
-Argument | Description
---- | ---
-`MODULENAME` | Specify one or more modules to install by name, separated by spaces
-<!--/module-add-args-->
-
-<!--module-add-opts-->
-Option | Default | Description
---- | --- | ---
-`--cwd=<directory>` | `.` | Specify the working directory
-`--logLevel=<silent\|info\|verbose>` |  | Specify build-time log level
-`--skipInstall` |  | Skip npm install
-`--skipConfig` |  | Skip nuxt.config.ts update
-`--dev` |  | Install modules as dev dependencies
-<!--/module-add-opts-->
-
-The command lets you install [Nuxt modules](/modules) in your application with no manual work.
-
-When running the command, it will:
-
-- install the module as a dependency using your package manager
-- add it to your [package.json](/docs/4.x/guide/directory-structure/package) file
-- update your [`nuxt.config`](/docs/4.x/guide/directory-structure/nuxt-config) file
-
-**Example:**
-
-Installing the [`Pinia`](/modules/pinia) module
-
-```bash [Terminal]
-npx nuxt module add pinia
-```
-
-## nuxt module search
-
-<!--module-search-cmd-->
-```bash [Terminal]
-npx nuxt module search <QUERY> [--cwd=<directory>] [--nuxtVersion=<2|3>]
-```
-<!--/module-search-cmd-->
-
-### Arguments
-
-<!--module-search-args-->
-Argument | Description
---- | ---
-`QUERY` | keywords to search for
-<!--/module-search-args-->
-
-### Options
-
-<!--module-search-opts-->
-Option | Default | Description
---- | --- | ---
-`--cwd=<directory>` | `.` | Specify the working directory
-`--nuxtVersion=<2\|3>` |  | Filter by Nuxt version and list compatible modules only (auto detected by default)
-<!--/module-search-opts-->
-
-The command searches for Nuxt modules matching your query that are compatible with your Nuxt version.
-
-**Example:**
-
-```bash [Terminal]
-npx nuxt module search pinia
-```

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

@@ -1,41 +0,0 @@
----
-title: 'nuxt prepare'
-description: The prepare command creates a .nuxt directory in your application and generates types.
-links:
-  - label: Source
-    icon: i-simple-icons-github
-    to: https://github.com/nuxt/cli/blob/main/packages/nuxi/src/commands/prepare.ts
-    size: xs
----
-
-<!--prepare-cmd-->
-```bash [Terminal]
-npx nuxt prepare [ROOTDIR] [--dotenv] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--envName] [-e, --extends=<layer-name>]
-```
-<!--/prepare-cmd-->
-
-The `prepare` command creates a [`.nuxt`](/docs/4.x/guide/directory-structure/nuxt) directory in your application and generates types. This can be useful in a CI environment or as a `postinstall` command in your [`package.json`](/docs/4.x/guide/directory-structure/package).
-
-## Arguments
-
-<!--prepare-args-->
-Argument | Description
---- | ---
-`ROOTDIR="."` | Specifies the working directory (default: `.`)
-<!--/prepare-args-->
-
-## Options
-
-<!--prepare-opts-->
-Option | Default | Description
---- | --- | ---
-`--dotenv` |  | Path to `.env` file to load, relative to the root directory
-`--cwd=<directory>` |  | Specify the working directory, this takes precedence over ROOTDIR (default: `.`)
-`--logLevel=<silent\|info\|verbose>` |  | Specify build-time log level
-`--envName` |  | The environment to use when resolving configuration overrides (default is `production` when building, and `development` when running the dev server)
-`-e, --extends=<layer-name>` |  | Extend from a Nuxt layer
-<!--/prepare-opts-->
-
-::note
-This command sets `process.env.NODE_ENV` to `production`.
-::

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

@@ -1,44 +0,0 @@
----
-title: "nuxt preview"
-description: The preview command starts a server to preview your application after the build command.
-links:
-  - label: Source
-    icon: i-simple-icons-github
-    to: https://github.com/nuxt/cli/blob/main/packages/nuxi/src/commands/preview.ts
-    size: xs
----
-
-<!--preview-cmd-->
-```bash [Terminal]
-npx nuxt preview [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--envName] [-e, --extends=<layer-name>] [-p, --port] [--dotenv]
-```
-<!--/preview-cmd-->
-
-The `preview` command starts a server to preview your Nuxt application after running the `build` command. The `start` command is an alias for `preview`. When running your application in production refer to the [Deployment section](/docs/4.x/getting-started/deployment).
-
-## Arguments
-
-<!--preview-args-->
-Argument | Description
---- | ---
-`ROOTDIR="."` | Specifies the working directory (default: `.`)
-<!--/preview-args-->
-
-## Options
-
-<!--preview-opts-->
-Option | Default | Description
---- | --- | ---
-`--cwd=<directory>` |  | Specify the working directory, this takes precedence over ROOTDIR (default: `.`)
-`--logLevel=<silent\|info\|verbose>` |  | Specify build-time log level
-`--envName` |  | The environment to use when resolving configuration overrides (default is `production` when building, and `development` when running the dev server)
-`-e, --extends=<layer-name>` |  | Extend from a Nuxt layer
-`-p, --port` |  | Port to listen on (use `PORT` environment variable to override)
-`--dotenv` |  | Path to `.env` file to load, relative to the root directory
-<!--/preview-opts-->
-
-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/4.x/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/test.md

@@ -1,40 +0,0 @@
----
-title: "nuxt test"
-description: The test command runs tests using @nuxt/test-utils.
-links:
-  - label: Source
-    icon: i-simple-icons-github
-    to: https://github.com/nuxt/cli/blob/main/packages/nuxi/src/commands/test.ts
-    size: xs
----
-
-<!--test-cmd-->
-```bash [Terminal]
-npx nuxt test [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--dev] [--watch]
-```
-<!--/test-cmd-->
-
-The `test` command runs tests using [`@nuxt/test-utils`](/docs/getting-started/testing). This command sets `process.env.NODE_ENV` to `test` if not already set.
-
-## Arguments
-
-<!--test-args-->
-Argument | Description
---- | ---
-`ROOTDIR="."` | Specifies the working directory (default: `.`)
-<!--/test-args-->
-
-## Options
-
-<!--test-opts-->
-Option | Default | Description
---- | --- | ---
-`--cwd=<directory>` |  | Specify the working directory, this takes precedence over ROOTDIR (default: `.`)
-`--logLevel=<silent\|info\|verbose>` |  | Specify build-time log level
-`--dev` |  | Run in dev mode
-`--watch` |  | Watch mode
-<!--/test-opts-->
-
-::note
-This command sets `process.env.NODE_ENV` to `test`.
-::

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

@@ -1,44 +0,0 @@
----
-title: "nuxt typecheck"
-description: The typecheck command runs vue-tsc to check types throughout your app.
-links:
-  - label: Source
-    icon: i-simple-icons-github
-    to: https://github.com/nuxt/cli/blob/main/packages/nuxi/src/commands/typecheck.ts
-    size: xs
----
-
-<!--typecheck-cmd-->
-```bash [Terminal]
-npx nuxt typecheck [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--dotenv] [-e, --extends=<layer-name>]
-```
-<!--/typecheck-cmd-->
-
-The `typecheck` command runs [`vue-tsc`](https://github.com/vuejs/language-tools/tree/master/packages/tsc) to check types throughout your app.
-
-## Arguments
-
-<!--typecheck-args-->
-Argument | Description
---- | ---
-`ROOTDIR="."` | Specifies the working directory (default: `.`)
-<!--/typecheck-args-->
-
-## Options
-
-<!--typecheck-opts-->
-Option | Default | Description
---- | --- | ---
-`--cwd=<directory>` |  | Specify the working directory, this takes precedence over ROOTDIR (default: `.`)
-`--logLevel=<silent\|info\|verbose>` |  | Specify build-time log level
-`--dotenv` |  | Path to `.env` file to load, relative to the root directory
-`-e, --extends=<layer-name>` |  | Extend from a Nuxt layer
-<!--/typecheck-opts-->
-
-::note
-This command sets `process.env.NODE_ENV` to `production`. To override, define `NODE_ENV` in a [`.env`](/docs/4.x/guide/directory-structure/env) file or as a command-line argument.
-::
-
-::read-more{to="/docs/4.x/guide/concepts/typescript#type-checking"}
-Read more on how to enable type-checking at build or development time.
-::

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

@@ -1,37 +0,0 @@
----
-title: "nuxt upgrade"
-description: The upgrade command upgrades Nuxt to the latest version.
-links:
-  - label: Source
-    icon: i-simple-icons-github
-    to: https://github.com/nuxt/cli/blob/main/packages/nuxi/src/commands/upgrade.ts
-    size: xs
----
-
-<!--upgrade-cmd-->
-```bash [Terminal]
-npx nuxt upgrade [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--dedupe] [-f, --force] [-ch, --channel=<stable|nightly|v3|v4|v4-nightly|v3-nightly>]
-```
-<!--/upgrade-cmd-->
-
-The `upgrade` command upgrades Nuxt to the latest version.
-
-## Arguments
-
-<!--upgrade-args-->
-Argument | Description
---- | ---
-`ROOTDIR="."` | Specifies the working directory (default: `.`)
-<!--/upgrade-args-->
-
-## Options
-
-<!--upgrade-opts-->
-Option | Default | Description
---- | --- | ---
-`--cwd=<directory>` |  | Specify the working directory, this takes precedence over ROOTDIR (default: `.`)
-`--logLevel=<silent\|info\|verbose>` |  | Specify build-time log level
-`--dedupe` |  | Dedupe dependencies after upgrading
-`-f, --force` |  | Force upgrade to recreate lockfile and node_modules
-`-ch, --channel=<stable\|nightly\|v3\|v4\|v4-nightly\|v3-nightly>` | `stable` | Specify a channel to install from (default: stable)
-<!--/upgrade-opts-->