diff --git a/pages/common/vhs.md b/pages/common/vhs.md new file mode 100644 index 000000000..ca7527130 --- /dev/null +++ b/pages/common/vhs.md @@ -0,0 +1,28 @@ +# vhs + +> CLI home video recorder to generate terminal gifs from code. +> More information: . + +- Create a tape file (Add commands to the tap file using your editor): + +`vhs new {{path/to/file.tape}}` + +- Record inputs to a tape file (Once done, exit the shell to create the tape): + +`vhs record > {{path/to/file.tape}}` + +- Record inputs to a tape file using a specific shell: + +`vhs record --shell {{shell}} > {{path/to/file.tape}}` + +- Validate a type file's syntax: + +`vhs validate {{path/to/file.tape}}` + +- Create a gif from a tape file: + +`vhs < {{path/to/file.tape}}` + +- Publish a gif to https://vhs.charm.sh and get a shareable URL: + +`vhs publish {{path/to/file.gif}}`