Salesforce CLI Setup Guide

Before You Begin
Install Salesforce CLI
Install the CLI Release Candidate
Run Salesforce CLI Using a Docker Image
Update Salesforce CLI
Salesforce CLI Plug-ins
Salesforce CLI Configuration and Tips
Uninstall Salesforce CLI or Plug-ins
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

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, synchronize source to and from orgs, create and install packages, and more.

Salesforce 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.

We release new versions of the CLI and plug-ins weekly. Read the weekly release notes to learn about recent and upcoming changes.

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 8.1 and Windows Server 2012 (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.
Node.js
We bundle Node.js in each operating system-specific Salesforce CLI installer. We include the version of Node.js with Active LTS status and update it in tandem with the Node.js release schedule.
If you prefer to install Salesforce CLI using npm, we recommend you also use the Active LTS version of Node.js.

CLI Version Support

Salesforce supports only the most current version of Salesforce CLI. See the Salesforce CLI Release Notes for the latest version information.