help-me

WebJar for help-me

License	MIT
GroupId	org.webjars.npm
ArtifactId	help-me
Last Version	1.1.0
Release Date	Jul 15, 2018
Type	jar
Description	help-me WebJar for help-me
Project URL	http://webjars.org
Source Code Management	https://github.com/mcollina/help-me

Download help-me

Filename	Size
help-me-1.1.0.pom
help-me-1.1.0.jar	9 KB
help-me-1.1.0-sources.jar	22 bytes
help-me-1.1.0-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/help-me/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>help-me</artifactId>
    <version>1.1.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/help-me/
implementation 'org.webjars.npm:help-me:1.1.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/help-me/
implementation ("org.webjars.npm:help-me:1.1.0")

Apache Buildr

'org.webjars.npm:help-me:jar:1.1.0'

Apache Ivy

<dependency org="org.webjars.npm" name="help-me" rev="1.1.0">
  <artifact name="help-me" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='help-me', version='1.1.0')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "help-me" % "1.1.0"

Leiningen

[org.webjars.npm/help-me "1.1.0"]

Dependencies

compile (4)

Group / Artifact	Type	Version
org.webjars.npm : callback-stream	jar	[1.0.2,2)
org.webjars.npm : glob-stream	jar	[6.1.0,7)
org.webjars.npm : through2	jar	[2.0.1,3)
org.webjars.npm : xtend	jar	[4.0.0,5)

Project Modules

There are no modules declared in this project.

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

Versions

Version
1.1.0 Jul 15, 2018