Skip to content

phil-scott-78/vcr

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.

VCR Install Demo

Installation

Install VcrSharp as a global .NET tool:

dotnet tool install --global vcr

Documentation

For complete documentation, tutorials, and examples, visit:

https://phil-scott-78.github.io/vcr/

The documentation includes:

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

Attribution

This project is heavily inspired by VHS by Charm Bracelet. VcrSharp adds better Windows support and the ability to execute real commands via the Exec command, but VHS is still much more feature rich.

License

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

About

CLI video recorder for dotnet

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages