コマンドライン

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 のファイルに書き込めない、または --open なしの --run
3	権限が拒否されました — トークンがない、無効または失効している、プランが不足している、検証エンドポイントに到達できない

環境変数

変数	役割
RESTORM_TOKEN	ヘッドレス実行 が必要とする組織トークン（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

出力形式、パラメーターの変換、パイプラインの例については ヘッドレス実行と CI を参照してください。