charmbracelet/vhs
Vhs
This project is a terminal automation and recording tool that uses a custom declarative scripting language to execute command-line sequences. It functions as a framework for both generating animated media files and performing automated terminal output validation. By managing isolated pseudo-terminal sessions, it captures and renders terminal interactions into high-quality GIFs, videos, or static images.
The tool distinguishes itself through its ability to treat terminal sessions as testable, repeatable artifacts. It supports golden-file testing, allowing users to verify command-line behavior against predefined snapshots within automated pipelines. The system also provides extensive visual control, including configurable window decorations, color themes, and font settings, ensuring that recorded sessions maintain a consistent and stylized appearance.
Beyond recording and rendering, the project includes capabilities for process-level privilege sandboxing and remote recording services. It supports complex workflow automation by simulating keyboard input and managing shell environments, while providing error reporting to assist in script development. The software is designed for consistent execution across environments through containerized dependency bundling.
Features
- Terminal Session Recorders - Captures interactive terminal activity into structured formats for playback and rendering.
- Terminal Automation - Automates complex terminal workflows and keystroke sequences to generate repeatable demonstrations.
- Interaction Scripting - Uses a declarative scripting language to define sequences of terminal commands and timing.
- Output Validation - Validates command-line behavior by comparing terminal output against predefined golden files.
- Command Line Frameworks - Provides a framework for verifying terminal output against golden files in automated testing environments.
- Snapshot Testing - Verifies command-line behavior by comparing terminal output against predefined golden file snapshots.
- Recording Services - Hosts a network server that accepts terminal scripts and returns rendered media files.
- Command Line Utilities - Automates the validation of command-line output against expected results within continuous integration pipelines.
- Domain Specific Languages - Provides a declarative scripting language for defining terminal interaction sequences, timing, and visual styling.
- Scripting Languages - Uses a domain-specific scripting language to define keystrokes, timing, and visual styling for terminal recordings.
- Infrastructure and Monitoring - Terminal session recording tool.
- Animation Tools - Uses a scripting language to generate high-quality terminal animations.
- Audio and Subtitle Tools - Tool for turning terminal sessions into animated GIFs or videos.
- Go 项目 - Listed in the “Go 项目” section of the Great Open Source Project awesome list.
- Pseudo-Terminal Interfaces - Manages isolated terminal processes via pseudo-terminal interfaces to capture output and simulate user input.
- Session Media Renderers - Converts terminal interactions into animated GIFs or videos for visual storytelling.
- Terminal Customization - Configures visual properties like fonts, themes, and window styles for terminal recordings.
- Process Sandboxing - Enforces security by dropping user permissions during the execution of scripted terminal commands.
- Terminal Rendering Engines - Renders captured terminal frames into animated media files with configurable framerate and playback speed.
- Keyboard Input Automation - Simulates user keystrokes and text entry to automate terminal interactions.
- Terminal Session Management - Manages isolated shell environments for recording while suppressing local configuration.
- Terminal Color Schemes - Applies custom color palettes and visual themes to the appearance of recorded terminal sessions.
- Media Encoding Pipelines - Implements automated pipelines that pipe terminal output into media encoders for video and GIF generation.
- Privilege Management - Manages process-level permissions to ensure secure execution of terminal commands.
