Nearly Picked Makefiles

    help-me

    4.0.1 • Public • Published

    help-me

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

    Example

    'use strict'
    
    var helpMe = require('help-me')
    var path = require('path')
    var help = helpMe({
      dir: path.join(__dirname, '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 path = require('path')
    var help = require('help-me')({
      dir: path.join(__dirname, 'doc')
    })
    
    commist.register('help', help.toStdout)
    
    commist.parse(process.argv.splice(2))

    Acknowledgements

    This project was kindly sponsored by nearForm.

    License

    MIT

    Install

    npm i help-me

    DownloadsWeekly Downloads

    540,781

    Version

    4.0.1

    License

    MIT

    Unpacked Size

    12 kB

    Total Files

    18

    Last publish

    Collaborators

    • matteo.collina