@linterhub/usage-parser

Simple parser for usage page in CLI

Table of Contents

• Background
• Install
• Usage
• Contribute
• License

Background

There are a lot of CLI with different usage doc, distributed in different ways. This repository contains a proposal to unified format for arguments of various CLI. Under the hood, the main idea is pretty similar to docopt approach.

More details in doс or at the catalog page

Install

Requirements:

• Node.js 4+

npm install @linterhub/usage-parser

GitHub

All releases and the source code are available for download at GitHub Releases.

Usage

Parse help doc and output result to console:

JavaScript

const parser = require('@linterhub/usage-parser');
console.log(parser('help doc'));

CLI

Before run add node_modules/.bin/usage-parser to script in package.json

npm run parse "help doc"

Contribute

You may contribute in several ways like requesting new features, adding tests, fixing bugs, improving documentation or examples. Please check our contributing guidelines.

License

MIT