CLI 參考
comp-hub CLI 提供一組指令來管理您的本機開發伺服器。多個專案可以同時執行,每個專案都有自己的連接埠。
CLI 提供三個二進位名稱 —— comphub、ch、comp-hub,都指向同一個程式。下列指令用哪個名稱都可以,例如 ch status、comp-hub -p 8080。
指令總覽
| 指令 | 說明 |
|---|---|
comphub | 為目前專案啟動開發伺服器 |
comphub status | 檢視主程式狀態和所有執行中的專案 |
comphub stop <hash> | 停止特定專案 |
comphub stop --all | 停止所有專案 |
comphub kill | 關閉主程式程序 |
comphub fix | 修正常見問題(過期的執行檔等) |
comphub — 啟動伺服器
在專案目錄中執行以啟動開發伺服器,並在瀏覽器中預覽元件。
bash
comphub選項:
| 選項 | 簡寫 | 類型 | 預設值 | 說明 |
|---|---|---|---|---|
--port | -p | number | 5478 | 服務連接埠 |
--dir | -d | path | "./" | 資源目錄相對路徑 |
--log-level | -l | string | "error" | 日誌級別:debug, info, warn, error |
| --version | -v | - | - | 顯示版本 | | --help | -h | - | - | 顯示說明 |
--port僅在尚無 master 程序執行時生效。若 master 已在執行,CLI 會重複使用它並提示-p被忽略;確實需要更換連接埠請先執行comphub kill。
範例:
bash
# 使用預設連接埠啟動
comphub
# 使用自訂連接埠
comphub -p 8080
# 指定目錄
comphub -d ./src啟動成功後,您會看到專案資訊和存取 URL:
✓ comp-hub v0.44.11
██████╗ ██████╗ ███╗ ███╗ ██████╗ ██╗ ██╗ ██╗ ██╗ ██████╗
██╔════╝ ██╔═══██╗ ████╗ ████║ ██╔══██╗ ██║ ██║ ██║ ██║ ██╔══██╗
██║ ██║ ██║ ██╔████╔██║ ██████╔╝ ███████║ ██║ ██║ ██████╔╝
██║ ██║ ██║ ██║╚██╔╝██║ ██╔═══╝ ██╔══██║ ██║ ██║ ██╔══██╗
╚██████╗ ╚██████╔╝ ██║ ╚═╝ ██║ ██║ ██║ ██║ ╚██████╔╝ ██████╔╝
╚═════╝ ╚═════╝ ╚═╝ ╚═╝ ╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═════╝
Version 0.44.11
Project D:\project\housing\vue2
Hash 94525912
Port 5478
URL http://localhost:5478/94525912/main/
─────────────────────────────────────────────
comphub status View all projects
comphub stop 94525912 Stop current project
comphub stop --all Stop all projects
comphub kill Shutdown master在瀏覽器中開啟 URL 即可進入平台。
啟動時的行為
- 版本檢查:啟動前 CLI 會向遠端服務查詢目前版本是否仍可使用。若目前版本被列為必須升級,啟動會直接中止並提示
comp-hub must be upgraded before it can start,請先執行npm install comp-hub@latest -g再啟動;若只是有新版本,則僅顯示提示並正常啟動。 - 日誌串流:橫幅之後,CLI 會以 SSE 即時輸出本專案 MidwayJS 子程序的日誌。按
Ctrl+C結束,專案會自動從 master 註銷。
comphub status — 檢視狀態
查看目前正在執行的專案。
bash
comphub status輸出範例:
● Master Status
Status ● running
Version 0.44.11
Uptime 2m
Projects 2
▸ Registered Projects (2):
────────────────────────────────────────────────────────
hash 94525912
path D:\project\housing\vue2
url http://localhost:5478/94525912/main/
────────────────────────────────────────────────────────
hash a3f82109
path D:\project\housing\vue3
url http://localhost:5478/a3f82109/main/
────────────────────────────────────────────────────────如果沒有服務在執行:
✗ Master service is not runningcomphub stop — 停止專案
停止一個或所有執行中的專案,而不影響其他專案。
bash
# 停止特定專案(使用 status 找到 hash)
comphub stop <hash>
# 停止所有專案
comphub stop --all範例:
bash
# 停止 hash 為 94525912 的專案
comphub stop 94525912
# 一次停止所有專案
comphub stop --allcomphub kill — 關閉所有服務
關閉所有專案和服務。
bash
comphub kill這會終止主程序程序和所有已註冊的專案。再次執行 comphub 即可重新啟動。
comphub fix — 修正常見問題
清理過期的執行檔並修正其他常見問題:
bash
comphub fix以下情況非常有用:
- 先前關閉留下了過期的程序檔,阻止新的啟動
- 您需要重設本機執行狀態
執行多個專案
您可以同時執行不同的專案:
bash
# 終端機 1:啟動專案 A
cd /path/to/project-a
comphub
# 終端機 2:啟動專案 B
cd /path/to/project-b
comphub
# 查看所有執行中的專案
comphub status每個專案都有自己的連接埠,並透過不同的 URL 存取。