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 Second-Generation 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

CLI Runtime Configuration Values

You can set CLI runtime configuration values for your current project or for all projects. You can set two kinds of configuration values: global and local. Global values apply to all projects on your computer. Local values apply to a specific project. Local values override global values when commands are run from within a Salesforce DX project directory.

To set a configuration value for the current project:

1sfdx force:config:set name=<value>

For local configuration values, you must issue this command from within the Salesforce DX project directory.

To set the value for all your projects:

1sfdx force:config:set name=<value> --global

You can issue global commands anywhere or within any project, yet they apply to all the Salesforce CLI commands you run.

You can view the local and global configuration values that you have set. The output lists the local values for the project directory from which you are running the command and all global values.

1sfdx force:config:list

To return one or more previously set configuration values, use force:config:get. It is often useful to specify JSON output for this command for easier parsing in a continuous integration (CI) environment. For example, to return the value of defaultusername and defaultdevhubusername:

1sfdx force:config:get defaultusername defaultdevhubusername --json

To unset a configuration value, set it to no value. For example, to unset the instanceUrl configuration value:

1sfdx force:config:set instanceUrl=

You can set these CLI configuration values.

Configuration Value Name Description
apiVersion The API version for a specific project or all projects. This examples sets the API version for all projects (globally).

sfdx force:config:set apiVersion=41.0 --global
defaultusername The username for an org that all commands run against by default.
defaultdevhubusername The username of your Dev Hub org that the force:org:create command defaults to.
instanceUrl The URL of the Salesforce instance that is hosting your org.