Skip to content

rjeffman/vcr

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

VCR

vcr will create a tape for vhs, based on a regular shell script, allowing creation of a demo without manual intervention with the vhs shell, and ensuring that the commands are correct.

Some vhs behavior can be controlled in a command-by-command basis using comments in the script with the tag vcr: (as in # vcr:).

The available commands are:

  • clear[=<time>]: Clear the screen before the next command, after the specified amount of time. Default time is 3s.
  • hide: Hide commands
  • show: Show commands (after hide)
  • wait="[+context] <regex>": Wait context and regex. By default vcr waits for a prompt ending with with [$#] *.
  • prompt=/<regex>/: Set the prompt to wait before executing the next command
  • timeout=<time>: Modify the default timeout to wait for a command. Default is 10s.
  • sleep=<time>: Wait some specific amount of time. Use s for seconds, ms for miliseconds, and m for minutes. Note: Using sleep will override wait.

Multiple commands can be used an one, as in # vcr: show clear wait="+OK"

In a vcr comment, anything after -- is ignored.

Comments on the original script are "typed" in the final demo, so there's a way to give instructions to the audience.

About

A tool to record vhs demos.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages