docfy init
Onboarding em um só comando: conecta o DocfyModule, decora os controllers, registra o plugin do webpack se necessário, adiciona scripts ao package.json e gera os arquivos de documentação.
Uso
bash
npx nestjs-docfy init [options]O caminho mais rápido para um setup funcionando — reúne o que generate --link-controller --register-plugin já fazem, mais o único passo novo: conectar o DocfyModule.forRoot() no seu módulo raiz.
O que faz
- Locates each app's bootstrap file and the class passed to
NestFactory.create(...), then wiresDocfyModule.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. - 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.tsfiles. - Adds
docs:generate/docs:previewscripts to the rootpackage.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.
Opções
| Option | Default | Description |
|---|---|---|
--root <path> | . | Project root directory |
--tsconfig <path> | auto-detected | Path to tsconfig.json |
--pattern <glob> | **/*.controller.ts | Glob pattern to find controllers |
--format | ts | Output format: ts or js |
--dry-run | false | Print what would change without writing any files |
--quiet | false | Suppress all output except errors |