NestJS CLI installation - Mini Project: Build & Apply

NestJS CLI Installation

📖 Scenario: You want to create a new backend project using NestJS, a popular Node.js framework. To start, you need to install the NestJS Command Line Interface (CLI) globally on your computer. This CLI helps you create and manage NestJS projects easily.

🎯 Goal: Install the NestJS CLI globally using npm so you can create new NestJS projects from the command line.

📋 What You'll Learn

Use npm to install the NestJS CLI globally

Verify the installation by checking the CLI version

Use the exact command npm install -g @nestjs/cli

Use the exact command nest --version to check the version

💡 Why This Matters

🌍 Real World

Developers use the NestJS CLI to quickly set up backend projects with best practices and ready-to-use configurations.

💼 Career

Knowing how to install and use the NestJS CLI is essential for backend developers working with Node.js and NestJS frameworks.

1

Install NestJS CLI globally

Type the exact command npm install -g @nestjs/cli in your terminal to install the NestJS CLI globally on your computer.

NestJS

# Type the command to install NestJS CLI globally
# Your code here

Hint

Use npm with the -g flag to install the package globally.

2

Verify NestJS CLI installation

Type the exact command nest --version in your terminal to check if the NestJS CLI installed correctly and to see its version number.

NestJS

npm install -g @nestjs/cli
# Type the command to check NestJS CLI version
# Your code here

Hint

Use the nest command followed by --version to check the installed CLI version.

3

Create a new NestJS project

Use the exact command nest new my-app to create a new NestJS project folder named my-app.

NestJS

npm install -g @nestjs/cli
nest --version
# Type the command to create a new NestJS project named my-app
# Your code here

Hint

Use nest new followed by the project name to create a new project.

4

Navigate into the new project folder

Type the exact command cd my-app to change your terminal directory into the new project folder my-app.

NestJS

npm install -g @nestjs/cli
nest --version
nest new my-app
# Type the command to enter the my-app folder
# Your code here

Hint

Use cd followed by the folder name to enter the project directory.

Practice

1. What is the main purpose of the NestJS CLI?

easy

A. To help create and manage NestJS projects easily

B. To run NestJS applications in production

C. To replace Node.js runtime

D. To write CSS styles for NestJS apps

Solution

1. Step 1: Understand what CLI tools do

   CLI tools help automate tasks like creating and managing projects.

2. Step 2: Match NestJS CLI purpose

   NestJS CLI specifically helps start and manage NestJS projects quickly.

3. Final Answer:

   To help create and manage NestJS projects easily -> Option A

4. Quick Check:

   NestJS CLI = project management tool [OK]

Hint: CLI means command line helper for projects [OK]

Common Mistakes:

• Thinking CLI runs the app in production
• Confusing CLI with runtime environment
• Assuming CLI styles the app

2. Which command correctly installs the NestJS CLI globally using npm?

easy

A. npm install nestjs-cli

B. npm install -g @nestjs/cli

C. npm global add nestjs

D. npm install @nestjs/cli

Solution

1. Step 1: Identify npm global install syntax

   Global install uses npm install -g package-name.

2. Step 2: Match correct package name

   The official NestJS CLI package is @nestjs/cli.

3. Final Answer:

   npm install -g @nestjs/cli -> Option B

4. Quick Check:

   Global install = npm install -g @nestjs/cli [OK]

Hint: Global npm installs use -g flag [OK]

Common Mistakes:

• Omitting the -g flag for global install
• Using wrong package name
• Using npm global add instead of install -g

3. After installing NestJS CLI globally, what happens when you run nest new my-app?

medium

A. It deletes the 'my-app' folder if it exists

B. It runs the NestJS server immediately

C. It creates a new NestJS project folder named 'my-app'

D. It updates the NestJS CLI to the latest version

Solution

1. Step 1: Understand the nest new command

   This command creates a new project folder with starter files.

2. Step 2: Analyze the argument 'my-app'

   The argument specifies the folder name for the new project.

3. Final Answer:

   It creates a new NestJS project folder named 'my-app' -> Option C

4. Quick Check:

   nest new = create project folder [OK]

Hint: nest new always creates a new project folder [OK]

Common Mistakes:

• Thinking it runs the server immediately
• Assuming it updates CLI version
• Believing it deletes folders

4. You run npm install -g nestjs/cli but get an error. What is the likely problem?

medium

A. You must use yarn instead of npm

B. You forgot to add the -g flag for global install

C. You need to run the command inside a NestJS project folder

D. The package name is incorrect; it should be '@nestjs/cli'

Solution

1. Step 1: Check the package name format

   Correct package name uses the scope '@nestjs/cli', not 'nestjs/cli'.

2. Step 2: Understand npm package naming

   Scoped packages start with '@' and are required for correct install.

3. Final Answer:

   The package name is incorrect; it should be '@nestjs/cli' -> Option D

4. Quick Check:

   Correct package name = @nestjs/cli [OK]

Hint: Scoped packages start with @ symbol [OK]

Common Mistakes:

• Using slash instead of @ for scoped package
• Forgetting -g flag (but question says it is present)
• Thinking install must be inside project folder

5. You want to install NestJS CLI globally but only for your current user without admin rights. Which command should you use?

hard

A. npm install -g @nestjs/cli --prefix ~/.npm-global

B. npm install @nestjs/cli

C. npm install -g @nestjs/cli

D. npm install --save @nestjs/cli

Solution

1. Step 1: Understand global install without admin rights

   Global install usually needs admin rights; using --prefix installs globally in user folder.

2. Step 2: Match command with user-level global install

   Using npm install -g @nestjs/cli --prefix ~/.npm-global installs CLI globally for current user only.

3. Final Answer:

   npm install -g @nestjs/cli --prefix ~/.npm-global -> Option A

4. Quick Check:

   User-level global install = npm install -g with --prefix [OK]

Hint: Use --prefix to install global packages without admin rights [OK]

Common Mistakes:

• Using normal install without -g for global tools
• Trying to install globally without admin rights and no prefix
• Confusing --save with global install