.TH VHS 1 "2026-03-10" "vhs" "Run a given tape file and generates its outputs."
.SH NAME
vhs - Run a given tape file and generates its outputs\&.
.SH SYNOPSIS
\fBvhs\fP [\fIoptions\&.\&.\&.\fP] [\fIargument\&.\&.\&.\fP]
.SH DESCRIPTION
VHS lets you write terminal GIFs as code\&.
.PP
VHS reads \&.tape files and renders GIFs (videos)\&.
.PP
A tape file is a script made up of commands describing what actions to perform in the render\&.
.PP
.PP
The following is a list of all possible commands in VHS:
.PP
.PP
.RS
.IP \(bu 3
Output <path>\&.(gif|webm|mp4)
.IP \(bu 3
Require <program>
.IP \(bu 3
Set <setting> <value>
.IP \(bu 3
Sleep <time>
.IP \(bu 3
Type "<string>"
.IP \(bu 3
Ctrl [+Alt][+Shift]+<char>
.IP \(bu 3
Backspace [repeat]
.IP \(bu 3
Delete [repeat]
.IP \(bu 3
Insert [repeat]
.IP \(bu 3
Down [repeat]
.IP \(bu 3
Enter [repeat]
.IP \(bu 3
Left [repeat]
.IP \(bu 3
Right [repeat]
.IP \(bu 3
Tab [repeat]
.IP \(bu 3
Up [repeat]
.IP \(bu 3
PageUp [repeat]
.IP \(bu 3
PageDown [repeat]
.IP \(bu 3
ScrollUp [repeat]
.IP \(bu 3
ScrollDown [repeat]
.IP \(bu 3
Hide
.IP \(bu 3
Show
.IP \(bu 3
Wait[+Screen][@<timeout>] /<regexp>/
.IP \(bu 3
Escape
.IP \(bu 3
Alt+<key>
.IP \(bu 3
Space [repeat]
.IP \(bu 3
Source <path>\&.tape
.IP \(bu 3
Screenshot <path>\&.png
.IP \(bu 3
Copy "<string>"
.IP \(bu 3
Paste
.RE
.SH OPTIONS
.TP
\fB-o, --output\fP
file name(s) of video output
.TP
\fB-p, --publish\fP
publish your GIF to vhs\&.charm\&.sh and get a shareable URL
.TP
\fB-q, --quiet\fP
quiet do not log messages\&. If publish flag is provided, it will log shareable URL
.SH COMMANDS
.TP
\fBhelp\fP [command]
.RS 4
Help about any command
.RE
.TP
\fBnew\fP <name>
.RS 4
Create a new tape file with example tape file contents and documentation
.RE
.TP
\fBpublish\fP <gif>
.RS 4
Publish your GIF to vhs\&.charm\&.sh and get a shareable URL
.RE
.TP
\fBrecord\fP
.RS 4
Create a new tape file by recording your actions
.RE
.TP
\fBOPTIONS\fP
.RS 4
\fB-s, --shell\fP
shell for recording
.RE
.TP
\fBserve\fP
.RS 4
Start the VHS SSH server
.RE
.TP
\fBthemes\fP
.RS 4
List all the available themes, one per line
.RE
.TP
\fBOPTIONS\fP
.RS 4
\fB--markdown\fP
output as markdown
.RE
.TP
\fBvalidate\fP <file>\&.\&.\&.
.RS 4
Validate a glob file path and parses all the files to ensure they are valid without running them\&.
.RE
.SH OUTPUT
The Output command instructs VHS where to save the output of the recording\&.
.PP
File names with the extension \&.gif, \&.webm, \&.mp4 will have the respective file types\&.
.PP
.SH SETTINGS
The Set command allows VHS to adjust settings in the terminal, such as fonts, dimensions, and themes\&.
.PP
.PP
The following is a list of all possible setting commands in VHS:
.PP
.PP
.RS
.IP \(bu 3
Set Shell <string>
.IP \(bu 3
Set FontSize <number>
.IP \(bu 3
Set FontFamily <string>
.IP \(bu 3
Set Height <number>
.IP \(bu 3
Set Width <number>
.IP \(bu 3
Set LetterSpacing <float>
.IP \(bu 3
Set LineHeight <float>
.IP \(bu 3
Set TypingSpeed <time>
.IP \(bu 3
Set Theme <json|string>
.IP \(bu 3
Set Padding <number>
.IP \(bu 3
Set Framerate <number>
.IP \(bu 3
Set PlaybackSpeed <float>
.IP \(bu 3
Set WaitTimeout <time>
.IP \(bu 3
Set WaitPattern <regexp>
.RE
.SH BUGS
See GitHub Issues: <https://github\&.com/charmbracelet/vhs/issues>
.SH AUTHOR
Charm <vt100@charm\&.sh>
.SH COPYRIGHT
(C) 2021-2022 Charmbracelet, Inc\&.
.PP
Released under MIT license\&.