Docs

vCut is a local video studio (Node + ffmpeg on your machine) with a Cloudflare Pages gate for download, install help, and updates. Source video stays on your computer — ffmpeg never runs on Cloudflare.

Install

Start on the gate — download the package, follow the OS-specific wizard, then click Check again and Open editor.

1. Open the gate → Download (top bar).
2. Extract the archive and run docker compose up --build (recommended) or the native install script.
3. Return to the gate → Check again → Open editor at http://127.0.0.1:4321.

New user — Docker (recommended)

After extracting the download package (folder contains docker-compose.yml):

docker compose up --build

Boot log should show auto-captions: on (whisper.cpp) when using the Docker image.

Native install (no Docker):

./scripts/install.sh          # macOS / Linux
.\scripts\install.ps1         # Windows PowerShell

Requires Node.js 18+ and ffmpeg on PATH.

Existing user — update

1. Open the gate — if an update is available, click Update or Download.
2. Stop the running agent, replace your folder, run docker compose up --build again.
3. Point VCUT_UPDATE_URL at this site’s latest.json (optional; enables in-editor update banner).

Updates

Version feed: latest.json

{
  "version": "2.69.0",
  "url": "https://YOUR_PAGES_HOST/index.html#update",
  "notes": "Release notes…",
  "sha256": "…",
  "download": {
    "url": "https://YOUR_PAGES_HOST/downloads/vcut-2.69.0.tar.gz",
    "filename": "vcut-2.69.0.tar.gz",
    "size": 1234567
  }
}

After deploy, run ./scripts/set-pages-host.sh https://YOUR_PAGES_HOST or ./scripts/pages-deploy.sh with VCUT_PAGES_HOST set.

Docker

docker compose up --build

Operator / UAT testing

For internal testing with accounts, docs links, and gate health checks from Pages:

VCUT_AUTH=on
VCUT_DOCS_URL=https://YOUR_PAGES_HOST
VCUT_UPDATE_URL=https://YOUR_PAGES_HOST/latest.json
VCUT_CORS_ORIGINS=https://YOUR_PAGES_HOST

UAT Docker overlay:

docker compose -f docker-compose.yml -f deploy/docker-compose.uat.yml up --build

Or ./scripts/uat-agent-up.sh. See repo docs/UAT.md and deploy/README.md.

Cloudflare Tunnel

Optional: expose one always-on operator agent without opening ports. See repo deploy/README.md.

Auth

• Open mode (default) — no login.
• Accounts — VCUT_AUTH=on. Users sign up / sign in; files isolated under VCUT_DATA_DIR.

Tool help

In the editor, click (i) on any tool for a quick note, Ask assistant, or Open docs (these anchors).