nuxi add
Scaffold an entity into your Nuxt application.
Terminal
npx nuxi add <TEMPLATE> <NAME> [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--force]
Arguments
| Argument | Description |
|---|---|
TEMPLATE | Specify which template to generate (options: <api|plugin|component|composable|middleware|layout|page>) |
NAME | Specify name of the generated file |
Options
| Option | Default | Description |
|---|---|---|
--cwd=<directory> | . | Specify the working directory |
--logLevel=<silent|info|verbose> | Specify build-time log level | |
--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.
Terminal
# Generates `/plugins/sockets.client.ts`
npx nuxi add plugin sockets --client
nuxi add component
- Modifier flags:
--mode client|serveror--clientor--server
Terminal
# Generates `components/TheHeader.vue`
npx nuxi add component TheHeader
nuxi add composable
Terminal
# Generates `composables/foo.ts`
npx nuxi add composable foo
nuxi add layout
Terminal
# Generates `layouts/custom.vue`
npx nuxi add layout custom
nuxi add plugin
- Modifier flags:
--mode client|serveror--clientor--server
Terminal
# Generates `plugins/analytics.ts`
npx nuxi add plugin analytics
nuxi add page
Terminal
# Generates `pages/about.vue`
npx nuxi add page about
Terminal
# Generates `pages/category/[id].vue`
npx nuxi add page "category/[id]"
nuxi add middleware
- Modifier flags:
--global
Terminal
# 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.
Terminal
# Generates `server/api/hello.ts`
npx nuxi add api hello