> ## Documentation Index
> Fetch the complete documentation index at: https://patch.codemagic.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI for Capacitor

> Release notes for the cmpatch-capacitor CLI (@codemagic/capacitor-patch-cli), by version.

# CLI for Capacitor release notes

Release notes for `cmpatch-capacitor`, published as
`@codemagic/capacitor-patch-cli`. It publishes and manages releases for apps
that use the [Capacitor SDK](/docs/releases/capacitor-sdk). Self-host operator
commands (`selfhost install`, `upgrade`, `backup`) are in
[`cmpatch`](/docs/releases/cli) for all frameworks. The other surfaces'
releases and the compatibility table are on the
[Release Notes](/docs/releases) page.

```bash
npm install -g @codemagic/capacitor-patch-cli@latest
```

Reference: [CLI reference](/docs/reference/cli-reference) ·
[Binary versions for Capacitor](/docs/using-patch/binary-version-capacitor) ·
[GitHub releases](https://github.com/codemagic-ci-cd/codemagic-patch/releases?q=capacitor-patch-cli)

## 0.2.0 {#v0-2-0}

*19th October 2026*

### Breaking

Without `--format`, `cmpatch-capacitor` now prints results as JSON when stdout
is piped or redirected, as `cmpatch` does. On a terminal the output is still
text. Scripts that read the text output from a pipe should pass
`--format text`. Progress lines and prompts are unchanged: a piped run still
asks before a change when someone is at the terminal, and only an explicit
`--format json` never asks.

### `cmpatch-capacitor doctor`

`doctor` checks why an app may not receive updates, without changing
anything. Run it from the app's root:

```bash
cmpatch-capacitor doctor
```

It reads the app's Capacitor configuration and checks the sign-in, the server
connection, the app and deployment that each platform's deployment key belongs
to, the native project setup, and the download origin. It reports deployment
keys that are missing or do not match the app's settings. With
`--verify-delivery` it also checks the published manifest and artifacts for
the app's exact version. It ends by naming where to watch the SDK's logs on a
device. It exits `1` when a check fails; `--platform` checks one platform and `--verbose`
shows every check.

See the [CLI reference](/docs/reference/cli-reference) and
[CLI release](https://github.com/codemagic-ci-cd/codemagic-patch/releases/tag/%40codemagic/capacitor-patch-cli%400.2.0).

## 0.1.0 {#v0-1-0}

*6th October 2026* ·
**Requires server 0.6.0 or newer**

First published version. Flags may still change before 1.0.

`cmpatch-capacitor` is a standalone CLI for Capacitor apps and does not
require `cmpatch`. It signs in, creates apps and deployments, publishes built
web assets with `release create`, and manages existing releases with
`release patch`, `disable`, `enable`, `promote`, `rollback`, and adoption
metrics. CI can sign in with personal access tokens.

- **Web root check:** `release create` checks that the bundle has
  `index.html` at its top level before uploading. A bundle rooted one folder
  too high installs but boots to a blank screen.
- **Binary version targeting:** The CLI does not compute a native
  fingerprint; `--target-binary-version` ties a release to a native build. See
  [Binary versions for Capacitor](/docs/using-patch/binary-version-capacitor).
  `release patch` and `promote` refuse a target override that moves a
  Capacitor release to another binary version.
- **Framework scoping:** `app create` records the app as a Capacitor app, and
  app lists and pickers show only Capacitor apps. Server 0.6.0 stores the
  framework, and the dashboard shows the `cmpatch-capacitor` release command
  for these apps.
- **Shared default server:** `cmpatch-capacitor` reads the default server from
  the same `~/.codemagic-patch/config.json` as `cmpatch`, and `config set`
  writes to it. Sign-ins are stored separately in `credentials-capacitor.json`.

See the [CLI release](https://github.com/codemagic-ci-cd/codemagic-patch/releases/tag/%40codemagic/capacitor-patch-cli%400.1.0).