nestjs-console-oclif is a NestJS module that provides a CLI with Oclif.

Getting started

Generate your NestJS application

The architecture is based on NestJS architecture. So you can generate your application with nestcli : https://docs.nestjs.com/first-steps

Install from NPM

1npm install @oclif/command @oclif/config @oclif/errors @oclif/parser nestjs-console-oclif
2# or unig yarn
3yarn add @oclif/command @oclif/config @oclif/errors @oclif/parser nestjs-console-oclif

:warning: Don't forget to specify Oclif options in package.json :

1{
2  // ...
3  "scripts": {
4    "build": "nest build && oclif-dev manifest"
5  },
6  // ...
7  "devDependencies": {
8    // ...
9    "@oclif/dev-cli": "^1.22.2",
10    // ...
11  },
12  "bin": {
13    "myCli": "./dist/main.js"
14  },
15  // ...
16  "oclif": {
17    "commands": "./dist/commands",
18    "bin": "myCli",
19    "plugins": [
20      "@oclif/plugin-help"
21    ]
22  }
23  // ...
24}

Override NestJS bootstrap

Replace in file src/main.ts with AppModule as your main NestJS module:

1#!/usr/bin/env node
2
3import { bootstrap } from 'nestjs-console-oclif';
4import { AppModule } from './app.module';
5
6bootstrap({
7  nestModule: AppModule
8});
9

Options :

• nestModule : The class of the NestJS module
• singleCommand: The class of the single command
• enableShutdownHooks: true if you want enable shutdown hooks on the NestJS app. See NestJS lifecycle events

Import OclifModule

Import OclifModule in your main NestJS module (in file src/app.module.ts).

1import { Module } from '@nestjs/common';
2import { OclifModule } from 'nestjs-console-oclif';
3
4@Module({
5  imports: [OclifModule.forRoot()],
6  providers: [...],
7})
8export class AppModule {
9}

Define your commands

Multi commands

You define your command in src/commands/myCommand.ts like oclif.

But :

• Extends your command from BaseCommand
• You don't need to implement the run function.

1import { BaseCommand } from 'nestjs-console-oclif';
2import { flags } from '@oclif/command';
3
4export class MyCommand extends BaseCommand {
5  static description = 'description of this example command';
6
7  static flags: = {
8    myFlag: flags.string({
9      char: 'f',
10      description: 'My flag',
11    })
12  };
13
14  static args = [
15    {name: 'myArg'}
16  ];
17}

Single command

Define your command in src/commands/myCommand.ts, but specify the command in bootstrap function :

1#!/usr/bin/env node
2
3import { bootstrap } from 'nestjs-console-oclif';
4import { AppModule } from './app.module';
5import { MyCommand } from './commands/myCommand';
6
7bootstrap({
8  nestModule: AppModule,
9  singleCommand: MyCommand
10});
11

Register your commands entrypoints

Define the entrypoint of the command defined in MyCommand.

:warning: The entrypoint does not take arguments.

1import { Injectable } from '@nestjs/common';
2import { OclifCommand } from 'nestjs-console-oclif';
3
4@Injectable()
5export class AppService {
6
7  @OclifCommand('myCommand')
8  async run(): Promise<void> {
9    // Do something
10  }
11}

Read Args and flags

Load your parameters from NestJS context with the decorators OclifArgs and OclifFlags :

1import { OclifFlags, OclifCommand, OclifArgs } from 'nestjs-console-oclif';
2import { Injectable } from '@nestjs/common';
3
4@Injectable()
5export class AppService {
6  constructor(
7        @OclifFlags('myFlag') protected myFlag: string,
8        @OclifArgs('myArg') protected myArg: string) {
9  }
10
11  @OclifCommand('myCommand')
12  async run(): Promise<void> {
13    console.log(`my flag : ${this.myFlag}`);
14    console.log(`my arg : ${this.myArg}`);
15  }
16}