CLI Reference


A utility to generate a printable screenplay.

The output is HTML. It is styled to be an input to WeasyPrint, so you can ultimately create a script in PDF format.

There are command line options to change the timing of dialogue, to repeat the action, and to control the number of roles an entity may take.

Example (see the episode Blue Monday):

turberfield-dialogue    --references=bluemonday78.logic:references
usage: turberfield-dialogue [-h] [--version] [-v] [--log LOG_PATH]
                            [--references REFERENCES] [--folder FOLDER]
                            [--roles ROLES] [--strict] [--repeat REPEAT]
                            [--pause PAUSE] [--dwell DWELL]



Print the current version number

-v, --verbose

Increase the verbosity of output


Set a file path for log output


Give an import path to a list of Python references.


Give a sequence of import paths to SceneScript folders.


The number of roles [1] permitted for each member of cast.


Only perform fully-cast scene files.


Repeat the performance [0] times.


Time in seconds [1.2] to pause after a line.


Time in seconds [0.3] to dwell on each word.



This tool has a web mode which is experimental. It may not work perfectly in your web browser.

It also presents a potential security risk while it is running, since its CGI interface facilitates code execution on your computer.

Always check that your PC firewall does not permit outside access to the port configured by the program options. If in doubt, disconnect your PC from all networks while web mode is in operation.