2023-03-29 03:33:43 -05:00
|
|
|
# vhs
|
|
|
|
|
2025-08-05 10:55:02 +00:00
|
|
|
> Generate terminal GIFs from a tape file.
|
2023-03-29 03:33:43 -05:00
|
|
|
> More information: <https://github.com/charmbracelet/vhs>.
|
|
|
|
|
2023-07-16 19:23:40 +02:00
|
|
|
- Create a tape file (add commands to the tape file using an editor):
|
2023-03-29 03:33:43 -05:00
|
|
|
|
|
|
|
`vhs new {{path/to/file.tape}}`
|
|
|
|
|
2025-08-05 10:55:02 +00:00
|
|
|
- Record inputs to a tape file:
|
2023-03-29 03:33:43 -05:00
|
|
|
|
|
|
|
`vhs record > {{path/to/file.tape}}`
|
|
|
|
|
|
|
|
- Record inputs to a tape file using a specific shell:
|
|
|
|
|
2025-08-05 10:55:02 +00:00
|
|
|
`vhs record {{[-s|--shell]}} {{shell}} > {{path/to/file.tape}}`
|
|
|
|
|
|
|
|
- Stop recording:
|
|
|
|
|
|
|
|
`exit`
|
2023-03-29 03:33:43 -05:00
|
|
|
|
2023-07-16 19:23:40 +02:00
|
|
|
- Validate the syntax of a tape file:
|
2023-03-29 03:33:43 -05:00
|
|
|
|
|
|
|
`vhs validate {{path/to/file.tape}}`
|
|
|
|
|
2025-08-05 10:55:02 +00:00
|
|
|
- Create a GIF from a tape file:
|
2023-03-29 03:33:43 -05:00
|
|
|
|
2025-08-05 10:55:02 +00:00
|
|
|
`vhs {{path/to/file.tape}}`
|
2023-03-29 03:33:43 -05:00
|
|
|
|
2025-08-05 10:55:02 +00:00
|
|
|
- Publish a GIF to <https://vhs.charm.sh> and get a shareable URL:
|
2023-03-29 03:33:43 -05:00
|
|
|
|
|
|
|
`vhs publish {{path/to/file.gif}}`
|