https://github.com/ahmadawais/cli-meow-help
š Generate automagically formatted help text for `meow` CLI app helper.
https://github.com/ahmadawais/cli-meow-help
cli command-line help javascript kitten meow meow-help nodejs
Last synced: 8 months ago
JSON representation
š Generate automagically formatted help text for `meow` CLI app helper.
- Host: GitHub
- URL: https://github.com/ahmadawais/cli-meow-help
- Owner: ahmadawais
- License: mit
- Created: 2020-07-08T16:05:12.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-08-13T23:43:57.000Z (about 1 year ago)
- Last Synced: 2024-10-19T07:54:27.486Z (12 months ago)
- Topics: cli, command-line, help, javascript, kitten, meow, meow-help, nodejs
- Language: JavaScript
- Homepage: https://NodeCLI.com?utm_source=github&utm_medium=referral&utm_campaign=ahmadawais/cli-meow-help
- Size: 761 KB
- Stars: 35
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- Funding: .github/funding.yml
- License: license
- Code of conduct: code-of-conduct.md
Awesome Lists containing this project
README
[](./../../)
# cli-meow-help
[](https://www.npmjs.com/package/cli-meow-help) [](https://NodeCLI.com/?utm_source=FOSS) [](https://VSCode.pro/?utm_source=FOSS) [](https://github.com/ahmadawais/sponsor?utm_source=FOSS)
[](https://twitter.com/mrahmadawais/)
> Generate automatically formatted help text for [`meow`](https://github.com/sindresorhus/meow) CLI helper
[](./../../)
## Install
```sh
npm install meow cli-meow-help
```
[](./../../)
## Usage
```js
const meow = require('meow');
const meowHelp = require('cli-meow-help');
const commands = {
new: {desc: `Creates a new user account`},
duplicate: {desc: `Duplicates a user account`}
};
const flags = {
random: {
desc: `Prints random data`,
type: 'boolean',
default: true
}
};
const helpText = meowHelp({
name: `cli-command`,
flags,
commands
});
meow(helpText, {flags});
// Now run `cli-command --help` to view the
// following auto formatted & generated help info.
```
[](./../../)
[](./../../)
## API
### meowHelp(options)
#### āÆ options
Type: `object`
Default: ā
```js
{
name = `(CLI name undefined)`,
desc,
commands = {},
flags = {},
examples = [],
defaults = true,
header,
footer
}
```
You can specify the options below.
#### āÆ name
Type: `string`
Default: `(CLI name undefined)`
The `bin` command name of the cli that's used to run the CLI. Examples: `corona` for the [corona-cli](https://github.com/AhmadAwais/corona-cli) that's installed globally or `npx corona-cli` for if `npx` is the recommended usage.
#### āÆ desc
Type: `string`
Default: `undefined` (optional)
Optionally define a description text for the help message.
#### āÆ commands
Type: `string`
Default: `{}` (optional)
Optionally, define a JavaScript object containing info on the CLI commands (i.e. `meow` inputs). Each command has a `desc` property to define the help text.
#### āÆ flags
Type: `string`
Default: `{}`
Define CLI options (i.e. `meow` flags) just like you do with `meow` which is the `flags` JavaScript object containing each flag with an extra `desc` property to define the help text.
##### > examples
Type: `Array`
Default: `[]`
List optional examples of how to use the CLI.
> Check the [test](./test.js) file for more context. Format example:
```js
const examples = [
{
command: `new`,
flags: [`random`]
}
];
```
#### āÆ defaults
Type: `string`
Default: `true` (optional)
Prints out the default values of flags. Set to `false` to disable.
#### āÆ header
Type: `string`
Default: `undefined` (optional)
Optionally, add additional header information.
#### āÆ footer
Type: `string`
Default: `undefined` (optional)
Optionally, add additional footer information.
[](changelog.md)
## Changelog
[āÆ Read the changelog here ā](changelog.md)
**KEY**: `š¦ NEW`, `š IMPROVE`, `š FIX`, `š DOC`, `š RELEASE`, and `š¤ TEST`
> _I use [Emoji-log](https://github.com/ahmadawais/Emoji-Log), you should try it and simplify your git commits._
[](./../../)
## License & Conduct
- MIT Ā© [Ahmad Awais](https://twitter.com/MrAhmadAwais/)
- Thanks to Maarten Brakkee for initial implementation
- [Code of Conduct](code-of-conduct.md)
[](./../../)
## Connect
Ā (follow) To stay up to date on free & open-source software
Ā (follow) To get #OneDevMinute daily hot tips & trolls
Ā (subscribe) To tech talks & #OneDevMinute videos
Ā (read) In-depth & long form technical articles
Ā (connect) On the LinkedIn profile y'all
[](https://github.com/AhmadAwais/sponsor)
## Sponsor
Me ([Ahmad Awais](https://twitter.com/mrahmadawais/)) and my incredible wife ([Maedah Batool](https://twitter.com/MaedahBatool/)) are two engineers who fell in love with open source and then with each other. You can read more [about me here](https://ahmadawais.com/about). If you or your company use any of my projects or like what Iām doing then consider backing me. I'm in this for the long run. An open-source developer advocate.
[](https://twitter.com/mrahmadawais/)
### [NodeCLI.com][n] ā Learn to build Node.js CLI Automation
> This repository is part of the [NodeCLI.com][n] course.
After building hundreds of developer automation tools used by millions of developers, I am sharing exactly how you can do it yourself with minimum effective effort. Learn to build Node.js & JavaScript based CLI (Command Line Interface) apps. Automate the grunt work, do more in less time, impress your manager, and help the community.
ā I'm sharing it all in this online video course. [Node CLI Automation
without wasting a 1,000 hours][n] ā
[][n]
[][n]
[n]: https://NodeCLI.com?utm_source=github&utm_medium=referral&utm_campaign=ahmadawais/cli-meow-help
[](https://github.com/AhmadAwais/sponsor)