ReelaDocs

Referensi perintah

Sintaks, argumen, dan opsi untuk perintah Reela. Jalankan reela <command> -h untuk bantuan pada versi yang terpasang.

Sintaks, argumen, dan opsi untuk perintah Reela. Jalankan reela <command> -h untuk bantuan pada versi yang terpasang.

login / logout / whoami / status

reela login
reela logout
reela whoami
reela status
  • login masuk melalui otorisasi browser. Buka URL yang ditampilkan, masukkan kode jika diminta, lalu tunggu hingga perintah selesai.
  • logout keluar dari profil yang dipilih.
  • whoami menampilkan akun yang sedang masuk.
  • status memeriksa status akun dan pengiriman.
reela --profile work login
reela --profile work whoami

create

Buat video dari prompt dan file media opsional.

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

Berikan prompt posisional atau --prompt-file. Setidaknya satu --visual diperlukan.

OpsiDeskripsi
--prompt-file <PATH>Baca prompt dari file, bukan dari prompt posisional.
--visual <TYPE>Jenis visual. Ulangi untuk beberapa jenis; lihat di bawah.
--duration <SECONDS>Durasi video. Bawaan: 30.
--layout <LAYOUT>landscape (bawaan), portrait, atau square.
--tier <TIER>Opsi kualitas dan biaya dari reela tiers list.
--avatar <ID>Avatar yang akan disertakan. Ulangi untuk beberapa avatar.
--file <ROLE:PATH>Lampirkan file lokal beserta perannya. Ulangi untuk beberapa file.
--session <TITLE>Kelompokkan video terkait dalam satu judul proyek deskriptif.
--music-videoBuat lagu dan video musik. Jangan gabungkan dengan file musik latar.
--dry-runValidasi dan perkirakan kredit tanpa mengunggah file atau membuat tugas.

Jenis visual dan peran file

  • ai-video: buat shot; secara opsional, lampirkan reference-image:<path> untuk gaya.
  • avatar: sertakan presenter yang dipilih dengan --avatar <id>.
  • original-clip: edit rekaman tanpa audionya; lampirkan video-source:<path>.
  • original-sync: pertahankan audio rekaman; lampirkan video-audio:<path>.
  • image-video: animasikan gambar; lampirkan original-image:<path>.

Gunakan background-music:<path> untuk musik Anda sendiri. Ulangi flag alih-alih menggabungkan nilai dengan koma.

Contoh

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

Tinjau perkiraan kredit terlebih dahulu. Jalankan daemon dan konfigurasi langganan pengiriman Anda sebelum menghapus --dry-run untuk mengirimkan permintaan. Pengiriman dapat menghabiskan kredit; Reela membuat video di latar belakang dan mengirimkan hasil akhir melalui langganan Anda. Lihat bagian daemon / subscribe di bawah.

tasks

Daftar tugas dan periksa detail tugas atau versi output satu per satu. Untuk pembuatan video yang berjalan lama, gunakan langganan penyelesaian daemon agar hasil yang selesai diterima secara otomatis.

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: secara bawaan menampilkan 20 hasil, offset 0, diurutkan berdasarkan created_at:desc. Filter status: cancelled, pending, processing, failed, partial, completed.
  • get: tampilkan status tugas, progres, dan prompt pembuatan jika tersedia.
  • versions: daftar versi output Brand, termasuk output yang belum selesai. Memerlukan --origin brand. Batas: 1–100 (bawaan 20); offset secara bawaan 0.
  • download: unduh video yang selesai ke direktori yang dikonfigurasi atau --out-dir (bentuk singkat: -o). Gunakan --video untuk memilih output Brand yang selesai.
reela tasks list --status completed --output json

collection

Daftar video dalam koleksi yang sudah ada, termasuk judul dan deskripsi.

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

REELA_COLLECTION_ID diprioritaskan jika disetel. Jika tidak, perintah akan mencari sesi di profil yang dipilih. Sesi bawaan adalah reela-YYYY-MM-DD berdasarkan tanggal setempat, bukan sesi terakhir yang digunakan. Perintah ini tidak membuat koleksi; gunakan create untuk memulainya.

Video yang sudah selesai mungkin menyertakan URL unduhan. Perlakukan tautan ini sebagai informasi sensitif dan jangan publikasikan; jangan berasumsi bahwa setiap tautan memerlukan autentikasi atau memiliki masa berlaku yang sama.

avatar

reela avatar list
reela avatar get <ID>

avatar list mencantumkan avatar yang tersedia; avatar get menampilkan detail avatar. Gunakan ID-nya dengan create --avatar.

tiers

Daftar opsi pembuatan dan tier bawaan untuk profil yang dipilih.

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

Output teks biasa menampilkan label yang dikutip, deskripsi, dan penanda bawaan untuk setiap tier. Output JSON mencakup:

  • default_tier: label tier bawaan, jika tersedia.
  • tiers: daftar pilihan, dengan label, content (deskripsi), dan is_default untuk setiap entri.

Gunakan label persis seperti create --tier, pertahankan penggunaan huruf besar-kecil dan kutip label yang mengandung spasi. Deskripsi tier menjelaskan pilihan pembuatan yang tersedia. Akses akun diperiksa saat Anda memvalidasi atau mengirim permintaan.

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

Ganti <tier-label> dengan label yang dikembalikan oleh tiers list. Pratinjau mengembalikan credits_cost dan quota_after tanpa membuat tugas. Hapus --dry-run untuk mengirimkan permintaan dengan opsi yang sama.

Tanpa --tier, create menggunakan bawaan yang tersedia bagi CLI. Jika tidak ada bawaan, perbarui dengan tiers list atau berikan --tier. Pilih profil yang sama saat mencantumkan tier dan membuat video.

brand

Daftar dan terapkan paket merek yang sudah ada.

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

list secara bawaan menampilkan 20 hasil dan offset 0; batasnya harus 1–100. apply menerapkan paket merek dan menunggu hingga 10 menit sampai video selesai.

Gunakan --inputs untuk memberikan nilai yang diperlukan oleh paket merek Anda. Opsi ini menerima objek JSON dengan nilai string, angka, atau boolean; array, objek bertingkat, dan null tidak didukung. Nama parameter ditentukan oleh paket. Contoh:

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

Nilai template wajib yang belum diisi akan ditolak sebelum proses render. Berikan nilai yang belum diisi sebelum menerapkan kembali. Jangan sertakan kredensial atau rahasia dalam parameter ini.

Jika proses menunggu terganggu, operasi mungkin tetap berlanjut. Periksa versi output sebelum menerapkan kembali:

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

edit

Ekspor JSON edit untuk melanjutkan pengeditan di Reela, atau ekspor proyek Remotion mandiri untuk pengeditan lokal tanpa batasan.

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: daftar versi yang dapat diedit, termasuk draf dan render yang gagal.
  • export-json: ekspor versi edit terbaru atau yang dipilih sebagai JSON untuk diedit di Reela. Edit file, validasi, lalu gunakan save atau render.
  • export-remotion: ekspor proyek Remotion mandiri untuk pengeditan lokal tanpa batasan. Tanpa --video, opsi ini mengekspor edit saat ini; gunakan --video untuk memilih versi video. --out-dir (bentuk singkat: -o) adalah direktori proyek itu sendiri, bukan direktori induknya. Jika tidak disertakan, folder proyek dibuat di direktori unduhan yang dikonfigurasi. Tujuan yang sudah ada akan dipertahankan dengan menambahkan sufiks numerik. Output JSON berisi direktori akhir path.
  • validate: periksa JSON edit untuk menemukan kesalahan tanpa mengunggah isinya. Memerlukan login dan koneksi internet.
  • save: simpan draf tanpa melakukan render. Buka URL pratinjau yang dikembalikan untuk meninjaunya.
  • render: simpan dan tunggu hingga render selesai. Jika berhasil, ID tugas dan URL pratinjau hanya dikembalikan setelah output hasil render tersimpan. Layanan menunggu hingga sepuluh menit; CLI menunggu hingga sepuluh menit tiga puluh detik untuk respons. Kegagalan render yang terkonfirmasi akan keluar dengan kode 10; timeout akan keluar dengan kode 6. Pengiriman tidak dicoba ulang secara otomatis. Menghentikan atau mengalami timeout tidak membatalkan render; periksa reela edit versions <task-id> sebelum melakukan render lagi.
reela edit export-json <task-id> --file edit.json
reela edit validate edit.json
reela edit save edit.json

Ekspor Remotion menunggu proses pengemasan, mengunduh dan mengekstrak proyek, serta tidak menyimpan ZIP. Pengemasan dapat memakan waktu hingga sepuluh menit. Pengiriman tidak dicoba ulang secara otomatis; menghentikan atau mengalami timeout saat menunggu tidak membatalkan pengemasan di latar belakang. Proyek yang diekspor tidak dapat diimpor kembali ke Reela dan tidak menggunakan perintah validate, save, atau render.

show

Unduh dan edit ruang kerja Show yang berisi show.yaml, subjects.yaml, dan episodes/*.md.

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 secara bawaan menampilkan 20 hasil dan offset 0. Jalankan validate dan update dari direktori ruang kerja yang diunduh. update --dry-run menampilkan pratinjau tanpa menulis secara lokal atau jarak jauh; --yes mengirimkan permintaan tanpa konfirmasi interaktif.

Opsi destruktif: download --force menghapus semua file yang ada di direktori target, termasuk file yang tidak terkait. update mengirimkan seluruh ruang kerja lokal: menghapus file Episode akan menghapusnya dari jarak jauh, dan konten lokal yang dapat diedit akan menimpa konten jarak jauh tanpa pemeriksaan versi atau penggabungan. Show yang sedang dibuat atau dijeda tidak dapat diperbarui.

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: unduh gambar untuk semua Subject atau satu Subject dalam ruang kerja saat ini. --history menyertakan gambar historis; --force menimpa file gambar yang sudah ada.
  • replace-image: unggah gambar statis JPEG, PNG, atau WebP (maksimum 20 MiB dan 40 megapiksel), dengan mempertahankan riwayat gambar dan video yang sudah ada.
  • regenerate: buat satu gambar dan tunggu hingga 10 menit. File prompt harus berformat UTF-8. --reference-image-id memilih gambar dari ruang kerja saat ini; --yes mengizinkan pembuatan tanpa konfirmasi interaktif.

Unduhan Show berisi file terstruktur, bukan gambar; unduh gambar Subject secara terpisah. Untuk memilih gambar historis, edit current_image_id di subjects.yaml, lalu perbarui.

Menghentikan pembuatan gambar hanya menghentikan proses menunggu, bukan pembuatan di latar belakang. Menjalankannya lagi dapat membuat gambar baru dan menimbulkan biaya lagi.

config

Kelola pengaturan dan profil akun.

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>

Pengaturan berlaku untuk profil yang dipilih. Gunakan config list untuk mengetahui kunci dan nilai saat ini. profiles use mengubah profil bawaan; --profile memilih profil untuk satu perintah.

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

daemon / subscribe

Kelola pengiriman otomatis lokal di Linux dan macOS. Perintah ini tidak tersedia di 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: mulai pengiriman otomatis. --foreground mempertahankannya agar tetap terhubung ke terminal. Jika profil ini tidak memiliki progres pengiriman tersimpan, --keep-backlog juga mengirimkan video lama yang telah selesai dan masih tersedia untuk pengiriman otomatis. Jika tidak, pengiriman dilanjutkan dari progres tersimpan.
  • stop menghentikan pengiriman; status menampilkan statusnya saat ini.
  • install mengaktifkan pemulaian saat masuk; uninstall menonaktifkan pemulaian otomatis.
  • logs menampilkan log terbaru; --tail secara bawaan menampilkan 20 baris.

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>

Metodenya adalah download, email, atau script. Email secara bawaan menggunakan email akun. Skrip harus berupa executable tepercaya yang membaca satu objek JSON dari stdin dan keluar dengan kode 0 jika berhasil. --max-retries adalah jumlah maksimum total percobaan pengiriman; gunakan reela subscribe add -h untuk payload skrip.

Menambahkan metode akan mencoba memulai daemon yang sedang berhenti. Setelah mengubah pengaturan pengiriman, mulai ulang daemon yang sudah berjalan agar pengaturan baru dimuat: untuk daemon yang dimulai secara manual, gunakan reela daemon stop diikuti reela daemon start; untuk pemulaian yang dikelola layanan, mulai ulang melalui pengelola layanan Anda.

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

update

Perbarui CLI yang terpasang dan periksa versinya.

reela update
reela --version