Command line

restorm [--open <chemin>] [--run <cible>] [options]

Arguments

Argument	Alias	Type	Default	Role
--open <path>	-o	string	—	File or folder to open at start-up. Mandatory with --run
--run <target>		string	—	Runs the named scenario and exits. Activates command-line mode
--by <name|id>		list	name	How --run designates the scenario
--headless		boolean	false	No window at all. Without it, the window appears while the run proceeds
--param name=value		repeatable	—	Supplies a scenario parameter
--all-logs		boolean	false	Includes the engine’s entries, not only the Log action’s
--out <file>		string	—	Also writes the log to a file, as it goes
--clear-settings	-cls	boolean	false	Resets the preferences before launching
--inactive-window		boolean	false	Shows the window without giving it focus
--quiet	-q	boolean	—	Reduces the output to the execution log alone. Added automatically when --run is present
--mcp-session-name <name>		string	auto	Names the MCP session (see also the RESTORM_MCP_SESSION_NAME variable)
--help	-h			Shows the help
--version	-v			Shows the version

Exit codes

Code	Meaning
0	The scenario finished correctly
1	Failure, cancellation, or an engine error
2	Target not found, --out file unreachable, or --run without --open
3	Entitlement denied — missing, invalid or revoked token, insufficient plan, or verification endpoint unreachable

Environment variables

Variable	Role
RESTORM_TOKEN	The organisation token (rstk_…) required by headless execution
RESTORM_MCP_SESSION_NAME	The equivalent of --mcp-session-name

Environment variable-typed secrets are also read from the process’s environment: that is the recommended mechanism in continuous integration.

Examples

Opening a project:

restorm --open ./api.restorm

Running a scenario with the window shown (handy for watching it happen):

restorm --open ./api.restorm --run "Tests de fumée"

Running with no window, with parameters and a full log:

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

See Headless execution and CI for the output format, parameter conversion and pipeline examples.