CLI Reference
The @nest-extended/cli package installs the nest-cli binary for scaffolding apps and
resources.
$npm install -g @nest-extended/cli
Commands
| Command | Alias | Purpose |
|---|---|---|
nest-cli generate app <name> | g app | Scaffold a complete NestJS app |
nest-cli generate service <name> | g service | Generate a CRUD resource bundle |
nest-cli generate auth | g auth | Add an auth + users module to an app |
nest-cli migration run | m run | Run version migration scripts |
nest-cli version | v | Print the CLI version |
generate app
nest-cli g app my-api --db PostgreSQL --orm prisma --validator zod --pm npm --auth| Flag | Alias | Values |
|---|---|---|
--database | --db | PostgreSQL, MySQL, SQLite, MongoDB |
--orm | prisma, typeorm, mongoose | |
--validator | -v | zod, class-validator |
--pkg-manager | --pm | npm, yarn, pnpm |
--auth | Include JWT auth + users module | |
--skip-auth | Exclude auth |
Run without flags for an interactive prompt:
nest-cli g app my-shopgenerate 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 pathsrc/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.tsName transformation
| Input | Class | Variable | Folder | Route |
|---|---|---|---|---|
user-profile | UserProfile | userProfile | src/services/userProfile/ | user-profile |
qna/category | Category | category | src/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