mtk-pm/help.js

mtk-npm: npm client for mediatek

/**!
 * mpm - help.js
 *
 * Copyright(c) mpmjs.org and other contributors.
 * MIT Licensed
 *
 * Authors:
 *  dead_horse <dead_horse@qq.com> (http://deadhorse.me)
 */

'use strict';

/**
 * Module dependencies.
 */
var config = require('./config');

module.exports = function outputHelp(argv) {
  var helpInfo = 'Usage: mpm [option] <command>\n' +
  'Help: http://mpmjs.org/help/mpm\n\n' +
  '  Extend command\n' +
  '    web                            open mpm web (ex.: tnpm web)\n' +
  '    check [ingoreupdate]           check project dependencies, add ignoreupdate will not check modules\' latest version(ex.: mpm check, mpm check -i)\n' +
  '    doc [moduleName]               open document page (ex.: mpm doc urllib)\n' +
  '    sync [moduleName]              sync module from source npm (ex.: mpm sync urllib)\n' +
  '    user [username]                open user profile page (ex.: mpm user fengmk2)\n' +
  '\n' +
  '  npm command use --registry=' + (argv.registry || config.mpmRegistry) + '\n' +
  '    where <command> is one of:\n' +
  '    add-user, adduser, apihelp, author, bin, bugs, c, cache,\n' +
  '    completion, config, ddp, dedupe, deprecate, docs, edit,\n' +
  '    explore, faq, find, find-dupes, get, help, help-search,\n' +
  '    home, i, info, init, install, isntall, la, link, list, ll,\n' +
  '    ln, login, ls, outdated, owner, pack, prefix, prune,\n' +
  '    publish, r, rb, rebuild, remove, restart, rm, root,\n' +
  '    run-script, s, se, search, set, show, shrinkwrap, star,\n' +
  '    start, stop, submodule, tag, test, tst, un, uninstall,\n' +
  '    unlink, unpublish, unstar, up, update, v, version, view,\n' +
  '    whoami\n' +

  '      npm <cmd> -h     quick help on <cmd>\n' +
  '      npm -l           display full usage info\n' +
  '      npm faq          commonly asked questions\n' +
  '      npm help <term>  search for help on <term>\n' +
  '      npm help npm     involved overview\n\n' +

  '      Specify configs in the ini-formatted file:\n' +
  '          ' + (argv.userconfig || config.userconfig) + '\n' +
  '      or on the command line via: npm <command> --key value\n' +
  '      Config info can be viewed via: npm help config';
  console.log(helpInfo);
  process.exit(0);
};