spaship-beta

SPAship CLI

A command line interface for SPAship.

• SPAship CLI
• Usage
• Commands
• Writing tests

Usage

$ npm install -g spaship-beta
$ spaship COMMAND
running command...
$ spaship (-v|--version|version)
spaship-beta/2.0.1 darwin-x64 node-v14.18.1
$ spaship --help [COMMAND]
USAGE
  $ spaship COMMAND
...

Commands

• spaship help [COMMAND]
• spaship init
• spaship login
• spaship pack
• spaship upload [ZIP]

spaship help [COMMAND]

display help for spaship

USAGE
  $ spaship help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

spaship init

Initialize a SPAship config file for your app.

USAGE
  $ spaship init

OPTIONS
  -b, --builddir=builddir  path of your SPAs artifact. Defaults to 'buildDir' if specified in the spaship.yaml.
  -d, --dist=dist          the URL path for dist folder
  -m, --file=file          the URL path for .spaship file

DESCRIPTION
  Without arguments, init will ask you a few questions and generate a .spaship config file.

EXAMPLES
  $ spaship init --file=/home/shranand/Documents/one-platform/packages/home-spa 
  --dist=/home/shranand/Documents/one-platform/packages/home-spa/dist
  $ spaship init --builddir=build

See code: src/commands/init.js

spaship login

Authenticate and Authorize users inorder to deploy SPA

USAGE
  $ spaship login

OPTIONS
  -s, --server=server  orchestrator-base-url it is responsible for loading file from cli
  -t, --token=token    jwt token for authentication

DESCRIPTION
  user access token && server url is saved inside config file(.spashipsessionrc.yaml) .
  spaship login command can be copied from web-ui.

EXAMPLES
  $ spaship login --token=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiS 
  --server=http://dev.api.apps.int.spoke.preprod.us-west-2.aws.paas.redhat.com
  Here server refer to api Base-URL && token refer to jwt access token for authorization

See code: src/commands/login.js

spaship pack

pack the distribution folder

USAGE
  $ spaship pack

DESCRIPTION
  create and save the zip file of distribution folder which is consist of SPA content inside tmp.

EXAMPLE
  $ spaship pack

See code: src/commands/pack.js

spaship upload [ZIP]

deploy to a SPAship host

USAGE
  $ spaship upload [ZIP]

ARGUMENTS
  ZIP  An archive (zip) file containing SPA static assets and a .spaship configfile.

DESCRIPTION
  Send zip file containing a SPA to a SPAship host for deployment.

EXAMPLES
  $ spaship upload your-app-1.0.0.zip #here your-app-1.0.0.zip refer to zip created by pack command
  $spaship upload # will prompt to enter your-app-1.0.0.zip
  If no your-app-1.0.0.zip is provided it will zip and upload it.

See code: src/commands/upload.js

Writing tests

Tests are written using oclif's testing tools. See oclif's testing documentation for more.