Docs

Kavio CLI reference.

The local CLI validates compositions, inspects timelines, migrates supported formats, and starts browser previews.

Commands

validate: Validate a Kavio composition file and report schema or composition errors.
inspect: Print duration, dimensions, asset counts, layer counts, audio, and export presets.
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

Render

The general kavio render command supports opaque mp4, webm, and mov outputs. It can render every export by default, or one named export with --export, and supports props, batch rows, output directories, concurrency, fail-fast, and JSON output.