Package Exports

command-line-commands

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (command-line-commands) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

command-line-commands

A lightweight module to help build a git-like command interface for your app.

Synopsis

Create a list of valid commands (null represents "no command"). Supply it to commandLineCommands(), receiving back an object with two properties: command (the supplied command) and argv (the remainder of the command line args):

const commandLineCommands = require('command-line-commands')

const validCommands = [ null, 'clean', 'update', 'install' ]
const { command, argv } = commandLineCommands(validCommands)

console.log('command: %s', command)
console.log('argv:    %s', JSON.stringify(argv))

Assuming the above script is installed as example:

$ example
command: null
argv:    []

$ example --verbose
command: null
argv:    ["--verbose"]

$ example install --save something
command: install
argv:    ["--save","something"]

From here, you can make a decision how to proceed based on the command and argv received. For example, if no command (null) was passed, you could parse the remaining argv for general options:

if (command === null) {
  const commandLineArgs = require('command-line-args')
  const cli = commandLineArgs([
    { name: 'version', type: Boolean }
  ])

  // pass in the `argv` returned by `commandLineCommands()``
  const options = cli.parse(argv)

  if (options.version) {
    console.log('version 1.0.1')
  }
}

Or, process an install command:

if (command === 'install') {
  const commandLineArgs = require('command-line-args')
  const cli = commandLineArgs([
    { name: 'save', type: Boolean },
    { name: 'dir', type: String }
  ])

  // pass in the `argv` returned by `commandLineCommands()``
  const options = cli.parse(argv)

  // perform installation to the directory specified by `options.dir`.
  installSomething(options.dir)
}

Examples

Both examples use command-line-args for option-parsing.

Simple: A basic app with a couple of commands.
Advanced: A more complete example, implementing part of the git command interface.

Usage guides

Usage guides can be generated by command-line-usage. See here for an example (uses v3 of command-line-usage which is still in progress).

API Reference

Example

const commandLineCommands = require('command-line-commands')