Salesforce DX Developer Guide

How Salesforce Developer Experience Changes the Way You Work
Project Setup
Salesforce CLI Configuration and Tips
CLI Runtime Configuration Values
CLI Environment Variables
Salesforce DX Usernames and Orgs
Override or Add Definition File Options at the Command Line
CLI Parameter Resolution Order
Support for JSON Responses
Log Messages and Log Levels
CLI Deprecation Policy
Sample Repository on GitHub
Create a Salesforce DX Project
Create a Salesforce DX Project from Existing Source
Retrieve Source from an Existing Managed Package
Retrieve Unpackaged Source Defined in a package.xml File
Retrieve Unpackaged Source by Creating a Temporary Unmanaged Package
Convert the Metadata API Source
Link a Namespace to a Dev Hub Org
Salesforce DX Project Configuration
Authorization
Scratch Orgs
Development
Build and Release Your App
Develop Packages (Beta)
Continuous Integration
Troubleshoot Salesforce DX
Limitations for Salesforce DX
PDF

Newer Version Available

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

Salesforce CLI Configuration and Tips

Use the Salesforce command-line interface (CLI) for most Salesforce DX 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.

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 commands in the force topic.

1sfdx force:doc:commands:list