CLI reference

This page is generated from the command tree exported by the CLI. The commands and options below therefore match the published module version.

bunx nuxt-feathers-zod --help
bunx nuxt-feathers-zod capabilities --section all --json

Usage principles

• Run doctor after generation or a significant nuxt.config.ts change.
• Use --dry when available to inspect a patch before writing files.
• Use --force only when replacing an existing artifact is intentional.
• For business services, prefer add service or add custom-service over manually creating folders.
• The schema --add-field field format is name:type! for a required field, for example title:string!.

Command catalogue

Command	Purpose	Arguments and options
add custom-service	Explicit alias for a custom service without a standard adapter.	<name> `--schema <none
add file-service	Generate a local upload and download service.	<name> --path <value> --storageDir <value> --auth --docs --servicesDir <value> --force --dry
add middleware	Generate middleware or another targeted server artifact.	<name> `--target <nitro
add mongodb-compose	Generate a development MongoDB Compose file.	--out <value> --service <value> --port <value> --database <value> --rootUser <value> --rootPassword <value> --volume <value> --force --dry
add remote-service	Declare a remote Feathers service in the client configuration.	<name> --path <value> --methods <value> --dry
add server-module	Generate a Feathers/Nitro server module from a preset.	<name> `--preset <helmet
add service	Generate a Feathers service using memory, MongoDB, Knex, or a custom service class.	<name> --custom `--type <adapter
auth service	Enable or disable JWT hooks on an existing service.	<name> --servicesDir <value> --enabled --dry
capabilities	Expose the capability matrix implemented by the installed package version.	`--section <summary
doctor	Inspect the current project and report configuration or service inconsistencies.	—
init embedded	Configure Nuxt with a Feathers server embedded in Nitro.	`--framework <express
init remote	Configure the Nuxt client for a remote Feathers API.	--url <value> * `--transport <auto
init starter	Copy the Nuxt 4 + Quasar 2 + UnoCSS + Pinia starter shipped with the package.	--preset <value> --dir <value> --force --dry
init templates	Install customizable module templates.	--dir <value> --force --diff --dry
middlewares add	Generate middleware from the preset registry.	<name> `--target <nitro
middlewares list	List middleware and targeted artifacts.	`--target <all
modules add	Generate a server module.	<name> `--preset <helmet
modules list	List detected server modules.	—
mongo management	Configure MongoDB management services exposed by the module.	--url <value> --enabled --auth --basePath <value> --exposeDatabasesService --exposeCollectionsService --exposeUsersService --exposeCollectionCrud --whitelistDatabases <value> --blacklistDatabases <value> --whitelistCollections <value> --blacklistCollections <value> --showSystemDatabases --allowCreateDatabase --allowDropDatabase --allowCreateCollection --allowDropCollection --allowInsertDocuments --allowPatchDocuments --allowReplaceDocuments --allowRemoveDocuments --dry
plugins add	Generate a Feathers server plugin.	<name> --force --dry
plugins list	List detected server plugins.	—
remote auth keycloak	Configure Keycloak client mode for a remote backend.	--ssoUrl, --url <value> * --realm <value> * --clientId <value> * --dry
schema	Inspect, validate, and modify a service schema manifest.	<name> --show --get --json --export `--set-mode <none
templates init	Install templates into the project.	--dir <value> --force --diff --dry
templates list	List available templates.	—

Recommended workflows

Embedded Feathers backend

bunx nuxt-feathers-zod init embedded --auth --framework express
bunx nuxt-feathers-zod add service users --adapter mongodb --schema zod --auth
bunx nuxt-feathers-zod add service articles --adapter mongodb --schema zod
bunx nuxt-feathers-zod schema articles --add-field title:string!
bunx nuxt-feathers-zod doctor

Custom service

bunx nuxt-feathers-zod add custom-service reports --methods find --customMethods run --schema zod

Remote client

bunx nuxt-feathers-zod init remote --url https://api.example.test --transport socketio --auth
bunx nuxt-feathers-zod add remote-service users --path users --methods find,get,create,patch,remove
bunx nuxt-feathers-zod doctor

Source of truth

The capabilities --json command exposes implemented modes, transports, NFZ services, composables, and authentication events. The repository coherence gate compares this matrix with the runtime, playground, and documentation.