Manage Analytics recipes.
analytics:recipe:list (Deprecated)
Lists Analytics recipes in the specified target org.
analytics:recipe:start (Deprecated)
Starts a Data Prep recipe.
Lists Analytics recipes in the specified 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
1sfdx analytics:recipe:listsfdx analytics:recipe:list[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
--jsonOptional
Format output as JSON.
Type: boolean
--loglevel LOGLEVELOptional
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 TARGETUSERNAMEOptional
A username or alias for the target org. Overrides the default target org.
Type: string
--apiversion APIVERSIONOptional
Override the API version used for API requests made by this command.
Type: string
Starts a Data Prep recipe.
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
1sfdx analytics:recipe:start --recipe recipeIdsfdx analytics:recipe:start[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
[-i RECIPEID]
--jsonOptional
Format output as JSON.
Type: boolean
--loglevel LOGLEVELOptional
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 TARGETUSERNAMEOptional
A username or alias for the target org. Overrides the default target org.
Type: string
--apiversion APIVERSIONOptional
Override the API version used for API requests made by this command.
Type: string
-i | --recipeid RECIPEIDRequired
ID of the recipe to start.
Type: id
j