命令参考

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。

视觉类型和文件角色复制锚点链接

• 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：列出品牌输出版本，包括未完成的输出。需要 --origin brand。限制：1–100（默认 20）；偏移量默认为 0。
• download：将已完成的视频下载到已配置的目录或 --out-dir（简写形式：-o）。使用 --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

将 <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 图像。若要选择历史图像，请编辑 current_image_id（位于 subjects.yaml 中），然后更新。

中断图像生成只会停止等待，不会停止后台生成。再次运行可能会重新生成并再次扣费。

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