Référence CLI

Cette page est générée depuis l’arbre de commandes réellement exporté par la CLI. Les commandes et options ci-dessous correspondent donc à la version publiée du module.

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

Principes d’utilisation

• Exécutez doctor après une génération ou une modification importante de nuxt.config.ts.
• Utilisez --dry lorsqu’il est disponible pour vérifier un patch avant écriture.
• Utilisez --force uniquement lorsque vous acceptez de remplacer un artefact existant.
• Pour un service métier, préférez add service ou add custom-service à une création manuelle de dossiers.
• Le format des champs de schema --add-field est nom:type! pour un champ requis, par exemple title:string!.

Catalogue des commandes

Commande	Rôle	Arguments et options
add custom-service	Alias explicite pour générer un service personnalisé sans adapter standard.	<name> `--schema <none
add file-service	Génère un service local de dépôt et téléchargement de fichiers.	<name> --path <value> --storageDir <value> --auth --docs --servicesDir <value> --force --dry
add middleware	Génère un middleware ou un artefact serveur ciblé.	<name> `--target <nitro
add mongodb-compose	Génère un fichier Compose MongoDB de développement.	--out <value> --service <value> --port <value> --database <value> --rootUser <value> --rootPassword <value> --volume <value> --force --dry
add remote-service	Déclare un service Feathers distant dans la configuration client.	<name> --path <value> --methods <value> --dry
add server-module	Génère un module serveur Feathers/Nitro à partir d’un preset.	<name> `--preset <helmet
add service	Génère un service Feathers avec adapter memory, MongoDB ou Knex, ou un service personnalisé.	<name> --custom `--type <adapter
auth service	Active ou désactive les hooks JWT sur un service existant.	<name> --servicesDir <value> --enabled --dry
capabilities	Expose la matrice des capacités réellement implémentées par la version installée.	`--section <summary
doctor	Analyse le projet courant et signale les incohérences de configuration ou de services.	—
init embedded	Configure Nuxt avec un serveur Feathers embarqué dans Nitro.	`--framework <express
init remote	Configure le client Nuxt pour une API Feathers distante.	--url <value> * `--transport <auto
init starter	Copie le starter Nuxt 4 + Quasar 2 + UnoCSS + Pinia livré avec le package.	--preset <value> --dir <value> --force --dry
init templates	Installe les templates modifiables du module.	--dir <value> --force --diff --dry
middlewares add	Génère un middleware à partir du registre de presets.	<name> `--target <nitro
middlewares list	Liste les middlewares et artefacts ciblés.	`--target <all
modules add	Génère un module serveur.	<name> `--preset <helmet
modules list	Liste les modules serveur détectés.	—
mongo management	Configure les services d’administration MongoDB exposés par le 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	Génère un plugin serveur Feathers.	<name> --force --dry
plugins list	Liste les plugins serveur détectés.	—
remote auth keycloak	Configure le mode client Keycloak pour un backend distant.	--ssoUrl, --url <value> * --realm <value> * --clientId <value> * --dry
schema	Inspecte, valide et modifie le manifeste de schéma d’un service.	<name> --show --get --json --export `--set-mode <none
templates init	Installe les templates dans le projet.	--dir <value> --force --diff --dry
templates list	Liste les templates disponibles.	—

Parcours recommandés

Backend Feathers embarqué

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

Service personnalisé

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

Client distant

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 de vérité

La commande capabilities --json expose les modes, transports, services NFZ, composables et événements d’authentification implémentés. Le contrôle de cohérence du dépôt compare cette matrice au runtime, au playground et à la documentation.