https://github.com/sindresorhus/parse-help

Parse CLI help output
https://github.com/sindresorhus/parse-help

Last synced: about 2 months ago
JSON representation

Parse CLI help output

• Host: GitHub
• URL: https://github.com/sindresorhus/parse-help
• Owner: sindresorhus
• License: mit
• Created: 2015-12-30T18:11:18.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2023-08-31T15:40:51.000Z (about 1 year ago)
• Last Synced: 2024-04-13T17:52:46.265Z (5 months ago)
• Language: JavaScript
• Size: 8.79 KB
• Stars: 37
• Watchers: 5
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license
  • Security: .github/security.md

Awesome Lists containing this project

README

        
# parse-help

> Parse CLI help output

## Install

```sh

npm install parse-help

```

## Usage

```js

import parseHelp from 'parse-help';

const help = `

	Usage

	  $ unicorn 

	Options

	  --rainbow    Lorem ipsum dolor sit amet

	  -m, --magic  Aenean commodo ligula eget dolor

	  --pony       Nullam dictum felis eu pede

	  -c, --color  Donec quam felis

	Examples

	  $ unicorn Peachy

	  $ unicorn Sparkle --rainbow --magic

`;

parseHelp(help);

/*

{

	flags: {

		rainbow: {

			description: 'Lorem ipsum dolor sit amet'

		},

		magic: {

			alias: 'm',

			description: 'Aenean commodo ligula eget dolor'

		},

		pony: {

			description: 'Nullam dictum felis eu pede'

		},

		color: {

			alias: 'c',

			description: 'Donec quam felis'

		}

	},

	aliases: {

		m: 'magic',

		c: 'color'

	}

}

*/

```

## Related

- [aliases](https://github.com/sindresorhus/aliases) - Parse flag aliases in CLI help output