Docs API Commands

nuxi add

Scaffold an entity into your Nuxt application.

Terminal
npx nuxi add [--cwd] [--force] <TEMPLATE> <NAME>
OptionDefaultDescription
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.
--forcefalseForce 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|server or --client or --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|server or --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 accept connect, delete, get, head, options, patch, post, put or trace) or alternatively you can directly use --get, --post, etc.
Terminal
# Generates `server/api/hello.ts`npx nuxi add api hello