vcr 0.0.35

VcrSharp

⚠️ WORK IN PROGRESS This project is in early development and the API will change rapidly. If you need a stable, production-ready terminal recorder, please use VHS instead. VcrSharp is experimental and should be considered alpha quality.

A .NET terminal recorder that turns .tape files into GIFs and videos. Write your terminal demos as code, then render them to video.

Installation

VCR# itself ships as a .NET global tool, but it drives a real terminal under the hood, so two extra binaries need to be on your PATH:

• ttyd (>= 1.7.2) — the terminal server VCR# scripts against.
• FFmpeg — used to encode GIF / MP4 / WebM output.

Then install VCR# itself:

dotnet tool install --global vcr

Verify everything is wired up (vcr themes lists the built-in themes, confirming VCR# runs):

vcr themes
ttyd --version
ffmpeg -version

The full walkthrough lives in the Getting Started tutorial.

Quick Example

Create a file called demo.tape:

Output demo.gif

Set Cols 80
Set Rows 20
Set Theme "Dracula"

Type "echo 'Hello, VCR#!'"
Enter
Sleep 1s

Then record it:

vcr demo.tape

CLI at a glance

Documentation

Full docs, tutorials, and reference: https://phil-scott-78.github.io/vcr/

• Getting Started Tutorial
• Command Reference
• Configuration Guide
• Sample tape files in samples/

Attribution

This project is heavily inspired by VHS by Charm Bracelet. VcrSharp adds better Windows support, the ability to execute real commands via the Exec command, and an interactive record mode that works across shells (VHS's is bash-only) — but VHS is still much more feature rich.

License

This project is licensed under the MIT License - see the LICENSE file for details.