CLI: Realtime
Publish to channels, list channels and presence, replay messages and manage end-to-end encryption keys with sov.
sov realtime
Realtime stream and E2EE
sov realtime subscribe
Subscribe a client to a channel.
sov realtime subscribe [OPTIONS] CHANNEL CLIENT_IDArguments and options
CHANNELtextrequiredCLIENT_IDtextrequired
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov realtime unsubscribe
Unsubscribe a client from a channel.
sov realtime unsubscribe [OPTIONS] CHANNEL CLIENT_IDArguments and options
CHANNELtextrequiredCLIENT_IDtextrequired
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov realtime presence
Show online clients for a channel.
sov realtime presence [OPTIONS] CHANNELArguments and options
CHANNELtextrequired
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov realtime channels
List active channels in current scope.
sov realtime channels [OPTIONS]- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov realtime replay
Replay channel events from a sequence index.
sov realtime replay [OPTIONS] CHANNELArguments and options
CHANNELtextrequired--afterintegeroptionaldefault0--limitintegeroptionaldefault200
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov realtime publish
Publish a payload on a channel.
sov realtime publish [OPTIONS] CHANNEL PAYLOADArguments and options
CHANNELtextrequiredPAYLOADtextrequired- JSON object payload
--clocktextoptional- JSON object clock
--clock-deltatextoptional- JSON object clock delta
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov realtime dry-run
Would this app caller be allowed to subscribe/publish?
sov realtime dry-run [OPTIONS] CHANNELChecks the channel rules; sends nothing.
Arguments and options
CHANNELtextrequired--actiontextoptionaldefaultSUBSCRIBE- SUBSCRIBE or PUBLISH
--usertextoptional- An app user's id (default: anonymous visitor)
--rolestextoptional- Comma-separated app roles of that user
--payloadtextoptional- JSON object (only measured)
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov realtime e2ee-bootstrap
Create or fetch active E2EE key material.
sov realtime e2ee-bootstrap [OPTIONS] CHANNELArguments and options
CHANNELtextrequired--ttlintegeroptionaldefault86400--force-newflagoptional
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov realtime e2ee-rotate
Rotate E2EE key material.
sov realtime e2ee-rotate [OPTIONS] CHANNELArguments and options
CHANNELtextrequired--ttlintegeroptionaldefault86400
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov realtime e2ee-revoke
Revoke an E2EE key.
sov realtime e2ee-revoke [OPTIONS] CHANNELArguments and options
CHANNELtextrequired--key-idtextoptional--reasontextoptional
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov realtime e2ee-list
List E2EE keys for a channel.
sov realtime e2ee-list [OPTIONS] CHANNELArguments and options
CHANNELtextoptional- Channel name (defaults to 'default')
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
sov realtime ws-url
Generate websocket URL for Pulse via gateway.
sov realtime ws-url [OPTIONS] CHANNELArguments and options
CHANNELtextoptional- Channel name (defaults to 'default')
--tickettextoptional- Use an already issued WS ticket
- Also takes
--profile,--org,--projectand--envto act on another account, organization, project or environment.
Something unclear or missing on this page?Tell us