@nuxt/docs 3.20.1 → 3.21.0

package/3.api/2.composables/use-cookie.md

@@ -1,183 +0,0 @@
----
-title: 'useCookie'
-description: useCookie is an SSR-friendly composable to read and write cookies.
-links:
-  - label: Source
-    icon: i-simple-icons-github
-    to: https://github.com/nuxt/nuxt/blob/main/packages/nuxt/src/app/composables/cookie.ts
-    size: xs
----
-
-## Usage
-
-Within your pages, components, and plugins, you can use `useCookie` to read and write cookies in an SSR-friendly way.
-
-```ts
-const cookie = useCookie(name, options)
-```
-
-::note
-`useCookie` only works in the [Nuxt context](/docs/3.x/guide/going-further/nuxt-app#the-nuxt-context).
-::
-
-::tip
-The returned ref will automatically serialize and deserialize cookie values to JSON.
-::
-
-## Type
-
-```ts [Signature]
-import type { Ref } from 'vue'
-import type { CookieParseOptions, CookieSerializeOptions } from 'cookie-es'
-
-export interface CookieOptions<T = any> extends Omit<CookieSerializeOptions & CookieParseOptions, 'decode' | 'encode'> {
-  decode?(value: string): T
-  encode?(value: T): string
-  default?: () => T | Ref<T>
-  watch?: boolean | 'shallow'
-  readonly?: boolean
-}
-
-export interface CookieRef<T> extends Ref<T> {}
-
-export function useCookie<T = string | null | undefined> (
-  name: string,
-  options?: CookieOptions<T>,
-): CookieRef<T>
-```
-
-## Parameters
-
-`name`: The name of the cookie.
-
-`options`: Options to control cookie behavior. The object can have the following properties:
-
-Most of the options will be directly passed to the [cookie](https://github.com/jshttp/cookie) package.
-
-| Property | Type | Default | Description |
-| --- | --- | --- | --- |
-| `decode` | `(value: string) => T` | `decodeURIComponent` + [destr](https://github.com/unjs/destr). | Custom function to decode the cookie value.  Since the value of a cookie has a limited character set (and must be a simple string), this function can be used to decode a previously encoded cookie value into a JavaScript string or other object. <br/> **Note:** If an error is thrown from this function, the original, non-decoded cookie value will be returned as the cookie's value. |
-| `encode` | `(value: T) => string` | `JSON.stringify` + `encodeURIComponent` | Custom function to encode the cookie value. Since the value of a cookie has a limited character set (and must be a simple string), this function can be used to encode a value into a string suited for a cookie's value. |
-| `default` | `() => T \| Ref<T>` | `undefined` | Function returning the default value if the cookie does not exist.  The function can also return a `Ref`. |
-| `watch` | `boolean \| 'shallow'` | `true`  | Whether to watch for changes and update the cookie. `true` for deep watch, `'shallow'` for shallow watch, i.e. data changes for only top level properties, `false` to disable. <br/> **Note:** Refresh `useCookie` values manually when a cookie has changed with [`refreshCookie`](/docs/3.x/api/utils/refresh-cookie). |
-| `readonly` | `boolean` | `false` | If `true`, disables writing to the cookie. |
-| `maxAge` | `number` | `undefined` | Max age in seconds for the cookie, i.e. the value for the [`Max-Age` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.2). The given number will be converted to an integer by rounding down. By default, no maximum age is set. |
-| `expires` | `Date` | `undefined` | Expiration date for the cookie. By default, no expiration is set. Most clients will consider this a "non-persistent cookie" and will delete it on a condition like exiting a web browser application. <br/> **Note:** The [cookie storage model specification](https://tools.ietf.org/html/rfc6265#section-5.3) states that if both `expires` and `maxAge` is set, then `maxAge` takes precedence, but not all clients may obey this, so if both are set, they should point to the same date and time! <br/>If neither of `expires` and `maxAge` is set, the cookie will be session-only and removed when the user closes their browser. |
-| `httpOnly` | `boolean` | `false` | Sets the HttpOnly attribute. <br/> **Note:** Be careful when setting this to `true`, as compliant clients will not allow client-side JavaScript to see the cookie in `document.cookie`. |
-| `secure` | `boolean` | `false` | Sets the [`Secure` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.5). <br/>**Note:** Be careful when setting this to `true`, as compliant clients will not send the cookie back to the server in the future if the browser does not have an HTTPS connection. This can lead to hydration errors. |
-| `partitioned` | `boolean` | `false` | Sets the [`Partitioned` `Set-Cookie` attribute](https://datatracker.ietf.org/doc/html/draft-cutler-httpbis-partitioned-cookies#section-2.1). <br/>**Note:** This is an attribute that has not yet been fully standardized, and may change in the future. <br/>This also means many clients may ignore this attribute until they understand it.<br/>More information can be found in the [proposal](https://github.com/privacycg/CHIPS). |
-| `domain` | `string` | `undefined` | Sets the [`Domain` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.3). By default, no domain is set, and most clients will consider applying the cookie only to the current domain. |
-| `path` | `string` | `'/'` | Sets the [`Path` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.4). By default, the path is considered the ["default path"](https://tools.ietf.org/html/rfc6265#section-5.1.4). |
-| `sameSite` | `boolean \| string` | `undefined` | Sets the [`SameSite` `Set-Cookie` attribute](https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-03#section-4.1.2.7). <br/>- `true` will set the `SameSite` attribute to `Strict` for strict same-site enforcement.<br/>- `false` will not set the `SameSite` attribute.<br/>- `'lax'` will set the `SameSite` attribute to `Lax` for lax same-site enforcement.<br/>- `'none'` will set the `SameSite` attribute to `None` for an explicit cross-site cookie.<br/>- `'strict'` will set the `SameSite` attribute to `Strict` for strict same-site enforcement. |
-
-## Return Values
-
-Returns a Vue `Ref<T>` representing the cookie value. Updating the ref will update the cookie (unless `readonly` is set). The ref is SSR-friendly and will work on both client and server.
-
-## Examples
-
-### Basic Usage
-
-The example below creates a cookie called `counter`. If the cookie doesn't exist, it is initially set to a random value. Whenever we update the `counter` variable, the cookie will be updated accordingly.
-
-```vue [app.vue]
-<script setup lang="ts">
-const counter = useCookie('counter')
-
-counter.value ||= Math.round(Math.random() * 1000)
-</script>
-
-<template>
-  <div>
-    <h1>Counter: {{ counter || '-' }}</h1>
-    <button @click="counter = null">
-      reset
-    </button>
-    <button @click="counter--">
-      -
-    </button>
-    <button @click="counter++">
-      +
-    </button>
-  </div>
-</template>
-```
-
-### Readonly Cookies
-
-```vue
-<script setup lang="ts">
-const user = useCookie(
-  'userInfo',
-  {
-    default: () => ({ score: -1 }),
-    watch: false,
-  },
-)
-
-if (user.value) {
-  // the actual `userInfo` cookie will not be updated
-  user.value.score++
-}
-</script>
-
-<template>
-  <div>User score: {{ user?.score }}</div>
-</template>
-```
-
-### Writable Cookies
-
-```vue
-<script setup lang="ts">
-const list = useCookie(
-  'list',
-  {
-    default: () => [],
-    watch: 'shallow',
-  },
-)
-
-function add () {
-  list.value?.push(Math.round(Math.random() * 1000))
-  // list cookie won't be updated with this change
-}
-
-function save () {
-  // the actual `list` cookie will be updated
-  list.value &&= [...list.value]
-}
-</script>
-
-<template>
-  <div>
-    <h1>List</h1>
-    <pre>{{ list }}</pre>
-    <button @click="add">
-      Add
-    </button>
-    <button @click="save">
-      Save
-    </button>
-  </div>
-</template>
-```
-
-### Cookies in API Routes
-
-You can use `getCookie` and `setCookie` from [`h3`](https://github.com/h3js/h3) package to set cookies in server API routes.
-
-```ts [server/api/counter.ts]
-export default defineEventHandler((event) => {
-  // Read counter cookie
-  let counter = getCookie(event, 'counter') || 0
-
-  // Increase counter cookie by 1
-  setCookie(event, 'counter', ++counter)
-
-  // Send JSON response
-  return { counter }
-})
-```
-
-:link-example{to="/docs/examples/advanced/use-cookie"}

package/3.api/2.composables/use-router.md

@@ -1,94 +0,0 @@
----
-title: "useRouter"
-description: "The useRouter composable returns the router instance."
-links:
-  - label: Source
-    icon: i-simple-icons-github
-    to: https://github.com/nuxt/nuxt/blob/main/packages/nuxt/src/app/composables/router.ts
-    size: xs
----
-
-```vue [pages/index.vue]
-<script setup lang="ts">
-const router = useRouter()
-</script>
-```
-
-If you only need the router instance within your template, use `$router`:
-
-```vue [pages/index.vue]
-<template>
-  <button @click="$router.back()">
-    Back
-  </button>
-</template>
-```
-
-If you have a `pages/` directory, `useRouter` is identical in behavior to the one provided by `vue-router`.
-
-::read-more{icon="i-simple-icons-vuedotjs" to="https://router.vuejs.org/api/interfaces/Router.html#Properties-currentRoute" target="_blank"}
-Read `vue-router` documentation about the `Router` interface.
-::
-
-## Basic Manipulation
-
-- [`addRoute()`](https://router.vuejs.org/api/interfaces/Router.html#addRoute): Add a new route to the router instance. `parentName` can be provided to add new route as the child of an existing route.
-- [`removeRoute()`](https://router.vuejs.org/api/interfaces/Router.html#removeRoute): Remove an existing route by its name.
-- [`getRoutes()`](https://router.vuejs.org/api/interfaces/Router.html#getRoutes): Get a full list of all the route records.
-- [`hasRoute()`](https://router.vuejs.org/api/interfaces/Router.html#hasRoute): Checks if a route with a given name exists.
-- [`resolve()`](https://router.vuejs.org/api/interfaces/Router.html#resolve): Returns the normalized version of a route location. Also includes an `href` property that includes any existing base.
-
-```ts [Example]
-const router = useRouter()
-
-router.addRoute({ name: 'home', path: '/home', component: Home })
-router.removeRoute('home')
-router.getRoutes()
-router.hasRoute('home')
-router.resolve({ name: 'home' })
-```
-
-::note
-`router.addRoute()` adds route details into an array of routes and it is useful while building [Nuxt plugins](/docs/3.x/guide/directory-structure/plugins) while `router.push()` on the other hand, triggers a new navigation immediately and it is useful in pages, Vue components and composable.
-::
-
-## Based on History API
-
-- [`back()`](https://router.vuejs.org/api/interfaces/Router.html#back): Go back in history if possible, same as `router.go(-1)`.
-- [`forward()`](https://router.vuejs.org/api/interfaces/Router.html#forward): Go forward in history if possible, same as `router.go(1)`.
-- [`go()`](https://router.vuejs.org/api/interfaces/Router.html#go): Move forward or backward through the history without the hierarchical restrictions enforced in `router.back()` and `router.forward()`.
-- [`push()`](https://router.vuejs.org/api/interfaces/Router.html#push): Programmatically navigate to a new URL by pushing an entry in the history stack. **It is recommended to use [`navigateTo`](/docs/3.x/api/utils/navigate-to) instead.**
-- [`replace()`](https://router.vuejs.org/api/interfaces/Router.html#replace): Programmatically navigate to a new URL by replacing the current entry in the routes history stack. **It is recommended to use [`navigateTo`](/docs/3.x/api/utils/navigate-to) instead.**
-
-```ts [Example]
-const router = useRouter()
-
-router.back()
-router.forward()
-router.go(3)
-router.push({ path: '/home' })
-router.replace({ hash: '#bio' })
-```
-
-::read-more{icon="i-simple-icons-mdnwebdocs" to="https://developer.mozilla.org/en-US/docs/Web/API/History" target="_blank"}
-Read more about the browser's History API.
-::
-
-## Navigation Guards
-
-`useRouter` composable provides `afterEach`, `beforeEach` and `beforeResolve` helper methods that acts as navigation guards.
-
-However, Nuxt has a concept of **route middleware** that simplifies the implementation of navigation guards and provides a better developer experience.
-
-:read-more{to="/docs/guide/directory-structure/middleware"}
-
-## Promise and Error Handling
-
-- [`isReady()`](https://router.vuejs.org/api/interfaces/Router.html#isReady): Returns a Promise that resolves when the router has completed the initial navigation.
-- [`onError`](https://router.vuejs.org/api/interfaces/Router.html#onError): Adds an error handler that is called every time a non caught error happens during navigation.
-
-:read-more{icon="i-simple-icons-vuedotjs" to="https://router.vuejs.org/api/interfaces/Router.html#Methods" title="Vue Router Docs" target="_blank"}
-
-## Universal Router Instance
-
-If you do not have a `pages/` folder, then [`useRouter`](/docs/3.x/api/composables/use-router)  will return a universal router instance with similar helper methods, but be aware that not all features may be supported or behave in exactly the same way as with `vue-router`.

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

@@ -1,42 +0,0 @@
----
-title: "nuxt analyze"
-description: "Analyze the production bundle or your Nuxt application."
-links:
-  - label: Source
-    icon: i-simple-icons-github
-    to: https://github.com/nuxt/cli/blob/main/packages/nuxi/src/commands/analyze.ts
-    size: xs
----
-
-<!--analyze-cmd-->
-```bash [Terminal]
-npx nuxt analyze [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--dotenv] [-e, --extends=<layer-name>] [--name=<name>] [--no-serve]
-```
-<!--/analyze-cmd-->
-
-The `analyze` command builds Nuxt and analyzes the production bundle (experimental).
-
-## Arguments
-
-<!--analyze-args-->
-Argument | Description
---- | ---
-`ROOTDIR="."` | Specifies the working directory (default: `.`)
-<!--/analyze-args-->
-
-## Options
-
-<!--analyze-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
-`--name=<name>` | `default` | Name of the analysis
-`--no-serve` |  | Skip serving the analysis results
-<!--/analyze-opts-->
-
-::note
-This command sets `process.env.NODE_ENV` to `production`.
-::

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

@@ -1,42 +0,0 @@
----
-title: 'nuxt build-module'
-description: 'Nuxt command to build your Nuxt module before publishing.'
-links:
-  - label: Source
-    icon: i-simple-icons-github
-    to: https://github.com/nuxt/module-builder/blob/main/src/cli.ts
-    size: xs
----
-
-<!--build-module-cmd-->
-```bash [Terminal]
-npx nuxt build-module [ROOTDIR] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--build] [--stub] [--sourcemap] [--prepare]
-```
-<!--/build-module-cmd-->
-
-The `build-module` command runs `@nuxt/module-builder` to generate `dist` directory within your `rootDir` that contains the full build for your **nuxt-module**.
-
-## Arguments
-
-<!--build-module-args-->
-Argument | Description
---- | ---
-`ROOTDIR="."` | Specifies the working directory (default: `.`)
-<!--/build-module-args-->
-
-## Options
-
-<!--build-module-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
-`--build` | `false` | Build module for distribution
-`--stub` | `false` | Stub dist instead of actually building it for development
-`--sourcemap` | `false` | Generate sourcemaps
-`--prepare` | `false` | Prepare module for local development
-<!--/build-module-opts-->
-
-::read-more{to="https://github.com/nuxt/module-builder" icon="i-simple-icons-github" target="\_blank"}
-Read more about `@nuxt/module-builder`.
-::

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/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)