Youka CLI - Youka Docs

O Youka CLI encapsula a API pública para que você possa criar karaokê a partir de uma música, personalizar a letra e o estilo do vídeo e exportar um MP4 finalizado a partir do seu terminal ou de um agente.

Instalação

npm install -g @youka/cli

pnpm add -g @youka/cli

yarn global add @youka/cli

Verifique a instalação:

youka --version
youka --help

Configurar autenticação

Obter uma chave de API

Acesse online.youka.io/account, abra API keys e copie uma nova chave.

Salvar a chave

Persista a chave em ~/.youka/config.json:

youka login YOUR_API_KEY

Ou exporte-a como uma variável de ambiente:

export YOUKA_API_KEY=YOUR_API_KEY

Criar karaokê a partir de um arquivo

Use um arquivo de áudio ou vídeo local como fonte:

youka project create ./song.mp3 --download --output ./karaoke.mp4 --wait --json

Isso envia a fonte, cria o projeto de karaokê, renderiza uma exportação e baixa o vídeo MP4 finalizado.

Criar karaokê a partir de uma URL

Passe uma URL de origem HTTP ou HTTPS em vez de um caminho de arquivo:

youka project create "https://example.com/song.mp4" --download --output ./karaoke.mp4 --wait --json

Para URLs de vídeo hospedadas, o Youka usa yt-dlp para baixar a partir da URL. Você pode instalar as dependências de download de URL antes da primeira importação por URL:

youka deps ensure --for url

Referência

Conta

Faça login, logout e inspecione o estado de autenticação.

Créditos

Inspecione o saldo atual e os pacotes de crédito que expiram.

Cobrança

Exiba preços e crie URLs de checkout ou do portal.

Projetos

Crie, inspecione, aguarde e atualize projetos.

Exportações

Renderize artefatos de exportação na nuvem ou localmente e faça o download.

Presets

Gerencie configurações de renderização reutilizáveis.

Mídia

Envie e gerencie mídia reutilizável.

Tarefas

Inspecione o estado de tarefas de baixo nível quando necessário.

Dependências

Inspecione e instale dependências de importação por URL e de renderização local.

Opções globais

Flags disponíveis em todos os comandos.

Pronto para agentes por padrão

Todo comando oferece suporte a um modo legível por máquina que retorna um único envelope JSON com um formato estável. Use estas flags para controlar o CLI a partir de agentes ou scripts:

Flag	Finalidade
`--json`	Imprima exatamente um envelope JSON no stdout. Progresso e logs são suprimidos.
`--body <file\|->`	Mescle um payload JSON de um arquivo ou do stdin. Flags do CLI sobrescrevem campos correspondentes.
`--wait`	Consulte jobs assíncronos (project create, exports) até atingirem um estado terminal.
`--idempotency-key <key>`	Passe uma chave de idempotência para qualquer operação de escrita.
`--quiet`	Suprima a saída de progresso não-JSON ao usar com `--wait`.
`--api <url>`	Substitua a URL base da API pública.

Formato do envelope JSON:

{
  "ok": true,
  "data": {
    /* command result */
  }
}

Em caso de falha:

{
  "ok": false,
  "error": {
    "code": "INVALID_INPUT",
    "message": "Human-readable description",
    "details": {
      /* optional */
    }
  }
}

Veja Opções globais para a lista completa.

Exportação na nuvem vs local

export create roda na nuvem por padrão. Passe --local para renderizar na sua máquina usando o toolchain Remotion incluído. Renderizações locais exigem as dependências de renderização:

youka deps ensure --for render

Veja Exportações para o fluxo completo.

Próximos passos

Conta - salve sua chave de API
Projetos - crie e processe projetos
Exportações - renderize um vídeo de karaokê finalizado
AI agents - controle o CLI a partir de um fluxo de trabalho automatizado

​Instalação

​Configurar autenticação

​Criar karaokê a partir de um arquivo

​Criar karaokê a partir de uma URL

​Referência