ヘッドレス実行と継続的インテグレーション

インターフェースで組み立てたシナリオは、コマンドラインから ウィンドウなしで 実行できます。API テストをパイプラインの 1 ステップに変えるための道筋です。

restorm \
  --open ./projet.restorm \
  --run "Find pets by status" \
  --headless \
  --param status=available

Pro エディション

ヘッドレス実行は Pro および Enterprise エディションに含まれます。組織の トークンが必要で、環境変数 RESTORM_TOKEN で渡します。 プランと機能 を参照してください。

引数

引数	役割
--open <path>、-o	開くプロジェクト。--run と併用する場合は必須
--run <target>	実行するシナリオ。これを指定するとコマンドラインモードが有効になります
--by <name|id>	--run がシナリオを指し示す方法。名前（既定）または識別子
--headless	ウィンドウを表示しません。指定しない場合はウィンドウが表示され、ログはコンソールに流れます
--param name=value	シナリオの入力パラメーター（Input / Param ボックス）に渡す値。繰り返し指定できます
--all-logs	エンジンのエントリーも含めます。既定では Log アクションのものだけが出力されます
--out <file>	ログをファイルにも書き出します（リアルタイム）
--clear-settings、-cls	起動前に設定を初期化します

書式が不正な --param（= がないもの）は標準エラー出力に報告され、無視されます。 nom=（値が空）は受け付けられます。

値はパラメーターの 宣言された型 に従って変換されます — 変数とデータ を参照してください。

--param はシナリオの入力を対象とし、環境変数は対象外です

--param はシナリオ内で宣言された Input / Param ボックスに値を供給します。 環境変数を変更するものでは ありません。したがって、上記の --param status=available が機能するのは、そのシナリオが status という入力 パラメーターを公開しているからです。--param baseUrl=… でベース URL を上書き しようとしても、baseUrl が環境変数であれば何の効果もありません。 環境 の中で生きている値は、 コマンドラインから上書きできないのです。そうした値を CI から操作できるようにするには、 シナリオの入力パラメーター（Input / Param ボックス）として公開し、必要な場所へ 配線してください。

終了コード

コード	意味
0	シナリオが正常に終了しました
1	失敗、キャンセル、またはエンジンのエラー
2	対象が見つからない、--out のファイルにアクセスできない、または --open なしの --run
3	権限が拒否されました：RESTORM_TOKEN がない / 無効 / 失効している、プランが不足している、または検証エンドポイントに到達できない

この規約のおかげで、結果を CI ランナーからそのまま利用できます。

出力

ログは標準出力に、生成された時点で 1 エントリーずつ、YAML のシーケンスとして 書き出されます。

- message: "🔵 [2026-07-29 10:30:00.123] Commande créée"
  data: { id: 4271 }

レベルには印が付きます。⚪ debug、🔵 info、🟠 warn、🔴 error です。行が 折り返されることはないので、出力は grep できます。エラーは標準エラー出力に出ます。

これはインターフェースの「ログをコピー」ボタンが生成するテキストと まったく同じ です。どちらも同じ形式です。

CI でのシークレット

シークレットのソースには 環境変数 を使ってください。シークレットは CI の 保管庫から注入され、Restorm はそれを読むだけで、プロジェクトには何も書き込まれません。 シークレット を参照してください。

バージョンを固定してください

ダウンロードチャンネルが公開するのは バージョン付き のファイル （restorm_<version>_amd64.deb）で、latest のエイリアスはありません。パイプライン ではバージョンを固定してください。新しいバージョンがレビューなしにジョブの挙動を 変えてしまわないよう、CI ではいずれにせよそうしたいところです。最新バージョンの 正確なファイル名は、同じチャンネルのマニフェスト latest-linux.yml に記載されています。

GitHub Actions

name: Tests d'API
on: [push]

jobs:
  api:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Installer Restorm
        env:
          RESTORM_VERSION: '1.4.2' # 固定したいバージョン
        run: |
          curl -sSL -o restorm.deb \
            "https://dl.restorm.app/restorm_${RESTORM_VERSION}_amd64.deb"
          sudo apt-get install -y ./restorm.deb

      - name: Exécuter les tests de fumée
        env:
          RESTORM_TOKEN: ${{ secrets.RESTORM_TOKEN }}
          API_TOKEN: ${{ secrets.API_TOKEN }}
        run: |
          xvfb-run -a restorm \
            --open ./api.restorm \
            --run "Find pets by status" \
            --headless \
            --all-logs \
            --out run.log \
            --param status=available

      - name: Publier le journal
        if: always()
        uses: actions/upload-artifact@v4
        with:
          name: journal-restorm
          path: run.log

GitLab CI

tests-api:
  image: ubuntu:24.04
  variables:
    RESTORM_TOKEN: $RESTORM_TOKEN
    RESTORM_VERSION: '1.4.2' # 固定したいバージョン
  before_script:
    - apt-get update && apt-get install -y curl xvfb
    - curl -sSL -o restorm.deb "https://dl.restorm.app/restorm_${RESTORM_VERSION}_amd64.deb"
    - apt-get install -y ./restorm.deb
  script:
    - >
      xvfb-run -a restorm
      --open ./api.restorm
      --run "Find pets by status"
      --headless --all-logs --out run.log
      --param status=$PET_STATUS
  artifacts:
    when: always
    paths: [run.log]

ヘッドレスで変わること

• Toast アクションは何もしません。実行はそのまま続きます。
• パラメーターを対話的に尋ねることはできません。--param ですべて渡すか、既定値を 使わせてください。
• ディスプレイのないマシンでは、設定がどうであれ MCP サーバー は起動しません。

トークンを取得する

RESTORM_TOKEN トークン（接頭辞は rstk_）は、アカウントのダッシュボードから 生成します。個人ではなく 組織に紐づく もので、CI の保管庫に入れるのはこの トークンです。 アカウントとログイン を参照してください。