Docs Menu

realm-cli login

On this page

  • Syntax
  • Options
  • Inherited Options

Log the CLI into Realm using a MongoDB Cloud API key

Begins an authenticated session with Realm. To get a MongoDB Cloud API Key, open your Realm app in the Realm 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.

realm-cli login [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
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

Auto generated by cobra2snooty on 16-Aug-2021

Give Feedback
© 2021 MongoDB, Inc.

About

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