Editframe
Start
/
CLI Tools

Editframe CLI

The Development Loop

1. npm create @editframe     ← scaffold a project (editframe-create skill)
2. npx editframe preview     ← open in browser with hot-reload
3. edit composition files    ← iterate
4. npx editframe render -o output.mp4  ← render to MP4 locally
5. npx editframe cloud-render          ← (optional) render in the cloud

Which command for which need:

NeedCommand
Iterate on composition in browserpreview
Export to MP4 (local)render
Render from already-running dev serverrender --url http://localhost:4321
Render with dynamic datarender --data '{"key":"val"}'
Generate captions from audiotranscribe
Render in Editframe cloudcloud-render

Quick Start

# Render a composition to video
npx editframe render -o output.mp4


# Render from a URL
npx editframe render --url http://localhost:4321 -o output.mp4


# Preview a project
npx editframe preview


# Generate captions
npx editframe transcribe video.mp4 -o captions.json

Installation

The CLI is included in all Editframe project templates. To use standalone:

npx @editframe/cli <command>

Or install globally:

npm install -g @editframe/cli

Global Options

  • -t, --token <token> — API token (or EF_TOKEN env var)
  • --ef-host <host> — Editframe host (default: https://editframe.com)
  • -V, --version — Show version
  • -h, --help — Show help

Commands

Local Development

Media

Cloud

Utilities