runner

• デスクトップアプリ — Windows / macOS 向けのシステムトレイアプリ。ほとんどのユーザーにおすすめです。
• CLI — ヘッドレスサーバーや CI/CD 環境向けのターミナルコマンド。

​

セットアップ

​

デスクトップアプリ

​

ダウンロード

​

使い方

1. アプリをインストールして起動します
2. 設定ウィンドウで Runner API キー（rfr_...）とサーバー URL を入力します
3. アプリが自動的に接続し、システムトレイに表示されます
4. Runner がサーバーからのジョブを受け付ける準備が整いました

​

CLI

​

概要

npx @refrainai/cli runner -- \
  --api-key <rfr_key> \
  [options]

​

必須引数

​

オプション引数

​

環境変数

​

使用例

​

基本的な使い方

npx @refrainai/cli runner -- --api-key rfr_xxx

​

名前付き Runner

npx @refrainai/cli runner -- \
  --api-key rfr_xxx \
  --name "staging-runner"

​

環境変数を使用

export REFRAIN_RUNNER_API_KEY="rfr_xxx"

npx @refrainai/cli runner

​

動作の仕組み

1. Runner はサーバーに対してアクティベーションを行い、コマンドのポーリングを開始します
2. サーバーがジョブからブラウザコマンドを送信すると、Runner がそれを受信しローカルで実行します
3. 実行結果（スクリーンショット、ダウンロード、録画を含む）はサーバーに返送されます
4. 接続を維持するため、30 秒ごとにハートビートを送信します
5. 接続が切断された場合、指数バックオフで自動的に再接続します
6. シャットダウン時、Runner はグレースフルに非アクティブ化されます