Socotra Deploy 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/deploy-cli

Install as a local package:

npm install @socotra/deploy-cli

Usage

Usage: socotra-deploy [options] [command]

Options:
  --ci                                          change output when running as a CI process
  --prod                                        deploy to production (i.e. non sandbox) environment
  --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:
  zip [options] <folder> <archive>              create a Socotra tenant configuration archive ready for deployment
  file [options] <archive> <tenant>             deploy a Socotra tenant configuration archive
  folder [options] <folder> <tenant> [archive]  deploy a Socotra tenant configuration folder
  help [command]                                display help for command

Usage: zip

Usage: socotra-deploy zip [options] <folder> <archive>

create a Socotra tenant configuration archive ready for deployment

Options:
  -o, --overwrite  overwrite <archive> if it exists
  -h, --help       display help for command

Usage: file

Usage: socotra-deploy file [options] <archive> <tenant>

deploy a Socotra tenant configuration archive

Options:
  -c, --connect <name>       connect via Socotra profile
  -a, --api <url>            the fully qualified Socotra API URL
  -u, --username <username>  username
  -p, --password <password>  password
  -A, --adminApi <url>       the fully qualified Admin API URL (can be inferred from API URL)
  -m, --mode                 set the deployment mode
  --prod                     an alias for --mode production
  -h, --help                 display help for command

Usage: folder

Usage: socotra-deploy folder [options] <folder> <tenant> [archive]

deploy a Socotra tenant configuration folder

Options:
  -c, --connect <name>       connect via Socotra profile
  -a, --api <url>            the fully qualified Socotra API URL
  -u, --username <username>  username
  -p, --password <password>  password
  -A, --adminApi <url>       the fully qualified Admin API URL (can be inferred from the API)
  -o, --overwrite            overwrite [archive] if it exists
  -m, --mode                 set the deployment mode
  --prod                     an alias for --mode production
  -h, --help                 display help for command