Kavio

Docs

Getting started with Kavio.

Kavio is currently used from the repository workspace. Published npm packages are not available yet.

Requirements

Install And Build

Install dependencies with lifecycle scripts disabled, then build all packages.

corepack pnpm install --ignore-scripts
corepack pnpm run build

Run the full local verification suite when making changes.

corepack pnpm test

Validate A Composition

The smallest useful example is the basic JSON composition.

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

Expected output:

Valid Kavio composition: /absolute/path/to/examples/basic-json/composition.json

Inspect And Preview

Inspect prints duration, canvas dimensions, assets, layer counts, audio, and exports.

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

Preview starts a local browser preview server and prints a URL.

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

Next Steps

Learn conceptsComposition, frames, props, assets, layers, exports, and batch jobs. Author templatesUse raw JSON or the TypeScript builder to create canonical Kavio JSON. Explore examplesSee basic JSON, builder, MVP demo, and visual fixtures. Understand renderingOpaque video render works today; some formats remain pre-release work.