1
0
Fork 0
mirror of https://github.com/tldr-pages/tldr.git synced 2025-08-15 04:35:44 +02:00
tldr/pages/common/vhs.md
2025-08-05 12:55:02 +02:00

32 lines
677 B
Markdown

# vhs
> Generate terminal GIFs from a tape file.
> More information: <https://github.com/charmbracelet/vhs>.
- 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:
`vhs record > {{path/to/file.tape}}`
- Record inputs to a tape file using a specific shell:
`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:
`vhs {{path/to/file.tape}}`
- Publish a GIF to <https://vhs.charm.sh> and get a shareable URL:
`vhs publish {{path/to/file.gif}}`