Kommandozeile
restorm [--open <Pfad>] [--run <Ziel>] [Optionen]Argumente
Section titled “Argumente”| Argument | Alias | Typ | Standard | Rolle |
|---|---|---|---|---|
--open <path> | -o | Zeichenkette | — | Beim Start zu öffnende Datei oder Ordner. Bei --run erforderlich |
--run <target> | Zeichenkette | — | Führt das benannte Szenario aus und beendet sich. Aktiviert den Kommandozeilenmodus | |
--by <name|id> | Liste | name | Wie --run das Szenario bezeichnet | |
--headless | Boolean | false | Kein Fenster. Ohne diese Option wird das Fenster während der Ausführung angezeigt | |
--param name=value | wiederholbar | — | Liefert einen Szenarioparameter | |
--all-logs | Boolean | false | Enthält auch die Einträge der Engine, nicht nur die der Aktion Log | |
--out <file> | Zeichenkette | — | Schreibt das Protokoll zusätzlich fortlaufend in eine Datei | |
--clear-settings | -cls | Boolean | false | Setzt die Einstellungen vor dem Start zurück |
--inactive-window | Boolean | false | Zeigt das Fenster an, ohne ihm den Fokus zu geben | |
--quiet | -q | Boolean | — | Beschränkt die Ausgabe auf das reine Ausführungsprotokoll. Wird bei Vorhandensein von --run automatisch hinzugefügt |
--mcp-session-name <name> | Zeichenkette | automatisch | Benennt die MCP-Sitzung (siehe auch die Variable RESTORM_MCP_SESSION_NAME) | |
--help | -h | Zeigt die Hilfe an | ||
--version | -v | Zeigt die Version an |
Exit-Codes
Section titled “Exit-Codes”| Code | Bedeutung |
|---|---|
0 | Das Szenario wurde korrekt beendet |
1 | Fehlschlag, Abbruch oder Engine-Fehler |
2 | Ziel nicht gefunden, Datei --out nicht erreichbar, oder --run ohne --open |
3 | Zugriff verweigert — Token fehlt, ungültig oder widerrufen, unzureichender Tarif, oder Prüfpunkt nicht erreichbar |
Umgebungsvariablen
Section titled “Umgebungsvariablen”| Variable | Rolle |
|---|---|
RESTORM_TOKEN | Das von der Headless-Ausführung benötigte Organisations-Token (rstk_…) |
RESTORM_MCP_SESSION_NAME | Äquivalent zu --mcp-session-name |
Auch Secrets vom Typ Umgebungsvariable werden aus der Umgebung des Prozesses gelesen: Das ist der empfohlene Mechanismus für Continuous Integration.
Beispiele
Section titled “Beispiele”Ein Projekt öffnen:
restorm --open ./api.restormEin Szenario mit sichtbarem Fenster ausführen (praktisch zum Beobachten):
restorm --open ./api.restorm --run "Tests de fumée"Ohne Fenster ausführen, mit Parametern und vollständigem Protokoll:
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=stagingSiehe Headless-Ausführung und CI für das Ausgabeformat, die Parameterkonvertierung und Pipeline-Beispiele.