Deploy Changes with Realm CLI¶

On this page

Overview
Prerequisites
Procedure

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¶

1

Prepare the Application Directory¶

Export your application to a local application directory. Alternatively, create a new application directory that contains a config.json file with your application’s app_id.

copy

{
  "app_id": "<Your Application ID>"
}

2

Add or Update Application Entities¶

Add sub-directories and configuration files for any new entities you’re importing, or update the values in existing entity files. Every configuration file must conform to its configuration file schema.

3

Authenticate a MongoDB Atlas User¶

To import or update a Realm app with realm-cli, users must authenticate with MongoDB Atlas using an API Key.

copy

realm-cli login --api-key="<my api key>" --private-api-key="<my private api key>"

4

Run the Import Command¶

Use the realm-cli import to deploy your changes:

copy

realm-cli import --strategy=merge

Import Strategy

The --strategy flag indicates how you want Realm to handle configuration files that are missing or duplicated compared to the currently deployed version of your application. For more information, see import strategies.

If you want to upload static assets to Realm Hosting, include the static assets in the /hosting/files directory and specify the --include-hosting option:

copy

realm-cli import --strategy=merge --include-hosting

If you want to upload external dependencies, include your archived node_modules in the /functions directory and specify the --include-dependencies option:

copy

realm-cli import --strategy=merge --include-dependencies

5

Review and Confirm Import Diff¶

Before committing the import, realm-cli will show you a diff of the changes that will be made to your application. Review the diff to ensure that all changes are correct then confirm the import.

After successfully importing your application, Realm will automatically deploy a new version of your app and update your local application directory to match the new deployment.

← Deploy Automatically with GitHub Export an Existing Realm Application →