pr-demo

This skill provides a structured workflow for generating high-quality animated terminal recordings, perfect for demonstrating software features in GitHub pull requests or technical documentation. It streamlines the entire process from scripting and environment setup to recording, conversion, and validation. By utilizing industry-standard tools like asciinema for recording, and agg or svg-term-cli for outputting GIFs and SVGs, it ensures that your demos remain lightweight, professional, and visually clear for reviewers.

• Automated workflow: Script → Record → Convert → Embed.

• Optimized output formats: Generates compact GIFs (< 5MB) for native GitHub embedding or SVGs (< 500KB) for smaller footprint requirements.

• Self-validation mechanisms: Includes steps for automated checks (file size, duration, metadata) and visual validation using LLM-as-a-judge to ensure readability and security.

• Environment standardization: Enforces clean terminal states by stripping sensitive data, using specific terminal dimensions (100x24), and standardizing color schemes.

• Practical guidance: Provides best-practice patterns for keeping demos concise (20-30 seconds), highlighting key "aha moments," and cleaning terminal prompts for a professional look.

• Always script your demo session before recording to maintain focus and ensure the "aha moment" is clearly demonstrated.

• Use asciinema rec with the specified 100x24 dimensions to ensure the playback remains readable across different devices and screen sizes.

• Validate the output with the provided prompt to ensure no sensitive information, such as API keys or local file paths, is leaked in the recording.

• Default to the asciinema + agg toolchain for the best compatibility, but switch to svg-term-cli if file size constraints become an issue in your repository.

• Place all generated assets, including the source .cast files and the final .gif or .svg demos, within the docs/demos/ directory for organized documentation management.