# meow-help

> Generate help text for meow.

Latest version **0.3.0** (published 2019-05-22) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.0 |
| Published | 2019-05-22 |
| First published | 2019-05-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 5 |
| Unpacked size | 13.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Maarten Brakee |
| Maintainers | maartenbrakkee |
| Keywords | meow, cli, help, javascript, command-line, nodejs |

## Links

- npm: https://www.npmjs.com/package/meow-help
- Repository: https://github.com/maartenbrakkee/meow-help
- Homepage: https://github.com/maartenbrakkee/meow-help#readme
- Issues: https://github.com/maartenbrakkee/meow-help/issues
- npm.io page: https://npm.io/package/meow-help

## Dependencies (5)

- [chalk](https://npm.io/package/chalk.md) ^2.4.2
- [core-js](https://npm.io/package/core-js.md) ^3.1.0
- [cli-table3](https://npm.io/package/cli-table3.md) ^0.5.1
- [read-pkg-up](https://npm.io/package/read-pkg-up.md) ^6.0.0
- [normalize-package-data](https://npm.io/package/normalize-package-data.md) ^2.5.0

## 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

- 0.3.0 (latest) — 2019-05-22
- 0.2.0 — 2019-05-22
- 0.1.0 — 2019-05-21

## README

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

> Help text generator for [meow](https://github.com/sindresorhus/meow).

![](https://media.giphy.com/media/KjqnOCVXbIkiA/giphy.gif)

## Features

- Generates clean and styled help text
- Simplifies the usage of meow

## Install

```
$ npm install meow-help
```

## Usage

```js
const meowHelp = require("meow-help");
const meow = require("meow");
const foo = require(".");

const flags = {
  rainbow: {
    type: "boolean",
    alias: "r",
    description: "Include a rainbow."
  }
}

const cli = meow(meowHelp(flags), {
	flags: flags
});

foo(cli.input[0], cli.flags);
```
## API

```js
meowHelp(flags, description);
```

Returns a `String` that can be passed as `helpText` to [meow](https://github.com/sindresorhus/meow).

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| flags | `Object` | ✅ | Flags object for meow, extended with descriptions. |
| description | `String` | ❌ | Extra description text shown when `--help` is called. |


## License

MIT © [Maarten Brakkee](https://maartenbrakkee.nl)

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