Files
claude-engineering-plugin/plugins/compound-engineering/skills/ce-demo-reel/references/tier-terminal-recording.md
2026-04-09 21:29:51 -07:00

3.0 KiB

Tier: Terminal Recording

Record a terminal session using VHS (charmbracelet/vhs) to produce a GIF demo.

Best for: CLI tools, scripts, command-line features with interaction or motion (typing, streaming output, progressive rendering). Output: GIF (direct from VHS) Label: "Demo" Required tools: vhs

Step 1: Plan the Recording

Before generating a .tape file, determine:

  • What command(s) to run -- The actual product command, not test commands. "I ran npm test" is test evidence, not a demo.
  • Expected output -- What the terminal should show when the command succeeds.
  • Terminal dimensions -- Wide enough for the longest output line, tall enough to avoid scrolling.
  • Timing -- Target 5-10 seconds total. Enough sleep after each command for output to render.

Step 2: Generate .tape File

Write a VHS tape file to [RUN_DIR]/demo.tape:

Output [RUN_DIR]/demo.gif

Set FontSize 16
Set Width 800
Set Height 500
Set Theme "Catppuccin Mocha"
Set TypingSpeed 40ms

# Hide boring setup
Hide
Type "cd /path/to/project"
Enter
Sleep 500ms
Show

# The demo
Type "your-cli-command --flag value"
Sleep 500ms
Enter
Sleep 3s

# Let viewer read the output
Sleep 2s

Key .tape directives:

  • Output [path] -- Where to write the GIF (must be first line)
  • Set FontSize [14-18] -- Larger for readability
  • Set Width/Height [pixels] -- Match content needs
  • Set Theme [name] -- "Catppuccin Mocha" or "Dracula" are readable defaults
  • Set TypingSpeed [ms] -- 30-50ms feels natural
  • Hide/Show -- Skip boring setup (cd, source, npm install)
  • Type [text] -- Types characters (does not execute)
  • Enter -- Presses enter (executes the typed command)
  • Sleep [duration] -- Wait for output to render

Avoid:

  • Non-deterministic output (random IDs, timestamps that change between runs)
  • Commands that require interactive input (prompts, password entry)
  • Very long output that scrolls off screen

Step 3: Run VHS

Use the capture pipeline script to execute the tape file and validate output:

python3 scripts/capture-demo.py terminal-recording --output [RUN_DIR]/demo.gif --tape [RUN_DIR]/demo.tape

The script runs VHS, validates the output exists, and reports the file size. If the GIF exceeds 10 MB, reduce by adjusting the .tape: smaller terminal dimensions (Set Width/Height), shorter recording (fewer sleeps), or lower font size. Re-run.

Step 4: Quality Check

Read the generated GIF to verify:

  1. Commands are visible and readable
  2. Output renders completely (not cut off)
  3. The feature being demonstrated is clearly shown
  4. No secrets, credentials, or sensitive paths are visible

If quality is poor, revise the .tape file and re-record.

If VHS fails (crashes, produces empty GIF, or the command being demonstrated fails): fall back to the screenshot reel tier. Write the same commands and expected output as text frames and stitch via silicon + ffmpeg. If silicon is also unavailable, fall back to static screenshots.

Proceed to references/upload-and-approval.md.