Command line
The kinemo command, installed with the package.
Explanatory animations in Python. Every subcommand takes -h / --help. Exit codes: 0 when everything is fine, non-zero when there are errors (or warnings with --strict).
| Command | Summary |
|---|---|
kinemo new |
create a project |
kinemo dev |
browser preview with hot reload and a scrubbable timeline |
kinemo check |
build + resolve without rendering: errors, lints, timeline |
kinemo inspect |
scene graph at time t |
kinemo snap |
PNGs of the requested times |
kinemo render |
final output |
kinemo mcp |
MCP server (stdio) with check, inspect, snap, docs and explain |
kinemo docs |
short offline docs with a canonical example |
kinemo upgrade |
codemods between versions |
kinemo explain |
long explanation of an error or lint |
Scene commands (dev, check, inspect, snap, render) take the file, --scene NAME to pick one scene (default: all) and --param NAME=VALUE (repeatable) to set scene parameters. Settings precedence: CLI > @k.scene > kinemo.toml > defaults (configuration).
kinemo new#
Create a project.
kinemo new [-h] name| Argument | Type | Default | Description |
|---|---|---|---|
name |
str | (required) |
Examples:
kinemo new my-video
cd my-video && kinemo check scene.py && kinemo render scene.pykinemo dev#
Browser preview with hot reload and a scrubbable timeline.
kinemo dev [-h] [--scene SCENE] [--param NAME=VALUE] [--port PORT] [--no-open] [--debug DEBUG] file| Argument | Type | Default | Description |
|---|---|---|---|
file |
str | (required) | |
--scene SCENE |
str | scene name (default: all) | |
--param NAME=VALUE |
str | (repeatable) | |
--port PORT |
int | 7878 |
|
--no-open |
flag | do not open the browser | |
--debug DEBUG |
str | overlays: layout,safe (comma-separated) |
Examples:
kinemo dev scene.py
kinemo dev scene.py --scene intro --debug layout,safe --port 8000kinemo check#
Build + resolve without rendering: errors, lints, timeline.
kinemo check [-h] [--scene SCENE] [--param NAME=VALUE] [--json] [--strict] [--fix] file| Argument | Type | Default | Description |
|---|---|---|---|
file |
str | (required) | |
--scene SCENE |
str | scene name (default: all) | |
--param NAME=VALUE |
str | (repeatable) | |
--json |
flag | ||
--strict |
flag | treat warnings as errors | |
--fix |
flag | apply safe fixes |
Examples:
kinemo check scene.py
kinemo check scene.py --json --strict
kinemo check scene.py --fix
kinemo check scene.py --scene intro --param n=5kinemo inspect#
Scene graph at time t.
kinemo inspect [-h] [--scene SCENE] [--param NAME=VALUE] [--at AT] [--json] [--all] file| Argument | Type | Default | Description |
|---|---|---|---|
file |
str | (required) | |
--scene SCENE |
str | scene name (default: all) | |
--param NAME=VALUE |
str | (repeatable) | |
--at AT |
str | 0 |
|
--json |
flag | ||
--all |
flag | include objects not in the scene |
Examples:
kinemo inspect scene.py --at 2.5
kinemo inspect scene.py --at end --json --allkinemo snap#
PNGs of the requested times.
kinemo snap [-h] [--scene SCENE] [--param NAME=VALUE] [--at AT] [--out OUT] [--quality {draft,final}] file| Argument | Type | Default | Description |
|---|---|---|---|
file |
str | (required) | |
--scene SCENE |
str | scene name (default: all) | |
--param NAME=VALUE |
str | (repeatable) | |
--at AT |
str | 0,end |
|
--out OUT |
str | out |
|
--quality QUALITY |
draft | final |
draft |
Examples:
kinemo snap scene.py --at 0,2.5,end
kinemo snap scene.py --at intro_done --quality final --out shotskinemo render#
Final output.
kinemo render [-h] [--scene SCENE] [--param NAME=VALUE] [--format {mp4,webm,mov,gif,png,svg,slides}] [--quality {draft,final}] [--out OUT] [--at AT] [--frames] [--transparent] file| Argument | Type | Default | Description |
|---|---|---|---|
file |
str | (required) | |
--scene SCENE |
str | scene name (default: all) | |
--param NAME=VALUE |
str | (repeatable) | |
--format FORMAT |
mp4 | webm | mov | gif | png | svg | slides |
mp4 |
|
--quality QUALITY |
draft | final |
final |
|
--out OUT |
str | out |
|
--at AT |
str | time (png/svg): seconds, a mark name or 'end' | |
--frames |
flag | png: the whole sequence | |
--transparent |
flag |
Examples:
kinemo render scene.py
kinemo render scene.py --format gif --quality draft
kinemo render scene.py --format png --at end --transparent
kinemo render scene.py --format slideskinemo mcp#
MCP server (stdio) with the check, inspect, snap, docs and explain tools, always with --strict.
kinemo mcp [-h]Takes no arguments.
Examples:
kinemo mcpkinemo docs#
Short offline docs with a canonical example.
kinemo docs [-h] [--json] [--check] [symbol]| Argument | Type | Default | Description |
|---|---|---|---|
symbol |
str | symbol: k.draw, draw, s.play, Scene.play, ax.plot (optional) | |
--json |
flag | JSON output | |
--check |
flag | build every canonical example (like check --strict) |
Examples:
kinemo docs
kinemo docs k.morph
kinemo docs s.play --json
kinemo docs --checkkinemo upgrade#
Codemods between versions.
kinemo upgrade [-h] [--check] files [files ...]| Argument | Type | Default | Description |
|---|---|---|---|
files |
str | (one or more) | |
--check |
flag | only show the diff; do not write |
Examples:
kinemo upgrade scene.py --check
kinemo upgrade scenes/*.pykinemo explain#
Long explanation of an error or lint.
kinemo explain [-h] code| Argument | Type | Default | Description |
|---|---|---|---|
code |
str | (required) |
Examples:
kinemo explain K0101