Deploy Changes with Realm CLI¶

Overview¶

You can deploy changes to your Realm app with Realm CLI by importing an application directory with configuration files that define the updated app.

Prerequisites¶

A MongoDB Atlas programmatic API Key.
A properly installed copy of realm-cli that has been added to your system PATH.

Procedure¶

Important

Check your CLI version

This procedure uses version 2 of Realm CLI. If you have an older version of Realm CLI, upgrade to the latest version or run realm-cli --help for a list of commands supported in your version.

1

Log In to MongoDB Cloud¶

To configure your app with realm-cli, you must log in to MongoDB Cloud using an API key scoped to the organization or project that contains the app.

realm-cli login --api-key="<MongoDB Cloud Public API Key>" --private-api-key="<MongoDB Cloud Private API Key>"

2

Pull the Latest Version of Your App¶

You'll need a local copy of your application's configuration files. To pull a local copy of the latest version of your app, run the following:

realm-cli pull --remote="<Your App ID>"

Tip

You can also download a copy of your application's configuration files from the Deploy > Import/Export App screen in the Realm UI.

3

Update Your Application¶

Add, delete, and modify configuration files for your application's various components.

4

Deploy the Updated App¶

Once you've updated your app's configuration files, you can push them to your remote app. Realm CLI immediately deploys the updated configurations on push.

realm-cli push --remote="<Your App ID>"

Give Feedback

← Deploy Automatically with GitHub Export an Existing Realm Application →