# help

> substack way of --help

Latest version **3.0.2** (published 2016-05-08) · MIT license · 0 weekly downloads

## Install

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

## 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 | 3.0.2 |
| Published | 2016-05-08 |
| First published | 2015-05-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Evan Lucas |
| Maintainers | eh, evanlucas |

## Links

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

## Recent versions

- 3.0.2 (latest) — 2016-05-08
- 3.0.1 — 2016-04-28
- 3.0.0 — 2016-04-28
- 2.1.3 — 2016-04-27
- 2.1.2 — 2015-10-30
- 2.1.1 — 2015-09-02
- 2.1.0 — 2015-05-19
- 2.0.0 — 2015-05-10
- 1.0.0 — 2015-05-08

## README

# help

[![Build Status](https://travis-ci.org/evanlucas/help.svg)](https://travis-ci.org/evanlucas/help)
[![Coverage Status](https://coveralls.io/repos/evanlucas/help/badge.svg?branch=master&service=github)](https://coveralls.io/github/evanlucas/help?branch=master)

[substack](https://github.com/substack) way of --help

v3 of `help` requires at least Node.js v4. To use `help` with an older version,
please use `help@2.x`.

## Install

```bash
$ npm install help
```

## Usage

```js
var help = require('help')('usage.txt')

if (/* someone requested help */) {
  return help(0)
}
```

## API

### help(filepath, stream)

returns function(code)

Pipes the contents of <filepath> to `process.stdout`.

`code` is the exit code. If not falsy, then the process is explictly exited.

`stream` defaults to `process.stdout`

## Full example

```js
var help = require('help')('usage.txt')
var args = process.argv.splice(2)
if (args[0] === '-h' || args[0] === '--help' || args[0] === 'help') {
  // process prints contents of `usage.txt` and returns
  return help()
}

// the first arg must be a number
if (isNaN(args[0])) {
  // process prints contents of `usage.txt` and exits with code 1
  return help(1)
}
```

## Author

Evan Lucas

## License

MIT (See `LICENSE` for more info)

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