Salesforce CLI Setup Guide

Before You Begin
Install Salesforce CLI
Install the CLI Release Candidate
Install Salesforce CLI Plug-Ins
Update Salesforce CLI
Salesforce CLI Configuration and Tips
Autocomplete CLI Commands, Parameters, and File Names
Use the Salesforce CLI from Behind a Company Firewall or Web Proxy
Windows Performance Suggestions
CLI Runtime Configuration Values
Environment Variables
CLI Parameter Resolution Order
Support for JSON Responses
Log Messages and Log Levels
Disable CLI Data Collection and Metrics
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

Windows Performance Suggestions

Follow these suggestions to improve the performance of Salesforce CLI on Windows.

We recommend that you consult your security administrator before making any of these suggested configuration changes.

Warning

Use a local file system for your Salesforce DX project rather than a cloud-based one.
Salesforce CLI performs better when your Salesforce DX project and associated files are on a local file system. Cloud-based file systems, such as OneDrive, Google Drive, and Dropbox, constantly watch all the files and directories in the file system. As a result, if you create your Salesforce DX project in one of these file systems, it can limit the performance of the Salesforce CLI. To avoid this issue, move your project directory away from these systems.
Install Salesforce CLI with the official installer and exclude the sfdx executable from Windows Defender.
  • Windows Defender continually rescans executables for potential threats. This scanning can have a noticeable performance impact on slower machines.
  • To exclude the CLI, use the sfdx executable installed from developer.salesforce.com and follow these steps:
    1. Add an exclusion to Windows Security.
    2. When prompted to select a folder, select C:\Program Files\Salesforce CLI.
Exclude the project folder from Windows Defender.
It’s also possible that Windows Defender keeps rescanning your project folder, causing negative performance. To exclude your project folder, follow these steps.
Exclude the sfdx executable from other security software.
Some companies use more extensive security software than Windows Defender, and this security software can cause Salesforce CLI to perform slowly. Work with your internal IT department to exclude the sfdx executable from all security software.
Close memory intensive programs.
Salesforce CLI can be performing slowly because other programs such as Google Chrome or VS Code are using too much memory. Try restarting these programs to free up memory.