>[info] 基本管理命令 ### **1. 框架安裝：** ``` php easyswoole install ``` ### **2. 服務管理：** * **幫助命令：** ``` php easyswoole server -h ``` * **服務啟動：** ``` php easyswoole server start # 守護進程方式啟動（配合 Supervisor 守護進程） php easyswoole server start -d ``` * **指定配置文件啟動服務：** 默認為`dev`，即`-mode`參數默認為`dev`，即默認以項目根目錄的`dev.php`作為框架運行的配置文件。 指定以項目根目錄的`produce.php`作為框架運行的配置文件，請運行如下命令： `-d`可選參數：守護進程 ``` php easyswoole server start -mode=produce ``` * **停止服務：** ``` php easyswoole server stop # 強制停止服務 php easyswoole server stop -force ``` * **熱重啟：** 僅會重啟`worker`進程 ``` php easyswoole server reload ``` * **重啟服務：** `-d`可選參數：守護進程 ``` php easyswoole server restart ``` * **服務狀態：** ``` php easyswoole server status ``` ### **3. 進程管理：** `EasySwoole`內置對于`Process`的命令行操作，方便開發者友好地去管理`Process`。 * **幫助命令：** ``` php easyswoole process -h ``` * **顯示所有進程：** ``` php easyswoole process show # 如果想要以 MB 形式顯示： php easyswoole process show -d ``` * **殺死指定進程(PID)：** ``` php easyswoole process kill --pid=PID ``` * **殺死指定進程組(GROUP)：** ``` php easyswoole process kill --group=GROUP_NAME ``` * **殺死所有進程：** ``` php easyswoole process killAll ``` * **強制殺死進程：** 需要帶上`-f`參數，例如： ``` php easyswoole process kill --pid=PID -f ``` ### **4. Crontab 管理：** `EasySwoole`內置對于`Crontab`的命令行操作，方便開發者友好地去管理`Crontab`。 * **幫助命令：** ``` php easyswoole crontab -h ``` * **查看所有注冊的 Crontab：** ``` php easyswoole crontab show ``` * **停止指定的 Crontab：** ``` php easyswoole crontab stop --name=TASK_NAME ``` * **恢復指定的 Crontab：** ``` php easyswoole crontab resume --name=TASK_NAME ``` * **立即跑一次指定的 Crontab：** ``` php easyswoole crontab run --name=TASK_NAME ``` ### **5. Task 管理：** * **查看`Task`進程狀態** ``` php easyswoole task status ``` ### **6. 單元測試：** >[info] 注意：需要先使用命令`composer require easyswoole/phpunit`安裝單元測試組件包，然后才可以執行如下命令。詳細使用請看[單元測試](https://www.easyswoole.com/Components/phpunit.html)章節。 * **協程方式執行單元測試** 單元測試用例存放在項目根目錄的`tests`目錄。 ``` php easyswoole phpunit tests ``` * **非協程方式執行單元測試** 單元測試用例存放在項目根目錄的`tests`目錄。 ``` php easyswoole phpunit tests --no-coroutine ``` ### **7. 生成API文檔：** `EasySwoole`內置了針對`注解控制器`中的注解方法生成對應`API`接口文檔的命令，方便開發者可以更加高效地提供`API`接口文檔用于對接。關于`注解`如何使用，詳細請看[注解](https://www.easyswoole.com/HttpServer/Annotation/install.html)章節。 * **幫助命令：** ``` php easyswoole doc -h ``` * **指定需要生成 API 文檔的控制器目錄** ``` php easyswoole doc --dir=App/HttpController/ ``` * **指定生成 API 文檔的額外說明** ``` php easyswoole doc --extra=API_README.md ``` * **指定需要生成 API 文檔的控制器目錄和文檔額外說明** ``` php easyswoole doc --extra=API_README.md --dir=App/HttpController/ ``` 以上命令執行完成之后，開發者即可在項目根目錄看到`easyDoc.html`API 接口文檔。