UNPKG

commandos

Version:

Command line parser, compatible with DOS style command

56 lines (38 loc) 3 kB
# commandos __Command line parser, compatible with DOS style command__ [![coverage status of github.com/YounGoat/nodejs.commandos](https://coveralls.io/repos/github/YounGoat/nodejs.commandos/badge.svg?branch=master)](https://coveralls.io/github/YounGoat/nodejs.commandos2?branch=master) [![total downloads of commandos](https://img.shields.io/npm/dt/commandos.svg)](https://www.npmjs.com/package/commandos) [![commandos's License](https://img.shields.io/npm/l/commandos.svg)](https://www.npmjs.com/package/commandos) [![latest version of commandos](https://img.shields.io/npm/v/commandos.svg)](https://www.npmjs.com/package/commandos) [![coverage status of github.com/YounGoat/nodejs.commandos](https://img.shields.io/coveralls/YounGoat/nodejs.commandos/master.svg)](https://coveralls.io/github/YounGoat/nodejs.commandos2?branch=master) [![dependencies of github.com/YounGoat/nodejs.commandos](https://david-dm.org/YounGoat/nodejs.commandos/status.svg)](https://david-dm.org/YounGoat/nodejs.commandos) [![devDependencies of github.com/YounGoat/nodejs.commandos](https://david-dm.org/YounGoat/nodejs.commandos/dev-status.svg)](https://david-dm.org/YounGoat/nodejs.commandos?type=dev) [![build status of github.com/YounGoat/nodejs.commandos](https://travis-ci.org/YounGoat/nodejs.commandos.svg?branch=master)](https://travis-ci.org/YounGoat/nodejs.commandos) [![star github.com/YounGoat/nodejs.commandos](https://img.shields.io/github/stars/YounGoat/nodejs.commandos.svg?style=social&label=Star)](https://github.com/YounGoat/nodejs.commandos/stargazers) LANGUAGES / [简体中文](./README.zh_CN.md) The name *commandos* is combination of *command* and *DOS*. __commandos__ is a light-weighted command line parser which help to connect cli and Node.js application. ## Table of Contents * [API](#api) * [Why *commandos*](#why-commandos) * [About](#about) * [References](#references) * [Links](#links) ## API * [commandos.parse()](docs/parse.md) * [commandos.run()](docs/run.md) ## Why *commandos* There are already many packages help you to parse command line content, in which [minimist](https://www.npmjs.com/package/minimist) and [commander](https://www.npmjs.com/package/commander) are probably most famous. However, sometimes __minimist__ is too slim while __commander__ is too heavy. That is why I wrote __commandos__. ## About *commandos* = *command* + *DOS* ## References If __commandos__ is not to your taste, maybe the following packages is considerable (in alphabetical order): * [commander](https://www.npmjs.com/package/commander) * [getopts](https://www.npmjs.com/package/getopts) * [minimist](https://www.npmjs.com/package/minimist) * [nomnom](https://www.npmjs.com/package/nomnom) * [optimist](https://www.npmjs.com/package/optimist) * [yargs](https://www.npmjs.com/package/yargs) * [cli-argparse](https://www.npmjs.com/package/cli-argparse) ## Links * [CHANGE LOG](./CHANGELOG.md) * [Homepage](https://github.com/YounGoat/nodejs.commandos)