Editframe CLI

Editframe CLI

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

• references/render.md — Render compositions to MP4 locally
• references/preview.md — Preview compositions in the browser

Media

• references/transcribe.md — Generate captions from audio/video

Cloud

• references/cloud-render.md — Render in the Editframe cloud

Utilities

• references/utilities.md — Auth, dependency check, webhook testing