cli-demo-gif

Create terminal GIFs by writing a VHS tape file that scripts command sequences, outputs, and timing, then run VHS to render the tape into a shareable GIF. Store tape files in docs/demo/ and configure output paths, shell, fonts, themes, and typing speed within the tape.

VHS is a terminal recording tool that converts tape files—scripts defining commands, delays, and display settings—into polished GIFs. It captures command sequences and output rendering with configurable themes and fonts to produce documentation-ready demos.

Yes, VHS-generated GIFs are designed specifically for README and documentation contexts. They render CLI interactions as standard GIF files that embed directly into markdown and HTML docs without external dependencies.

VHS tape files support Output, Set Shell, Set FontSize, Set Width, Set Height, Set Padding, Set Theme, Set TypingSpeed, Type, Enter, Sleep, Hide, and Show commands. These control GIF destination, rendering style, command execution, and timing to produce consistent polished demos.

Yes, install VHS (via brew install vhs or your package manager) before running tape files. VHS is the only required dependency; create tape files in plain text and execute vhs docs/demo/cli.tape from the command line.

GIFs are static recordings—they cannot capture interactive user input or real-time output beyond what the tape script defines. Large, complex sessions may produce larger file sizes; consider tape length and visual complexity when designing demos.