CLI v1.0.0 — published to 8 registries

Install iLoveVideoEditor

Render MP4 videos from VideoJSON specs in your terminal or CI/CD pipeline. Pick your platform — every channel ships the same CLI.

First: get an API key

Create a key in the dashboard under Account > API Keys, then export it:

terminal
export ILOVEVIDEOEDITOR_API_KEY=vf_live_...
npx ilovevideoeditor render video.json -o out.mp4

Install the CLI

npm

macOS, Linux, Windows — requires Node.js 18+

terminal
npm install -g ilovevideoeditor

# or run without installing
npx ilovevideoeditor render video.json -o out.mp4
npmjs.com/package/ilovevideoeditor

Homebrew

macOS & Linux — native binary, no Node.js required

terminal
brew tap ilovevideoeditor/tap
brew install ilovevideoeditor
github.com/ilovevideoeditor/homebrew-tap

Docker

Any OS with Docker — multi-arch (amd64 + arm64), ideal for CI/CD

terminal
# Docker Hub
docker run --rm -e ILOVEVIDEOEDITOR_API_KEY -v "$PWD:/work" \
  ilovevideoeditor/cli render video.json -o out.mp4

# GitHub Container Registry
docker run --rm -e ILOVEVIDEOEDITOR_API_KEY -v "$PWD:/work" \
  ghcr.io/ilovevideoeditor/cli render video.json -o out.mp4
hub.docker.com/r/ilovevideoeditor/cli

winget

Windows 10/11 — native binary

terminal
winget install ilovevideoeditor
Listing in review — microsoft/winget-pkgs#402460

Scoop

Windows — native binary, no admin rights required

terminal
scoop bucket add ilovevideoeditor https://github.com/ilovevideoeditor/scoop-bucket
scoop install ilovevideoeditor
github.com/ilovevideoeditor/scoop-bucket

AUR (Arch Linux)

Arch Linux & derivatives — source package built from the npm tarball

terminal
yay -S ilovevideoeditor
# or: paru -S ilovevideoeditor
aur.archlinux.org/packages/ilovevideoeditor

SDKs for your stack

Prefer code over CLI? The core composition library and the typed REST SDKs are published to language-native registries.

JSR — @ilovevideoeditor/core

Deno & Bun — TypeScript-first core library for composing VideoJSON scenes

terminal
# Deno
deno add jsr:@ilovevideoeditor/core

# Bun / Node (via JSR)
npx jsr add @ilovevideoeditor/core
jsr.io/@ilovevideoeditor/core

NuGet — iLoveVideoEditor.Sdk

.NET / C# — typed SDK generated from the OpenAPI spec

terminal
dotnet add package iLoveVideoEditor.Sdk
nuget.org/packages/iLoveVideoEditor.Sdk

Verify your install

terminal
ilovevideoeditor --version
ilovevideoeditor templates --search promo --json

Frequently asked questions

Which install method should I use?

If you already have Node.js 18+, npm or npx is the fastest path. On macOS and Linux, Homebrew gives you a native binary with no Node.js dependency. On Windows, use winget or Scoop. For CI/CD pipelines, the Docker image is the most reproducible option — it is multi-arch (amd64 and arm64) and needs no local toolchain.

Do I need an API key?

Yes. Every render goes through the iLoveVideoEditor cloud API. Create a key in the dashboard under Account > API Keys, then export it as ILOVEVIDEOEDITOR_API_KEY or pass it with the --api-key flag. The key is only shown once, so store it like a password.

What can I do with the CLI?

The CLI renders videos from VideoJSON specs: ilovevideoeditor render video.json -o out.mp4 queues a render and downloads the MP4. You can also check job status, estimate credit cost before rendering, and browse the 249+ public templates — all scriptable with the --json and --no-wait flags for CI.

Is the Docker image kept up to date?

Yes. The ilovevideoeditor/cli image is rebuilt and pushed to both Docker Hub and GHCR on every release tag, as linux/amd64 and linux/arm64. Pin a version with ilovevideoeditor/cli:1.0.0 or track latest.

Where is the source code?

The CLI is open source under the MIT license at github.com/ilovevideoeditor/cli, and the core composition library lives at github.com/ilovevideoeditor/video-frames. Binaries are compiled with Bun during the release workflow; the same code is published to npm.