Příkazová řádka
restorm [--open <path>] [--run <target>] [options]Argumenty
Section titled “Argumenty”| Argument | Alias | Typ | Výchozí | Role |
|---|---|---|---|---|
--open <path> | -o | řetězec | — | Soubor nebo složka, které se otevřou po spuštění. Povinný spolu s --run |
--run <target> | řetězec | — | Spustí pojmenovaný scénář a skončí. Zapíná režim příkazové řádky | |
--by <name|id> | seznam | name | Jak --run označuje scénář | |
--headless | logická hodnota | false | Žádné okno. Bez tohoto přepínače se okno během běhu zobrazí | |
--param name=value | opakovatelný | — | Předá parametr scénáře | |
--all-logs | logická hodnota | false | Zahrne i záznamy jádra, nejen ty z akce Log | |
--out <file> | řetězec | — | Zapisuje logy průběžně také do souboru | |
--clear-settings | -cls | logická hodnota | false | Před spuštěním obnoví výchozí předvolby |
--inactive-window | logická hodnota | false | Zobrazí okno, ale nepředá mu zaměření | |
--quiet | -q | logická hodnota | — | Omezí výstup pouze na log běhu. Přidává se automaticky, je-li přítomen --run |
--mcp-session-name <name> | řetězec | automaticky | Pojmenuje sezení MCP (viz také proměnná RESTORM_MCP_SESSION_NAME) | |
--help | -h | Zobrazí nápovědu | ||
--version | -v | Zobrazí verzi |
Kódy návratu
Section titled “Kódy návratu”| Kód | Význam |
|---|---|
0 | Scénář se dokončil správně |
1 | Selhání, zrušení nebo chyba jádra |
2 | Cíl nenalezen, soubor --out je nedostupný, nebo --run bez --open |
3 | Odepřené právo — token chybí, je neplatný nebo odvolaný, plán nestačí, případně není dostupný kontrolní bod |
Proměnné prostředí
Section titled “Proměnné prostředí”| Proměnná | Role |
|---|---|
RESTORM_TOKEN | Token organizace (rstk_…), který vyžaduje běh v režimu headless |
RESTORM_MCP_SESSION_NAME | Ekvivalent přepínače --mcp-session-name |
Tajemství typu proměnná prostředí se rovněž čtou z prostředí procesu: to je doporučený mechanismus v průběžné integraci.
Příklady
Section titled “Příklady”Otevření projektu:
restorm --open ./api.restormSpuštění scénáře se zobrazeným oknem (praktické, chcete-li průběh sledovat):
restorm --open ./api.restorm --run "Tests de fumée"Spuštění bez okna, s parametry a úplným logem:
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=stagingFormát výstupu, převod parametrů a příklady pipeline najdete v části Běh v režimu headless a CI.