Home Reference Source 
import {CLI} from 'projext-plugin-runner/src/services/cli/cli.js'
public class | source

CLI

The main CLI program interface where all the commands are registered and that works as a bridge between the app and commander.

Constructor Summary

Public Constructor
public

constructor(info: Object, name: string)

Class constructor.

Member Summary

Public Members
public

This app package.json information.
public

The name of the CLI program.

Method Summary

Public Methods
public

start(commands: Array<CLICommand>)

Start the interface with a list of commands.

Public Constructors

public constructor(info: Object, name: string) source

Class constructor.

Params:

NameTypeAttributeDescription
info Object

This app package.json information.
name string
  • optional
  • default: ''

The name of the program. If not specified, it will use the one on info object.

Public Members

public info: Object source

This app package.json information.

public name: string source

The name of the CLI program.

Public Methods

public start(commands: Array<CLICommand>) source

Start the interface with a list of commands.

Params:

NameTypeAttributeDescription
commands Array<CLICommand>

A list of commands to register.