Skip to main content
The Gateway publishes realtime events on a private WebSocket channel. realtime:show shows where that channel is. realtime:tail connects to it and prints each event as it arrives. Realtime needs an active websocket role, as Realtime events with Reverb describes.

​
Commands

Both commands accept --json.

​
orbit realtime:show

Ask the active Gateway where its Reverb server is and which key and channel a client uses.
Human output shows Status (configured or not configured), URL, Channel, and Key. The key is public. The Reverb app secret never leaves the Gateway. URL and Key show — when no Node holds an active websocket role. JSON returns { "url", "key", "channel", "request_id" }, with url and key null in that case. channel is always orbit.

​
orbit realtime:tail

Connect to the orbit channel and print every event until you stop the command.
The command asks the Gateway for the connection, as realtime:show does, and signs its subscription through the Gateway. Human output prints one line per event: <at> <type> <summary>, where the summary lists the data fields as key=value pairs. JSON output prints the { type, id, at, data } envelope, one object per line. Press Ctrl-C to stop. When the socket drops, the command reconnects after 1, 2, 4, 8, and 16 seconds, and then every 30 seconds. It keeps trying, so it survives a Gateway restart or a short network loss.