Docs Menu

Realm CLI

On this page

  • Overview
  • Installation
  • Options
  • Commands

The MongoDB Realm Command Line Interface (realm-cli) allows you to programmatically manage your Realm apps. With realm-cli, you can create or update Realm apps from a local directory as well as export existing applications to a local directory.

Important
Check your CLI version

This page is a quickstart for version 2 of realm-cli. If you need documentation for version 1 of realm-cli, see: Realm CLI v1. To check your CLI version, use: realm-cli --version.

Realm CLI is available on npm. To install version 2 of the Realm CLI on your system, ensure that you have Node.js installed and then run the following command in your shell:

npm install -g mongodb-realm-cli

Use "realm-cli [command] --help" for information on a specific command

Name
Type
Required
Description
--profile
string
false
Specify your profile (Default value: "default") (default "default")
--telemetry
String
false
Enable/Disable CLI usage tracking for your current profile (Default value: "on"; Allowed values: "on", "off")
-o, --output-target
string
false
Write CLI output to the specified filepath
-f, --output-format
String
false
Set the CLI output format (Default value: <blank>; Allowed values: <blank>, "json")
--disable-colors
false
Disable all CLI output styling (e.g. colors, font styles, etc.)
-y, --yes
false
Automatically proceed through CLI commands by agreeing to any required user prompts
-h, --help
false
help for realm-cli
Give Feedback
© 2021 MongoDB, Inc.

About

  • Careers
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2021 MongoDB, Inc.