命令行文档

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

命令行安装

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

npm install pomelo -g

命令介绍

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

• start：启动应用及服务器。

• add: 动态增加服务器。

• list: 列出当前应用开启的所有服务器的信息，包括服务器Id、服务器类型、pid、堆使用情况、启动时长。

• stop：关闭应用及服务器或者停止指定的服务器。

• kill：强制关闭应用及服务器。

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

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

命令使用说明

pomelo init

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

pomelo start [development|production] [--daemon]

应用启动有development和production两种模式，默认以development模式启动。用户可以通过--daemon参数让应用在后台运行，此时服务器的运行日志可以在game-server/logs/目录下查看，应用默认在前台运行。用户可以在/nameofypurproject/game-server/config/servers.json中不同的服务器中添加不同参数。例如：

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

如果需要在某台服务器上进行debug,可以在对应的服务器配置中加入--debug=[port]参数，例如要在8080端口开启debug：--debug=8080。其它支持的参数类型可以参考nodejs及v8的命令行参数。该命令需在项目的game-server目录下使用。

应用运行daemon模式运行需要系统安装forever模块，安装命令：npm install forever -g

pomelo add host=[host] port=[port] id=[id] serverType=[serverType]

根据用户给定的配置信息，动态的添加服务器。添加的参数必须包括服务器ip地址(host),服务器端口号(port)，服务器标识(id)，服务器类型(serverType)，其它参数可以根据需要添加。该命令需在master服务器的项目的根目录下使用。

pomelo list

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

pomelo stop [id]

停止当前应用，优雅地关闭应用。和kill命令不同，这种关闭首先会切断客户端与服务器的连接，然后逐一关闭所有服务器；或者在加入服务器标识(id)，动态停止特定的服务器。该命令需在项目的根目录下使用。

pomelo kill [--force]

强制关闭应用。在本地进行应用开发过程中，如果遇到kill之后还有服务器进程没有关闭的情况，可以使用pomelo kill --force强制关闭所有服务器进程。该操作可能产生数据丢失等不好的影响，所以不推荐在线上使用该命令。该命令需在项目的根目录下使用。

pomelo --version

列出当前使用pomelo的版本信息。该命令可以全局使用。

pomelo --help

列出所有pomelo支持的命令及使用说明。该命令可以全局使用。