xsm (package xstate-statemachine-cli)

The command-line companion of xstate-statemachine: validate, inspect, diagram, document, simulate and analyse XState machines, serve the Stately Inspector locally, and inspect snapshot stores, from the terminal. Output is plain text when piped; --json is available on the analysis commands. Exit codes: 0 success, 1 findings or a failed run, 2 usage error.

cargo install xstate-statemachine-cli   # installs the `xsm` binary
xsm validate machine.json                 # build with the real engine, report every finding
xsm inspect machine.json                  # state tree, transitions, logic, policies
xsm diagram machine.json -f mermaid       # mermaid | plantuml | json
xsm simulate machine.json -e GO,+500,STOP --record run.jsonl
xsm paths machine.json --simple           # every acyclic path (default: a shortest path to each configuration)
xsm inspect machine.json --live           # Stately Inspector over SSE, driven from stdin
xsm replay run.jsonl --live --speed 1     # replay a recording into the Inspector
xsm snapshots --store sqlite:///app.db machine.json --stale      # records labelled with another machine version
xsm snapshots --store sqlite:///app.db machine.json --stale --stale-by hash   # structure hash differs

snapshots --stale follows the Python CLI: a record is stale when its machine_version label differs from the machine JSON’s version (an unversioned machine or an unlabelled record is never stale). --stale-by version|hash|either (default version) picks the rule, and the table and --json always report a hash_mismatch flag, the structure difference restore would refuse. Only sqlite:/// and file:/// stores are readable; there is no memory://. validate treats unknown keys as errors unless --lenient.

Features

None. Binary crate; depends on xstate-core, xstate-persistence and xstate-inspect.

Python counterpart

xstate_statemachine.cli (python -m xstate_statemachine, also installed as xsm).