1. Cài đặt và Kiểm tra

Trước khi bắt đầu, bạn cần cài đặt CLI ở phạm vi toàn cầu (global).

• Cài đặt:

  npm install -g @nestjs/cli

• Kiểm tra version:

  nest --version

• Xem trợ giúp tổng quát:

  nest --help

2. Tạo Dự án (Scaffolding)

Lệnh new dùng để khởi tạo một dự án mới hoàn toàn.

Cú pháp cơ bản

nest new <project-name>

Các tùy chọn (Options) thường dùng

Ví dụ:

nest new my-app --strict --package-manager pnpm

3. Chạy ứng dụng (Development)

Lệnh start dùng để chạy ứng dụng trong môi trường development.

4. Generators (Tạo file tự động)

Đây là tính năng mạnh nhất của NestJS CLI. Lệnh generate (viết tắt là g) giúp tạo các thành phần theo đúng cấu trúc NestJS.

Cú pháp

nest generate <schematic> <name> [options]
# Hoặc viết tắt
nest g <schematic> <name> [options]

Bảng các Schematic phổ biến

Các cờ (Flags) quan trọng cho lệnh Generate

Những cờ này áp dụng cho hầu hết các lệnh nest g.

1. --dry-run (hoặc -d):

   • Tác dụng: Chạy thử lệnh nhưng không tạo file thật. Chỉ in ra danh sách file sẽ được tạo.
   • Khi nào dùng: Luôn dùng khi bạn không chắc cấu trúc file sinh ra sẽ nằm ở đâu.
   • nest g s users -d

2. --no-spec:

   • Tác dụng: Không tạo file test (.spec.ts).
   • Khi nào dùng: Khi làm dự án nhỏ hoặc tạo DTO/Entity không cần unit test.
   • nest g s users --no-spec

3. --flat:

   • Tác dụng: Không tạo thư mục con bọc ngoài.
   • Ví dụ: nest g s auth --flat sẽ tạo auth.service.ts ngay tại thư mục hiện tại thay vì tạo auth/auth.service.ts.

4. --project (Dùng cho Monorepo):

   • Tác dụng: Chỉ định app hoặc library nào trong Monorepo để tạo file vào.
   • nest g mo users --project my-app-2

5. Trường hợp đặc biệt: nest g resource

Lệnh này đặc biệt hữu ích để tạo REST API hoặc GraphQL nhanh chóng.

nest g res users

Khi chạy lệnh này, CLI sẽ hỏi:

1. Transport layer: (REST API, GraphQL Code First, GraphQL Schema First, Microservice, WebSocket).
2. Generate entry points?: Có muốn tạo sẵn các hàm CRUD (Create, Read, Update, Delete) không.

Kết quả: Nó tự động tạo Module, Controller, Service, DTO, Entity và test cho users.

6. Build & Production

Lệnh build biên dịch TypeScript sang JavaScript (thư mục dist) để deploy.

7. Các lệnh tiện ích khác

nest info

Hiển thị thông tin hệ thống, version Node.js, NestJS CLI và các dependencies. Dùng khi báo lỗi (submit issue).

nest update

Cập nhật các package của NestJS (@nestjs/core, @nestjs/common…) lên bản mới nhất.

nest update
nest update --force # Ép cập nhật

nest add

Cài đặt và tự động cấu hình một thư viện bên thứ 3 (nếu thư viện đó hỗ trợ schematic).

nest add @nestjs/swagger # Tự động cài swagger và config vào main.ts

8. Làm việc với Monorepo (Workspace)

NestJS hỗ trợ chế độ Monorepo (nhiều apps và libs trong một project).

Chuyển project thường sang Monorepo

nest new my-workspace
# Sau đó bên trong workspace:
nest g app my-app-2
nest g app admin-portal

Tạo Library (Thư viện dùng chung)

nest g library my-shared-lib

• nest g lib sẽ tạo thư mục trong libs/.
• Dùng @app/my-shared-lib để import vào các app khác.

9. Tóm tắt cấu trúc lệnh (Cheat Sheet)

# Tạo dự án
nest new <tên-app>

# Chạy dev
nest start --watch

# Tạo Controller (không test)
nest g co users --no-spec

# Tạo Service (không tạo folder con)
nest g s auth --flat

# Tạo trọn bộ CRUD
nest g res products

# Xem trước kết quả (An toàn nhất)
nest g mo payments --dry-run

# Build production
nest build

10. File cấu hình nest-cli.json

Mọi hành vi của CLI được cấu hình trong file này tại root dự án.

• sourceRoot: Thư mục chứa code (thường là src).
• entryFile: File chạy chính (thường là main).
• monorepo: true nếu là monorepo.
• compilerOptions: Cấu hình builder (webpack hay tsc), plugins (tự động thêm swagger decorators…).

Mẹo: Để xem danh sách đầy đủ nhất tại thời điểm hiện tại, bạn hãy gõ lệnh:

nest g --help