# @collabco/myday-deploy-app

> Utility to upload and update apps on myday platform

Latest version **1.0.6** (published 2021-08-24) · 0 weekly downloads

## Install

```sh
npm install @collabco/myday-deploy-app
pnpm add @collabco/myday-deploy-app
yarn add @collabco/myday-deploy-app
bun add @collabco/myday-deploy-app
```

Provides the command `myday-deploy-app`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2021-08-24 |
| First published | 2019-12-07 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=12.0.0 |
| Dependencies | 4 |
| Unpacked size | 15.5 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Kamil Burek |
| Maintainers | kamilbrk, cbc-jordan-fletcher |
| Keywords | collabco, myday, cli |

## Links

- npm: https://www.npmjs.com/package/@collabco/myday-deploy-app
- Repository: https://github.com/Collabco/myday-deploy-app
- Issues: https://github.com/Collabco/myday-deploy-app/issues
- npm.io page: https://npm.io/package/@collabco/myday-deploy-app

## Dependencies (4)

- [chalk](https://npm.io/package/chalk.md) 4.1.2
- [yargs](https://npm.io/package/yargs.md) 17.1.1
- [request](https://npm.io/package/request.md) 2.88.0
- [request-promise-native](https://npm.io/package/request-promise-native.md) 1.0.8

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.0.6 (latest) — 2021-08-24
- 1.0.5 — 2019-12-09
- 1.0.4 — 2019-12-08
- 1.0.3 — 2019-12-08
- 1.0.2 — 2019-12-07
- 1.0.1 — 2019-12-07
- 1.0.0 — 2019-12-07

## README

# @collabco/myday-deploy-app

[![npm-version](https://img.shields.io/npm/v/@collabco/myday-deploy-app)](https://www.npmjs.com/package/@collabco/myday-deploy-app) [![node-version](https://img.shields.io/node/v/@collabco/myday-deploy-app)](https://nodejs.org) [![dependencies](https://img.shields.io/librariesio/release/npm/@collabco/myday-deploy-app)](https://github.com/Collabco/myday-deploy-app/blob/master/package.json)

[![myday](./myday.png)](https://myday.collabco.com)

Utility to upload and update apps on [myday](https://myday.collabco.com) platform, by [Collabco](https://collabco.com).


## Prerequisites

Please contact Collabco Support for API and authentication details.

## Command Line Interface

To start using CLI, install the module globally:

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

Usage:

```bash
myday-deploy-app [options]
```

Use [`npx`](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) to run it anywhere, for example in CI/CD pipelines:
```bash
npx @collabco/myday-deploy-app [options]
```

Example v2 deployment:

```bash
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:

```bash
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:

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

Usage:

```js
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

---
_Source: https://npm.io/package/@collabco/myday-deploy-app · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._