Remotion CLI
ツールは remotion、@remotion/cli から提供されます。すべてのコマンドは npx remotion <command> で実行され、それぞれが最初にプロジェクトをバンドルするため、型エラーや不正なインポートはレンダリングエラーではなくバンドルエラーとして表面化します。
npx remotion --help と npx remotion <command> --help がフラグに関する正統な情報源です。 フラグはリリース間で変更されるため、このリストを含め、あらかじめ書かれたリストを信頼するのではなく、help出力を読んでください。以下に示すのはループと障害モードであり、フラグリファレンスではありません。
ループ
| 段階 | コマンド | 理由 |
|---|---|---|
| スキャフォールド | npx create-video@latest --blank | 適切な package.json、remotion.config.ts、tsconfig を書き出します |
| 型チェック | npx tsc --noEmit | 最もコストの低いゲート。レンダリング前にスキーマ/プロップのずれをキャッチします |
| 一覧表示 | npx remotion compositions | レンダリングしようとしている id が実際に存在することを確認します |
| フレームプローブ | npx remotion still <id> out/probe.png --frame=<n> | 数分ではなく数秒。イテレーションの主力です |
| レビュー | npx remotion studio | ユーザーに渡します。ユーザーはスクラブしてプロップを自分で編集します |
| レンダリング | npx remotion render <id> out/video.mp4 | ユーザーが承認した後にのみ実行します |
| リモート出荷 | npx remotion bundle → npx remotion lambda render <url> <id> | 分散レンダリング。デプロイされたAWSインフラストラクチャが必要です |
レンダリング前に静止画をプローブする
45秒の1080pコンポジションのフルレンダリングには数分かかります。静止画なら数秒で済み、ほとんどの疑問に答えます:テキストがフレーム内に収まっているか、アセットがロードされたか、色は正しいか。各シーンの中間点をプローブし、すべての画像を確認してからレンダリングしてください。
npx remotion still launch out/s1.png --frame=45
npx remotion still launch out/s2.png --frame=180
バンドルが成功したという理由だけでコンポジションが動作していると報告しないでください。ピクセルを見てください。
スタジオはレビュー画面であり、デバッガではありません
npx remotion studio は、タイムライン、Zodスキーマによって駆動されるプロップエディタ、フレーム精度のスクラビングを備えたプロジェクトを提供します。承認のためにユーザーに渡してください。自身の検証には still プローブを推奨します。スクリプト化可能であり、ユーザーに見えているものを説明してもらうことなく出力を確認できます。
プロップの渡し方
--props はJSON文字列またはJSONファイルへのパスを受け取り、defaultProps を上書きします:
npx remotion render launch out/video.mp4 --props='{"productName":"Acme"}'
コンポジションのZodスキーマに失敗するプロップは、レンダリングを大きなエラーで失敗させます。これがスキーマを宣言する目的なので、正確に保ってください。
バッチレンダリング
バッチサブコマンドはありません。シェルでidまたはプロップペイロードをループさせます:
for id in $(npx remotion compositions --quiet); do
npx remotion render "$id" "out/$id.mp4"
done
1つのコンポジションをデータセットに対して多数レンダリングする場合は、Nodeスクリプトで @remotion/renderer の renderMedia() を使用することを推奨します。1回のレンダリングにつき1回ではなく、1回だけバンドルするため、ウォールクロック時間が大幅に短縮されます。
レンダリングパフォーマンス
--concurrency=<n>は並列ワーカー数を設定します。デフォルトはCPUコアの半分(最大8)です。最大値はコア数であり、それ以上を指定するとエラーになります(クランプされません)。メモリが逼迫しているマシンでは、これを下げるとレンダラのバグのように見えるクラッシュを修正できます。--jpeg(デフォルトのPNGフレーム形式の代わり)は、透明度を保持する必要がない場合に大幅な高速化をもたらします。npx remotion benchmarkは実際のレンダリングを測定するため、推測ではなく、これを利用して同時実行数やコーデックの変更を正当化してください。npx remotion gpuは、ブラウザが実際にどのGPUアクセラレーションを使用するかを報告します。シェーダーや重いフィルターがレンダリングの遅延原因であると非難する前に確認する価値があります。
障害診断
| 症状 | 考えられる原因 |
|---|---|
| バンドルに失敗する | 型エラーまたは不正なインポート。 npx tsc --noEmit を実行すると、同じエラーの読みやすいバージョンが表示されます。 |
| 「id … のコンポジションが見つかりません」 | Root.tsx 内の id が渡したものと異なります。 npx remotion compositions で解決します。 |
| レンダリングがハングし、その後タイムアウトする | 対応する continueRender() がない delayRender()。すべてのdelayハンドルは解放されなければなりません。 |
| すべてのフレームがフレーム0のように見える | CSSアニメーション/トランジション、または requestAnimationFrame。レンダラーはブラウザのクロックを進めません。 |
| アニメーションがフレームごとにストロボまたはちらつく | シードなしの Math.random()。代わりに random(seed) を使用してください。 |
| 前方にスクラブするとモーションは機能するが、ジャンプすると壊れる | 状態駆動型アニメーション。代わりに useCurrentFrame() から導出してください。 |
| Lambdaまたはバンドルレンダリングでのみアセットが404になる | staticFile() の代わりにハードコードされたパス。 |
| 意味不明なバージョンエラー | Remotionパッケージの不一致。 npx remotion versions で不一致を報告します。 |
| レンダリング中にメモリ不足になる | マシンに対して同時実行数が高すぎます。 --concurrency を下げてください。 |
障害を報告する際は、実際のエラー出力を提示してください。スタックトレースを言い換えないでください。
廃止されたHyperFrames CLIの機能はどこへ行ったか
以前の hyperframes CLIは、RemotionのCLIにはないオーサリング、メディア、QAコマンドをバンドルしていました。以下はRemotionコマンドではないため、実行しようとしないでください:
| 廃止されたコマンド | 現在の機能の場所 |
|---|---|
init | npx create-video@latest --blank、その後 /hyperframes-core → references/project-structure.md |
lint, check, layout, validate | npx tsc --noEmit と still プローブ。これらのゲートが強制していた data-* 契約はなくなりました。 |
snapshot, compare, grade-compare | 選択したフレームで npx remotion still。PNGを独自のツールで差分比較します。 |
preview, play, present | npx remotion studio |
add, catalog | /hyperframes-registry |
capture | /product-launch-video(サイトキャプチャ)および /media-use |
tts, transcribe, remove-background | /media-use |
beats, keyframes | /hyperframes-creative(ビート計画)、/hyperframes-keyframes |
cloud, publish | npx remotion bundle + remotion lambda / remotion cloudrun、または独自のホスティング |
skills, docs, upgrade, doctor | これらのスキルはこのリポジトリにベンダリングされています。npx remotion upgrade および npx remotion versions |
もしワークフロースキルやリファレンスファイルが引き続き npx hyperframes <anything> を実行するよう指示している場合、その指示は古いものです。上記の表のRemotion相当のコマンドを実行し、サマリーで古いポインタに遭遇したことを報告して修正できるようにしてください。