Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Does your Node.js command line program have lots of arguments? Add custom tab completion!

branch: master
README.md

Synopsis

Custom command line tab completion for node.js applications.

Example

#!/usr/bin/env node

var complete = require('complete'); // get the `complete` module.

//
// list of items to complete on.
//
complete.list = ['apple', 'orange', 'pear', 'lemon', 'mango'];

complete.callback = function(lastSelection, userInput, reducedList) {

  if (lastSelection === 'apple') {
    complete.add('sauce');
  }
};

complete.init();

//
// continue with the application...
//
console.log('program started with the following arguments:', process.argv[2] || 'none provided');

Distribution and Installation

Your installment procedure should place your CLI program in a location made accessible by the PATH variable. If users install your program with the NPM -g option, your program will be in the path.

/usr/local/bin/myprogram -> /usr/local/lib/node_modules/myprogram/bin/myprogram

API

list

Create a list of commands that you want to autocomplete with.

complete.list = ['apple', 'orange', 'pear', 'lemon', 'mango'];

callback

Optionally you can define a callback that will get called when the match when the completion happens.

complete.callback = function(lastSelection, userInput, reducedList) {

  //
  // do something if this is an `orange`. Note that anything that
  // you `process.stdout.write()` will be added to the auto complete
  // list.
  //
};

init()

Initialize the auto completion behavior.

complete.init();

Higher Level Example

var complete = require('complete');

complete({
  program: 'my-program',
  // Commands
  commands: {
    'hello': function(words, prev, cur) {
      complete.output(cur, ['abc', 'def']);
    },
    'world': {
      'hi': function(words, prev, cur) {
        complete.echo('next');
      }
    }
  },
  // Position-independent options.
  // These will attempted to be
  // matched if `commands` fails
  // to match.
  options: {
    '--help': {},
    '-h': {},
    '--version': {},
    '-v': {}
  }
});

The above results in

$ my-program he<TAB>
$ my-program hello
$ my-program hello a<TAB>
$ my-program hello abc

License

(The MIT License)

Copyright (c) 2010 hij1nx http://www.twitter.com/hij1nx

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.

Something went wrong with that request. Please try again.