Ligne de commande
restorm [--open <chemin>] [--run <cible>] [options]Arguments
Section titled “Arguments”| Argument | Alias | Type | Défaut | Rôle |
|---|---|---|---|---|
--open <chemin> | -o | chaîne | — | Fichier ou dossier à ouvrir au démarrage. Obligatoire avec --run |
--run <cible> | chaîne | — | Exécute le scénario nommé et sort. Active le mode ligne de commande | |
--by <name|id> | liste | name | Comment --run désigne le scénario | |
--headless | booléen | false | Aucune fenêtre. Sans lui, la fenêtre s’affiche pendant l’exécution | |
--param nom=valeur | répétable | — | Fournit un paramètre de scénario | |
--all-logs | booléen | false | Inclut les entrées du moteur, pas seulement celles de l’action Log | |
--out <fichier> | chaîne | — | Écrit aussi le journal dans un fichier, au fil de l’eau | |
--clear-settings | -cls | booléen | false | Réinitialise les préférences avant le lancement |
--inactive-window | booléen | false | Affiche la fenêtre sans lui donner le focus | |
--quiet | -q | booléen | — | Réduit la sortie au seul journal d’exécution. Ajouté automatiquement en présence de --run |
--mcp-session-name <nom> | chaîne | auto | Nomme la session MCP (voir aussi la variable RESTORM_MCP_SESSION_NAME) | |
--help | -h | Affiche l’aide | ||
--version | -v | Affiche la version |
Codes de sortie
Section titled “Codes de sortie”| Code | Signification |
|---|---|
0 | Le scénario s’est terminé correctement |
1 | Échec, annulation, ou erreur du moteur |
2 | Cible introuvable, fichier --out inaccessible, ou --run sans --open |
3 | Droit refusé — jeton absent, invalide ou révoqué, plan insuffisant, ou point de vérification injoignable |
Variables d’environnement
Section titled “Variables d’environnement”| Variable | Rôle |
|---|---|
RESTORM_TOKEN | Le jeton d’organisation (rstk_…) requis par l’exécution headless |
RESTORM_MCP_SESSION_NAME | Équivalent de --mcp-session-name |
Les secrets de type variable d’environnement sont également lus dans l’environnement du processus : c’est le mécanisme recommandé en intégration continue.
Exemples
Section titled “Exemples”Ouvrir un projet :
restorm --open ./api.restormExécuter un scénario en affichant la fenêtre (pratique pour observer) :
restorm --open ./api.restorm --run "Tests de fumée"Exécuter sans fenêtre, avec des paramètres et un journal complet :
RESTORM_TOKEN=rstk_… restorm \ --open ./api.restorm \ --run "Tests de fumée" \ --headless \ --all-logs \ --out ./run.log \ --param baseUrl=https://recette.exemple.test \ --param Ids='[1,2,3]' \ --param Env=recetteVoir Exécution headless et CI pour le format de sortie, la conversion des paramètres et des exemples de pipelines.