archive-gh-me/pm2
1
0
Fork 0
mirror of https://github.com/Unitech/pm2.git synced 2025-12-08 20:35:53 +00:00
Code Issues Projects Releases Wiki Activity

refactor: move helper to CLI/helper.js

Browse Source
This commit is contained in:
Unitech 2015-12-16 14:09:25 +01:00
parent 69265cbecf
commit e6e22abfcd
3 changed files with 146 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

96
doc/CLI.md Normal file
View File

@ -0,0 +1,96 @@
# CLI.js
.pm2Init
.connect
.lauchBus
.disconnectBus
.disconnect
.start
._startScript
._startJson
.deploy
.getVersion
.actionFromJson
.startup
.logrotate
.ping
.reset
.resurrect
.update / .updatePM2
.dump
.web
.gracefulReload
.reload
._reloadAll
._reloadProcessName
.remote
.remoteV2
._jsonStartOrAction
._operate
.restart
._restart
.delete
._stop
.generateSample
.list
.jlist
.scale
.flush
.describe
.reloadLogs
.sendDataToProcessId
.sendSignalToProcessName
.sendSignalToProcessId
.monit
.streamLogs
.killDaemon / .kill
.install
.uninstall
.publish
.generateModuleSample
.killAllModules
.deleteModule
.get
.set
.multiset
.unset
.conf
.interact
.killInteract
.infoInteract
.pullAndRestart
.pullAndReload
.pullAngGracefulReload
.pullComitId
.backward
.forward
.forceGc / .gc
.deepUpdate

48
lib/CLI.js
View File

@ -29,6 +29,9 @@ var Utility = require('./Utility.js');
var Modularizer = require('./Modularizer.js');
var Configuration = require('../lib/Configuration.js');
var CliHelper = require('./CLI/helper.js');
var Deploy = require('pm2-deploy');
var exitCli = Common.exitCli;
@ -452,7 +455,7 @@ CLI._startJson = function(cmd, opts, jsonVia, cb) {
*/
CLI.deploy = function(file, commands, cb) {
if (file == 'help') {
deployHelp();
CliHelper.deployHelp();
return cb ? cb() : exitCli(cst.SUCCESS_EXIT);
}
@ -484,7 +487,7 @@ CLI.deploy = function(file, commands, cb) {
}
if (!env) {
deployHelp();
CliHelper.deployHelp();
return cb ? cb() : exitCli(cst.SUCCESS_EXIT);
}
@ -2525,44 +2528,3 @@ function parseConfig(confString, filename) {
function warn(warning){
printOut(cst.PREFIX_MSG_WARNING + warning);
}
function deployHelp() {
console.log('');
console.log('-----> Helper: Deployment with PM2');
console.log('');
console.log(' Generate a sample ecosystem.json with the command');
console.log(' $ pm2 ecosystem');
console.log(' Then edit the file depending on your needs');
console.log('');
console.log(' Commands:');
console.log(' setup run remote setup commands');
console.log(' update update deploy to the latest release');
console.log(' revert [n] revert to [n]th last deployment or 1');
console.log(' curr[ent] output current release commit');
console.log(' prev[ious] output previous release commit');
console.log(' exec|run <cmd> execute the given <cmd>');
console.log(' list list previous deploy commits');
console.log(' [ref] deploy to [ref], the "ref" setting, or latest tag');
console.log('');
console.log('');
console.log(' Basic Examples:');
console.log('');
console.log(' First initialize remote production host:');
console.log(' $ pm2 deploy ecosystem.json production setup');
console.log('');
console.log(' Then deploy new code:');
console.log(' $ pm2 deploy ecosystem.json production');
console.log('');
console.log(' If I want to revert to the previous commit:');
console.log(' $ pm2 deploy ecosystem.json production revert 1');
console.log('');
console.log(' Execute a command on remote server:');
console.log(' $ pm2 deploy ecosystem.json production exec "pm2 restart all"');
console.log('');
console.log(' PM2 will look by default to the ecosystem.json file so you dont need to give the file name:');
console.log(' $ pm2 deploy production');
console.log(' Else you have to tell PM2 the name of your ecosystem file');
console.log('');
console.log(' More examples in https://github.com/Unitech/pm2');
console.log('');
}

45
lib/CLI/helper.js Normal file
View File

@ -0,0 +1,45 @@
var Helper = {};
Helper.deployHelp = function() {
console.log('');
console.log('-----> Helper: Deployment with PM2');
console.log('');
console.log(' Generate a sample ecosystem.json with the command');
console.log(' $ pm2 ecosystem');
console.log(' Then edit the file depending on your needs');
console.log('');
console.log(' Commands:');
console.log(' setup run remote setup commands');
console.log(' update update deploy to the latest release');
console.log(' revert [n] revert to [n]th last deployment or 1');
console.log(' curr[ent] output current release commit');
console.log(' prev[ious] output previous release commit');
console.log(' exec|run <cmd> execute the given <cmd>');
console.log(' list list previous deploy commits');
console.log(' [ref] deploy to [ref], the "ref" setting, or latest tag');
console.log('');
console.log('');
console.log(' Basic Examples:');
console.log('');
console.log(' First initialize remote production host:');
console.log(' $ pm2 deploy ecosystem.json production setup');
console.log('');
console.log(' Then deploy new code:');
console.log(' $ pm2 deploy ecosystem.json production');
console.log('');
console.log(' If I want to revert to the previous commit:');
console.log(' $ pm2 deploy ecosystem.json production revert 1');
console.log('');
console.log(' Execute a command on remote server:');
console.log(' $ pm2 deploy ecosystem.json production exec "pm2 restart all"');
console.log('');
console.log(' PM2 will look by default to the ecosystem.json file so you dont need to give the file name:');
console.log(' $ pm2 deploy production');
console.log(' Else you have to tell PM2 the name of your ecosystem file');
console.log('');
console.log(' More examples in https://github.com/Unitech/pm2');
console.log('');
};
module.exports = Helper;