mirror of
https://github.com/nuxt/nuxt.git
synced 2024-12-12 23:37:14 +00:00
f26a801775
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> Co-authored-by: Daniel Roe <daniel@roe.dev>
2.0 KiB
2.0 KiB
title | description | links | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
nuxi add | Scaffold an entity into your Nuxt application. |
|
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 modifier flags to add a suffix (like .client
or .get
) to their name.
# Generates `/plugins/sockets.client.ts`
npx nuxi add plugin sockets --client
nuxi add component
- Modifier flags:
--mode client|server
or--client
or--server
# Generates `components/TheHeader.vue`
npx nuxi add component TheHeader
nuxi add composable
# Generates `composables/foo.ts`
npx nuxi add composable foo
nuxi add layout
# Generates `layouts/custom.vue`
npx nuxi add layout custom
nuxi add plugin
- Modifier flags:
--mode client|server
or--client
or--server
# Generates `plugins/analytics.ts`
npx nuxi add plugin analytics
nuxi add page
# 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
# Generates `middleware/auth.ts`
npx nuxi add middleware auth
nuxi add api
- Modifier flags:
--method
(can acceptconnect
,delete
,get
,head
,options
,patch
,post
,put
ortrace
) or alternatively you can directly use--get
,--post
, etc.
# Generates `server/api/hello.ts`
npx nuxi add api hello