@nestjs/cli

What is @nestjs/cli?

The @nestjs/cli package is a command-line interface tool for NestJS, a framework for building efficient, reliable and scalable server-side applications. This CLI tool helps developers to initialize, develop, and maintain their NestJS applications with ease by providing a set of commands to generate, run, and manage various parts of the application.

What are @nestjs/cli's main functionalities?

Project Initialization

This command creates a new NestJS project with all the necessary configuration and dependencies to get started.

nest new project-name

Generate Resources

Generates a new controller named 'users' within the project. The CLI supports generating various resources like modules, services, and guards.

nest generate controller users

Run Development Server

Starts the application in watch mode. Any changes in the source code will automatically restart the server, facilitating a smooth development process.

nest start --watch

Build Project

Compiles the application into JavaScript, preparing it for production deployment.

nest build

Other packages similar to @nestjs/cli

express-generator

Similar to @nestjs/cli, express-generator is a CLI tool for Express.js, another Node.js framework. It helps in scaffolding new Express applications quickly but lacks the comprehensive set of features for managing the entire lifecycle of the application as @nestjs/cli does.

angular-cli

Although angular-cli is for Angular, a front-end framework, it shares a similar purpose with @nestjs/cli in terms of initializing projects, generating components, and managing build tasks. Both provide a robust set of tools to streamline development within their respective ecosystems.

create-react-app

create-react-app is a CLI tool for setting up new React applications. It abstracts away the build configuration into a single command, similar to how @nestjs/cli simplifies the setup and development of NestJS applications. However, it's focused on front-end React projects.

README

WARNING: The CLI is still a work in progress and is not ready for practical use. The repository is created to allow for insight and contributions.

Nest CLI

Installation

Git :

$ git clone https://github.com/nestjs/nest-cli.git <project>
$ cd <project>
$ npm install
$ npm link

###npm (not registered)

nestconfig.json (not implemented)

While the CLI does not require a nestconfig.json file to work, default values can be overrided by implementing one. Currently, a nestconfig.json file is only the following:

{
    "language": "ts | es (default: ts)"
}

Commands

new

Examples :

• $ nest new my-app
• $ nest new my-app myapp/
• $ nest new my-app --repo https://github.com/ThomRick/nest-typescript-starter Creates a new Nest application by cloning https://github.com/ThomRick/nest-typescript-starter Git repository.

generate (or g)

module

Example :

• $ nest generate module path/to/<name>
• $ nest g module path/to/<name> Creates a templated module file :
• src/path/to/<name>/<name>.module.ts

@Module({})
export class NameModule {}

controller

Examples :

• $ nest generate controller path/to/<name>
• $ nest g controller path/to/<name> Creates a templated controller files :
• src/path/to/<name>/<name>.controller.ts

@Controller()
export class NameController {
    public constructor() {}
}

• src/path/to/<name>/<name>.controller.spec.ts

import {NameController} from './name.controller';
import {expect} from 'chai';

describe('NameController', () => {
    const controller: NameController;

    beforeEach(() => {
        Test.createTestingModule({
            controllers: [
                NameController
            ]
        });

        controller = Test.get(NameController);
    });

    it('should exists', () => {
        expect(controller).to.exist;
    });
}

component

Examples :

• $ nest generate component path/to/<name>
• $ nest g component path/to/<name> Creates a templated component files :
• src/path/to/<name>/<name>.service.ts

@Component()
export class NameService {
    constructor() {}
}

• src/path/to/<name>/<name>.service.spec.ts

import {NameService} from './name.service';
import {expect} from 'chai';

describe('NameService', () => {
    const service: NameService;

    beforeEach(() => {
        Test.createTestingModule({
            components: [
                NameService
            ]
        });

        service = Test.get(NameService);
    });

    it('should exists', () => {
        expect(service).to.exist;
    });
}

serve (not implemented)

build (not implemented)