Salesforce CLI Setup Guide

Release Notes
Before You Begin
Move from sfdx (v7) to sf (v2)
Install Salesforce CLI
Update Salesforce CLI
Disable Automatic Update of the CLI
Salesforce CLI Configuration and Tips
Uninstall Salesforce CLI or Plugins
Run Salesforce CLI Using a Docker Image
Salesforce CLI Plugins
Troubleshoot Salesforce CLI
CLI Deprecation Policy
Next Steps
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Update Salesforce CLI

If you want to ensure that you’re running the latest version of Salesforce CLI, you can manually update it.

Determine How You Installed Salesforce CLI

Because the method to update Salesforce CLI differs depending on whether you used the installers or npm, you must know how you installed before you can update. In case you forgot, here are two ways to determine how you installed Salesforce CLI:

  • Run sf update. If Salesforce CLI updates, then you installed with the installers. If the command returns this or similar warning, then you installed with npm:
    1sf update
2 ›   Warning: Use "npm update --global @salesforce/cli" to update npm-based installations.
3@salesforce/cli: Updating CLI... not updatable
  • If you’ve installed Node.js, run npm list -g --depth 0. If the displayed list includes the entry @salesforce/cli@<version>, then you installed Salesforce CLI with npm.

If You Installed Salesforce CLI Using the Installer

To install the latest Salesforce CLI and plugin versions, run:
1sf update

By default, the CLI periodically checks for and installs updates. To disable auto-update, set the SF_AUTOUPDATE_DISABLE environment variable to true.

When you update Salesforce CLI, we automatically display the release notes for the version you're updating to so you can learn about the new, changed, and fixed features. To silence the display, set the SF_HIDE_RELEASE_NOTES and SF_HIDE_RELEASE_NOTES_FOOTER environment variables to true.

If You Installed Salesforce CLI Using npm

The auto-update option isn’t available. When a new version of the CLI is available, run this command::
1npm install --global @salesforce/cli

Disable Automatic Update of the CLI

When you run a command, Salesforce CLI checks to see if you have the latest version. If not, the CLI automatically updates itself. You can disable this automatic update with an environment variable.

To remain on the current version of the CLI and disable automatic updates, set the SF_AUTOUPDATE_DISABLE environment variable to true. How you set an environment variable is different for different operating systems. See the operating system vendor’s help for instructions on how to set environment variables.