CLI コマンドリファレンス

プロジェクト記録と残りのクレジットを読み取ります。

project show

パラメーターなし。

screenrig project show

data.credit_remaining は整数のクレジット残高です。1000未満の場合、credits_low 警告が表示されることがあります。2027年1月1日までは常識的な範囲で利用が無料のため、残りクレジットはエージェントが読み取れる整数メーターであり、停止指示ではありません。

ダッシュボードのプロジェクト切り替えで表示される名前を設定

project rename NAME

プロジェクトのプラン、独立したscreensおよびadvertiserの機能フラグ、および有効な機能セットを読み取ります。ルート拒否は古い機能読み取りより優先されます。

project capabilities

UTC日ごとのプロジェクトのスクリーン利用可能性を読み取ります。

project uptime [--day-from YYYY-MM-DD] [--day-to YYYY-MM-DD]

screenrig project uptime
screenrig project uptime --day-from 2026-09-01 --day-to 2026-09-30

範囲とデフォルトは screen uptime のものです。data.items は UTC 日ごとに 1 行ずつ（古い順）表示します：online_s と offline_s はその日の状態が記録されたスクリーンで合計され、availability、coverage（そのスクリーンの 1 日のうち状態が記録された割合）、screens（状態が記録されたスクリーン数）です。本日の行はこれまでに終了した区間をカバーします。screen list は現在オンラインのユーザーを示します。

UTC時間ごとのフリートの状態を読み取ります：報告中のスクリーン、ホット、ディスプレイ切断、クラッシュ。

project health-trend [--from TIME] [--to TIME]

screenrig project health-trend
screenrig project health-trend --from 7d

data.items は UTC 時間ごとのフリートのヘルスを一覧表示します：hour, screens_reporting, hot（80 ℃以上のピーク温度）, display_disconnected, crashing（24 時間以内に 3 回以上のクラッシュ）。CLI は next_cursor まで追跡し、毎時 next_cursor null で応答します。各時間はレポートから最大約 5 分遅れます。

プロジェクトメンバーおよび広告購入者の招待を作成、一覧表示、または取り消します。

invitations create --email ADDRESS[,ADDRESS] [--kind member|ad-buyer]
invitations create --link
    [--screen-id ID] [--slot-id ID] [--policy trusted|review_required]
invitations list [--kind member|ad-buyer] [--status STATUS]
invitations revoke ID

--kind はデフォルトで member です。メール配信が初期設定で、7日後に有効期限が切れます。--email ではカンマ区切りで最大50件まで受信者を指定できます。--link はメンバー限定で、受信者は1名のみ指定でき、24時間有効な招待 URL を1回だけ返します。必ずその URL をログ、メモ、共有記録に記載しないでください。リストでは返しません。

広告購入者はメールのみ使用し、所有するスクリーンまたはスロットのスコープ（または両方）が必要です。--screen-idと--slot-idはカンマ区切りのIDを受け入れます。--policyはtrustedまたはreview_requiredを選択します。ステータスフィルターはqueued、sent、issued、accepted、revoked、expired、failedです。

screenrig invitations create --email teammate@example.com
screenrig invitations create --kind ad-buyer --email buyer@example.com --screen-id scr_LOBBY --policy review_required

エージェントは招待を受け入れません。招待された人はメールを開き、サインインまたはパスキーを作成し、ダッシュボードで承認します。リンクサインアップは最初にメールを確認します。承認済み招待の取り消しはメンバーシップを元に戻しません。広告アクセスを取り消すにはバイヤーメンバーシップコントロールを使用してください。

このインストールに使用可能な認証情報があるか報告します。

agent status

パラメーターなし。

screenrig agent status

読み取り専用。ローカルまたはサーバー状態を変更せず、費用もかかりません。結果にはセッションのaccess、そのeffective_access、およびプロジェクトのレビュー設定や承認できないメンバーが低く保持している場合はaccess_limited_by（projectまたはperson）が含まれます。

このインストールを既存アカウントにサインインさせ、ダッシュボードで本人の承認を得ます。

login [--project ID] [--access read|propose|manage] [--name NAME] [--no-wait] [--resume ID]

screenrig login --access read

ダッシュボードのアドレスと8文字のコードを標準エラーに印刷し、最大24時間待機します。ユーザーはコードが一致することを確認し、接続を1回押します。最後の1時間のダッシュボードサインイン後は2回目のパスキープロンプトはありません。エンベロープはstatus: signed_in、プロジェクト、組織およびaccessを報告します。サインイン済みのインストールで再度実行するとプロジェクトを追加するか、読み取り専用または提案プロジェクトを管理に昇格します。拒否はlogin_deniedで、有効期限はlogin_expiredです。

このインストールのサインインを終了し、トークンを削除する。

logout

パラメーターなし。

screenrig logout

サーバー上のサインインを取り消し、保存されたトークンを削除して status: signed_out を報告します。サーバーに到達しなかった可能性のある失敗はトークンを保持するため、再実行は安全です。再度サインインするには screenrig login を実行してください。

通常のダッシュボードURLを開きます。このコマンドはサインインリンクを発行せず、セッションを作成せず、エージェント認証も不要です。

dashboard [open]

screenrig dashboard

ダッシュボードはサインイン後にその人のプロジェクトを表示します。ブラウザのプロジェクト選択はエージェントにバインドされたプロジェクトを変更しません。

エージェント資格情報なしでサインインリセットメールを依頼

dashboard reset-sign-in --email ADDRESS

承認はメールにログインがあるかどうかを明かしません。メールで送信されたリセットは 1 時間で期限切れになります。本人は新しいパスキーを作成します。完了するとサインイン資格情報が置き換えられ、他のセッションは無効になります。

このインストールをチェックし、名前ごとにすべてのチェックを報告します。

doctor [--repair-config]

screenrig doctor

data.checks は各チェック項目とそのステータスを示します。Node ランタイム、解決された設定パスとその権限、コントロールプレーンのオリジンとサービスルート、公開されている feedback 機能、オプションのメディアツールチェーン（ffmpeg, ffprobe, encoder_libx264, encoder_libx265, encoder_libwebp, cwebp, filter_hdr_tonemap）です。

チェックに失敗するとdoctorが非ゼロで終了するため、インストールを不健康と判断する前に個別の名前を読み取ってください。メディアツールチェーンの欠落はmedia uploadのみに影響します。

バンドルされたCLIのバージョンとそのプロトコルアダプターを印刷します。

version

パラメーターなし。

screenrig version

セッションで最初にこれを実行します。成功したエンベロープはランチャーがバンドルされた CLI を解決したことを証明します。--version と -V はコマンドラインのどこからでも同じことを行います。

このプロジェクトのサービスクライアント一覧（有効・無効含む）、キー・シークレットID・使用状況付き

service-client list

パラメーターなし。

screenrig service-client list

秘密を返しません。

1つのサービスクライアントを表示します。

service-client show ID

screenrig service-client show scl_ID

各キーのkidと各シークレットのcss_IDをローテーション用に一覧表示

このプロジェクト所有のサービスクライアントを作成。

service-client create --name NAME [--capability NAME]... [--access read|propose|manage] [--key-file PATH] [--secret-file PATH]

screenrig service-client create --name "Nightly report" --access read --capability reports --key-file screenrig-client.pem

上記のアイデンティティ、プロジェクト、組織管理者の権限が必要です。組織ごとに有効なクライアントは、すべてのプロジェクトを合わせて最大 50 個です。独自の kid がない鍵は RFC 7638 のサムプリントで識別されます。

ダウンタイムなしのローテーションのために2つ目の公開鍵を登録します。

service-client add-key ID --key-file PATH

screenrig service-client add-key scl_ID --key-file new.pem

クライアントは最大で2つのキーを保持します。

ダウンタイムなしのローテーション用に2つ目のシークレットを生成します。

service-client add-secret ID --secret-file PATH

screenrig service-client add-secret scl_ID --secret-file new-secret

クライアントは最大で2つのシークレットを保持します。現在のものは削除するまで有効です。

キーを削除します。これにより発行されたトークンは数秒で無効になります。

service-client remove-key ID --kid KID

screenrig service-client remove-key scl_ID --kid KID

クライアントは少なくとも1つのキーまたはシークレットを保持します。

シークレットを削除します。これにより発行されたトークンは数秒で無効になります。

service-client remove-secret ID --secret-id css_ID

screenrig service-client remove-secret scl_ID --secret-id css_ID

サービスクライアントを永久に取り消します。

service-client revoke ID --yes

screenrig service-client revoke scl_ID --yes

キーとシークレットを削除します。トークンは数秒以内に無効になります。レコードは監査のために保持されます。

プロジェクトのメディアストアに提示可能な全画面静止画を生成します。

media generate --prompt TEXT [--aspect-ratio RATIO] [--quality low|medium|high] [--tag TAG]
               [--no-progress]

screenrig media generate --prompt "A 16:9 restaurant menu poster for North Lobby Cafe. Dark walnut, gold type. Title NORTH LOBBY CAFE. Items: Espresso $4, Cortado $4.50, House Blend $3. Footer Open 7am to 7pm. Typeset every line of copy in the image." --aspect-ratio 16:9 --quality high --tag LobbyMenu

コマンドはプロジェクトメディアストアにロスィーWebPを保存し、data.media_id (med_…) を返します。バイトを再アップロードしないでください。ピクセルやプロンプトを印刷しないでください。オーサリングツリーとプロンプト契約は Compose にあります。

ローカルファイルを配信バイトに変換し、アップロードしてオブジェクトの準備完了を待ちます。

media upload <file> [--content-type TYPE] [--tag TAG] [--folder ID] [--no-wait] [--poll-ms MS]
             [--timeout MS] [--no-transcode] [--codec h264|hevc] [--max-fps N]
             [--max-edge PIXELS] [--webp-quality 1-100] [--no-progress]
             [--preset signage-1080p30|signage-4k30] [--no-audio]

screenrig media upload ./lobby-welcome-loop.mp4 --tag LobbyLoop

ビデオはMP4になります：デフォルトはH.264ハイプロファイルレベル4.2、または--codec hevc付きH.265、yuv420pタグ付きRec. 709。HDRソースはRec. 709にトーンマップされます。ソースに音声がある場合はAAC 192 kbit/s、48 kHz、ステレオです。

静止画は品質90でロスのある WebP になり、元にアルファがあれば保持します。アニメーション元は無限ループします。サイズ制限内の WebP は再エンコードされずそのまま通過します。

オーディオはプレイリストのサウンドトラック用に MP3 になります。MP3 ソースは変換せずアップロード。WAV、AAC、M4A、OGG、FLAC は 128 kb/s MP3 に変換（libmp3lame を含む ffmpeg ビルドが必要）。トラックは1秒から3時間。playlist init はオーディオ入力をページではなくサウンドトラックトラックに変換。ready オブジェクトは audio メディアオブジェクトで、再生時間を含みます。ページに配置できず、プレイリストの audio サウンドトラックで名前を付けてください。

準備済みオブジェクトIDは data.media_id です。同じ値が data.id と data.operation.result.media_id です。そのIDがプレイリストセレクターで使用されます。

video.mp4のような情報量の少ないファイル名は、封筒にgeneric_filenameの警告を追加します。アップロードは成功し、CLIはファイル名を変更しません。コマンド実行前に名前を選んでください。

変換は ffmpeg と ffprobe を PATH から、または SCREENRIG_FFMPEG と SCREENRIG_FFPROBE の絶対パスから実行します。静止画は ffmpeg の libwebp エンコーダーを優先し、PATH または SCREENRIG_CWEBP で cwebp にフォールバックします。セッションの最初のアップロード前に doctor を実行してください。

--preset signage-1080p30 は長辺を1920、短辺を1080、フレームレートを一定の30fpsに制限します。signage-4k30 は長辺を3840、短辺を2160、フレームレートを一定の30fpsに制限します。どちらも横向き、縦向き、正方形のコンテンツに対応します。--no-audio は無音クリップの場合、音声エンコードを省略します。これらのオプションは動画にのみ適用されます。

screenrig media upload ./lobby.mov --preset signage-1080p30 --no-audio

screenrig media upload ./menu.png --folder mfd_01EXAMPLEFOLDER000000000

アップロードはライブラリのルートに置かれ、準備ができるとフォルダーに移動します。media upload-batch --folder はすべてのアップロード済みアイテムを同様に移動します。

Proposeアクセス時、またはプロジェクトがエージェント変更のレビューを要求する場合、新しいアップロードはタグ、フォルダー、またはallセレクターが再生される前に人のレビューを待ちます。詳細はレビューを参照してください。

マニフェストから多数のローカルファイルをアップロードし、必要な状態ファイルから再開します。

media upload-batch <manifest.json> [--state FILE] [--concurrency N] [--tag TAG] [--folder ID]
                   [--poll-ms MS] [--timeout MS] [--no-transcode] [--codec h264|hevc]
                   [--max-fps N] [--max-edge PIXELS] [--webp-quality 1-100] [--no-progress]
                   [--preset signage-1080p30|signage-4k30] [--no-audio]

screenrig media upload-batch ./images.json --state ./upload-state.json

エンベロープはマニフェスト順にdata.items[]を運び、それぞれにpath、source_filename、sha256、outcome（acceptedまたはresumed）、media_idがあります。data.failed[]は着地しなかったアイテムを運びます。

メディアのファイルをその場で置き換えます。ID、プレイリスト、スケジュールはそのまま使えます。

media replace <id> <file> [--expect-rev REVISION] [--note TEXT] [--content-type TYPE] [--no-wait]
              [--poll-ms MS] [--timeout MS] [--no-transcode] [--codec h264|hevc] [--max-fps N]
              [--max-edge PIXELS] [--webp-quality 1-100] [--no-progress]
              [--preset signage-1080p30|signage-4k30] [--no-audio]

screenrig media replace med_01EXAMPLEIMAGE0000000000 ./menu-v2.png
screenrig media replace med_01EXAMPLEVIDEO0000000000 ./intro.mp4 --expect-rev 3 --note "Spring cut"

メディアはID、タグ、フォルダーを保持するため、それを指定しているすべてのプレイリストとスケジュールは次のマニフェストで新しいファイルを再生し、タグ、フォルダー、allのセレクターもそれを反映します。再スケジュールは不要です。このコマンドはmedia uploadと同じ手順（変換、プランの動画バイト数上限、サイズ上限、ストレージ容量、署名付き転送）を実行し、新しいメディアを追加する代わりに置き換えます。--tagと--folderは指定できません。

デフォルトでは、コマンドは処理の完了を待ちます。data.media_idとdata.idはメディアID、data.versionはmedia versionsにおける新しいファイルの番号、data.revisionはメディアの新しいリビジョンです。data.warnings、data.operation、data.upload、data.transcodeとタイミングはmedia uploadと同様に報告され、操作IDはエンベロープに含まれます。--no-waitを指定すると、data.operationは受理された操作となり、data.versionとdata.warningsは含まれません。

アスペクト比の変更は許可されます。エンベロープにはaspect_ratio_changed警告が含まれ、data.warnings[].playlistsはそのメディアを使用するプレイリストを示すので、表示を確認してください。現在のファイルとバイトが同じファイルはresource_conflict（終了コード13）で拒否されます。

以前のファイルはすべてメディアの履歴に残り、そのバージョンを削除するまで保存済みバイトに含まれます。media versionsを参照してください。

Propose アクセスの場合、またはプロジェクトがエージェントの変更にレビューを要求する場合、置換は人を待ち、コマンドは成功します（終了コード0）。data.statusはpending_reviewで、data.review_idがレビューを示し、警告pending_reviewがそのURLを示し、data.nextはscreenrig reviews show IDです。人が承認するまでメディアは現在のファイルを再生し続けるので、待機中であることを伝え、書き込みを繰り返さないでください。同じメディアのより新しい置換は、待機中のものを置き換えます。レビューを参照してください。

メディアがこれまでに持っていたファイルを、使用中のファイルを先頭にして一覧表示します。

media versions <id> [--limit N] [--cursor CURSOR]

screenrig media versions med_01EXAMPLEIMAGE0000000000

data.itemsには、メディアがこれまでに持っていたファイルごとに1件のエントリーがあります：number、current、filename、content_type、sha256、bytes、width、height、duration_ms、codecs、source（upload、replace、sync、またはrestore）、note、by（種類はperson、agent、client、またはsyncで、IDと名前を含みます）、およびrestored_from。使用中のファイルが最初（current: true）で、その後は新しい順です。バージョン1は最初のアップロードで、置換、復元、メディア同期の変更のたびに次の番号が加わります。

--limitも--cursorも指定しない場合はすべてのページを読み取り、data.next_cursorはnullになります。どちらかを指定すると1ページだけ読み取ります。data.next_cursorが文字列である間は、--cursorをその値にしてコマンドを再実行してください。読み取り専用アクセスで足ります。過去のバージョンのバイトは、media version deleteが削除するまで保存され、プロジェクトの保存済みバイトに含まれます。保持するバージョン数に上限はなく、プランの無料ストレージを超えて保存されたバイトは、ほかのストレージと同じく課金されます。

過去のバージョンを新しいバージョンとして使用中に戻します。

media restore <id> --number N [--expect-rev REVISION] [--note TEXT]

screenrig media restore med_01EXAMPLEIMAGE0000000000 --number 2
screenrig media restore med_01EXAMPLEIMAGE0000000000 --number 2 --expect-rev 5 --note "Back to the winter menu"

メディアはIDを保持して新しいリビジョンに移り、それを指定しているすべてのプレイリストとスケジュールがそのファイルを再び再生します。コピー元のバージョンは履歴に残ってバイトを共有し、新しいバージョンは他と同様に保存済みバイトに含まれます。data.mediaはメディアで、data.warningsは、復元したファイルのアスペクト比が異なる場合に、そのメディアを使用するプレイリストを示すaspect_ratio_changedを含みます。

使用中のバージョンは復元できず（resource_conflict、終了コード5）、不明なバージョンはnot_found（終了コード4）です。Propose アクセスの場合、またはプロジェクトがエージェントの変更にレビューを要求する場合、復元は人を待ち、コマンドは成功します（終了コード0）。data.statusはpending_reviewでdata.reviewを伴い、警告pending_reviewがそのURLを示し、data.nextはscreenrig reviews show IDです。人が承認するまでメディアは現在のファイルを再生し続けるので、書き込みを繰り返さないでください。

過去のバージョンとその保存済みバイトを削除します。

media version delete <id> --number N

screenrig media version delete med_01EXAMPLEIMAGE0000000000 --number 2

バージョンのレコードは削除され、そのバイトは直ちにプロジェクトの保存済みバイトから外れます。保存されているオブジェクトは、他のバージョンまたは使用中のファイルが同じファイルを保持していない限り、24時間後に削除されます。削除したバージョンは復元できません。使用中のバージョンは削除できず、メディアの置換がレビュー待ちの間はどのバージョンも削除できません。どちらもresource_conflict（終了コード5）で、どのバージョンが使用中かはmedia versions IDで確認できます。不明なバージョンはnot_found（終了コード4）です。削除には Manage アクセスが必要で、Propose の認証情報はinsufficient_accessで拒否され、削除がレビュー用に提案されることはありません。

1件のメディアオブジェクトとその現在のリビジョンを読み込みます。

media show <id>

screenrig media show med_01EXAMPLEIMAGE0000000000

検査用に保存済みのレンディションをディスクに書き込みます。バイトは絶対に印刷しません。

media download <id> [--output FILE]

screenrig media download med_01EXAMPLEIMAGE0000000000 --output ./lobby.webp

エンベロープはmedia_id、path、bytes、sha256、content_type、primitive、filename、オプションのsource_filename、width / heightを報告します。ピクセルは含みません。生成された静止画をガラスに表示する前の検証に使用してください。

タグやプリミティブで絞り込み可能なメディアオブジェクト一覧

media list [--tag TAG] [--primitive image|video|audio] [--folder ID|root] [--library]

screenrig media list --tag LobbyLoop --primitive video
screenrig media list --folder mfd_01EXAMPLEFOLDER000000000
screenrig media list --library

各行には folder_id が含まれますが、ライブラリのルートにはありません。

1つのオブジェクトのタグを変更またはクリアします。利用可能期間のルールはmedia availabilityで設定します。

media update <id> (--tag TAG | --tags TAG1,TAG2 | --clear-tag) [--expect-rev REVISION]

screenrig media update med_01EXAMPLEIMAGE0000000000 --tag LobbyLoop

Proposeアクセス時、またはプロジェクトがエージェント変更のレビューを要求する場合、承認済みメディアの再タグ付けはokに警告media_review_pendingを返します：スクリーンは承認済みタグで再生を続け、人が変更を承認するまで拒否はタグを元に戻します。レビューは数秒以内にreviews listに表示されます。承認済みプレイリストやレビュー待ちプレイリストを変更しない再タグ付けは自動で適用されます。詳細はレビューを参照してください。

動的セレクターが 1 つのファイルを選べる時期を設定またはクリアします。

media availability <id> (--file FILE | --clear) [--expect-rev REVISION]

screenrig media availability med_01EXAMPLEIMAGE0000000000 --file rule.json

ルールの要素と動作はメディアの利用可能期間を参照してください。

メディアオブジェクトを1つ削除します。

media delete <id> [--expect-rev REVISION]

screenrig media delete med_01EXAMPLEIMAGE0000000000

メディアファイルとフォルダーをフォルダーに移動、またはライブラリのルートに戻します。

media move <id>... (--folder ID | --root)

screenrig media move med_01EXAMPLEIMAGE0000000000 med_01EXAMPLEVIDEO0000000000 --folder mfd_01EXAMPLEFOLDER000000000
screenrig media move mfd_01EXAMPLEFOLDER000000000 --root

移動はすべてか無かのリクエストです。フォルダーは自身またはその中のフォルダーに移動できず、フォルダーは最大10階層まで入れ子になります。すでに目的地にあるアイテムはそのままです。data.mediaとdata.foldersは移動した数をカウントします。

ファイルの移動は、古いフォルダーと新しいフォルダーの by:folder セレクターが各スクリーンの次のセレクター解決から再生する内容を変えます。フォルダーの移動はフォルダー自身のファイルを変えません。Propose access 下またはプロジェクトがエージェント変更にレビューを要求する場合、移動したファイルは人のレビュー（reviews list）を待ち、承認されたプレイリストは承認時のフォルダーで再生を続けます。レビューを参照してください。

プロジェクトのメディアフォルダー一覧

media folder list [--library]

screenrig media folder list
screenrig media folder list --library

プロジェクトのすべてのフォルダーを最大1000件、名前順で返します：data.items、id、name、parent_id（ライブラリのルートはnull）、およびrevision。parent_idからツリーを構築します。ファイルのフォルダーはfolder_idでmedia listとmedia showにあります。ライブラリのルートにはありません。

1件のメディアフォルダーを読み込みます。

media folder show <id>

screenrig media folder show mfd_01EXAMPLEFOLDER000000000

エンベロープはフォルダーのname、parent_id、revisionを運びます。

ライブラリのルートまたは他のフォルダー内にメディアフォルダーを作成。

media folder create --name NAME [--parent ID]

screenrig media folder create --name Menus
screenrig media folder create --name Lunch --parent mfd_01EXAMPLEFOLDER000000000

組織は、すべてのプロジェクトを合わせて最大1000個のフォルダーを最大10階層まで保持します。プレイリストは by:folder セレクターでフォルダー内のファイルを再生します。

メディアフォルダーの名前を変更するか、中身すべてを別のフォルダーに移動します。

media folder update <id> [--name NAME] [--parent ID | --root] [--expect-rev REVISION]

screenrig media folder update mfd_01EXAMPLEFOLDER000000000 --name Archive
screenrig media folder update mfd_01EXAMPLEFOLDER000000000 --root

フォルダーは自身またはその内部のフォルダーに移動できず、移動はすべてのフォルダーが10階層以内に収まる必要があります。現在の値を送信するのは無操作です。

メディアフォルダーを削除します。中のファイルとフォルダーは1階層上に移動します。

media folder delete <id> [--expect-rev REVISION]

screenrig media folder delete mfd_01EXAMPLEFOLDER000000000

フォルダーのみを削除します。中のファイルとフォルダーは親に移動し、親がなければライブラリのルートに移動します。by:folderセレクターで指定すると何も一致しなくなるため、先にプレイリストの指定先を変更してください。

同期が SharePoint または OneDrive for work のフォルダーを読み取れるように、ご自身の Microsoft Entra アプリ、またはプロジェクトの Microsoft 接続を追加します。

media sync account add microsoft365 --name NAME
    (--tenant-id TENANT --client-id ID --secret-file FILE | --connection-id ID)

screenrig media sync account add microsoft365 --name Contoso --tenant-id contoso.onmicrosoft.com --client-id 0b1d2f3a-4c5e-4f60-8a7b-9c0d1e2f3a4b --secret-file secret.txt
screenrig media sync account add microsoft365 --name Contoso --connection-id pcn_01EXAMPLECONNECTION0000

Microsoft Entra 管理センターで、リダイレクト URI のないシングルテナントのアプリを登録し、クライアントシークレットを追加し（シークレット ID ではなく値をコピー）、Microsoft Graph のアプリケーションのアクセス許可 Sites.Selected（その後、各サイトへの読み取りアクセスをアプリに付与）または Files.Read.All を追加して、管理者の同意を付与します。アプリはこのプロジェクトに属します。次に media sync account test を実行します。

Dropbox アカウントを追加し、所有者が Dropbox にサインインした状態で開いて接続するための 1 回限りのリンクを表示します。

media sync account add dropbox --name NAME [--app-key KEY]

screenrig media sync account add dropbox --name "Marketing Dropbox"
screenrig media sync account add dropbox --name "Marketing Dropbox" --app-key YOURAPPKEY

data.authorize_url がリンク、data.authorize_expires_at がその有効期限です。CLI がブラウザーを開くことはありません。リンクは Dropbox アカウントの所有者に送ってください。所有者は読み取り専用のアクセス（files.metadata.read、files.content.read、account_info.read）を許可します。data.state が ready（最初は pending_consent）になるまで media sync account show を実行し、その後 media sync create dropbox を実行します。ご自身の Dropbox アプリでは、これらの権限を有効にし、出力に表示されるリダイレクト URI を登録する必要があります。

Google Drive アカウントを追加してすぐに使える状態にし、フォルダーの共有先となるサービスアカウントのアドレスを表示します。

media sync account add google-drive --name NAME [--key-file FILE]

screenrig media sync account add google-drive --name "Marketing Drive"
screenrig media sync account add google-drive --name "Marketing Drive" --key-file key.json

data.config.service_account_email は各フォルダーを共有するアドレスで、閲覧者で十分です。screenRIG のサービスアカウントを通じる場合、フォルダーが同期されるのは、検証済みメールアドレスを持つこのプロジェクトのメンバーがそれを共有したか、所有している場合だけです（そうでない場合は media_sync_sharer_not_member）。ご自身のキーを使う場合は、サービスアカウントと共有されたフォルダーはすべて同期されます。

このプロジェクトのメディア同期アカウントを、種類、状態、直近のテストとともに一覧表示します；シークレットは返されません。

media sync account list

パラメーターなし。

screenrig media sync account list

アカウントを確認します。テナントとクライアント ID、状態、マスクされたシークレット、直近のテストを表示します。

media sync account show <id>

screenrig media sync account show msa_01EXAMPLEACCOUNT0000000

Dropbox アカウントには、接続した人と app_key も表示され、Google Drive アカウントには service_account_email が表示されます。

アカウントの名前を変更するか、Microsoft アプリのテナント、アプリケーション ID、クライアントシークレットを変更するか、Google Drive アカウント独自のキーを置き換えます。

media sync account update <id> [--name NAME] [--tenant-id TENANT] [--client-id ID]
    [--secret-file FILE | --key-file FILE] [--expect-rev REVISION]

screenrig media sync account update msa_01EXAMPLEACCOUNT0000000 --secret-file new-secret.txt
screenrig media sync account update msa_01EXAMPLEACCOUNT0000000 --name "Contoso tenant" --expect-rev 2

少なくとも 1 つの変更が必要です。認証情報を変更すると last_test が消去されるので、アカウントをもう一度テストしてください。Entra のクライアントシークレットには有効期限があるため、期限が切れる前にここで置き換えてください。

Dropbox アカウントを接続または再接続するための、新しい 1 回限りのリンクを作成します。

media sync account connect <id>

screenrig media sync account connect msa_01EXAMPLEACCOUNT0000000

data.authorize_url と data.authorize_expires_at にリンクが含まれ、前のリンクは置き換えられます。Dropbox アカウントの所有者に送ってください。その人が完了しなかった場合や、アカウントが reconnect_required（Dropbox が接続を認めなくなった状態）の場合に使います。接続済みのアカウントは、新しい同意が完了するまで接続されたままで、別の Dropbox アカウントがサインインすると、その接続を引き継ぎます。

アカウントを確認します: Microsoft アプリのサインインと Graph のアクセス許可、または Dropbox や Google Drive アカウントの接続かキー。

media sync account test <id>

screenrig media sync account test msa_01EXAMPLEACCOUNT0000000

応答は last_test として保存されます。Microsoft アプリでは、credentials（Microsoft がトークンを発行したこと。拒否された場合は、値ではなく ID を指定したシークレットの AADSTS7000215 など、AADSTS コードが含まれます）と permissions（トークンが持つ Graph のアプリケーションのアクセス許可）を報告します。Sites.Selected だけの場合は警告になります: 各サイトには引き続き付与が必要で、共有リンクには Files.Read.All が必要です。このテストは、サイトへの付与やフォルダーは判定しません: 指定したフォルダーを読み取るのは media sync create です。失敗したチェックは、終了コード 0 で data.ok が false になります。

どの同期も使っていないアカウントを削除します。

media sync account delete <id> [--expect-rev REVISION]

screenrig media sync account delete msa_01EXAMPLEACCOUNT0000000

同期がアカウントを使っている間は、それらを示して resource_conflict（終了コード 5）が返ります；先にそれらを削除してください。

SharePoint または OneDrive for work のフォルダーをメディアフォルダーに同期します。

media sync create sharepoint --account-id ID --url URL [--folder-id ID] [--every DURATION] [--name NAME]

screenrig media sync create sharepoint --account-id msa_01EXAMPLEACCOUNT0000000 --url https://contoso.sharepoint.com/sites/Marketing/Shared%20Documents/Lobby%20Signs
screenrig media sync create sharepoint --account-id msa_01EXAMPLEACCOUNT0000000 --url "https://contoso.sharepoint.com/:f:/s/Marketing/EabcDEF" --folder-id mfd_01EXAMPLEFOLDER000000000 --every 1h --name "Lobby signs"

Microsoft が拒否したフォルダーは media_sync_source_refused（終了コード 5）になり、付与すべき権限が示されます；何も保存されません。

Dropbox のフォルダーをメディアフォルダーに同期します。

media sync create dropbox --account-id ID --url URL|PATH [--folder-id ID] [--every DURATION] [--name NAME]

screenrig media sync create dropbox --account-id msa_01EXAMPLEACCOUNT0000000 --url https://www.dropbox.com/home/Marketing/Lobby%20Signs
screenrig media sync create dropbox --account-id msa_01EXAMPLEACCOUNT0000000 --url /Marketing/Lobby --folder-id mfd_01EXAMPLEFOLDER000000000 --every 1h --name "Lobby signs"

実行のたびに、Dropbox が保存したフォルダー内の位置から続けて、変更された分だけを読み取ります。アカウントが開けないフォルダーは media_sync_source_refused、Dropbox が認めなくなった接続は dropbox_reconnect_required（media sync account connect）になり、どちらも終了コード 5 で、何も保存されません。

アカウントのサービスアカウントと共有された Google Drive のフォルダーをメディアフォルダーに同期します。

media sync create google-drive --account-id ID --url URL|ID [--folder-id ID] [--every DURATION] [--name NAME]

screenrig media sync create google-drive --account-id msa_01EXAMPLEACCOUNT0000000 --url https://drive.google.com/drive/folders/1AbCdEfGhIjKlMnOpQrStUvWxYz --folder-id mfd_01EXAMPLEFOLDER000000000 --every 1h
screenrig media sync create google-drive --account-id msa_01EXAMPLEACCOUNT0000000 --url 1AbCdEfGhIjKlMnOpQrStUvWxYz

screenRIG のサービスアカウントを通じる場合、フォルダーが同期されるのは、検証済みメールアドレスを持つこのプロジェクトのメンバーがそれを共有したか、所有している場合だけです（media_sync_sharer_not_member、終了コード 3、何も保存されません）。実行のたびにこれが再確認され、そのような共有者を失ったフォルダーは、メディアを保持したまま同期を状態 error で停止させます；メンバーの Google アカウントからもう一度共有してから、media sync update ID --resume を実行してください。Google ドキュメント、スプレッドシート、スライドのファイルは unsupported_type としてスキップされます。アドレスが開けないフォルダーは media_sync_source_refused（終了コード 5）になります；サービスアカウントと共有してください。

このプロジェクトのメディア同期を、メディアフォルダー、頻度、状態、直近の実行のステータスとともに一覧表示します。

media sync list

パラメーターなし。

screenrig media sync list

同期とその直近の実行の概要を確認します。

media sync show <id>

screenrig media sync show msy_01EXAMPLESYNC000000000

data.last_run には、status（ok、partial、error のいずれか）、added、updated、removed、pending_delete（スクリーンがまだ保持している削除済みファイルで、Removed フォルダーで待機中）、そして各ファイルの理由（unsupported_type、too_large、storage、subfolder、download_failed、unreadable、in_use）を伴う skipped が含まれます。失敗した実行には、修正方法を示す code と detail を伴う error が含まれます。data.source には、Dropbox では path、Google Drive では shared_by が加わります。

状態が error の同期は修復が必要です。メディアフォルダーが削除された場合は、media sync update --folder-id で別のフォルダーを指定します。ソースフォルダーが削除または移動された場合は、同期を削除して新しく作成します。screenRIG のサービスアカウント経由の Google Drive では、フォルダーが検証済みの共有者を失った場合（sharer_not_member）、プロジェクトメンバーの Google アカウントからもう一度共有してから、media sync update ID --resume を実行します。Dropbox が接続を認めなくなると（media sync account connect）、Dropbox の実行は reconnect_required で失敗します。

同期の名前、頻度、メディアフォルダーを変更するか、一時停止と再開を行います。

media sync update <id> [--name NAME] [--every DURATION] [--folder-id ID]
    [--pause | --resume] [--expect-rev REVISION]

screenrig media sync update msy_01EXAMPLESYNC000000000 --every 1h
screenrig media sync update msy_01EXAMPLESYNC000000000 --pause
screenrig media sync update msy_01EXAMPLESYNC000000000 --folder-id mfd_01EXAMPLEFOLDER000000000 --expect-rev 3

変更を少なくとも 1 つ指定してください。

次の予定時刻を待たず、同期を今すぐ実行します。

media sync run <id>

screenrig media sync run msy_01EXAMPLESYNC000000000

同期は約 30 秒以内に実行され、その後 media sync show に直近の実行が表示されます。一時停止中の同期は、先に再開する必要があります。

同期を停止します；メディアとフォルダーは残ります。

media sync delete <id> [--expect-rev REVISION]

screenrig media sync delete msy_01EXAMPLESYNC000000000

同期は、どのソースファイルがどのメディアになったかを忘れます。インポート済みのメディアとメディアフォルダーは残り、何も削除されません。

静的ディレクトリをアップロードせずに決定論的アーカイブにパックします。

app pack <directory> [--output FILE]

screenrig app pack ./lobby-board --output ./lobby-board.tgz

エンベロープはsha256、compressed_bytes、expanded_bytes、file_count、エントリーリスト、SDKランタイムが注入されたかを報告します。app uploadはディレクトリ自体をパックするため、アーカイブを先に調べたい場合にこのコマンドを使用してください。

アプリケーションはインラインコードをブロックするコンテンツセキュリティポリシーの下で実行されます。パッキングはインラインスタイルとスクリプトブロックを _screenrig/inline/ 以下のファイルに移動しリンクします。onclick= や javascript: のようなインラインイベントハンドラーや URL は移動できず、パッキングは拒否しファイル名と行を示します。

ディレクトリをパックし、新しいアプリケーションリリースとして公開し、公開の成功を待ちます。

app upload <directory> [--name NAME] [--no-wait] [--poll-ms MS] [--timeout MS]

screenrig app upload ./lobby-board --name "Lobby board"

3つのフィールドを読み取ります：data.operation.stateはsucceeded、data.application.release_idはrel_のIDでapplicationのプリミティブピン、data.application.idはapp_のIDでkvコマンドが使用します。成功した操作はリリースが使用可能であることを意味し、リリースID単独ではありません。

すべてのapp uploadは新しいアプリケーションと最初の不変リリースを作成します。同じアプリの後続リリースを公開するにはapp updateを使います。プレイリストは編集するまで既にピン留めされたリリースを提供し続けます。

既存アプリケーションの新リリースを公開し、ID、名前、アプリケーションK/Vを保持します。

app update <id> <directory> [--expect-rev REVISION] [--no-wait] [--poll-ms MS]

screenrig app update app_01EXAMPLEAPP00000000000 ./lobby-board

data.operation.state: "succeeded"を待ってから、playlist replace-releaseを使って正確なページ、プリミティブ、新しいリリース、および影響を受けるスクリーンを確認してください。返されたインパクトトークンと、playlist workflowで説明されているオプションのリビジョンガードを使って適用します。既存のplaylistピンは適用まで変更されません。リビジョンの競合があった場合は、再試行するかどうかを決める前にアプリを再度読み込み、競合を回避するためだけに置き換えアプリケーションを作成しないでください。

プロジェクトのアプリケーション一覧

app list

パラメーターなし。

screenrig app list

1件のアプリケーションを読み込みます。

app show <id>

screenrig app show app_01EXAMPLEAPP00000000000

latest_ready_release は初回公開が ready に到達するまで存在しません。公開状態はオペレーションとリリースに紐づき、アプリケーションにはありません。

アプリケーションとそのすべてのリリースを削除します。

app delete <id> [--expect-rev REVISION]

screenrig app delete app_01EXAMPLEAPP00000000000

リリースごとの削除はありません。スクリーンがアプリケーションのリリースを表示している間、削除はapplication_in_useで応答します：先にそれらのスクリーンに別のコンテンツを与えてください。削除はリリースをピン留めして表示しないプレイリストはチェックしないため、それらのプレイリストも更新または削除してください。

アプリケーションに保存されたキー一覧

kv list --app-id ID

screenrig kv list --app-id app_01EXAMPLEAPP00000000000

1件のキーを読み込みます。

kv get --app-id ID <key>

screenrig kv get --app-id app_01EXAMPLEAPP00000000000 menu

JSON、ファイル、またはbase64バイトから1つのキーを書く。

kv set --app-id ID <key> --json-value JSON [--expect-rev REVISION]
kv set --app-id ID <key> --file FILE [--content-type TYPE] [--expect-rev REVISION]
kv set --app-id ID <key> --value-base64 BASE64 [--content-type TYPE] [--expect-rev REVISION]

screenrig kv set --app-id app_01EXAMPLEAPP00000000000 menu --json-value '{"soup":"lentil"}'

キーを1つ削除します。

kv delete --app-id ID <key> [--expect-rev REVISION]

screenrig kv delete --app-id app_01EXAMPLEAPP00000000000 menu

1つのキーを書き込むWebhookを作成し、そのURLとシークレットを一度だけ受け取る。

kv webhook create <key> --app-id ID [--description TEXT]

screenrig kv webhook create menu --app-id app_01EXAMPLEAPP00000000000 --description "Point of sale menu feed"

エンベロープはWebhookです：data.id（kvw_…）、data.key、data.url（https://api.screenrig.ai/api/applications/<app_id>/kv-webhooks/<id>/write）、data.secret（srkw_…）。URLとシークレットを送信システムに今すぐ入力してください。このシークレットは以降のコマンドで表示されません。

アプリケーションの Webhook を古い順に一覧表示

kv webhook list --app-id ID

screenrig kv webhook list --app-id app_01EXAMPLEAPP00000000000

各項目には id、key、description、url、created_at があり、書き込み後は last_used_at もあります。リストに秘密情報は含まれません。

Webhookを削除します。URLは即座に無効になり、キーは値を保持します。

kv webhook delete <webhook_id> --app-id ID

screenrig kv webhook delete kvw_01EXAMPLEWEBHOOK00000 --app-id app_01EXAMPLEAPP00000000000

Webhookのシークレットを置き換え、一度だけ新しいものを受け取ります。

kv webhook rotate-secret <webhook_id> --app-id ID

screenrig kv webhook rotate-secret kvw_01EXAMPLEWEBHOOK00000 --app-id app_01EXAMPLEAPP00000000000

エンベロープは新しいシークレットをdata.secretに運びます。古いシークレットは即座に無効になるため、送信システムに新しいものを入力してください。

カードWebhookを変更します。説明、マッピング、有効状態、署名を変更できます。

kv webhook update <webhook_id> --card CARD_ID [--description TEXT] [--map FILE|-] [--clear-map]
                   [--enable|--disable] [--signing|--no-signing]

screenrig kv webhook update kvw_01EXAMPLEWEBHOOK00000 --card crd_01EXAMPLEBOARD0000000000 --map alert-map.json

エンベロープはWebhookそのものです。data.signing_secret は、署名を有効にしたレスポンスにのみ一度だけ現れます。

カードWebhookの配信ログを、過去7日分、新しい順に読み取ります。

kv webhook deliveries <webhook_id> --card CARD_ID [--limit N]

screenrig kv webhook deliveries kvw_01EXAMPLEWEBHOOK00000 --card crd_01EXAMPLEBOARD0000000000

各項目には at、outcome (written、unchanged、refused、invalid、handshake)、reason (たとえば credentials、signature、disabled、body、mapping、card_data_invalid、rate_limited)、detail、status、bytes、revision、request_id があります。本文、ヘッダー、認証情報は保存されず、誤ったアドレスへの送信は行を残しません。

ローカルメディアファイル、準備済みメディアID、アプリリリースID、またはHTTPまたはHTTPS URLから編集可能な全画面プレイリストを準備します。

playlist init <inputs...> --name NAME --output FILE [--overwrite] [--screen-id ID]
              [--target-width PX --target-height PX] [--duration-ms MS] [--fit contain|cover|fill]
              [--no-transcode] [--no-progress] [--poll-ms MS]

screenrig playlist init med_POSTER med_VIDEO --name "Lobby loop" --screen-id scr_LOBBY --output lobby.json

準備はローカルドキュメントを書き込み、メディアをアップロードすることがあります。リモートプレイリストの作成やスクリーンの割り当ては行いません。ドキュメントを検査した後、screen publishしてください。プレイリストの準備、公開、編集を参照。

作成または更新前にプレイリストドキュメントをローカルで検証します。ネットワーク不要。

playlist validate <file>

screenrig playlist validate ./lobby-loop.json

エラーは正確なJSONパスを示します。パスが通ればローカルの形状とフィールド間意味は有効ですが、認可、メディア準備、動的セレクター数、期間、リモート可用性はサーバーチェックが必要です。作成と更新は書き込み前にこのチェックを実行します。結果には、チェックを失敗させないジオメトリの lint 検出結果も含まれます：motion_overuse、collision、safe_margin、adjacent_repeat。ページの見え方を確認するには、公開して screen screenshot を実行します。

JSON ドキュメント、テンプレート、または組み込みの「緊急のお知らせ」テンプレートからプレイリストを作成します。

playlist create [file] [--from-template ID --name NAME [--set NAME=VALUE...] [--dry-run]] [--starter KEY [--name NAME]] [--format-region REGION --format-orientation ORIENTATION] [--note TEXT]

screenrig playlist create ./lobby-loop.json

screenrig playlist create --from-template pl_01EXAMPLETEMPLATE00000 --name "Monday notice" --set headline="Open late"

エンベロープの data.id は、screen assign が受け取る pl_ ID です。変更が確認待ちのときは data が {status: pending_review, review, playlist} となり、プレイリストは approved_revision: 0 で存在し、承認されるまでどの画面にも表示できません（playlist_not_approved）。テンプレートは fields を宣言したプレイリストで、画面には表示されません（playlist_is_template）。テンプレートから作成したプレイリストは通常のプレイリストとして割り当て、スケジュールし、改訂できます。

プレイリストドキュメントを置き換えます。

playlist update <id> <file> [--format-region REGION --format-orientation ORIENTATION] [--expect-rev REVISION] [--note TEXT]

screenrig playlist update pl_01EXAMPLEPLAYLIST000000 ./lobby-loop.json

変更がレビュー待ちの場合、ライブプレイリストは人が提案を承認するまで変更されずに再生され続けます。

1件のプレイリストとその現在のリビジョンを読み込みます。

playlist show <id>

screenrig playlist show pl_01EXAMPLEPLAYLIST000000

ライブバージョンを返します。approved_revisionはまだ誰も承認していないプレイリストの0であり、変更待ちの間はapprovalがオープンレビュー名を示し、reviews show IDは提案を返します。

プロジェクトのプレイリスト一覧

playlist list [--templates] [--library]

screenrig playlist list --templates
screenrig playlist list --library

テンプレートのフィールドまたはコピーの値を表示するか、値を変更してコピーを最新の状態にします。

playlist fields <id> [--set NAME=VALUE...] [--clear NAME...] [--refresh] [--expect-rev REVISION] [--note TEXT]

screenrig playlist fields pl_01EXAMPLECOPY00000000 --set headline="Closed today"

オプションなしでは、テンプレートのフィールドとそこから作成されたプレイリストの数、またはコピーの値、作成元のテンプレートのリビジョン、テンプレートに新しいリビジョンがあるかどうかを表示します。すべての変更、および --refresh だけでも、テンプレートの現在のリビジョンからコピーのページを作り直します。これがテンプレートへのブランド変更が既存のコピーに反映される方法で、自動では反映されません。値は作成時と同様に検証されます。Propose アクセスでは変更は確認依頼になります。

テンプレートから作成したプレイリストと、それぞれの作成元のテンプレートのリビジョンを一覧表示します。

playlist instances <id>

screenrig playlist instances pl_01EXAMPLETEMPLATE00000

outdated は、テンプレートの古いリビジョンから作成されたプレイリストを示します。playlist fields ID --refresh で最新の状態になります。

プレイリストのリビジョンを新しい順に一覧表示します。

playlist revisions <id> [--after CURSOR]

screenrig playlist revisions pl_01EXAMPLEPLAYLIST000000

各リビジョンには、それを作成したもの（created、edited、コピー元のリビジョン付きのpromoted、または履歴開始時にプレイリストが持っていたリビジョンであるbaseline）、作成者、日時、ページ数、現在のリビジョンかどうかが示されます。1ページに50件のリビジョンが含まれ、next_cursorで次のページを読み込みます。

1件のリビジョンと、その時点のプレイリストを読み込みます。

playlist revision show <id> --revision N

screenrig playlist revision show pl_01EXAMPLEPLAYLIST000000 --revision 3

以前のリビジョンを新しいリビジョンとしてコピーし、再び現在のものにします。

playlist promote <id> --revision N --expect-rev CURRENT

screenrig playlist promote pl_01EXAMPLEPLAYLIST000000 --revision 3 --expect-rev 9

そのリビジョンのページ、サウンドトラック、形式が次のリビジョンになります。名前はそのまま、以前のリビジョンも一覧に残り、プレイリストを表示しているすべての画面が更新されます。昇格にはライブで公開できる認証情報が必要です。変更がレビュー待ちになる認証情報にはforbiddenが返ります。内容がすでに現在のものと同じリビジョンでは何も変わりません。

プレイリストを1つ削除します。

playlist delete <id> [--expect-rev REVISION]

screenrig playlist delete pl_01EXAMPLEPLAYLIST000000

画像と動画のファイル、サウンドトラックの音声、iframe URL をポータブルなプレイリストバンドルとしてエクスポートします。

playlist export <id> --output DIRECTORY [--skip-applications]

screenrig playlist export pl_01EXAMPLEPLAYLIST000000 --output ./lobby-bundle

バンドルには、マニフェスト、プレイリストドキュメント、内容に基づいてアドレス指定された画像、動画、サウンドトラック音声のファイルが含まれます。動的セレクター all、tag、folder は正確な ID に固定され、iframe URL は保持され、コメントは除外されます。

カード、ストリーム、adslot ページがあると、メディアのダウンロード前にエクスポートが停止します。アプリケーションも既定ではエクスポートを停止させます。--skip-applications はアプリケーションプリミティブと、空のページまたはアプリケーションが制御するページを削除し、スキップしたプリミティブとページの ID を報告します。少なくとも 1 ページを残す必要があります。このフラグを指定しても、カード、ストリーム、adslot ページがあるとエクスポートは停止します。

カードとアプリケーションへの参照を保持した編集可能なドキュメントには、screenrig playlist show pl_01EXAMPLEPLAYLIST000000 --output playlist.json を使います。ドキュメントは同じプロジェクトの既存リソースを使います。

バンドルディレクトリからプレイリストを作成、または既存のものを更新。

playlist import <directory> [--name NAME] [--update ID [--expect-rev REVISION] [--note TEXT]]

screenrig playlist import ./lobby-bundle
screenrig playlist import ./lobby-bundle --name "Lobby loop (copy)"

プレイリストの表示名は繰り返される場合があります。インポートは名前が一致しても別のプレイリストを作成します。既存のプレイリストを置き換えるには ID を指定して --update を使用してください。

インポートはプロジェクトに触れる前にバンドル全体をローカルで検証します：マニフェスト、ドキュメント、パス、メディア種別、長さ、ハッシュ。既存のメディアは正確なファイル名、メディアタイプ、バイト長、ハッシュ、タグが一致した場合に再利用され、残りは変換なしでアップロードされ、すべてのオブジェクトが準備済みになった後にプレイリストが書き込まれます。

インポートはリモートメディアを削除または剪定しません。アップロード開始後に後続のステップが失敗した場合、エラーは準備済みと確認されたオブジェクトをリストし、プレイリスト書き込みが開始されたかどうかを示します。同じバンドルを再試行すると、それらのオブジェクトが再利用されます。

画面に表示されたコードでPlayerをペアリングします。

screenrig screen pair "$PAIRING_CODE" --name "Lobby"

スクリーン一覧。アーカイブ済みは指定がなければ除外

screen list [--state archived] [--tag TAG] [--folder ID|root]

screenrig screen list --tag Lobby
screenrig screen list --folder sfd_01EXAMPLEFOLDER000000000

各行にはスクリーンのtagsが含まれます。--humanがある場合、一覧内のいずれかのスクリーンにタグが付いていれば、表にTAGS列が追加されます。

1件のスクリーン（リビジョン、割り当て、稼働状況を含む）を読み込みます。

screen show <id>

screenrig screen show scr_01EXAMPLESCREEN00000000

tags はスクリーンのフリートタグを一覧表示します。effective_playlist, takeover, playlist_schedule はスクリーンが何を再生しているかとその理由を報告します。詳細は スケジュールとテイクオーバー を参照してください。health とプレーヤーのホスト機能は デバイスのヘルスと電源 にあります。online はプレーヤーが接続中（短時間の再接続ウィンドウも含む）の間 true です。オプションの last_online_at と last_ip は初回接続後に表示されます。オプションの observation はプレーヤーが描画したサーフェスを報告します：id, width, height, pixel_ratio, presentation。これらはすべて読み取り専用です。screen update は送信できず、アーカイブされたスクリーンも行を返します。

commands は、スクリーンの直近10件の再起動、再読み込み、キャッシュのクリア、アプリの再起動、更新を古い順に一覧します。各項目には、type、state（queued、sent、done、failed、expired、cancelled、superseded）、source（再起動スケジュールが発行した再起動には schedule、人が依頼したものでは存在しません）、expires_at、送信または完了した時刻が含まれます。reboot_schedule と next_reboot_at は、スクリーンの再起動スケジュールと次の再起動ウィンドウの開始を報告します。Player が終了させたキャッシュのクリア、アプリの再起動、更新には、cause と短い detail も含まれ、--human はこれを CAUSE 列と表の下の行として表示します。suspension には、一時停止中のスクリーンの message と since が含まれます。screen replace でアーカイブされたスクリーンは、デバイスの移動先のスクリーンである replaced_by を報告します。--human を付けると、screen show がそれぞれを表示します。

last_outage は、画面の直近の停止を報告します：offline_since、back_at、duration_s。ヘルスレポートで判定されると、device_restart、app_crash、app_restart、network、platform のいずれかを値とする likely_cause も含まれます。screenRIG が判断できない場合は含まれません。再起動は画面の復帰時に判定されますが、ネットワークまたは screenRIG が原因の場合は Player の次のヘルスレポートを待つため、最大 15 分かかることがあります。glass には、画面の再生レポートとスクリーンショットから screenRIG が導いた判定が入ります。--human を付けると、screen show は Last outage と Likely cause を表示し、問題が見つかった判定では Playlist stalled、Blank screen、または Frozen picture を表示します。判定が対象外とするものについては 通知 を参照してください。

スクリーンの名前、プレイリスト割り当て、タイムゾーンを一度の呼び出しでパッチします。

screen update <id> [--name NAME] [--playlist-id ID] [--timezone ZONE] [--expect-rev REVISION]

screenrig screen update scr_01EXAMPLESCREEN00000000 --name "Lobby"

レビュー中は--playlist-idの変更のみがscreen assignのように提案されます。Proposeセッションは他のフィールドを変更できません。

準備済みファイルから新しいプレイリストを作成し、スクリーンに割り当てる。

screen publish <id> <file> [--expect-rev REVISION] [--note TEXT]

screenrig screen publish scr_LOBBY lobby.json

これは新しいプレイリストを作成して割り当てます。既存のプレイリストを名前で更新しません。準備したドキュメントを先に検査してください。同じ入力を繰り返すと、曖昧な失敗から再開できます。割り当ての読み戻しは再生を証明しません。スクリーンショットを別途リクエストしてください。レビュー中は両方のレビューと共にstage: pending_reviewを返します。詳細はプレイリストの準備、公開、編集を参照してください。

スクリーンまたはスクリーン群をプレイリストに向けます。

screen assign (<id>... | --tag TAG) --playlist-id ID [--expect-rev REVISION] [--note TEXT]

screenrig screen assign scr_01EXAMPLESCREEN00000000 --playlist-id pl_01EXAMPLEPLAYLIST000000
screenrig screen assign --tag Lobby --playlist-id pl_01EXAMPLEPLAYLIST000000

プレイリストが任意のページをスケジュールし、スクリーンにタイムゾーンがない場合、CLIは何も送信せず拒否し、実行すべきscreen set-timezoneコマンドを示します。この拒否でリビジョンは消費されません。フリートでは各スクリーンが独自にこのルールを適用し、タイムゾーンなしのスクリーンは結果で失敗し、他は割り当てられます。

フリートに公開するには、まずplaylist createでプレイリストを作成し、次にscreen assign --tag TAG --playlist-id IDを実行します。screen publishは1つのスクリーンを対象とします。

スケジュールされたプレイリストが読み込まれる標準時刻帯を設定

screen set-timezone <id> --timezone ZONE [--expect-rev REVISION]

screenrig screen set-timezone scr_01EXAMPLESCREEN00000000 --timezone America/Los_Angeles

ページスケジュールは標準時刻なので、ゾーンなしでは意味がありません。ゾーンを変更するとマニフェストリビジョンが再発行されます。

スクリーンを非表示にし、ガラスを暗くします。

screen archive <id> [--expect-rev REVISION]

screenrig screen archive scr_01EXAMPLESCREEN00000000

アーカイブすると、スクリーンがデフォルトの一覧から非表示になり、画面が暗くなります。Player のバインドは解除されません。

アーカイブ済みスクリーンをデフォルトリストに復元します。

screen unarchive <id> [--expect-rev REVISION]

screenrig screen unarchive scr_01EXAMPLESCREEN00000000

Player は自身のスクリーンもアーカイブできます。キーを持つ Player ではリセットの確認、Cookie でペアリングされたブラウザー Player ではペアリング解除です。screen show は archive_reason を device_reset または device_unpair（リクエストしたアーカイブの場合は project）として archived_at で報告します。スクリーンはあらゆる理由でデバイスの紐付けを保持するため、そのキーやデバイス Cookie を持つ Player は暗転し、アーカイブ解除時に再ペアリングなしで復帰します。リセットまたはペアリング解除された Player はキーや Cookie を破棄し、新しいスクリーンとして再ペアリングします。確認済みのスクリーン復元で置き換えられたキーは無効のままです。

screen replace によって replaced としてアーカイブされたスクリーンはデバイスの紐付けを保持しないため、アーカイブ解除は受け付けられず、screen delete で削除できます。

スクリーンのコンテンツの代わりに通知を表示し、再開されるまで続けます。

screen suspend <id> --message TEXT [--expect-rev REVISION]

screenrig screen suspend scr_01EXAMPLESCREEN00000000 --message "Closed for stocktake. Back at 9am."

一時停止中のスクリーンは、コンテンツの代わりにメッセージを表示します。それ以外は変わりません：プレイリスト、スケジュール、テイクオーバー、ディスプレイ制御はそのまま残り、通常どおり変化し続けます。screen resume は、そのスクリーンが現在表示するはずの内容を表示します。screen show は suspension を message と since とともに報告します。一時停止中のスクリーンをさらに一時停止すると、メッセージが置き換わり、since は維持されます。一時停止するとスクリーンのリビジョンが更新され、Player はすぐに再取得します。アーカイブ済みのスクリーンは screen_archived を返します。

スクリーンの一時停止を終了し、スクリーン自身のコンテンツを再び表示します。

screen resume <id> [--expect-rev REVISION]

screenrig screen resume scr_01EXAMPLESCREEN00000000

再開すると、スクリーンは自身のコンテンツを再び表示します。その内容は、スクリーンが現在表示するはずのものから決まり、Player はすぐに再取得します。一時停止中でないスクリーンは変更なしで応答し、リビジョンも変わりません。アーカイブ済みのスクリーンは screen_archived を返します。

スクリーンを削除します。

screen delete <id> [--expect-rev REVISION]

screenrig screen delete scr_01EXAMPLESCREEN00000000

スクリーンを削除できるのは、Player のキーが紐づいていない間だけで、そのスクリーンでは screen show が deletable: true を報告します。コードでペアリングする Player は、ネイティブでもブラウザー版でもキーを保持し、そのキーはスクリーンに紐づいたままです。そのスクリーンを削除すると 409 screen_archive_required（終了コード 5）が返るので、代わりにアーカイブしてください。キーを持たないのは Cookie でペアリングされたブラウザー Player だけで、そのスクリーンはペアリング済みでも保留中でも削除できます。

別のスクリーンとしてペアリングされているデバイスをこのスクリーンに移し、このスクリーンの設定と履歴を保持します。

screen replace <id> --with ID [--expect-rev REVISION]

screenrig screen replace scr_01EXAMPLESCREEN00000000 --with scr_01EXAMPLENEWSCREEN000000

最初に新しいハードウェアを独自のスクリーンとしてペアリングし、そのあと置き換えを実行します。デバイスのキー（ブラウザー Player の場合はその認証情報）が <id> を開くようになります。そのスクリーンは名前、タグ、タイムゾーン、プレイリスト、スケジュール、テイクオーバー、ディスプレイスケジュールとオーバーライド、ビデオウォール、コメント、フィールド、場所、履歴を保持し、置き換え側のホストと Player を引き継ぎます。ヘルス、ステータス、ストレージ、キューに入っているコマンドはリセットされます。--with で指定したスクリーンは、archive_reason replaced と、<id> を示す replaced_by を付けてアーカイブされます。デバイスの紐付けは保持されないため、screen unarchive では復元できず、screen delete で削除できます。<id> が保持していたキーは、15分の猶予期間が過ぎると無効になり、その後、古いデバイスは拒否されます。どちらのスクリーンも、ペアリング済みの Player を持つアクティブな状態でなければなりません：ペアリング待ちのスクリーンには resource_conflict が、アーカイブ済みのスクリーンには screen_archived が返り、ビデオウォールには display.wall（wall_unsupported）を宣言する置き換え側の Player が必要です。リクエストには常に冪等キーが付き、正確な再試行は元の回答を返します。

スクリーンの新しい公開IDを発行します。

screen rotate-public-id <id> [--expect-rev REVISION]

screenrig screen rotate-public-id scr_01EXAMPLESCREEN00000000

スクリーンのリンクを作成または置き換え、その Player URL を表示する。

screen link create <id> [--expect-rev REVISION]

screenrig screen link create scr_01EXAMPLESCREEN00000000

data.url、つまり vMix や OBS のブラウザーソースの URL として貼り付ける Player URL（https://play.screenrig.ai/player/#screen=…）を表示します。ブラウザーソースはストレージを保持せず、そのままでは読み込みのたびにペアリングを失います。Player は読み込みのたびにこの URL から動作し、URL がペアリングのすべてです。リンクをもう一度作成すると置き換えられ（data.replaced は true）、古い URL は直ちに動作しなくなり、そこから開いた Player はコンテンツのない通知を表示します。URL はスクリーンを開く認証情報なので、機密ラベルの下に表示され、操作ログには残らず、screen link show で再表示できます。1か所だけで開いてください。ペアリングされていないスクリーンは resource_conflict（終了コード 5）、アーカイブ済みのスクリーンは screen_archived を返します。リクエストが中断された後は、同じコマンドをもう一度実行してください。保存された冪等キーを再利用し、同じリンクが返ります。

スクリーンのリンクとその Player URL を表示する。

screen link show <id>

screenrig screen link show scr_01EXAMPLESCREEN00000000

data.url を機密ラベルの下に表示し、data.hint（シークレットの末尾4文字）と、Player がリンクを開いた後は data.created_at と data.last_used_at も表示します。読み取り専用の認証情報では url は空で url_redacted が true になり、人間向け出力は URL が伏せられていると表示します。Manage のサインインでは受け取れます。リンクのないスクリーンは screen_link_not_found（終了コード 4）を返し、リンクを作成するコマンドを示します。screen show はリンクのあるスクリーンでは Screen link: on (…HINT) を表示し、URL は決して表示しません。

スクリーンのリンクをオフにする。

screen link delete <id> [--expect-rev REVISION]

screenrig screen link delete scr_01EXAMPLESCREEN00000000

URL は直ちに動作しなくなり、それが開いたセッションはすべて終了します。まだそれを表示しているブラウザーソースは、新しい URL が与えられるまで通知だけを表示し、コンテンツは表示しません。スクリーン、そのペアリング、コンテンツには影響しません。スクリーンにリンクがない場合は、何も変更せずに成功します。

スクリーンの Player またはフリート内のすべての Player に一度だけリロードを依頼

screen reload (<id>... | --tag TAG) [--expires-in DURATION] [--expect-rev REVISION]

screenrig screen reload scr_01EXAMPLESCREEN00000000
screenrig screen reload scr_01EXAMPLESCREEN00000000 --expires-in 2h
screenrig screen reload --tag Lobby

回答は reload_id、state、expires_at を含みます。オンラインのスクリーンには再読み込みがすぐに送信されます（state sent）。オフラインのスクリーンの場合、再読み込みは queued の状態で保持され、expires_at（--expires-in で別に指定しない限り、リクエストの24時間後）より前にオンラインに復帰した時点で送信されます。新しい再読み込みは、キューに残っている再読み込みを置き換えます。screen show はスクリーンの commands を一覧表示し、screen command cancel でキューに残っている再読み込みをキャンセルできます。フリートでは、各結果の reload に同じ state が含まれます。Web Player は次のページ境界で再読み込みし、ネイティブ Player は再接続し、マニフェストを再取得し、更新を確認します。Player は、最後に処理した再読み込みから10分以内の再読み込みを無視します。再読み込みはアクティブなスクリーンでもアーカイブ済みのスクリーンでも動作し、スクリーンのリビジョンは変更しません。

ライブスクリーンまたはスクリーン群に一時的なステージクロームメッセージを投稿します。

screen toast (<id>... | --tag TAG) --text TEXT [--level info] [--duration-ms MS]

screenrig screen toast scr_01EXAMPLESCREEN00000000 --text "Lobby closed"
screenrig screen toast --tag Lobby --text "Closing in ten minutes"

トーストはプリミティブではありません：キャンバススロットを占有せず、レイヤーもなく、準備やクロスフェードに関与しません。最新が勝ち、キューもキャンセルもありません。受け入れられるエンベロープは { expires_at } のみです。テキストに認証情報や秘密情報を絶対に入れないでください。

スクリーンの名前をコンテンツの上にしばらく表示し、現場でスクリーンを見つけやすくします。

screen identify <id> [--duration DURATION]

screenrig screen identify scr_01EXAMPLESCREEN00000000
screenrig screen identify scr_01EXAMPLESCREEN00000000 --duration 2m

Player はコンテンツの上に全画面のオーバーレイを描画し、スクリーンの名前を非常に大きく、その下に ID を小さく表示します。再生はその下で続き、より新しい識別リクエストがオーバーレイを置き換えます。受け入れられたエンベロープは identify_id、duration_ms、リクエストの60秒後を示す expires_at を含むため、オフラインのスクリーンが後からオーバーレイを表示することはありません。identify 機能を宣言した Player だけがオーバーレイを表示します：それ以外のスクリーンには 409 identify_unsupported（終了コード 5）が返り、何も送信されないため、Player を更新するか、screen toast で名前を表示してください。アーカイブ済みのスクリーンには screen_archived が、ペアリング待ちのスクリーンには resource_conflict が返ります。識別はスクリーンのリビジョンを変更しません。

アクティブなスクリーンの静止画を 1 枚、またはフリート内のすべてのスクリーンの静止画を撮影し、ディスクに書き込みます。

screen screenshot <id> [--output FILE] [--timeout MS] [--poll-ms MS]
screen screenshot (<id> <id>... | --tag TAG) [--output DIRECTORY] [--concurrency N] [--timeout MS] [--poll-ms MS]

screenrig screen screenshot scr_01EXAMPLESCREEN00000000 --output ./lobby.webp

screenrig screen screenshot --tag Lobby --output ./lobby-shots

コマンドはWebPがディスクにあるまでブロックします。--no-wait はありません。エンベロープは screen_id、capture_id、path、bytes、sha256、width、height を報告し、画像バイトは含みません。最新が優先され、後のリクエストが進行中のキャプチャを置き換えます。 Playerウェブのスクリーンショットでは、各 iframe ページは「Embedded web page」というラベルの付いた濃いグレーのタイルとして描かれ、各アプリケーションは自身の描画どおりに表示されます。画像にはタイルの目印がないため、iframe ページが描画されたことの証明にはなりません。

複数の id または--tagの場合、回答はフリート結果となり、action: "screenshot"、selector、outputディレクトリが含まれます。各ok結果にはpath、bytes、sha256、width、heightが含まれます。--tagを指定した場合、CLI はまずタグ付きスクリーンをリストし、すべてのリストページを順に処理します。各リストページは課金対象ですが、キャプチャ自体は無料です。複数 id の場合リストは不要です。--idempotency-keyはこの形式では拒否されます。各キャプチャが独自のキーを使用するためです。キャプチャが予期せず失敗した場合、そのスクリーンの結果はunexpected_errorとなり、新しいキャプチャは開始されず、待機中のスクリーンはnot_attemptedを報告し、終了コードは 1 です。

スクリーンまたはフリートのタグを設定、追加、削除、またはクリアします。

screen tag (<id>... | --tag TAG) (--set TAGS | --add TAGS | --remove TAGS | --clear) [--expect-rev REVISION]

screenrig screen tag scr_01EXAMPLESCREEN00000000 --set Lobby,Floor2
screenrig screen tag scr_01EXAMPLESCREEN00000000 --add Spring
screenrig screen tag --tag Lobby --add Spring

タグは1～32文字の英数字で、スクリーンは最大16個のユニークタグを持ちます。タグはフリートを選択し、認証には使わずプレーヤーには届きません。タグ変更はスクリーンのリビジョンを更新し、マニフェストのリビジョンは変わりません。単一スクリーンではエンベロープは更新されたスクリーンです。--add と --remove はスクリーンを先に読み込み、--expect-rev または読み込んだリビジョンで新セットを書き込み、同時変更は revision_conflict（終了コード6）を返し上書きされません。コマンドを再実行してください。フリートでは --add と --remove が各スクリーンのセットに原子操作で適用され、16タグを超えるスクリーンは自身の結果で invalid_request となります。

タグが変更されるあらゆる場面（screen tag、API によるスクリーンの更新、ダッシュボードのタグエディター）で、応答のlevelsは、gainedとlostの下に、スクリーンがタグ対象に加わった、または外れたキャンペーンを列挙し、それぞれにsource（campaign）、id、screensの数、キャンペーンに到達数がある場合はreach_beforeとreach_afterを持ちます。フリートのscreen tagは、フリート全体でそれらを合計します。タグの編集を無害と判断する前にlevels.lostを読んでください。キャンペーンのスクリーンから最後の一致するタグを外すとそのグループが空になり、reach_droppedとgroup_emptyの通知が発生します。

スクリーンのプレイリストスケジュールと現在選択中のプレイリストを表示。

screen schedule show <id>

screenrig screen schedule show scr_CAFE

JSON 出力は直接 screen schedule set --file に戻せます。

スクリーンまたはフリートのプレイリストスケジュールを置き換えます。

screen schedule set (<id>... | --tag TAG) --file FILE [--expect-rev REVISION] [--note TEXT]

screenrig screen schedule set scr_CAFE --file dayparts.json
screenrig screen schedule set --tag Cafe --file dayparts.json

スケジュールが指定するすべてのプレイリストは割り当てとして検証され、スクリーンにはタイムゾーンと割り当てられたデフォルトプレイリストが必要です。条件を満たすエントリがない場合は、割り当てられたプレイリストが再生されます。後でスケジュールされたプレイリストが表示できなくなった場合、そのエントリはスキップされscreen.playlist_unavailableが記録されます。

スクリーンまたはフリートからプレイリストスケジュールを削除

screen schedule clear (<id>... | --tag TAG) [--expect-rev REVISION] [--note TEXT]

screenrig screen schedule clear --tag Cafe

スクリーンのプレイリストスケジュールを置き換えた場合に何が変わるかを、実行せずに表示します。

screen schedule preview <id> --file FILE [--calendar-from INSTANT] [--calendar-to INSTANT]

screenrig screen schedule preview scr_LOBBY --file dayparts.json
screenrig screen schedule preview scr_LOBBY --file dayparts.json --calendar-from 2026-12-01T00:00:00Z --calendar-to 2027-01-01T00:00:00Z

何も書き込まれません。エントリはscreen schedule setと同じ方法で検査されるため、プレビューはsetが拒否するものを拒否します。data.gainedとdata.lostは、スクリーンがスケジュールのレベルを得るか失うかを示します。"paused": trueを持つエントリはどのスクリーンにも表示されないため、公開するとそのエントリが加わります。data.calendar.beforeとdata.calendar.afterは、--calendar-fromから--calendar-toまでの、現在のスクリーンのカレンダーと変更後のカレンダーです。

スクリーンのプレイリストスケジュールのリビジョンを新しい順に一覧表示します。

screen schedule revisions <id> [--after CURSOR]

screenrig screen schedule revisions scr_LOBBY
screenrig screen schedule revisions scr_LOBBY --after CURSOR

data.itemsには最大50件のリビジョンが含まれ、それぞれにrevision（書き込み時のスクリーンのリビジョン。スクリーンが別の変更を受けた箇所では番号が飛びます）、created_at、change、current、判明している場合はauthor、そしてentries（その書き込み後のスケジュール全体。noneはスクリーンにスケジュールがなかったことを示します）が付きます。changeはedited（setまたはclear、スケジュールのインポート）、restored（restored_fromが示す以前のリビジョンのコピー）、またはbaselineです。data.next_cursorが文字列である間は古いリビジョンが残っています。--afterにその値を指定してコマンドをもう一度実行してください。リビジョンはスクリーンの完全削除とともに消えます。読み取り専用アクセスで足ります。

以前のリビジョンのスケジュールを前方にコピーして、スクリーンに戻します。

screen schedule restore <id> --revision N [--expect-rev REVISION] [--note TEXT]

screenrig screen schedule restore scr_LOBBY --revision 4
screenrig screen schedule restore scr_LOBBY --revision 4 --expect-rev 9

リビジョンNのエントリがスクリーンのスケジュールになります。これは、それらのエントリで行うscreen schedule set（そのリビジョンにエントリがなければscreen schedule clear）と同じ書き込みで、現在の基準で検査されます。その後に削除されたプレイリストがあれば拒否されます。Proposeアクセスの場合や、エージェントの変更にレビューを必須とするプロジェクトでは、setと同様に復元は人の承認を待ち、承認されるまでスクリーンは何も変わりません。以前のリビジョンはそのまま残ります。

キャンペーン、スケジュール、割り当てより前に、スクリーンまたはフリートで1つのプレイリストを表示します。

screen takeover [set] (<id>... | --tag TAG) --playlist-id ID [--until TIME | --for DURATION] [--reason TEXT] [--expect-rev REVISION] [--note TEXT]

screenrig screen takeover scr_LOBBY --playlist-id pl_DRILL --for 30m --reason "Fire drill"
screenrig screen takeover --tag Lobby --playlist-id pl_LAUNCH --for 2h
screenrig screen takeover scr_A scr_B --playlist-id pl_NOTICE --until none

screen takeover ID は screen takeover set ID の略です。新しいテイクオーバーは前のものを置き換えます。終了すると、スクリーンは自動的に、条件を満たすキャンペーン、スケジュール、または割り当てられたプレイリストに戻ります。プレイリストを表示できないテイクオーバーは終了します。--for はあいまいな失敗後に再実行されると、新しい終了時刻を計算し、新しいリクエストとして送信されます。

スクリーンまたはフリートのテイクオーバーを終了する。

screen takeover clear (<id>... | --tag TAG) [--expect-rev REVISION] [--note TEXT]

screenrig screen takeover clear --tag Lobby

スクリーンが読み取る順に、プロジェクトのキャンペーンを一覧表示します。

campaign list

パラメーターなし。

screenrig campaign list

data.itemsには最大100件のキャンペーンが含まれ、優先度の高い順、同じ優先度の中では新しい順に並びます。一時停止中のキャンペーンは一覧に表示され、どこにも適用されません。

1件のキャンペーンを読み込みます。

campaign show <id>

screenrig campaign show cmp_LUNCH

name、playlist_id、audience（正確なルール）、priority、paused、設定されているfrom、until、windows、monthly、dates、except、interaction、displays、start、およびrevision（以降の書き込みで--expect-revに使う値）を返します。reachはオーディエンスに一致するスクリーンの数を示します。publishedはキャンペーンが最後に公開されたとき（作成時、または新しいオーディエンス、プレイリスト、一時停止状態で更新したとき）の数、currentとatは最新の数、empty_groupsはどのスクリーンにも一致しないオーディエンスのtag:NAMEとfolder:IDのリーフです。数を変えるタグ、フォルダー、アーカイブ、削除は約15秒以内に再集計されます。campaign listにもreachが含まれ、reach_droppedとgroup_emptyの通知がこれを監視します。ads campaigns listのIDは、ここではnot_found（終了コード4）を返します。

対象のスクリーンを、常時、またはルールの条件を満たす間、プレイリストに切り替えます。

campaign create --name NAME --playlist-id ID (--tag TAG | --any-tag TAG | --screen-id ID | --folder ID | --all-screens | --audience RULE) [--from TIME] [--until TIME] [--window SPEC] [--monthly SPEC] [--date SPEC] [--except DATES] [--on-touch [IDLE_S]] [--displays N[,N]] [--start on-time|next-item] [--covers WHERE] [--priority N] [--paused]

screenrig campaign create --name "Lunch menu" --playlist-id pl_LUNCH --tag north --window mon-fri@11:00-14:00
screenrig campaign create --name "North Tower welcome" --playlist-id pl_WELCOME --folder sfd_01EXAMPLEFOLDER000000000
screenrig campaign create --name "Holiday hours" --playlist-id pl_HOLIDAY --tag Lobby --from 2026-12-20T00:00 --until 2027-01-02T00:00 --priority 10
screenrig campaign create --name "North cafes" --playlist-id pl_CAFE --audience '{"all":[{"tag":"North"},{"any":[{"tag":"Cafe"},{"tag":"Patio"}]}]}' --paused
screenrig campaign create --name "Brunch" --playlist-id pl_BRUNCH --tag Cafe --monthly 1st-sun@10:00-14:00 --except 2026-12-06
screenrig campaign create --name "Touch to browse" --playlist-id pl_MENU --screen-id scr_KIOSK --on-touch 90
screenrig campaign create --name "Holiday opening" --playlist-id pl_HOLIDAY --tag Lobby --date 2026-12-24@18:00-22:00 --start on-time
screenrig campaign create --name "Wall outputs 1 and 2" --playlist-id pl_WALL --screen-id scr_WALL --displays 1,2

タグは1～32文字の英数字です。DAYSはdaily、曜日（mon）、範囲（mon-fri。fri-monは週の終わりをまたぎます）、またはカンマ区切りのリスト（sat,sun）です。時刻を指定しないウィンドウは1日全体で、終了が開始以前の場合は日跨ぎとなり、開始日に属します。--audienceルールの各メンバーはall、any、tag、screen_id、folderのうちちょうど1つを持ち、グループのネストは最大3階層、対象のルールは最大500件で、{"all":[]}はすべてのスクリーンです。

中断またはあいまいな作成後は24時間以内に同じコマンドを再実行してください。保存された冪等キーを再利用し、サーバーは別のキャンペーンを作成せず同じキャンペーンを返します。

キャンペーンを変更します。変更前と変更後の対象のスクリーンは、1分以内に再評価されます。

campaign update <id> [--name NAME] [--playlist-id ID] [audience option] [--from TIME | --clear-from] [--until TIME | --clear-until] [--window SPEC | --clear-windows] [--monthly SPEC | --clear-monthly] [--date SPEC | --clear-dates] [--except DATES | --clear-except] [--on-touch [IDLE_S] | --clear-on-touch] [--displays N[,N] | --clear-displays] [--start WHEN] [--covers WHERE] [--priority N] [--expect-rev REVISION]

screenrig campaign update cmp_LUNCH --playlist-id pl_LUNCH2 --expect-rev 2
screenrig campaign update cmp_LUNCH --tag Lobby --window sat,sun --priority 20
screenrig campaign update cmp_LUNCH --clear-until --clear-windows
screenrig campaign update cmp_BRUNCH --monthly 2nd-sun@10:00-14:00 --except 2026-12-13,2027-01-10
screenrig campaign update cmp_BROWSE --clear-on-touch --clear-displays

変更を少なくとも1つ指定してください。指定したフィールドのみが変更されます。新しい--playlist-idは作成と同様にチェックされます。中断またはあいまいなリクエストの後は、同じコマンドを再実行してください。保存された冪等キーを再利用し、サーバーは更新を再適用せず、すでに行われた更新を返します。

キャンペーンを削除せずに、すべてのスクリーンで停止します。

campaign pause <id> [--expect-rev REVISION]

screenrig campaign pause cmp_LUNCH

キャンペーンを表示していたスクリーンは、1分以内にキャンペーンがない場合の表示に戻ります。campaign resumeで再開します。

一時停止中のキャンペーンを再開します。

campaign resume <id> [--expect-rev REVISION]

screenrig campaign resume cmp_LUNCH

対象のスクリーンのうち、キャンペーンを適用できるすべてのスクリーンは、キャンペーンの条件を満たしている間、1分以内にそのプレイリストに切り替わります。

キャンペーンを削除します。

campaign delete <id> [--expect-rev REVISION]

screenrig campaign delete cmp_LUNCH

キャンペーンは元に戻りません。キャンペーンを表示しているすべてのスクリーンは、1分以内にキャンペーンがない場合の表示に戻ります。プレイリスト、スクリーン、タグは残ります。campaign pauseはキャンペーンを停止し、そのまま残します。

キャンペーンが届くスクリーンと、それぞれの状態を表示します。

campaign screens <id> [--limit N] [--cursor CURSOR]