ReelaDocs

コマンドリファレンス

Reela の各コマンドの構文、引数、オプション。インストール済みバージョンのヘルプを表示するには、reela <command> -h を実行してください。

Reela の各コマンドの構文、引数、オプション。インストール済みバージョンのヘルプを表示するには、reela <command> -h を実行してください。

login / logout / whoami / status

reela login
reela logout
reela whoami
reela status
  • login はブラウザー認証でサインインします。表示された URL を開き、求められた場合はコードを入力して、コマンドが完了するまで待ちます。
  • logout は選択中のプロファイルからサインアウトします。
  • whoami はサインイン中のアカウントを表示します。
  • status はアカウントと配信状況を確認します。
reela --profile work login
reela --profile work whoami

create

プロンプトと任意のメディアファイルから動画を作成します。

reela create [PROMPT] --visual <TYPE> [OPTIONS]

位置引数のプロンプトまたは --prompt-file を指定します。少なくとも 1 つの --visual が必要です。

オプション説明
--prompt-file <PATH>位置引数のプロンプトの代わりに、ファイルからプロンプトを読み込みます。
--visual <TYPE>ビジュアルタイプ。複数のタイプを指定するには繰り返し指定します。以下を参照してください。
--duration <SECONDS>動画の長さ。デフォルト: 30。
--layout <LAYOUT>landscape(デフォルト)、portrait、または square。
--tier <TIER>reela tiers list の画質と料金のオプション。
--avatar <ID>含めるアバター。複数のアバターを指定するには繰り返し指定します。
--file <ROLE:PATH>役割を指定してローカルファイルを添付します。複数のファイルを指定するには繰り返し指定します。
--session <TITLE>関連する動画を、説明的なプロジェクトタイトルの下にまとめます。
--music-video楽曲とミュージックビデオを生成します。BGM ファイルと組み合わせないでください。
--dry-runファイルのアップロードやタスクの作成を行わずに、検証してクレジット数を見積もります。

ビジュアルタイプとファイルの役割

  • ai-video: ショットを生成します。スタイル用に任意で reference-image:<path> を添付できます。
  • avatar: --avatar <id> で選択したプレゼンターを含めます。
  • original-clip: 音声を除いた映像素材を編集します。video-source:<path> を添付します。
  • original-sync: 映像素材の音声を保持します。video-audio:<path> を添付します。
  • image-video: 画像をアニメーション化します。original-image:<path> を添付します。

自分の音楽を使うには background-music:<path> を使用します。値をカンマで連結せず、フラグを繰り返し指定してください。

使用例

reela create "A product demo" --visual ai-video --layout portrait --dry-run
reela create --prompt-file brief.txt --visual image-video --file original-image:photo.png --dry-run

まず推定クレジット数を確認してください。送信するには、--dry-run を削除する前にデーモンを起動し、配信サブスクリプションを設定してください。送信するとクレジットが消費される場合があります。Reela はバックグラウンドで動画を生成し、完成した結果をサブスクリプション経由で配信します。以下の daemon / subscribe のセクションを参照してください。

tasks

タスクを一覧表示し、個々のタスクの詳細や出力バージョンを確認します。時間のかかる動画生成では、デーモンの完了通知サブスクリプションを利用すると、完成した結果を自動的に受け取れます。

reela tasks list [--status <STATUS>] [--limit <N>] [--offset <N>] [--sort <ORDER>]
reela tasks get <TASK_ID>
reela tasks versions <TASK_ID> --origin brand [--limit <N>] [--offset <N>]
reela tasks download <TASK_ID> [--video <ID>] [--out-dir <DIR>]
  • list: デフォルトでは 20 件を表示し、オフセットは 0、created_at:desc の順に並べ替えます。ステータスフィルター: cancelled、pending、processing、failed、partial、completed。
  • get: タスクのステータス、進捗状況、利用可能な場合は作成時のプロンプトを表示します。
  • versions: 未完了の出力を含む、Brand の出力バージョンを一覧表示します。--origin brand が必要です。上限: 1~100(デフォルトは 20)。オフセットのデフォルトは 0 です。
  • download: 完成した動画を、設定済みのディレクトリまたは --out-dir にダウンロードします(短縮形: -o)。完成した Brand 出力を選択するには --video を使用します。
reela tasks list --status completed --output json

collection

既存のコレクション内の動画を、タイトルと説明を含めて一覧表示します。

reela collection list [--session <TITLE>]
reela collection list --session "Product launch" --output json

REELA_COLLECTION_ID が設定されている場合は、その値が優先されます。設定されていない場合、コマンドは選択中のプロファイルのセッションを参照します。デフォルトのセッションは、最後に使用したセッションではなく、現地の日付を使用した reela-YYYY-MM-DD です。このコマンドではコレクションは作成されません。新しいコレクションを開始するには create を使用してください。

完成した動画にはダウンロード URL が含まれることがあります。これらのリンクは機密情報として扱い、公開しないでください。すべてのリンクに認証が必要、または有効期限が同じだと想定しないでください。

avatar

reela avatar list
reela avatar get <ID>

avatar list は利用可能なアバターを一覧表示し、avatar get はアバターの詳細を表示します。その ID を create --avatar とともに使用してください。

tiers

選択中のプロファイルで利用できる生成オプションとデフォルトのティアを一覧表示します。

reela tiers list
reela tiers list --output json
reela --profile work tiers list

通常の出力では、各ティアの引用符付きラベル、説明、デフォルトを示すマーカーが表示されます。JSON 出力には次の内容が含まれます。

  • default_tier: 利用可能な場合、デフォルトのティアラベル。
  • tiers: 選択肢の一覧。各項目には label、content(説明)、is_default が含まれます。

create --tier として正確なラベルを使用し、大文字と小文字を保持してください。スペースを含むラベルは引用符で囲みます。ティアの説明には、利用可能な生成オプションが記載されています。リクエストの検証時または送信時に、アカウントへのアクセス権が確認されます。

reela create "A product demo" --visual ai-video \
  --tier "<tier-label>" --dry-run --output json

tiers list が返すラベルで <tier-label> を置き換えてください。プレビューではタスクを作成せずに credits_cost と quota_after が返されます。同じオプションで送信するには --dry-run を削除してください。

--tier がない場合、create は CLI で利用できるデフォルトを使用します。デフォルトが利用できない場合は、tiers list で更新するか、--tier を指定してください。ティアの一覧表示と動画の作成には、同じプロファイルを選択してください。

brand

既存のブランドパッケージを一覧表示して適用します。

reela brand list [--limit <N>] [--offset <N>]
reela brand apply <BRAND_ID> --task <TASK_ID> [--inputs '<JSON>']

list はデフォルトで 20 件を表示し、オフセットは 0 です。上限は 1~100 である必要があります。apply はブランドパッケージを適用し、完成した動画を最大 10 分間待ちます。

ブランドパッケージに必要な値を指定するには --inputs を使用します。文字列、数値、真偽値を値とする JSON オブジェクトを受け付けます。配列、ネストされたオブジェクト、null はサポートされません。パラメーター名はパッケージで定義されています。例:

reela brand apply <BRAND_ID> --task <TASK_ID> \
  --inputs '{"AUTHOR_PROFILE_IMAGE_URL":"https://example.com/avatar.jpg","AUTHOR_NAME":"Alex"}'

不足している必須テンプレート値は、レンダリング開始前に拒否されます。不足している値を指定してから、再度適用してください。これらのパラメーターに認証情報や秘密情報を含めないでください。

待機が中断されても、処理が継続している場合があります。再度適用する前に出力バージョンを確認してください。

reela tasks versions <task-id> --origin brand
reela tasks download <task-id> --video <video-id>

edit

Reela 内で編集を続けるには編集 JSON をエクスポートし、制限なくローカルで編集するには Remotion プロジェクトをエクスポートします。

reela edit versions <TASK_ID>
reela edit export-json <TASK_ID> --file <PATH> [--version <N>]
reela edit export-remotion <TASK_ID> [--video <VIDEO_ID>] [--out-dir <DIR>]
reela edit validate <FILE>
reela edit save <FILE>
reela edit render <FILE>
  • versions: 下書きやレンダリングに失敗したものを含む、編集可能なバージョンを一覧表示します。
  • export-json: 最新または選択した編集バージョンを、Reela 内での編集用に JSON としてエクスポートします。ファイルを編集して検証した後、save または render を使用してください。
  • export-remotion: 制限なくローカルで編集できる Remotion プロジェクトをエクスポートします。--video がない場合は現在の編集内容をエクスポートします。動画のバージョンを選択するには --video を使用してください。--out-dir(短縮形: -o)はプロジェクトの親ディレクトリではなく、プロジェクトディレクトリそのものです。これを指定しない場合、設定済みのダウンロードディレクトリにプロジェクトフォルダーが作成されます。既存の保存先はそのまま保持され、数値のサフィックスが追加されます。JSON 出力には最終ディレクトリ path が含まれます。
  • validate: 内容をアップロードせずに編集 JSON のエラーを確認します。サインインとインターネット接続が必要です。
  • save: レンダリングせずに下書きを保存します。返されたプレビュー URL を開いて確認してください。
  • render: 保存して、レンダリングが完了するまで待ちます。成功すると、レンダリング結果が保存された後にのみタスク ID とプレビュー URL が返されます。サービスは最大 10 分間待機し、CLI は応答を 10 分 30 秒間待機します。レンダリング失敗が確認された場合は終了コード 10、タイムアウトの場合は終了コード 6 で終了します。送信は自動的に再試行されません。処理を中断したりタイムアウトしたりしても、レンダリングはキャンセルされません。再度レンダリングする前に reela edit versions <task-id> を確認してください。
reela edit export-json <task-id> --file edit.json
reela edit validate edit.json
reela edit save edit.json

Remotion のエクスポートでは、パッケージ化が完了するまで待機し、プロジェクトをダウンロードして展開します。ZIP は保持されません。パッケージ化には最大 10 分かかる場合があります。送信は自動的に再試行されません。待機を中断したりタイムアウトしたりしても、バックグラウンドでのパッケージ化はキャンセルされません。エクスポートしたプロジェクトは Reela に再インポートできず、validate、save、または render コマンドも使用しません。

show

show.yaml、subjects.yaml、episodes/*.md を含む Show ワークスペースをダウンロードして編集します。

reela show list [--limit <N>] [--offset <N>]
reela show download <SHOW_ID> [--out-dir <DIR>] [--force]
reela show validate
reela show update [--dry-run] [--yes]

list はデフォルトで 20 件を表示し、オフセットは 0 です。ダウンロードしたワークスペースのディレクトリから validate と update を実行してください。update --dry-run はローカルにもリモートにも書き込まずにプレビューします。--yes は対話型の確認なしで送信します。

破壊的なオプション: download --force は、無関係なファイルを含め、対象ディレクトリ内の既存ファイルをすべて削除します。update はローカルのワークスペース全体を送信します。Episode ファイルを削除するとリモートでも削除され、ローカルの編集可能なコンテンツは、バージョン確認やマージを行わずにリモートのコンテンツを上書きします。生成中または一時停止中の Show は更新できません。

reela show download <show-id> --out-dir ./my-show
cd my-show
reela show validate
reela show update --dry-run
reela show update

show subject

reela show subject download (--all | --subject-id <ID>) [--history] [--force]
reela show subject replace-image <SUBJECT_ID> --file <PATH>
reela show subject regenerate <SUBJECT_ID> --prompt-file <PATH> --model <MODEL> [--reference-image-id <ID>] [--yes]
  • download: 現在のワークスペース内のすべての Subject、または単一の Subject の画像をダウンロードします。--history は過去の画像も含めます。--force は既存の画像ファイルを上書きします。
  • replace-image: 静止画像の JPEG、PNG、または WebP ファイルをアップロードします(最大 20 MiB、40 メガピクセル)。画像履歴と既存の動画は保持されます。
  • regenerate: 画像を 1 枚生成し、最大 10 分間待ちます。プロンプトファイルは UTF-8 である必要があります。--reference-image-id は現在のワークスペースから画像を選択します。--yes は対話型の確認なしで生成を承認します。

Show のダウンロードには画像ではなく、構造化ファイルが含まれます。Subject の画像は別途ダウンロードしてください。過去の画像を選択するには、更新前に subjects.yaml 内の current_image_id を編集してください。

画像生成を中断しても停止するのは待機だけであり、バックグラウンドでの生成は停止しません。再度実行すると、再生成され、再び料金が発生する場合があります。

config

設定とアカウントプロファイルを管理します。

reela config list
reela config get <KEY>
reela config set <KEY> <VALUE>
reela config profiles list
reela config profiles create <NAME>
reela config profiles show [NAME]
reela config profiles use <NAME>
reela config profiles delete <NAME>

設定は選択中のプロファイルに適用されます。キーと現在の値を確認するには config list を使用してください。profiles use はデフォルトのプロファイルを変更します。単一のコマンドでプロファイルを選択するには --profile を使用してください。

reela config set delivery.download ~/Videos/reela
reela config profiles create work
reela --profile work login
reela config profiles use work

daemon / subscribe

Linux と macOS でローカルの自動配信を管理します。これらのコマンドは Windows では利用できません。

reela daemon start [--foreground] [--keep-backlog]
reela daemon stop
reela daemon status
reela daemon install
reela daemon uninstall
reela daemon logs [--tail <N>]
  • start: 自動配信を開始します。--foreground はターミナルに接続した状態で実行し続けます。このプロファイルに配信の進捗が保存されていない場合、--keep-backlog は自動配信がまだ可能な、以前に完成した動画も配信します。それ以外の場合は、保存済みの進捗から配信を再開します。
  • stop は配信を停止します。status は現在のステータスを表示します。
  • install はサインイン時の起動を有効にします。uninstall は自動起動を無効にします。
  • logs は最近のログを表示します。--tail のデフォルトは 20 行です。

subscribe

reela subscribe list
reela subscribe status
reela subscribe add download [--dir <DIR>]
reela subscribe add email [--address <EMAIL>]
reela subscribe add script --path <PATH> [--timeout-seconds <N>] [--max-retries <N>]
reela subscribe remove <METHOD>

方法は download、email、または script です。メールアドレスはアカウントのメールアドレスがデフォルトで使用されます。スクリプトには、標準入力から JSON オブジェクトを 1 つ読み取り、成功時に終了コード 0 で終了する、信頼できる実行可能ファイルを指定してください。--max-retries は配信試行の最大合計回数です。スクリプトのペイロードには reela subscribe add -h を使用してください。

方法を追加すると、停止中のデーモンの起動が試みられます。配信設定を変更した後、すでに実行中のデーモンを再起動して設定を読み込んでください。手動で起動したデーモンの場合は、reela daemon stop に続けて reela daemon start を使用します。サービス管理による起動の場合は、サービスマネージャーから再起動してください。

reela subscribe add download --dir ~/Videos/reela
reela subscribe status

update

インストール済みの CLI を更新し、バージョンを確認します。

reela update
reela --version