Skip to main content
@capgo/capacitor-updater Updates Open source

Updater Capacitor plugin

Deploy Ionic and Capacitor live updates instantly to your users without app store review delays

Install

bun add @capgo/capacitor-updater bunx cap sync
npm, pnpm or yarn
  • npm install @capgo/capacitor-updater
  • pnpm add @capgo/capacitor-updater
  • yarn add @capgo/capacitor-updater

Guide

How to use Updater in Capacitor

Test on device

Download the Capgo app, then scan the QR code.

Updater plugin preview QR code

Ionic and Capacitor live updates with @capgo/capacitor-updater

@capgo/capacitor-updater is the open-source updater plugin behind Capgo live updates for Ionic and Capacitor apps. It downloads approved web bundles, applies them with native rollback protection, and keeps binary-only changes on the normal App Store and Play review path.

Use it when you need OTA updates for HTML, CSS, JavaScript, assets, and other web-layer changes after your native shell is already approved.

Install

npm install @capgo/capacitor-updater
npx cap sync

Where It Fits

For Ionic teams, live updates usually mean the same workflow: ship a new web bundle without forcing every user through a full store release. Capgo handles that workflow for Capacitor apps with channels, compatibility checks, rollout control, device logs, and rollback.

Native plugins, entitlements, Android manifest changes, iOS plist changes, and binary SDK updates still require a normal app store release. Keep those changes in your native build pipeline and use live updates for the approved web layer.

What This Plugin Exposes

  • notifyAppReady - Notify the native layer that JavaScript initialized successfully.
  • setUpdateUrl - Set the update URL for the app dynamically at runtime.
  • setStatsUrl - Set the statistics URL for the app dynamically at runtime.
  • setChannelUrl - Set the channel URL for the app dynamically at runtime.

Example Usage

notifyAppReady

Notify the native layer that JavaScript initialized successfully.

import { CapacitorUpdater } from '@capgo/capacitor-updater';

const result = await CapacitorUpdater.notifyAppReady();
console.log(result);

setUpdateUrl

Set the update URL for the app dynamically at runtime.

import { CapacitorUpdater } from '@capgo/capacitor-updater';

await CapacitorUpdater.setUpdateUrl({ url: 'https://example.com' });

setStatsUrl

Set the statistics URL for the app dynamically at runtime.

import { CapacitorUpdater } from '@capgo/capacitor-updater';

await CapacitorUpdater.setStatsUrl({ url: 'https://example.com' });

setChannelUrl

Set the channel URL for the app dynamically at runtime.

import { CapacitorUpdater } from '@capgo/capacitor-updater';

await CapacitorUpdater.setChannelUrl({ url: 'https://example.com' });

Full Reference

Keep going from @capgo/capacitor-updater

If you are using @capgo/capacitor-updater to plan live updates, connect it with Live Updates for the product workflow, @capgo/capacitor-updater for implementation details, Getting Started, Channels, and Rollbacks.

FAQ

Updater plugin FAQ

How do I install the Updater plugin in a Capacitor app?

Run "bun add @capgo/capacitor-updater" (or "npm install @capgo/capacitor-updater"), then run "bunx cap sync" so the iOS and Android projects pick up the native code. Import it from "@capgo/capacitor-updater" in your app code.

Does @capgo/capacitor-updater work with React, Vue and Angular?

Yes. Updater is a Capacitor package, so it works with any web framework that runs inside Capacitor, including Ionic, React, Vue, Angular, Svelte and plain JavaScript.

Which Capacitor version does @capgo/capacitor-updater support?

Capgo plugins follow Capacitor's major version: use the plugin major version that matches your Capacitor major version (for example plugin v8 with Capacitor 8). The compatibility table in the GitHub README lists the maintained versions.

Is @capgo/capacitor-updater free and open source?

Yes. The source code is public on GitHub at https://github.com/Cap-go/capacitor-updater/ and the package is free to install from npm. Bug reports and pull requests are welcome.

Can I update code that uses Updater without an App Store review?

Installing or upgrading the plugin changes native code, so it needs a new store build. After that, JavaScript, HTML and CSS changes that call the plugin can ship instantly with Capgo live updates.

Ship Updater changes without waiting for app review

Once the plugin is in your store build, Capgo live updates push your JavaScript, HTML and CSS changes to users in minutes.

Start with Capgo