realm-cli apps init
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
Initialize an App in your current working directory (alias: initialize)
Initializes a new App by saving your configuration files in your current working directory.
You can specify a "--remote" flag to initialize an App from an existing app; if you do not specify a "--remote" flag, the CLI will initialize a default App.
NOTE: To create a new App and have it deployed, use "app create".
Syntax
realm-cli apps init [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--remote | string | false | Specify the name or ID of a remote App to clone |
-n, --name | string | false | Name your new App |
-l, --location | String | false | Select the App's location (Default value: <none>; Allowed values: US-VA, US-OR, DE-FF, IE, AU, IN-MB, SG) |
-d, --deployment-model | String | false | Select the App's deployment model (Default value: <none>; Allowed values: GLOBAL, LOCAL) |
-e, --environment | String | false | Select the App's environment (Default value: <none>; Allowed values: development, testing, qa, production) |
-h, --help | false | help for init |
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 |