From dbe4b33eb12dc9740fdcd9e60f07fb77a7f6c4d5 Mon Sep 17 00:00:00 2001 From: Tjatse Date: Wed, 3 Jun 2015 16:12:36 +0800 Subject: [PATCH] docs for `mon` command --- README.md | 11 +++++++++++ bin/pm2-gui | 4 ++-- 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3f98e40..4b0e874 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ An elegant web interface for Unitech/PM2. - [Cautions](#cauts) - [Installation](#ins) - [CLI](#cli) + - [Curses-like dashboard](#dashboard) - [Run Web Interface](#cli_web) - [Configs](#cli_confs) - [Authorization](#auth) @@ -51,6 +52,7 @@ $ npm install -g pm2-gui Commands: start [options] [port] Launch the web server, port default by 8088 + mon curses-like dashboard config show all configs set set config by key-value pairs rm remove config by key @@ -73,7 +75,16 @@ $ npm install -g pm2-gui Start the web server, by specific configuration file: $ pm2-gui start --config my-config.ini +``` + +## Curses-like dashboard +**Only working on unix system** +```bash + Usage: mon [options] + Options: + + -h, --help output usage information ``` diff --git a/bin/pm2-gui b/bin/pm2-gui index eb9ddf0..07b1006 100755 --- a/bin/pm2-gui +++ b/bin/pm2-gui @@ -66,7 +66,7 @@ commander.command('start [port]') }); commander.command('mon') - .description('build terminal dashboard') + .description('curses-like dashboard') .action(function(){ var mon = Monitor({ debug: false @@ -96,7 +96,7 @@ commander.command('set ') */ commander.command('rm ') .description('remove config by key') - .action(function unsetConfig(key, cmd){ + .action(function(key, cmd){ var mon = Monitor(); mon.config(key, null); showConfigs(cmd, mon);