Skip to content

Commit

Permalink
docs for mon command
Browse files Browse the repository at this point in the history
  • Loading branch information
Tjatse committed Jun 3, 2015
1 parent d3e795d commit dbe4b33
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand All @@ -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" />
Expand Down
4 changes: 2 additions & 2 deletions bin/pm2-gui
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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);
Expand Down

0 comments on commit dbe4b33

Please sign in to comment.