Docs Menu
Docs Home
/ /
Atlas App Services
/ / / /

realm-cli apps describe

On this page

  • Syntax
  • Options
  • Inherited Options

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

Displays information about your App

View all of the aspects of your App to see what is configured and enabled (e.g. services, functions, etc.). If you have more than one App, you will be prompted to select an App to view.

realm-cli apps describe [options]
Name
Type
Required
Description

-a, --app

string

false

Specify the name or ID of an App to describe

-h, --help

false

help for describe

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

Back

delete