An application that automates Command-Line Interface (CLI) screencast output.
Go to file
starkandwayne-bot b42e8ccdf9 Updating CODE_OF_CONDUCT.md 2019-01-15 15:41:04 -05:00
bin add initial binary 2017-08-13 20:53:29 -06:00
CODE_OF_CONDUCT.md Updating CODE_OF_CONDUCT.md 2019-01-15 15:41:04 -05:00
LICENSE Add Apache 2.0 License 2017-08-13 20:46:24 -06:00
README.md Cleanup text formatting. 2017-08-13 20:38:46 -06:00
hello-world add hello-world 2017-08-13 21:24:05 -06:00

README.md

scriptcast

An application that automates Command-Line Interface (CLI) screencast output.

Introduction

By using scriptcast, you can make the output of a tutorial:

  • repeatable
  • maintainable
  • interactive

Install

One click install goes here.  Essentially it will put the script in user's path.

Dependencies

The randtype tool puts random mistakes while typing to look more natural.

git clone git@github.com:norman-abramovitz/randtype.git
cd randtype
sudo make install

Asciinema records our output.

brew install asciinema

Commands

command Argument Description
prompt Does a simple command line prompt.
display command Just types out the command without executing.
pause A manual delay. Pause accepts the letter c (ontinue) and b(reak) so the next command can be be executed. CTRL-D will exit right away. See the repeat command for the reason for the two letter commands.
repeat command Repeats the execution of the same command using the pause command. The additional executions runs faster.
run command Types the command at Norman's typing speed. 😄 Once the command finishes it will print the prompt.
run_fast command Same as run but typing speed is slightly faster.
run_normal command Same as run but no typing delay.
erdiff old-file new-file Hopefully an easier reading of showing a file difference

Hello World

  1. Create a file.
  2. Run that file with scriptcast.
  3. Profit!