Skip to content

fsm

Description

Implement fsm tooling.

Subcommands

from-file

Convert between FSM specification formats.

Required Parameters:

fsm_spec: Path to the FSM specification file

fsm_name: Name of the FSM to process

Optional Parameters:

in_type: Input format type (fsm_spec or mermaid). (Default: fsm_spec)

output: Output format type (fsm_spec or mermaid). (Default: mermaid)

output_path: Path to write the output to. If not provided, prints to stdout.

Usage:

Convert FSM spec to mermaid and save to file:
    adev fsm from-file fsm_specification.yaml testAbciApp --output-path diagram.mmd

Convert FSM spec to mermaid and print to stdout:
    adev fsm from-file fsm_specification.yaml testAbciApp

Convert FSM spec to FSM spec (validation):
    adev fsm from-file fsm_specification.yaml testAbciApp --output fsm_spec

Convert from mermaid to FSM spec:
    adev fsm from-file diagram.mmd testAbciApp --in-type mermaid --output fsm_spec

Convert mermaid to mermaid (validation):
    adev fsm from-file diagram.mmd testAbciApp --in-type mermaid