Socotra Aux-Data CLI

A command-line interface for deploying a Socotra configuration.

!npm

Changelog

Installation

Install globally as a part of the @socotra/cli tools:

``code
npm install -g @socotra/cli
`

Install as a globally available standalone tool:

`code
npm install -g @socotra/aux-cli
`

Install as a local package:

`code
npm install @socotra/aux-cli
`

Usage

`code
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 connect via Socotra profile
-a, --api the API URI
-n, --hostName hostname
-u, --username username
-p, --password password
-h, --help display help for command

Commands:
ls [page] fetch a list of keys for a given locator
get retrieve a single auxiliary data record
delete [options] delete an auxiliary data record
set [options] [value] set or update an auxiliary data record
edit [options] 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

`code
Usage: socotra-aux ls [options] [page]

fetch a list of keys for a given locator

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

Usage: get

`code
Usage: socotra-aux get [options]

retrieve a single auxiliary data record

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

Usage: delete

`code
Usage: socotra-aux delete [options]

delete an auxiliary data record

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

Usage: set

`code
Usage: socotra-aux set [options] [value]

set or update an auxiliary data record

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

Usage: edit

`code
Usage: socotra-aux edit [options]

edit an auxiliary data record

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