help.js

function rangeArg (desc, type) {
  return {
    type: type,
    description: 'only results ' + desc + ' ' + type,
    optional: true
  }
}

function rangeArgs (type) {
  return {
    gte: rangeArg('greater than or equal to', type),
    lte: rangeArg('less than or equal to', type),
    gt: rangeArg('greater than ', type),
    lt: rangeArg('less than', type),
    reverse: {type: 'boolean', test: 'boolean', description: 'output is reversed', optional: true},
    live: {type: 'boolean', test: 'boolean', description: 'include live results', optional: true},
    old: {type: 'boolean', test: 'boolean', description: 'include old results', optional: true}
  }
}

var keysAndValues = {
   keys: {
      type: 'boolean',
      description: 'include keys',
      optional: true
    },
    values: {
      type: 'boolean',
      description: 'include values',
      optional: true
    }
}

var MessageId = {
  type: 'string',
  test: /^%[a-zA-Z0-9+/]+={0,2}\.\w+$/
}

var Private = {
  type: 'boolean',
  description: 'decrypt private messages',
  default: false
}

module.exports = {
  description: 'append only-log database for secure-scuttlebutt',
  commands: {
    createLogStream: {
      type: "source",
      description: 'stream of all locally stored messages, in order received',
      args:
        Object.assign(rangeArgs('timestamp'), keysAndValues)
    },
    get: {
      type: "async",
      description: 'retrive a locally stored message',
      args: {
        id: MessageId,
        private: Private,
        meta: {
          type: 'boolean',
          description: 'include key, value, and timestamp',
          default: false
        }
      }
    },
    publish: {
      type: 'async',
      description: 'publish a message',
      args: {}
    },
    add: {
      type: 'async',
      description: 'append a valid message',
      args: {},
    },
    status: {
      type: 'sync',
      description: 'show internal system statuses',
      args: {}
    },
    progress: {
      type: 'sync',
      description: 'show internal progress',
      args: {}
    },
    version: {
      type: 'sync',
      description: 'show version numbers',
      args: {}
    },
    whoami: {
      type: 'sync',
      description: 'print main identity',
      args: {}
    },
    createHistoryStream: {
      type: 'source',
      description: 'output messages from a feed in order',
      args: Object.assign({
        id: {
          type: 'FeedId',
          optional: false,
          description: 'a ssb feed identity',
        },
        seq: {
          type: 'SequenceNumber',
          optional: true,
          description: 'sequence number to stream from',
        },
        limit: {
          type: 'number',
          description: 'max number of messages to output',
          optional: true
        }
      }, keysAndValues)
    }
  }
}

//ways to call usage:

//quick: lists commands, or help
//deep: print all options or all subcommands
//help: print all subcommands

/*

quick: command1|command2|command3...

deep: command1.foo
    --blah <type> # description
    ...

help:
  command1.foo --{blah,...}
  command1.bar --{blah,...}

*/