// index.js
// Require all ShellJS plugins first
require('shelljs-plugin-foo');

// Require ShellJS itself
var shell = require('shelljs'); // 'shelljs/global' is allowed instead

// Require any other packages you like

var ret = shell.foo(); // this function works!
shell.echo(ret.stdout); // most plugins return a ShellString, just like ShellJS commands!
shell.foo().grep('o').sed(/o/g, 'a'); // most plugins will be fully pipe-able

{
  "name": "shelljs-plugin-foo",
  "version": "0.1.0",
  "description": "A foo plugin for ShellJS",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [
    "shelljs",
    "plugin",
    "foo"
  ],
  "author": "Joe Smith",
  "license": "MIT",
  "devDependencies": {
    "shelljs": "^0.7.3"
  },
  "peerDependencies": {
    "shelljs": "^0.7.3"
  }
}

// This exposes the plugin utilities
var plugin = require('shelljs/plugin');

// Require whatever modules you need for your project here

// Implement your command in a function, which accepts `options` as the
// first parameter, and other arguments after that
function fooImplementation(options, fileName) {
  return 'Hello world';
}

// Register the new plugin as a ShellJS command
plugin.register('foo', fooImplementation, {
  cmdOptions: {},   // There are no supported options for this command
});

// Optionally, you can export the implementation of the command like so:
exports.foo = fooImplementation;