NestJS CLI

The NestJS CLI is a command-line interface tool that helps you initialize, develop, and maintain NestJS applications. It assists in multiple ways, including scaffolding the project, serving it in development mode, and building and bundling the application for production distribution. It embodies best-practice architectural patterns to encourage well-structured apps.

Package Information

• Package Name: @nestjs/cli
• Package Type: npm
• Language: TypeScript
• Installation: npm install -g @nestjs/cli

Core Usage

nest <command> [options]

The CLI works with schematics and provides built-in support from the schematics collection at @nestjs/schematics.

Basic Usage

# Create a new NestJS application
nest new my-app

# Generate a controller
nest generate controller users

# Build the application
nest build

# Start in development mode
nest start --watch

# Display project information
nest info

Architecture

The NestJS CLI is built around several key components:

• Command System: Modular command structure using Commander.js for argument parsing
• Schematics Integration: Built-in support for Angular DevKit schematics and @nestjs/schematics
• Build System: Multi-builder support (TypeScript compiler, Webpack, SWC) for different compilation needs
• Package Manager Integration: Automatic detection and support for npm, yarn, and pnpm
• Configuration Management: Project-level configuration through nest-cli.json files

Capabilities

Project Creation

Create new NestJS applications with customizable options including language selection, package manager, and project structure.

nest new [name] [options]
nest n [name] [options]

Project Creation

Code Generation

Generate NestJS components, services, controllers, and other elements using schematics.

nest generate <schematic> [name] [path] [options]
nest g <schematic> [name] [path] [options]

Code Generation

Application Building

Build applications for production with support for multiple build systems and watch mode.

nest build [apps...] [options]

Application Building

Development Server

Start applications in development mode with hot reloading, debugging, and asset watching.

nest start [app] [options]

Development Server

Library Integration

Add external libraries to your project with automated setup and configuration.

nest add <library> [options]

Library Integration

Project Information

Display comprehensive information about your NestJS project including dependencies, versions, and configuration.

nest info [options]
nest i [options]

Project Information

Global Options

All commands support the following help options:

-h, --help     # Output usage information
-v, --version  # Output the current version

Configuration

The CLI uses a nest-cli.json configuration file in your project root to define build settings, project structure, and default options.

Environment Requirements

• Node.js: >= 20.11
• Package Managers: npm, yarn, or pnpm
• Optional Dependencies: @swc/cli and @swc/core for SWC compilation support