0% found this document useful (0 votes)

401 views

SFDX Cli Reference PDF

Uploaded by

Pascal Jaramillo

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

401 views

SFDX Cli Reference PDF

Uploaded by

Pascal Jaramillo

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 152

Salesforce CLI Command

Reference
Salesforce, Spring ’19

@salesforcedocs
Last updated: April 23, 2019
© Copyright 2000–2019 salesforce.com, inc. All rights reserved. Salesforce is a registered trademark of salesforce.com, inc.,

as are other names and marks. Other marks appearing herein may be trademarks of their respective owners.
CONTENTS

Salesforce CLI Command Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

force Namespace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Help for Salesforce CLI Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
CLI Deprecation Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
SALESFORCE CLI COMMAND REFERENCE

The command reference contains information about the Salesforce CLI commands and their parameters. This version of the command
reference includes details about version 45.12.0 of the salesforcedx CLI plug-in, for version 7.3.0 of Salesforce CLI.
For information about installing Salesforce CLI, see the Salesforce DX Setup Guide.
For information about Salesforce CLI changes, see the Salesforce CLI Release Notes.

force Namespace
Use commands in the force namespace to develop on the Salesforce Platform.
Help for Salesforce CLI Commands
The -h | --help parameter shows details about Salesforce CLI topics and their commands.
CLI Deprecation Policy
Salesforce deprecates CLI commands and parameters when, for example, the underlying API changes.

force Namespace
Use commands in the force namespace to develop on the Salesforce Platform.

alias Commands
Use the alias commands to manage username aliases.
apex Commands
Use the apex commands to create Apex classes, execute anonymous blocks, view your logs, run Apex tests, and view Apex test
results.
auth Commands
Use the auth commands to authorize a Salesforce org for use with the Salesforce CLI.
config Commands
Use the config commands to view and set your Salesforce CLI configuration values. Set your default Dev Hub and scratch org, and
your default instance URL, either globally or at the project level.
data Commands
Use the data commands to manipulate records in your org. Commands are available to help you work with various APIs. Import CSV
files with the Bulk API. Export and import data that includes master-detail relationships with the SObject Tree Save API. Perform
simple CRUD operations on individual records with the REST API.
doc Commands
Use the doc commands to display descriptions and help for commands in the force namespace.
lightning Commands
Use the lightning commands to create Aura components and Lightning web components and to test Aura components. As of API
version 45.0, you can build Lightning components using two programming models: Lightning Web Components, and the original
model, Aura Components. Lightning web components and Aura components can coexist and interoperate on a page.

1
Salesforce CLI Command Reference alias Commands

limits Commands
Use the limits commands to view your org’s limits and how close you are to reaching them.
mdapi Commands
Use the mdapi commands to retrieve and deploy Metadata API–formatted files that represent components in an org, or to convert
Metadata API–formatted metadata into the source format used in Salesforce DX projects.
org Commands
Use the org commands to manage the orgs you use with Salesforce CLI. Create and delete scratch orgs, list your created and authorized
orgs, and open orgs in your browser.
package Commands
Use the package commands to develop and install packages.
package1 Commands
Use the package1 commands to create and view first-generation package versions in your Dev Hub org.
project Commands
Use the project commands to set up a Salesforce DX project.
schema Commands
Use the schema commands to view information about the standard and custom objects in your org.
source Commands
Use the source commands to push and pull source to and from your scratch orgs, to deploy and retrieve source to and from
non-source-tracked orgs, to see synchronization changes between your project and scratch orgs, and to convert your source to the
metadata format for Metadata API deployments.
user Commands
Use the user commands to perform user-related admin tasks.
visualforce Commands
Use the visualforce commands to create Visualforce pages and components.

alias Commands
Use the alias commands to manage username aliases.

alias:list
Lists the aliases that the Salesforce CLI can use for various commands and tasks.
alias:set
Sets an alias that the Salesforce CLI can use for various commands and tasks.

alias:list
Lists the aliases that the Salesforce CLI can use for various commands and tasks.

Command Syntax
sfdx force:alias:list
[--json]
[--loglevel LOGLEVEL]

2
Salesforce CLI Command Reference alias Commands

Help for alias:list

Example:
$ sfdx force:alias:list

alias:set
Sets an alias that the Salesforce CLI can use for various commands and tasks.

Command Syntax
sfdx force:alias:set
[--json]
[--loglevel LOGLEVEL]

3
Salesforce CLI Command Reference apex Commands

Help for alias:set

You can associate an alias with only one username at a time. If you’ve set an alias multiple times, the alias points to the most recent
username.
To delete an alias, run "sfdx force:alias:set" with no username.
Examples:
$ sfdx force:alias:set [email protected]

$ sfdx force:alias:set [email protected] [email protected]

$ sfdx force:alias:set AliasToDelete=

apex Commands
Use the apex commands to create Apex classes, execute anonymous blocks, view your logs, run Apex tests, and view Apex test results.

apex:class:create
Creates an Apex class in the specified directory or the current working directory. If you don’t explicitly set the API version, it defaults
to the current API version. The .cls file and associated metadata file are created.
apex:execute
Executes one or more lines of anonymous Apex code, or executes the code in a local file.
apex:log:get
Fetches the last debug log.
apex:log:list
Displays a list of debug log IDs, along with general information about the logs.
apex:log:tail
Activates debug logging and displays logs in the terminal. You can also pipe the logs to a file.
apex:test:report
Displays the test results for a specific test run.
apex:test:run
Runs Apex tests.
apex:trigger:create
Creates an Apex trigger in the specified directory or the current working directory. If you don’t explicitly set the API version, it defaults
to the current API version. The .trigger file and associated metadata file are created.

Command Syntax
sfdx force:apex:class:create
[--json]

4
Salesforce CLI Command Reference apex Commands

[--loglevel LOGLEVEL]
-n CLASSNAME
[-t TEMPLATE]
[-d OUTPUTDIR]
[-a APIVERSION]

Parameters
--json
Optional
Formats output as JSON.
Type: boolean
--loglevel LOGLEVEL
Optional
The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.
Type: string
Permissible values are: trace, debug, info, warn, error, fatal
Default value: warn
-n | --classname CLASSNAME
Required
The name of the new Apex class. The name can be up to 40 characters and must start with a letter.
Type: string
-t | --template TEMPLATE
Optional
The template to use to create the file. Supplied parameter values or default values are filled into a copy of the template.
Type: string
Permissible values are: DefaultApexClass, ApexException, ApexUnitTest, InboundEmailService
Default value: DefaultApexClass
-d | --outputdir OUTPUTDIR
Optional
The directory to store the newly created files. The location can be an absolute path or relative to the current working directory. The
default is the current directory.
Type: string
-a | --apiversion APIVERSION
Optional
The API version of the created source.
Type: string
Permissible values are: 45.0, 44.0
Default value: 45.0

5
Salesforce CLI Command Reference apex Commands

Help for apex:class:create

apex:execute
Executes one or more lines of anonymous Apex code, or executes the code in a local file.

Command Syntax
sfdx force:apex:execute
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
[-f APEXCODEFILE]

6
Salesforce CLI Command Reference apex Commands

Help for apex:execute

Executes one or more lines of Apex code, or executes the code in a local file.
Before you enter code, run this command with no parameters to get a prompt.
From the prompt, all commands are executed in a single execute anonymous request.
For more information, see "Anonymous Blocks" in the Apex Developer Guide.
Examples:
$ sfdx force:apex:execute -f ~/test.apex

$ sfdx force:apex:execute

>> Start typing Apex code. Press the Enter key after each line,

>> then press CTRL+D when finished.

apex:log:get
Fetches the last debug log.

Command Syntax
sfdx force:apex:log:get
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
[-c]
[-i LOGID]
[-n NUMBER]

7
Salesforce CLI Command Reference apex Commands

-u | --targetusername TARGETUSERNAME
Optional
A username or alias for the target org. Overrides the default target org.
Type: string
--apiversion APIVERSION
Optional
Override the API version used for API requests made by this command.
Type: string
-c | --color
Optional
Applies default colors to noteworthy log lines.
Type: boolean
-i | --logid LOGID
Optional
ID of the log to display.
Type: id
-n | --number NUMBER
Optional
Number of most recent logs to display.
Type: number

Help for apex:log:get

When you execute this command in a project, it fetches the specified log or given number of last logs from your default scratch org.
To get the IDs for your debug logs, run "sfdx force:apex:log:list".
To specify a count of logs to return, use the --number parameter to return the most recent logs.
Executing this command without parameters returns the most recent log.
Examples:
$ sfdx force:apex:log:get -i <log id>

$ sfdx force:apex:log:get -i <log id> -u [email protected]

$ sfdx force:apex:log:get -n 2 -c

apex:log:list
Displays a list of debug log IDs, along with general information about the logs.

Command Syntax
sfdx force:apex:log:list
[--json]

8
Salesforce CLI Command Reference apex Commands

[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]

Help for apex:log:list

When you execute this command in a project, it lists the log IDs for your default scratch org.
Examples:
$ sfdx force:apex:log:list

$ sfdx force:apex:log:list -u [email protected]

apex:log:tail
Activates debug logging and displays logs in the terminal. You can also pipe the logs to a file.

Command Syntax
sfdx force:apex:log:tail
[--json]
[--loglevel LOGLEVEL]

9
Salesforce CLI Command Reference apex Commands

[-u TARGETUSERNAME]
[--apiversion APIVERSION]
[-c]
[-d DEBUGLEVEL]
[-s]

10
Salesforce CLI Command Reference apex Commands

Help for apex:log:tail

Tails logs from your target org for 30 minutes.
If a DEVELOPER_LOG trace flag does not exist, this command creates one in the target org.
If the active trace flag's expiration date is within this command's timeout window, the command sets the trace flag's expiration date to
30 minutes from the current time.
The --debuglevel parameter assigns a debug level to the active DEVELOPER_LOG trace flag.
Use --skiptraceflag to skip trace flag setup, including setting expiration date and debug level. Include this flag only if there is an active
user-based trace flag for your user.
The --json parameter emits log lines in JSON, but does not follow the standard Salesforce CLI JSON format (which includes status and
result values).
Examples:
$ sfdx force:apex:log:tail

$ sfdx force:apex:log:tail --debuglevel MyDebugLevel

$ sfdx force:apex:log:tail -c -s

apex:test:report
Displays the test results for a specific test run.

Command Syntax
sfdx force:apex:test:report
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
-i TESTRUNID
[-c]
[-d OUTPUTDIR]
[-w WAIT]
[--verbose]
[-r RESULTFORMAT]

Parameters
--json
Optional
Format output as JSON.
Type: boolean

11
Salesforce CLI Command Reference apex Commands

--loglevel LOGLEVEL
Optional
The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.
Type: string
Permissible values are: trace, debug, info, warn, error, fatal
Default value: warn
-u | --targetusername TARGETUSERNAME
Optional
A username or alias for the target org. Overrides the default target org.
Type: string
--apiversion APIVERSION
Optional
Override the API version used for API requests made by this command.
Type: string
-i | --testrunid TESTRUNID
Required
The ID of test run.
Type: id
-c | --codecoverage
Optional
Retrieves code coverage results.
Type: boolean
-d | --outputdir OUTPUTDIR
Optional
Directory to store test run files.
Type: directory
-w | --wait WAIT
Optional
Sets the streaming client socket timeout, in minutes. If the streaming client socket has no contact from the server for a number of
minutes, the client exits. Specify a longer wait time if timeouts occur frequently.
Type: minutes
Default value: 6
--verbose
Optional
Displays Apex test processing details. If JSON format is specified, processing details aren’t displayed.
Type: boolean
-r | --resultformat RESULTFORMAT
Optional
Format to use when displaying results. If you also specify the --json flag, --json overrides this parameter.

12
Salesforce CLI Command Reference apex Commands

Type: string
Permissible values are: human, tap, junit, json
Default value: human

Help for apex:test:report

Displays test results for an enqueued or completed asynchronous Apex test run.
Examples:
$ sfdx force:apex:test:report -i <test run id>

$ sfdx force:apex:test:report -i <test run id> -r junit

$ sfdx force:apex:test:report -i <test run id> -c --json

apex:test:run
Runs Apex tests.

Command Syntax
sfdx force:apex:test:run
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
[-n CLASSNAMES]
[-s SUITENAMES]
[-t TESTS]
[-c]
[-d OUTPUTDIR]
[-l TESTLEVEL]
[-w WAIT]
[-y]
[--verbose]
[-r RESULTFORMAT]

Parameters
--json
Optional
Format output as JSON.
Type: boolean

13
Salesforce CLI Command Reference apex Commands

--loglevel LOGLEVEL
Optional
The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.
Type: string
Permissible values are: trace, debug, info, warn, error, fatal
Default value: warn
-u | --targetusername TARGETUSERNAME
Optional
A username or alias for the target org. Overrides the default target org.
Type: string
--apiversion APIVERSION
Optional
Override the API version used for API requests made by this command.
Type: string
-n | --classnames CLASSNAMES
Optional
Comma-separated list of Apex test class names to run. You can specify only one of classnames, suitenames, or tests.
Type: array
-s | --suitenames SUITENAMES
Optional
Comma-separated list of Apex test suite names to run. You can only specify one of classnames, suitenames, or tests.
Type: array
-t | --tests TESTS
Optional
Comma-separated list of Apex test class names or IDs and test methods, if applicable, to run. You can only specify one of classnames,
suitenames, or tests.
Type: array
-c | --codecoverage
Optional
Retrieves code coverage results.
Type: boolean
-d | --outputdir OUTPUTDIR
Optional
Directory to store test run files.
Type: directory
-l | --testlevel TESTLEVEL
Optional
Specifies which tests to run, using one of these TestLevel enum values:
RunSpecifiedTests—Only the tests that you specify are run.

14
Salesforce CLI Command Reference apex Commands

RunLocalTests—All tests in your org are run, except the ones that originate from installed managed packages.
RunAllTestsInOrg—All tests are in your org and in installed managed packages are run.
Type: string
Permissible values are: RunLocalTests, RunAllTestsInOrg, RunSpecifiedTests
-w | --wait WAIT
Optional
Sets the streaming client socket timeout, in minutes. If the streaming client socket has no contact from the server for a number of
minutes, the client exits. Specify a longer wait time if timeouts occur frequently.
Type: minutes
-y | --synchronous
Optional
Runs test methods from a single Apex class synchronously. If you don't specify this flag, tests are run asynchronously.
Type: boolean
--verbose
Optional
Displays Apex test processing details. If JSON format is specified, processing details aren’t displayed.
Type: boolean
-r | --resultformat RESULTFORMAT
Optional
Format to use when displaying results. If you also specify the --json flag, --json overrides this parameter.
Type: string
Permissible values are: human, tap, junit, json

Help for apex:test:run

By default, runs all Apex tests in the org’s namespace.
To run specific test classes, specify class names or suite names, or set a --testlevel value.
To run specific test methods, use --tests.
Examples:
$ sfdx force:apex:test:run

$ sfdx force:apex:test:run -n MyClassTest,MyOtherClassTest -r human

$ sfdx force:apex:test:run -s MySuite,MyOtherSuite -c --json

$ sfdx force:apex:test:run -t
MyClassTest.testCoolFeature,MyClassTest.testAwesomeFeature,AnotherClassTest,namespace.TheirClassTest.testThis
-r human

$ sfdx force:apex:test:run -l RunLocalTests -d <path to outputdir> -u [email protected]

15
Salesforce CLI Command Reference apex Commands

apex:trigger:create
Creates an Apex trigger in the specified directory or the current working directory. If you don’t explicitly set the API version, it defaults
to the current API version. The .trigger file and associated metadata file are created.

Command Syntax
sfdx force:apex:trigger:create
[--json]
[--loglevel LOGLEVEL]
-n TRIGGERNAME
[-t TEMPLATE]
[-d OUTPUTDIR]
[-a APIVERSION]
[-s SOBJECT]
[-e TRIGGEREVENTS]

16
Salesforce CLI Command Reference auth Commands

The directory to store the newly created files. The location can be an absolute path or relative to the current working directory. The
default is the current directory.
Type: string
-a | --apiversion APIVERSION
Optional
The API version of the created source.
Type: string
Permissible values are: 45.0, 44.0
Default value: 45.0
-s | --sobject SOBJECT
Optional
The sObject to create an Apex trigger on.
Type: string
Default value: SOBJECT
-e | --triggerevents TRIGGEREVENTS
Optional
The events that cause the trigger to fire.
Type: array
Default value: before insert

Help for apex:trigger:create

auth Commands
Use the auth commands to authorize a Salesforce org for use with the Salesforce CLI.

auth:jwt:grant
Authorizes a Salesforce org using the JWT flow.
auth:list
Lists the usernames you’ve authorized. Unlike org:list, this command doesn’t check whether orgs are still valid.
auth:logout
Logs you out from one or all of your authorized Salesforce orgs.
auth:sfdxurl:store
Authorizes a Salesforce org using an SFDX auth URL.
auth:web:login
Authorizes a Salesforce org by opening a browser so you can log in through salesforce.com.

auth:jwt:grant
Authorizes a Salesforce org using the JWT flow.

17
Salesforce CLI Command Reference auth Commands

Command Syntax
sfdx force:auth:jwt:grant
[--json]
[--loglevel LOGLEVEL]
-u USERNAME
-f JWTKEYFILE
-i CLIENTID
[-r INSTANCEURL]
[-d]
[-s]
[-a SETALIAS]

18
Salesforce CLI Command Reference auth Commands

Type: url
-d | --setdefaultdevhubusername
Optional
Sets the authenticated org as the default Dev Hub org for scratch org creation.
Type: boolean
-s | --setdefaultusername
Optional
Sets the authenticated org as the default username that all commands run against.
Type: boolean
-a | --setalias SETALIAS
Optional
Sets an alias for the authenticated org.
Type: string

Help for auth:jwt:grant

Authorizes a Salesforce org using a private key file that has been uploaded to a personal connected app.
If you specify an --instanceurl value, this value overrides the sfdcLoginUrl value in your sfdx-project.json file. To specify a My Domain
URL, use the format <yourdomain>.my.salesforce.com (not <yourdomain>.lightning.force.com).
Examples:
$ sfdx force:auth:jwt:grant -u [email protected] -f <path to jwt key file> -i <OAuth client id>

$ sfdx force:auth:jwt:grant -u [email protected] -f <path to jwt key file> -i <OAuth client id>
-s -a MyDefaultOrg

$ sfdx force:auth:jwt:grant -u [email protected] -f <path to jwt key file> -i <OAuth client

id> -r https://acme.my.salesforce.com

auth:list
Lists the usernames you’ve authorized. Unlike org:list, this command doesn’t check whether orgs are still valid.

Command Syntax
sfdx force:auth:list
[--json]
[--loglevel LOGLEVEL]

Parameters
--json
Optional
Format output as JSON.
Type: boolean

19
Salesforce CLI Command Reference auth Commands

Help for auth:list

auth:logout
Logs you out from one or all of your authorized Salesforce orgs.

Command Syntax
sfdx force:auth:logout
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
[-a]
[-p]

20
Salesforce CLI Command Reference auth Commands

Override the API version used for API requests made by this command.
Type: string
-a | --all
Optional
Includes all authenticated orgs: for example, Dev Hubs, sandboxes, DE orgs, and expired, deleted, and unknown-status scratch orgs.
Type: boolean
-p | --noprompt
Optional
Do not prompt for confirmation.
Type: boolean

Help for auth:logout

By default, this command logs you out from your default scratch org.
Examples:
$ sfdx force:auth:logout -u [email protected]

$ sfdx force:auth:logout -a

$ sfdx force:auth:logout -p

auth:sfdxurl:store
Authorizes a Salesforce org using an SFDX auth URL.

Command Syntax
sfdx force:auth:sfdxurl:store
[--json]
[--loglevel LOGLEVEL]
-f SFDXURLFILE
[-d]
[-s]
[-a SETALIAS]

Parameters
--json
Optional
Format output as JSON.
Type: boolean
--loglevel LOGLEVEL
Optional

21
Salesforce CLI Command Reference auth Commands

The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.
Type: string
Permissible values are: trace, debug, info, warn, error, fatal
Default value: warn
-f | --sfdxurlfile SFDXURLFILE
Required
Path to a file containing the SFDX URL.
Type: filepath
-d | --setdefaultdevhubusername
Optional
Sets the authenticated org as the default Dev Hub org for scratch org creation.
Type: boolean
-s | --setdefaultusername
Optional
Sets the authenticated org as the default username that all commands run against.
Type: boolean
-a | --setalias SETALIAS
Optional
Sets an alias for the authenticated org.
Type: string

Help for auth:sfdxurl:store

Authorize a Salesforce org using an SFDX auth URL stored within a file.
The file must have the format "force://<refreshToken>@<instanceUrl>" or
"force://<clientId>:<clientSecret>:<refreshToken>@<instanceUrl>".
The file must contain only the URL or be a JSON file that has a top-level property named sfdxAuthUrl.
Examples:
$ sfdx force:auth:sfdxurl:store -f <path to sfdxAuthUrl file>

$ sfdx force:auth:sfdxurl:store -f <path to sfdxAuthUrl file> -s -a MyDefaultOrg

auth:web:login
Authorizes a Salesforce org by opening a browser so you can log in through salesforce.com.

Command Syntax
sfdx force:auth:web:login
[--json]
[--loglevel LOGLEVEL]
[-i CLIENTID]

22
Salesforce CLI Command Reference auth Commands

[-r INSTANCEURL]
[-d]
[-s]
[-a SETALIAS]

Help for auth:web:login

To log in to a sandbox, set --instanceurl to https://test.salesforce.com.

23
Salesforce CLI Command Reference config Commands

Examples:
$ sfdx force:auth:web:login -a TestOrg1

$ sfdx force:auth:web:login -i <OAuth client id>

$ sfdx force:auth:web:login -r https://test.salesforce.com

config Commands
Use the config commands to view and set your Salesforce CLI configuration values. Set your default Dev Hub and scratch org, and your
default instance URL, either globally or at the project level.

config:get
Gets the Salesforce CLI configuration values for your default scratch org, your default Dev Hub org, your default instance URL, or any
combination of the three.
config:list
Lists the configuration variables for the Salesforce CLI.
config:set
Sets the local and global configuration variables for the Salesforce CLI.

config:get
Gets the Salesforce CLI configuration values for your default scratch org, your default Dev Hub org, your default instance URL, or any
combination of the three.

Command Syntax
sfdx force:config:get
[--json]
[--loglevel LOGLEVEL]
[--verbose]

24
Salesforce CLI Command Reference config Commands

--verbose
Optional
Emit additional command output to stdout.
Type: boolean

Help for config:get

To see your default scratch org username, include "defaultusername".
To see your default Dev Hub, include "defaultdevhubusername".
To see your default instance URL, include "instanceUrl".
To see the locations where your values are set, include the --verbose flag.
Examples:
$ sfdx force:config:get defaultusername

$ sfdx force:config:get defaultusername defaultdevhubusername instanceUrl

$ sfdx force:config:get defaultusername defaultdevhubusername --verbose

config:list
Lists the configuration variables for the Salesforce CLI.

Command Syntax
sfdx force:config:list
[--json]
[--loglevel LOGLEVEL]

Help for config:list

Lists the config variables that the Salesforce CLI uses for various commands and tasks.

25
Salesforce CLI Command Reference data Commands

config:set
Sets the local and global configuration variables for the Salesforce CLI.

Command Syntax
sfdx force:config:set
[--json]
[--loglevel LOGLEVEL]
[-g]

Help for config:set

Sets the configuration variables that the Salesforce CLI uses for various commands and tasks. Local variables apply only to your current
project. Global variables apply in any directory.
Examples:
$ sfdx force:config:set [email protected] [email protected]

$ sfdx force:config:set [email protected] -g

data Commands
Use the data commands to manipulate records in your org. Commands are available to help you work with various APIs. Import CSV
files with the Bulk API. Export and import data that includes master-detail relationships with the SObject Tree Save API. Perform simple
CRUD operations on individual records with the REST API.

26
Salesforce CLI Command Reference data Commands

data:bulk:delete
Deletes a batch of records listed in a CSV file.
data:bulk:status
Polls the Bulk API for job status or batch status.
data:bulk:upsert
Creates a job and one or more batches for inserting new rows and updating existing rows by accessing the Bulk API.
data:record:create
Creates and inserts a record.
data:record:delete
Deletes a single record.
data:record:get
Displays a single record.
data:record:update
Updates a single record.
data:soql:query
Executes a SOQL query.
data:tree:export
Exports data from an org into sObject tree format for force:data:tree:import consumption.
data:tree:import
Imports data into an org using the SObject Tree Save API. This data can include master-detail relationships.

data:bulk:delete
Deletes a batch of records listed in a CSV file.

Command Syntax
sfdx force:data:bulk:delete
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
-s SOBJECTTYPE
-f CSVFILE
[-w WAIT]

Parameters
--json
Optional
Format output as JSON.
Type: boolean

27
Salesforce CLI Command Reference data Commands

Help for data:bulk:delete

The file must be a CSV file with only one column: "Id".
One job can contain many batches, depending on the length of the CSV file.
Returns a job ID and a batch ID. Use these IDs to check job status with data:bulk:status.
Examples:
$ sfdx force:data:bulk:delete -s Account -f ./path/to/file.csv

$ sfdx force:data:bulk:delete -s MyObject__c -f ./path/to/file.csv

data:bulk:status
Polls the Bulk API for job status or batch status.

28
Salesforce CLI Command Reference data Commands

Command Syntax
sfdx force:data:bulk:status
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
-i JOBID
[-b BATCHID]

29
Salesforce CLI Command Reference data Commands

Help for data:bulk:status

Examples:
$ sfdx force:data:bulk:status -i 750xx000000005sAAA

$ sfdx force:data:bulk:status -i 750xx000000005sAAA -b 751xx000000005nAAA

data:bulk:upsert
Creates a job and one or more batches for inserting new rows and updating existing rows by accessing the Bulk API.

Command Syntax
sfdx force:data:bulk:upsert
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
-s SOBJECTTYPE
-f CSVFILE
-i EXTERNALID
[-w WAIT]

30
Salesforce CLI Command Reference data Commands

Type: string
-s | --sobjecttype SOBJECTTYPE
Required
The sObject type of the records you want to upsert.
Type: string
-f | --csvfile CSVFILE
Required
The path to the CSV file that defines the records to upsert.
Type: filepath
-i | --externalid EXTERNALID
Required
The column name of the external ID.
Type: string
-w | --wait WAIT
Optional
The number of minutes to wait for the command to complete before displaying the results.
Type: minutes

Help for data:bulk:upsert

Inserts or updates records from a CSV file.
One job can contain many batches, depending on the length of the CSV file.
Returns a job ID and a batch ID. Use these IDs to check job status with data:bulk:status.
For information about formatting your CSV file, see "Prepare CSV Files" in the Bulk API Developer Guide.
Examples:
$ sfdx force:data:bulk:upsert -s MyObject__c -f ./path/to/file.csv -i MyField__c

$ sfdx force:data:bulk:upsert -s MyObject__c -f ./path/to/file.csv -i Id -w 2

data:record:create
Creates and inserts a record.

Command Syntax
sfdx force:data:record:create
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
-s SOBJECTTYPE

31
Salesforce CLI Command Reference data Commands

-v VALUES
[-t]
[--perflog]

32
Salesforce CLI Command Reference data Commands

Help for data:record:create

The format of a field-value pair is <fieldName>=<value>.
Enclose all field-value pairs in one set of double quotation marks, delimited by spaces.
Enclose values that contain spaces in single quotes.
To get data on API performance metrics, specify both --perflog and --json.
Examples:
$ sfdx force:data:record:create -s Account -v "Name=Acme"

$ sfdx force:data:record:create -s Account -v "Name='Universal Containers'"

$ sfdx force:data:record:create -s Account -v "Name='Universal Containers'

Website=www.example.com"

$ sfdx force:data:record:create -t -s TraceFlag -v "DebugLevelId=7dl170000008U36AAE

StartDate=2017-12-01T00:26:04.000+0000 ExpirationDate=2017-12-01T00:56:04.000+0000
LogType=CLASS_TRACING TracedEntityId=01p17000000R6bLAAS"

$ sfdx force:data:record:create -s Account -v "Name=Acme" --perflog --json

data:record:delete
Deletes a single record.

Command Syntax
sfdx force:data:record:delete
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
-s SOBJECTTYPE
[-i SOBJECTID]
[-w WHERE]
[-t]
[--perflog]

Parameters
--json
Optional
Format output as JSON.
Type: boolean
--loglevel LOGLEVEL
Optional

33
Salesforce CLI Command Reference data Commands

The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.
Type: string
Permissible values are: trace, debug, info, warn, error, fatal
Default value: warn
-u | --targetusername TARGETUSERNAME
Optional
A username or alias for the target org. Overrides the default target org.
Type: string
--apiversion APIVERSION
Optional
Override the API version used for API requests made by this command.
Type: string
-s | --sobjecttype SOBJECTTYPE
Required
The sObject type of the record you’re deleting.
Type: string
-i | --sobjectid SOBJECTID
Optional
The ID of the record you’re deleting.
Type: id
-w | --where WHERE
Optional
A list of <fieldName>=<value> pairs to search for.
Type: string
-t | --usetoolingapi
Optional
Delete the record using Tooling API.
Type: boolean
--perflog
Optional
Gets data on API performance metrics from the server. The data is stored in $HOME/.sfdx/apiPerformanceLog.json
Type: boolean

Help for data:record:delete

Specify an sObject type and either an ID or a list of <fieldName>=<value> pairs.
The format of a field-value pair is <fieldName>=<value>.
Enclose all field-value pairs in one set of double quotation marks, delimited by spaces.
Enclose values that contain spaces in single quotes.
To get data on API performance metrics, specify both --perflog and --json.

34
Salesforce CLI Command Reference data Commands

Examples:
$ sfdx force:data:record:delete -s Account -i 001D000000Kv3dl

$ sfdx force:data:record:delete -s Account -w "Name=Acme"

$ sfdx force:data:record:delete -s Account -w "Name='Universal Containers'"

$ sfdx force:data:record:delete -s Account -w "Name='Universal Containers' Phone='(123)

456-7890'"

$ sfdx force:data:record:delete -t -s TraceFlag -i 7tf170000009cU6AAI --perflog --json

data:record:get
Displays a single record.

Command Syntax
sfdx force:data:record:get
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
-s SOBJECTTYPE
[-i SOBJECTID]
[-w WHERE]
[-t]
[--perflog]

35
Salesforce CLI Command Reference data Commands

Type: string
--apiversion APIVERSION
Optional
Override the API version used for API requests made by this command.
Type: string
-s | --sobjecttype SOBJECTTYPE
Required
The sObject type of the record you’re retrieving.
Type: string
-i | --sobjectid SOBJECTID
Optional
The ID of the record you’re retrieving.
Type: id
-w | --where WHERE
Optional
A list of <fieldName>=<value> pairs to search for.
Type: string
-t | --usetoolingapi
Optional
Retrieve the record using Tooling API.
Type: boolean
--perflog
Optional
Gets data on API performance metrics from the server. The data is stored in $HOME/.sfdx/apiPerformanceLog.json
Type: boolean

Help for data:record:get

36
Salesforce CLI Command Reference data Commands

Examples:
$ sfdx force:data:record:get -s Account -i 001D000000Kv3dl

$ sfdx force:data:record:get -s Account -w "Name=Acme"

$ sfdx force:data:record:get -s Account -w "Name='Universal Containers'"

$ sfdx force:data:record:get -s Account -w "Name='Universal Containers' Phone='(123)

456-7890'"

$ sfdx force:data:record:get -t -s TraceFlag -i 7tf170000009cUBAAY --perflog --json

data:record:update
Updates a single record.

Command Syntax
sfdx force:data:record:update
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
-s SOBJECTTYPE
[-i SOBJECTID]
[-w WHERE]
-v VALUES
[-t]
[--perflog]

37
Salesforce CLI Command Reference data Commands

A username or alias for the target org. Overrides the default target org.
Type: string
--apiversion APIVERSION
Optional
Override the API version used for API requests made by this command.
Type: string
-s | --sobjecttype SOBJECTTYPE
Required
The sObject type of the record you’re updating.
Type: string
-i | --sobjectid SOBJECTID
Optional
The ID of the record you’re updating.
Type: id
-w | --where WHERE
Optional
A list of <fieldName>=<value> pairs to search for.
Type: string
-v | --values VALUES
Required
The <fieldName>=<value> pairs you’re updating.
Type: string
-t | --usetoolingapi
Optional
Update the record using Tooling API.
Type: boolean
--perflog
Optional
Gets data on API performance metrics from the server. The data is stored in $HOME/.sfdx/apiPerformanceLog.json
Type: boolean

Help for data:record:update

38
Salesforce CLI Command Reference data Commands

Examples:
$ sfdx force:data:record:update -s Account -i 001D000000Kv3dl -v "Name=NewAcme"

$ sfdx force:data:record:update -s Account -w "Name='Old Acme'" -v "Name='New Acme'"

$ sfdx force:data:record:update -s Account -i 001D000000Kv3dl -v "Name='Acme III'

Website=www.example.com"

$ sfdx force:data:record:update -t -s TraceFlag -i 7tf170000009cUBAAY -v

"ExpirationDate=2017-12-01T00:58:04.000+0000"

$ sfdx force:data:record:update -s Account -i 001D000000Kv3dl -v "Name=NewAcme" --perflog

--json

data:soql:query
Executes a SOQL query.

Command Syntax
sfdx force:data:soql:query
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
-q QUERY
[-t]
[-r RESULTFORMAT]
[--perflog]

39
Salesforce CLI Command Reference data Commands

A username or alias for the target org. Overrides the default target org.
Type: string
--apiversion APIVERSION
Optional
Override the API version used for API requests made by this command.
Type: string
-q | --query QUERY
Required
SOQL query to execute.
Type: string
-t | --usetoolingapi
Optional
Execute the query using Tooling API.
Type: boolean
-r | --resultformat RESULTFORMAT
Optional
Format to use when displaying results. If you also specify the --json flag, --json overrides this parameter.
Type: string
Permissible values are: human, csv, json
Default value: human
--perflog
Optional
Gets data on API performance metrics from the server. The data is stored in $HOME/.sfdx/apiPerformanceLog.json
Type: boolean

Help for data:soql:query

When you execute this command in a project, it executes the query against the data in your default scratch org.
To get data on API performance metrics, specify both --perflog and --json.
Examples:
$ sfdx force:data:soql:query -q "SELECT Id, Name, Account.Name FROM Contact"

$ sfdx force:data:soql:query -q "SELECT Id, Name FROM Account WHERE ShippingState IN

('CA', 'NY')"

$ sfdx force:data:soql:query -q "SELECT Name FROM ApexTrigger" -t

$ sfdx force:data:soql:query -q "SELECT Name FROM ApexTrigger" --perflog --json

data:tree:export
Exports data from an org into sObject tree format for force:data:tree:import consumption.

40
Salesforce CLI Command Reference data Commands

Command Syntax
sfdx force:data:tree:export
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
-q QUERY
[-p]
[-x PREFIX]
[-d OUTPUTDIR]

41
Salesforce CLI Command Reference data Commands

-x | --prefix PREFIX
Optional
Prefix of generated files.
Type: string
-d | --outputdir OUTPUTDIR
Optional
Directory to store generated files.
Type: directory

Help for data:tree:export

Generates JSON files for use with the force:data:tree:import command.
Examples:
$ sfdx force:data:tree:export -q "SELECT Id, Name, (SELECT Name, Address__c FROM
Properties__r) FROM Broker__c"

$ sfdx force:data:tree:export -q <path to file containing soql query> -x export-demo

-d /tmp/sfdx-out -p

For more information and examples, run "sfdx force:data:tree:import -h".

The query for export can return a maximum of 2,000 records. For more information, see the REST API Developer Guide:
https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobject_tree.htm

data:tree:import
Imports data into an org using the SObject Tree Save API. This data can include master-detail relationships.

Command Syntax
sfdx force:data:tree:import
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
[-f SOBJECTTREEFILES]
[-p PLAN]
[--confighelp]

Parameters
--json
Optional
Format output as JSON.
Type: boolean

42
Salesforce CLI Command Reference data Commands

--loglevel LOGLEVEL
Optional
The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.
Type: string
Permissible values are: trace, debug, info, warn, error, fatal
Default value: warn
-u | --targetusername TARGETUSERNAME
Optional
A username or alias for the target org. Overrides the default target org.
Type: string
--apiversion APIVERSION
Optional
Override the API version used for API requests made by this command.
Type: string
-f | --sobjecttreefiles SOBJECTTREEFILES
Optional
Comma-delimited, ordered paths of JSON files containing a collection of record trees to insert. Either --sobjecttreefiles or --plan is
required.
Type: array
-p | --plan PLAN
Optional
Path to plan to insert multiple data files that have master-detail relationships. Either --sobjecttreefiles or --plan is required.
Type: filepath
--confighelp
Optional
Displays the schema information for the configuration file. If you use this option, all other options, except --json, are ignored.
Type: boolean

Help for data:tree:import

To generate JSON files for use with force:data:tree:import, run "sfdx force:data:tree:export".
Examples:
To import records as individual files, first run the export commands:
$ sfdx force:data:tree:export -q "SELECT Id, Name FROM Account"

$ sfdx force:data:tree:export -q "SELECT Id, LastName, FirstName FROM Contact"

Then run the import command:

$ sfdx force:data:tree:import -f Contact.json,Account.json -u [email protected]

43
Salesforce CLI Command Reference doc Commands

To import multiple data files as part of a plan, first run the export command with the -p | --plan flag:
$ sfdx force:data:tree:export -p -q "SELECT Id, Name, (SELECT Id, LastName, FirstName
FROM Contacts) FROM Account"

Then run the import command, supplying a filepath value for the -p | --plan parameter:
$ sfdx force:data:tree:import -p Account-Contact-plan.json -u [email protected]

The SObject Tree API supports requests that contain up to 200 records. For more information, see the REST API Developer Guide:
https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobject_tree.htm

doc Commands
Use the doc commands to display descriptions and help for commands in the force namespace.

doc:commands:display
Displays help for commands in the force namespace.
doc:commands:list
Lists the commands in the force namespace.

doc:commands:display
Displays help for commands in the force namespace.

Command Syntax
sfdx force:doc:commands:display
[--json]
[--loglevel LOGLEVEL]

Help for doc:commands:display

Displays --help output for commands in the force namespace.

44
Salesforce CLI Command Reference lightning Commands

To display more details about the commands’ parameters, include the --json flag.

doc:commands:list
Lists the commands in the force namespace.

Command Syntax
sfdx force:doc:commands:list
[--json]
[--loglevel LOGLEVEL]
[-u]

Help for doc:commands:list

Displays a list of commands in the force namespace and their descriptions.

lightning Commands
Use the lightning commands to create Aura components and Lightning web components and to test Aura components. As of API version
45.0, you can build Lightning components using two programming models: Lightning Web Components, and the original model, Aura
Components. Lightning web components and Aura components can coexist and interoperate on a page.

lightning:app:create
Creates a Lightning app bundle in the specified directory or the current working directory. The bundle consists of multiple files in a
folder with the designated name.

45
Salesforce CLI Command Reference lightning Commands

lightning:component:create
Creates a bundle for an Aura component or a Lightning web component. in the specified directory or the current working directory.
The bundle consists of multiple files in a folder with the designated name.
lightning:event:create
Creates a Lightning event bundle in the specified directory or the current working directory. The bundle consists of multiple files in
a folder with the designated name.
lightning:interface:create
Creates a Lightning interface bundle in the specified directory or the current working directory. The bundle consists of multiple files
in a folder with the designated name.
lightning:lint
Runs a static analysis, or “lint,” tool on your Aura component code. The default rules include recommended best practices and Locker
Service requirements. For details, including how to customize the rules for your org, see the Lightning Aura Components Developer
Guide.
lightning:test:create
Creates a Lightning test in the specified directory or the current working directory. The .resource file and associated metadata file
are created.
lightning:test:install
Installs a Lightning Testing Service (LTS) unmanaged package into your org.
lightning:test:run
Runs Aura component tests. The Lightning Testing Service (LTS) unmanaged package must be installed in your org. For details, see
the LTS documentation.

lightning:app:create
Creates a Lightning app bundle in the specified directory or the current working directory. The bundle consists of multiple files in a folder
with the designated name.

Command Syntax
sfdx force:lightning:app:create
[--json]
[--loglevel LOGLEVEL]
-n APPNAME
[-t TEMPLATE]
[-d OUTPUTDIR]
[-a APIVERSION]

Parameters
--json
Optional
Formats output as JSON.
Type: boolean

46
Salesforce CLI Command Reference lightning Commands

--loglevel LOGLEVEL
Optional
The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.
Type: string
Permissible values are: trace, debug, info, warn, error, fatal
Default value: warn
-n | --appname APPNAME
Required
The Lightning app name. The name can be up to 40 characters and must start with a letter.
Type: string
-t | --template TEMPLATE
Optional
The template to use to create the file. Supplied parameter values or default values are filled into a copy of the template.
Type: string
Permissible values are: DefaultLightningApp
Default value: DefaultLightningApp
-d | --outputdir OUTPUTDIR
Optional
The directory to store the newly created files. The location can be an absolute path or relative to the current working directory. The
default is the current directory.
Type: string
-a | --apiversion APIVERSION
Optional
The API version of the created source.
Type: string
Permissible values are: 45.0, 44.0
Default value: 45.0

Help for lightning:app:create

Command Syntax
sfdx force:lightning:component:create
[--json]
[--loglevel LOGLEVEL]
-n COMPONENTNAME

47
Salesforce CLI Command Reference lightning Commands

[-t TEMPLATE]
[-d OUTPUTDIR]
[-a APIVERSION]
[--type TYPE]

Parameters
--json
Optional
Formats output as JSON.
Type: boolean
--loglevel LOGLEVEL
Optional
The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.
Type: string
Permissible values are: trace, debug, info, warn, error, fatal
Default value: warn
-n | --componentname COMPONENTNAME
Required
The Lightning component name. The name can be up to 40 characters and must start with a letter.
Type: string
-t | --template TEMPLATE
Optional
The template to use to create the file. Supplied parameter values or default values are filled into a copy of the template.
Type: string
Permissible values are: DefaultLightningCmp
Default value: DefaultLightningCmp
-d | --outputdir OUTPUTDIR
Optional
The directory to store the newly created files. The location can be an absolute path or relative to the current working directory. The
default is the current directory.
Type: string
-a | --apiversion APIVERSION
Optional
The API version of the created source.
Type: string
Permissible values are: 45.0, 44.0
Default value: 45.0
--type TYPE
Optional

48
Salesforce CLI Command Reference lightning Commands

The type of the new Lightning component.

Type: string
Permissible values are: aura, lwc
Default value: aura

Help for lightning:component:create

lightning:event:create
Creates a Lightning event bundle in the specified directory or the current working directory. The bundle consists of multiple files in a
folder with the designated name.

Command Syntax
sfdx force:lightning:event:create
[--json]
[--loglevel LOGLEVEL]
-n EVENTNAME
[-t TEMPLATE]
[-d OUTPUTDIR]
[-a APIVERSION]

49
Salesforce CLI Command Reference lightning Commands

Type: string
Permissible values are: DefaultLightningEvt
Default value: DefaultLightningEvt
-d | --outputdir OUTPUTDIR
Optional
The directory to store the newly created files. The location can be an absolute path or relative to the current working directory. The
default is the current directory.
Type: string
-a | --apiversion APIVERSION
Optional
The API version of the created source.
Type: string
Permissible values are: 45.0, 44.0
Default value: 45.0

Help for lightning:event:create

lightning:interface:create
Creates a Lightning interface bundle in the specified directory or the current working directory. The bundle consists of multiple files in
a folder with the designated name.

Command Syntax
sfdx force:lightning:interface:create
[--json]
[--loglevel LOGLEVEL]
-n INTERFACENAME
[-t TEMPLATE]
[-d OUTPUTDIR]
[-a APIVERSION]

Parameters
--json
Optional
Formats output as JSON.
Type: boolean
--loglevel LOGLEVEL
Optional
The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.
Type: string

50
Salesforce CLI Command Reference lightning Commands

Permissible values are: trace, debug, info, warn, error, fatal

Default value: warn
-n | --interfacename INTERFACENAME
Required
The Lightning interface name. The name can be up to 40 characters and must start with a letter.
Type: string
-t | --template TEMPLATE
Optional
The template to use to create the file. Supplied parameter values or default values are filled into a copy of the template.
Type: string
Permissible values are: DefaultLightningIntf
Default value: DefaultLightningIntf
-d | --outputdir OUTPUTDIR
Optional
The directory to store the newly created files. The location can be an absolute path or relative to the current working directory. The
default is the current directory.
Type: string
-a | --apiversion APIVERSION
Optional
The API version of the created source.
Type: string
Permissible values are: 45.0, 44.0
Default value: 45.0

Help for lightning:interface:create

lightning:lint
Runs a static analysis, or “lint,” tool on your Aura component code. The default rules include recommended best practices and Locker
Service requirements. For details, including how to customize the rules for your org, see the Lightning Aura Components Developer
Guide.

Command Syntax
sfdx force:lightning:lint
[--json]
[--loglevel LOGLEVEL]
[-i IGNORE]
[--files FILES]
[--config CONFIG]
[--verbose]

51
Salesforce CLI Command Reference lightning Commands

[--exit]

52
Salesforce CLI Command Reference lightning Commands

Help for lightning:lint

lightning:test:create
Creates a Lightning test in the specified directory or the current working directory. The .resource file and associated metadata file are
created.

Command Syntax
sfdx force:lightning:test:create
[--json]
[--loglevel LOGLEVEL]
-n TESTNAME
[-t TEMPLATE]
[-d OUTPUTDIR]

Parameters
--json
Optional
Formats output as JSON.
Type: boolean
--loglevel LOGLEVEL
Optional
The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.
Type: string
Permissible values are: trace, debug, info, warn, error, fatal
Default value: warn
-n | --testname TESTNAME
Required
The name of the new Lightning test. The name can be up to 40 characters and must start with a letter.
Type: string
-t | --template TEMPLATE
Optional
The template to use to create the file. Supplied parameter values or default values are filled into a copy of the template.
Type: string
Permissible values are: DefaultLightningTest
Default value: DefaultLightningTest
-d | --outputdir OUTPUTDIR
Optional
The directory to store the newly created files. The location can be an absolute path or relative to the current working directory. The
default is the current directory.

53
Salesforce CLI Command Reference lightning Commands

Type: string

Help for lightning:test:create

lightning:test:install
Installs a Lightning Testing Service (LTS) unmanaged package into your org.

Command Syntax
sfdx force:lightning:test:install
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
[-w WAIT]
[-r RELEASEVERSION]
[-t PACKAGETYPE]

54
Salesforce CLI Command Reference lightning Commands

Maximum number of minutes to wait for installation status.

Type: minutes
Default value: 2
-r | --releaseversion RELEASEVERSION
Optional
The release version of LTS unmanaged package you want to install.
Type: string
Default value: latest
-t | --packagetype PACKAGETYPE
Optional
Type of LTS unmanaged package to install. 'jasmine' and 'mocha' contains the essentials for development, 'full' contains both, and
adds sample components and tests in the package. 'full' is best for 'kicking the tires' of LTS.
Type: string
Permissible values are: jasmine, mocha, full
Default value: full

Help for lightning:test:install

Examples:
$ sfdx force:lightning:test:install

$ sfdx force:lightning:test:install -w 0 -r v1.0

$ sfdx force:lightning:test:install -t jasmine

lightning:test:run
Runs Aura component tests. The Lightning Testing Service (LTS) unmanaged package must be installed in your org. For details, see the
LTS documentation.

Command Syntax
sfdx force:lightning:test:run
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
[-a APPNAME]
[-d OUTPUTDIR]
[-f CONFIGFILE]
[-o]
[-t TIMEOUT]

55
Salesforce CLI Command Reference lightning Commands

[-r RESULTFORMAT]

56
Salesforce CLI Command Reference limits Commands

-t | --timeout TIMEOUT
Optional
Time, in milliseconds, to wait for the results element to be present in the DOM, before failing and moving on to the next test.
Type: number
Default value: 60000
-r | --resultformat RESULTFORMAT
Optional
Format to use when displaying results. If you also specify the --json flag, --json overrides this parameter.
Type: string
Permissible values are: human, tap, junit, json
Default value: human

Help for lightning:test:run

Examples:
$ sfdx force:lightning:test:run

$ sfdx force:lightning:test:run -a tests -r human

$ sfdx force:lightning:test:run -f config/myConfigFile.json -d testResultFolder

limits Commands
Use the limits commands to view your org’s limits and how close you are to reaching them.

limits:api:display
Displays remaining and maximum calls and events for your org.

Command Syntax
sfdx force:limits:api:display
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]

Parameters
--json
Optional

57
Salesforce CLI Command Reference mdapi Commands

Format output as JSON.

Help for limits:api:display

When you execute this command in a project, it provides limit information for your default scratch org.
Examples:
$ sfdx force:limits:api:display

$ sfdx force:limits:api:display -u [email protected]

mdapi Commands
Use the mdapi commands to retrieve and deploy Metadata API–formatted files that represent components in an org, or to convert
Metadata API–formatted metadata into the source format used in Salesforce DX projects.

mdapi:convert
Converts metadata retrieved via Metadata API into the source format used in Salesforce DX projects.
mdapi:deploy
Deploys file representations of components into an org by creating or updating the components they represent. You can deploy
and retrieve up to 10,000 files or 400 MB (39 MB compressed) at one time. The default target username is the admin user for the
default scratch org.
mdapi:deploy:cancel
Cancels an asynchronous metadata deployment.
mdapi:deploy:report
Checks the current status of an asynchronous metadata deployment.

58
Salesforce CLI Command Reference mdapi Commands

mdapi:describemetadata
Displays details about metadata types enabled for your org. Use this information to identify the syntax needed for a <name> element
in package.xml. The most recent API version is the default, or you can specify an older version.
mdapi:listmetadata
Displays properties of metadata components of a specified type. This call is useful when you want to identify individual components
in your manifest file or if you want a high-level view of particular components in your organization. For example, you could use this
target to return a list of names of all Layout components in your org, then use this information in a retrieve operation that returns a
subset of these components.
mdapi:retrieve
Uses Metadata API to retrieve a .zip of XML files that represent metadata from the targeted org. The default target username is the
admin user for the default scratch org. You can retrieve and deploy up to 10,000 files or 400 MB (39 MB compressed) at one time.
mdapi:retrieve:report
Check the status of an asynchronous metadata retrieval.

mdapi:convert
Converts metadata retrieved via Metadata API into the source format used in Salesforce DX projects.

Command Syntax
sfdx force:mdapi:convert
[--json]
[--loglevel LOGLEVEL]
-r ROOTDIR
[-d OUTPUTDIR]

59
Salesforce CLI Command Reference mdapi Commands

-d | --outputdir OUTPUTDIR
Optional
The directory to store your files in after they’re converted to the source format. Can be an absolute or relative path.
Type: directory

Help for mdapi:convert

To use Salesforce CLI to work with components that you retrieved via Metadata API, first convert your files from the metadata format to
the source format using "sfdx force:mdapi:convert".
To convert files from the source format back to the metadata format, so that you can deploy them using "sfdx force:mdapi:deploy", run
"sfdx force:source:convert".
Examples:
$ sfdx force:mdapi:convert -r path/to/metadata

$ sfdx force:mdapi:convert -r path/to/metadata -d path/to/outputdir

mdapi:deploy
Deploys file representations of components into an org by creating or updating the components they represent. You can deploy and
retrieve up to 10,000 files or 400 MB (39 MB compressed) at one time. The default target username is the admin user for the default
scratch org.

Command Syntax
sfdx force:mdapi:deploy
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
[-c]
[-d DEPLOYDIR]
[-w WAIT]
[-i JOBID]
[-l TESTLEVEL]
[-r RUNTESTS]
[-e ROLLBACKONERROR]
[-o]
[-g]
[-q VALIDATEDDEPLOYREQUESTID]
[--verbose]
[-f ZIPFILE]

60
Salesforce CLI Command Reference mdapi Commands

Parameters
--json
Optional
Format output as JSON.
Type: boolean
--loglevel LOGLEVEL
Optional
The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.
Type: string
Permissible values are: trace, debug, info, warn, error, fatal
Default value: warn
-u | --targetusername TARGETUSERNAME
Optional
A username or alias for the target org. Overrides the default target org.
Type: string
--apiversion APIVERSION
Optional
Override the API version used for API requests made by this command.
Type: string
-c | --checkonly
Optional
Validates the deployed metadata and runs all Apex tests, but prevents the deployment from being saved to the org.
If you change a field type from Master-Detail to Lookup or vice versa, that change isn’t supported when using the --checkonly
parameter to test a deployment (validation). This kind of change isn’t supported for test deployments to avoid the risk of data loss
or corruption. If a change that isn’t supported for test deployments is included in a deployment package, the test deployment fails
and issues an error.
If your deployment package changes a field type from Master-Detail to Lookup or vice versa, you can still validate the changes prior
to deploying to Production by performing a full deployment to another test Sandbox. A full deployment includes a validation of the
changes as part of the deployment process.
Note: A Metadata API deployment that includes Master-Detail relationships deletes all detail records in the Recycle Bin in the following
cases.
1. For a deployment with a new Master-Detail field, soft delete (send to the Recycle Bin) all detail records before proceeding to deploy
the Master-Detail field, or the deployment fails. During the deployment, detail records are permanently deleted from the Recycle
Bin and cannot be recovered.
2. For a deployment that converts a Lookup field relationship to a Master-Detail relationship, detail records must reference a master
record or be soft-deleted (sent to the Recycle Bin) for the deployment to succeed. However, a successful deployment permanently
deletes any detail records in the Recycle Bin.
Type: boolean
-d | --deploydir DEPLOYDIR
Optional

61
Salesforce CLI Command Reference mdapi Commands

The root of the directory tree that contains the files to deploy. The root must contain a valid package.xml file describing the entities
in the directory structure. Required to initiate a deployment if you don’t use --zipfile. If you specify both --zipfile and --deploydir, a
zip file of the contents of the --deploydir directory is written to the location specified by --zipfile.
Type: directory
-w | --wait WAIT
Optional
The number of minutes to wait for the command to complete. The default is –1 (no limit). 0
Type: minutes
-i | --jobid JOBID
The parameter --jobid has been deprecated and will be removed in v42.0 or later. Use instead.
Optional
The job ID (asyncId) of the deployment you want to check. If not specified, the default value is the ID of the most recent metadata
deployment you ran using Salesforce CLI. Use with -w to resume waiting.
Type: id
-l | --testlevel TESTLEVEL
Optional
Specifies which level of deployment tests to run. Valid values are:
NoTestRun—No tests are run. This test level applies only to deployments to development environments, such as sandbox, Developer
Edition, or trial orgs. This test level is the default for development environments.
RunSpecifiedTests—Runs only the tests that you specify in the --runtests option. Code coverage requirements differ from the default
coverage requirements when using this test level. Executed tests must comprise a minimum of 75% code coverage for each class
and trigger in the deployment package. This coverage is computed for each class and trigger individually and is different than the
overall coverage percentage.
RunLocalTests—All tests in your org are run, except the ones that originate from installed managed packages. This test level is the
default for production deployments that include Apex classes or triggers.
RunAllTestsInOrg—All tests in your org are run, including tests of managed packages.
If you don’t specify a test level, the default behavior depends on the contents of your deployment package. For more information,
see “Running Tests in a Deployment” in the Metadata API Developer Guide.
Type: string
Permissible values are: NoTestRun, RunSpecifiedTests, RunLocalTests, RunAllTestsInOrg
-r | --runtests RUNTESTS
Optional
Lists the Apex classes containing the deployment tests to run. Use this parameter when you set --testlevel to RunSpecifiedTests.
Type: array
-e | --rollbackonerror ROLLBACKONERROR
The parameter --rollbackonerror has been deprecated and will be removed in v42.0 or later. Use instead.
Optional
Indicates whether any failure causes a complete rollback of the deploy operation. The default is true. If set to false, the operation
performs actions that don’t have errors and returns errors for the remaining actions. You must set this parameter to true if you are
deploying to a production org.
Type: string

62
Salesforce CLI Command Reference mdapi Commands

Permissible values are: true, false

-o | --ignoreerrors
Optional
Ignores the deploy errors, and continues with the deploy operation. The default is false. Keep this parameter set to false when
deploying to a production org. If set to true, components without errors are deployed, and components with errors are skipped.
Type: boolean
-g | --ignorewarnings
Optional
If a warning occurs and ignoreWarnings is set to true, the success field in DeployMessage is true. When ignoreWarnings is set to
false, success is set to false, and the warning is treated like an error.
This field is available in API version 18.0 and later. Prior to version 18.0, there was no distinction between warnings and errors. All
problems were treated as errors and prevented a successful deployment.
Type: boolean
-q | --validateddeployrequestid VALIDATEDDEPLOYREQUESTID
Optional
Specifies the ID of a package with recently validated components to run a Quick Deploy. Deploying a validation helps you shorten
your deployment time because tests aren’t rerun. If you have a recent successful validation, you can deploy the validated components
without running tests. A validation doesn’t save any components in the org. You use a validation only to check the success or failure
messages that you would receive with an actual deployment. To validate your components, add the -c | --checkonly flag when you
run "sfdx force:mdapi:deploy". This flag sets the checkOnly="true" parameter for your deployment. Before deploying a recent
validation, ensure that the following requirements are met:
1. The components have been validated successfully for the target environment within the last 10 days.
2. As part of the validation, Apex tests in the target org have passed.
3. Code coverage requirements are met.
- If all tests in the org or all local tests are run, overall code coverage is at least 75%, and Apex triggers have some coverage.
- If specific tests are run with the RunSpecifiedTests test level, each class and trigger that was deployed is covered by at least 75%
individually.
Type: id
--verbose
Optional
Indicates that you want verbose output from the deploy operation.
Type: boolean
-f | --zipfile ZIPFILE
Optional
The path to the .zip file of metadata files to deploy. You must indicate this option or --deploydir.If you specify both --zipfile and
--deploydir, a .zip file of the contents of the deploy directory is created at the path specified for the .zip file.
Type: filepath

63
Salesforce CLI Command Reference mdapi Commands

Help for mdapi:deploy

Specify the location of the files to deploy as a .zip file or by the root of the directory tree containing the files. To check the status of a
deployment, specify its job ID. To run quick deploy of a recently validated package, use --validateddeployrequestid with the validated
ID.
The default value of --rollbackonerror is true, but the corresponding parameter in the Metadata API deploy() call defaults to false.
To wait for the command to finish running no matter how long the deployment takes, set --wait to -1: "sfdx force mdapi:deploy -w -1
...".

mdapi:deploy:cancel
Cancels an asynchronous metadata deployment.

Command Syntax
sfdx force:mdapi:deploy:cancel
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
[-w WAIT]
[-i JOBID]

64
Salesforce CLI Command Reference mdapi Commands

-w | --wait WAIT
Optional
Number of minutes to wait for the command to complete and display results to the terminal window. If the command continues
to run after the wait period, the CLI returns control of the terminal window to you. The default is 33 minutes.
Type: minutes
Default value: 33
-i | --jobid JOBID
Optional
The job ID (requestId) of the deployment you want to cancel. If not specified, the default value is the ID of the most recent metadata
deployment you ran using Salesforce CLI.
Type: id

Help for mdapi:deploy:cancel

Use this command to cancel a specified asynchronous metadata deployment. You can also specify a wait time (in minutes) to check for
updates to the canceled deploy status.
Examples:
Deploy a directory of files to the org
$ sfdx force:mdapi:deploy -d <directory>

Now cancel this deployment and wait two minutes

$ sfdx force:mdapi:deploy:cancel -w 2

If you have multiple deployments in progress and want to cancel a specific one, specify the job ID
$ sfdx force:mdapi:deploy:cancel -i <jobid>

Check the status of the cancel job

$ sfdx force:mdapi:deploy:report

mdapi:deploy:report
Checks the current status of an asynchronous metadata deployment.

Command Syntax
sfdx force:mdapi:deploy:report
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
[-w WAIT]
[-i JOBID]
[--verbose]

65
Salesforce CLI Command Reference mdapi Commands

Help for mdapi:deploy:report

Specify the job ID for the deploy you want to check. You can also specify a wait time (minutes) to check for updates to the deploy status.

66
Salesforce CLI Command Reference mdapi Commands

Command Syntax
sfdx force:mdapi:describemetadata
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[-a APIVERSION]
[-f RESULTFILE]

Help for mdapi:describemetadata

The default target username is the admin user for the default scratch org. The username must have the Modify All Data permission or
the Modify Metadata permission (Beta). For more information about permissions, see Salesforce Help.

67
Salesforce CLI Command Reference mdapi Commands

Examples:
$ sfdx force:mdapi:describemetadata -a 43.0

$ sfdx force:mdapi:describemetadata -u [email protected]

$ sfdx force:mdapi:describemetadata -f /path/to/outputfilename.txt

$ sfdx force:mdapi:describemetadata -u [email protected] -f /path/to/outputfilename.txt

mdapi:listmetadata
Displays properties of metadata components of a specified type. This call is useful when you want to identify individual components in
your manifest file or if you want a high-level view of particular components in your organization. For example, you could use this target
to return a list of names of all Layout components in your org, then use this information in a retrieve operation that returns a subset of
these components.

Command Syntax
sfdx force:mdapi:listmetadata
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[-a APIVERSION]
[-f RESULTFILE]
-m METADATATYPE
[--folder FOLDER]

68
Salesforce CLI Command Reference mdapi Commands

-a | --apiversion APIVERSION
Optional
The API version to use. The default is the latest API version (45.0).
Type: string
-f | --resultfile RESULTFILE
Optional
The path to the file where the results of the command are stored. The default output destination is the console.
Type: filepath
-m | --metadatatype METADATATYPE
Required
The metadata type to be retrieved, such as CustomObject or Report. The metadata type value is case-sensitive.
Type: string
--folder FOLDER
Optional
The folder associated with the component. This parameter is required for components that use folders, such as Dashboard, Document,
EmailTemplate, or Report. The folder name value is case-sensitive.
Type: string

Help for mdapi:listmetadata

The default target username is the admin user for the default scratch org.
Examples:
$ sfdx force:mdapi:listmetadata -m CustomObject

$ sfdx force:mdapi:listmetadata -m CustomObject -a 43.0

$ sfdx force:mdapi:listmetadata -m CustomObject -u [email protected]

$ sfdx force:mdapi:listmetadata -m CustomObject -f /path/to/outputfilename.txt

$ sfdx force:mdapi:listmetadata -m Dashboard --folder foldername

$ sfdx force:mdapi:listmetadata -m Dashboard --folder foldername -a 43.0

$ sfdx force:mdapi:listmetadata -m Dashboard --folder foldername -u [email protected]

$ sfdx force:mdapi:listmetadata -m Dashboard --folder foldername -f

/path/to/outputfilename.txt

$ sfdx force:mdapi:listmetadata -m CustomObject -u [email protected] -f

/path/to/outputfilename.txt

mdapi:retrieve
Uses Metadata API to retrieve a .zip of XML files that represent metadata from the targeted org. The default target username is the admin
user for the default scratch org. You can retrieve and deploy up to 10,000 files or 400 MB (39 MB compressed) at one time.

69
Salesforce CLI Command Reference mdapi Commands

Command Syntax
sfdx force:mdapi:retrieve
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[-a APIVERSION]
[-w WAIT]
-r RETRIEVETARGETDIR
[-k UNPACKAGED]
[--verbose]
[-d SOURCEDIR]
[-p PACKAGENAMES]
[-s]
[-i JOBID]

70
Salesforce CLI Command Reference mdapi Commands

-r | --retrievetargetdir RETRIEVETARGETDIR
Required
The root of the directory structure where the retrieved .zip or metadata files are put.
Type: directory
-k | --unpackaged UNPACKAGED
Optional
The complete path for the manifest file that specifies the components to retrieve.
Type: filepath
--verbose
Optional
Indicates that you want verbose output from the retrieve operation.
Type: boolean
-d | --sourcedir SOURCEDIR
Optional
The source directory to use instead of the default manifest specified in sfdx-config.json.
Type: directory
-p | --packagenames PACKAGENAMES
Optional
A comma-separated list of package names to retrieve.
Type: array
-s | --singlepackage
Optional
Specifies whether only a single package is being retrieved (true) or more than one package (false).
Type: boolean
-i | --jobid JOBID
The parameter --jobid has been deprecated and will be removed in v42.0 or later. Use instead.
Optional
The job ID (asyncId) of the retrieve you want to check. If not specified, the default value is the ID of the most recent metadata retrieval
you ran using Salesforce CLI. You must specify a --retrievetargetdir. Use with --wait to resume waiting.
Type: id

Help for mdapi:retrieve

The default target username is the admin user for the default scratch org. You can retrieve and deploy up to 10,000 files or 400 MB (39
MB compressed) at one time.

mdapi:retrieve:report
Check the status of an asynchronous metadata retrieval.

71
Salesforce CLI Command Reference mdapi Commands

Command Syntax
sfdx force:mdapi:retrieve:report
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
[-w WAIT]
[-r RETRIEVETARGETDIR]
[--verbose]
[-i JOBID]

72
Salesforce CLI Command Reference org Commands

--verbose
Optional
Indicates that you want verbose output from the retrieve operation.
Type: boolean
-i | --jobid JOBID
Optional
The job ID (asyncId) of the retrieve you want to check. If not specified, the default value is the ID of the most recent metadata retrieval
you ran using Salesforce CLI. You must specify a --retrievetargetdir. Use with --wait to resume waiting.
Type: id

Help for mdapi:retrieve:report

Specify the job ID and a target directory for the retrieve you want to check. You can also specify a wait time (minutes) to check for updates
to the deploy status. If the retrieve was successful, the resulting zip file will be saved to the location passed in with the retrieve target
parameter.

org Commands
Use the org commands to manage the orgs you use with Salesforce CLI. Create and delete scratch orgs, list your created and authorized
orgs, and open orgs in your browser.

org:create
Creates a scratch org using values specified in a configuration file or key=value pairs that you specify on the command line. Values
specified on the command line override values in the configuration file.
org:delete
Marks a scratch org for deletion.
org:display
Gets the description for the current or target org.
org:list
Lists all orgs that the Salesforce CLI has created or authenticated to.
org:open
Opens an org in your browser.
org:shape:create (Pilot)
Creates a snapshot of org edition, features, and licenses to use for scratch org creation, allowing your scratch org to look like another
org for testing.
org:shape:delete (Pilot)
Deletes all org shapes that you’ve created for an org using the Salesforce CLI.
org:shape:list (Pilot)
Lists all org shapes that you’ve created using the Salesforce CLI.
org:snapshot:create (Pilot)
Creates a snapshot of a scratch org.

73
Salesforce CLI Command Reference org Commands

org:snapshot:delete (Pilot)
Deletes a scratch org snapshot.
org:snapshot:get (Pilot)
Retrieves details about a scratch org snapshot.
org:snapshot:list (Pilot)
Lists scratch org snapshots for your Dev Hub.

Command Syntax
sfdx force:org:create
[--json]
[--loglevel LOGLEVEL]
[-v TARGETDEVHUBUSERNAME]
[--apiversion APIVERSION]
[-f DEFINITIONFILE]
[-n]
[-c]
[-i CLIENTID]
[-s]
[-a SETALIAS]
[-w WAIT]
[-d DURATIONDAYS]

74
Salesforce CLI Command Reference org Commands

-v | --targetdevhubusername TARGETDEVHUBUSERNAME
Optional
A username or alias for the target Dev Hub org. Overrides the default Dev Hub org.
Type: string
--apiversion APIVERSION
Optional
Override the API version used for API requests made by this command.
Type: string
-f | --definitionfile DEFINITIONFILE
Optional
Path to a scratch org definition file. Either --definitionfile or a vararg value for edition (for example, edition=Developer) is required.
Varargs override the values in the scratch org definition file.
Type: filepath
-n | --nonamespace
Optional
Creates the scratch org with no namespace. Useful when using a scratch org to test installations of packages with namespaces.
Type: boolean
-c | --noancestors
Optional
Do not include second-generation package ancestors in the scratch org.
Type: boolean
-i | --clientid CLIENTID
Optional
Connected app consumer key, as configured in your Dev Hub.
Type: string
-s | --setdefaultusername
Optional
Sets the created org as the default username.
Type: boolean
-a | --setalias SETALIAS
Optional
Sets an alias for for the created scratch org.
Type: string
-w | --wait WAIT
Optional
Sets the streaming client socket timeout, in minutes. If the streaming client socket has no contact from the server for a number of
minutes, the client exits. Specify a longer wait time if timeouts occur frequently.
Type: minutes
Default value: 6

75
Salesforce CLI Command Reference org Commands

-d | --durationdays DURATIONDAYS
Optional
Sets the duration of the scratch org, in days. Valid values are from 1-30. The default is 7 days.
Type: number

Help for org:create

To set up a connected app for your new scratch org, specify the value that was returned when you created a connected app in your Dev
Hub org as --clientid.
Examples:
$ sfdx force:org:create -f config/enterprise-scratch-def.json -a TestOrg1

$ sfdx force:org:create -a MyDevOrg -s -v [email protected] edition=Developer

$ sfdx force:org:create -f config/enterprise-scratch-def.json -a OrgWithOverrides

[email protected]

org:delete
Marks a scratch org for deletion.

Command Syntax
sfdx force:org:delete
[--json]
[--loglevel LOGLEVEL]
[-v TARGETDEVHUBUSERNAME]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
[-p]

76
Salesforce CLI Command Reference org Commands

-v | --targetdevhubusername TARGETDEVHUBUSERNAME
Optional
A username or alias for the target Dev Hub org. Overrides the default Dev Hub org.
Type: string
-u | --targetusername TARGETUSERNAME
Optional
A username or alias for the target org. Overrides the default target org.
Type: string
--apiversion APIVERSION
Optional
Override the API version used for API requests made by this command.
Type: string
-p | --noprompt
Optional
No prompt to confirm deletion.
Type: boolean

Help for org:delete

To mark the org for deletion without being prompted to confirm, specify --noprompt.
Examples:
$ sfdx force:org:delete -u [email protected]

$ sfdx force:org:delete -u MyOrgAlias -p

org:display
Gets the description for the current or target org.

Command Syntax
sfdx force:org:display
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
[--verbose]

Parameters
--json
Optional

77
Salesforce CLI Command Reference org Commands

Format output as JSON.

Help for org:display

Output includes your access token, client ID, connected status, org ID, instance URL, username, and alias, if applicable.
Use --verbose to include the SFDX auth URL. Including --verbose displays the sfdxAuthUrl property only if you authenticated to the org
using force:auth:web:login (not force:auth:jwt:grant).
Examples:
$ sfdx force:org:display

$ sfdx force:org:display -u [email protected]

$ sfdx force:org:display -u TestOrg1 --json

$ sfdx force:org:display -u TestOrg1 --json > tmp/MyOrgDesc.json

org:list
Lists all orgs that the Salesforce CLI has created or authenticated to.

Command Syntax
sfdx force:org:list
[--json]

78
Salesforce CLI Command Reference org Commands

[--loglevel LOGLEVEL]
[--verbose]
[--all]
[--clean]
[-p]

79
Salesforce CLI Command Reference org Commands

Help for org:list

Examples:
$ sfdx force:org:list

$ sfdx force:org:list --verbose --json

$ sfdx force:org:list --verbose --json > tmp/MyOrgList.json

org:open
Opens an org in your browser.

Command Syntax
sfdx force:org:open
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
[-p PATH]
[-r]

80
Salesforce CLI Command Reference org Commands

-p | --path PATH
Optional
Navigation URL path (not including domain).
Type: string
-r | --urlonly
Optional
Displays a navigation URL, but doesn’t launch your browser.
Type: boolean

Help for org:open

Opens your default scratch org, or another org that you specify.
To open a specific page, specify the portion of the URL after "yourInstance.salesforce.com/" as --path.
For example, specify "--path lightning" to open Lightning Experience, or specify "--path /apex/YourPage" to open a Visualforce page.
To generate a URL but not launch your browser, specify --urlonly.
Examples:
$ sfdx force:org:open

$ sfdx force:org:open -u [email protected]

$ sfdx force:org:open -u MyTestOrg1

$ sfdx force:org:open -r -p lightning

org:shape:create (Pilot)
Creates a snapshot of org edition, features, and licenses to use for scratch org creation, allowing your scratch org to look like another
org for testing.

Note: We provide the org:shape:create command to selected customers through an invitation-only pilot program that
requires agreement to specific terms and conditions. Pilot programs are subject to change, and we can’t guarantee acceptance.
The org:shape:create command isn’t generally available unless or until Salesforce announces its general availability in
documentation or in press releases or public statements. 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. You can provide feedback
and suggestions for the org:shape:create command in the W19 Pilot: Org Shape for Scratch Orgs group in the Trailblazer
Community.

Command Syntax
sfdx force:org:shape:create
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]

81
Salesforce CLI Command Reference org Commands

Help for org:shape:create

Examples:
$ sfdx force:org:shape:create -u [email protected]

$ sfdx force:org:shape:create -u [email protected] --json --loglevel debug

org:shape:delete (Pilot)
Deletes all org shapes that you’ve created for an org using the Salesforce CLI.

Note: We provide the org:shape:delete command to selected customers through an invitation-only pilot program that
requires agreement to specific terms and conditions. Pilot programs are subject to change, and we can’t guarantee acceptance.
The org:shape:delete command isn’t generally available unless or until Salesforce announces its general availability in
documentation or in press releases or public statements. 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. You can provide feedback
and suggestions for the org:shape:delete command in the W19 Pilot: Org Shape for Scratch Orgs group in the Trailblazer
Community.

Command Syntax
sfdx force:org:shape:delete
[--json]
[--loglevel LOGLEVEL]

82
Salesforce CLI Command Reference org Commands

[-u TARGETUSERNAME]
[--apiversion APIVERSION]
[-p]

Help for org:shape:delete

Examples:
$ sfdx force:org:shape:delete -u [email protected]

$ sfdx force:org:shape:delete -u MyOrgAlias -p

$ sfdx force:org:shape:delete -u [email protected] --json

$ sfdx force:org:shape:delete -u [email protected] -p --json > tmp/MyOrgShapeDelete.json

org:shape:list (Pilot)
Lists all org shapes that you’ve created using the Salesforce CLI.

83
Salesforce CLI Command Reference org Commands

Note: We provide the org:shape:list command to selected customers through an invitation-only pilot program that
requires agreement to specific terms and conditions. Pilot programs are subject to change, and we can’t guarantee acceptance.
The org:shape:list command isn’t generally available unless or until Salesforce announces its general availability in
documentation or in press releases or public statements. 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. You can provide feedback
and suggestions for the org:shape:list command in the W19 Pilot: Org Shape for Scratch Orgs group in the Trailblazer
Community.

Command Syntax
sfdx force:org:shape:list
[--json]
[--loglevel LOGLEVEL]
[--verbose]

Help for org:shape:list

Examples:
$ sfdx force:org:shape:list

$ sfdx force:org:shape:list --json

$ sfdx force:org:shape:list --json > tmp/MyOrgShapeList.json

org:snapshot:create (Pilot)
Creates a snapshot of a scratch org.

84
Salesforce CLI Command Reference org Commands

Note: We provide the org:snapshot:create command to selected customers through an invitation-only pilot program
that requires agreement to specific terms and conditions. Pilot programs are subject to change, and we can’t guarantee acceptance.
The org:snapshot:create command isn’t generally available unless or until Salesforce announces its general availability
in documentation or in press releases or public statements. 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. You can provide feedback
and suggestions for the org:snapshot:create command in the W19 Pilot: Scratch Org Snapshots group in the Trailblazer
Community.

Command Syntax
sfdx force:org:snapshot:create
[--json]
[--loglevel LOGLEVEL]
[-v TARGETDEVHUBUSERNAME]
[--apiversion APIVERSION]
-o SOURCEORG
-n SNAPSHOTNAME
[-d DESCRIPTION]

85
Salesforce CLI Command Reference org Commands

Type: string
-n | --snapshotname SNAPSHOTNAME
Required
The unique name of the snapshot. Use this name to create scratch orgs from the snapshot.
Type: string
-d | --description DESCRIPTION
Optional
A description of the snapshot. Use this description to document the contents of the snapshot. We suggest that you include a reference
point, such as a version control system tag or commit ID.
Type: string

Help for org:snapshot:create

A snapshot is a point-in-time export of a scratch org. The export is stored in Salesforce and referenced by its unique name in a scratch
definition file.
Use "sfdx force:org:snapshot:get" to get details, including status, about a snapshot creation request.
With "snapshot" in your scratch org definition file, use "sfdx force:org:create" to create a scratch org from a snapshot.
Examples:
$ sfdx force:org:snapshot:create --sourceorg 00Dxx0000000000 --snapshotname Dependencies
--description "Contains PackageA v1.1.0"

$ sfdx force:org:snapshot:create -o myuser@myorg -n NightlyBranch -d "Contains PkgA

v2.1.0 and PkgB 3.3.0"

org:snapshot:delete (Pilot)
Deletes a scratch org snapshot.

Note: We provide the org:snapshot:delete command to selected customers through an invitation-only pilot program
that requires agreement to specific terms and conditions. Pilot programs are subject to change, and we can’t guarantee acceptance.
The org:snapshot:delete command isn’t generally available unless or until Salesforce announces its general availability
in documentation or in press releases or public statements. 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. You can provide feedback
and suggestions for the org:snapshot:delete command in the W19 Pilot: Scratch Org Snapshots group in the Trailblazer
Community.

Command Syntax
sfdx force:org:snapshot:delete
[--json]
[--loglevel LOGLEVEL]
[-v TARGETDEVHUBUSERNAME]
[--apiversion APIVERSION]
-s SNAPSHOT

86
Salesforce CLI Command Reference org Commands

Help for org:snapshot:delete

Examples:
$ sfdx force:org:snapshot:delete --snapshot 0Oo...

$ sfdx force:org:snapshot:delete -s BaseSnapshot

org:snapshot:get (Pilot)
Retrieves details about a scratch org snapshot.

Note: We provide the org:snapshot:get command to selected customers through an invitation-only pilot program that
requires agreement to specific terms and conditions. Pilot programs are subject to change, and we can’t guarantee acceptance.
The org:snapshot:get command isn’t generally available unless or until Salesforce announces its general availability in
documentation or in press releases or public statements. 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. You can provide feedback
and suggestions for the org:snapshot:get command in the W19 Pilot: Scratch Org Snapshots group in the Trailblazer
Community.

87
Salesforce CLI Command Reference org Commands

Command Syntax
sfdx force:org:snapshot:get
[--json]
[--loglevel LOGLEVEL]
[-v TARGETDEVHUBUSERNAME]
[--apiversion APIVERSION]
-s SNAPSHOT

Help for org:snapshot:get

Use "sfdx force:org:snapshot:create" to create a snapshot.
Use "sfdx force:org:snapshot:list" to retrieve all snapshots.
Examples:
$ sfdx force:org:snapshot:get --snapshot 0Oo...

$ sfdx force:org:snapshot:get -s Dependencies

88
Salesforce CLI Command Reference org Commands

org:snapshot:list (Pilot)
Lists scratch org snapshots for your Dev Hub.

Note: We provide the org:snapshot:list command to selected customers through an invitation-only pilot program
that requires agreement to specific terms and conditions. Pilot programs are subject to change, and we can’t guarantee acceptance.
The org:snapshot:list command isn’t generally available unless or until Salesforce announces its general availability in
documentation or in press releases or public statements. 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. You can provide feedback
and suggestions for the org:snapshot:list command in the W19 Pilot: Scratch Org Snapshots group in the Trailblazer
Community.

Command Syntax
sfdx force:org:snapshot:list
[--json]
[--loglevel LOGLEVEL]
[-v TARGETDEVHUBUSERNAME]
[--apiversion APIVERSION]

Help for org:snapshot:list

Use "sfdx force:org:snapshot:get" to get details about a snapshot request.

89
Salesforce CLI Command Reference package Commands

Use "sfdx force:org:snapshot:create" to create a snapshot.

Examples:
$ sfdx force:org:snapshot:list

$ sfdx force:org:snapshot:list -v [email protected]

package Commands
Use the package commands to develop and install packages.

package:create
Creates a package.
package:install
Installs a package in the target org.
package:install:report
Retrieves the status of a package installation request.
package:installed:list
Lists all packages installed in the target org.
package:list
Lists all packages in the Dev Hub org.
package:uninstall
Uninstalls a second-generation package from the target org. To uninstall a first-generation package, use the Salesforce user interface.
package:uninstall:report
Retrieves the status of a package uninstall request.
package:update
Updates details about a package. Does not create a package version.
package:version:create
Creates a package version in the Dev Hub org.
package:version:create:list
Lists all requests to create second-generation package versions in the Dev Hub org.
package:version:create:report
Retrieves details about a package version creation request in the Dev Hub org.
package:version:list
Lists all package versions in the Dev Hub org.
package:version:promote
Promotes a package version to released status.
package:version:report
Retrieves details about a package version in the Dev Hub org.
package:version:update
Updates a second-generation package version in the Dev Hub org.

90
Salesforce CLI Command Reference package Commands

package:create
Creates a package.

Command Syntax
sfdx force:package:create
[--json]
[--loglevel LOGLEVEL]
[-v TARGETDEVHUBUSERNAME]
[--apiversion APIVERSION]
-n NAME
-t PACKAGETYPE
[-d DESCRIPTION]
[-e]
-r PATH

91
Salesforce CLI Command Reference package Commands

-t | --packagetype PACKAGETYPE
Required
Package type for the package.
The options for package type are Managed and Unlocked (Managed=DeveloperManagedSubscriberManaged,
Unlocked=DeveloperControlledSubscriberEditable). Managed packages are currently in beta.
These options determine upgrade and editability rules.
Type: string
Permissible values are: Managed, Unlocked
-d | --description DESCRIPTION
Optional
Description of the package.
Type: string
-e | --nonamespace
Optional
Creates the package with no namespace. Available only for unlocked packages. Useful when you’re migrating an existing org to
packages. But, use a namespaced package for new metadata.
Type: boolean
-r | --path PATH
Required
The path to the directory that contains the contents of the package.
Type: directory

Help for package:create

First, use this command to create a package. Then create a package version.
If you don’t have a namespace defined in your sfdx-project.json file, use --nonamespace.
Your --name value must be unique within your namespace.
Examples:
$ sfdx force:package:create -n YourPackageName -t Unlocked -r force-app

$ sfdx force:package:create -n YourPackageName -d "Your Package Descripton" -t Unlocked

-r force-app

Run 'sfdx force:package:list' to list all packages in the Dev Hub org.

package:install
Installs a package in the target org.

Command Syntax
sfdx force:package:install
[--json]

92
Salesforce CLI Command Reference package Commands

[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
[-w WAIT]
[-k INSTALLATIONKEY]
[-b PUBLISHWAIT]
[-r]
[-p PACKAGE]
[-s SECURITYTYPE]
[-t UPGRADETYPE]

93
Salesforce CLI Command Reference package Commands

-b | --publishwait PUBLISHWAIT
Optional
Maximum number of minutes to wait for the Subscriber Package Version ID to become available in the target org before canceling
the install request. The default is 0.
Type: minutes
-r | --noprompt
Optional
Allow Remote Site Settings and Content Security Policy websites to send or receive data without confirmation.
Type: boolean
-p | --package PACKAGE
Optional
The ID (starts with 04t) or alias of the package version to install.
Type: string
-s | --securitytype SECURITYTYPE
Optional
Security access type for the installed package.
Type: string
Permissible values are: AllUsers, AdminsOnly
Default value: AllUsers
-t | --upgradetype UPGRADETYPE
Optional
For package upgrades, specifies whether to mark all removed components as deprecated (DeprecateOnly) or to delete removed
components that can be safely deleted and deprecate the others (Mixed).
Type: string
Permissible values are: DeprecateOnly, Mixed
Default value: Mixed

Help for package:install

Supply the ID of the package version to install. The package installs in your default target org unless you supply the username for a
different target org.
For package upgrades, to specify options for component deprecation or deletion of removed components, include an --upgradetype
value. To delete components that can be safely deleted and deprecate the others, specify --upgradetype Mixed (the default). To deprecate
all removed components, specify --upgradetype DeprecateOnly. The default is Mixed.
Examples:
$ sfdx force:package:install --package 04t... -u [email protected]

$ sfdx force:package:install --package awesome_package_alias

$ sfdx force:package:install --package "Awesome Package Alias"

$ sfdx force:package:install --package 04t... -t DeprecateOnly

94
Salesforce CLI Command Reference package Commands

package:install:report
Retrieves the status of a package installation request.

Command Syntax
sfdx force:package:install:report
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
-i REQUESTID

95
Salesforce CLI Command Reference package Commands

Help for package:install:report

Examples:
$ sfdx force:package:install:report -i 0Hf...

$ sfdx force:package:install:report -i 0Hf... -u [email protected]

package:installed:list
Lists all packages installed in the target org.

Command Syntax
sfdx force:package:installed:list
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]

96
Salesforce CLI Command Reference package Commands

Help for package:installed:list

Examples:
$ sfdx force:package:installed:list

$ sfdx force:package:installed:list -u [email protected]

package:list
Lists all packages in the Dev Hub org.

Command Syntax
sfdx force:package:list
[--json]
[--loglevel LOGLEVEL]
[-v TARGETDEVHUBUSERNAME]
[--apiversion APIVERSION]
[--verbose]

97
Salesforce CLI Command Reference package Commands

Type: boolean

Help for package:list

You can view the namespace, IDs, and other details for each package.
Examples:
$ sfdx force:package:list -v [email protected]

$ sfdx force:package:list -v [email protected] --verbose

package:uninstall
Uninstalls a second-generation package from the target org. To uninstall a first-generation package, use the Salesforce user interface.

Command Syntax
sfdx force:package:uninstall
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
[-w WAIT]
[-p PACKAGE]

98
Salesforce CLI Command Reference package Commands

Override the API version used for API requests made by this command.
Type: string
-w | --wait WAIT
Optional
Maximum number of minutes to wait for uninstall status. The default is 0.
Type: minutes
-p | --package PACKAGE
Optional
The ID (starts with 04t) or alias of the package version to uninstall.
Type: string

Help for package:uninstall

Specify the package ID for a second-generation package.
Examples:
$ sfdx force:package:uninstall -p 04t... -u [email protected]

$ sfdx force:package:uninstall -p undesirable_package_alias

$ sfdx force:package:uninstall -p "Undesirable Package Alias"

To list the org’s installed packages, run "sfdx force:package:installed:list".

To uninstall a first-generation package, from Setup, enter Installed Packages in the Quick Find box, then select Installed Packages.

package:uninstall:report
Retrieves the status of a package uninstall request.

Command Syntax
sfdx force:package:uninstall:report
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
-i REQUESTID

Parameters
--json
Optional
Format output as JSON.
Type: boolean

99
Salesforce CLI Command Reference package Commands

Help for package:uninstall:report

Examples:
$ sfdx force:package:uninstall:report -i 06y...

$ sfdx force:package:uninstall:report -i 06y... -u [email protected]

package:update
Updates details about a package. Does not create a package version.

Command Syntax
sfdx force:package:update
[--json]
[--loglevel LOGLEVEL]
[-v TARGETDEVHUBUSERNAME]
[--apiversion APIVERSION]
-p PACKAGE
[-n NAME]
[-d DESCRIPTION]

100
Salesforce CLI Command Reference package Commands

Help for package:update

Specify a new value for each option you want to update.
Examples:
$ sfdx force:package:update -p "Your Package Alias" -n "New Package Name"

$ sfdx force:package:update -p 0Ho... -d "New Package Description"

Run "sfdx force:package:list" to list all packages in the Dev Hub org.

101
Salesforce CLI Command Reference package Commands

package:version:create
Creates a package version in the Dev Hub org.

Command Syntax
sfdx force:package:version:create
[--json]
[--loglevel LOGLEVEL]
[-v TARGETDEVHUBUSERNAME]
[--apiversion APIVERSION]
[-p PACKAGE]
[-d PATH]
[-f DEFINITIONFILE]
[-b BRANCH]
[-t TAG]
[-k INSTALLATIONKEY]
[-x]
[-w WAIT]
[-a VERSIONNAME]
[-n VERSIONNUMBER]
[-e VERSIONDESCRIPTION]

102
Salesforce CLI Command Reference package Commands

Override the API version used for API requests made by this command.
Type: string
-p | --package PACKAGE
Optional
The ID (starts with 0Ho) or alias of the package to create a version of.
Type: string
-d | --path PATH
Optional
The path to the directory that contains the contents of the package.
Type: directory
-f | --definitionfile DEFINITIONFILE
Optional
The path to a definition file similar to scratch org definition file that contains the list of features and org preferences that the metadata
of the package version depends on.
Type: filepath
-b | --branch BRANCH
Optional
The package version’s branch.
Type: string
-t | --tag TAG
Optional
The package version’s tag.
Type: string
-k | --installationkey INSTALLATIONKEY
Optional
Installation key for creating the key-protected package. Either an --installationkey value or the --installationkeybypass flag is required.
Type: string
-x | --installationkeybypass
Optional
Bypasses the installation key requirement. If you bypass this requirement, anyone can install your package. Either an --installationkey
value or the --installationkeybypass flag is required.
Type: boolean
-w | --wait WAIT
Optional
The number of minutes to wait for the package version to be created.
Type: minutes
-a | --versionname VERSIONNAME
Optional
The name of the package version to be created. Overrides the sfdx-project.json value.
Type: string

103
Salesforce CLI Command Reference package Commands

-n | --versionnumber VERSIONNUMBER
Optional
The version number of the package version to be created. Overrides the sfdx-project.json value.
Type: string
-e | --versiondescription VERSIONDESCRIPTION
Optional
The description of the package version to be created. Overrides the sfdx-project.json value.
Type: string

Help for package:version:create

The package version is based on the package contents in the specified directory.
To retrieve details about a package version create request, including status and package version ID (04t), run "sfdx
force:package:version:create:report -i 08c...".
We recommend specifying the --installationkey to protect the contents of your package and to prevent unauthorized installation of your
package.
To list package version creation requests in the org, run "sfdx force:package:version:create:list".
Examples:
$ sfdx force:package:version:create -d common -k password123

$ sfdx force:package:version:create -p "Your Package Alias" -k password123

$ sfdx force:package:version:create -p 0Ho... -k password123

package:version:create:list
Lists all requests to create second-generation package versions in the Dev Hub org.

Command Syntax
sfdx force:package:version:create:list
[--json]
[--loglevel LOGLEVEL]
[-v TARGETDEVHUBUSERNAME]
[--apiversion APIVERSION]
[-c CREATEDLASTDAYS]
[-s STATUS]

Parameters
--json
Optional
Format output as JSON.

104
Salesforce CLI Command Reference package Commands

Type: boolean
--loglevel LOGLEVEL
Optional
The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.
Type: string
Permissible values are: trace, debug, info, warn, error, fatal
Default value: warn
-v | --targetdevhubusername TARGETDEVHUBUSERNAME
Optional
A username or alias for the target Dev Hub org. Overrides the default Dev Hub org.
Type: string
--apiversion APIVERSION
Optional
Override the API version used for API requests made by this command.
Type: string
-c | --createdlastdays CREATEDLASTDAYS
Optional
Filters the list based on the specified maximum number of days since the request was created (starting at 00:00:00 of first day to
now; 0 for today).
Type: number
-s | --status STATUS
Optional
Filters the list based on the status of version creation requests.
Type: string
Permissible values are: Queued, InProgress, Success, Error

Help for package:version:create:list

Shows the details of each request to create a package version in the Dev Hub org.
All filter parameters are applied using the AND logical operator (not OR).
To get information about a specific request, run "sfdx force:package:version:create:report" and supply the request ID.
Examples:
$ sfdx force:package:version:create:list

$ sfdx force:package:version:create:list --createdlastdays 3

$ sfdx force:package:version:create:list --status Error

$ sfdx force:package:version:create:list -s InProgress

$ sfdx force:package:version:create:list -c 3 -s Success

105
Salesforce CLI Command Reference package Commands

package:version:create:report
Retrieves details about a package version creation request in the Dev Hub org.

Command Syntax
sfdx force:package:version:create:report
[--json]
[--loglevel LOGLEVEL]
[-v TARGETDEVHUBUSERNAME]
[--apiversion APIVERSION]
-i PACKAGECREATEREQUESTID

Help for package:version:create:report

Specify the request ID for which you want to view details. If applicable, the command displays errors related to the request.

106
Salesforce CLI Command Reference package Commands

Examples:
$ sfdx force:package:version:create:report -i 08c...

$ sfdx force:package:version:create:report -i 08c... -v [email protected]

To show all requests in the org, run "sfdx force:package:version:create:list".

package:version:list
Lists all package versions in the Dev Hub org.

Command Syntax
sfdx force:package:version:list
[--json]
[--loglevel LOGLEVEL]
[-v TARGETDEVHUBUSERNAME]
[--apiversion APIVERSION]
[-c CREATEDLASTDAYS]
[--concise]
[-m MODIFIEDLASTDAYS]
[-p PACKAGES]
[-r]
[-o ORDERBY]
[--verbose]

107
Salesforce CLI Command Reference package Commands

--apiversion APIVERSION
Optional
Override the API version used for API requests made by this command.
Type: string
-c | --createdlastdays CREATEDLASTDAYS
Optional
Filters the list based on the specified maximum number of days since the request was created (starting at 00:00:00 of first day to
now; 0 for today).
Type: number
--concise
Optional
Displays limited package version details.
Type: boolean
-m | --modifiedlastdays MODIFIEDLASTDAYS
Optional
Lists the items modified in the specified last number of days, starting at 00:00:00 of first day to now. Use 0 for today.
Type: number
-p | --packages PACKAGES
Optional
Filters results on the specified comma-delimited packages (aliases or 0Ho IDs).
Type: array
-r | --released
Optional
Displays released versions only (IsReleased=true).
Type: boolean
-o | --orderby ORDERBY
Optional
Orders the list by the specified package version fields.
Type: array
--verbose
Optional
Displays extended package version details.
Type: boolean

Help for package:version:list

Displays details of each package version in the org.
Use --concise or --verbose to display limited or additional details, respectively.
All filter parameters are applied using the AND logical operator (not OR).

108
Salesforce CLI Command Reference package Commands

Examples:
$ sfdx force:package:version:list --verbose --createdlastdays 3 --released --orderby
PatchVersion

$ sfdx force:package:version:list --packages 0Ho000000000000,0Ho000000000001 --released

--modifiedlastdays 0

$ sfdx force:package:version:list --released

$ sfdx force:package:version:list --concise --modifiedlastdays 0

$ sfdx force:package:version:list --concise -c 3 -r

$ sfdx force:package:version:list --packages exp-mgr,exp-mgr-util --released

--modifiedlastdays 0

package:version:promote
Promotes a package version to released status.

Command Syntax
sfdx force:package:version:promote
[--json]
[--loglevel LOGLEVEL]
[-v TARGETDEVHUBUSERNAME]
[--apiversion APIVERSION]
-p PACKAGE
[-n]

109
Salesforce CLI Command Reference package Commands

Type: string
--apiversion APIVERSION
Optional
Override the API version used for API requests made by this command.
Type: string
-p | --package PACKAGE
Required
The ID (starts with 04t) or alias of the package version to promote.
Type: string
-n | --noprompt
Optional
Do not prompt to confirm setting the package version as released.
Type: boolean

Help for package:version:promote

Supply the ID or alias of the package version you want to promote. Promotes the package version to released status.
Examples:
$ sfdx force:package:version:promote -p 04t...

$ sfdx force:package:version:promote -p awesome_package_alias

$ sfdx force:package:version:promote -p "Awesome Package Alias"

package:version:report
Retrieves details about a package version in the Dev Hub org.

Command Syntax
sfdx force:package:version:report
[--json]
[--loglevel LOGLEVEL]
[-v TARGETDEVHUBUSERNAME]
[--apiversion APIVERSION]
-p PACKAGE
[--verbose]

Parameters
--json
Optional
Format output as JSON.

110
Salesforce CLI Command Reference package Commands

Type: boolean
--loglevel LOGLEVEL
Optional
The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.
Type: string
Permissible values are: trace, debug, info, warn, error, fatal
Default value: warn
-v | --targetdevhubusername TARGETDEVHUBUSERNAME
Optional
A username or alias for the target Dev Hub org. Overrides the default Dev Hub org.
Type: string
--apiversion APIVERSION
Optional
Override the API version used for API requests made by this command.
Type: string
-p | --package PACKAGE
Required
The ID (starts with 04t) or alias of the package to retrieve details for.
Type: string
--verbose
Optional
Displays extended package version details.
Type: boolean

Help for package:version:report

Examples:
$ sfdx force:package:version:report -p 04t...

$ sfdx force:package:version:report -p "Your Package Alias"

To update package version values, run "sfdx force:package:version:update".

package:version:update
Updates a second-generation package version in the Dev Hub org.

Command Syntax
sfdx force:package:version:update
[--json]
[--loglevel LOGLEVEL]
[-v TARGETDEVHUBUSERNAME]

111
Salesforce CLI Command Reference package Commands

[--apiversion APIVERSION]
-p PACKAGE
[-a VERSIONNAME]
[-e VERSIONDESCRIPTION]
[-b BRANCH]
[-t TAG]
[-k INSTALLATIONKEY]

112
Salesforce CLI Command Reference package1 Commands

-b | --branch BRANCH
Optional
The new package version branch.
Type: string
-t | --tag TAG
Optional
The new package version tag.
Type: string
-k | --installationkey INSTALLATIONKEY
Optional
The new installation key for the key-protected package. The default is null.
Type: string

Help for package:version:update

Specify a new value for each option you want to update.
Examples:
$ sfdx force:package:version:update -p "Your Package Alias" -k password123

$ sfdx force:package:version:update -p 04t... -b master -t 'Release 1.0.7'

$ sfdx force:package:version:update -p 04t... -e "New Package Version Description"

To display details about a package version, run "sfdx force:package:version:report".

package1 Commands
Use the package1 commands to create and view first-generation package versions in your Dev Hub org.

package1:version:create
Creates a first-generation package version in the release org.
package1:version:create:get
Retrieves the status of a package version creation request.
package1:version:display
Displays detailed information about an individual first-generation package version.
package1:version:list
Lists the versions for the specified package or all first-generation packages in the org.

package1:version:create
Creates a first-generation package version in the release org.

113
Salesforce CLI Command Reference package1 Commands

Command Syntax
sfdx force:package1:version:create
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
-i PACKAGEID
-n NAME
[-d DESCRIPTION]
[-v VERSION]
[-m]
[-r RELEASENOTESURL]
[-p POSTINSTALLURL]
[-k INSTALLATIONKEY]
[-w WAIT]

114
Salesforce CLI Command Reference package1 Commands

Type: id
-n | --name NAME
Required
Package version name.
Type: string
-d | --description DESCRIPTION
Optional
Package version description.
Type: string
-v | --version VERSION
Optional
Package version in major.minor format, for example, 3.2.
Type: string
-m | --managedreleased
Optional
Creates a managed package version. To create a beta version, don’t include this parameter.
Type: boolean
-r | --releasenotesurl RELEASENOTESURL
Optional
Release notes URL.
Type: url
-p | --postinstallurl POSTINSTALLURL
Optional
Post install URL.
Type: url
-k | --installationkey INSTALLATIONKEY
Optional
Installation key for creating the key-protected package. The default is null.
Type: string
-w | --wait WAIT
Optional
Minutes to wait for the package version to be created. The default is 2 minutes.
Type: number

Help for package1:version:create

The package version is based on the contents of the specified metadata package. Omit -m if you want to create an unmanaged package
version.

115
Salesforce CLI Command Reference package1 Commands

package1:version:create:get
Retrieves the status of a package version creation request.

Command Syntax
sfdx force:package1:version:create:get
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
-i REQUESTID

116
Salesforce CLI Command Reference package1 Commands

Help for package1:version:create:get

Examples:
$ sfdx force:package:version:create:report -i 08c...

$ sfdx force:package:version:create:report -i 08c... -v [email protected]

package1:version:display
Displays detailed information about an individual first-generation package version.

Command Syntax
sfdx force:package1:version:display
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
-i PACKAGEVERSIONID

117
Salesforce CLI Command Reference package1 Commands

Type: id

Help for package1:version:display

Display detailed information about an individual package version, including metadata package ID, name, the release state, and build
number.

package1:version:list
Lists the versions for the specified package or all first-generation packages in the org.

Command Syntax
sfdx force:package1:version:list
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
[-i PACKAGEID]

118
Salesforce CLI Command Reference project Commands

Metadata package ID (starts with 033) whose package versions you want to list. If not specified, shows all versions for all packages
(managed and unmanaged) in the org.
Type: id

Help for package1:version:list

If a metadata package ID is specified, lists all versions of the specified package. Otherwise, lists all package versions for the org. For each
package version, the list includes the package version ID, metadata package ID, name, version number, and release state.

project Commands
Use the project commands to set up a Salesforce DX project.

project:create
Creates a Salesforce DX project in the specified directory or the current working directory. The command creates the necessary
configuration files and folders.
project:upgrade
Updates project configuration and definition files to the latest format.

project:create
Creates a Salesforce DX project in the specified directory or the current working directory. The command creates the necessary configuration
files and folders.

Command Syntax
sfdx force:project:create
[--json]
[--loglevel LOGLEVEL]
-n PROJECTNAME
[-t TEMPLATE]
[-d OUTPUTDIR]
[-s NAMESPACE]
[-p DEFAULTPACKAGEDIR]
[-x]

Parameters
--json
Optional
Formats output as JSON.
Type: boolean
--loglevel LOGLEVEL
Optional

119
Salesforce CLI Command Reference project Commands

The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.
Type: string
Permissible values are: trace, debug, info, warn, error, fatal
Default value: warn
-n | --projectname PROJECTNAME
Required
The name for the new project. Any valid folder name is accepted.
Type: string
-t | --template TEMPLATE
Optional
The template to use to create the project. Supplied parameter values or default values are filled into a copy of the template.
Type: string
Permissible values are: empty, standard, Defaultsfdx-project.json
Default value: empty
-d | --outputdir OUTPUTDIR
Optional
The directory to store the newly created files. The location can be an absolute path or relative to the current working directory. The
default is the current directory.
Type: string
-s | --namespace NAMESPACE
Optional
The namespace associated with this project and any connected scratch orgs.
Type: string
-p | --defaultpackagedir DEFAULTPACKAGEDIR
Optional
The default package directory name. Metadata items such as classes and Lightning bundles are placed inside this folder.
Type: string
Default value: force-app
-x | --manifest
Optional
Generates a default manifest (package.xml) for fetching Apex, Visualforce, Lightning web components, Aura components, and static
resources.
Type: boolean

Help for project:create

project:upgrade
Updates project configuration and definition files to the latest format.

120
Salesforce CLI Command Reference schema Commands

Command Syntax
sfdx force:project:upgrade
[--json]
[--loglevel LOGLEVEL]
[-f]

Help for project:upgrade

Examples:
$ sfdx force:project:upgrade
$ sfdx force:project:upgrade -f

schema Commands
Use the schema commands to view information about the standard and custom objects in your org.

schema:sobject:describe
Displays the metadata for a standard or custom object.
schema:sobject:list
Lists all objects of a specified sObject category.

schema:sobject:describe
Displays the metadata for a standard or custom object.

121
Salesforce CLI Command Reference schema Commands

Command Syntax
sfdx force:schema:sobject:describe
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
-s SOBJECTTYPE
[-t]

122
Salesforce CLI Command Reference schema Commands

Help for schema:sobject:describe

Examples:
$ sfdx force:schema:sobject:describe -s Account

$ sfdx force:schema:sobject:describe -s MyObject__c

$ sfdx force:schema:sobject:describe -s ApexClass -t

schema:sobject:list
Lists all objects of a specified sObject category.

Command Syntax
sfdx force:schema:sobject:list
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
-c SOBJECTTYPECATEGORY

123
Salesforce CLI Command Reference source Commands

-c | --sobjecttypecategory SOBJECTTYPECATEGORY
Required
The type of objects to list: all, custom, or standard.
Type: string

Help for schema:sobject:list

Lists all objects, custom objects, or standard objects in the org.
Examples:
$ sfdx force:schema:sobject:list -c all

$ sfdx force:schema:sobject:list -c custom

$ sfdx force:schema:sobject:list -c standard

source Commands
Use the source commands to push and pull source to and from your scratch orgs, to deploy and retrieve source to and from
non-source-tracked orgs, to see synchronization changes between your project and scratch orgs, and to convert your source to the
metadata format for Metadata API deployments.

source:convert
Converts source-formatted files into metadata that you can deploy using Metadata API.
source:delete (Beta)
Deletes source files from your project and from a non-source-tracked org, such as a sandbox.
source:deploy (Beta)
Deploys source to a non-source-tracked org, such as a sandbox.
source:open
Opens the specified Lightning Page in Lightning App Builder. Lightning Page files have the suffix .flexipage-meta.xml, and are stored
in the flexipages directory. If you specify a different type of file, this command opens your org’s home page.
source:pull
Pulls changed source from the scratch org to your project to keep them in sync.
source:push
Pushes changed source from your project to a scratch org to keep them in sync.
source:retrieve (Beta)
Retrieves source from a non-source-tracked org, such as a sandbox, to your local Salesforce DX project.
source:status
Lists changes that have been made locally, in a scratch org, or both.

source:convert
Converts source-formatted files into metadata that you can deploy using Metadata API.

124
Salesforce CLI Command Reference source Commands

Command Syntax
sfdx force:source:convert
[--json]
[--loglevel LOGLEVEL]
[-r ROOTDIR]
[-d OUTPUTDIR]
[-n PACKAGENAME]

Help for source:convert

To convert source-formatted files into the metadata format, so that you can deploy them using Metadata API, run "sfdx
force:source:convert". Then deploy the metadata using "sfdx force:mdapi:deploy".
To convert Metadata API–formatted files into the source format, run "sfdx force:mdapi:convert".
To specify a package name that includes spaces, enclose the name in single quotes.

125
Salesforce CLI Command Reference source Commands

Examples:
$ sfdx force:source:convert -r path/to/source

$ sfdx force:source:convert -r path/to/source -d path/to/outputdir -n 'My Package'

source:delete (Beta)
Deletes source files from your project and from a non-source-tracked org, such as a sandbox.

Note: This release contains a beta version of the source:delete command, which means it’s a high-quality feature with
known limitations. The the source:delete command isn’t generally available unless or until Salesforce announces its general
availability in documentation or in press releases or public statements. 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. You can provide
feedback and suggestions for the source:delete command in the Salesforce CLI New Command Feedback group in the
Trailblazer Community.

Command Syntax
sfdx force:source:delete
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
[-r]
[-w WAIT]
[-p SOURCEPATH]
[-m METADATA]

126
Salesforce CLI Command Reference source Commands

Type: string
--apiversion APIVERSION
Optional
Override the API version used for API requests made by this command.
Type: string
-r | --noprompt
Optional
Do not prompt for delete confirmation.
Type: boolean
-w | --wait WAIT
Optional
Number of minutes to wait for the command to complete and display results to the terminal window. If the command continues
to run after the wait period, the CLI returns control of the terminal window to you. The default is 33 minutes.
Type: minutes
Default value: 33
-p | --sourcepath SOURCEPATH
Optional
A comma-separated list of paths to the local metadata to delete. The supplied paths can be a single file (in which case the operation
is applied to only one file) or a folder (in which case the operation is applied to all metadata types in the directory and its
sub-directories).
If you specify this parameter, don’t specify --manifest or --metadata.
Type: array
-m | --metadata METADATA
Optional
A comma-separated list of names of metadata components to delete from your project and your org.
Type: array

Help for source:delete

Use this command to delete components from orgs that don’t have source tracking, such as sandboxes.
To remove deleted items from scratch orgs, which have change tracking, use "sfdx force:source:push".
Examples:
$ sfdx force:source:delete -p path/to/source

$ sfdx force:source:delete -m <metadata>

source:deploy (Beta)
Deploys source to a non-source-tracked org, such as a sandbox.

Note: This release contains a beta version of the source:deploy command, which means it’s a high-quality feature with
known limitations. The the source:deploy command isn’t generally available unless or until Salesforce announces its general

127
Salesforce CLI Command Reference source Commands

availability in documentation or in press releases or public statements. 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. You can provide
feedback and suggestions for the source:deploy command in the Salesforce CLI New Command Feedback group in the
Trailblazer Community.

Command Syntax
sfdx force:source:deploy
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
[-w WAIT]
[-m METADATA]
[-p SOURCEPATH]
[-x MANIFEST]

128
Salesforce CLI Command Reference source Commands

Type: minutes
Default value: 33
-m | --metadata METADATA
Optional
A comma-separated list of names of metadata components to deploy to the org.
Type: array
-p | --sourcepath SOURCEPATH
Optional
A comma-separated list of paths to the local source files to deploy. The supplied paths can be to a single file (in which case the
operation is applied to only one file) or to a folder (in which case the operation is applied to all metadata types in the directory and
its sub-directories).
If you specify this parameter, don’t specify --manifest or --metadata.
Type: array
-x | --manifest MANIFEST
Optional
The complete path for the manifest (package.xml) file that specifies the components to deploy.
If you specify this parameter, don’t specify --metadata or --sourcepath.
Type: filepath

Help for source:deploy

Use this command to deploy source to orgs that don’t have source tracking, such as sandboxes.
To push source to scratch orgs, which have change tracking, use "sfdx force:source:push".
To deploy metadata that’s in the Metadata API format, use "sfdx force:mdapi:deploy".
The source you deploy overwrites the corresponding metadata in your org. This command does not attempt to merge your source with
the versions in your org.
If the comma-separated list you’re supplying contains spaces, enclose the entire comma-separated list in one set of double quotes.
Examples:
To deploy the source files in a directory:
$ sfdx force:source:deploy -p path/to/source

To deploy a specific Apex class and the objects whose source is in a directory:
$ sfdx force:source:deploy -p path/to/apex/classes/MyClass.cls,path/to/source/objects

To deploy source files in a comma-separated list that contains spaces:

$ sfdx force:source:deploy -p
"path/to/objects/MyCustomObject/fields/MyField.field-meta.xml, path/to/apex/classes"

To deploy all Apex classes:

$ sfdx force:source:deploy -m ApexClass

129
Salesforce CLI Command Reference source Commands

To deploy a specific Apex class:

$ sfdx force:source:deploy -m ApexClass:MyApexClass

To deploy all custom objects and Apex classes:

$ sfdx force:source:deploy -m CustomObject,ApexClass

To deploy all Apex classes and two specific profiles (one of which has a space in its name):
$ sfdx force:source:deploy -m "ApexClass, Profile:My Profile, Profile: AnotherProfile"

To deploy all components listed in a manifest:

$ sfdx force:source:deploy -x path/to/package.xml

source:open
Opens the specified Lightning Page in Lightning App Builder. Lightning Page files have the suffix .flexipage-meta.xml, and are stored in
the flexipages directory. If you specify a different type of file, this command opens your org’s home page.

Command Syntax
sfdx force:source:open
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
-f SOURCEFILE
[-r]

130
Salesforce CLI Command Reference source Commands

--apiversion APIVERSION
Optional
Override the API version used for API requests made by this command.
Type: string
-f | --sourcefile SOURCEFILE
Required
File to edit.
Type: filepath
-r | --urlonly
Optional
Generate a navigation URL path, but don’t launch a browser-based editor.
Type: boolean

Help for source:open

The file opens in your default browser.
If no browser-based editor is available for the selected file, this command opens your org’s home page.
To generate a URL for the browser-based editor but not open the editor, use --urlonly.
Examples:
$ sfdx force:source:open -f Property_Record_Page.flexipage-meta.xml

$ sfdx force:source:open -f Property_Record_Page.flexipage-meta.xml -r

source:pull
Pulls changed source from the scratch org to your project to keep them in sync.

Command Syntax
sfdx force:source:pull
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
[-w WAIT]
[-f]

Parameters
--json
Optional
Format output as JSON.

131
Salesforce CLI Command Reference source Commands

Type: boolean
--loglevel LOGLEVEL
Optional
The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.
Type: string
Permissible values are: trace, debug, info, warn, error, fatal
Default value: warn
-u | --targetusername TARGETUSERNAME
Optional
A username or alias for the target org. Overrides the default target org.
Type: string
--apiversion APIVERSION
Optional
Override the API version used for API requests made by this command.
Type: string
-w | --wait WAIT
Optional
The number of minutes to wait for the command to complete and display results to the terminal window. If the command continues
to run after the wait period, the CLI returns control of the terminal window to you. The default is 33 minutes.
Type: minutes
Default value: 33
-f | --forceoverwrite
Optional
Runs the pull command even if conflicts exist. Changes in the scratch org overwrite changes in the project.
Type: boolean

Help for source:pull

If the command detects a conflict, it displays the conflicts but does not complete the process. After reviewing the conflict, rerun the
command with the --forceoverwrite parameter.

source:push
Pushes changed source from your project to a scratch org to keep them in sync.

Command Syntax
sfdx force:source:push
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]

132
Salesforce CLI Command Reference source Commands

[-f]
[-g]
[-w WAIT]

133
Salesforce CLI Command Reference source Commands

Help for source:push

If the command detects a conflict, it displays the conflicts but does not complete the process. After reviewing the conflict, rerun the
command with the --forceoverwrite parameter.

source:retrieve (Beta)
Retrieves source from a non-source-tracked org, such as a sandbox, to your local Salesforce DX project.

Note: This release contains a beta version of the source:retrieve command, which means it’s a high-quality feature with
known limitations. The the source:retrieve command isn’t generally available unless or until Salesforce announces its
general availability in documentation or in press releases or public statements. 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. You
can provide feedback and suggestions for the source:retrieve command in the Salesforce CLI New Command Feedback
group in the Trailblazer Community.

Command Syntax
sfdx force:source:retrieve
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
[-w WAIT]
[-x MANIFEST]
[-m METADATA]
[-p SOURCEPATH]

134
Salesforce CLI Command Reference source Commands

--apiversion APIVERSION
Optional
Override the API version used for API requests made by this command.
Type: string
-w | --wait WAIT
Optional
Number of minutes to wait for the command to complete and display results to the terminal window. If the command continues
to run after the wait period, the CLI returns control of the terminal window to you. The default is 33 minutes.
Type: minutes
Default value: 33
-x | --manifest MANIFEST
Optional
The complete path for the manifest (package.xml) file that specifies the components to retrieve.
If you specify this parameter, don’t specify --metadata or --sourcepath.
Type: filepath
-m | --metadata METADATA
Optional
A comma-separated list of names of metadata components to retrieve from the org.
Type: array
-p | --sourcepath SOURCEPATH
Optional
A comma-separated list of file paths for source to retrieve from the org. The supplied paths can be to a single file (in which case the
operation is applied to only one file) or to a folder (in which case the operation is applied to all source files in the directory and its
sub-directories).
Type: array

Help for source:retrieve

Use this command to retrieve source from orgs that don’t have source tracking, such as sandboxes.
To pull source from scratch orgs, which have change tracking, use "sfdx force:source:pull".
To retrieve metadata that’s in the Metadata API format, use "sfdx force:mdapi:retrieve".
The source you retrieve overwrites the corresponding source files in your local project. This command does not attempt to merge the
source from your org with your local source files.
If the comma-separated list you’re supplying contains spaces, enclose the entire comma-separated list in one set of double quotes.
Examples:
To retrieve the source files in a directory:
$ sfdx force:source:retrieve -p path/to/source

To retrieve a specific Apex class and the objects whose source is in a directory:
$ sfdx force:source:retrieve -p path/to/apex/classes/MyClass.cls,path/to/source/objects

135
Salesforce CLI Command Reference source Commands

To retrieve source files in a comma-separated list that contains spaces:

$ sfdx force:source:retrieve -p
"path/to/objects/MyCustomObject/fields/MyField.field-meta.xml, path/to/apex/classes"

To retrieve all Apex classes:

$ sfdx force:source:retrieve -m ApexClass

To retrieve a specific Apex class:

$ sfdx force:source:retrieve -m ApexClass:MyApexClass

To retrieve all custom objects and Apex classes:

$ sfdx force:source:retrieve -m CustomObject,ApexClass

To retrieve all Apex classes and two specific profiles (one of which has a space in its name):
$ sfdx force:source:retrieve -m "ApexClass, Profile:My Profile, Profile: AnotherProfile"

To retrieve all metadata components listed in a manifest:

$ sfdx force:source:retrieve -x path/to/package.xml

source:status
Lists changes that have been made locally, in a scratch org, or both.

Command Syntax
sfdx force:source:status
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
[-a]
[-l]
[-r]

Parameters
--json
Optional
Format output as JSON.
Type: boolean
--loglevel LOGLEVEL
Optional
The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.
Type: string

136
Salesforce CLI Command Reference user Commands

Permissible values are: trace, debug, info, warn, error, fatal

Default value: warn
-u | --targetusername TARGETUSERNAME
Optional
A username or alias for the target org. Overrides the default target org.
Type: string
--apiversion APIVERSION
Optional
Override the API version used for API requests made by this command.
Type: string
-a | --all
Optional
Lists all the changes that have been made.
Type: boolean
-l | --local
Optional
Lists the changes that have been made locally.
Type: boolean
-r | --remote
Optional
Lists the changes that have been made in the scratch org.
Type: boolean

Help for source:status

Examples:
$ sfdx force:source:status -l

$ sfdx force:source:status -r

$ sfdx force:source:status -a

$ sfdx force:source:status -a -u [email protected] --json

user Commands
Use the user commands to perform user-related admin tasks.

user:create
Creates a user for a scratch org.
user:display
Displays information about a user of a scratch org that the Salesforce CLI has created or authenticated.

137
Salesforce CLI Command Reference user Commands

user:list
Lists all users of a scratch org that the Salesforce CLI has created or authenticated.
user:password:generate
Generates a password for scratch org users. Targets the usernames listed with the --onbehalfof parameter or the --targetusername
parameter. Defaults to the defaultusername.
user:permset:assign
Assigns a named permission set to one or more users of an org.

user:create
Creates a user for a scratch org.

Command Syntax
sfdx force:user:create
[--json]
[--loglevel LOGLEVEL]
[-v TARGETDEVHUBUSERNAME]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
[-f DEFINITIONFILE]
[-a SETALIAS]

138
Salesforce CLI Command Reference user Commands

Type: string
--apiversion APIVERSION
Optional
Override the API version used for API requests made by this command.
Type: string
-f | --definitionfile DEFINITIONFILE
Optional
File path to a user definition.
Type: filepath
-a | --setalias SETALIAS
Optional
Sets an alias for the created username to reference within the CLI.
Type: string

Help for user:create

Create a user for a scratch org, optionally setting an alias for use by the CLI, assigning permission sets (e.g., permsets=ps1,ps2), generating
a password (e.g., generatepassword=true), and setting User sObject fields.
Examples:
$ sfdx force:user:create

$ sfdx force:user:create -a testuser1 -f config/project-user-def.json

$ sfdx force:user:create [email protected] [email protected] permsets=DreamHouse

$ sfdx force:user:create -f config/project-user-def.json [email protected]

generatepassword=true

user:display
Displays information about a user of a scratch org that the Salesforce CLI has created or authenticated.

Command Syntax
sfdx force:user:display
[--json]
[--loglevel LOGLEVEL]
[-v TARGETDEVHUBUSERNAME]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]

139
Salesforce CLI Command Reference user Commands

Help for user:display

Output includes the profile name, org ID, access token, instance URL, login URL, and alias if applicable.
Examples:
$ sfdx force:user:display

$ sfdx force:user:display -u [email protected] --json

user:list
Lists all users of a scratch org that the Salesforce CLI has created or authenticated.

Command Syntax
sfdx force:user:list
[--json]
[--loglevel LOGLEVEL]
[-v TARGETDEVHUBUSERNAME]

140
Salesforce CLI Command Reference user Commands

[-u TARGETUSERNAME]
[--apiversion APIVERSION]

Help for user:list

The original scratch org admin is marked with "(A)"
Examples:
$ sfdx force:user:list

$ sfdx force:user:list -u [email protected] --json

$ sfdx force:user:list --json > tmp/MyUserList.json

user:password:generate
Generates a password for scratch org users. Targets the usernames listed with the --onbehalfof parameter or the --targetusername
parameter. Defaults to the defaultusername.

141
Salesforce CLI Command Reference user Commands

Command Syntax
sfdx force:user:password:generate
[--json]
[--loglevel LOGLEVEL]
[-v TARGETDEVHUBUSERNAME]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
[-o ONBEHALFOF]

142
Salesforce CLI Command Reference user Commands

Help for user:password:generate

Generates and sets a random password for one or more scratch org users.
If you haven’t set a default Dev Hub, or if your scratch org isn’t associated with your default Dev Hub, --targetdevhubusername is required.
To see a password that was previously generated, run "sfdx force:user:display".
Examples:
$ sfdx force:user:password:generate

$ sfdx force:user:password:generate -u [email protected] --json

$ sfdx force:user:password:generate -o [email protected],[email protected],[email protected]

user:permset:assign
Assigns a named permission set to one or more users of an org.

Command Syntax
sfdx force:user:permset:assign
[--json]
[--loglevel LOGLEVEL]
[-u TARGETUSERNAME]
[--apiversion APIVERSION]
-n PERMSETNAME
[-o ONBEHALFOF]

143
Salesforce CLI Command Reference visualforce Commands

--apiversion APIVERSION
Optional
Override the API version used for API requests made by this command.
Type: string
-n | --permsetname PERMSETNAME
Required
The name of the permission set to assign.
Type: string
-o | --onbehalfof ONBEHALFOF
Optional
Comma-separated list of usernames or aliases to assign the permission set to.
Type: array

Help for user:permset:assign

Defaults to the defaultusername.
Examples:
$ sfdx force:user:permset:assign -n DreamHouse

$ sfdx force:user:permset:assign -n DreamHouse -u [email protected]

$ sfdx force:user:permset:assign -n DreamHouse -o [email protected],user2,user3

visualforce Commands
Use the visualforce commands to create Visualforce pages and components.

visualforce:component:create
Creates a Visualforce component in the specified directory or the current working directory. The command creates the .component
file and associated metadata file.
visualforce:page:create
Creates a Visualforce page in the specified directory or the current working directory. The command creates the .page file and
associated metadata file.

visualforce:component:create
Creates a Visualforce component in the specified directory or the current working directory. The command creates the .component file
and associated metadata file.

Command Syntax
sfdx force:visualforce:component:create
[--json]
[--loglevel LOGLEVEL]

144
Salesforce CLI Command Reference visualforce Commands

[-t TEMPLATE]
[-d OUTPUTDIR]
-n COMPONENTNAME
[-a APIVERSION]
-l LABEL

Parameters
--json
Optional
Formats output as JSON.
Type: boolean
--loglevel LOGLEVEL
Optional
The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.
Type: string
Permissible values are: trace, debug, info, warn, error, fatal
Default value: warn
-t | --template TEMPLATE
Optional
The template to use to create the file. Supplied parameter values or default values are filled into a copy of the template.
Type: string
Permissible values are: DefaultVFComponent
Default value: DefaultVFComponent
-d | --outputdir OUTPUTDIR
Optional
The directory to store the newly created files. The location can be an absolute path or relative to the current working directory. The
default is the current directory.
Type: string
-n | --componentname COMPONENTNAME
Required
The Visualforce component name. The name can be up to 40 characters and must start with a letter.
Type: string
-a | --apiversion APIVERSION
Optional
The API version of the created source.
Type: string
Permissible values are: 45.0, 44.0
Default value: 45.0

145
Salesforce CLI Command Reference visualforce Commands

-l | --label LABEL
Required
The label saved in the metadata for the Visualforce component.
Type: string

Help for visualforce:component:create

visualforce:page:create
Creates a Visualforce page in the specified directory or the current working directory. The command creates the .page file and associated
metadata file.

Command Syntax
sfdx force:visualforce:page:create
[--json]
[--loglevel LOGLEVEL]
[-t TEMPLATE]
[-d OUTPUTDIR]
-n PAGENAME
[-a APIVERSION]
-l LABEL

146
Salesforce CLI Command Reference Help for Salesforce CLI Commands

-d | --outputdir OUTPUTDIR
Optional
The directory to store the newly created files. The location can be an absolute path or relative to the current working directory. The
default is the current directory.
Type: string
-n | --pagename PAGENAME
Required
The Visualforce page name. The name can be up to 40 characters and must start with a letter.
Type: string
-a | --apiversion APIVERSION
Optional
The API version of the created source.
Type: string
Permissible values are: 45.0, 44.0
Default value: 45.0
-l | --label LABEL
Required
The label saved in the metadata for the Visualforce page.
Type: string

Help for visualforce:page:create

Help for Salesforce CLI Commands

The -h | --help parameter shows details about Salesforce CLI topics and their commands.
For namespaces, the -h | --help parameter lists all topics in the namespace. For example, to see names and descriptions of all topics
in the force namespace, run sfdx force -h.
For topics, the -h | --help parameter lists the commands and their descriptions. For example, to see all commands in the org
topic, run sfdx force:org -h.
For commands, adding the -h | --help parameter shows parameters and usage information. For example, to see help for the
org:create command, run sfdx force:org:create -h.
Help for commands has four parts.
1. Short Description of Command
At the top of the --help output (with no heading), a short description of the command is shown. For longer descriptions, see
the Salesforce CLI Command Reference.

2. Usage
The command signature on the Usage line uses the docopt format.
• All available parameters are listed. Parameters that have short names are listed using their short names.

147
Salesforce CLI Command Reference CLI Deprecation Policy

• Parameters that take a value show the value’s type (for example, <string>) in angle brackets immediately after the parameter’s
name.
• Optional parameters are in square brackets ([ … ]).
• Required parameters have no annotation.
• For parameters that accept a limited set of values, the values are shown after the parameter name, separated by pipes
(--parametername value1|value2|value3).
• Mutually exclusive options are shown in parentheses, separated by a pipe (( … | … )).
If the command takes varargs (name-value pairs that aren’t parameters), the usage signature includes name=value....

Tip: To see signatures for all commands in the force namespace, run sfdx force:doc:commands:list
--usage.

3. Options
The Options section lists all the command’s parameters, including their short name, long name, and purpose. For parameters that
accept a value, the value name is written after an equals sign (=). The equals sign is optional when you run the command—for
example, you could run sfdx force:org:create -f=config/enterprise-scratch-def.json -a TestOrg1
or sfdx force:org:create -f config/enterprise-scratch-def.json -a TestOrg1 with the same
results.
Parameters that accept a limited list of values include the values in parentheses, with the default value indicated by an asterisk (*).
For more information about the parameters, see the Salesforce CLI Command Reference.

4. Description
Usage notes and examples are below the list of parameters, in the Description section. This information is also available in the
Salesforce CLI Command Reference.

CLI Deprecation Policy

Salesforce deprecates CLI commands and parameters when, for example, the underlying API changes.
The Salesforce CLI deprecation policy is:
• Salesforce can deprecate a command or parameter in any major update of the salesforcedx plug-in.
• Salesforce removes the deprecated command or parameter in the next major release of the salesforcedx plug-in. For example,
if Salesforce deprecates a command in version 41, it does not appear in version 42.
• If you use a command or parameter that’s been deprecated but not yet removed, you get a warning message in stderr when
you specify human-readable output. If you specify JSON output, the warning is presented as a property. The message includes the
plug-in version of when the command or parameter will be removed. The command help also includes deprecation information
when appropriate.
• When possible, Salesforce provides a functional alternative to the deprecated command or parameter.
• Salesforce announces new and upcoming deprecated commands and parameters in the release notes.

148

Top and Bottom Finder (Source Code)
No ratings yet
Top and Bottom Finder (Source Code)
10 pages
Field Service Lightning FSL in Salesforce 1720015048
No ratings yet
Field Service Lightning FSL in Salesforce 1720015048
11 pages
Brothers and The Reception of Yu Hua in France
No ratings yet
Brothers and The Reception of Yu Hua in France
13 pages
Cheatsheet: Fields With Database Indexes
No ratings yet
Cheatsheet: Fields With Database Indexes
2 pages
Salesforce Forcecom Workbook
No ratings yet
Salesforce Forcecom Workbook
116 pages
Manufacturing Cloud Discovery Guide For Partners
No ratings yet
Manufacturing Cloud Discovery Guide For Partners
1 page
Setup PDF
No ratings yet
Setup PDF
845 pages
Salesforce Apex Tutorials
No ratings yet
Salesforce Apex Tutorials
4 pages
ANTONY SFDC Developer
No ratings yet
ANTONY SFDC Developer
5 pages
Formulas Quick Reference: Math Operators
No ratings yet
Formulas Quick Reference: Math Operators
7 pages
Salesforce JD - Technical Support Engineer Role
No ratings yet
Salesforce JD - Technical Support Engineer Role
2 pages
20 Common Errors in Salesforce With Resolution 1720015105
No ratings yet
20 Common Errors in Salesforce With Resolution 1720015105
12 pages
Write SOQL Queries Unit - Salesforce Trailhead
No ratings yet
Write SOQL Queries Unit - Salesforce Trailhead
7 pages
SFDC Training Series - Associate
No ratings yet
SFDC Training Series - Associate
44 pages
Salesforce Course Outline
No ratings yet
Salesforce Course Outline
3 pages
User Guide For Salesforce Multi Factor Authentication - AD
No ratings yet
User Guide For Salesforce Multi Factor Authentication - AD
13 pages
Salesforce Apex Language Reference
No ratings yet
Salesforce Apex Language Reference
344 pages
Salesforce Pages Developers Guide
No ratings yet
Salesforce Pages Developers Guide
810 pages
SF Help - 2025 - Service - Salesforce_console
No ratings yet
SF Help - 2025 - Service - Salesforce_console
113 pages
Salesforce - CPQ Admin
No ratings yet
Salesforce - CPQ Admin
4 pages
Complete Salesforce B2C Solution Architect's Handbook - Second Edition Mike King PDF For All Chapters
100% (2)
Complete Salesforce B2C Solution Architect's Handbook - Second Edition Mike King PDF For All Chapters
79 pages
SALESFORCE Links
No ratings yet
SALESFORCE Links
2 pages
Salesforce Admin
No ratings yet
Salesforce Admin
4 pages
Field Service Lightning Data Model Spring 19 v45.0
No ratings yet
Field Service Lightning Data Model Spring 19 v45.0
1 page
DEX450 BuildApplicationsProgrammatically Exercises
No ratings yet
DEX450 BuildApplicationsProgrammatically Exercises
91 pages
3-Months Roadmap To Become A Data Analyst in 2024
No ratings yet
3-Months Roadmap To Become A Data Analyst in 2024
11 pages
Salesforce Apex Developer Guide
No ratings yet
Salesforce Apex Developer Guide
734 pages
Async Soql Guide
No ratings yet
Async Soql Guide
22 pages
Swap Na Sales Force Admin For Ude My Sessions
No ratings yet
Swap Na Sales Force Admin For Ude My Sessions
257 pages
Spring23 ReleaseOverviewDeck
No ratings yet
Spring23 ReleaseOverviewDeck
101 pages
Dreamwares Salesforce/Force - Com Expertise
No ratings yet
Dreamwares Salesforce/Force - Com Expertise
14 pages
Salesforce Apex Language Reference PDF
No ratings yet
Salesforce Apex Language Reference PDF
2,667 pages
Salesforce Dreamforce 2012 - Docusign Apex REST API Integeration
No ratings yet
Salesforce Dreamforce 2012 - Docusign Apex REST API Integeration
14 pages
Salesforce Pages Developers Guide
No ratings yet
Salesforce Pages Developers Guide
569 pages
Salesforce Certified Associate Glossary
No ratings yet
Salesforce Certified Associate Glossary
6 pages
Wa0007.
No ratings yet
Wa0007.
182 pages
Aura 1
No ratings yet
Aura 1
10 pages
Enabled Aura Framework, by Adding Aura Attributes and Aura Handlers For Events To Focus On Logic and Interactions in Lightning Applications.
No ratings yet
Enabled Aura Framework, by Adding Aura Attributes and Aura Handlers For Events To Focus On Logic and Interactions in Lightning Applications.
7 pages
salesforce-consultants-guide
No ratings yet
salesforce-consultants-guide
168 pages
Certified B2C Commerce Developer Demo
No ratings yet
Certified B2C Commerce Developer Demo
6 pages
SOSL Queries
No ratings yet
SOSL Queries
4 pages
Sales Force Apex Language Reference
No ratings yet
Sales Force Apex Language Reference
485 pages
Apps
No ratings yet
Apps
95 pages
Salesforce Packaging Demystified
100% (1)
Salesforce Packaging Demystified
24 pages
T & H P A: Understanding Person Accounts
No ratings yet
T & H P A: Understanding Person Accounts
2 pages
LWC
No ratings yet
LWC
2 pages
Vlocity Health Product Brief
No ratings yet
Vlocity Health Product Brief
2 pages
SF Rest API Cheatsheet Web
No ratings yet
SF Rest API Cheatsheet Web
4 pages
Heroku Connect Datasheet
No ratings yet
Heroku Connect Datasheet
4 pages
CPQ Level2
No ratings yet
CPQ Level2
123 pages
A Deeper Look at SOQL and Relationship Queries On Force
No ratings yet
A Deeper Look at SOQL and Relationship Queries On Force
10 pages
Script 4
No ratings yet
Script 4
4 pages
Salesforce-Brochure New
No ratings yet
Salesforce-Brochure New
24 pages
Revenue Cloud Consultant Accredited Professional - Exam Guide
0% (1)
Revenue Cloud Consultant Accredited Professional - Exam Guide
5 pages
Javascript
No ratings yet
Javascript
95 pages
Salesforce Devops
No ratings yet
Salesforce Devops
5 pages
LWC Apex Methods 1679577718
No ratings yet
LWC Apex Methods 1679577718
2 pages
salesforce_IQ_2023
No ratings yet
salesforce_IQ_2023
8 pages
Microsoft Dynamics CRM 2011: Dashboards Cookbook
From Everand
Microsoft Dynamics CRM 2011: Dashboards Cookbook
Mark AuCoin
No ratings yet
Visualforce Development Cookbook
From Everand
Visualforce Development Cookbook
Keir Bowden
No ratings yet
Salesforce CRM Administration Handbook: A comprehensive guide to administering, configuring, and customizing Salesforce CRM
From Everand
Salesforce CRM Administration Handbook: A comprehensive guide to administering, configuring, and customizing Salesforce CRM
Krzysztof Nowacki
No ratings yet
SCCM software change and configuration management Standard Requirements
From Everand
SCCM software change and configuration management Standard Requirements
Gerardus Blokdyk
No ratings yet
Forcedotcom SFDX Simple
No ratings yet
Forcedotcom SFDX Simple
2 pages
Unité Put The Web in Web API - Salesforce Trailhead PDF
No ratings yet
Unité Put The Web in Web API - Salesforce Trailhead PDF
4 pages
Unité Learn The Benefits of APIs - Salesforce Trailhead
No ratings yet
Unité Learn The Benefits of APIs - Salesforce Trailhead
6 pages
Unité Make APIs For You and Me - Salesforce Trailhead PDF
No ratings yet
Unité Make APIs For You and Me - Salesforce Trailhead PDF
4 pages
Kiitee 2012
No ratings yet
Kiitee 2012
19 pages
GRADE 5 - First Mastery Exam: Pointers in Math
No ratings yet
GRADE 5 - First Mastery Exam: Pointers in Math
1 page
"Reading The Image" Art Appreciation
100% (1)
"Reading The Image" Art Appreciation
11 pages
English Global Volunteerism
No ratings yet
English Global Volunteerism
12 pages
Feminist Reading of The Great Gatsby
No ratings yet
Feminist Reading of The Great Gatsby
65 pages
Andi Renata Fadhillah - 5-Paragraph Essay Writing
No ratings yet
Andi Renata Fadhillah - 5-Paragraph Essay Writing
13 pages
What Is An Interjection Examples, Definition & Types
No ratings yet
What Is An Interjection Examples, Definition & Types
1 page
TC HKMO 0405 H GP
No ratings yet
TC HKMO 0405 H GP
3 pages
Hinduism
No ratings yet
Hinduism
30 pages
Game IPA With Answer
No ratings yet
Game IPA With Answer
6 pages
Maths Project File Term 2
No ratings yet
Maths Project File Term 2
19 pages
Resume Rohit
No ratings yet
Resume Rohit
5 pages
World Literature Student
100% (1)
World Literature Student
25 pages
Nidhi Resume 1
No ratings yet
Nidhi Resume 1
2 pages
Synopsis PPT Template
No ratings yet
Synopsis PPT Template
13 pages
Analyzing Data Using Python - Cleaning and Analyzing Data in Pandas
No ratings yet
Analyzing Data Using Python - Cleaning and Analyzing Data in Pandas
81 pages
RPH Activities
No ratings yet
RPH Activities
7 pages
Chapter 3 Compiler Design
No ratings yet
Chapter 3 Compiler Design
42 pages
Knjiga About Soul and Klages
No ratings yet
Knjiga About Soul and Klages
30 pages
LESSON-1 Basic Concepts of ICT (RogenMeihDahipon)
No ratings yet
LESSON-1 Basic Concepts of ICT (RogenMeihDahipon)
3 pages
Gpon Olt - Ma5600t
No ratings yet
Gpon Olt - Ma5600t
93 pages
Web Methods Installation Guide 6 5 and 6 5 1
0% (1)
Web Methods Installation Guide 6 5 and 6 5 1
288 pages
Pueblos de Panay
No ratings yet
Pueblos de Panay
28 pages
Articulation of Vowels
100% (1)
Articulation of Vowels
6 pages
ResPaper ICSE BIOLOGY THE CIRCULATORY SYSTEM NOTES
100% (1)
ResPaper ICSE BIOLOGY THE CIRCULATORY SYSTEM NOTES
25 pages
Verilog Modules For Common Digital Functions
No ratings yet
Verilog Modules For Common Digital Functions
30 pages
CD Unit3
No ratings yet
CD Unit3
21 pages
Voice Based Mail System
85% (27)
Voice Based Mail System
18 pages