About editframe-cli
editframe-cli is a command-line tool for Editframe projects, supporting project previews, video rendering and media tasks. It provides local MP4 rendering, cloud rendering and caption generation from audio or video.
Key features
- 01Render MP4 locally
- 02Render from a URL
- 03Preview projects in a browser
- 04Render in the cloud
- 05Generate audio/video captions
Use cases
- 01Render a composition to MP4
- 02Preview a project in a browser
- 03Generate captions from audio or video
Install
Copy the command and run it in a terminal.
$
npx skills add https:/ / github.com/ editframe/ skills --skill editframe-cliAfter installing, type/editframe-cliin Claude Code to confirm it loaded.
Bundled files
References and scripts installed along with SKILL.md.
references/cloud-render.mdpreview.mdrender.mdtranscribe.mdutilities.mdDetails
From the project READMEEditframe 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 (orEF_TOKENenv 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
Comments
Markdown supported