參考

CLI 指令參考

Watt 的 CLI 保持簡短:檢查定義、檢查執行環境、執行一個 pipeline。

一般指令

PowerShell
watt --version
watt --help

不帶子指令直接輸入 watt,會顯示橫幅字樣與使用說明。--version 輸出目前版本,--help 列出所有指令與旗標。

watt check

Usage
watt check [--env]

從目前工作目錄載入 watt.yaml,執行靜態驗證。它不會執行任何 step,也不會產生 .watt/result.json。

--env

在靜態驗證通過後,額外確認所有 pipeline 與 step 需要的 command、pwsh 或 cmd 是否已加入 PATH/能否在 PATH 中找到。仍不會啟動 process。

watt run

Usage
watt run [pipeline] [--output json]

執行目前工作目錄 watt.yaml 中的單一 pipeline。未提供名稱時執行 default;指定名稱時,該名稱必須存在。

--output json

把最終 result JSON 輸出至標準輸出。為避免混入 JSON,step 的標準輸出會改導向至標準錯誤。無論是否使用此旗標,符合條件的 watt run 都會把結果寫入 .watt/result.json;若寫入失敗,Watt 會以結束碼 5 回報。

PowerShell
watt run
watt run package
watt run verify --output json

建議使用流程

PowerShell
# 修改 watt.yaml 後
watt check --env

# 執行預設 pipeline
watt run

# 讓其他程式接收結果 JSON
watt run verify --output json

若要讓其他程式自動判斷執行結果,先讀取 Watt 程序的結束碼(exit code),再讀取 result.json 中會影響成敗判定的欄位(semantic fields)。不要用畫面上的文字或只供除錯的欄位(diagnostic fields)判斷成功或失敗。