Command line usage reference

This is a full reference for shakespeare commands and usage. The same information is available by using the option --help on the CLI commands themselves.

shakespeare

Run or debug Shakespeare Programming Language plays, or start a console.

shakespeare alone without a subcommand starts a console.

Usage:

shakespeare [OPTIONS] COMMAND [ARGS]...

Options:

  --characters TEXT  Characters to make available to the console, separated by
                     commas. Default is Romeo and Juliet.

  --help             Show this message and exit.

console

Run a Shakespeare Programming Language console.

Usage:

shakespeare console [OPTIONS]

Options:

  --characters TEXT  Characters to make available to the console, separated by
                     commas. Default is Romeo and Juliet.

  --help             Show this message and exit.

debug

Execute the Shakespeare Programming Language play located at filepath FILE, pausing at breakpoints.

Usage:

shakespeare debug [OPTIONS] FILE

Options:

  --input-style TEXT   Input style to use. 'interactive' is the default and
                       nicer when getting input from a human. 'basic' is best
                       for piped input.

  --output-style TEXT  Output style to use. 'verbose' is the default, prefixes
                       output, and shows visible representations of whitespace
                       characters. 'basic' outputs exactly what the SPL play
                       generated. 'debug' is like 'verbose' but with debug
                       output from the interpreter.

  --help               Show this message and exit.

run

Execute the Shakespeare Programming Language play located at filepath FILE.

Usage:

shakespeare run [OPTIONS] FILE

Options:

  --input-style TEXT   Input style to use. 'basic' is the default and best for
                       piped input. 'interactive' is nicer when getting input
                       from a human.

  --output-style TEXT  Output style to use. 'basic' is the default and outputs
                       exactly what the SPL play generated. 'verbose' prefixes
                       output and shows visible representations of whitespace
                       characters. 'debug' is like 'verbose' but with debug
                       output from the interpreter.

  --help               Show this message and exit.