charmbracelet

A tool for recording terminal sessions as GIFs for integration testing and demoing CLI tools.

v0.12.1
Published at
Sep 24, 2026
21,054
Stars
198,081
Download
Synced at
Oct 4, 2026

Latest release

v0.12.1Sep 24, 2026, 09:30 AM
Downloads slow? Switch the source anytime above

README

Project Overview

VHS records terminal sessions as GIFs for integration testing and demoing your CLI tools.

Key Features

  • Record terminal sessions as GIFs
  • Write recordings using .tape files
  • Custom terminal dimensions and font size
  • Sleep, type, enter, and other commands
  • Cross-platform support

Target Audience

  • Developers who need to demo CLI tools
  • Teams needing CLI integration testing
  • Open-source project maintainers

Quick Start

  1. Install VHS: brew install vhs
  2. Create a .tape file: vhs new demo.tape
  3. Edit the tape file
  4. Generate GIF: vhs demo.tape

Core Advantages

  • Code as recording, version-controllable
  • Cross-platform support
  • Rich command reference
  • Open-source and free

System Requirements

  • OS: macOS, Linux, Windows
  • Architectures: x86_64, arm64
  • Additional Dependencies: ttyd and ffmpeg

Notes

  • Requires ttyd and ffmpeg
  • Can run via Docker: docker run --rm -v $PWD:/vhs ghcr.io/charmbracelet/vhs .tape

Release history

Sort