Ironflow is pre-1.0: APIs can change between releases. Pin a version. What is ready →
- CLI Reference
- Commands
- ironflow subscribe
ironflow subscribe
Subscribe to real-time events via WebSocket.
ironflow subscribe [patterns...] [flags]Connects to the server’s WebSocket endpoint and streams events matching the given NATS-style patterns.
Arguments:
| Argument | Required | Description |
|---|---|---|
patterns | Yes (1+) | NATS-style topic patterns to subscribe to |
Flags:
| Flag | Short | Type | Default | Description |
|---|---|---|---|---|
--server | -s | string | ws://localhost:9123/ws (derived from IRONFLOW_SERVER_URL if set) | WebSocket server URL |
--replay | -r | int | 0 | Number of historical events to replay |
--json | -j | bool | false | Output events as JSON (one per line) |
--metadata | -m | bool | false | Include event metadata (timestamp, sequence) |
--keep-stale | bool | false | Print 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:
# Subscribe to all run eventsironflow subscribe "system.run.>"
# Subscribe to user eventsironflow subscribe "events:order.placed"
# Multiple patterns with replayironflow subscribe --replay 10 "system.run.>" "events:>"