cueframe

Agent-native CLI for CueFrame — turn media into rendered video from the terminal. Every command speaks --json (an NDJSON event stream) and the binary self-describes via cueframe describe --json, so agents can drive it without guesswork.

Preview release. Early-access build for invited testers, connected to the hosted CueFrame service.

Install

npx cueframe@latest --help      # zero-install
# or
npm i -g cueframe               # global `cueframe`

Authenticate

cueframe auth <cf_live_… key>        # static API key (CI / headless)
# or
cueframe login                       # OAuth device flow (browser)

The key can also be supplied via the CUEFRAME_API_KEY environment variable.

Quick start — upload → author → render

# 1. Register media (video / image / audio)
cueframe upload ./source.mp4 --json              # → mediaItemId

# 2. Create a project (sets aspect / format)
cueframe project create -n promo -a 9:16 --json  # → projectId

# 3. Author the composition — tracks of clips, per-clip reframe/trim,
#    optional captions. The composition is the source of truth.
cueframe composition put <projectId> -b @composition.json

# 4. Render the saved composition to MP4 (queues, SSE-watches, downloads)
cueframe render <projectId> -o out.mp4 --json

render takes only a project id and renders whatever composition is saved on it — no clip suggestion required. Run cueframe describe --json for the full composition schema and every command + flag.

Let CueFrame pick the clip (podcast → short)

cueframe upload ./long.mp4 --analyze --json                 # media + AI clip suggestions
cueframe clips <mediaItemId> --json                         # list suggestions (sug_…)
cueframe project create -n short -a 9:16 --from-suggestion <sug_…> --json
cueframe render <projectId> -o short.mp4 --json

Both paths converge on render; the suggestion on-ramp just authors the composition for you instead of you hand-writing it.

Install the agent skill

Drop the usage skill into your agent so Claude Code / Cursor / Codex know how to drive the CLI:

cueframe install                     # → ~/.claude/skills/cueframe-cli

For agents

• --json everywhere — NDJSON lifecycle: <verb>_prepare → <verb>_progress* → <verb>_complete | error, plus a non-zero exit on failure.
• cueframe describe --json — the full command tree as structured JSON.
• cueframe api <METHOD> <path> — raw escape hatch over the v1 API.

Common commands

| Need to… | Command | |---|---| | List projects | cueframe list | | Read a composition + ETag | cueframe composition get <projectId> --json | | Write a composition | cueframe composition put <projectId> -b @comp.json | | Export to Final Cut / Premiere | cueframe export fcpxml \| premiere <projectId> -s <sug_…> --wait -o cut.zip | | Validate without mutating | append --dry-run |

© CueFrame — preview release.