No Packages, Mate

    base-cli

    0.5.0 • Public • Published

    base-cli NPM version NPM downloads Build Status

    Plugin for base-methods that maps built-in methods to CLI args (also supports methods from a few plugins, like 'base-store', 'base-options' and 'base-data'.

    You might also be interested in base-config.

    Install

    Install with npm:

    $ npm install base-cli --save

    Adds a cli method to base for mapping parsed command line arguments existing base methods or custom functions.

    The goal is to simplify the process of settings up command line logic for your base application.

    Usage

    var cli = require('base-cli');
    var Base = require('base');
    var app = new Base();
     
    // register the plugin
    app.use(cli());

    API

    This adds a cli object to base with the following (chainable) methods (base.cli.*):

    • .map() - .map: add mappings from command line flags/options to custom functions or base methods
    • .alias() - .alias: similar to map but creates simple aliases. For example, alias('show', 'get') would invoke the .get() method when --show is passed on the command line
    • .process() - .process: once all mappings are defined, pass argv to .process() to iterate over the mappings, passing argv as context.

    Example

    var argv = require('minimist')(process.argv.slice(2));
    var expand = require('expand-args');
    var cli = require('base-cli');
    var Base = require('base');
     
    var app = new Base();
    app.use(cli());
     
    app.cli
      .map('get', function(key, val) {
        app.get(key, val);
      })
      .map('set', function(key, val) {
        app.set(key, val);
      })
     
    app.cli.process(expand(argv), function(err) {
      if (err) throw err;
    });
     
    // command line args:
    //   
    //   '--set=a:b --get=a'
    //   
    // prints:
    //   
    //   'a'
    //   

    Commands

    The following commands are currently supported.

    Related projects

    Other useful base plugins:

    Contributing

    Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

    Building docs

    Generate readme and API documentation with verb:

    $ npm install verb && npm run docs

    Or, if verb is installed globally:

    $ verb

    Running tests

    Install dev dependencies:

    $ npm install -d && npm test

    Author

    Jon Schlinkert

    License

    Copyright © 2016, Jon Schlinkert. Released under the MIT license.


    This file was generated by verb, v0.9.0, on April 14, 2016.

    Install

    npm i base-cli

    DownloadsWeekly Downloads

    37,819

    Version

    0.5.0

    License

    MIT

    Last publish

    Collaborators

    • jonschlinkert