Salesforce CLI Setup Guide

Before You Begin
Install the Salesforce CLI and Plug-Ins
Salesforce CLI Configuration and Tips
Update the CLI
Uninstall the CLI Binary or Plug-In
Troubleshoot Salesforce CLI
CLI Deprecation Policy
Next Steps
PDF

Newer Version Available

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

Before You Begin

The Salesforce CLI is a command-line interface that simplifies development and build automation when working with your Salesforce org. Use it to create and manage orgs (scratch and sandboxes), synchronize source to and from orgs, create and install packages, and more.

Salesforce CLI consists of two parts:

  • CLI: An npm package called sfdx-cli. The CLI is based on oclif, an open-source framework for building a command-line interface in Node.js. You run it on your local machine or continuous integration (CI) system. It supports the installation of custom plug-ins.
  • One or more plug-ins. An npm package that you install into the CLI that contains commands. Most of the core functionality that Salesforce provides comes from plug-ins. These plug-ins are automatically installed when you install the CLI:
    • salesforcedx, the core Salesforce plug-in that contains commands that support source-driven development, such as creating and managing scratch orgs, synchronizing source code, creating second-generation packaging, and more.
    • Supporting plug-ins that contain commands that make it easier to use the CLI, such as setting configuration values or aliases.
    You can install more plug-ins, such as Einstein Analytics, to incorporate other Salesforce features into your development environment. You can also develop your own plug-in to add your custom functionality to Salesforce CLI.

System Requirements

Before you begin, review these system requirements to get the most out of Salesforce CLI and developer tools.

Operating Systems
Salesforce CLI supports the following operating systems.
  • Windows—Windows 7 (64-bit and 32-bit) or later
  • Mac—macOS 10.11 or later
  • Linux—Ubuntu 14.0.4
Code Editor or IDE
You can use any code editor, including Salesforce Extensions for VS Code, a set of Visual Studio Code extensions that are designed for development on Salesforce Platform.

If you’re using Salesforce Extensions for VS Code, keep in mind that many of the installation commands are unavailable in the command palette. If you can’t find a command in VS Code, run it in the integrated terminal.

Note

Version Control System
You can use any version control system (VCS). We recommend that you use GitHub to take advantage of the samples in our GitHub repository.

CLI and Plug-In Versions

Salesforce supports only the most current versions of the Salesforce CLI and the salesforcedx plug-in. See the Salesforce CLI Release Notes for the latest version information.

To check the version of the Salesforce CLI installed on your computer, run sfdx version. To check the version of the installed salesforcedx plug-in, run sfdx plugins --core.

To upgrade to the current version, run sfdx update.