安装和全局配置
在使用命令之前,你需要先安装 pomelo-cli。
（图片来源网络，侵删）
安装
npm install -g pomelo-cli
查看版本
安装后,你可以检查是否安装成功。
pomelo -V # 或者 pomelo --version
核心命令详解
pomelo 命令主要围绕项目的 创建、启动、监控 和 调试。
pomelo new <项目名>
这是最常用的命令,用于创建一个新的 Pomelo 项目骨架。
语法：
（图片来源网络，侵删）
pomelo new [项目名称] [选项]
示例：
# 创建一个名为 'myGame' 的新项目 pomelo new myGame
常用选项：
--type: 指定项目模板类型。empty: 创建一个最空的项目（默认）。chat: 创建一个聊天室示例项目。demo: 创建一个更完整的游戏示例项目。
--git: 初始化 Git 仓库。--sass: 启用 Sass 预处理器（主要用于前端部分）。
示例：
# 创建一个带聊天室模板和Git仓库的项目 pomelo new myChatGame --type chat --git
执行后,pomelo-cli 会在当前目录下创建一个包含基本文件结构、配置文件和示例代码的新文件夹。
（图片来源网络，侵删）
pomelo start
在开发模式下启动你的 Pomelo 服务器，这个命令会读取 package.json 中的 start 脚本，通常是 node app.js。
语法：
pomelo start [选项]
示例：
# 在开发模式下启动服务器 pomelo start
常用选项：
-e, --env [环境]: 指定运行环境，如development,production,testing，这会加载config/env/[环境].js的配置。-d, --daemon: 在后台（守护进程模式）运行服务器。-i, --id [服务器ID]: 如果你的应用由多个服务器组成，可以指定要启动的服务器ID。
pomelo stop
停止正在运行的 Pomelo 服务器。
语法：
pomelo stop [选项]
示例：
# 停止正在运行的Pomelo服务器 pomelo stop
常用选项：
-k, --kill: 强制杀死进程，即使它没有响应停止信号。
pomelo kill
这是一个更暴力的停止命令,它会直接杀死指定进程号的 Node.js 进程。
语法：
pomelo kill [进程ID]
示例：
# 假设你通过 'ps aux | grep pomelo' 找到进程ID为 12345 pomelo kill 12345
pomelo list
列出所有由 pomelo-cli 管理的正在运行的 Pomelo 进程。
语法：
pomelo list
示例：
pomelo list # 输出示例： # [master] pid: 12345, id: master, env: development, status: online # [area] pid: 12346, id: area-1, env: development, status: online
pomelo install
用于向现有项目中安装官方或社区提供的模块（如 pomelo-rpc, pomelo-logger 等）。
语法：
pomelo install [模块名]
示例：
# 安装一个名为 'pomelo-protobuf' 的模块 pomelo install pomelo-protobuf
pomelo add
这个命令用于向项目中添加新的服务器组件（如 master, gate, area）。
语法：
pomelo add [服务器类型] [服务器ID]
示例：
# 添加一个ID为 'area-2' 的area服务器 pomelo add area area-2
这通常会在 config/servers.json 中添加新的服务器配置，并可能生成相应的服务器启动脚本。
辅助和调试命令
pomelo help
显示帮助信息,或者查看特定命令的用法。
语法：
pomelo help [命令名]
示例：
# 查看所有命令 pomelo help # 查看 'start' 命令的详细用法 pomelo help start
pomelo status
查看当前 Pomelo 服务的状态，包括运行环境、进程ID等，功能与 list 类似，但输出格式可能不同。
语法：
pomelo status
项目结构理解
了解这些命令后,理解它们操作的项目结构也很重要，一个典型的 Pomelo 项目结构如下：
myGame/
├── app/ # 核心应用代码
│ ├── controllers/ # 控制器，处理业务逻辑
│ ├── domain/ # 领域模型，定义数据结构
│ ├── handlers/ # 请求处理器，处理网络协议
│ ├── routes/ # 路由配置
│ ├── servers/ # 各个服务器的逻辑代码
│ └── util/ # 工具函数
├── config/ # 配置文件
│ ├── servers.json # 服务器列表配置
│ ├── master.json # Master服务器配置
│ ├── gate.json # Gate服务器配置
│ ├── area.json # Area服务器配置
│ └── env/ # 不同环境的配置文件
│ ├── development.js
│ └── production.js
├── logs/ # 日志文件目录
├── public/ # 静态资源（前端代码）
├── app.js # 应用入口文件
├── package.json # 项目依赖和脚本
└── README.md # 项目说明总结表格
| 命令 | 描述 | 常用选项 |
|---|---|---|
pomelo new <name> |
创建新项目 | --type, --git |
pomelo start |
启动服务器 | -e (环境), -d (后台) |
pomelo stop |
停止服务器 | -k (强制) |
pomelo kill <pid> |
杀死指定进程 | - |
pomelo list |
列出运行中的进程 | - |
pomelo install <module> |
安装模块 | - |
pomelo add <type> <id> |
添加服务器组件 | - |
pomelo help |
显示帮助 | - |
希望这份详细的梳理能帮助你更好地理解和使用 pomelo 命令！
