explain-with-anim

Generates checked explanatory diagrams and animations from code structure using vlmkit-anim.

22|1|Updated Mar 30, 2026
One-click install
npx skills add https://github.com/mizchi/vlmkit --skill explain-with-anim-mizchi
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: explain-with-anim
Source: https://github.com/mizchi/vlmkit/tree/main/.apm/skills/vlmkit/workflows/explain-with-anim
Command: npx skills add https://github.com/mizchi/vlmkit --skill explain-with-anim-mizchi

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Answering "how does this work" questions about code with prose alone often fails when the answer involves many modules, states, or steps and their relations. This Skill produces a drawn figure (module map, sequence walk, state machine, algorithm trace) generated from the actual code by vlmkit-anim, verified against the facts it depicts, and paired with prose that walks the figure beat by beat. ## Core Features & Use Cases - Fact-grounded diagrams: Extracts the real import graph via vlmkit-anim facts or repo, then validates the scene with check --expect so the picture matches the code rather than memory. - Multiple scene kinds: Module maps, sequence walks, state machines, flowcharts, distributed-system messages, Gantt charts, algorithm visualizations, PR change maps, and Mermaid imports. - Checked delivery pipeline: Scene JSON is validated with check, layout, and explain, then rendered as an SVG still for structures or a GIF for walks, with prose that names elements by their ids. - Use Case: A user asks "how does a request flow through this service?" The Skill reads the code path, builds a modules scene with a sequence, verifies it against the import graph, renders a GIF, and delivers a beat-by-beat explanation citing the actual files and functions. ## Quick Start Ask the agent to explain how this repository is structured or how a request flows through it, and request a checked diagram with a walkthrough.

Frequently Asked Questions about explain-with-anim

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a diagram of my codebase structure?

Run vlmkit-anim facts on the directory to extract the import graph, build a modules scene from it, then validate with check --expect and render an SVG with the still command. The repo command draws the whole workspace and writes its own fact sheet.

How do I visualize a pull request or branch changes?

Use vlmkit-anim pr --base origin/main to produce one beat per commit, or vlmkit-anim diff to compare two module maps. The generated markdown file is paste-ready for the PR description.

When should I use a diagram instead of a written explanation?

Draw when the answer involves four or more named things with relations, an order in time, or a before-and-after. Skip the figure for one-line answers, a single function body, or questions about a single value.

Can I import an existing Mermaid diagram into vlmkit-anim?

Yes, vlmkit-anim import mermaid converts a Mermaid diagram from a markdown file into a scene JSON you can finish and check. Review the dropped and changed list it reports, since not every Mermaid construct translates.

What happens if the scene fails validation repeatedly?

The workflow allows at most five edit-and-check rounds. If the scene still is not clean, deliver the explanation in prose, state which check line stopped convergence, and keep the scene file for the reader.