Docs

Kavio CLI reference.

The local CLI validates compositions, inspects render eligibility, migrates supported formats, starts browser previews, and renders export jobs.

Commands

validate: Validate a Kavio composition file and report schema or composition errors.
inspect: Print duration, dimensions, asset counts, layer counts, audio, exports, whole-composition eligibility, and browser/FFmpeg support for every transition window.
migrate: Run supported migration scaffolding for composition documents.
preview: Start a local preview server for scrubbing, playback, safe zones, and export-aspect overrides.

Examples

node packages/cli/dist/index.js validate examples/basic-json/composition.json
node packages/cli/dist/index.js inspect examples/basic-json/composition.json
node packages/cli/dist/index.js preview examples/basic-json/composition.json

Use --json for machine-readable output where supported.

node packages/cli/dist/index.js --json validate examples/basic-json/composition.json
node packages/cli/dist/index.js --json inspect examples/transition-series/composition.json

Text inspection labels each transition as an FFmpeg filter or browser only. JSON includes the complete support object:

{
  "transitionType": "grayscaleDissolve",
  "renderSupport": {
    "browser": { "supported": true },
    "ffmpegDirect": { "supported": true, "filter": "fadegrays" }
  }
}

Render

The general kavio render command supports video, still, and PNG-sequence exports. Use --render-mode auto to pick FFmpeg-direct for eligible compositions and browser-overlay otherwise. --capture-parallelism controls browser pages per job, while --concurrency controls batch jobs. It can render every export by default, or one named export with --export, and supports props, batch rows, output directories, fail-fast, and JSON output.