命令行文档

#命令行文档
Pomelo框架包含一个类似Shell的命令行工具，该工具能够帮助开发者更便捷、更有效率地进行应用开发。该工具包括的命令支持绝大多数的应用开发操作，例如创建项目、启动应用、停止应用、关闭应用等。用户可以通过pomelo help命令查询相关命令及其使用说明。

命令行安装

使用npm(node包管理工具)全局安装pomelo及命令行工具。

$:npm install pomelo -g

命令介绍

• init：创建一个新项目，该项目中包含创建pomelo应用的基本文件及pomelo应用的简单示例。

• start：启动应用及服务器，该命令还允许添加不同参数，例如—debug、--trace、--profile、--daemon。

• list: 列出当前应用开启的所有服务器的信息，包括服务器Id、服务器类型、pid、cpu、内存、启动时间。

• stop：关闭应用及服务器，和kill命令不同，这种关闭是优雅的关闭。

• kill：强制关闭应用及服务器，该操作可能产生数据丢失等不好的影响，所以不推荐使用该命令。

• version：列出当前使用Pomelo的版本信息。

• help：列出所有pomelo支持的命令及使用说明。

命令使用说明

• $:pomelo init <dirname>

根据给出的路径或文件名创建新项目，支持相对路径和绝对路径。默认当前路径，项目名称为当前文件夹名称。

• $:pomelo start [development|production] [--daemon]

应用启动有development和production两种模式，默认以development模式启动。用户可以通过--daemon参数让应用在后台运行，应用默认在前台运行。用户可以在config/servers.json中不同的服务器中添加不同参数。例如：

“connector”:[{"id":"connector-server-1", "host":"127.0.0.1", "port":4050, "wsPort":3050, "args":"--debug=
[port], --trace"}]

支持的参数类型可以参考nodejs及v8的命令行参数。该命令需在项目的根目录下使用。

应用运行daemon模式运行需要系统安装forever模块，安装命令如下：

npm install forever -g

• $:pomelo list

当应用启动后，列出所有服务器信息。该命令需在项目的根目录下使用。

• $:pomelo stop

停止当前应用，优雅地关闭应用。该命令需在项目的根目录下使用。

• $:pomelo kill

强制关闭应用。该命令需在项目的根目录下使用。

• $:pomelo version

列出当前使用Pomelo的版本信息。

• $:pomelo help

列出所有pomelo支持的命令及使用说明。