ReelaDocs

Referência de comandos

Sintaxe, argumentos e opções dos comandos do Reela. Execute reela <command> -h para obter ajuda na versão instalada.

Sintaxe, argumentos e opções dos comandos do Reela. Execute reela <command> -h para obter ajuda na versão instalada.

login / logout / whoami / status

reela login
reela logout
reela whoami
reela status
  • login entra na conta por meio da autorização no navegador. Abra o URL exibido, insira o código, se solicitado, e aguarde a conclusão do comando.
  • logout encerra a sessão do perfil selecionado.
  • whoami mostra a conta conectada.
  • status verifica o status da conta e da entrega.
reela --profile work login
reela --profile work whoami

create

Crie um vídeo a partir de um prompt e de arquivos de mídia opcionais.

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

Forneça um prompt posicional ou --prompt-file. É necessário pelo menos um --visual.

OpçãoDescrição
--prompt-file <PATH>Lê o prompt de um arquivo em vez de usar um prompt posicional.
--visual <TYPE>Tipo visual. Repita para vários tipos; veja abaixo.
--duration <SECONDS>Duração do vídeo. Padrão: 30.
--layout <LAYOUT>landscape (padrão), portrait ou square.
--tier <TIER>Opção de qualidade e custo entre reela tiers list.
--avatar <ID>Avatar a incluir. Repita para vários avatares.
--file <ROLE:PATH>Anexa um arquivo local com uma função. Repita para vários arquivos.
--session <TITLE>Agrupa vídeos relacionados sob um título descritivo de projeto.
--music-videoGera uma música e um videoclipe. Não combine com arquivos de música de fundo.
--dry-runValida e estima os créditos sem enviar arquivos nem criar uma tarefa.

Tipos visuais e funções dos arquivos

  • ai-video: gera cenas; opcionalmente, anexe reference-image:<path> para definir o estilo.
  • avatar: inclui um apresentador selecionado com --avatar <id>.
  • original-clip: edita a filmagem sem o áudio; anexe video-source:<path>.
  • original-sync: mantém o áudio da filmagem; anexe video-audio:<path>.
  • image-video: anima uma imagem; anexe original-image:<path>.

Use background-music:<path> para sua própria música. Repita as opções em vez de unir os valores com vírgulas.

Exemplos

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

Confira primeiro os créditos estimados. Inicie o daemon e configure sua assinatura de entrega antes de remover --dry-run para enviar. O envio pode consumir créditos; o Reela gera o vídeo em segundo plano e entrega o resultado final pela sua assinatura. Consulte a seção sobre daemon / subscribe abaixo.

tasks

Liste tarefas e consulte detalhes de tarefas individuais ou versões de saída. Para a geração de vídeos de longa duração, use as assinaturas de conclusão do daemon para receber automaticamente os resultados finalizados.

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: o padrão é 20 resultados, deslocamento 0, ordenados por created_at:desc. Filtros de status: cancelled, pending, processing, failed, partial, completed.
  • get: mostra o status e o progresso da tarefa, além do prompt de criação, quando disponível.
  • versions: lista as versões de saída do Brand, incluindo saídas não finalizadas. Requer --origin brand. Limite: 1–100 (padrão: 20); o deslocamento padrão é 0.
  • download: baixa o vídeo finalizado para o diretório configurado ou --out-dir (forma abreviada: -o). Use --video para selecionar uma saída concluída do Brand.
reela tasks list --status completed --output json

collection

Liste vídeos de uma coleção existente, incluindo títulos e descrições.

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

REELA_COLLECTION_ID tem prioridade quando definido. Caso contrário, o comando procura a sessão no perfil selecionado. A sessão padrão é reela-YYYY-MM-DD usando a data local, e não a sessão usada mais recentemente. Este comando não cria uma coleção; use create para iniciar uma.

Os vídeos finalizados podem incluir URLs de download. Trate esses links como confidenciais e não os publique; não suponha que todos os links exijam autenticação ou tenham o mesmo prazo de validade.

avatar

reela avatar list
reela avatar get <ID>

avatar list lista os avatares disponíveis; avatar get mostra os detalhes de um avatar. Use o ID com create --avatar.

tiers

Liste as opções de geração e o nível padrão do perfil selecionado.

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

A saída simples mostra o rótulo entre aspas de cada nível, sua descrição e o indicador de padrão. A saída JSON inclui:

  • default_tier: o rótulo do nível padrão, quando disponível.
  • tiers: a lista de opções, com label, content (descrição) e is_default para cada entrada.

Use o rótulo exato como create --tier, preservando maiúsculas e minúsculas e colocando entre aspas os rótulos que contêm espaços. As descrições dos níveis explicam as opções de geração disponíveis. O acesso à conta é verificado quando você valida ou envia uma solicitação.

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

Substitua <tier-label> por um rótulo retornado por tiers list. A prévia retorna credits_cost e quota_after sem criar uma tarefa. Remova --dry-run para enviar com as mesmas opções.

Sem --tier, create usa o padrão disponível para a CLI. Se não houver um padrão disponível, atualize com tiers list ou forneça --tier. Selecione o mesmo perfil ao listar os níveis e criar o vídeo.

brand

Liste e aplique pacotes de marca existentes.

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

list usa como padrão 20 resultados e deslocamento 0; o limite deve estar entre 1 e 100. apply aplica um pacote de marca e aguarda até 10 minutos pelo vídeo finalizado.

Use --inputs para fornecer os valores exigidos pelo seu pacote de marca. Ele aceita um objeto JSON com valores de string, número ou booleano; arrays, objetos aninhados e null não são aceitos. Os nomes dos parâmetros são definidos pelo pacote. Por exemplo:

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

Valores obrigatórios ausentes no modelo são rejeitados antes da renderização. Forneça os valores ausentes antes de aplicar novamente. Não inclua credenciais nem segredos nesses parâmetros.

Se a espera for interrompida, a operação poderá continuar. Verifique as versões de saída antes de aplicar novamente:

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

edit

Exporte o JSON de edição para continuar editando no Reela ou exporte um projeto Remotion independente para edição local irrestrita.

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: lista as versões editáveis, incluindo rascunhos e renderizações com falha.
  • export-json: exporta a versão de edição mais recente ou selecionada como JSON para edição no Reela. Edite o arquivo, valide-o e, em seguida, use save ou render.
  • export-remotion: exporta um projeto Remotion independente para edição local irrestrita. Sem --video, exporta a edição atual; use --video para selecionar uma versão do vídeo. --out-dir (forma abreviada: -o) é o próprio diretório do projeto, não o diretório pai. Sem essa opção, uma pasta do projeto é criada no diretório de downloads configurado. Destinos existentes são preservados acrescentando um sufixo numérico. A saída JSON contém o diretório final path.
  • validate: verifica se há erros no JSON de edição sem enviar seu conteúdo. Requer login e conexão com a internet.
  • save: salva o rascunho sem renderizar. Abra o URL de prévia retornado para analisá-lo.
  • render: salva e aguarda o fim da renderização. Em caso de sucesso, retorna o ID da tarefa e o URL de prévia somente depois que a saída renderizada for salva. O serviço aguarda até dez minutos; a CLI permite dez minutos e trinta segundos para a resposta. Uma falha de renderização confirmada encerra com o código 10; um tempo limite excedido encerra com o código 6. Os envios não são repetidos automaticamente. Interromper ou exceder o tempo limite não cancela a renderização; verifique reela edit versions <task-id> antes de renderizar novamente.
reela edit export-json <task-id> --file edit.json
reela edit validate edit.json
reela edit save edit.json

A exportação Remotion aguarda o empacotamento, baixa e descompacta o projeto e não mantém o arquivo ZIP. O empacotamento pode levar até dez minutos. Os envios não são repetidos automaticamente; interromper ou exceder o tempo limite da espera não cancela o empacotamento em segundo plano. O projeto exportado não pode ser importado de volta para o Reela e não usa os comandos validate, save ou render.

show

Baixe e edite um espaço de trabalho Show que contém show.yaml, subjects.yaml e 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 usa como padrão 20 resultados e deslocamento 0. Execute validate e update no diretório do espaço de trabalho baixado. update --dry-run gera uma prévia sem gravar local ou remotamente; --yes envia sem confirmação interativa.

Opções destrutivas: download --force exclui todos os arquivos existentes no diretório de destino, inclusive arquivos não relacionados. update envia o espaço de trabalho local completo: remover um arquivo Episode o exclui remotamente, e o conteúdo editável local substitui o conteúdo remoto sem verificar versões nem fazer mesclagem. Shows em geração ou pausados não podem ser atualizados.

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: baixa imagens de todos os Subjects ou de um único Subject no espaço de trabalho atual. --history inclui imagens históricas; --force sobrescreve os arquivos de imagem existentes.
  • replace-image: envia uma imagem estática JPEG, PNG ou WebP (máximo de 20 MiB e 40 megapixels), preservando o histórico de imagens e os vídeos existentes.
  • regenerate: gera uma imagem e aguarda até 10 minutos. O arquivo de prompt deve estar em UTF-8. --reference-image-id seleciona uma imagem do espaço de trabalho atual; --yes autoriza a geração sem confirmação interativa.

Os downloads do Show contêm arquivos estruturados, não imagens; baixe as imagens do Subject separadamente. Para selecionar uma imagem histórica, edite current_image_id em subjects.yaml e, em seguida, atualize.

Interromper a geração de imagens encerra apenas a espera, não a geração em segundo plano. Executá-la novamente pode gerar outra imagem e cobrar novamente.

config

Gerencie configurações e perfis de conta.

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>

As configurações se aplicam ao perfil selecionado. Use config list para descobrir as chaves e os valores atuais. profiles use altera o perfil padrão; --profile seleciona um perfil para um único comando.

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

daemon / subscribe

Gerencie a entrega automática local no Linux e no macOS. Esses comandos não estão disponíveis no 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: inicia a entrega automática. --foreground mantém o daemon conectado ao terminal. Se este perfil não tiver progresso de entrega salvo, --keep-backlog também entrega vídeos concluídos anteriormente que ainda estejam disponíveis para entrega automática. Caso contrário, a entrega é retomada a partir do progresso salvo.
  • stop interrompe a entrega; status mostra o status atual.
  • install ativa a inicialização ao entrar na conta; uninstall desativa a inicialização automática.
  • logs mostra os registros recentes; --tail usa como padrão 20 linhas.

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>

Os métodos são download, email ou script. Por padrão, usa-se o e-mail da conta. Um script deve ser um executável confiável que leia um objeto JSON da entrada padrão e termine com código 0 em caso de sucesso. --max-retries é o número máximo total de tentativas de entrega; use reela subscribe add -h para o conteúdo do script.

Adicionar um método tenta iniciar um daemon parado. Depois de alterar as configurações de entrega, reinicie um daemon que já esteja em execução para carregá-las: para um daemon iniciado manualmente, use reela daemon stop seguido de reela daemon start; para uma inicialização gerenciada por serviço, reinicie usando o gerenciador de serviços.

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

update

Atualize a CLI instalada e verifique sua versão.

reela update
reela --version