CodePush CLI

Common errors

• code-push: command not found

  cause The `code-push-cli` package was not installed globally, or the global npm binaries directory is not in your system's PATH.
  fix Run `npm install -g code-push-cli`. If the issue persists on macOS/Linux, you might need `sudo npm install -g code-push-cli` or ensure npm's global bin path is in your shell's PATH environment variable.

• Error: No access key specified. Please login by running 'code-push login' or 'code-push register'.

  cause The CLI requires authentication to interact with the CodePush service, and no active session or access key was found.
  fix Execute `code-push register` for initial setup, which launches a browser for authentication. If you have an existing account or access key, use `code-push login` or `code-push login --accessKey <YOUR_ACCESS_KEY>`.

• Error: There is no app with the name 'YourAppName' under your account.

  cause The application name provided in a command (e.g., `code-push release-react YourAppName ...`) does not exactly match a registered application associated with your authenticated CodePush account.
  fix Verify the application name for typos. Use `code-push app list` to see all applications registered under your account and their exact names. If the app doesn't exist, create it using `code-push app add <appName>`.

Warnings

• breaking The `code-push-cli` package is officially deprecated and no longer supported by Microsoft. Users should migrate to `AppCenter-CLI` or community-driven alternatives for equivalent functionality, active maintenance, and continued support.
  Fix: Install `appcenter-cli` globally (`npm install -g appcenter-cli`) and use `appcenter codepush` commands. Alternatively, explore solutions like `NextPush` (`dpctl`), `Revopush` (`@revopush/code-push-cli`), or `Stallion` as drop-in replacements, following their respective migration guides.
• gotcha Multiple security vulnerabilities (e.g., `vm2`, `ip`, `cookiejar`, `superagent-proxy`) have been identified and patched across various versions. While recent v4.x releases address many of these, using older, unpatched versions can expose development environments to risks.
  Fix: If you absolutely must use `code-push-cli`, always update to the latest available version (`npm update -g code-push-cli`) to ensure you have the most recent security patches. Ideally, migrate to an actively maintained alternative.
• gotcha The CodePush service, particularly its backend provided by Microsoft App Center, was retired in March 2025. Even if the CLI is installed, the underlying service it connects to may no longer be operational, or its functionality severely limited.
  Fix: Migrate to a actively maintained CodePush alternative that provides both a client SDK and a server backend (e.g., AppCenter, NextPush, DeployPulse, Revopush, Stallion, Codemagic, or a self-hosted solution) to ensure operational continuity.

Install

• npm install code-push-cli npm
• yarn add code-push-cli yarn
• pnpm add code-push-cli pnpm

Imports

• code-push
  wrong:

  import codePush from 'code-push-cli'

  correct:

  npm install -g code-push-cli
  # Then use 'code-push <command>' in your terminal

  This package is a global command-line interface. It is not designed for programmatic import or usage within a Node.js application via `require` or `import` statements. Its functionality is accessed directly through shell commands after global installation.
• code-push release-react
  wrong:

  import { releaseReact } from 'code-push-cli'

  correct:

  code-push release-react MyAppName <platform> --target-binary-version "1.0.0" --output-dir ./build

  This is a common subcommand pattern used for releasing React Native updates. It's invoked via the main `code-push` command in the terminal, not through programmatic imports. The command handles bundling and uploading.
• code-push app add
  wrong:

  import { appAdd } from 'code-push-cli'

  correct:

  code-push app add MyAppName-iOS ios react-native
  code-push app add MyAppName-Android android react-native

  This subcommand is used for registering new applications with the CodePush service via the command line. Each platform (iOS/Android) typically requires a separate application registration.

Quickstart

Demonstrates the global installation of the CodePush CLI, account registration, adding applications, and performing a basic React Native release to a staging environment, highlighting its deprecated status.

npm install -g code-push-cli

# 1. Register/Login to your CodePush account (opens browser for authentication)
code-push register

# 2. Add an application (e.g., for iOS and Android)
code-push app add MyAwesomeApp-iOS ios react-native
code-push app add MyAwesomeApp-Android android react-native

# 3. List your registered apps to verify
code-push app list

# 4. Release an update for a React Native iOS app to the 'Staging' deployment
# Note: Replace 'MyAwesomeApp-iOS' with your app name and '1.0.0' with your target binary version
code-push release-react MyAwesomeApp-iOS ios --target-binary-version "1.0.0" --description "Initial staging release" --mandatory true

# IMPORTANT: This CLI is deprecated. Consider migrating to AppCenter CLI or alternatives:
# npm install -g appcenter-cli
# appcenter login
# appcenter codepush release-react -a YourOrg/YourApp -d Staging