Socotra Aux-Data CLI

A command-line interface for deploying a Socotra configuration.

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

Install as a local package:

npm install @socotra/aux-cli

Usage

Usage: socotra-aux [options] [command]

Options:
  --debug                                output debugging info
  --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:
  ls <locator> [page]                    fetch a list of keys for a given locator
  get <locator> <key>                    retrieve a single auxiliary data record
  delete [options] <locator> <key>       delete an auxiliary data record
  set [options] <locator> <key> [value]  set or update an auxiliary data record
  edit [options] <locator> <key>         edit an auxiliary data record
  help [command]                         display help for command

For Socotra Auxiliary Data API documentation see https://docs.socotra.com/production/api/auxiliary-data.html

Usage: ls

Usage: socotra-aux ls [options] <locator> [page]

fetch a list of keys for a given locator

Options:
  -h, --help  display help for command

Usage: get

Usage: socotra-aux get [options] <locator> <key>

retrieve a single auxiliary data record

Options:
  -h, --help  display help for command

Usage: delete

Usage: socotra-aux delete [options] <locator> <key>

delete an auxiliary data record

Options:
  -y, --yes   do not ask for confirmation (default: false)
  -h, --help  display help for command

Usage: set

Usage: socotra-aux set [options] <locator> <key> [value]

set or update an auxiliary data record

Options:
  --uiType <uiType>  uiType
  -y, --yes          do not ask for confirmation (default: false)
  -h, --help         display help for command

Usage: edit

Usage: socotra-aux edit [options] <locator> <key>

edit an auxiliary data record

Options:
  --uiType <uiType>  uiType
  -h, --help         display help for command