command-line interface to mux rpc servers
Switch branches/tags
Clone or download
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Add config for Stale app Nov 1, 2018
.gitignore Add .gitignore to ignore node_modules Oct 29, 2018
.npmrc Add .npmrc to disable package-lock.json Oct 29, 2018 add TypeError to usage-triggering error types Sep 13, 2015
example.js initial implementation Sep 13, 2015
index.js implement verbose mode Oct 23, 2016
package.json 1.1.0 Oct 23, 2016


Command-line interface to muxrpc servers. Works by converting the command-line parameters into args for the RPC calls. Also adds some standard behaviors for usage calls.

CLI Parameters

Parameters are parsed with minimist. The first positional param is mapped to the rpc command. Any subsequent positional params are passed as arguments. Then, the object constructed by the named parameters (if there are any) is passed as the last argument.


$ program command arg1 arg2
invokes `server.command("arg1", "arg2")`

$ program command -a beep -b boop
invokes `server.command({ a: "beep", b: "boob" })'

$ program command arg1 arg2 -a beep -b boop
invokes `server.command("arg1", "arg2", { a: "beep", b: "boob" })'

$ program command -a beep -b boop arg1 arg2 
invokes `server.command("arg1", "arg2", { a: "beep", b: "boob" })'

If a stream is supplied to stdin, it will be parsed as JSON and used instead of the CLI parameters.

$ echo '{"a":"beep","b":"boop"}' | program command
invokes `server.command({ a: "beep", b: "boob" })'

Usage calls

Usage-calls are the help which is output when a command fails, or when help is requested. They are used in the following situations:

  • If the command does not exist in the RPC server's manifest, does a top-level usage call.
  • If the command responses with a TypeError, UsageError, BadParamError, or BadArgError, does a usage call for that command.
  • If the -h or --help switches are given, does a toplevel or command usage call.

A usage-call is a call to the usage(cmd) function on the RPC server. A 'top-level' usage call will leave cmd falsey. The usage method should return a string to display.

Example rpc server

var zerr = require('zerr')
var MissingArgError = zerr('BadArg', '"%" is required')
var BadTypeError = zerr('BadArg', '"%" must be a valid %')

var manifest = {
  usage: 'sync',
  whoami: 'sync',
  ping: 'async'
var api = {}
// muxrpc(null, manifest)(api) is called

api.usage = function (cmd) {
  switch (cmd) {
    case 'whoami':
      return 'whoami. get your profile info.'
    case 'ping':
      return 'ping {target} [-n times]. send `n` pings to `target`, defaults to 1'
  return [
    'myexample usage:'
    ' - ' + api.usage('whoami'),
    ' - ' + api.usage('ping')

api.whoami = function() { return 'bob, obviously' } = function(target, opts, cb) {
  if (!target) return cb(MissingArgError('target'))
  if (!isAddress(target)) return cb(BadTypeError('target', 'address'))
  var n = 1
  if (opts && opts.n) {
    n = +opts.n
    if (isNaN(n)) return cb(BadTypeError('n', 'number'))

  // ...

Here's how a session would behave with this server:

$ myexample
myexample usage:
 - whoami. get your profile info.
 - ping {target} [-n times]. send `n` pings to `target. defaults to 1

$ myexample whoami -h
whoami. get your profile info.

$ myexample ping -h
ping {target} [-n times]. send `n` pings to `target. defaults to 1

$ myexample whoami
bob, obviously

$ myexample ping

$ myexample ping 1123123123
[BadArgError: "target" must be a valid address]
ping {target} [-n times]. send `n` pings to `target. defaults to 1

$ myexample ping -n foobar
[BadArgError: "n" must be a valid number]
ping {target} [-n times]. send `n` pings to `target. defaults to 1