pr-demo

To create an animated terminal demo for a GitHub PR, record your terminal session using asciinema, convert the cast file to a GIF or SVG using agg or svg-term-cli, and embed the resulting asset directly into your PR description.

The best way to record terminal sessions for documentation is using asciinema to capture interactive commands, which can then be converted into lightweight GIF or SVG formats to visually demonstrate features in READMEs and wikis.

You can convert asciinema recordings to GIF or SVG for a README by passing the recorded cast file through the agg converter for GIFs or svg-term-cli for SVGs to generate ready-to-embed visual assets.

Yes, you need external tools to embed terminal recordings in pull requests, specifically asciinema for recording sessions and agg or svg-term-cli to convert the output into embeddable GIF or SVG formats.

Yes, asciinema works with svg-term-cli for terminal demo creation by outputting a cast file that svg-term-cli can process to generate animated SVG files with a window frame for documentation.

Using SVG instead of GIF for terminal recordings in docs produces sharper, scalable animations with smaller file sizes, making it ideal for high-resolution displays and fast-loading documentation pages.