realm-cli login
On this page
Atlas Device Sync, Atlas Edge Server, Data API, and HTTPS Endpoints are deprecated. Refer to the deprecation page for details.
Important
Realm CLI is Deprecated
realm-cli is deprecated and will not receive future features or
bug fixes. Instead, use the App Services CLI.
App Services CLI is available on npm. To install the CLI on your system,
ensure that you have Node.js
installed and then run the following command in your shell:
npm install -g atlas-app-services-cli
Log the CLI into Atlas App Services using a MongoDB Cloud API key
Begins an authenticated session with App Services. To get a MongoDB Cloud API Key, open your App in the App Services UI. Navigate to "Deployment" in the left navigation menu, and select the "Export App" tab. From there, create a programmatic API key to authenticate your realm-cli session.
Syntax
realm-cli login [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--api-key | string | false | Specify the public portion of your Atlas programmatic API Key |
--private-api-key | string | false | Specify the private portion of your Atlas programmatic API Key |
-h, --help | false | help for login |
Inherited Options
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 |