mirror of
https://github.com/nuxt/nuxt.git
synced 2024-11-30 01:17:16 +00:00
dc47c64f14
Co-authored-by: Daniel Roe <daniel@roe.dev> Co-authored-by: Sébastien Chopin <seb@nuxtjs.com> Co-authored-by: Pooya Parsa <pooya@pi0.io> Co-authored-by: pooya parsa <pyapar@gmail.com> Co-authored-by: Clément Ollivier <clement.o2p@gmail.com>
1.8 KiB
1.8 KiB
title | description |
---|---|
nuxi add | Scaffold an entity into your Nuxt application. |
nuxi add
npx nuxi add [--cwd] [--force] <TEMPLATE> <NAME>
Option | Default | Description |
---|---|---|
TEMPLATE |
- | Specify a template of the file to be generated. |
NAME |
- | Specify a name of the file that will be created. |
--cwd |
. |
The directory of the target application. |
--force |
false |
Force override file if it already exists. |
Modifiers:
Some templates support additional modifer flags to add a suffix (like .client
or .get
) to their name.
Example: npx nuxi add plugin sockets --client
generates /plugins/sockets.client.ts
.
nuxi add component
- Modifier flags:
--mode client|server
or--client
or--server
Example:
# Generates `components/TheHeader.vue`
npx nuxi add component TheHeader
nuxi add composable
Example:
# Generates `composables/foo.ts`
npx nuxi add composable foo
nuxi add layout
Example:
# Generates `layouts/custom.vue`
npx nuxi add layout custom
nuxi add plugin
- Modifier flags:
--mode client|server
or--client
or--server
Example:
# Generates `plugins/analytics.ts`
npx nuxi add plugin analytics
nuxi add page
Example:
# Generates `pages/about.vue`
npx nuxi add page about
# Generates `pages/category/[id].vue`
npx nuxi add page "category/[id]"
nuxi add middleware
- Modifier flags:
--global
Example:
# Generates `middleware/auth.ts`
npx nuxi add middleware auth
nuxi add api
- Modifier flags:
--method=connect|delete|get|head|options|patch|post|put|trace
or--get
,--post
, etc.
Example:
# Generates `server/api/hello.ts`
npx nuxi add api hello