# @cartona/deploy-cli

> Deploy changes to an Ionic app for live update

Latest version **0.0.5** (published 2025-03-18) · UNLICENSED license · 0 weekly downloads

## Install

```sh
npm install @cartona/deploy-cli
pnpm add @cartona/deploy-cli
yarn add @cartona/deploy-cli
bun add @cartona/deploy-cli
```

Provides the command `deploy`.

## Health

**Score 25/100 (F)** — status: maintenance-mode.

Positive: no vulnerabilities.

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

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2025-03-18 |
| First published | 2023-07-25 |
| Weekly downloads | 0 |
| License | UNLICENSED |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 58.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | sam.atawy@cartona.com |
| Maintainers | hamdy.khalil, samatawy, mazenaboelanin |

## Links

- npm: https://www.npmjs.com/package/@cartona/deploy-cli
- npm.io page: https://npm.io/package/@cartona/deploy-cli

## Dependencies (4)

- [nconf](https://npm.io/package/nconf.md) ^0.12.0
- [archiver](https://npm.io/package/archiver.md) ^5.3.1
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.0
- [prompt-sync](https://npm.io/package/prompt-sync.md) ^4.2.0

## Recent versions

- 0.0.5 (latest) — 2025-03-18
- 0.0.4 — 2023-07-30
- 0.0.3 — 2023-07-29
- 0.0.2 — 2023-07-25
- 0.0.1 — 2023-07-25

## README

# Cartona Live Update CLI

A replacement for AppFlow's live update feature.

You need to be granted access to Cartona's `deploy-api` server (by default at `deploy-api.cartona.com`).

You also need to add code in your Ionic app using `@capgo/capacitor-updater`.

### Using the CLI

Start by installing the CLI globally and access it from the command line in your project folder.

    npm install -g @cartona/deploy-cli

You can also install it locally and then access the `deploy` command from inside `package.json` or using `npm-exec`.
 
    npm install --save-dev @cartona/deploy-cli

In your project you must also run the following:

    npm install @capgo/capacitor-updater
    npx cap sync

Run `deploy help` to learn the available commands and parameters.

Using the credentials provided to you by the server administrator run `deploy login` at least once.

Whenever a live update is required for an Ionic project, just follow the following steps:

    ionic build
    deploy upload

Commands will prompt you to provide the required parameters. Alternatively you can pass them as arguments. For example:

    deploy upload app=retailer dir=./www

Save common commands and parameters in your `package.json` scripts.


### Server management

The `update-api` server has its own API but most common tasks can be performed from this CLI. For example:

```
    deploy list builds app=retailer
    deploy list permissions app=retailer
    deploy grant username=ahmed app=retailer can_upload=1
```

Run `deploy help` to learn the available commands and parameters.

### Enabling Ionic apps

To receive updates from a `deploy-api` server, you need a capacitor plugin `@cartona/deploy-capacitor`.

This is available in its own repository and on NPM.

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