@socotra/app-cli

Socotra App CLI

A command-line interface for managing and publishing Socotra App Store Apps.

Designed for local use on Windows, macOS, or Linux systems.

Changelog

Installation

Install globally:

npm install -g @socotra/app-cli

Install as a local package:

npm install @socotra/app-cli

Arguments and Environment Variables

Prefer CLI options (arguments) whenever possible, but some commands interact with Docker and rely upon:

DEFAULT_API # upload target for publish docker $IMAGE_NAME
DOCKER_HTTP=http://localhost # source for images
DOCKER_PIPE=//./pipe/docker_engine
DOCKER_SOCK=/var/run/docker.sock

The DOCKER_PIPE is used on Windows, DOCKER_SOCK on other operating systems, and other env vars on both.

Usage

Usage: socotra-app [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:
  init [options] [name] [version]  initialise an App Store package
  version [options] <release>      bump an app version
  publish <from> <fromUri>         publish an app to the Socotra App Store
  help [command]                   display help for command

Usage: init

Usage: socotra-app init [options] [name] [version]

initialise an App Store package

Options:
  --description <text>  package description
  --author <text>       package author
  -h, --help            display help for command

Usage: version

Usage: socotra-app version [options] [<newversion> | major | premajor | minor | preminor | patch | prepatch | prerelease]

bump an app version

Options:
  --preid <identifier>  A prerelease identifier such as: alpha or beta
  -h, --help            display help for command

Usage: publish

Usage: socotra-app publish [options] <file|docker> <uri>

publish an app to the Socotra App Store

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