module-shell-command-execution.md

Example: module shell command execution

module-shell-config.yml

commands:
  - name: module-shell
    description: execute shelljs commands
    command: ./module-shell.js
    commandType: Module

module-shell.js

module.exports = function (input) {
  input.cliUtils.shelljs.exec('echo hello');

  // safeExec will throw an exception if the command exit code is not 0
  input.cliUtils.shelljsSafeExec('git stats'); // intentional typo
};

Usage

nca module-shell

Prints:

hello
git: 'stats' is not a git command. See 'git --help'.

The most similar command is
        status
# stacktrace...

Notes

Shelljs is passed as a one of the anonymous function input, to facilitate native command execution (i.e. useful to run git and docker commands which share the same interface across differen operating systems).

Moreover a shelljsSafeExec utility function can be used to run commands which can potentially fail: the function will throw an exception when the command has a non 0 exit code.