Cli

Handles the command-line integration based on docopt specification.

It enables the execution of actions triggered as command-line applications. The args are parsed using the reader CliArgs and the output is provided by writer CliOutput.

Using cli handler:

Creating an action that can be executed through command-line

@Mebo.grant('cli')
@Mebo.register('myAction')
class MyAction extends Mebo.Action{
  constructor(){
    super();
    this.setMeta('description', 'Welcome!');
    this.createInput('myArgument: text', {elementType: 'argument', description: 'my argument'});
    this.createInput('myOption: bool', {description: 'my option'});
  }

  async _perform(data){
    const result = {
      myArgument: data.myArgument,
      myOption: data.myOption,
    };
    return result;
  }
}

The command-line support can be invoked in two ways:

1) Multiple commands (recommended): Used to provide multiple granted actions through command-line

if (require.main === module) {
  const cli = Mebo.Handler.get('cli');
  if (cli.isSupported()){
    cli.init();
  }
}

When this method is used the command-line help (-h or --help) provides a list of commands:

node mycli.js --help
 __  __      _
|  \/  | ___| |__   ___
| |\/| |/ _ \ '_ \ / _ \_
| |  | |  __/ |_) | (_) |
|_|  |_|\___|_.__/ \___/

Available commands:
    myAction

In order to access the help for each command you need to provide the command name before the help flag (-h or --help)

node . myAction --help
Welcome.

Usage: node mycli.js myAction [options] <my-argument>

Arguments:
  my-argument     my argument (text type).

Options:
  --my-option     my option (bool type).

A complete example about providing multiple commands through command-line can be found at: https://github.com/meboHQ/example-cli

2) Single command: Used to provide just a single granted action through command-line

if (require.main === module) {
  // creating an cli handler which is used to load the arguments
  // arguments to the action and to output the result back to the stream
  const cli = Mebo.Handler.create('cli');

  // loading the parsed information to the action
  cli.runAction('myAction').then((result) => {

  // success output
  cli.output(result);

  // error output
  }).catch((err) => {
    cli.output(err);
  });
}

When using the single command the help flag (-h or --help) provides the help about the command directly:

node mycli.js --help
Welcome.

Usage: node mycli.js [options] <my-argument>

Arguments:
  my-argument     my argument (text type).

Options:
  --my-option     my option (bool type).