Documentation

The documents

Quick start

You need Node ≥ 22.18 and ffmpeg with ffprobe on your PATH (macOS: brew install ffmpeg node).

git clone https://github.com/lampo-vr/lampo.git && cd lampo
npm install
npm start          # http://localhost:4747, signed in as you (builds the UI on first start)
npm run link       # puts lampo in ~/.local/bin (and says if that is not on your PATH)

Press A (Add video) to add a render: drop or choose files to upload a copy, or Link a file on this machine to review it where it lives (rendering again to the same path adds the next version), then pick its project and the agent that should act on the notes. Nothing is scanned; the tool only reads the files you add. Your owner account is created on first start; set an email and a password in Settings → Profile to sign in from your phone or another computer.

Working with an agent? Connect it in Settings → Connect an agent and tell it Use Lampo for "<project>": it puts V1 up itself (For agents). Until there is a video, the empty library offers Ask Claude Code to make one (or whichever agent you connected), with the prompt copied for you.

No footage at hand? npm run demo renders synthetic clips and builds a review history on a throwaway store: notes, an agent's fixes, a re-render with its diff, a review link and an approval. Ctrl+C deletes it again.

More ways to run it:

npm run dev        # the same with hot reload, for UI work
npm run lan        # also on your Wi-Fi (prints a link with an access token for your phone)

Where things live, and every setting: docs/configuration.md. In short, a fresh install keeps its store in ~/.video-review/:

• data/ holds the reviews;
• versions/ holds every render and can't be regenerated;
• cache/ is rebuilt on demand and safe to delete while the app is stopped, except cache/uploads/ (uploads in flight).

Voice notes are transcribed on your machine by transcribe.cpp (installed with npm install, no Python): Whisper large-v3-turbo when there is a GPU (Apple Silicon, CUDA, Vulkan), Parakeet v3 on CPU-only machines. The model downloads once, on the first voice note. Details and an OpenAI-compatible server option: docs/speech.md.

Run it as a server

A server is for a team, or for sharing reviews with clients without a tunnel. This repository is the whole app: self-hosted, it is complete and has no limits, except that hiding the Powered by Lampo badge on review links is a feature of Lampo Cloud's paid plans. The maintainers also run it as a hosted service, Lampo Cloud (lampo.video), for those who'd rather not run their own; its plans and billing come from a separate module that is not part of this repository and that a self-hosted server doesn't need (docs/server-mode.md):

cp .env.example .env      # set LAMPO_DOMAIN and LAMPO_PUBLIC_URL (LAMPO_TRUST_PROXY=uniquelocal
                          # is already set), and storage for Bunny or S3 (.env is gitignored)
docker compose up -d      # the app behind Caddy, with automatic HTTPS
docker compose logs       # the first start prints a one-time setup token

Open your URL, enter the token and create the owner account. Then invite people, upload renders (drop them on the library, or lampo push), keep each project's material in its Files tab, and connect agents: through Settings → Connect an agent (a chat app by its connector address, signing in once), or lampo login, which signs in through the browser and gives lampo and the stdio MCP server an API token:

lampo login https://review.example.com
lampo push render.mp4 --folder "Acme/Reels"   # the same name again becomes V2, V3, …
lampo render --to render.mp4 --out out/v3.mp4 -- \
  npx remotion render src/index.ts Main out/v3.mp4   # the progress shows in Lampo, then V3

docs/docker.md covers the image, volumes, upgrades and backups. docs/server-mode.md covers configuration, the reverse proxy, accounts and workspaces, storage (Bunny, S3) and the security model. Going live for real: docs/go-live.md, the runbook for one server (DNS, TLS, backups with a restore drill, monitoring, updates), with node scripts/smoke.ts https://review.example.com to check a running instance.

Keys