@collabco/myday-deploy-app

Utility to upload and update apps on myday platform, by Collabco.

Prerequisites

Please contact Collabco Support for API and authentication details.

Command Line Interface

To start using CLI, install the module globally:

npm install --global @collabco/myday-deploy-app

Usage:

myday-deploy-app [options]

Use npx to run it anywhere, for example in CI/CD pipelines:

npx @collabco/myday-deploy-app [options]

Example v2 deployment:

myday-deploy-app \
  --appId "tenantalias.appname" \
  --file "path/to/app.zip" \
  --platform "v2" \
  --tenantId "Your tenant ID" \
  --apiUrl "Base URL for myday APIs" \
  --idSrvUrl "Base URL for myday Identity Server" \
  --clientId "Your client ID" \
  --clientSecret "Your client secret" \
  --verbose \
  --dryRun

Example v3 deployment:

myday-deploy-app \
  --appId "tenantalias.appname" \
  --file "path/to/app.zip" \
  --tenantId "Your tenant ID" \
  --apiUrl "Base URL for myday APIs" \
  --idSrvUrl "Base URL for myday Identity Server" \
  --clientId "Your client ID" \
  --clientSecret "Your client secret" \
  --verbose \
  --dryRun

Node Interface

To start using Node interface, install the module locally:

npm install --save-dev @collabco/myday-deploy-app

Usage:

const MydayDeployApp = require('@collabco/myday-deploy-app');

const config = {
  appId: 'tenantalias.appname',
  file: 'path/to/app.zip',
  tenantId: 'Your tenant ID',
  apiUrl: 'Base URL for myday APIs',
  idSrvUrl: 'Base URL for myday identity server',
  clientId: 'Your client ID',
  clientSecret: 'Your client secret',
  verbose: true,
  dryRun: true
};

const instance = new MydayDeployApp(config).start();

Configuration

App options:

• appId (required): Application ID, e.g. tenantalias.appname
• file (required): Path to a zip archive with an app

Platform options:

• platform (optional): Platform version, either v3 (default) or v2
• tenantId (optional): Tenant ID, required for tenant-level apps
• apiUrl (required): Base URL for myday APIs

Identity Server options:

• idSrvUrl (required): Base URL for myday Identity Server
• clientId (required): OAuth client ID
• clientSecret (required): OAuth client secret

Additional options:

• verbose (optional): Verbose mode (additional output)
• silent (optional): Silent mode (disable output)
• dryRun (optional): Dry run, does not upload the app

CLI only options:

• help: Displays help
• version: Displays package version