import { ShellModule, ShellFacade } from 'nestjs-shell' // `ShellModule` is Global, so please put it only in your main module and it will work flawlessly in others.  @Module({ imports: [ShellModule] }) export class YourAppMainModule implements OnApplicationBootstrap { constructor(private readonly shellFacade: ShellFacade) {} public async onApplicationBootstrap(): Promise<void> { // You can use it without passing any arguments and use default configuration or configure it in your own way. await this.shellFacade.bootstrap() // It does not have to be here, you can register components anywhere you want and as many times as you need.  this.shellFacade.registerComponents( new SayCommandComponent(), new AnotherSecondTestCommandComponent(new SomeDependency()), ) } }

import { ShellCommand, ShellComponent } from 'nestjs-shell' /* Please do not put @Injectable() or any other decorator that creates a new instance of a class,   it may cause bugs and it is definitely not going to work the way you want.  */ export class SayCommandComponent extends ShellComponent { /* Only `name` property is required, so by default you have no prefix, no description and no pattern  and it works fine!  */ /* Pattern ideology is simple:  if your parameter name is wrapped with `<` and `>` then it's required  if your parameter name is wrapped with `[` and `]` then it's optional  if there is `@` sign inside any brackets (`[` or `<`) then it's varargs.   Same as in JavaScript varargs, they can only be placed in the last parameter.  */ @ShellCommand({ name: 'say', prefix: '.', description: 'Sends a message to the console', pattern: '<sender> [@message]', }) public async sayCommand(sender: string, message: string): Promise<string> { return `${sender} says: ${message || 'Nothing'}` } // There is no limit to the amount of commands in one ShellComponent. @ShellCommand({ name: 'said', prefix: '/', description: 'Sends a message to the console that has been said', pattern: '<sender> <@message>', }) /* You don't have to keep function's parameters in the same order as pattern ones.   They are applied by name, not order.  */ public async saidCommand(sender: string, message: string): Promise<string> { return `${sender} said: ${message}` } }

import { ShellCommand, ShellComponent } from 'nestjs-shell' export class AnotherSecondTestCommandComponent extends ShellComponent { constructor(private readonly someDependency: TestDependency) { super() } /* You can use as much prefixes as you want..   if you do not specify any then it uses the default, which is '' (empty string)  */ @ShellCommand({ name: '.help', description: 'Displays all commands with description and usage', }) public async help(): Promise<string> { // Method's execution context is ALWAYS set to the actual class instance and so `this` keyword works as expected. return [ 'Here are all available commands: ', '-------------------------------------', ...this.someDependency, ...this.shellFacade.getAllCommands().map((command) => { return `-> ${command.name} ${command.pattern} - ${command.description || 'Description not available'}` }), '-------------------------------------', ].join('\n') } }

import { ShellFacade } from 'nestjs-shell'

type BootstrapOptions = { prompt?: string = '⤳' messages?: { notFound?: string; wrongUsage?: string } = { notFound: 'Say what? I might have heard $input', wrongUsage: 'Wrong usage: $command $pattern', } shellPrinter?: ((value: any) => void) = (value: any) => console.log(value) }