cinegram

Animated, narrated architecture diagrams from a Mermaid-compatible DSL. A .dgm file is a Mermaid diagram plus scenario, view and interact blocks; cinegram compiles it into a self-contained HTML page that plays.

uvx cinegram preview diagram.dgm -o out.html
uvx cinegram lint diagram.dgm --strict
uvx cinegram record diagram.dgm -o out.gif

pipx run cinegram …, pipx install cinegram and pip install cinegram all work the same way.

What this package is

A launcher, not a copy of the compiler. cinegram itself is a single static Go binary published on GitHub releases; this package downloads the one that matches your platform the first time you run it, checks it against the release's SHA256SUMS, and executes it. There is no install hook, so nothing can fail during pip install and then puzzle you later: a failure can only happen at the moment you run the command, in front of you.

The version is pinned to this distribution's own version, so uvx cinegram==0.3.0 runs exactly the v0.3.0 binary. Because the cache entry is version-pinned, cinegram upgrade refuses to run under the launcher — install a newer version instead (uvx cinegram@latest …, pip install -U cinegram).

Supported platforms: darwin-arm64, darwin-x64, linux-x64, linux-arm64, win32-x64. Anything else gets a clear error naming the platform.

Cache

Binaries land in one directory per version:

Delete the directory to force a fresh download.

Environment

Some subcommands need more than the binary: PNG frames and record need a Chrome/Chromium ($CINEGRAM_CHROME), and --format mp4|webm needs ffmpeg ($CINEGRAM_FFMPEG). GIF recording needs nothing else.

More

• Documentation
• Source
• Also available as npx cinegram, as a VS Code extension, and as a plain binary download.