Documentation
README
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:
This is the opening of the README. Read the full README on GitHub.