generate-help v1.0.2

generate-help

Build a help output for CLI programs.

Installation

$ npm install generate-help --save

Usage

Note: options are compatible with minimist-options.

const help = require('generate-help');

let output = help({
  usage: 'hello [options] <command>',
  desc: 'Very cool description',
  options: {
    help: {
      alias: 'h',
      desc: 'Display help'
    },

    force: {
      aliases: ['f'],
      desc: 'Force something'
    }
  },
  commands: [{
    name: 'hi',
    desc: 'Say hi'
  }, {
    name: 'yo',
    desc: 'Say yo'
  }]
});

process.stdout.write(output);

Tests

$ make test

License

MIT © Vadym Demedes