CLI.
render, view, help. Flags work before or after the script.
Note: Flags may come before or after the script path —
kyfram render intro.lgv --out out.mp4 works too. Examples keep flags-first by convention.kyfram render
usage
kyfram render [--out f] [--fps n] [--width n] [--height n] [--font f] [--crf n] [--preset s] [--format mp4|png] [--var k=v ...] <script.lgv>| flag | default | does what |
|---|---|---|
| --out FILE | out.mp4 | output path |
| --fps N | scene fps | override the scene() fps |
| --width N | 640 | override canvas width |
| --height N | 360 | override canvas height |
| --font FILE | bundled face | default typeface for text entities |
| --crf N | 23 | x264 quality 0-51, lower is better (18 high, 28 small) |
| --preset S | medium | speed/quality: ultrafast..veryslow |
| --format F | mp4 | mp4 or png (png = single frame at t=0, no ffmpeg) |
| --var K=V | — | template variable, repeatable |
Examples
everyday
kyfram render --out out.mp4 examples/intro.lgv
kyfram render --crf 18 --preset slow examples/intro.lgv
kyfram render --format png --out frame.png examples/intro.lgv
kyfram render --var title=kyfram examples/vars.lgvLong renders show a progress bar with frame count and percent on terminals (plain line when piped), and finish with duration, dims, fps, frames, and file size.
kyfram new
usage
kyfram new <name> # scaffolds <name>/scene.lgv + assets/ + out/Scaffolds a starter project: a scene.lgv (ball + title, 4s), an assets/ folder for images and fonts, and an out/ folder for renders. Instant edit-and-render loop:
then
kyfram new demo
kyfram render --out demo/out/demo.mp4 demo/scene.lgvkyfram view
usage
kyfram view [--port n] [--font f] <script.lgv> # opens http://localhost:7070| flag | default | does what |
|---|---|---|
| --port N | 7070 | preview server port |
| --font FILE | bundled face | default typeface |
Scrub slider, play button, and hot reload — every request re-reads the script, and a modtime cache keeps scrubbing fast without re-running TTS per frame. Time ruler, loop toggle, PNG export, fullscreen (F), Space / arrows / Home / End keys. UI matches the site: warm zinc, monochrome.
help and version
terminal
kyfram --help
kyfram help render
kyfram help view
kyfram help new
kyfram --version-h/--help and -v/--version work anywhere. No colors, structured plain text.