pr-demo

What This Skill Does

The pr-demo skill is a specialized utility designed for developers and technical writers to streamline the creation of high-quality, professional terminal-based demonstrations. It encapsulates a standardized workflow—scripting, recording, and converting—to generate lightweight, web-ready media (GIFs or SVGs) that are perfect for embedding directly into GitHub pull requests, README documentation, or technical blog posts. By automating the technical overhead of recording and formatting, this skill ensures your documentation remains as dynamic and engaging as the code you are shipping.

Installation

To integrate this skill into your environment, use the OpenClaw command-line interface: clawhub install openclaw/skills/skills/paulpete/pr-demo

Ensure you have the required prerequisites installed on your host system: asciinema for recording, agg (asciinema gif generator) for high-quality GIF conversion, and optionally svg-term-cli for creating smaller vector-based previews.

Use Cases

• Feature Showcasing: Rapidly demonstrate a new CLI flag or output format in a PR description.
• Technical Documentation: Embed interactive or animated walkthroughs in documentation to explain complex workflows without requiring the user to run the code locally.
• Bug Reporting: Provide clear, reproducible terminal sessions that show exactly how an error occurs, reducing the back-and-forth between maintainers and contributors.
• Onboarding: Create short, 30-second guides that show new team members how to set up the environment or run tests.

Example Prompts

1. "I've finished the new CLI interface. Use the pr-demo tool to help me script and record a 20-second demo of the command being run, then convert it to a small GIF for my PR."
2. "I need to document the database migration command. Walk me through the pr-demo workflow to ensure the terminal output is clean and the resulting GIF is under 5MB."
3. "My current demo.cast file is too large for GitHub. Can you guide me through using the pr-demo skill to compress it into a higher-quality SVG or a optimized GIF?"

Tips & Limitations

• Keep it brief: Viewers lose interest after 30 seconds. Focus on the 'aha' moment of your feature.
• Environment Hygiene: Always reset your shell prompt (export PS1='$ ') and clear your screen to ensure the recording looks professional and consistent.
• Size Matters: GitHub has strict limits on file sizes. Use the agg tool's speed and font-size parameters to keep files optimized.
• Limitations: This tool is designed for terminal output. It cannot capture GUI applications or complex multi-window graphical interfaces effectively.