Socotra Utils CLI

A command-line interface for miscellaneous Socotra utils.

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

Install as a local package:

npm install @socotra/utils-cli

Usage

Usage: socotra-utils [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
  -h, --help                          display help for command

Commands:
  data-dictionary [options] <folder>  generate data dictionary csv file
  copy-policy [options]               Copy a policy response JSON into a policy create JSON
  render-document [options]           Render a document from a policy
  help [command]                      display help for command

Usage: data-dictionary

Usage: socotra-utils data-dictionary [options] <folder>

generate data dictionary csv file

Options:
--output <filename>  filename (default: "output.csv")
-h, --help           display help for command

Usage: copy-policy

Usage: socotra-utils copy-policy [options]

Copy a policy response JSON into a policy create JSON

Options:
  --policy <locator>         lookup a policy by locator
  --file <filename>          read policy json from file
  -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

Usage: render-document

Usage: socotra-utils render-document [options]

Render a document from a policy

Options:
  -i --policy <locator>      lookup a policy by locator
  -d --document <fileName>   supply liquid document template file
  -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