Vhs Tape

Output demo.gif          # GIF (most common)
Output demo.mp4          # MP4 video
Output demo.webm         # WebM video
Output frames/           # Directory for PNG frame sequence
Output demo.txt          # ASCII text (for testing)

Require echo             # Abort with clear error if program not in PATH
Require fzf

Set Width  1200          # pixels (default: 1200)
Set Height 600           # pixels (default: 600)

Set FontSize      22                   # pt (default: 22)
Set FontFamily    "RobotoMono Nerd Font"  # must be installed on system
Set LetterSpacing 1                    # multiplier (default: 1.0)
Set LineHeight    1.2                  # multiplier (default: 1.0)

Set Shell "bash"         # bash, zsh, fish, etc.

Set TypingSpeed   50ms       # delay between typed chars (default: 50ms)
Set Framerate     60         # capture framerate (default: 50)
Set PlaybackSpeed 2          # output speed multiplier (0.5 = slow, 2.0 = fast)
Set LoopOffset    60.4       # % into GIF where looping restarts (avoids blank-terminal loop)
Set LoopOffset    20.99%     # same, with explicit %

Set WaitTimeout  15s         # how long Wait polls before failing (default: 15s)
Set WaitPattern  /regex/     # default pattern for bare Wait command

Set Theme "Catppuccin Mocha"    # named theme (350+ available; run `vhs themes` to list)
Set Theme "Dracula"
Set Theme "Nord"
Set Theme "TokyoNight"
Set Theme "One Dark"
Set Theme "Gruvbox Dark"
Set Theme "Rose Pine"

# Inline JSON custom theme:
Set Theme { "name": "Custom", "black": "#535178", "red": "#ef6487", "green": "#5eca89", "yellow": "#fdd877", "blue": "#65aef7", "purple": "#aa7ff0", "cyan": "#43c1be", "white": "#ffffff", "brightBlack": "#535178", "brightRed": "#ef6487", "brightGreen": "#5eca89", "brightYellow": "#fdd877", "brightBlue": "#65aef7", "brightPurple": "#aa7ff0", "brightCyan": "#43c1be", "brightWhite": "#ffffff", "background": "#29283b", "foreground": "#b3b0d6", "selectionBackground": "#3d3c58", "cursorColor": "#b3b0d6" }

Set Padding      50          # internal padding in pixels
Set Margin       20          # external border in pixels
Set MarginFill   "#6B50FF"   # margin area color (hex)
Set BorderRadius 10          # corner radius in pixels
Set CursorBlink  false       # cursor animation (default: true)

Set WindowBar         "Colorful"       # colored traffic-light buttons (recommended for docs)
Set WindowBar         "ColorfulRight"  # buttons on the right
Set WindowBar         "Rings"          # monochrome rings
Set WindowBar         "RingsRight"     # rings on the right
Set WindowBarSize     40               # height in pixels

Sleep 1s          # 1 second
Sleep 500ms       # 500 milliseconds
Sleep .5          # 0.5 seconds
Sleep 1m          # 1 minute

Type "hello world"             # type at global TypingSpeed
Type 'single quotes work'
Type `backticks work`

Type@500ms "slow emphasis"     # override speed for this command only
Type@10ms  "fast burst"

Enter                    # press Enter once
Enter 3                  # press Enter 3 times
Enter@100ms 3            # press 3 times with 100ms between each

Backspace
Backspace 2
Backspace@200ms 5

Delete
Delete 2

Insert
Tab
Tab 2

Space
Space 3

Escape

Up
Down
Left
Right
Up 2
Down@50ms 3

PageUp
PageDown
PageUp 2
PageDown@100ms 3

ScrollUp
ScrollDown
ScrollUp 2
ScrollDown@100ms 2

Ctrl+C
Ctrl+L
Ctrl+R
Ctrl+D
Ctrl+Z
Ctrl+A              # any letter
Ctrl+Left           # ctrl + arrow
Ctrl+Right
Ctrl+Up
Ctrl+Down

Alt+.
Alt+L
Alt+b
Alt+f

Shift+Enter
Shift+Tab

# Multiple modifiers:
Ctrl+Shift+Alt+C
Ctrl+Alt+Down

Wait                          # wait using WaitPattern setting
Wait /regex/                  # wait until regex matches current line
Wait+Line /regex/             # explicit: match current line
Wait+Screen /regex/           # match anywhere on screen buffer

Wait@5s /pattern/             # 5-second timeout override for this Wait
Wait+Screen@10s /done/

Hide
Type "export PS1='$ '"
Enter
Sleep 300ms
Type "cd /tmp/demo"
Enter
Sleep 300ms
Show
# Recording content starts here

Screenshot examples/output.png

Copy "text to copy"    # copy to clipboard
Paste                  # paste clipboard contents into terminal

Env HOME "/tmp/demo"
Env FOO  "bar"

Source setup.tape
Source common/header.tape

# This is a comment