Salesforce DX Developer Guide

How Salesforce Developer Experience (DX) Tooling Changes the Way You Work
Get Started by Using a Sample Repo
Get Started by Creating a New DX Project
Create an Application
Migrate or Import Existing Source
Release Notes
Provide Developers Access to Salesforce DX Tools
Project Setup
Authorization
Metadata Coverage
Scratch Orgs
Sandboxes
Track Changes Between Your Project and Org
Work with Data
Salesforce DX MCP Server and Tools
Development
Build and Release Your App
Unlocked Packages
Continuous Integration
Troubleshoot Salesforce DX
Limitations for Salesforce DX
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, 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.

Migrate or Import Existing Source

Use the Metadata API to retrieve the code, and then convert your source for use in a Salesforce DX project.

If your current repo follows the directory structure that is created from a Metadata API retrieve, you can skip the retrieve step and go directly to converting the source.

Tip

  1. Set up your project.
  2. Retrieve your metadata.
  3. Convert the metadata formatted source you just retrieved to source format.
  4. Authorize the Developer Hub org for the project.
  5. Configure your local project.
  6. Create a scratch org.
  7. Push the source from your project to the scratch org.
  8. Develop the app.
  9. Pull the source to sync your project and scratch org.
  10. Run tests.
  11. Add, commit, and push changes. Create a pull request.

Deploy your app using one of the following methods:

  • Build and release your app with managed packages
  • Build and release your app using the Metadata API