Socotra Event Stream CLI
A command-line interface for querying and streaming events from the Socotra Event Stream API
Installation
Install globally as a part of the @socotra/cli tools:
npm install -g @socotra/cli
Install as a globally available standalone tool:
npm install -g @socotra/events-cli
Install as a local package:
npm install @socotra/events-cli
Usage
Usage: socotra-events [options] [command]
Options:
--ci change output when running as a CI process
--no-title turn off title and banner output
--no-banner turn off banner output
--no-styling turn off terminal styling and colours
--no-progress turn off progress bars and spinners
-V, --version output the version number
-c, --connect <name> connect via Socotra profile
-a, --api <uri> the API URI
-n, --hostName <hostName> hostname
-u, --username <username> username
-p, --password <password> password
-h, --help display help for command
Commands:
stream [options] [eventName] stream events from the Socotra Event Stream
query [options] [eventName] query events from the Socotra Event Stream
help [command] display help for command
For Socotra Event Stream API documentation see https://docs.socotra.com/production/api/event-stream.html
Usage: stream
Usage: socotra-events stream [options] [eventName]
stream events from the Socotra Event Stream
Options:
--poll <interval> polling interval in seconds (default: "5")
--pageSize <size> page size (default: "100")
-h, --help display help for command
-h, --help display help for command
Usage: query
Usage: socotra-events query [options] [eventName]
query events from the Socotra Event Stream
Options:
--start <timestamp> query events from <timestamp>
--end <timestamp> query events to <timestamp>
--poll <interval> polling interval in seconds (default: "5")
--pageSize <size> page size (default: "100")
-h, --help display help for command