Skip to content
Ironflow is pre-1.0: APIs can change between releases. Pin a version. What is ready →

ironflow subscribe

Subscribe to real-time events via WebSocket.

Terminal window
ironflow subscribe [patterns...] [flags]

Connects to the server’s WebSocket endpoint and streams events matching the given NATS-style patterns.

Arguments:

ArgumentRequiredDescription
patternsYes (1+)NATS-style topic patterns to subscribe to

Flags:

FlagShortTypeDefaultDescription
--server-sstringws://localhost:9123/ws (derived from IRONFLOW_SERVER_URL if set)WebSocket server URL
--replay-rint0Number of historical events to replay
--json-jboolfalseOutput events as JSON (one per line)
--metadata-mboolfalseInclude event metadata (timestamp, sequence)
--keep-staleboolfalsePrint all frames, bypassing version ordering and remembered deletion

Run and step frames are ranked independently by their full identity. A strictly lower positive version is dropped; ties and unknown versions pass. A deletion remembers its run ID and drops later run and step frames, including unversioned ones, until that ID is evicted from the shared 10,000-identity cache. Pass --keep-stale to print every frame, with --json or without. See Run frames and ordering.

Examples:

Terminal window
# Subscribe to all run events
ironflow subscribe "system.run.>"
# Subscribe to user events
ironflow subscribe "events:order.placed"
# Multiple patterns with replay
ironflow subscribe --replay 10 "system.run.>" "events:>"