NestJS 是一个流行的 Node.js 框架,常用于构建高效、可扩展的服务端应用。以下是 NestJS 的常用命令整理:


1. 项目初始化

  • 创建新项目
    nest new project-name
    
    初始化一个全新的 NestJS 项目,并安装依赖。

2. 生成代码(Generate)

  • 生成模块(Module)

    nest generate module module-name
    # 简写
    nest g mo module-name
    
  • 生成控制器(Controller)

    nest generate controller controller-name
    # 简写
    nest g co controller-name
    
  • 生成服务(Service)

    nest generate service service-name
    # 简写
    nest g s service-name
    
  • 生成完整资源(CRUD 代码)

    nest generate resource resource-name
    # 简写
    nest g res resource-name
    

    自动生成模块、控制器、服务、DTO 和实体类,支持 REST 或 GraphQL。

  • 其他生成选项

    nest g guard     # 生成守卫(Guard)
    nest g interceptor # 生成拦截器(Interceptor)
    nest g middleware # 生成中间件
    nest g pipe      # 生成管道(Pipe)
    nest g filter    # 生成异常过滤器(Exception Filter)
    

3. 运行与构建

  • 启动开发服务器(热更新)

    nest start --watch
    
  • 生产环境构建

    nest build
    

    生成编译后的 JavaScript 文件到 dist 目录。

  • 自定义构建配置

    nest build --webpack  # 使用 Webpack
    nest build --tsc      # 使用 TypeScript 编译器
    

4. 其他实用命令

  • 查看 NestJS 版本信息

    nest info
    
  • 更新 NestJS CLI 工具

    nest update
    
  • 添加第三方库

    nest add package-name
    

    例如:nest add @nestjs/swagger 集成 Swagger API 文档。


常用参数

  • --dry-run: 模拟执行,查看生成的文件结构但不实际创建。
  • --no-spec: 不生成测试文件(如 *.spec.ts)。
  • --flat: 生成文件时不创建子目录。

示例场景

生成一个用户模块的 CRUD 代码:

nest g res users

选择 REST API 风格后,会自动生成 users 模块、控制器、服务、DTO 和实体文件。


这些命令能显著提升 NestJS 开发效率。建议结合官方文档进一步学习:
NestJS 官方文档