Salesforce Analytics CLI Plugin Command Reference

The command reference contains information about the Salesforce CLI commands for the Analytics plugin and their flags.

The sf section contains information about the sf-style commands, which became generally available in July 2023. The sfdx section contains information about the sfdx-style commands, which are deprecated. We no longer maintain the sfdx information and keep it in this guide for historical reference only. See this developer blog post for more information about Salesforce CLI sf (v2).

Getting Started

The Analytics plug-in commands perform Analytics related actions, like creating apps and updating templates, in your target org. You must be authenticated into your scratch org from a generated project for the Analytics plug-in commands to work.

Create a project:

1sf project generate --name MyAnalyticsWork

Create a Developer edition scratch org using your default dev hub and give the scratch org an alias:

1sf org create scratch --edition developer --alias my-scratch-org

Set the target org default for all sf commands:

1sf config set target-org my-scratch-org

Open your scratch org:

1sf org open [-o my-scratch-org]

View the help for analytics commands:

1sf analytics --help

For information about installing the Salesforce CLI, see the Salesforce DX Setup Guide.

For information about installing the Analytics CLI plugin, see Install the Analytics CLI Plugin.

For information about Salesforce CLI changes, see the Salesforce CLI Release Notes.

sf

This section contains information about the sf commands for the analytics plug-in.
sfdx (Deprecated)

This section contains information about the deprecated sfdx-style commands for the analytics plug-in.
Help for Salesforce CLI Commands

The -h | --help parameter shows details about Salesforce CLI topics and their commands.
CLI Deprecation Policy

Salesforce deprecates CLI commands and flags when, for example, the underlying API changes.