Salesforce CLI Setup Guide

Quick Start
System Requirements
Move from sfdx (v7) to sf (v2)
Install Salesforce CLI
Update Salesforce CLI
Salesforce CLI Configuration and Tips
Autocomplete Salesforce CLI Commands and Flags
Use Salesforce CLI from Behind a Company Firewall or Web Proxy
Windows Performance Suggestions
Configuration Variables
Salesforce CLI Environment Variables
How API Version and Source API Version Work in Salesforce CLI
CLI Parameter Resolution Order
Support for JSON Responses
Specify Topics and Commands in Any Order
Customize the Colors in Help Output
Specify Flag Values in Files
Log Messages and Log Levels
Enable 256-Bit Encryption of Local Authorization Files
Disable Salesforce CLI Data Collection and Metrics
Uninstall Salesforce CLI or Plugins
Run Salesforce CLI Using a Docker Image
Salesforce CLI Plugins
Troubleshoot Salesforce CLI
CLI Deprecation Policy
Next Steps
Release Notes
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

CLI Parameter Resolution Order

Because you can specify parameters for a given Salesforce CLI command in several ways, it’s important to know the order of resolution.

Salesforce CLI resolves command-line flags and arguments, definition files, environment variables, and settings in this order, which means items at the top of the list take precedence over items lower down:

  • Command-line flags such as --target-org.
  • Options listed in a file specified at the command line. An example is a scratch org definition in a file, which you specify with the --definition-file flag of org create scratch. If you specify a flag at the command line, such as --edition, whose value differs from what exists in the definition file, the command-line flag takes precedence.
  • Environment variables, such as SF_TARGET_ORG.
  • Local configuration variables, such as target-org or target-dev-hub. To view the local configuration variables, run sf config list from your project directory.
  • Global CLI configuration variables. To view the global configuration variables, run sf config list --global from any directory.

Remember, command-line flags are at the top of the precedence list. For example, let’s say you set the SF_TARGET_ORG environment variable to myorg@mydomain.com. If you specify --target-org myotherorg@myotherdomain.com when you run a command, it connects to an org with the myotherorg@myotherdomain.com username.

Similarly, let’s say you set the configuration variable target-org to myorg@mydomain.com. If you specify --target-org myotherorg@myotherdomain.com when you run a command, you connect to an org with the myotherorg@myotherdomain.com username.