Skip to main content

Quick Start

AppsOnAir CodePush allows you to deploy over-the-air (OTA) updates to your mobile apps seamlessly. This section covers how to authenticate, create deployments, release updates, manage mandatory vs optional updates, and perform rollbacks when needed.

CLI Installation​

Run the following command to install @appsonair/codepush-cli globally:

Terminal
npm install -g @appsonair/codepush-cli

Authentication​

Before using AppsOnAir CodePush, you need to log in.

  1. Run the following command to start the login process:

    Terminal
    appsonair-codepush login

  2. This will launch a browser, asking you to authenticate with your AppsOnAir account.

  3. Once authenticated, it generate an access key you can copy/paste into the CLI in order to login.

To check the logged-in user, run:

Terminal
appsonair-codepush whoami

Checking Available Apps​

To list the apps you have access to:

Terminal
appsonair-codepush app list

App Naming Convention​

AppsOnAir uses a different app naming convention compared to AppCenter. While AppCenter uses the app name directly, AppsOnAir follows this structure:

<workspace-name>-<app-name>-<platform>

For example, if your workspace is MyCompany and your app is MyApp, the names would be:

  • MyCompany-MyApp-android

  • MyCompany-MyApp-ios

Ensure you use this format when interacting with the CLI.

Releasing Updates​

To release an update to a specific deployment, run:

Terminal
appsonair-codepush release-react <app-name> --target-version <target-version>
  • <target-version> specifies the app version to target.

Example:

Terminal
appsonair-codepush release-react MyApp --target-version 1.0.0

Mandatory vs Optional Updates​

By default, updates are optional, meaning users can download them at their convenience. However, if you need to force an update (e.g., for security fixes), use the --mandatory flag:

Terminal
appsonair-codepush release-react <app-name> --target-version <target-version> --mandatory

Rollback & Versioning​

If an update causes issues, you can rollback to a previous version:

Terminal
appsonair-codepush rollback <app-name>

Example:

Terminal
appsonair-codepush rollback MyApp

This reverts the last update, ensuring users receive the previous stable version.

To view update history:

Terminal
appsonair-codepush deployment history <app-name>