Salesforce CLI Setup Guide

Quick Start
System Requirements
Move from sfdx (v7) to sf (v2)
Install Salesforce CLI
Update Salesforce CLI
Salesforce CLI Configuration and Tips
Uninstall Salesforce CLI or Plugins
Run Salesforce CLI Using a Docker Image
Salesforce CLI Plugins
Install a CLI Plugin
Install Other Versions of Salesforce CLI Plugins
Install Trusted Unsigned Plugins Automatically
Discover Salesforce Plugins
Quickly Uninstall All Non-Core Plugins
Troubleshoot Salesforce CLI
CLI Deprecation Policy
Next Steps
Release Notes
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Install Trusted Unsigned Plugins Automatically

When you install a plugin with the sf plugins install command, Salesforce CLI first verifies its digital signature. If the plugin provides a valid signature, the CLI installs it. Otherwise, Salesforce CLI doesn't install it until you answer a warning prompt and acknowledge that you understand the risks. This process works well when you install a plugin interactively at the command line, but can prevent a batch job from completing. To automatically install a plugin without prompting, even when unsigned, create an allowlist file on your local file system and add the plugins you trust.

After you install a plugin and run one of its commands in a terminal, the command runs with your user privileges. As a result, the command can read encrypted data, communicate with any Salesforce org you authenticated to, or remove files in your home directory. Install only unsigned and unverified plugins that you trust.

Warning

  1. Create a file called unsignedPluginAllowList.json and put it in one of these directories:
    • (Linux and macOS): $HOME/.config/sf
    • (Windows) Depending on your Windows configuration, either C:\Users\username\.config\sf or %LOCALAPPDATA%\sf
  2. Add the names of the plugins you trust to the JSON file in a simple array of strings. For example: 
    1[
2    "sfdx-templates",
3    "salesforce-cmdt",
4    ...
5]