docs/4.api/4.commands/add.md
npx nuxt add <TEMPLATE> <NAME> [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--force]
| Argument | Description |
|---|---|
TEMPLATE | Specify which template to generate (options: <api|app|app-config|component|composable|error|layer|layout|middleware|module|page|plugin|server-middleware|server-plugin|server-route|server-util>) |
NAME | Specify name of the generated file |
| 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.
# Generates `/plugins/sockets.client.ts`
npx nuxt add plugin sockets --client
nuxt add component--mode client|server or --client or --server# Generates `app/components/TheHeader.vue`
npx nuxt add component TheHeader
nuxt add composable# Generates `app/composables/foo.ts`
npx nuxt add composable foo
nuxt add layout# Generates `app/layouts/custom.vue`
npx nuxt add layout custom
nuxt add plugin--mode client|server or --clientor --server# Generates `app/plugins/analytics.ts`
npx nuxt add plugin analytics
nuxt add page# Generates `app/pages/about.vue`
npx nuxt add page about
# Generates `app/pages/category/[id].vue`
npx nuxt add page "category/[id]"
nuxt add middleware--global# Generates `app/middleware/auth.ts`
npx nuxt add middleware auth
nuxt add api--method (can accept connect, delete, get, head, options, patch, post, put or trace) or alternatively you can directly use --get, --post, etc.# Generates `server/api/hello.ts`
npx nuxt add api hello
nuxt add layer# Generates `layers/subscribe/nuxt.config.ts`
npx nuxt add layer subscribe