命令列
restorm [--open <path>] [--run <target>] [options]| 引數 | 別名 | 類型 | 預設 | 用途 |
|---|---|---|---|---|
--open <path> | -o | 字串 | — | 啟動時要開啟的檔案或資料夾。與 --run 併用時為必填 |
--run <target> | 字串 | — | 執行指定名稱的情境後結束。啟用命令列模式 | |
--by <name|id> | 清單 | name | --run 以什麼方式指定情境 | |
--headless | 布林 | false | 完全不顯示視窗。不加此項時,執行期間會顯示視窗 | |
--param name=value | 可重複 | — | 提供一個情境參數 | |
--all-logs | 布林 | false | 一併納入引擎本身的記錄項目,而不只是 Log 動作產生的項目 | |
--out <file> | 字串 | — | 同時把記錄逐步寫入一個檔案 | |
--clear-settings | -cls | 布林 | false | 啟動前重設所有偏好設定 |
--inactive-window | 布林 | false | 顯示視窗,但不讓它取得焦點 | |
--quiet | -q | 布林 | — | 把輸出精簡到只剩執行記錄。出現 --run 時會自動加上 |
--mcp-session-name <name> | 字串 | 自動 | 為 MCP 工作階段命名(另請參閱 RESTORM_MCP_SESSION_NAME 環境變數) | |
--help | -h | 顯示說明 | ||
--version | -v | 顯示版本 |
| 代碼 | 意義 |
|---|---|
0 | 情境正常結束 |
1 | 失敗、被取消,或引擎發生錯誤 |
2 | 找不到目標、--out 指定的檔案無法存取,或使用了 --run 卻沒有 --open |
3 | 權限被拒 — 權杖缺失、無效或已撤銷、方案等級不足,或驗證端點無法連線 |
| 變數 | 用途 |
|---|---|
RESTORM_TOKEN | headless 執行所需的組織權杖(rstk_…) |
RESTORM_MCP_SESSION_NAME | 等同於 --mcp-session-name |
環境變數類型的密鑰同樣會從處理程序的環境中 讀取:這正是持續整合中建議採用的機制。
開啟一個專案:
restorm --open ./api.restorm執行一個情境並顯示視窗(方便一邊觀察):
restorm --open ./api.restorm --run "Tests de fumée"不顯示視窗執行,帶上參數並輸出完整記錄:
RESTORM_TOKEN=rstk_… restorm \ --open ./api.restorm \ --run "Tests de fumée" \ --headless \ --all-logs \ --out ./run.log \ --param baseUrl=https://staging.exemple.test \ --param Ids='[1,2,3]' \ --param Env=staging輸出格式、參數轉換規則以及管線範例,請參閱 headless 執行與 CI。