命令行

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。