# help-me

> Help command for node, partner of minimist and commist

Latest version **5.0.0** (published 2023-12-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install help-me
pnpm add help-me
yarn add help-me
bun add help-me
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 5.0.0 |
| Published | 2023-12-13 |
| First published | 2014-12-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 14.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 16 |
| Author | Matteo Collina |
| Maintainers | matteo.collina |
| Keywords | help, command, minimist, commist |

## Links

- npm: https://www.npmjs.com/package/help-me
- Repository: https://github.com/mcollina/help-me
- Issues: https://github.com/mcollina/help-me/issues
- npm.io page: https://npm.io/package/help-me

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 5.0.0 (latest) — 2023-12-13
- 4.2.0 — 2022-12-15
- 4.1.0 — 2022-09-06
- 4.0.1 — 2022-06-07
- 4.0.0 — 2022-06-05
- 2.0.1 — 2021-06-22
- 3.0.0 — 2021-05-30
- 2.0.0 — 2020-11-28
- 1.1.0 — 2017-04-11
- 1.0.1 — 2016-08-18
- 1.0.0 — 2016-07-12
- 0.2.0 — 2014-12-29
- 0.1.0 — 2014-12-05

## README

help-me
=======

Help command for node, to use with [minimist](http://npm.im/minimist) and [commist](http://npm.im/commist).

Example
-------

```js
'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'])
```

Using ESM and top-level await::

```js
import { help } from 'help-me'
import { join } from 'desm'

await help({
  dir: join(import.meta.url, 'doc'),
  // the default
  ext: '.txt'
}, ['hello'])
```

Usage with commist
------------------

[Commist](http://npm.im/commist) provide a command system for node.

```js
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](http://nearform.com).

License
-------

MIT

---
_Source: https://npm.io/package/help-me · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._