vhs-recorder

Create professional terminal recordings with VHS tape files - guides through syntax, timing, settings, and best practices

Security Scan

This is an instruction-only documentation skill for the vhs terminal-recording tool; its files and runtime instructions align with that purpose and it does not request credentials or install code.

Purpose & Capability

The name/description match the provided instructions and reference docs. The skill is instruction-only and documents using Charm's vhs plus common helpers (ttyd, ffmpeg). One minor inconsistency: the registry metadata lists no required binaries/env, while SKILL.md explicitly lists prerequisites (vhs, ttyd, ffmpeg). This is documentation mismatch but not an indication of hidden behavior.

Instruction Scope

The SKILL.md and reference files stay within the expected scope (how to author tape files, timing, settings, formats). They include examples that run shell commands, clone repos, and even an example with 'rm -rf production-db/' demonstrating backspace recovery — these are example scenarios and not active code, but they illustrate potentially destructive commands. Users should avoid running untrusted tape files or example commands on production systems.

Install Mechanism

No install spec or code is provided (instruction-only). Nothing is downloaded or written to disk by the skill itself, which minimizes install-time risk.

Credentials

The skill declares no required environment variables or credentials. The documentation mentions an 'Env VAR "value"' tape command (used to set env for recordings) but that is an operational note, not a request for secrets. No unrelated credentials or config paths are requested.

Persistence & Privilege

always is false and the skill is user-invocable/autonomously callable by default (normal). The skill does not request persistent system presence or modify other skills/configs.

Assessment

This skill is a documentation bundle for using the vhs tool and appears internally consistent. Before using it: (1) ensure you have vhs, ffmpeg and any other CLI tools installed yourself — the registry metadata doesn't enforce these prerequisites; (2) never run tape files or example commands from untrusted sources on production systems (examples include repo cloning and 'rm -rf' style commands); (3) use the ASCII preview or run in a disposable container/VM to validate tapes before producing final videos; (4) be aware this skill will only instruct you — it does not install software or request secrets, so the main risk is executing harmful shell commands you paste or run locally.

Create terminal recordings with Charm's VHS. Use when creating CLI demos, README animations, documentation videos.

Prerequisites

• vhs installed (brew install vhs / go install github.com/charmbracelet/vhs@latest)
• ttyd and ffmpeg on PATH

Tape File Structure

Output demo.gif         # Outputs first
Set Width 1200          # Settings second
Set Theme "Catppuccin Mocha"
Require git             # Requirements third
Hide                    # Hidden setup
Type "cd /tmp && clear"
Enter
Show
Type "your command"     # Main recording
Enter
Wait
Sleep 2s

Core Commands

Command	Purpose
Type "text"	Type text (uses TypingSpeed setting)
Enter / Tab / Space	Key presses
Up / Down / Left / Right	Arrow navigation
PageUp / PageDown	Page navigation
Ctrl+C / Ctrl+D / Ctrl+L	Signal/EOF/clear combos
Wait / Wait /pattern/	Wait for prompt or regex match
Sleep 2s	Fixed pause (supports ms/s/m)
Hide/Show	Hide setup/cleanup from output
Type@50ms "text"	Override typing speed inline
Backspace N / Delete N	Delete N chars back/forward
Copy / Paste	Clipboard operations
Screenshot path.png	Capture single frame
Env VAR "value"	Set environment variable

Essential Settings

Setting	Default	Notes
Width/Height	1200/600	Terminal dimensions in pixels
FontSize	32	Text size; FontFamily for custom fonts
TypingSpeed	50ms	Per-char delay (override with Type@Xms)
Theme	-	Use vhs themes to list all available
Padding	40	Border space; LetterSpacing/LineHeight also available

Timing & Patterns

3-2-1 Rule: 3s after important commands, 2s between actions, 1s for transitions

• Clean start: Hide → Type "clear" → Enter → Show
• Command-wait: Type → Enter → Wait → Sleep 2s
• Fast hidden: Type@10ms "setup command"
• ASCII preview: Output demo.ascii for instant test

Output Formats

Format	Use Case
.gif	Web/README (universal)
.mp4/.webm	Social media / modern browsers
.ascii	Preview/test (instant, no ffmpeg)
frames/	PNG sequence for post-processing

Quick Fixes

Issue	Solution
Commands too fast	Add Wait + Sleep 2s after Enter
Messy terminal	Hide → clear → Show at start
Inconsistent pacing	Follow 3-2-1 timing rule

CLI Commands

vhs demo.tape       # Run tape file
vhs themes          # List all available themes
vhs manual          # Show full command reference

References

• vhs-syntax.md - Full command reference
• timing-control.md - Pacing strategies
• settings.md - All configuration options
• examples.md - Real-world tape files