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。至少需要一個 --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產生歌曲和音樂影片。請勿與背景音樂檔案併用。
--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 會在背景產生影片,並透過你的訂閱交付完成的結果。請參閱下方的背景程式/訂閱一節。

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)。使用 --video 選取已完成的 Brand 輸出。
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

請將 <tier-label> 替換為 tiers list 傳回的標籤。預覽會傳回 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

匯出編輯 JSON,以便在 Reela 中繼續編輯;或匯出獨立的 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:將最新或選取的編輯版本匯出為 JSON,以便在 Reela 中編輯。編輯檔案並完成驗證後,使用 save 或 render。
  • export-remotion:匯出獨立的 Remotion 專案,以便不受限制地在本機編輯。若未指定 --video,則會匯出目前的編輯內容;使用 --video 選取影片版本。--out-dir(短形式:-o)是專案目錄本身,而不是其上層目錄。若未指定,系統會在已設定的下載目錄中建立專案資料夾。若目的地已存在,系統會附加數字後綴,以保留現有內容。JSON 輸出包含最終目錄 path。
  • validate:檢查編輯 JSON 是否有錯誤,不會上傳其內容。需要登入並連上網際網路。
  • save:儲存草稿,不進行算繪。開啟傳回的預覽 URL 以檢視。
  • render:儲存並等待算繪完成。只有在算繪輸出儲存完成後,成功回應才會傳回工作 ID 和預覽 URL。服務最多等待十分鐘;CLI 等待回應的時間上限為十分鐘三十秒。確認算繪失敗時會以代碼 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 檔案。封裝最多可能需要十分鐘。已提交的工作不會自動重試;中斷等待或等待逾時不會取消背景封裝。匯出的專案無法重新匯入 Reela,也不會使用 validate、save 或 render 指令。

show

下載並編輯 Show 工作區,其中包含 show.yaml、subjects.yaml 和 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 預設顯示 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:產生一張圖片,並等待最多 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。電子郵件預設為帳戶電子郵件。指令碼必須是可信任的可執行檔,能從 stdin 讀取一個 JSON 物件,並在成功時以代碼 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