README

argvee

argv parsing (that is actually useful)

Installation

argvee is available on npm.

npm install argvee

Usage

The argvee argument parser takes the node.js standard process.argv array and constructs an object with helpers that can easily be queried.

import { parse } from 'argvee';
const argv = parse(process.argv);

When constructed, the argv collection recognizes three types command line arguments: commands, modes, and parameters.

Commands

Commands are the simplest of arguments. They are any arguments that are listed to that do not start with the - or -- prefix. Essentially, they are a list of keys.

// $ node cli.js hello universe
argv.commands === ['hello', 'universe'];

Modes

Modes are also a non-value list of keys, but they can be expressed differently by using the - or -- prefix. When using modes, if it begins with a single -, each letter will be parsed as its own mode.

// $ node cli.js --universe -abc
argv.modes === ['universe', 'a', 'b', 'c'];

Parameters

Parameters are key:value pairs that are declared in a similiar manner as modes. They can be declared in any of the following ways.

// $ node cli.js --noun universe --noun=world -v say --topic=hello -w=now
argv.params ===
  {
    noun: ['universe', 'world'],
    v: ['say'],
    topic: ['hello'],
    w: ['now'],
  };

You can also specify parameters with multiple words by surrounding the phrase with double-quotes.

// $ node cli.js --say "hello universe" --say "hello world"
argv.params ===
  {
    say: ['hello universe', 'hello world'],
  };

License

(The MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Usage no npm install needed!