pr-demo

name	pr-demo
description	Use when creating animated demos (GIFs) for pull requests or documentation. Covers terminal recording with asciinema and conversion to GIF/SVG for GitHub embedding.
metadata	{"internal":true}

PR Demo Creation

Overview

Create polished terminal demos for PRs using asciinema recordings converted to GIF. The workflow: script → record → convert → embed.

Tool Selection

Goal	Tool Chain	Output
CLI demo for GitHub PR	asciinema → agg	GIF (< 5MB)
Smaller file needed	asciinema → svg-term-cli	SVG (< 500KB)
TUI screenshot	tmux → freeze	SVG/PNG

Default choice: asciinema + agg (best compatibility, GitHub renders GIFs natively)

Prerequisites

# Install tools (macOS)
brew install asciinema
cargo install --git https://github.com/asciinema/agg
npm install -g svg-term-cli  # Optional: for SVG output

Workflow

1. Script Your Demo (REQUIRED)

Before recording, write a brief script:

## Demo: [feature name]
Duration: ~20-30 seconds

1. [0-3s] Show command being typed
2. [3-10s] Command executes, show key output
 [10-25s] Highlight the "aha moment" - what makes this valuable
 [25-30s] Clean exit or final state