Add an App

Copy a setup prompt with the install steps and the full markdown guide for this plugin.

Requirements

Before getting started with Capgo, make sure you have:

A Capacitor app installed and configured. Learn how to set up Capacitor
Node.js 20 or later installed
One of the following development environments:
- macOS with Xcode (for iOS development) and/or Android Studio (for Android development)
- Linux with Android Studio (for Android development)
- Windows with Android Studio (for Android development)

Introduction to Capgo

Live updates are 3 step away

Guided setup

Create your account at https://capgo.app/register.
Use the Init commands to get started
Terminal window
```
npx @capgo/cli@latest init [APIKEY]
```
You will be presented with a series of questions. Provide the necessary answers to complete the automated setup.
Deploy a live update

Detailed Onboarding Guide See the complete step-by-step guide for the CLI onboarding process

Deploy a live update Learn how to deploy a live update to your app

Manual setup

In case the init command doesn’t work for you, you can manually add an app.

Connect the CLI to your account:
Terminal window
```
npx @capgo/cli@latest login [APIKEY]
```
Add the app to your account with this command:
Terminal window
```
npx @capgo/cli@latest app add [APP_NAME]
```
Install the plugin in your app:
Terminal window
```
npm i @capgo/capacitor-updater
```

Configure the plugin in your capacitor.config

{
  "plugins": {
    CapacitorUpdater: {
      "appId": "Your appID",
      "autoUpdate": "atBackground",
      "version": "1.0.0"
    }
  }
}

See all available options. This information will be inferred if not provided.

Call the init method as early as possible in your app:

import { CapacitorUpdater } from '@capgo/capacitor-updater';
CapacitorUpdater.notifyAppReady();

Deploy a live update

The command above (step 3) installs the latest version (v8.x) for Capacitor 8. For older Capacitor versions, use the appropriate npm tag:

# Capacitor 7
npm i @capgo/capacitor-updater@lts-v7

# Capacitor 6
npm i @capgo/capacitor-updater@lts-v6

# Capacitor 5
npm i @capgo/capacitor-updater@lts-v5

Each plugin major version matches the Capacitor major version (v8 → Capacitor 8, v7 → Capacitor 7, v6 → Capacitor 6, v5 → Capacitor 5). Minor versions share the same feature set across all major versions (e.g., 5.34.0, 6.34.0, 7.34.0, and 8.34.0 all include the same features).

Keep going from Add an App

If you are using Add an App to plan native plugin work, connect it with Capgo Plugin Directory for the product workflow in Capgo Plugin Directory, Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, Adding or Updating Plugins for the implementation detail in Adding or Updating Plugins, Ionic Enterprise Plugin Alternatives for the product workflow in Ionic Enterprise Plugin Alternatives, and Capgo Native Builds for the product workflow in Capgo Native Builds.