ReelaDocs

Tham chiếu lệnh

Cú pháp, đối số và tùy chọn cho các lệnh Reela. Chạy reela <command> -h để xem trợ giúp trong phiên bản đã cài đặt.

Cú pháp, đối số và tùy chọn cho các lệnh Reela. Chạy reela <command> -h để xem trợ giúp trong phiên bản đã cài đặt.

login / logout / whoami / status

reela login
reela logout
reela whoami
reela status
  • login đăng nhập thông qua xác thực bằng trình duyệt. Mở URL được hiển thị, nhập mã nếu được yêu cầu và đợi lệnh hoàn tất.
  • logout đăng xuất khỏi hồ sơ đã chọn.
  • whoami hiển thị tài khoản đã đăng nhập.
  • status kiểm tra trạng thái tài khoản và gửi kết quả.
reela --profile work login
reela --profile work whoami

create

Tạo video từ câu lệnh và các tệp phương tiện tùy chọn.

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

Cung cấp câu lệnh dưới dạng đối số vị trí hoặc --prompt-file. Bắt buộc phải có ít nhất một --visual.

Tùy chọnMô tả
--prompt-file <PATH>Đọc câu lệnh từ tệp thay vì từ đối số vị trí.
--visual <TYPE>Loại hình ảnh. Lặp lại để dùng nhiều loại; xem bên dưới.
--duration <SECONDS>Thời lượng video. Mặc định: 30.
--layout <LAYOUT>landscape (mặc định), portrait hoặc square.
--tier <TIER>Tùy chọn chất lượng và chi phí từ reela tiers list.
--avatar <ID>Avatar cần đưa vào. Lặp lại để dùng nhiều avatar.
--file <ROLE:PATH>Đính kèm tệp cục bộ kèm vai trò. Lặp lại để dùng nhiều tệp.
--session <TITLE>Nhóm các video liên quan dưới một tiêu đề dự án mang tính mô tả.
--music-videoTạo bài hát và video ca nhạc. Không kết hợp với các tệp nhạc nền.
--dry-runXác thực và ước tính tín dụng mà không tải tệp lên hoặc tạo tác vụ.

Loại hình ảnh và vai trò của tệp

  • ai-video: tạo các cảnh; có thể đính kèm reference-image:<path> để làm phong cách.
  • avatar: đưa người dẫn chương trình được chọn bằng --avatar <id> vào video.
  • original-clip: chỉnh sửa cảnh quay mà không dùng âm thanh của cảnh quay; đính kèm video-source:<path>.
  • original-sync: giữ âm thanh của cảnh quay; đính kèm video-audio:<path>.
  • image-video: tạo hoạt ảnh cho hình ảnh; đính kèm original-image:<path>.

Dùng background-music:<path> cho nhạc của bạn. Lặp lại các cờ thay vì nối các giá trị bằng dấu phẩy.

Ví dụ

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

Trước tiên, hãy xem lại số tín dụng ước tính. Khởi động daemon và cấu hình gói đăng ký gửi kết quả trước khi bỏ --dry-run để gửi. Việc gửi có thể tiêu tốn tín dụng; Reela tạo video ở chế độ nền và gửi kết quả hoàn tất qua gói đăng ký của bạn. Xem phần daemon / subscribe bên dưới.

tasks

Liệt kê tác vụ và kiểm tra thông tin chi tiết của từng tác vụ hoặc các phiên bản đầu ra. Với quá trình tạo video chạy lâu, hãy dùng gói đăng ký hoàn tất của daemon để tự động nhận kết quả hoàn tất.

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: mặc định hiển thị 20 kết quả, độ lệch 0, sắp xếp theo created_at:desc. Bộ lọc trạng thái: cancelled, pending, processing, failed, partial, completed.
  • get: hiển thị trạng thái, tiến độ của tác vụ và câu lệnh tạo khi có.
  • versions: liệt kê các phiên bản đầu ra Brand, bao gồm cả đầu ra chưa hoàn tất. Yêu cầu --origin brand. Giới hạn: 1–100 (mặc định 20); độ lệch mặc định là 0.
  • download: tải video hoàn tất xuống thư mục đã cấu hình hoặc --out-dir (dạng viết tắt: -o). Dùng --video để chọn đầu ra Brand đã hoàn tất.
reela tasks list --status completed --output json

collection

Liệt kê video trong bộ sưu tập hiện có, bao gồm tiêu đề và nội dung mô tả.

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

REELA_COLLECTION_ID được ưu tiên nếu được đặt. Nếu không, lệnh sẽ tra cứu phiên trong hồ sơ đã chọn. Phiên mặc định là reela-YYYY-MM-DD theo ngày tại địa phương, không phải phiên được dùng gần nhất. Lệnh này không tạo bộ sưu tập; dùng create để bắt đầu tạo.

Video đã hoàn tất có thể chứa URL tải xuống. Hãy xem các liên kết này là thông tin nhạy cảm và không công khai chúng; đừng cho rằng mọi liên kết đều cần xác thực hoặc có cùng thời hạn hết hạn.

avatar

reela avatar list
reela avatar get <ID>

avatar list liệt kê các avatar hiện có; avatar get hiển thị thông tin chi tiết của một avatar. Dùng ID của avatar với create --avatar.

tiers

Liệt kê các tùy chọn tạo và bậc mặc định cho hồ sơ đã chọn.

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

Đầu ra văn bản thuần hiển thị nhãn được đặt trong dấu ngoặc kép, nội dung mô tả và dấu chỉ mặc định của từng bậc. Đầu ra JSON bao gồm:

  • default_tier: nhãn bậc mặc định, nếu có.
  • tiers: danh sách lựa chọn, với label, content (mô tả) và is_default cho mỗi mục.

Dùng nhãn chính xác làm create --tier, giữ nguyên kiểu viết hoa và đặt trong dấu ngoặc kép các nhãn có dấu cách. Nội dung mô tả bậc giải thích các lựa chọn tạo hiện có. Quyền truy cập tài khoản được kiểm tra khi bạn xác thực hoặc gửi yêu cầu.

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

Thay <tier-label> bằng nhãn do tiers list trả về. Bản xem trước trả về credits_cost và quota_after mà không tạo tác vụ. Bỏ --dry-run để gửi với cùng các tùy chọn.

Nếu không có --tier, create sẽ dùng mặc định có sẵn cho CLI. Nếu không có mặc định, hãy làm mới bằng tiers list hoặc cung cấp --tier. Chọn cùng một hồ sơ khi liệt kê các bậc và tạo video.

brand

Liệt kê và áp dụng các gói thương hiệu hiện có.

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

list mặc định hiển thị 20 kết quả và độ lệch 0; giới hạn phải nằm trong khoảng 1–100. apply áp dụng gói thương hiệu và đợi tối đa 10 phút để video hoàn tất.

Dùng --inputs để cung cấp các giá trị mà gói thương hiệu yêu cầu. Lệnh này chấp nhận một đối tượng JSON có các giá trị kiểu chuỗi, số hoặc boolean; không hỗ trợ mảng, đối tượng lồng nhau và null. Tên tham số do gói xác định. Ví dụ:

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

Các giá trị mẫu bắt buộc còn thiếu sẽ bị từ chối trước khi kết xuất. Hãy cung cấp các giá trị còn thiếu trước khi áp dụng lại. Không đưa thông tin đăng nhập hoặc bí mật vào các tham số này.

Nếu quá trình chờ bị gián đoạn, thao tác vẫn có thể tiếp tục. Hãy kiểm tra các phiên bản đầu ra trước khi áp dụng lại:

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

edit

Xuất JSON chỉnh sửa để tiếp tục chỉnh sửa trong Reela hoặc xuất dự án Remotion độc lập để chỉnh sửa cục bộ không giới hạn.

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: liệt kê các phiên bản có thể chỉnh sửa, bao gồm bản nháp và bản kết xuất thất bại.
  • export-json: xuất phiên bản chỉnh sửa mới nhất hoặc phiên bản đã chọn dưới dạng JSON để chỉnh sửa trong Reela. Chỉnh sửa tệp, xác thực tệp, sau đó dùng save hoặc render.
  • export-remotion: xuất dự án Remotion độc lập để chỉnh sửa cục bộ không giới hạn. Nếu không có --video, lệnh sẽ xuất bản chỉnh sửa hiện tại; dùng --video để chọn phiên bản video. --out-dir (dạng viết tắt: -o) là chính thư mục dự án, không phải thư mục cha. Nếu không có tùy chọn này, thư mục dự án sẽ được tạo trong thư mục tải xuống đã cấu hình. Các đích đã tồn tại được giữ nguyên bằng cách thêm hậu tố số. Đầu ra JSON chứa thư mục cuối cùng path.
  • validate: kiểm tra lỗi trong JSON chỉnh sửa mà không tải nội dung lên. Yêu cầu đăng nhập và kết nối internet.
  • save: lưu bản nháp mà không kết xuất. Mở URL xem trước được trả về để xem lại.
  • render: lưu và đợi kết xuất hoàn tất. Khi thành công, lệnh chỉ trả về ID tác vụ và URL xem trước sau khi đầu ra đã kết xuất được lưu. Dịch vụ chờ tối đa mười phút; CLI cho phép mười phút ba mươi giây để nhận phản hồi. Kết xuất thất bại đã được xác nhận sẽ thoát với mã 10; hết thời gian chờ sẽ thoát với mã 6. Các lần gửi không được tự động thử lại. Việc ngắt hoặc hết thời gian chờ không hủy quá trình kết xuất; hãy kiểm tra reela edit versions <task-id> trước khi kết xuất lại.
reela edit export-json <task-id> --file edit.json
reela edit validate edit.json
reela edit save edit.json

Quá trình xuất Remotion chờ đóng gói, tải xuống và giải nén dự án, đồng thời không lưu lại tệp ZIP. Quá trình đóng gói có thể mất tối đa mười phút. Các lần gửi không được tự động thử lại; việc ngắt hoặc hết thời gian chờ khi đợi không hủy quá trình đóng gói ở chế độ nền. Không thể nhập lại dự án đã xuất vào Reela và dự án không dùng các lệnh validate, save hoặc render.

show

Tải xuống và chỉnh sửa không gian làm việc Show chứa show.yaml, subjects.yaml và 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 mặc định hiển thị 20 kết quả và độ lệch 0. Chạy validate và update từ thư mục không gian làm việc đã tải xuống. update --dry-run xem trước mà không ghi vào máy cục bộ hoặc máy chủ; --yes gửi mà không cần xác nhận tương tác.

Tùy chọn có tính phá hủy: download --force xóa tất cả tệp hiện có trong thư mục đích, bao gồm các tệp không liên quan. update gửi toàn bộ không gian làm việc cục bộ: xóa tệp Episode sẽ xóa tệp đó từ xa, còn nội dung có thể chỉnh sửa ở máy cục bộ sẽ ghi đè nội dung từ xa mà không kiểm tra phiên bản hoặc hợp nhất. Không thể cập nhật các Show đang tạo hoặc đang tạm dừng.

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: tải hình ảnh cho tất cả Subject hoặc một Subject trong không gian làm việc hiện tại. --history bao gồm hình ảnh trong quá khứ; --force ghi đè các tệp hình ảnh hiện có.
  • replace-image: tải lên hình ảnh tĩnh JPEG, PNG hoặc WebP (tối đa 20 MiB và 40 megapixel), đồng thời giữ nguyên lịch sử hình ảnh và video hiện có.
  • regenerate: tạo một hình ảnh và chờ tối đa 10 phút. Tệp câu lệnh phải dùng UTF-8. --reference-image-id chọn một hình ảnh trong không gian làm việc hiện tại; --yes cho phép tạo mà không cần xác nhận tương tác.

Nội dung tải xuống của Show chứa các tệp có cấu trúc, không chứa hình ảnh; hãy tải riêng hình ảnh Subject. Để chọn hình ảnh trong quá khứ, hãy chỉnh sửa current_image_id trong subjects.yaml, sau đó cập nhật.

Việc ngắt quá trình tạo hình ảnh chỉ dừng chờ, không dừng quá trình tạo ở chế độ nền. Chạy lại lệnh có thể tạo hình ảnh mới và tính phí lần nữa.

config

Quản lý cài đặt và hồ sơ tài khoản.

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>

Cài đặt áp dụng cho hồ sơ đã chọn. Dùng config list để xem các khóa và giá trị hiện tại. profiles use thay đổi hồ sơ mặc định; --profile chọn hồ sơ cho một lệnh duy nhất.

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

daemon / subscribe

Quản lý việc gửi kết quả tự động trên máy cục bộ trong Linux và macOS. Các lệnh này không khả dụng trên 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: bắt đầu gửi kết quả tự động. --foreground giữ tiến trình gắn với cửa sổ dòng lệnh. Nếu hồ sơ này chưa lưu tiến độ gửi nào, --keep-backlog cũng gửi các video hoàn tất trước đó vẫn còn khả dụng để gửi tự động. Nếu không, quá trình gửi tiếp tục từ tiến độ đã lưu.
  • stop dừng gửi kết quả; status hiển thị trạng thái hiện tại.
  • install bật khởi động khi đăng nhập; uninstall tắt khởi động tự động.
  • logs hiển thị nhật ký gần đây; --tail mặc định hiển thị 20 dòng.

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>

Các phương thức gồm download, email hoặc script. Email mặc định là email của tài khoản. Tập lệnh phải là tệp thực thi đáng tin cậy, đọc một đối tượng JSON từ stdin và thoát với mã 0 khi thành công. --max-retries là số lần thử gửi tối đa; dùng reela subscribe add -h cho dữ liệu tải trọng của tập lệnh.

Khi thêm phương thức, hệ thống sẽ thử khởi động daemon nếu daemon đang dừng. Sau khi thay đổi cài đặt gửi kết quả, hãy khởi động lại daemon đang chạy để tải các cài đặt đó: nếu daemon được khởi động thủ công, dùng reela daemon stop rồi đến reela daemon start; nếu khởi động do dịch vụ quản lý, hãy khởi động lại thông qua trình quản lý dịch vụ.

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

update

Cập nhật CLI đã cài đặt và kiểm tra phiên bản.

reela update
reela --version