Linha de comandos

restorm [--open <path>] [--run <target>] [options]

Argumentos

Argumento	Alias	Tipo	Predefinição	Função
--open <path>	-o	cadeia	—	Ficheiro ou pasta a abrir no arranque. Obrigatório com --run
--run <target>		cadeia	—	Executa o cenário indicado e sai. Ativa o modo linha de comandos
--by <name|id>		lista	name	Como --run designa o cenário
--headless		booleano	false	Nenhuma janela. Sem ele, a janela aparece durante a execução
--param name=value		repetível	—	Fornece um parâmetro de cenário
--all-logs		booleano	false	Inclui as entradas do motor, não apenas as da ação Log
--out <file>		cadeia	—	Escreve também o registo num ficheiro, em tempo real
--clear-settings	-cls	booleano	false	Reinicia as preferências antes do lançamento
--inactive-window		booleano	false	Mostra a janela sem lhe dar o foco
--quiet	-q	booleano	—	Reduz a saída apenas ao registo de execução. Adicionado automaticamente na presença de --run
--mcp-session-name <name>		cadeia	automático	Dá nome à sessão MCP (ver também a variável RESTORM_MCP_SESSION_NAME)
--help	-h			Mostra a ajuda
--version	-v			Mostra a versão

Códigos de saída

Código	Significado
0	O cenário terminou corretamente
1	Falha, cancelamento ou erro do motor
2	Alvo não encontrado, ficheiro --out inacessível ou --run sem --open
3	Direito recusado — token ausente, inválido ou revogado, plano insuficiente, ou ponto de verificação inalcançável

Variáveis de ambiente

Variável	Função
RESTORM_TOKEN	O token de organização (rstk_…) exigido pela execução headless
RESTORM_MCP_SESSION_NAME	Equivalente de --mcp-session-name

Os segredos do tipo variável de ambiente também são lidos no ambiente do processo: é o mecanismo recomendado em integração contínua.

Exemplos

Abrir um projeto:

restorm --open ./api.restorm

Executar um cenário mostrando a janela (prático para observar):

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

Executar sem janela, com parâmetros e um registo completo:

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

Consulte Execução headless e CI para o formato de saída, a conversão dos parâmetros e exemplos de pipelines.