Quickstart

This guide takes you from nothing installed to your first over-the-air update, in five steps.

Before you can start setting up your app with DeployPulse, you must first create an account. Not sure whether your project is supported? Check Compatibility first.

Install the CLI

The DeployPulse dashboard allows you to manage most aspects of your app and deployments. The dpctl CLI will be important for integrating with CI/CD workflows and uploading your JavaScript bundle for deployment.

Install it from npm:

Install the dpctl CLI

npm install -g @deploypulseio/dpctl

The package name is scoped, but it installs a command named dpctl, so that is what you run from here on. Check the install with:

Verify the install

dpctl --version

Prefer to build from source, or want an unreleased change? Clone the repository and install it globally from your working copy instead: git clone https://github.com/deploypulseio/dpctl dpctl && cd dpctl && npm install && npm run build && npm install -g

Log in via the CLI

dpctl login

This will launch a browser, asking you to authenticate with either your GitHub or email.

You can also use the commands whoami and logout following a valid session.

For CI/headless environments, skip the browser flow and use the --key flag: dpctl login --key YOUR_ACCESS_TOKEN. Find your deployment key under Dashboard → App → Deployment → View Key.

Register your app

Register your app with DeployPulse. If you ship both iOS and Android, create a separate app for each, because the update package produced for one platform is not valid for the other:

dpctl app add MyApp-iOS
dpctl app add MyApp-Android

Every new app comes with two deployments, Staging and Production, so you can test an update internally before it reaches end users. The CLI prints the deployment key for each one. Keep the Staging key handy for the next step.

See Apps and deployments for renaming, listing, and adding your own deployment channels.

Connect the client SDK

Add the react-native-code-push SDK to your app and point it at DeployPulse using the Staging deployment key from the previous step. The SDK is unchanged from CodePush, so an app already using CodePush only needs its server URL and key updated.

Follow the guide for your platform:

Release your first update

With the SDK wired up, bundle and release from your project directory:

Release to Staging

dpctl release-react MyApp-iOS ios

The second argument is the platform, not the deployment. This releases to Staging by default, which is what you want for a first run: launch the app, confirm the update downloads and applies, then promote it.

When you are ready for end users, target Production explicitly:

Release to Production

dpctl release-react MyApp-iOS ios --deploymentName Production

See Releasing updates for the full list of release options, including target binary versions, mandatory updates, and percentage rollouts.

What's next?

Great, you're all logged in to the CLI, next check out these items: