Skip to content

Getting started

Node 24 or newer. Chrome for command-line renders.

Terminal window
npm install
npm test # the engine, the operations, the format, the interop, the editor's logic, the Worker, the API and the desktop storage
npm run typecheck
npm run dev # the editor on http://localhost:8787/ (local Worker, projects in .wrangler/state)
npm run site # the landing page and the docs (Astro) on http://localhost:4321/
npm run desktop:dev # the editor as a native window (Tauri 2), projects in Documents/Tramme

npm run dev rebuilds the editor on every change and runs the Worker locally (wrangler dev): R2 storage simulated on disk, no Cloudflare Access. It also starts the assistant’s companion, which pairs with this editor by itself (TRAMME_NO_COMPANION=1 to go without it). The home screen starts a film from words: describe it, add its material if there is any, pick a format, and the project opens in the studio with the assistant at work. A blank project, a video, a .tramme file, a Lottie animation and the examples are there too.

For the assistant with another local page, in a second terminal:

Terminal window
npm run tramme -- agent # companion: Claude with this machine's Claude Code login

then paste the token it prints in the editor (Assistant, settings). See The assistant.