Parancssor
restorm [--open <path>] [--run <target>] [options]Argumentumok
Section titled “Argumentumok”| Argumentum | Alias | Típus | Alapértelmezés | Szerep |
|---|---|---|---|---|
--open <path> | -o | karakterlánc | — | Az indításkor megnyitandó fájl vagy mappa. A --run mellett kötelező |
--run <target> | karakterlánc | — | Lefuttatja a megnevezett forgatókönyvet, majd kilép. Bekapcsolja a parancssori módot | |
--by <name|id> | lista | name | Ahogyan a --run megjelöli a forgatókönyvet | |
--headless | logikai | false | Nincs ablak. Nélküle az ablak látszik a futtatás alatt | |
--param name=value | ismételhető | — | Átad egy forgatókönyv-paramétert | |
--all-logs | logikai | false | A motor bejegyzéseit is tartalmazza, nem csak a Log művelet bejegyzéseit | |
--out <file> | karakterlánc | — | A naplót menet közben egy fájlba is kiírja | |
--clear-settings | -cls | logikai | false | Indítás előtt visszaállítja a beállításokat |
--inactive-window | logikai | false | Megjeleníti az ablakot anélkül, hogy fókuszt adna neki | |
--quiet | -q | logikai | — | A kimenetet a futtatási naplóra szűkíti. Automatikusan hozzáadódik, ha a --run jelen van |
--mcp-session-name <name> | karakterlánc | automatikus | Nevet ad az MCP-munkamenetnek (lásd még a RESTORM_MCP_SESSION_NAME változót) | |
--help | -h | Megjeleníti a súgót | ||
--version | -v | Megjeleníti a verziót |
Kilépési kódok
Section titled “Kilépési kódok”| Kód | Jelentés |
|---|---|
0 | A forgatókönyv rendben lefutott |
1 | Hiba, megszakítás vagy a motor hibája |
2 | A cél nem található, a --out fájl nem érhető el, vagy a --run --open nélkül szerepel |
3 | Megtagadott jogosultság — hiányzó, érvénytelen vagy visszavont token, elégtelen előfizetés, vagy elérhetetlen ellenőrzési végpont |
Környezeti változók
Section titled “Környezeti változók”| Változó | Szerep |
|---|---|
RESTORM_TOKEN | A headless futtatáshoz szükséges szervezeti token (rstk_…) |
RESTORM_MCP_SESSION_NAME | A --mcp-session-name megfelelője |
A környezeti változó típusú titkok szintén a folyamat környezetéből olvasódnak be: folyamatos integrációban ez az ajánlott mechanizmus.
Példák
Section titled “Példák”Projekt megnyitása:
restorm --open ./api.restormForgatókönyv futtatása megjelenített ablakkal (hasznos, ha követni kell a lefutást):
restorm --open ./api.restorm --run "Tests de fumée"Futtatás ablak nélkül, paraméterekkel és teljes naplóval:
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=stagingA kimeneti formátumról, a paraméterek átalakításáról és a pipeline-példákról lásd: Headless futtatás és CI.