Línea de comandos
restorm [--open <chemin>] [--run <cible>] [options]Argumentos
Section titled “Argumentos”| Argumento | Alias | Tipo | Por defecto | Función |
|---|---|---|---|---|
--open <chemin> | -o | cadena | — | Archivo o carpeta que se abre al arrancar. Obligatorio con --run |
--run <cible> | cadena | — | Ejecuta el escenario indicado y sale. Activa el modo de línea de comandos | |
--by <name|id> | lista | name | Cómo designa --run el escenario | |
--headless | booleano | false | Sin ninguna ventana. Sin él, la ventana se muestra durante la ejecución | |
--param nom=valeur | repetible | — | Proporciona un parámetro de escenario | |
--all-logs | booleano | false | Incluye las entradas del motor, no solo las de la acción Log | |
--out <fichier> | cadena | — | Escribe también el registro en un archivo, de forma continua | |
--clear-settings | -cls | booleano | false | Reinicia las preferencias antes del lanzamiento |
--inactive-window | booleano | false | Muestra la ventana sin darle el foco | |
--quiet | -q | booleano | — | Reduce la salida al solo registro de ejecución. Se añade automáticamente en presencia de --run |
--mcp-session-name <nom> | cadena | auto | Nombra la sesión MCP (véase también la variable RESTORM_MCP_SESSION_NAME) | |
--help | -h | Muestra la ayuda | ||
--version | -v | Muestra la versión |
Códigos de salida
Section titled “Códigos de salida”| Código | Significado |
|---|---|
0 | El escenario ha terminado correctamente |
1 | Fallo, cancelación o error del motor |
2 | Destino no encontrado, archivo --out inaccesible, o --run sin --open |
3 | Permiso denegado — token ausente, no válido o revocado, plan insuficiente, o punto de verificación inalcanzable |
Variables de entorno
Section titled “Variables de entorno”| Variable | Función |
|---|---|
RESTORM_TOKEN | El token de organización (rstk_…) que requiere la ejecución headless |
RESTORM_MCP_SESSION_NAME | Equivalente de --mcp-session-name |
Los secretos de tipo variable de entorno también se leen en el entorno del proceso: es el mecanismo recomendado en integración continua.
Ejemplos
Section titled “Ejemplos”Abrir un proyecto:
restorm --open ./api.restormEjecutar un escenario mostrando la ventana (práctico para observar):
restorm --open ./api.restorm --run "Tests de fumée"Ejecutar sin ventana, con parámetros y un registro 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=stagingConsulte Ejecución headless y CI para el formato de salida, la conversión de los parámetros y ejemplos de pipelines.