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
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
Get Started with Salesforce CLI Unification
PDF

Newer Version Available

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

Salesforce CLI Configuration and Tips

Use Salesforce command-line interface (CLI) for most development and testing tasks. These tasks include authorizing a Dev Hub org, creating a scratch org, synchronizing source code between your scratch orgs and VCS, and running tests.

You can start using the CLI right after you install it.

The CLI commands are grouped into top-level topics. For example, the force top-level topic is divided into topics that group commands by functionality, such as the force:org commands to manage your orgs. The config top-level topic contains commands for managing configuration values.

Run --help at each level to get more information.

1sfdx --help                   // lists all top-level topics
2sfdx force --help             // lists all the topics under force
3sfdx force:org --help         // lists all the commands in the topic force:org
4sfdx force:org:open --help    // detailed info about the force:org:open command

Run this command to view all available Salesforce CLI commands:

1sfdx commands

To see all commands with their parameters and flags, run the command with the --json flag:

1sfdx commands --json