Socotra Scripting CLI

A command-line interface for querying and streaming events from the Socotra Scripting API

Changelog

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/scripts-cli

Install as a local package:

npm install @socotra/scripts-cli

Usage

Usage: socotra-scripts [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] [searchText]             stream scripting logs from the Socotra Scripting API
  query [options] [searchText]              query scripting logs from the Socotra Scripting API
  event [options] <requestId> [searchText]  query scripting logs for a specific event identified by requestId
  help [command]                            display help for command

For Socotra Scripting API documentation see https://docs.socotra.com/production/api/scripts.html

Usage: stream

Usage: socotra-scripts stream [options] [searchText]

stream scripting logs from the Socotra Scripting API

Options:
  --nested           query and display nested log events identified by requestId
  --poll <interval>  polling interval in seconds (default: "5")
  --limit <count>    limit number of log entries per request (default: "100")
  -h, --help         display help for command

Usage: query

Usage: socotra-scripts query [options] [searchText]

query scripting logs from the Socotra Scripting API

Options:
  --nested             query and display nested log events identified by requestId
  --start <timestamp>  query events from <timestamp>
  --end <timestamp>    query events to <timestamp>
  --descending         show log events in descending order, default is ascending order or oldest first (default: false)
  --limit <count>      limit number of log entries per request (default: "100")
  -h, --help           display help for command

Usage: event

Usage: socotra-scripts event [options] <requestId> [searchText]

query scripting logs for a specific event identified by requestId

Options:
  --descending     show log events in descending order, default is ascending order or oldest first (default: false)
  --limit <count>  limit number of log entries per request (default: "100")
  -h, --help       display help for command