SuperCMD

SuperCMD is a framework to build command-line interfaces in Node.js

Usage

// commands/list.js
import { Command } from 'supercmd'

export const command = new Command()

command
  .cmd('list [options]')
  .description('List todos')
  .option('-s, --sort', 'Example of a boolean parameter')
  .option('-n, --num-items [num]', 'Example of an optional numeric parameter')
  .option('--filter [str]', 'Example of an optional string parameter')
  .action((ctx) => {
    // place command's code here
  })

// commands/create.js
import { Command } from 'supercmd'

export const command = new Command()

command
  .cmd('create')
  .description('Create todo')
  .input('Enter a title', 'Example of an optional string parameter')
  .action((ctx) => {
    // place command's code here
  })

Command entrypoint

The entrypoint file loads the command files from a directory.

#!/usr/bin/env node
require('firescript/register')
const {CommandsList} = require('supercmd')

const supercmd = new CommandsList()
supercmd.importFromDir(`${__dirname}/cli`).then((commandList) => {
  if (process.argv[2] === 'help') {
    commandList.printHelpPage(process.argv[3])
    return
  }

  if (process.argv[2] === 'commands') {
    commandList.printCommandsList(process.argv[3])
    return
  }

  commandList.callCommand(process.argv)
}).catch ((err) => {
  console.error(err)
  process.exit(1)
})

API

.cmd(str command)

Register a subcommand. A subcommand can take 0 - n arguments.

Wrap argument types in [ and ]. An leading ? marks it as optional. Command types are either str or num

Example: mycommand [str] [str?] This would register a command mycommand with two arguments. The second one is optional. Both arguments are handled as strings. You can access the arguments as second and third arguments in the action handler.

.action((ctx, infile, outfile) => {

})

.cwd(str workingDir)

Set a working dir

.description(str description)

Describe what a program is for and what is does, show in the help page

.option(str arg, str description, any defaultValue, func func)

Register an option parameter. The param argument describes the parameter name, alias, value und value type. The syntax is [alias] [name] [value].

Alias is an one char long shortcut of the parameter and it is prefixed by one minus char. Example: -f.
Name is a parameter name. It is prefixed by two minus and its the only required part. A parameter can contain chars, numbers and a minus. Example: --fruit, --fruit-banana. The third part describes the parameter value and if it is a mandatory parameter or not. The default type is bool. The type must be enclosed by square bracets. A leading ? in the value type defines the parameter as optional.

Example for a required parameter of type boolean: -f --fruit [bool]

Example for a optional parameter of type string: -b --banana [str?]

Allowed types: str, num, arr, bool, json

.input(str name, str question, str type, any values)

Ask for input parameter. All input parameter are available as ctx.input.<name>

.usage(str description)

Describes program usage, shown in the help page.