diff --git a/pages/common/vhs.md b/pages/common/vhs.md index f6b4692bd7..c29bf28ec4 100644 --- a/pages/common/vhs.md +++ b/pages/common/vhs.md @@ -1,28 +1,32 @@ # vhs -> Generate terminal gifs from a tape file. +> Generate terminal GIFs from a tape file. > More information: . - Create a tape file (add commands to the tape file using an editor): `vhs new {{path/to/file.tape}}` -- Record inputs to a tape file (once done, exit the shell to create the tape): +- Record inputs to a tape file: `vhs record > {{path/to/file.tape}}` - Record inputs to a tape file using a specific shell: -`vhs record --shell {{shell}} > {{path/to/file.tape}}` +`vhs record {{[-s|--shell]}} {{shell}} > {{path/to/file.tape}}` + +- Stop recording: + +`exit` - Validate the syntax of a tape file: `vhs validate {{path/to/file.tape}}` -- Create a gif from a tape file: +- Create a GIF from a tape file: -`vhs < {{path/to/file.tape}}` +`vhs {{path/to/file.tape}}` -- Publish a gif to and get a shareable URL: +- Publish a GIF to and get a shareable URL: `vhs publish {{path/to/file.gif}}`