CLI Reference

The @nest-extended/cli package installs the nest-cli binary for scaffolding apps and resources.

$npm install -g @nest-extended/cli

Commands

CommandAliasPurpose
nest-cli generate app <name>g appScaffold a complete NestJS app
nest-cli generate service <name>g serviceGenerate a CRUD resource bundle
nest-cli generate authg authAdd an auth + users module to an app
nest-cli migration runm runRun version migration scripts
nest-cli versionvPrint the CLI version

generate app

nest-cli g app my-api --db PostgreSQL --orm prisma --validator zod --pm npm --auth
FlagAliasValues
--database--dbPostgreSQL, MySQL, SQLite, MongoDB
--ormprisma, typeorm, mongoose
--validator-vzod, class-validator
--pkg-manager--pmnpm, yarn, pnpm
--authInclude JWT auth + users module
--skip-authExclude auth

Run without flags for an interactive prompt:

nest-cli g app my-shop

generate service

Generates a full resource — schema/model/entity, module, service, controller, DTO and specs:

nest-cli g service product
nest-cli g service qna/category   # nested path
Generated files
src/schemas/product.schema.ts
src/services/product/product.module.ts
src/services/product/product.service.ts
src/services/product/product.controller.ts
src/services/product/dto/product.dto.ts
src/services/product/product.service.spec.ts
src/services/product/product.controller.spec.ts

Name transformation

InputClassVariableFolderRoute
user-profileUserProfileuserProfilesrc/services/userProfile/user-profile
qna/categoryCategorycategorysrc/services/qna/category/qna/category

generate auth

Adds an Auth module (JWT + bcrypt) and a Users module to an existing app:

nest-cli g auth

Next steps