0.3.0 • Published 5 years ago
meow-help v0.3.0
meow-help
Help text generator for meow.
Features
- Generates clean and styled help text
- Simplifies the usage of meow
Install
$ npm install meow-help
Usage
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
meowHelp(flags, description);
Returns a String
that can be passed as helpText
to 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