realm-cli pull
On this page
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
Exports the latest version of your App into your local directory (alias: export)
Exports the latest version of your App into your local directory
Pulls changes from your remote App into your local directory. If applicable, Hosting Files and/or Dependencies associated with your App will be exported as well.
Syntax
realm-cli pull [options]
Options
Name | Type | Required | Description |
---|---|---|---|
--local | string | false | Specify a local filepath to export an App to |
--remote | string | false | Specify the name or ID of a remote App to export |
--include-node-modules | false | Export and include App dependencies from a node_modules archive (Note: The allowed formats are as a directory or compressed into a | |
--include-package-json | false | Export and include App dependencies from a package.json file | |
-s, --include-hosting | false | Export and include App hosting files | |
-x, --dry-run | false | Run without writing any changes to the local filepath | |
-t, --template | strings | false | Specify the frontend Template ID(s) to export. (Note: Specified templates must be compatible with the remote App) (Allowed values: |
-h, --help | false | help for pull |
Inherited Options
Name | Type | Required | Description |
---|---|---|---|
--profile | string | false | Specify your profile (Default value: "default") This value defaults to "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 |