realm-cli function run
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
Run a Function from your App
Atlas Functions allow you to define and execute server-side logic for your Atlas App Services app. Once you select and run a Function for your App, the following will be displayed:
A list of logs, if present
The function result as a document
A list of error logs, if present
Syntax
realm-cli function run [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
-a, --app | string | false | Specify the name or ID of an App to run its function |
--name | string | false | Specify the name of the function to run |
--args | stringArray | false | Specify the args to pass to your function. Learn more at: Call a Function from the CLI. |
--user | string | false | Specify which user to run the function as (Default value: <none>; Allowed values: <none>, <userID>) (Note: Using <none> will run as the System user) |
-h, --help | false | help for run |
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 |