2023-03-29 09:33:43 +01:00
|
|
|
# vhs
|
|
|
|
|
2023-07-16 18:23:40 +01:00
|
|
|
> Generate terminal gifs from a tape file.
|
2023-03-29 09:33:43 +01:00
|
|
|
> More information: <https://github.com/charmbracelet/vhs>.
|
|
|
|
|
2023-07-16 18:23:40 +01:00
|
|
|
- Create a tape file (add commands to the tape file using an editor):
|
2023-03-29 09:33:43 +01:00
|
|
|
|
|
|
|
`vhs new {{path/to/file.tape}}`
|
|
|
|
|
2023-07-16 18:23:40 +01:00
|
|
|
- Record inputs to a tape file (once done, exit the shell to create the tape):
|
2023-03-29 09:33:43 +01:00
|
|
|
|
|
|
|
`vhs record > {{path/to/file.tape}}`
|
|
|
|
|
|
|
|
- Record inputs to a tape file using a specific shell:
|
|
|
|
|
|
|
|
`vhs record --shell {{shell}} > {{path/to/file.tape}}`
|
|
|
|
|
2023-07-16 18:23:40 +01:00
|
|
|
- Validate the syntax of a tape file:
|
2023-03-29 09:33:43 +01:00
|
|
|
|
|
|
|
`vhs validate {{path/to/file.tape}}`
|
|
|
|
|
|
|
|
- Create a gif from a tape file:
|
|
|
|
|
|
|
|
`vhs < {{path/to/file.tape}}`
|
|
|
|
|
2023-07-16 18:23:40 +01:00
|
|
|
- Publish a gif to <https://vhs.charm.sh> and get a shareable URL:
|
2023-03-29 09:33:43 +01:00
|
|
|
|
|
|
|
`vhs publish {{path/to/file.gif}}`
|