CLICommands

fsm

snug fsm <COMMAND>

Finite State Machine operations.

Subcommands

CommandWhat it does
createCreate a new FSM definition
getGet FSM definition
listList all FSM definitions
entity-listList entities for an FSM definition (optionally filtered by state)
deleteDelete FSM definition
transitionTransition an entity to a new state
stateGet entity state
historyGet entity transition history
delete-entityDelete entity
bulk-transitionBulk transition multiple entities
bulk-transition-itemsBulk transition entities to heterogeneous targets from a JSON file
metricsGet FSM metrics
dead-letterList dead-letter (failed timeout) entries for an FSM

Run snug fsm <command> --help for that command's own options. The global options apply everywhere.

Examples

snug fsm create -n order -i pending -f states.json
snug fsm get -n order
snug fsm get -n order --mermaid
snug fsm list
snug fsm entity-list -n order -s processing
snug fsm delete -n order --force
snug fsm transition -n order -e order123 -t processing
snug fsm state -n order -e order123
snug fsm history -n order -e order123 -l 20
snug fsm delete-entity -n order -e order123
snug fsm bulk-transition -n order -e order123,order456 -t fulfilled
snug fsm bulk-transition-items -n order -f transitions.json
snug fsm metrics -n order
snug fsm dead-letter -n order -l 50

Next

  • fsm guide - what the service does and when to reach for it.
  • API reference - every endpoint these commands call.
  • CLI reference - global options, output modes, and exit codes.

On this page