Command-line interface

Synopsis

state-mate [OPTIONS] SOURCE

Arguments

SOURCE

Path to an existing Sismic YAML file.

The argument must point to a file. State Mate passes it to sismic.io.import_from_yaml().

Options

-o, --output PATH

Write generated Python source to PATH.

If omitted, State Mate writes the generated source to standard output.

Parent directories are created automatically when an output path is provided.

Errors

State Mate reports a CLI error and exits unsuccessfully when:

  • Sismic cannot import or validate the source document;
  • the imported statechart is outside State Mate's supported subset;
  • state names collide after conversion to Python Enum member names;
  • event names collide after conversion to Python identifiers.