Package Exports

help-me

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 (help-me) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

help-me

Help command for node, to use with minimist and commist.

Example

'use strict'

var helpMe = require('help-me')
var help = helpMe({
  // the default
  dir: path.join(path.dirname(require.main.filename), 'doc'),
  // the default
  ext: '.txt'
})

help
  .createStream(['hello']) // can support also strings
  .pipe(process.stdout)

// little helper to do the same
help.toStdout(['hello']

Usage with commist

Commist provide a command system for node.

var commist = require('commist')()
var help = require('help-me')()

commist.register('help', help.toStdout)

commist.parse(process.argv.splice(2))

Acknowledgements

This project was kindly sponsored by nearForm.

License

MIT