DX Commands

Getting Started

Force CLI Referece -Beta

List All Commands

sfdx force:doc:commands:display

Login to DevHub Org

sfdx force:auth:web:login -d -a DevHub

Open DevHub Org

sfdx force:org:open -u DevHub

Create a Project

sfdx force:project:create -n MyApp

Login to Sandbox

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

List Orgs

sfdx force:org:list

Create a Scratch Org

sfdx force:org:create -s -f config/project-scratch-def.json -a ScratchOrgAlias

Sample scratch org definition file

{
	"orgName": "Your Company",
	"edition": "Enterprise",
	"adminEmail": "Your.Name@Your.Company.com",
	"hasSampleData": "true",
	"orgPreferences" : {
		"enabled": ["S1DesktopEnabled"]
	}
}

Delete a Scratch Org

sfdx force:org:delete -u ScratchOrgAlias

Set a password for your Scratch Org

sfdx force:user:password:generate -u ScratchOrgAlias

Display User info in a Scratch Org

sfdx force:org:display -u ScratchOrgAlias

Push/Pull Source

sfdx force:source:push
sfdx force:source:pull

Assign Permission Set

sfdx force:user:permset:assign -n PermSetName -u ScratchOrgAlias

Data Export

sfdx force:data:tree:export -q soql/query.soql -d ./data -u OrgAlias
sfdx force:data:tree:export -q "select Name from Account limit 1" -d ./data -u OrgAlias

Data Import

sfdx force:data:tree:import -f data/MyObject.json -u OrgAlias

Query with SOQL

sfdx force:data:soql:query -u OrgAlias -q "select Id, Name from Account limit 10"

Create an Apex Class

sfdx force:apex:class:create -n MyClassName -d force-app/main/default/classes

Metadata API Retrieve

sfdx force:mdapi:retrieve -s -r ./mddir -p PkgName -u OrgAlias -w 10

Metadata Convert to DX

sfdx force:mdapi:convert -r mddir/

DX Convert to Metadata

sfdx force:source:convert -d mddir/

Metadata Deploy

sfdx force:mdapi:deploy -d mddir/ -u OrgAlias -w 100

Open an Org by Alias

sfdx force:org:open -u OrgAlias

Execute Anonymous Apex

sfdx force:apex:execute -f Script.apex

Execute Test Classes

sfdx force:apex:test:run -r human

Describe SObject Schema

sfdx force:schema:sobject:describe -s Account

Package2 Create

sfdx force:package:create -n apr -o Unlocked

Sample sfdx-project.json file for packages

{
  "packageDirectories": [ 
    {
      "path": "force-app",
      "default": true,
      "id": "0HoB0000000CaYnKAK",
      "versionName": "Version 1.0",
      "versionNumber": "1.0.0.NEXT"
    }
  ],
  "namespace": "",
  "sfdcLoginUrl": "https://login.salesforce.com",
  "sourceApiVersion": "42.0"
}

Package2 Version Create

sfdx force:package:version:create --directory force-app --wait 10

Package2 Install

sfdx force:package:install --package 04t1N00000297JLQAY --wait 5 -u orgAlias

Org Shape Create *Beta

sfdx force:org:shape:create -u DevHub

Org Shape List

sfdx force:org:shape:list