Docs Menu

realm-cli function run

On this page

  • Syntax
  • Options
  • Inherited Options

Run a Function from your Realm app

Realm Functions allow you to define and execute server-side logic for your Realm app. Once you select and run a Function for your Realm 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
realm-cli function run [options]
Name
Type
Required
Description
-a, --app
string
false
Specify the name or ID of a Realm 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 Realm 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
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.