VHS(1)         Run a given tape file and generates its outputs.         VHS(1)

NAME
       vhs - Run a given tape file and generates its outputs.

SYNOPSIS
       vhs [options...] [argument...]

DESCRIPTION
       VHS let's you write terminal GIFs as code.

       VHS reads .tape files and renders GIFs (videos).

       A tape file is a script made up of commands describing what actions to
       perform in the render.

       The following is a list of all possible commands in VHS:


              o  Output <path>.(gif|webm|mp4)

              o  Require <program>

              o  Set <setting> <value>

              o  Sleep <time>

              o  Type "<string>"

              o  Ctrl [+Alt][+Shift]+<char>

              o  Backspace [repeat]

              o  Delete [repeat]

              o  Insert [repeat]

              o  Down [repeat]

              o  Enter [repeat]

              o  Left [repeat]

              o  Right [repeat]

              o  Tab [repeat]

              o  Up [repeat]

              o  PageUp [repeat]

              o  PageDown [repeat]

              o  Hide

              o  Show

              o  Escape

              o  Alt+<key>

              o  Space [repeat]

              o  Source <path>.tape

              o  Screenshot <path>.png

              o  Copy "<string>"

              o  Paste

OPTIONS
       -o, --output
              file name(s) of video output

       -p, --publish
              publish your GIF to vhs.charm.sh and get a shareable URL

       -q, --quiet
              quiet do not log messages. If publish flag is provided, it will
              log shareable URL

COMMANDS
       help [command]
           Help about any command

       new <name>
           Create a new tape file with example tape file contents and
           documentation

       publish <gif>
           Publish your GIF to vhs.charm.sh and get a shareable URL

       record
           Create a new tape file by recording your actions

       OPTIONS
           -s, --shell shell for recording

       serve
           Start the VHS SSH server

       themes
           List all the available themes, one per line

       OPTIONS
           --markdown output as markdown

       validate <file>...
           Validate a glob file path and parses all the files to ensure they
           are valid without running them.

OUTPUT
       The Output command instructs VHS where to save the output of the
       recording.

       File names with the extension .gif, .webm, .mp4 will have the
       respective file types.

SETTINGS
       The Set command allows VHS to adjust settings in the terminal, such as
       fonts, dimensions, and themes.

       The following is a list of all possible setting commands in VHS:


              o  Set Shell <string>

              o  Set FontSize <number>

              o  Set FontFamily <string>

              o  Set Height <number>

              o  Set Width <number>

              o  Set LetterSpacing <float>

              o  Set LineHeight <float>

              o  Set TypingSpeed <time>

              o  Set Theme <json|string>

              o  Set Padding <number>

              o  Set Framerate <number>

              o  Set PlaybackSpeed <float>

BUGS
       See GitHub Issues: <https://github.com/charmbracelet/vhs/issues>

AUTHOR
       Charm <vt100@charm.sh>

COPYRIGHT
       (C) 2021-2022 Charmbracelet, Inc.

       Released under MIT license.

vhs                               2024-04-24                            VHS(1)