Salesforce CLI Setup Guide

Before You Begin
Release Notes
Move from sfdx (v7) to sf (v2)
Install Salesforce CLI
Update Salesforce CLI
Update to the CLI Release Candidate or Nightly
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 to the CLI Release Candidate or Nightly

We release a new version of the CLI weekly. At the same time we also publish a release candidate of the CLI that contains changes that we plan to include in the next weekly release. Think of the release candidate as the CLI-version of the Salesforce sandbox preview. You can update to a release candidate if you want to check out upcoming features. Or stay on the current and official release. Or go back and forth. It’s up to you!

We also release nightly builds every day. Nightly builds include the latest versions of all our libraries and plugins. If you want to try out a fix that was merged just a day ago, try installing a nightly build. Similar to the release candidate, the nightly builds help improve the stability of Salesforce CLI by catching issues before they make it to the stable release. 

While the latest (stable) release is the most reliable, we encourage users to also test the release candidates and nightly builds and report issues to our GitHub issues repository. We recommend you run your continuous integration (CI) jobs against both the current release and the release candidate to identify potential breaking changes before they happen.

To display the version of your installed Salesforce CLI, run this command from a terminal (macOS and Linux) or command prompt (Windows). The version doesn’t indicate if it’s a release candidate or nightly build, so check the release notes for the current version numbers. 

1sf version

Update Using Installers

Installers use the tags stable for the current release, stable-rc for the release candidate, and nightly for the nightly builds.

If you’ve already installed Salesforce CLI and are using the current release, run this command in a terminal (macOS and Linux) or command prompt (Windows) to switch to the release candidate.

1sf update stable-rc

Similarly, run this command to install the nightly build.

1sf update nightly

To uninstall the release candidate or nightly build and return to the current version, run this command.

1sf update stable

Install Using npm

Npm installs use the tags latest for the current release, latest-rc for the release candidate, and nightly for the nightly builds.

To install the release candidate using npm, run this command in a terminal (macOS and Linux) or command prompt (Windows).

1npm install --global @salesforce/cli@latest-rc

Similarly, run this command to install the nightly build.

1npm install --global @salesforce/cli@nightly

To uninstall the release candidate or nightly build and return to the current version, run this command. 

1npm install --global @salesforce/cli@latest

To view the Salesforce CLI versions that are currently associated with the npm tags, run this command. 

1npm view @salesforce/cli dist-tags --json

Install from a TAR File

Salesforce CLI distributes TAR files for the release candidate and nightly builds that you can install on all supported operating systems. The download URLs are similar to the URLs for installing the current release, but use the stable-rc or nightly channel rather than the stable channel.

For example, to wget the Linux TAR file for the release candidate, run this command in a terminal (macOS and Linux) or command prompt (Windows), which downloads from the stable-rc channel.

1wget https://developer.salesforce.com/media/salesforce-cli/sf/channels/stable-rc/sf-linux-x64.tar.xz

This command downloads a nightly build.

1wget https://developer.salesforce.com/media/salesforce-cli/sf/channels/nightly/sf-linux-x64.tar.xz

Other than using a different channel, the instructions for installing the release candidate or nightly build from a TAR file are the same as the instructions for installing the current release.