Salesforce CLI Setup Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Before You Begin
Release Notes
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
Troubleshoot Salesforce CLI
CLI Deprecation Policy
Next Steps
PDF

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.

Are you still using sfdx (v7)? See Move from sfdx (v7) to sf (v2) if so.

Important

Salesforce CLI is based on oclif, an open-source framework for building command-line interfaces in Node.js. You run it on your local machine or continuous integration (CI) system. It supports the installation of custom plugins.

We release new versions of the CLI and plugins 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 (Intel and M1)
  • Linux—Ubuntu 20.04
Code Editor or IDE
You can use any code editor. We recommend that you use Visual Studio Code (VS Code) and install the Salesforce Extensions for VS Code that are designed for development on Salesforce Platform.

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

Note

Enable API System Permission
Salesforce CLI requires the API Enabled system permission, which provides programmatic access to your org's information. If you’re unable to run CLI commands, ask your Salesforce admin to enable this permission.
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.

Salesforce CLI Version Support

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