{"id":15487732,"url":"https://github.com/ahmadawais/cli-meow-help","last_synced_at":"2025-10-29T23:31:40.736Z","repository":{"id":41116903,"uuid":"278135080","full_name":"ahmadawais/cli-meow-help","owner":"ahmadawais","description":"🐈 Generate automagically formatted help text for `meow` CLI app helper.","archived":false,"fork":false,"pushed_at":"2024-08-13T23:43:57.000Z","size":779,"stargazers_count":35,"open_issues_count":1,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-10-19T07:54:27.486Z","etag":null,"topics":["cli","command-line","help","javascript","kitten","meow","meow-help","nodejs"],"latest_commit_sha":null,"homepage":"https://NodeCLI.com?utm_source=github\u0026utm_medium=referral\u0026utm_campaign=ahmadawais/cli-meow-help","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ahmadawais.png","metadata":{"files":{"readme":"readme.md","changelog":"changelog.md","contributing":null,"funding":".github/funding.yml","license":"license","code_of_conduct":"code-of-conduct.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"custom":["https://github.com/ahmadawais/sponsor","https://NodeCLI.com","https://VSCode.pro"]}},"created_at":"2020-07-08T16:05:12.000Z","updated_at":"2024-08-13T23:44:00.000Z","dependencies_parsed_at":"2024-06-18T17:07:20.667Z","dependency_job_id":"efea24d6-c4ea-407c-be5a-a2aed2a1dca0","html_url":"https://github.com/ahmadawais/cli-meow-help","commit_stats":{"total_commits":32,"total_committers":1,"mean_commits":32.0,"dds":0.0,"last_synced_commit":"2e2484448c59c3262839f7934dbf782976ebe9da"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmadawais%2Fcli-meow-help","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmadawais%2Fcli-meow-help/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmadawais%2Fcli-meow-help/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmadawais%2Fcli-meow-help/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ahmadawais","download_url":"https://codeload.github.com/ahmadawais/cli-meow-help/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238785245,"owners_count":19529931,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","command-line","help","javascript","kitten","meow","meow-help","nodejs"],"created_at":"2024-10-02T06:41:35.776Z","updated_at":"2025-10-29T23:31:40.268Z","avatar_url":"https://github.com/ahmadawais.png","language":"JavaScript","funding_links":["https://github.com/ahmadawais/sponsor","https://NodeCLI.com","https://VSCode.pro"],"categories":[],"sub_categories":[],"readme":"[![cli-meow-help running in a terminal](./.github/cli-meow-help.png)](./../../)\n\n# cli-meow-help\n\n[![DOWNLOADS](https://img.shields.io/npm/dt/cli-meow-help?label=DOWNLOADS%20%20❯\u0026colorA=6A788D\u0026colorB=6A788D\u0026style=flat)](https://www.npmjs.com/package/cli-meow-help) [![Node.js CLI](https://img.shields.io/badge/-NodeCLI.com-gray.svg?colorB=6A788D\u0026style=flat)](https://NodeCLI.com/?utm_source=FOSS) [![Learn VSCode](https://img.shields.io/badge/-VSCODE.pro-gray.svg?colorB=6A788D\u0026style=flat)](https://VSCode.pro/?utm_source=FOSS) [![Sponsor](https://img.shields.io/badge/-Sponsor-gray.svg?colorB=6A788D\u0026style=flat)](https://github.com/ahmadawais/sponsor?utm_source=FOSS)\n[![Follow @MrAhmadAwais on Twitter](https://img.shields.io/badge/FOLLOW%20@MRAHMADAWAIS%20%E2%86%92-gray.svg?colorA=6A788D\u0026colorB=6A788D\u0026style=flat)](https://twitter.com/mrahmadawais/)\n\n\u003e Generate automatically formatted help text for [`meow`](https://github.com/sindresorhus/meow) CLI helper\n\n\u003cbr\u003e\n\n[![📟](https://raw.githubusercontent.com/ahmadawais/stuff/master/images/git/install.png)](./../../)\n\n## Install\n\n```sh\nnpm install meow cli-meow-help\n```\n\n\u003cbr\u003e\n\n[![⚙️](https://raw.githubusercontent.com/ahmadawais/stuff/master/images/git/usage.png)](./../../)\n\n## Usage\n\n```js\nconst meow = require('meow');\nconst meowHelp = require('cli-meow-help');\n\nconst commands = {\n\tnew: {desc: `Creates a new user account`},\n\tduplicate: {desc: `Duplicates a user account`}\n};\n\nconst flags = {\n\trandom: {\n\t\tdesc: `Prints random data`,\n\t\ttype: 'boolean',\n\t\tdefault: true\n\t}\n};\n\nconst helpText = meowHelp({\n\tname: `cli-command`,\n\tflags,\n\tcommands\n});\n\nmeow(helpText, {flags});\n\n// Now run `cli-command --help` to view the\n// following auto formatted \u0026 generated help info.\n```\n\n[![cli-meow-help running in a terminal](./.github/cli-meow-help.png)](./../../)\n\n\u003cbr /\u003e\n\n[![📃](https://raw.githubusercontent.com/ahmadawais/stuff/master/images/git/options.png)](./../../)\n\n## API\n\n### meowHelp(options)\n\n#### ❯ options\n\nType: `object`\n\nDefault: ↓\n\n```js\n{\n\tname = `(CLI name undefined)`,\n\tdesc,\n\tcommands = {},\n\tflags = {},\n\texamples = [],\n\tdefaults = true,\n\theader,\n\tfooter\n}\n```\n\nYou can specify the options below.\n\n#### ❯ name\n\nType: `string`\u003cbr\u003e\nDefault: `(CLI name undefined)`\n\nThe `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.\n\n#### ❯ desc\n\nType: `string`\u003cbr\u003e\nDefault: `undefined` (optional)\n\nOptionally define a description text for the help message.\n\n#### ❯ commands\n\nType: `string`\u003cbr\u003e\nDefault: `{}` (optional)\n\nOptionally, 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.\n\n#### ❯ flags\n\nType: `string`\u003cbr\u003e\nDefault: `{}`\n\nDefine 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.\n\n##### \u003e examples\n\nType: `Array`\u003cbr\u003e\nDefault: `[]`\n\nList optional examples of how to use the CLI.\n\n\u003e Check the [test](./test.js) file for more context. Format example:\n\n```js\nconst examples = [\n\n\t{\n\t\tcommand: `new`,\n\t\tflags: [`random`]\n\t}\n];\n```\n\n\n#### ❯ defaults\n\nType: `string`\u003cbr\u003e\nDefault: `true` (optional)\n\nPrints out the default values of flags. Set to `false` to disable.\n\n#### ❯ header\n\nType: `string`\u003cbr\u003e\nDefault: `undefined` (optional)\n\nOptionally, add additional header information.\n\n#### ❯ footer\n\nType: `string`\u003cbr\u003e\nDefault: `undefined` (optional)\n\nOptionally, add additional footer information.\n\n\u003cbr\u003e\n\n[![📝](https://raw.githubusercontent.com/ahmadawais/stuff/master/images/git/log.png)](changelog.md)\n\n## Changelog\n\n[❯ Read the changelog here →](changelog.md)\n\n\u003cbr\u003e\n\n\u003csmall\u003e**KEY**: `📦 NEW`, `👌 IMPROVE`, `🐛 FIX`, `📖 DOC`, `🚀 RELEASE`, and `🤖 TEST`\n\n\u003e _I use [Emoji-log](https://github.com/ahmadawais/Emoji-Log), you should try it and simplify your git commits._\n\n\u003c/small\u003e\n\n\u003cbr\u003e\n\n[![📃](https://raw.githubusercontent.com/ahmadawais/stuff/master/images/git/license.png)](./../../)\n\n## License \u0026 Conduct\n\n- MIT © [Ahmad Awais](https://twitter.com/MrAhmadAwais/)\n- Thanks to Maarten Brakkee for initial implementation\n- [Code of Conduct](code-of-conduct.md)\n\n\u003cbr\u003e\n\n[![🙌](https://raw.githubusercontent.com/ahmadawais/stuff/master/images/git/connect.png)](./../../)\n\n## Connect\n\n\u003cdiv align=\"left\"\u003e\n    \u003cp\u003e\u003ca href=\"https://github.com/ahmadawais\"\u003e\u003cimg alt=\"GitHub @AhmadAwais\" align=\"center\" src=\"https://img.shields.io/badge/GITHUB-gray.svg?colorB=6cc644\u0026style=flat\" /\u003e\u003c/a\u003e\u0026nbsp;\u003csmall\u003e\u003cstrong\u003e(follow)\u003c/strong\u003e To stay up to date on free \u0026 open-source software\u003c/small\u003e\u003c/p\u003e\n    \u003cp\u003e\u003ca href=\"https://twitter.com/MrAhmadAwais/\"\u003e\u003cimg alt=\"Twitter @MrAhmadAwais\" align=\"center\" src=\"https://img.shields.io/badge/TWITTER-gray.svg?colorB=1da1f2\u0026style=flat\" /\u003e\u003c/a\u003e\u0026nbsp;\u003csmall\u003e\u003cstrong\u003e(follow)\u003c/strong\u003e To get #OneDevMinute daily hot tips \u0026 trolls\u003c/small\u003e\u003c/p\u003e\n    \u003cp\u003e\u003ca href=\"https://www.youtube.com/AhmadAwais\"\u003e\u003cimg alt=\"YouTube AhmadAwais\" align=\"center\" src=\"https://img.shields.io/badge/YOUTUBE-gray.svg?colorB=ff0000\u0026style=flat\" /\u003e\u003c/a\u003e\u0026nbsp;\u003csmall\u003e\u003cstrong\u003e(subscribe)\u003c/strong\u003e To tech talks \u0026 #OneDevMinute videos\u003c/small\u003e\u003c/p\u003e\n    \u003cp\u003e\u003ca href=\"https://AhmadAwais.com/\"\u003e\u003cimg alt=\"Blog: AhmadAwais.com\" align=\"center\" src=\"https://img.shields.io/badge/MY%20BLOG-gray.svg?colorB=4D2AFF\u0026style=flat\" /\u003e\u003c/a\u003e\u0026nbsp;\u003csmall\u003e\u003cstrong\u003e(read)\u003c/strong\u003e In-depth \u0026 long form technical articles\u003c/small\u003e\u003c/p\u003e\n    \u003cp\u003e\u003ca href=\"https://www.linkedin.com/in/MrAhmadAwais/\"\u003e\u003cimg alt=\"LinkedIn @MrAhmadAwais\" align=\"center\" src=\"https://img.shields.io/badge/LINKEDIN-gray.svg?colorB=0077b5\u0026style=flat\" /\u003e\u003c/a\u003e\u0026nbsp;\u003csmall\u003e\u003cstrong\u003e(connect)\u003c/strong\u003e On the LinkedIn profile y'all\u003c/small\u003e\u003c/p\u003e\n\u003c/div\u003e\n\n\u003cbr\u003e\n\n[![👌](https://raw.githubusercontent.com/ahmadawais/stuff/master/images/git/sponsor.png)](https://github.com/AhmadAwais/sponsor)\n\n## Sponsor\n\nMe ([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.\n\n[![Ahmad on Twitter](https://img.shields.io/twitter/follow/mrahmadawais.svg?style=social\u0026label=Follow%20@MrAhmadAwais)](https://twitter.com/mrahmadawais/)\n\n### [NodeCLI.com][n] — Learn to build Node.js CLI Automation\n\n\u003e This repository is part of the [NodeCLI.com][n] course.\n\nAfter 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 \u0026 JavaScript based CLI (Command Line Interface) apps. Automate the grunt work, do more in less time, impress your manager, and help the community.\n→ I'm sharing it all in this online video course. [Node CLI Automation\nwithout wasting a 1,000 hours][n] →\u003c/p\u003e\n\n[![Node CLI Course](https://raw.githubusercontent.com/ahmadawais/stuff/master/nodecli/featured.jpg)][n]\n\n[![Node CLI](https://img.shields.io/badge/-NodeCLI.com%20%E2%86%92-gray.svg?colorB=488640\u0026style=flat)][n]\n\n[n]: https://NodeCLI.com?utm_source=github\u0026utm_medium=referral\u0026utm_campaign=ahmadawais/cli-meow-help\n\n[![Awais on Twitter](https://raw.githubusercontent.com/ahmadawais/stuff/master/sponsor/sponsor.jpg)](https://github.com/AhmadAwais/sponsor)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fahmadawais%2Fcli-meow-help","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fahmadawais%2Fcli-meow-help","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fahmadawais%2Fcli-meow-help/lists"}