Welcome to asciinema-director’s documentation!¶

Warning

This project is in alpha stage, and is not ready for testing. Consult the github project page for more information.

asciinema-director is an easier way to use asciinema, the amazing terminal recording tool.

Getting Started¶

I’ve used asciinema for a very long time and the biggest problem is making flawless recordings. It is hard to avoid making mistakes, especially when creating a long recording. Also, sometimes, you’re in the middle of recording and you want to consult documentation.

asciinema-director is a library that uses pexpect to interact with asciinema to create the cast files for you. It makes it so that you can write your commands into a screenplay file, sit back and relax.

Installation¶

Use pip.

$ pip install asciinema-director
$ asciinema-director --help                                                                                                                                                      git:(master*)
Usage: asciinema-director [OPTIONS] SRC DEST

Options:
-D, --delay FLOAT
--help             Show this message and exit.

Screenplay File¶

The screenplay file is the instruction file that you provide.

Todo

Design the screenplay file format.

API¶

Todo

Include documentation for the source code here.

asciinema_director.director¶

director file, contains core logic.

asciinema_director.director.direct(commands, destination, delay=0.001)[source]¶: Converts a source instruction file into destination recording.

asciinema_director.director.direct_from_file(src_file, destination, delay=0.001)[source]¶: Create asciicast file from source file.