Halaman utama Jelajahi Bantuan
Daftar Masuk
sunny
/
lzyd-map-h
1
0
Fork 0
Berkas Masalah 0 Tarik Permintaan 0 Wiki
Cabang: master
Ranting Tag
lzyd-map-h
/
node_modules
/
help-me
b s s m e0c8121d0c first commit 3 tahun lalu
..
doc e0c8121d0c first commit 3 tahun lalu
fixture e0c8121d0c first commit 3 tahun lalu
.npmignore e0c8121d0c first commit 3 tahun lalu
.travis.yml e0c8121d0c first commit 3 tahun lalu
LICENSE e0c8121d0c first commit 3 tahun lalu
README.md e0c8121d0c first commit 3 tahun lalu
example.js e0c8121d0c first commit 3 tahun lalu
help-me.js e0c8121d0c first commit 3 tahun lalu
package.json e0c8121d0c first commit 3 tahun lalu
test.js e0c8121d0c first commit 3 tahun lalu

README.md

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