Salesforce DX Developer Guide

How Salesforce Developer Experience (DX) Tooling Changes the Way You Work
Provide Developers Access to Salesforce DX Tools
Project Setup
Sample Repository on GitHub
Create a Salesforce DX Project
Salesforce DX Project Structure and Source Format
How to Exclude Source When Syncing
Create a Salesforce DX Project from Existing Source
Convert Files in Metadata Format to Source Format
Salesforce DX Usernames and Orgs
Link a Namespace to a Dev Hub Org
Salesforce DX Project Configuration
Multiple Package Directories
Replace Strings in Code Before Deploying or Packaging
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

Sample Repository on GitHub

To get started quickly, see the dreamhouse-lwc GitHub repo. This standalone application contains an example DX project with multiple Apex classes, Aura components, custom objects, sample data, and Apex tests.

Cloning this repo creates the directory dreamhouse-lwc. See the repo’s Readme for more information.

Assuming that you’ve already set up Git, use the git clone command to clone the main branch of the repo from the command line.

To use HTTPS:

To use SSH:

If you don’t want to use Git, download a .zip file of the repository’s source using Clone, or download on the GitHub website. Unpack the source anywhere on your local file system.

See Get Started by Using a Sample Repo for the next steps.

Check out more complex examples in the Sample Gallery.

The Sample Gallery contains sample apps that show what you can build on the Salesforce platform. They’re continuously updated to incorporate the latest features and best practices.

Tip