JSPM

  • Created
  • Published
  • Downloads 2973911
  • Score
    100M100P100Q218677F
  • License MIT

Command-line parser, usage text producer

Package Exports

  • command-line-args

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (command-line-args) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

view on npm npm module downloads per month Build Status Dependency Status

command-line-args

Collect command-line options, generate a usage guide..

  • Support most option notation styles
    • long options (--find lib.js)
    • short options (-f lib.js)
    • getopt-style combinations (-xvf lib.js)
    • option=val style (--find=lib.js)
  • Customisable usage guide generator
  • Modular - define reusage option sets.
  • Split options into groups, for apps with a large set of options.
  • Fine control over validation, type

Install

$ npm install command-line-args --save

API Reference

Modules

command-line-args
definition
definitions
option
## command-line-args ### CliArgs(definitions, argv) ⇒ object ⏏ **Kind**: Exported function
Param Type
definitions module:command-line-args.argDefType
argv Array.<string>

definition

Definition ⏏

Option Definition

Kind: Exported class

definition.name : string

Kind: instance property of Definition

definition.type : function

Kind: instance property of Definition

definition.alias : string

a single character

Kind: instance property of Definition

definition.multiple : boolean

Kind: instance property of Definition

definition.value : boolean

Kind: instance property of Definition

definition.defaultOption : boolean

Kind: instance property of Definition

definition.group : string | Array.<string>

Kind: instance property of Definition

definitions

option


© 2015 Lloyd Brookes <75pound@gmail.com>. Documented by jsdoc-to-markdown.