docfy init

Onboarding en une seule commande : connecte DocfyModule, décore les contrôleurs, enregistre le plugin webpack si nécessaire, ajoute des scripts à package.json et génère les fichiers de documentation.

Utilisation

bash
npx nestjs-docfy init [options]

Le chemin le plus rapide vers une configuration fonctionnelle — regroupe ce que generate --link-controller --register-plugin font déjà, plus la seule nouvelle étape : connecter DocfyModule.forRoot() à ton module racine.

Ce qu'il fait

  1. Locates each app's bootstrap file and the class passed to NestFactory.create(...), then wires DocfyModule.forRoot() into that root module's @Module({ imports: [...] }). Static analysis only — never executes your code. If it can't locate the bootstrap file or the module with certainty, it warns and skips that app instead of guessing.
  2. Runs the same steps as generate --link-controller --register-plugin: decorates every controller with @WithDocs(), registers the webpack CLI plugin if needed, and generates the companion *.controller.docs.ts files.
  3. Adds docs:generate/docs:preview scripts to the root package.json, without overwriting any script already defined under those names.

Every step is independently idempotent, so running init again is always safe — useful after adding a new controller or a second app to the project. See CLI: generate for what each bundled step does on its own.

Options

OptionDefaultDescription
--root <path>.Project root directory
--tsconfig <path>auto-detectedPath to tsconfig.json
--pattern <glob>**/*.controller.tsGlob pattern to find controllers
--formattsOutput format: ts or js
--dry-runfalsePrint what would change without writing any files
--quietfalseSuppress all output except errors