template Commands (Deprecated)

Create and manage Analytics templates.

analytics:template:create (Deprecated) 

Creates Analytics templates.

As of April 20, 2023, we no longer maintain this section of the command reference. Refer to the reference information about the sf-style commands instead, which we update regularly. We keep this reference information about the sfdx-style commands as-is for historical reference only.

The sfdx-style commands continue to work the same as before, and any scripts that use the commands won’t break. However, we recommend that you start using the equivalent sf-style commands.

The reference page for each sfdx command has been updated with information about its equivalent sf command. The page also shows how the flag names have changed between the sfdx and sf commands. Use this information to migrate your scripts.

For background information about this change, read this blog post, which describes how we’ve updated many of the existing sfdx commands to use the improvements we made in sf commands. To view all the changes, read the CLI release notes starting with version 7.183.1 on January 12, 2023.

Warning

Examples for analytics:template:create 

 
1sfdx analytics:template:create -f folderid
1sfdx analytics:template:create -f folderid -r "recipeid1, recipeid2"

Command Syntax 
sfdx analytics:template:create

[--json]

[--loglevel LOGLEVEL]

[-u TARGETUSERNAME]

[--apiversion APIVERSION]

-f FOLDERID

[-r RECIPEIDS]

[-l LABEL]

[--description DESCRIPTION]

Parameters 
--json

Optional

Format output as JSON.

Type: boolean

--loglevel LOGLEVEL

Optional

The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.

Type: enum

Permissible values are: trace, debug, info, warn, error, fatal, TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: warn

-u | --targetusername TARGETUSERNAME

Optional

A username or alias for the target org. Overrides the default target org.

Type: string

--apiversion APIVERSION

Optional

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

Type: string

-f | --folderid FOLDERID

Required

The ID of the folder that contains the template data.

Type: id

-r | --recipeids RECIPEIDS

Optional

A comma-separated list of recipe IDs to include with the template.

Type: array

-l | --label LABEL

Optional

The label for the Analytics template (defaults to the app label).

Type: string

--description DESCRIPTION

Optional

The description for the Analytics template (defaults to the app description).

Type: string

analytics:template:delete (Deprecated) 

Deletes Analytics templates.

As of April 20, 2023, we no longer maintain this section of the command reference. Refer to the reference information about the sf-style commands instead, which we update regularly. We keep this reference information about the sfdx-style commands as-is for historical reference only.

The sfdx-style commands continue to work the same as before, and any scripts that use the commands won’t break. However, we recommend that you start using the equivalent sf-style commands.

The reference page for each sfdx command has been updated with information about its equivalent sf command. The page also shows how the flag names have changed between the sfdx and sf commands. Use this information to migrate your scripts.

For background information about this change, read this blog post, which describes how we’ve updated many of the existing sfdx commands to use the improvements we made in sf commands. To view all the changes, read the CLI release notes starting with version 7.183.1 on January 12, 2023.

Warning

Examples for analytics:template:delete 

 
1sfdx analytics:template:delete -t templateid

Command Syntax 
sfdx analytics:template:delete

[--json]

[--loglevel LOGLEVEL]

[-u TARGETUSERNAME]

[--apiversion APIVERSION]

-t TEMPLATEID

[--forcedelete]

[--decouple]

[-p]

Parameters 
--json

Optional

Format output as JSON.

Type: boolean

--loglevel LOGLEVEL

Optional

The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.

Type: enum

Permissible values are: trace, debug, info, warn, error, fatal, TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: warn

-u | --targetusername TARGETUSERNAME

Optional

A username or alias for the target org. Overrides the default target org.

Type: string

--apiversion APIVERSION

Optional

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

Type: string

-t | --templateid TEMPLATEID

Required

The ID of the Analytics template.

Type: id

--forcedelete

Optional

Force deletes the Analytics template and all linked Analytics apps.

Type: boolean

--decouple

Optional

Decouple all linked Analytics apps.

Type: boolean

-p | --noprompt

Optional

Do not prompt to confirm force delete.

Type: boolean

analytics:template:display (Deprecated) 

Displays an Analytics template’s details.

As of April 20, 2023, we no longer maintain this section of the command reference. Refer to the reference information about the sf-style commands instead, which we update regularly. We keep this reference information about the sfdx-style commands as-is for historical reference only.

The sfdx-style commands continue to work the same as before, and any scripts that use the commands won’t break. However, we recommend that you start using the equivalent sf-style commands.

The reference page for each sfdx command has been updated with information about its equivalent sf command. The page also shows how the flag names have changed between the sfdx and sf commands. Use this information to migrate your scripts.

For background information about this change, read this blog post, which describes how we’ve updated many of the existing sfdx commands to use the improvements we made in sf commands. To view all the changes, read the CLI release notes starting with version 7.183.1 on January 12, 2023.

Warning

Examples for analytics:template:display 

 
1sfdx analytics:template:display -t templateid
1sfdx analytics:template:display -n templatename

Command Syntax 
sfdx analytics:template:display

[--json]

[--loglevel LOGLEVEL]

[-u TARGETUSERNAME]

[--apiversion APIVERSION]

[-t TEMPLATEID]

[-n TEMPLATENAME]

Parameters 
--json

Optional

Format output as JSON.

Type: boolean

--loglevel LOGLEVEL

Optional

The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.

Type: enum

Permissible values are: trace, debug, info, warn, error, fatal, TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: warn

-u | --targetusername TARGETUSERNAME

Optional

A username or alias for the target org. Overrides the default target org.

Type: string

--apiversion APIVERSION

Optional

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

Type: string

-t | --templateid TEMPLATEID

Optional

The ID of the Analytics template.

Type: id

-n | --templatename TEMPLATENAME

Optional

The name of the Analytics template.

Type: string

analytics:template:lint (Deprecated) 

Performs a lint check on an Analytics template. Requires either the ID or API name of template.

As of April 20, 2023, we no longer maintain this section of the command reference. Refer to the reference information about the sf-style commands instead, which we update regularly. We keep this reference information about the sfdx-style commands as-is for historical reference only.

The sfdx-style commands continue to work the same as before, and any scripts that use the commands won’t break. However, we recommend that you start using the equivalent sf-style commands.

The reference page for each sfdx command has been updated with information about its equivalent sf command. The page also shows how the flag names have changed between the sfdx and sf commands. Use this information to migrate your scripts.

For background information about this change, read this blog post, which describes how we’ve updated many of the existing sfdx commands to use the improvements we made in sf commands. To view all the changes, read the CLI release notes starting with version 7.183.1 on January 12, 2023.

Warning

Examples for analytics:template:lint 

 
1sfdx analytics:template:lint -t templateId
1sfdx analytics:template:lint -n templateApiName

Command Syntax 
sfdx analytics:template:lint

[--json]

[--loglevel LOGLEVEL]

[-u TARGETUSERNAME]

[--apiversion APIVERSION]

[-n TEMPLATENAME]

[-t TEMPLATEID]

Parameters 
--json

Optional

Format output as JSON.

Type: boolean

--loglevel LOGLEVEL

Optional

The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.

Type: enum

Permissible values are: trace, debug, info, warn, error, fatal, TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: warn

-u | --targetusername TARGETUSERNAME

Optional

A username or alias for the target org. Overrides the default target org.

Type: string

--apiversion APIVERSION

Optional

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

Type: string

-n | --templatename TEMPLATENAME

Optional

API name of the template to submit for lint check.

Type: string

-t | --templateid TEMPLATEID

Optional

ID of the template to submit for lint check.

Type: string

analytics:template:list (Deprecated) 

Lists Analytics templates in the specified folder or target org.

As of April 20, 2023, we no longer maintain this section of the command reference. Refer to the reference information about the sf-style commands instead, which we update regularly. We keep this reference information about the sfdx-style commands as-is for historical reference only.

The sfdx-style commands continue to work the same as before, and any scripts that use the commands won’t break. However, we recommend that you start using the equivalent sf-style commands.

The reference page for each sfdx command has been updated with information about its equivalent sf command. The page also shows how the flag names have changed between the sfdx and sf commands. Use this information to migrate your scripts.

For background information about this change, read this blog post, which describes how we’ve updated many of the existing sfdx commands to use the improvements we made in sf commands. To view all the changes, read the CLI release notes starting with version 7.183.1 on January 12, 2023.

Warning

Examples for analytics:template:list 

 
1sfdx analytics:template:list
1sfdx analytics:template:list --includembeddedtemplates
1sfdx analytics:template:list --includesalesforcetemplates

Command Syntax 
sfdx analytics:template:list

[--json]

[--loglevel LOGLEVEL]

[-u TARGETUSERNAME]

[--apiversion APIVERSION]

[-a]

[-e]

Parameters 
--json

Optional

Format output as JSON.

Type: boolean

--loglevel LOGLEVEL

Optional

The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.

Type: enum

Permissible values are: trace, debug, info, warn, error, fatal, TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: warn

-u | --targetusername TARGETUSERNAME

Optional

A username or alias for the target org. Overrides the default target org.

Type: string

--apiversion APIVERSION

Optional

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

Type: string

-a | --includesalesforcetemplates

Optional

Include Salesforce templates.

Type: boolean

-e | --includembeddedtemplates

Optional

Include EmbeddedApp templates.

Type: boolean

analytics:template:update (Deprecated) 

Updates Analytics templates.

As of April 20, 2023, we no longer maintain this section of the command reference. Refer to the reference information about the sf-style commands instead, which we update regularly. We keep this reference information about the sfdx-style commands as-is for historical reference only.

The sfdx-style commands continue to work the same as before, and any scripts that use the commands won’t break. However, we recommend that you start using the equivalent sf-style commands.

The reference page for each sfdx command has been updated with information about its equivalent sf command. The page also shows how the flag names have changed between the sfdx and sf commands. Use this information to migrate your scripts.

For background information about this change, read this blog post, which describes how we’ve updated many of the existing sfdx commands to use the improvements we made in sf commands. To view all the changes, read the CLI release notes starting with version 7.183.1 on January 12, 2023.

Warning

Examples for analytics:template:update 

 
1sfdx analytics:template:update -t templateid -f folderid
1sfdx analytics:template:update -t templateid -f folderid -r "recipeid1, recipeid2"

Command Syntax 
sfdx analytics:template:update

[--json]

[--loglevel LOGLEVEL]

[-u TARGETUSERNAME]

[--apiversion APIVERSION]

[-t TEMPLATEID]

[-n TEMPLATENAME]

[-f FOLDERID]

[-r RECIPEIDS]

[-v ASSETVERSION]

Parameters 
--json

Optional

Format output as JSON.

Type: boolean

--loglevel LOGLEVEL

Optional

The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.

Type: enum

Permissible values are: trace, debug, info, warn, error, fatal, TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: warn

-u | --targetusername TARGETUSERNAME

Optional

A username or alias for the target org. Overrides the default target org.

Type: string

--apiversion APIVERSION

Optional

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

Type: string

-t | --templateid TEMPLATEID

Optional

The ID of the Analytics template.

Type: id

-n | --templatename TEMPLATENAME

Optional

The name of the Analytics template.

Type: string

-f | --folderid FOLDERID

Optional

The ID of the folder that contains the template data.

Type: id

-r | --recipeids RECIPEIDS

Optional

A comma-separated list of recipe IDs to include with the template.

Type: array

-v | --assetversion ASSETVERSION

Optional

Version number for upgrading the template.

Type: integer

analytics:template:validate (Deprecated) 

Performs an org readiness check for an Analytics template. Requires either the ID or API name of template.

As of April 20, 2023, we no longer maintain this section of the command reference. Refer to the reference information about the sf-style commands instead, which we update regularly. We keep this reference information about the sfdx-style commands as-is for historical reference only.

The sfdx-style commands continue to work the same as before, and any scripts that use the commands won’t break. However, we recommend that you start using the equivalent sf-style commands.

The reference page for each sfdx command has been updated with information about its equivalent sf command. The page also shows how the flag names have changed between the sfdx and sf commands. Use this information to migrate your scripts.

For background information about this change, read this blog post, which describes how we’ve updated many of the existing sfdx commands to use the improvements we made in sf commands. To view all the changes, read the CLI release notes starting with version 7.183.1 on January 12, 2023.

Warning

Examples for analytics:template:validate 

 
1sfdx analytics:template:validate -t templateId
1sfdx analytics:template:validate -n templateApiName
1sfdx analytics:template:validate -n templateApiName -f templateValues.json

Command Syntax 
sfdx analytics:template:validate

[--json]

[--loglevel LOGLEVEL]

[-u TARGETUSERNAME]

[--apiversion APIVERSION]

[-n TEMPLATENAME]

[-t TEMPLATEID]

[-f VALUESFILE]

Parameters 
--json

Optional

Format output as JSON.

Type: boolean

--loglevel LOGLEVEL

Optional

The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.

Type: enum

Permissible values are: trace, debug, info, warn, error, fatal, TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: warn

-u | --targetusername TARGETUSERNAME

Optional

A username or alias for the target org. Overrides the default target org.

Type: string

--apiversion APIVERSION

Optional

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

Type: string

-n | --templatename TEMPLATENAME

Optional

API name of the template to run an org readiness check on.

Type: string

-t | --templateid TEMPLATEID

Optional

ID of the template to run an org readiness check on.

Type: string

-f | --valuesfile VALUESFILE

Optional

The file with values to override the template defaults with.

Type: filepath

Salesforce Analytics CLI Plugin Command Reference
sf
sfdx (Deprecated)
analytics:enable (Deprecated)
analytics:query (Deprecated)
app Commands (Deprecated)
asset Commands (Deprecated)
autoinstall Commands (Deprecated)
dashboard Commands (Deprecated)
dataflow Commands (Deprecated)
dataset Commands (Deprecated)
generate Commands (Deprecated)
lens Commands (Deprecated)
recipe Commands (Deprecated)
template Commands (Deprecated)
Help for Salesforce CLI Commands
CLI Deprecation Policy
Previous Versions