@mevdragon/vidfarm-devcli 0.2.1 → 0.2.3

package/.env.example

@@ -1,48 +1,15 @@
 NODE_ENV="development"
 PORT="3000"
 
-VIDFARM_DB_PATH="./data/vidfarm.sqlite"
-VIDFARM_DATA_DIR="./data"
-
-ENCRYPTION_SECRET="replace-with-a-long-random-secret"
-API_KEY_SALT="replace-with-a-second-long-random-secret"
-WEBHOOK_SECRET="replace-with-a-third-long-random-secret"
-
-WORKER_POLL_MS="1500"
-WORKER_BATCH_SIZE="2"
-WORKER_MAX_CONCURRENT_JOBS="1"
-DEFAULT_JOB_DELAY_SECONDS="20"
-MAX_PENDING_JOBS_GLOBAL="0"
-MAX_PENDING_JOBS_PER_CUSTOMER="0"
-
-PUBLIC_BASE_URL="https://vidfarm.cloud.zoomgtm.com"
-VIDFARM_ADMIN_EMAILS="admin@example.com"
-VIDFARM_DEVELOPER_EMAILS="developer@example.com,operator@zoom-gtm.com,entropyinternetorg@gmail.com"
-TEMPLATE_SOURCE_ROOT="./data/template-sources"
-STORAGE_DRIVER="local"
-AWS_REGION="us-east-1"
-AWS_S3_BUCKET=""
-AWS_S3_PUBLIC_READ="false"
-AWS_S3_ENDPOINT=""
-AWS_ACCESS_KEY_ID=""
-AWS_SECRET_ACCESS_KEY=""
-
-RESEND_API_KEY=""
-RESEND_FROM_EMAIL="vidfarm@fwd.zoomgtm.com"
-
 OPENAI_API_KEY=""
 OPENROUTER_API_KEY=""
 GEMINI_API_KEY=""
 PERPLEXITY_API_KEY=""
 
-REMOTION_FUNCTION_NAME=""
-REMOTION_REGION="us-east-1"
-REMOTION_BUCKET_NAME=""
-REMOTION_SITE_NAME="vidfarm-template-0000"
-REMOTION_SERVE_URL=""
-REMOTION_COMPOSITION_ID="template-0000"
-REMOTION_AWS_ACCESS_KEY_ID=""
-REMOTION_AWS_SECRET_ACCESS_KEY=""
-REMOTION_MODE="auto"
+# Optional when calling a hosted Vidfarm API directly.
+VIDFARM_USER_ID=""
+VIDFARM_API_KEY=""
 
-MOCK_PROVIDER_RESPONSES="true"
+# Optional local overrides. The CLI will choose sensible local defaults.
+PUBLIC_BASE_URL="http://localhost:3310"
+REMOTION_MODE="local"

package/GETTING_STARTED.developers.md

@@ -0,0 +1,87 @@
+# Vidfarm Developers
+
+## Interview Phase
+
+Prepare for your Interview:
+
+1. Browse the Winning Formats Gallery of viral TikTok videos here. These are samples of what you'd be recreating for customers:
+   https://winning-formats-gallery-tiktok.cloud.zoomgtm.com/
+
+2. Setup OpenAI Codex on your computer with free tier. This is your primary AI coding agent (really good to know, even for future jobs)
+   https://developers.openai.com/codex/cli
+   https://www.youtube.com/watch?v=GJsx_FuiwNg
+
+3. Setup Remotion Skill on your computer. Codex will handle all the coding work, you just need to be able to get it to render the output videos/images. no need for suno, just image gen is enough.
+   https://www.youtube.com/watch?v=Xdy1vkhSz-M
+
+4. You’ll need to acquire an ai api key that can generate images at least. There’s many free and paid ones out there. Part of the skills test is to be resourceful and find it so you can test with (hint: check huggingface, openrouter, and ask codex to suggest others). You will not be penalized for using a weaker free ai
+
+5. Once you are ready, request the interview with @zoom_gtm and he will give you the skills test, gemini api key, and invite to first week trial run hands on helping customers (you will be paid for your time). You'd be recreating from the winning formats gallery
+
+The skills test:
+
+try to build your own workflow in VSCode + Codex cli + prompt.md files to generate a winning template. It should be easy to re-run your template to generate infinite content of that type. You may ask codex to explain what I mean
+
+## Pre-Setup for Skills Test
+
+Hello Creative Directors! You can
+
+1. Create a Github account and setup SSH key so you can save your work & login on github CLI (ask codex how):
+   https://github.com
+
+2. Create an NPM account and login on npm CLI (ask codex how):
+   https://www.npmjs.com
+
+3. DM me your github username & npm username. congrats! you are a developer now
+
+4. Make sure you are familiar with codex & api keys prepared and have tried all of the above. I will provide a gemini ai api key for the skills test.
+
+MAKE SURE YOU ARE PREPARED. If I have to babysit you during the call, I will immediatlely end the interview early to not waste anyones time.
+
+5. Final step, schedule your 1:1 skills test interview. do not book time until you have finished prior steps.
+
+https://calendly.com/zoom-gtm/creative-director-interviews
+
+## Setup for Job
+
+0. Tell your manager your email so he can whitelist you access to Vidfarm. After he confirms you have access, login at https://vidfarm.cloud.zoomgtm.com
+
+1. Open VSCode in a new project called "Vidfarm-Developer"
+
+2. Open terminal and login to github cli and npm cli (ask ai/codex if you need help). ask your manager if they gave you npm access to "vidfarm-devcli" yet.
+
+3. Open Codex cli in terminal, with /permissions set to "Full Access"
+
+4. Install the private skill by copying it from https://vidfarm.cloud.zoomgtm.com/settings in "Developer SKILL.md" button and pasting it into the below prompt for codex.
+
+```txt
+Please take this agent skill and install it locally. Then install the vidfarm-devcli from npm, ask me for the otp if need, I will enter it. Here is the agent skill: [pasted]
+```
+
+5. Create a .env file at folder root with your AI API KEY. You need at least 1 of 3 and it doesn't matter which. We recommend Gemini. Ask your manager for an AI API key.
+
+```.env
+GEMINI_API_KEY="______"
+OPENAI_API_KEY="______"
+OPENROUTER_API_KEY="______"
+```
+
+6. Extend that .env file with another secret VIDFARM_API_KEY, you can get it at https://vidfarm.cloud.zoomgtm.com/settings
+
+```.env
+VIDFARM_API_KEY="_______"
+```
+
+6. Create a new folder called `src/`, this is where we are going to do most of our development work.
+
+7. Tell codex to:
+
+```txt
+use the vidfarm-devcli to copy-reference-template into src/vidfarm_template_0000 so i can view it as example
+```
+
+That will populate with a reference folder of what a template code looks like. We are going to create a new template.
+
+8. Create a new folder beside src called `drafts/` which is where we will put messy files when needed.
+
+9. Now find an easy winning format from https://winning-formats-gallery-tiktok.cloud.zoomgtm.com/ and save the image to your drafts/ folder. then tell Codex to look at that image (right click, copy relative path, paste to codex), then tell codex please make a new template based on the image.

package/README.md

@@ -1,300 +1,156 @@
-# Vidfarm
+# Vidfarm Dev CLI
 
-Vidfarm is a single-container Node.js control plane for async video template pipelines. It follows the architecture in [video-pipeline-architecture-draft.md](/Users/localghost/Projects/OfficeX/OfficeX/ZoomGTM/vidfarm/video-pipeline-architecture-draft.md) and [PLATFORM_SPEC.md](/Users/localghost/Projects/OfficeX/OfficeX/ZoomGTM/vidfarm/PLATFORM_SPEC.md): Hono API, SQLite-backed jobs and provider-key leasing, S3-compatible storage, and an in-process worker suitable for Docker on EC2.
+`@mevdragon/vidfarm-devcli` is the local development toolkit for third-party Vidfarm template authors.
 
-Production is now intended to run as one HTTPS host at `https://vidfarm.cloud.zoomgtm.com`, with the HTML console served from `/` and the API served under `/api/v1/...`.
+This package is intentionally scoped to:
 
-## What Is Included
+- building templates under `templates/*`
+- running the local Vidfarm API and worker
+- testing template operations as async jobs
+- validating template metadata, skills, and smoke test payloads
+- rendering Remotion locally when a template uses Remotion
 
-- Unified frontend and backend on one host
-- Async template API under `/api/v1/templates/:templateId/*`
-- User auth/profile/provider-key routes under `/api/v1/user/*`
-- Email OTP login with API key issuance
-- `is_developer` user flag, assigned from allowlisted emails, required for template source submission
-- Customer-scoped provider key vault with encryption at rest
-- SQLite-backed job queue and provider-key lease coordination
-- Structured job logs, artifacts, billing events, and webhook delivery queue
-- Local storage mode plus S3-compatible mode for AWS
-- Remotion adapter seam and a sample `template_0000` slideshow pipeline
+It is intentionally not documentation for platform internals, production deployment, admin release flow, or shared cloud infrastructure.
 
 ## Quick Start
 
-```bash
-npm install
-cp .env.example .env
-npm run dev
-```
-
-The service starts on `http://localhost:3000` by default and creates SQLite plus local artifact storage under `./data`.
-
-## Template Developer CLI
-
-For local template development, use the bundled CLI instead of manually wiring auth, provider keys, SQLite, and Remotion:
+1. Create a local `.env` from the example file.
+2. Add at least one AI provider key.
+3. Start the local CLI runtime.
 
 ```bash
-npm install
+cp .env.example .env
 npx @mevdragon/vidfarm-devcli dev --port 3310 --reset
 ```
 
-What it does:
-
-- starts the same REST API and in-process worker as production
-- provisions a local SQLite database automatically
-- uses local filesystem storage as an S3 stand-in
-- seeds a dev customer and API key
-- seeds provider keys from local `.env` variables like `OPENAI_API_KEY`, `GEMINI_API_KEY`, and `OPENROUTER_API_KEY`
-- falls back to mock provider keys plus mocked AI responses when no env keys are present
-- renders Remotion compositions locally instead of using Lambda
-
 Useful commands:
 
 ```bash
 npx @mevdragon/vidfarm-devcli dev --port 3310 --reset
 npx @mevdragon/vidfarm-devcli session
 npx @mevdragon/vidfarm-devcli validate-template --template-id template_0000
-npx @mevdragon/vidfarm-devcli generate-template --slug-id template_0001 --template-dir ./templates/template_0001
-npx @mevdragon/vidfarm-devcli analyze-viral-dna --template-dir ./templates/template_0001
-npx @mevdragon/vidfarm-devcli analyze-visual-dna --template-dir ./templates/template_0001
+npx @mevdragon/vidfarm-devcli copy-reference-template --template-dir ./src/vidfarm_template_0000
+npx @mevdragon/vidfarm-devcli generate-template --slug-id template_0001 --template-dir ./templates/vidfarm_template_0001
+npx @mevdragon/vidfarm-devcli analyze-viral-dna --template-dir ./templates/vidfarm_template_0001
+npx @mevdragon/vidfarm-devcli analyze-visual-dna --template-dir ./templates/vidfarm_template_0001
+npx @mevdragon/vidfarm-devcli presign-preview-media --file ./drafts/preview/example.png --directory drafts/preview
 ```
 
-After install, the package also exposes `vidfarm` and `vidfarm-devcli` as local binaries.
-
-`vidfarm session` prints reusable auth headers and a sample `curl` request for the local REST API.
-
-`generate-template` now scaffolds a standard `research/` area for new templates:
-
-- `research/source_notes.md` for original-format notes
-- `research/preview/` for source screenshots or video
-- `src/template-dna.ts` as the checked-in metadata module that feeds `about.viral_dna`, `about.visual_dna`, and `about.link_to_original`
-
-If preview media is already present, or if you pass `--source-preview-dir`, scaffold generation will run both DNA analyzers automatically unless `--skip-dna-analysis` is set.
-
-## Environment
-
-Primary variables:
-
-- `PORT`
-- `VIDFARM_DB_PATH`
-- `VIDFARM_DATA_DIR`
-- `VIDFARM_ADMIN_EMAILS`
-- `TEMPLATE_SOURCE_ROOT`
-- `ENCRYPTION_SECRET`
-- `API_KEY_SALT`
-- `STORAGE_DRIVER=local|s3`
-- `AWS_REGION`
-- `AWS_S3_BUCKET`
-- `AWS_S3_PUBLIC_READ=true|false`
-- `PUBLIC_BASE_URL`
-- `RESEND_API_KEY`
-- `WEBHOOK_SECRET`
-- `MOCK_PROVIDER_RESPONSES=true|false`
-- `VIDFARM_DEVELOPER_EMAILS`
-- `WORKER_MAX_CONCURRENT_JOBS`
-- `MAX_PENDING_JOBS_GLOBAL`
-- `MAX_PENDING_JOBS_PER_CUSTOMER`
-
-Remotion-specific variables:
-
-- `REMOTION_REGION`
-- `REMOTION_FUNCTION_NAME`
-- `REMOTION_BUCKET_NAME`
-- `REMOTION_SITE_NAME`
-- `REMOTION_SERVE_URL`
-- `REMOTION_COMPOSITION_ID`
-- `REMOTION_AWS_ACCESS_KEY_ID`
-- `REMOTION_AWS_SECRET_ACCESS_KEY`
-
-When `MOCK_PROVIDER_RESPONSES=true`, AI provider calls use the real key-leasing flow but return mocked content. This makes local end-to-end testing possible without burning customer API calls.
-
-When using `npx @mevdragon/vidfarm-devcli dev`, the CLI automatically chooses local-friendly defaults:
-
-- `STORAGE_DRIVER=local`
-- `REMOTION_MODE=local`
-- a local SQLite path under `.vidfarm/local`
-- `MOCK_PROVIDER_RESPONSES=false` if real provider env keys are present, otherwise `true`
-
-## Remotion AWS
+After install, the package exposes both `vidfarm` and `vidfarm-devcli` as local binaries.
 
-For shared Remotion AWS infra, use [AWS_REMOTION_HANDOFF.md](/Users/localghost/Projects/OfficeX/OfficeX/ZoomGTM/vidfarm/AWS_REMOTION_HANDOFF.md) as the operating contract.
+## What The Local CLI Does
 
-Shared Remotion AWS publish is an admin-only release step. Template developers may build and test locally, but they should not push directly to the shared production Remotion account. The intended promotion flow is:
+The local CLI runs the same template contract used by the hosted platform, but with local-first defaults:
 
-1. developer pushes template code to GitHub `production`
-2. admin reviews and pins a commit SHA
-3. admin publishes the approved Remotion site bundle
-4. admin activates the approved template release
-5. admin rebuilds and redeploys the production Docker image
+- local SQLite state under `.vidfarm/local`
+- local filesystem storage instead of cloud object storage
+- local Remotion rendering
+- a seeded developer session for local testing
+- provider keys sourced from your local `.env`
+- mocked provider responses only when no real provider keys are present
 
-The key points verified on `2026-05-16` are:
+Use `vidfarm session` to print reusable auth headers and a sample `curl` request for the local REST API.
 
-- region: `us-east-1`
-- shared Lambda function: `remotion-render-4-0-355-mem2048mb-disk2048mb-180sec`
-- shared bucket: `remotionlambda-useast1-ujg7c0h43q`
-- Remotion package version to pin: `4.0.355`
+For hosted preview-media uploads, use `vidfarm-devcli presign-preview-media`. It calls the authenticated Vidfarm API with `VIDFARM_API_KEY` and returns a presigned PUT URL under `developer/<user_id>/preview_media/*` plus the resulting Vidfarm media URL.
 
-This repo also has separate Remotion AWS runner credentials available in local production env config via:
+## What The Hosted Platform Expects From Templates
 
-- `REMOTION_AWS_ACCESS_KEY_ID`
-- `REMOTION_AWS_SECRET_ACCESS_KEY`
+Vidfarm treats templates as async job producers, not as ad hoc endpoints.
 
-Use those for Remotion site publish/render work rather than assuming the generic app AWS credentials are the right identity.
+Each template should provide:
 
-Recommended repo-level config for real Remotion work:
-
-```env
-REMOTION_REGION=us-east-1
-REMOTION_FUNCTION_NAME=remotion-render-4-0-355-mem2048mb-disk2048mb-180sec
-REMOTION_BUCKET_NAME=remotionlambda-useast1-ujg7c0h43q
-REMOTION_SITE_NAME=your-site-name
-REMOTION_SERVE_URL=https://remotionlambda-useast1-ujg7c0h43q.s3.us-east-1.amazonaws.com/sites/your-site-name/index.html
-REMOTION_COMPOSITION_ID=YourComposition
-```
-
-If you wire real Lambda rendering into `src/services/remotion.ts`, preserve the current platform contract and make the service read these env vars rather than hard-coding one-off values.
-
-## API Flow
-
-1. `POST /api/v1/user/request-otp`
-2. `POST /api/v1/user/verify-otp`
-3. `POST /api/v1/user/me/provider-keys`
-4. `GET /api/v1/templates/template_0000`
-5. `GET /api/v1/templates/template_0000/skill`
-6. `POST /api/v1/templates/template_0000/config`
-7. `POST /api/v1/templates/template_0000/operations/create_slideshow`
-8. Poll `GET /api/v1/templates/template_0000/jobs/:jobId`
-9. List or filter jobs with `GET /api/v1/templates/template_0000/jobs?tracer=...&start_time=...&end_time=...`
-10. Stream timeline data from `GET /api/v1/templates/template_0000/jobs/:jobId/logs?start_time=...&end_time=...`
-
-## Template Release Flow
-
-Templates can still live in this repo, but the platform now supports a GitHub-backed release workflow for in-house templates:
-
-1. developer keeps template code in GitHub
-2. the approved branch convention is `production`
-3. admin registers the template source with repo URL, module path, build command, and `SKILL.md` path
-4. admin imports a specific commit, or the current `production` head
-5. platform builds the repo, loads the template module, and runs certification
-6. only certified releases can be activated
-7. activation pins the live template to a specific commit SHA, not a floating branch head
+- stable template metadata
+- a `SKILL.md` file for users and agents
+- a TypeScript entrypoint at `src/template.ts`
+- one or more named operations
+- workflow functions behind those operations
+- a `smokeTestPayload` for each operation
+- `about.viral_dna` and `about.visual_dna`
 
-Template management endpoints:
+At runtime, the platform uses the template wrapper to expose a consistent API shape:
 
-- `GET /api/v1/templates/sources`
-- `POST /api/v1/templates/sources`
-- `GET /api/v1/templates/releases`
-- `POST /api/v1/templates/sources/:sourceId/import`
-- `POST /api/v1/templates/releases/:releaseId/activate`
+- `GET /api/v1/templates/:templateId`
+- `GET /api/v1/templates/:templateId/skill`
+- `POST /api/v1/templates/:templateId/config`
+- `POST /api/v1/templates/:templateId/operations/:operationName`
+- `GET /api/v1/templates/:templateId/jobs/:jobId`
+- `GET /api/v1/templates/:templateId/jobs/:jobId/logs`
 
-`POST /api/v1/templates/sources` requires a user with `is_developer=true`. That flag is assigned from `VIDFARM_DEVELOPER_EMAILS` or `VIDFARM_ADMIN_EMAILS` during OTP verification. Registration now requires a self-issued UUIDv4 `template_id` plus a human-readable `slug_id`, and the platform rejects reused `template_id` values with an explicit conflict error. Import and activation remain admin-only via `VIDFARM_ADMIN_EMAILS`.
+Operations should return work through the job system rather than inventing one-off synchronous routes.
 
-## Template Certification
+## Approval Flow
 
-Every template must have:
+Third-party developers build and validate templates locally first.
 
-- a `SKILL.md` file for customer AI agents
-- both `about.viral_dna` and `about.visual_dna`
-- at least one operation
-- valid workflow references
-- a `smokeTestPayload` for each operation
+After handoff, a Vidfarm admin reviews the template before it is made available on the hosted platform. Template authors should assume there is an approval step between local development and production availability.
 
-Use the CLI locally before import/activation:
+## Template Deploy Cycle
 
-```bash
-npx @mevdragon/vidfarm-devcli validate-template --template-id template_0000
-```
+When someone says "template deploy cycle" in this repo, they mean this exact sequence:
 
-Not every template needs Remotion. Certification only requires Remotion behavior if the template itself calls `ctx.remotion`.
+1. commit and `git push` the repo that contains the template folder, such as `templates/vidfarm_template_<slug>/` inside a monorepo or a standalone template repo
+2. as the platform admin, pull/import that template commit into Vidfarm
+3. approve and activate the imported template release in the hosted platform
+4. run the prod deploy script if platform-runtime code changed, or reuse the current prod image if the change was template-only and you just need a formal deploy-cycle restart
 
-## Docker
+For `template_0000`, that usually means:
 
 ```bash
-docker compose up --build
+git -C templates/vidfarm_template_0000 push origin production
+# then run the platform operator command
+node dist/src/cli.js deploy-template-cycle \
+  --env-file .env.production \
+  --stack-name VidfarmProdStack \
+  --template-id 4c7a7e1a-7f35-4f30-9f86-9c8a63c7f2db \
+  --slug-id template_0000 \
+  --repo-url https://github.com/your-org/your-template-repo \
+  --branch production \
+  --template-module-path templates/vidfarm_template_0000/src/template.ts
 ```
 
-For local Docker, `docker-compose.yml` already mounts `./data:/app/data`, which keeps SQLite across container restarts and rebuilds on the same machine.
+The important distinction is:
 
-For production on EC2, the CDK stack mounts a dedicated EBS volume at `/var/lib/vidfarm` on the instance and binds it into the container as `/app/data`. That means the following survive shutdowns, reboots, and container updates:
+- template repo changes ship through template source import and activation
+- platform code changes ship through the root prod deploy script
+- multiple templates can live in one git repo as long as each template has its own folder and its `template_module_path` points at that folder's `src/template.ts`
 
-- `vidfarm.sqlite`
-- SQLite WAL/SHM files
-- imported template source checkouts
-- any local fallback runtime data under `/app/data`
+## Authentication Context
 
-Artifacts and workspace objects should still live in S3 in production:
+When calling a hosted Vidfarm API directly, authenticated requests use:
 
-```env
-STORAGE_DRIVER=s3
-AWS_REGION=us-east-1
-AWS_S3_BUCKET=your-vidfarm-bucket
-AWS_S3_PUBLIC_READ=false
-PUBLIC_BASE_URL=https://vidfarm.cloud.zoomgtm.com
-```
+- `vidfarm-user-id`
+- `vidfarm-api-key`
 
-Queue protection for small EC2 instances is now SQLite-backed and built into the app:
+The API key comes from Vidfarm login and settings, not from platform infrastructure secrets.
+If you need to discover the authenticated customer ID first, resolve it from `GET /api/v1/user/me` and then send both headers on subsequent requests.
 
-- `WORKER_MAX_CONCURRENT_JOBS=1` by default
-- `WORKER_BATCH_SIZE=2` by default
-- `MAX_PENDING_JOBS_GLOBAL=0` by default
-- `MAX_PENDING_JOBS_PER_CUSTOMER=0` by default
+For hosted template source registration, treat `template_module_path` as repo-relative and point it at the template's TypeScript entrypoint, for example `templates/vidfarm_template_hooks/src/template.ts`. Each template folder must start with `vidfarm_template_`. The import flow builds the repo and loads the compiled `src/template.js` sibling at activation time.
 
-With the default `0` values, submissions are always accepted and persisted in SQLite. The worker simply drains the queue at the configured concurrency. Set either pending-job value above `0` only if you later decide you want a hard backlog cap.
+For private GitHub repos, export `VIDFARM_GITHUB_TOKEN` (or `GITHUB_TOKEN`) before running `import-source-prod` or `deploy-template-cycle`. The prod operator command injects that token into the live container's git config for the import and keeps the stored `repo_url` clean.
 
-## AWS CDK Production
+For local CLI usage, the `session` command gives you a local seeded session so you can test without manually wiring auth state.
 
-The production CDK app lives under `infra/cdk` and provisions:
+## Provider Keys
 
-- one S3 bucket for Vidfarm object storage
-- one public ALB with HTTP to HTTPS redirect
-- one ACM certificate for `vidfarm.cloud.zoomgtm.com`
-- one EC2 instance running the Docker image
-- one dedicated encrypted EBS data volume retained separately from the container
-- Route53 `A` and `AAAA` alias records for the production hostname
+Templates should work with the developer's own upstream AI keys.
 
-Required shell variables before synth or deploy:
+Typical local `.env`:
 
-```bash
-export CDK_DEFAULT_ACCOUNT=123456789012
-export CDK_DEFAULT_REGION=us-east-1
-export VIDFARM_ZONE_NAME=cloud.zoomgtm.com
-export VIDFARM_ZONE_ID=Z1234567890ABC
-export VIDFARM_RECORD_NAME=vidfarm
-export VIDFARM_PUBLIC_BASE_URL=https://vidfarm.cloud.zoomgtm.com
-export VIDFARM_ADMIN_EMAILS=admin@zoomgtm.com
-export VIDFARM_DEVELOPER_EMAILS=dev1@zoomgtm.com,dev2@zoomgtm.com
-export VIDFARM_ENCRYPTION_SECRET='replace-with-a-long-random-secret'
-export VIDFARM_API_KEY_SALT='replace-with-a-second-long-random-secret'
-export VIDFARM_WEBHOOK_SECRET='replace-with-a-third-long-random-secret'
+```env
+GEMINI_API_KEY=""
+OPENAI_API_KEY=""
+OPENROUTER_API_KEY=""
+PERPLEXITY_API_KEY=""
 ```
 
-Optional app env passthroughs are supported too, including:
-
-- `VIDFARM_RESEND_API_KEY`
-- `VIDFARM_RESEND_FROM_EMAIL`
-- `VIDFARM_OPENAI_API_KEY`
-- `VIDFARM_OPENROUTER_API_KEY`
-- `VIDFARM_GEMINI_API_KEY`
-- `VIDFARM_PERPLEXITY_API_KEY`
-- `VIDFARM_REMOTION_*`
-- `VIDFARM_INSTANCE_TYPE`
-- `VIDFARM_DATA_VOLUME_SIZE_GIB`
-- `VIDFARM_WORKER_MAX_CONCURRENT_JOBS`
-- `VIDFARM_MAX_PENDING_JOBS_GLOBAL`
-- `VIDFARM_MAX_PENDING_JOBS_PER_CUSTOMER`
-
-If you do not set `VIDFARM_INSTANCE_TYPE`, the CDK app now defaults to `t3.small`.
+You usually only need one provider key to develop and test a template locally.
 
-Deploy flow:
+## Remotion
 
-```bash
-npm install
-npm run cdk:synth
-npx aws-cdk bootstrap aws://$CDK_DEFAULT_ACCOUNT/$CDK_DEFAULT_REGION
-npm run cdk:deploy
-```
+For third-party template authors, Remotion is local.
 
-The stack builds the Docker image locally, pushes it to an asset ECR repository, installs Docker on the EC2 host, mounts the retained EBS volume, writes the production env file, and runs the container as a systemd service.
+If your template uses `ctx.remotion`, develop and validate it locally through the CLI. This package does not document or require shared cloud Remotion infrastructure.
 
-## Notes
+## Next Read
 
-- `template_0000` is the canonical sample internal template slug. Its current sample `template_id` is `4c7a7e1a-7f35-4f30-9f86-9c8a63c7f2db`. Add more templates by registering them in [src/registry.ts](/Users/localghost/Projects/OfficeX/OfficeX/ZoomGTM/vidfarm/src/registry.ts).
-- Remotion is still stubbed behind [src/services/remotion.ts](/Users/localghost/Projects/OfficeX/OfficeX/ZoomGTM/vidfarm/src/services/remotion.ts). When upgrading it to real Lambda submission, follow [AWS_REMOTION_HANDOFF.md](/Users/localghost/Projects/OfficeX/OfficeX/ZoomGTM/vidfarm/AWS_REMOTION_HANDOFF.md) and use the Remotion-specific AWS credentials already available in local production env config.
+For the external template-author workflow, continue with [GETTING_STARTED.developers.md](./GETTING_STARTED.developers.md) and the example template in [`templates/template_0000`](./templates/template_0000).