Build powerful command-line interfaces from simple ES6 modules.

Usage

Each command is defined within an ES module like so:

// commands/foo.cmd.js

export const name = 'foo';
export const description = 'A thing that does something.';
export const alias = 'f'; // String or Array.
export const group = 'Utilities';

export const args = {
  'param1': 'the first parameter',
  'param2': 'the second param',
  '--foo': 'a boolean flag',
};

export const validate = (args) => args;

export default (args) {
  // Run the command.
};

All exports are optional. If a name is omitted the name of the module is assumed. The only thing you really need is the default export function to invoke when the command is run.

If you don't wish to export the command as a default export, your can export a function named cmd, eg:

export async function cmd(args) {
  // Run the command.
}

To initialize the CLI, from the entry point of your module pass a glob pattern representing your JS modules that are commands. Typically these have a .cmd.js suffix:

import command from 'command-interface';
command('./**/*.cmd.js');

This will load all modules with the .cmd.js suffix anywhere within the project and produce the following index list when run with no command argument:

Command Help

To get details on a specific command:

node . foo -h

Run a Command

node . foo param1 flag=123 -f

The parameter and option arguments are passed to the command function as the args parameter.

{
  args: ['param1'],
  options: { flag: 123, f: true },
}

See minimist for more.

Example

cd lib/examples
node .

Tests

npm test

Usages

• msync - A powerful toolkit for building and syncing multiple node-modules in a flexibly defined workspace.

• new-file - Simple file templates.

Next

• Update checker

Change Log

All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning.

[Unreleased] - YYYY-MM-DD

Added

Changed

Deprecated

Removed

Fixed

Security

[4.2.0] - 2020-01-13

Changed

• Update dependency versions.

  Removed

• Removed lodash export references (namely debounce). Use observables instead! :)

[4.0.0] - 2018-06-27

Removed

Remove table export (not available via log.table()).

[3.0.24] - 2018-03-31

Added

Changed

• Updated typescript (using @tdb libs)
• Format with Prettier https://github.com/prettier/prettier

[3.0.0] - 2017-04-30

Changed

• Converted to using glob patterns to initialize commands.

  import command from 'command-interface';
  command('./**/*.cmd.js');

[2.2.0] - 2016-07-09

Added

• Command aliases.

[2.0.0] - 2016-06-02

Changed

• Loading commands from modules. Initialized from a directory path

[1.0.0] - 2016-05-17

Added

Initial creation and publish.