app Commands

Create and manage Analytics apps.

• analytics app create

  Creates an Analytics app.

• analytics app decouple

  Decouples an Analytics app from an Analytics template.

• analytics app delete

  Delete Analytics apps.

• analytics app display

  Displays an Analytics app’s details.

• analytics app list

  Lists Analytics apps in the specified folder or target org.

• analytics app update

  Updates an Analytics app from a template.

Creates an Analytics app.

1sf analytics app create -t templateid -n appname

1sf analytics app create -m templatename

1sf analytics app create -f path_to_json_file

sf analytics app create

[--json]

[--api-version APIVERSION]

-o TARGETORG

[-f DEFINITIONFILE]

[-t TEMPLATEID]

[-m TEMPLATENAME]

[-n APPNAME]

[-a]

[-v]

[-w WAIT]

--json

Optional

Format output as JSON.

Type: boolean

--api-version APIVERSION

Optional

Override the API version used for API requests made by this command.

Type: string

-o TARGETORG

Required

Username or alias of the target org. Not required if the target-org configuration variable is set.

Type: string

-f | --definitionfile DEFINITIONFILE

Optional

Analytics template definition file; required unless a --templateid value is specified.

Type: filepath

-t | --templateid TEMPLATEID

Optional

Template ID; required unless a --definitionfile value is specified.

Type: string

-m | --templatename TEMPLATENAME

Optional

The name of the Analytics template.

Type: string

-n | --appname APPNAME

Optional

The name of the created app.

Type: string

-a | --async

Optional

Create app asynchronously.

Type: boolean

-v | --allevents

Optional

Verbose display of all app create events.

Type: boolean

-w | --wait WAIT

Optional

Wait time in minutes for streaming app creation events (default 10).

Type: number

Default value: 10

Decouples an Analytics app from an Analytics template.

1sf analytics app decouple -f folderId -t templateId

sf analytics app decouple

[--json]

[--api-version APIVERSION]

-o TARGETORG

-f FOLDERID

-t TEMPLATEID

--json

Optional

Format output as JSON.

Type: boolean

--api-version APIVERSION

Optional

Override the API version used for API requests made by this command.

Type: string

-o TARGETORG

Required

Username or alias of the target org. Not required if the target-org configuration variable is set.

Type: string

-f | --folderid FOLDERID

Required

ID of the folder that contains the app data.

Type: id

-t | --templateid TEMPLATEID

Required

Template ID.

Type: id

Delete Analytics apps.

1sf analytics app delete -f folderid

sf analytics app delete

[--json]

[--api-version APIVERSION]

-o TARGETORG

-f FOLDERID

[-p]

--json

Optional

Format output as JSON.

Type: boolean

--api-version APIVERSION

Optional

Override the API version used for API requests made by this command.

Type: string

-o TARGETORG

Required

Username or alias of the target org. Not required if the target-org configuration variable is set.

Type: string

-f | --folderid FOLDERID

Required

ID of the folder that contains the app data.

Type: id

-p | --noprompt

Optional

Do not prompt to confirm delete.

Type: boolean

Displays an Analytics app’s details.

1sf analytics app display -f folderId -a

sf analytics app display

[--json]

[--apiversion APIVERSION]

-o TARGETORG

-f FOLDERID

[-a]

--json

Optional

Format output as JSON.

Type: boolean

--api-version APIVERSION

Optional

Override the API version used for API requests made by this command.

Type: string

-o TARGETORG

Required

Username or alias of the target org. Not required if the target-org configuration variable is set.

Type: string

-f | --folderid FOLDERID

Required

ID of the folder that contains the app data.

Type: id

-a | --applog

Optional

Specify to include app creation log details.

Type: boolean

Lists Analytics apps in the specified folder or target org.

1sf analytics app list

sf analytics app list

[--json]

[--api-version APIVERSION]

-o TARGETORG

[-f FOLDERID]

--json

Optional

Format output as JSON.

Type: boolean

--api-version APIVERSION

Optional

Override the API version used for API requests made by this command.

Type: string

-o TARGETORG

Required

Username or alias of the target org. Not required if the target-org configuration variable is set.

Type: string

-f | --folderid FOLDERID

Optional

ID of the folder that contains the app data.

Type: string

Updates an Analytics app from a template.

1sf analytics app update -f folderId -t templateId

sf analytics app update

[--json]

[--api-version APIVERSION]

-o TARGETORG

-t TEMPLATEID

-f FOLDERID

[-a]

[-v]

[-w WAIT]

--json

Optional

Format output as JSON.

Type: boolean

--api-version APIVERSION

Optional

Override the API version used for API requests made by this command.

Type: string

-o TARGETORG

Required

Username or alias of the target org. Not required if the target-org configuration variable is set.

Type: string

-t | --templateid TEMPLATEID

Required

The ID of the Analytics template.

Type: string

-f | --folderid FOLDERID

Required

ID of the folder that contains the app data.

Type: id

-a | --async

Optional

Update app asynchronously.

Type: boolean

-v | --allevents

Optional

Verbose display of all app update events.

Type: boolean

-w | --wait WAIT

Optional

Wait time in minutes for streaming app update events (default 10).

Type: number

Default value: 10

j

Salesforce Analytics CLI Plugin Command Reference

sf

analytics enable

analytics query

app Commands

asset Commands

autoinstall Commands

dashboard Commands

dataflow Commands

dataset Commands

generate Commands

lens Commands

recipe Commands

template Commands

sfdx (Deprecated)

Help for Salesforce CLI Commands

CLI Deprecation Policy

Previous Versions