@crievo/omni 0.0.0-stage → 0.1.0

package/.env.example

@@ -0,0 +1,41 @@
+# Voice provider keys. Copy to .env (outside git) and fill in.
+# Each provider's cloned voice goes in omnivideo.config.json: voice.fish.voice_id and voice.cartesia.voice_id.
+
+# fish.audio → API Keys
+FISH_API_KEY=
+
+# play.cartesia.ai → API Keys
+CARTESIA_API_KEY=
+
+# elevenlabs.io → Developers → API Keys (the voice goes in voice.elevenlabs.voice_id, or in the voice profile)
+ELEVENLABS_API_KEY=
+
+# play.cartesia.ai → API Keys → ADMIN key (sk_car_admin_…). Optional: only reads usage
+# for the usage screen; without it Cartesia usage is estimated.
+CARTESIA_ADMIN_API_KEY=
+
+# Publish (tools/publish.mjs; walkthrough in reference/publish.md). The Google Cloud
+# "Desktop app" OAuth client; the YouTube refresh token and the Instagram token are
+# written here by `node tools/publish.mjs auth youtube|instagram`.
+YOUTUBE_CLIENT_ID=
+YOUTUBE_CLIENT_SECRET=
+
+# Omnichat button and follow gate (tools/omnichat.mjs webhook; reference/omnichat.md). The Instagram
+# app secret (developers.facebook.com → Instagram → API setup with Instagram login) signs the webhook
+# events; the verify token is created by `node tools/omnichat.mjs webhook setup`.
+INSTAGRAM_APP_SECRET=
+INSTAGRAM_WEBHOOK_VERIFY_TOKEN=
+
+# Omnichat in the cloud (cloud/omnichat, tools/omnichat.mjs cloud): the Worker's SYNC_SECRET, the
+# Bearer token the CLI and the studio use. The Worker's url goes in omnivideo.config.json cloud.url.
+OMNICHAT_CLOUD_SECRET=
+
+# The hosted studio (cloud/studio): this Mac's key as its runner, written by `node tools/runner.mjs login`.
+OMNIVIDEO_RUNNER_TOKEN=
+# Its login (node cloud/studio/setup-auth.mjs sends them to the Worker): the Google OAuth client
+# (Web application, redirect <studio>/auth/callback/google), who may sign in (comma separated) and the
+# session secret (created by setup-auth.mjs on the first run).
+STUDIO_GOOGLE_CLIENT_ID=
+STUDIO_GOOGLE_CLIENT_SECRET=
+STUDIO_ALLOWED_EMAILS=
+STUDIO_AUTH_SECRET=

package/README.md

@@ -1,3 +1,3 @@
-# Temporary Holding Version
+# @crievo/omni
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+O CLI do OmniVideo. Use pelo plugin do Claude Code (`claude plugin install omnivideo --marketplace pedroflp/omni-plugin`) ou, sem ele, `npx -y @crievo/omni setup`.

package/bin/omni.mjs

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+/* The `omni` command (the npm package's bin, and `node bin/omni.mjs` in this repo). It settles the workspace
+   before any module reads it (tools/lib/paths.mjs takes OMNI_HOME at import), then hands over to
+   tools/omni.mjs: OMNI_HOME, else this folder when it holds an omnivideo.config.json, else ~/OmniVideo. */
+
+import { existsSync } from "node:fs";
+import { homedir } from "node:os";
+import { join } from "node:path";
+
+if (!process.env.OMNI_HOME)
+  process.env.OMNI_HOME = existsSync(join(process.cwd(), "omnivideo.config.json")) ? process.cwd() : join(homedir(), "OmniVideo");
+
+const { main } = await import("../tools/omni.mjs");
+await main(process.argv.slice(2));

package/docs/onboarding.md

@@ -0,0 +1,212 @@
+# Primeiros passos no OmniVideo
+
+Do zero ao primeiro vídeo: instalar as ferramentas, baixar o projeto, conectar o
+Claude Code, a voz, um estilo visual e o som, e pedir o vídeo. Publicar nas
+redes fica para o fim e é opcional.
+
+Cada passo diz o que fazer e como conferir. Com o studio aberto, a tela
+**Primeiros passos** (`http://127.0.0.1:5432/getting-started`) mostra este mesmo guia e marca
+sozinha o que já está pronto; no terminal, `node tools/setup.mjs check` faz a mesma
+conferência.
+
+![A tela Primeiros passos do studio](onboarding/getting-started.png)
+
+O que você vai precisar ter ou criar:
+
+- um Mac (macOS) com acesso de administrador;
+- uma conta do Claude com Claude Code (plano Pro ou Max);
+- uma conta num provider de voz: Fish Audio ou Cartesia (ElevenLabs também serve);
+- uma assinatura da Epidemic Sound, de onde vêm os efeitos sonoros;
+- um vídeo ou fotos do estilo visual que você quer (um link ou imagens).
+
+<!-- step: machine -->
+## 1. Ferramentas da máquina
+
+O OmniVideo roda inteiro na sua máquina. Ele precisa de Node.js, Bun, ffmpeg, Python
+e um Chrome. O jeito mais rápido no Mac é o [Homebrew](https://brew.sh):
+
+```bash
+/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+brew install node oven-sh/bun/bun ffmpeg python@3.12 yt-dlp
+brew install --cask google-chrome
+```
+
+- **Node.js 20+** roda as ferramentas de `tools/` (render, montagem, publicação).
+- **Bun** roda o studio.
+- **ffmpeg** (com o `ffprobe`) mede, corta, mistura e exporta tudo.
+- **Python 3.10+** roda a voz e a legenda (o passo 2 cria um ambiente só do projeto).
+- **Google Chrome** é onde o motion é desenhado quadro a quadro. Chromium e Brave
+  também servem; outro caminho vai em `CHROME_PATH`.
+- **yt-dlp** é opcional: baixa o estilo visual quando você manda um link.
+
+Confira com `node --version`, `bun --version`, `ffmpeg -version` e `python3 --version`.
+
+<!-- step: project -->
+## 2. Baixar e preparar o projeto
+
+Clone o repositório e rode o setup. Ele não sobrescreve nada que já exista:
+
+```bash
+git clone https://github.com/pedroflp/omni.git omnivideo
+cd omnivideo
+node tools/setup.mjs
+```
+
+O setup:
+
+- cria o `.env` (as chaves, fora do git) e o `omnivideo.config.json` a partir dos exemplos;
+- cria a biblioteca de estilos visuais vazia, ao lado do projeto (`../referencias`);
+- cria o kit de efeitos vazio (`kit/sfx/kit.json`);
+- cria o Python do projeto (`.venv`, com `requests`, `soundfile` e `numpy`);
+- instala as dependências do studio (`bun install`).
+
+No fim, ele mostra a conferência de todos os passos deste guia. Daí em diante, abra o
+studio e siga pela tela:
+
+```bash
+cd studio && bun start
+```
+
+O studio abre em `http://127.0.0.1:5432`. Deixe esse terminal aberto enquanto usa.
+
+<!-- step: claude -->
+## 3. Claude Code
+
+Quem escreve o roteiro, compõe o motion e conduz cada etapa é o Claude Code, aberto
+pelo studio. Instale e entre na sua conta:
+
+```bash
+curl -fsSL https://claude.ai/install.sh | bash
+CLAUDE_CONFIG_DIR=~/.claude-personal claude
+```
+
+Na primeira vez, o Claude pede para entrar: escolha a conta do Claude (Pro ou Max) e
+siga o login no navegador. Depois, digite `/exit`.
+
+O studio sempre abre o Claude com `CLAUDE_CONFIG_DIR=~/.claude-personal`, para nunca
+misturar com outra conta da máquina (uma de trabalho, por exemplo). Por isso o login
+precisa ser feito nessa pasta. Para não digitar a variável toda vez, ponha no
+`~/.zshrc`:
+
+```bash
+claude() { CLAUDE_CONFIG_DIR="$HOME/.claude-personal" command claude "$@"; }
+```
+
+Em **Configurações → Agente de IA** você escolhe o modelo e o esforço de cada etapa e
+pode pôr mais contas no rodízio: outras pastas do Claude (`~/.claude-personal-2`…) e contas
+do Codex (o CLI que vem no app do ChatGPT, ou o `codex` no PATH). Cada sessão nova vai para a
+próxima conta, e a que bate o limite de uso sai do rodízio até liberar. O botão **Entrar**
+de cada conta abre o login no navegador.
+
+<!-- step: voice -->
+## 4. Voz
+
+A narração é a sua voz clonada. O studio cria o clone na Fish Audio e na Cartesia
+pela API; você só precisa da chave de pelo menos uma delas.
+
+**A chave do provider.** Crie a conta e copie a chave da API:
+
+- **Fish Audio**: [fish.audio](https://fish.audio), menu da conta → **API Keys**.
+- **Cartesia**: [play.cartesia.ai](https://play.cartesia.ai), **API Keys**.
+- **ElevenLabs** (opcional): [elevenlabs.io](https://elevenlabs.io), **Developers →
+  API Keys**. Nela a voz entra pelo Voice ID de uma voz que você já criou lá.
+
+No studio, abra **Configurações → Voz → Provedores de voz** e cole a chave no
+provider. Ela vai para o `.env`, que nunca sobe para o git.
+
+![Provedores de voz: a chave de cada provider](onboarding/providers.png)
+
+**O clone.** Ainda em **Configurações → Voz**, vá até o último item da roleta,
+**Adicionar voz** (o "+"). Abre o quadro **Clonar a minha voz**:
+
+1. escolha o idioma da fala;
+2. grave lendo o roteiro que aparece na tela, ou envie áudios seus (de 30 s a 3 min
+   de fala; quanto mais perto de 3 min, melhor o clone);
+3. em **Criar voz**, marque os providers, aceite o consentimento, dê um nome e crie.
+
+![Clonar a minha voz](onboarding/clone-voice.png)
+
+O studio cria a voz em cada provider marcado e grava o perfil. A primeira voz criada
+vira a voz ativa, que já vem marcada em cada vídeo novo. Se o plano do provider não
+deixar clonar pela API, o cartão dele avisa; nesse caso crie a voz no site do
+provider e use **Já tenho voz criada nos provedores**, com o Voice ID.
+
+<!-- step: reference -->
+## 5. Estilo visual
+
+Todo vídeo segue um estilo visual: um vídeo (ou fotos) de que você gosta, medido
+(cores, ritmo, tipografia, movimento) e transformado num guia. O estilo visual é princípio,
+nunca asset copiado.
+
+Em **Estilos visuais → Novo estilo visual**:
+
+1. cole um **link** (Instagram, YouTube…; link precisa do `yt-dlp`, do passo 1), ou
+2. envie **fotos** do estilo (telas, quadros, capturas), ou os dois;
+3. clique em **Criar estilo visual**.
+
+![Novo estilo visual](onboarding/references.png)
+
+O Claude mede o vídeo (com fotos, lê as imagens) e escreve o guia em alguns minutos; a tela
+do estilo visual mostra o andamento. A biblioteca fica em `../referencias` (o caminho está em
+`references.dir`, na config) e serve para todos os vídeos.
+
+<!-- step: sound -->
+## 6. Efeitos sonoros
+
+Os efeitos vêm só da Epidemic Sound. O projeto começa com o kit vazio: na primeira
+composição, o Claude busca na Epidemic pelo seu Chrome, ouve, escolhe e baixa cada
+efeito. Os bons entram no kit (`kit/sfx/`) e passam a valer para todos os vídeos, sem
+buscar de novo.
+
+Para isso:
+
+1. assine a [Epidemic Sound](https://www.epidemicsound.com) e entre na conta no
+   Google Chrome;
+2. instale a extensão **Claude in Chrome** (na Chrome Web Store) nesse Chrome e
+   entre com a mesma conta do Claude do passo 3;
+3. deixe o Chrome aberto quando pedir o primeiro vídeo.
+
+Sem a extensão e com o kit vazio, a composição para e pede para abrir o Chrome: o
+OmniVideo nunca usa um áudio de outra fonte.
+
+<!-- step: first-video -->
+## 7. O primeiro vídeo
+
+Clique em **Criar vídeo**:
+
+1. cole o pedido: um roteiro pronto, um tema, um material ou um link;
+2. escolha o formato (vertical 9:16 ou horizontal 16:9), a voz e o estilo visual de
+   estilo (ou deixe o agente escolher);
+3. clique em **Criar e começar**.
+
+![Criar vídeo](onboarding/new-video.png)
+
+Daí o Claude trabalha sozinho e a tela do vídeo mostra cada etapa no stepper. Ele para
+duas vezes para você:
+
+- **O roteiro.** Aprove, peça alteração ou edite o texto. Se ninguém mexer, ele se
+  aprova sozinho em 10 min.
+- **As cenas.** Depois do roteiro de motion, cada cena aparece como um still para
+  aprovar ou pedir alteração. Se ninguém mexer, elas se aprovam sozinhas em 10 min.
+
+Aprovadas as cenas, composição, narração, voz, render, legenda e montagem rodam até
+o MP4, que aparece na
+etapa **Exportação** e fica em `videos/<data-slug>/export/`. O tempo depende do
+tamanho do vídeo; a tela mostra o que está rodando e a fila da máquina.
+
+<!-- step: publish -->
+## 8. Publicar nas redes (opcional)
+
+Com o vídeo pronto, a etapa **Publicar** sobe o MP4 no YouTube, no Instagram e no
+TikTok, agora ou num dia e hora marcados na **Agenda**. O título, a descrição e a
+legenda o Claude escreve a partir do roteiro, e você edita antes.
+
+![Publicar](onboarding/publish.png)
+
+Cada rede precisa de um app de desenvolvedor seu, criado uma vez. Conecte em
+**Configurações → Plataformas**; o passo a passo de cada uma (Google Cloud, Meta e
+TikTok) está em [`reference/publish.md`](../reference/publish.md). O Instagram
+busca o vídeo por um túnel temporário do `cloudflared` (`brew install cloudflared`).
+
+Publicar é sempre um pedido seu: nada sobe sozinho, a menos que você ligue a
+publicação automática em **Configurações → Publicação**.