vhs-recording
Generate terminal recordings using VHS (Charmbracelet) tape files.Executes tape files to produce GIF outputs of terminal sessions.Triggers: terminal recording, vhs tape, terminal demo, cli demoUse when: creating terminal recordings for tutorials and documentation
When & Why to Use This Skill
The VHS Recording skill automates the generation of professional terminal session GIFs using Charmbracelet's VHS tool. By processing declarative tape files, it streamlines the creation of high-quality CLI demonstrations, making it an essential utility for developers and technical writers to enhance documentation with visual, animated terminal examples.
Use Cases
- Technical Documentation: Automatically generate animated GIFs for GitHub READMEs and documentation sites to provide clear, visual examples of CLI tool usage.
- Educational Tutorials: Create engaging, step-by-step terminal recordings for coding tutorials and blog posts to help learners follow complex command sequences.
- Product Showcases: Produce polished terminal demos for marketing materials or social media to highlight the features and speed of new command-line applications.
- Internal Runbooks: Visualize complex infrastructure commands or deployment scripts within internal wikis to assist with team onboarding and operational clarity.
| name | vhs-recording |
|---|---|
| description | | |
| Triggers | terminal recording, vhs tape, terminal demo |
| Use when | creating terminal recordings for tutorials |
| category | media-generation |
| tags | [vhs, terminal, recording, gif, demo, tutorial] |
| tools | [Read, Write, Bash] |
| complexity | medium |
| estimated_tokens | 600 |
| progressive_loading | true |
VHS Recording Skill
Generate professional terminal recordings from VHS tape files.
Overview
VHS converts declarative tape files into animated GIFs of terminal sessions. Tape files define commands, timing, and terminal appearance.
Required TodoWrite Items
- Locate and validate tape file
- Check VHS installation status
- Execute VHS recording
- Verify output GIF creation
Workflow
Phase 1: Validate Tape File
- Confirm tape file exists at specified path
- Read tape file contents
- Verify required directives:
Outputdirective specifies GIF destination- At least one action command (Type, Enter, etc.)
Phase 2: Check VHS Installation
which vhs && vhs --version
If not installed:
# Linux/WSL
go install github.com/charmbracelet/vhs@latest
# macOS
brew install charmbracelet/tap/vhs
# Also requires ttyd and ffmpeg
Phase 3: Execute Recording
vhs <tape-file.tape>
VHS will:
- Parse tape file directives
- Launch virtual terminal (ttyd)
- Execute commands with timing
- Capture frames
- Encode to GIF using ffmpeg
Phase 4: Verify Output
- Check GIF file exists at Output path
- Verify file size is non-zero
- Report success with output location
Exit Criteria
- GIF file created at specified Output path
- File size indicates successful recording (typically >50KB)
- No error messages from VHS execution
Troubleshooting
Common Issues
If vhs is not found, verify that your Go bin directory is in your PATH (typically ~/go/bin). If the recording fails to start, ensure ttyd and ffmpeg are installed, as VHS depends on them for terminal emulation and video encoding. For "permission denied" errors when writing the GIF, check that the output directory exists and is writable.