docs for `mon` command

This commit is contained in:
Tjatse 2015-06-03 16:12:36 +08:00
parent d3e795d687
commit dbe4b33eb1
2 changed files with 13 additions and 2 deletions

View File

@ -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 <key> <value> set config by key-value pairs
rm <key> 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
```
<a name="dashboard" />
## Curses-like dashboard
**Only working on unix system**
```bash
Usage: mon [options]
Options:
-h, --help output usage information
```
<a name="cli_web" />

View File

@ -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 <key> <value>')
*/
commander.command('rm <key>')
.description('remove config by key')
.action(function unsetConfig(key, cmd){
.action(function(key, cmd){
var mon = Monitor();
mon.config(key, null);
showConfigs(cmd, mon);