Sign inSign up

ilovevideoeditor/cli

By ilovevideoeditor

•Updated 3 months ago

Render videos from VideoJSON specs in your terminal or CI/CD — official iLoveVideoEditor CLI

Image
0

349

ilovevideoeditor/cli repository overview

⁠ilovevideoeditor

Official CLI for iLoveVideoEditor⁠ — render videos from VideoJSON specs in your terminal or CI/CD pipeline.

Multi-arch image (linux/amd64 + linux/arm64), rebuilt on every release tag.

⁠Usage

export ILOVEVIDEOEDITOR_API_KEY=vf_live_...
docker run --rm -e ILOVEVIDEOEDITOR_API_KEY -v "$PWD:/work" \
  ilovevideoeditor/cli render video.json -o out.mp4

Get an API key from the dashboard⁠. All install channels are listed at ilovevideoeditor.com/install⁠.

⁠Commands

CommandDescription
render <spec.json>Queue a render and wait for the MP4
status <job-id>Check render status
estimate <spec.json>Estimate credit cost before rendering
templatesList the 249+ public templates
⁠Flags
FlagDescription
-o, --output <file>Download the rendered video to a file
--no-waitQueue and exit immediately (returns the job ID)
--jsonMachine-readable JSON output (for CI)
--search <query>Filter templates by name/id
--api-key <key>API key (env: ILOVEVIDEOEDITOR_API_KEY)
--api-base <url>API base URL override (env: ILOVEVIDEOEDITOR_API_BASE)

⁠Examples

Render and download:

docker run --rm -e ILOVEVIDEOEDITOR_API_KEY -v "$PWD:/work" \
  ilovevideoeditor/cli render video.json -o promo.mp4

Fire-and-forget (queue only, JSON output for CI):

docker run --rm -e ILOVEVIDEOEDITOR_API_KEY \
  ilovevideoeditor/cli render video.json --no-wait --json
# {
#   "jobId": "425ba18a-dab0-4827-afc9-eec80e5b3c20",
#   "status": "queued"
# }

Estimate cost before spending credits:

docker run --rm -e ILOVEVIDEOEDITOR_API_KEY -v "$PWD:/work" \
  ilovevideoeditor/cli estimate video.json
# cost: 0.04 credits
# duration: 2s
# resolution: 640x360 @ 30fps

⁠VideoJSON

A VideoJSON spec describes the scene: layers, text, images, animations, and timing. Generate one with the fluent API⁠:

import ILoveVideoEditor from '@ilovevideoeditor/core';

const $ = new ILoveVideoEditor({ name: 'Promo', width: 1920, height: 1080, fps: 30 });
$.addText({ text: 'Hello', fontSize: 12, color: '#fff' });
$.wait('3s');
console.log(JSON.stringify(await $.compile()));

⁠Source

github.com/ilovevideoeditor/cli⁠ — MIT license.

Tag summary

Content type

Image

Digest

sha256:a76ba412e…

Size

76.7 MB

Last updated

3 months ago

docker pull ilovevideoeditor/cli