mirror of
https://github.com/nuxt/nuxt.git
synced 2024-12-04 19:37:18 +00:00
3ec108493d
* docs: simplify docs to only markdown * Create nuxt-config.md * chore: update * chore: add readme
1.9 KiB
1.9 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 modifier 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|serveror--clientor--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|serveror--clientor--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(can acceptconnect,delete,get,head,options,patch,post,putortrace) or alternatively you can directly use--get,--post, etc.
Example:
# Generates `server/api/hello.ts`
npx nuxi add api hello