Komentorivi

restorm [--open <path>] [--run <target>] [options]

Argumentit

Argumentti	Alias	Tyyppi	Oletus	Tehtävä
--open <path>	-o	merkkijono	—	Käynnistyksen yhteydessä avattava tiedosto tai kansio. Pakollinen --run-valitsimen kanssa
--run <target>		merkkijono	—	Suorittaa nimetyn skenaarion ja poistuu. Ottaa komentorivitilan käyttöön
--by <name|id>		luettelo	name	Miten --run yksilöi skenaarion
--headless		totuusarvo	false	Ei lainkaan ikkunaa. Ilman tätä ikkuna näkyy suorituksen ajan
--param name=value		toistettava	—	Antaa skenaariolle parametrin
--all-logs		totuusarvo	false	Sisällyttää myös moottorin merkinnät, ei vain Log-toiminnon merkintöjä
--out <file>		merkkijono	—	Kirjoittaa lokin myös tiedostoon, sitä mukaa kuin sitä syntyy
--clear-settings	-cls	totuusarvo	false	Palauttaa asetukset alkutilaan ennen käynnistystä
--inactive-window		totuusarvo	false	Näyttää ikkunan antamatta sille kohdistusta
--quiet	-q	totuusarvo	—	Rajaa tulosteen pelkkään suorituslokiin. Lisätään automaattisesti, kun --run on annettu
--mcp-session-name <name>		merkkijono	auto	Nimeää MCP-istunnon (katso myös muuttuja RESTORM_MCP_SESSION_NAME)
--help	-h			Näyttää ohjeen
--version	-v			Näyttää version

Poistumiskoodit

Koodi	Merkitys
0	Skenaario päättyi onnistuneesti
1	Epäonnistuminen, peruutus tai moottorin virhe
2	Kohdetta ei löytynyt, --out-tiedostoon ei päästy käsiksi, tai --run annettiin ilman --open
3	Oikeus evätty — token puuttuu, on virheellinen tai peruutettu, tilaustaso ei riitä, tai tarkistuspisteeseen ei saada yhteyttä

Ympäristömuuttujat

Muuttuja	Tehtävä
RESTORM_TOKEN	Organisaatiotoken (rstk_…), jota headless-suoritus vaatii
RESTORM_MCP_SESSION_NAME	Vastaa valitsinta --mcp-session-name

Myös ympäristömuuttuja-tyyppiset salaisuudet luetaan prosessin ympäristöstä: tämä on suositeltu tapa jatkuvassa integraatiossa.

Esimerkit

Projektin avaaminen:

restorm --open ./api.restorm

Skenaarion suorittaminen ikkuna näkyvissä (kätevä seuraamista varten):

restorm --open ./api.restorm --run "Tests de fumée"

Suoritus ilman ikkunaa, parametreilla ja täydellä lokilla:

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=staging

Katso Headless-suoritus ja jatkuva integraatio, jossa käsitellään tulostemuoto, parametrien muunnos ja esimerkkejä putkista.