cmd-liner

A command line utility library to make it easier to make command line tools.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
cmd-liner
431.0.317 years ago8 years agoMinified + gzip package size for cmd-liner in KB

Readme

cmd-liner
Node.js library to help build awesome command line tools.

Installation

$ npm install cmd-liner

Features

Hierarchical (nested) commands. Easily provide documentation for every one of the commands. Handle errors when you want to.

Quick Start

var cmdliner = require('cmd-liner');

Now you need to create your commands object.
var commands = {};
commands.say = {
  action: function(cmd) {
    console.log('I say ' + cmd.args[0]);
  },
  argsCount: 1,
  desc: "A good description for the command 'say' :D"
};
commands.command2 = {
  commands: {
    is: function(optimist) {
      console.log('I can use optimist to parse arguments');
    }
  },
  nohandler: function() { console.error('No handler for this command :(')); }
}

Then you can initialize the command liner.
cmdliner.init(commands);

Take a look at https://github.com/substack/node-optimist. Every 'action' will be called with the instance of 'optimist' so you can parse arguments and create aliases. If your requirement needs no such thing, don't worry about it.

To-Do

  • X Allow non-dashed parameters. (like 'echo $arg0')
  • More code examples and documentation