Salesforce DX Developer Guide

How Salesforce Developer Experience Changes the Way You Work
Salesforce CLI Configuration and Tips
Project Setup
Sample Repository on GitHub
Create a Salesforce DX Project
Create a Salesforce DX Project from Existing Source
Retrieve Source from an Existing Managed Package
Retrieve Unpackaged Source Defined in a package.xml File
Convert the Metadata Source to Source Format
Link a Namespace to a Dev Hub Org
Salesforce DX Project Configuration
Authorization
Metadata Coverage
Scratch Orgs
Development
Build and Release Your App
First-Generation Managed Packages
Unlocked Packages (Generally Available) and Second-Generation Managed Packages (Beta)
Continuous Integration
Troubleshoot Salesforce DX
Limitations for Salesforce DX
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Create a Salesforce DX Project

A Salesforce DX project has a specific structure and a configuration file that identifies the directory as a Salesforce DX project.
You can create a project with minimal (empty) or expanded (standard) scaffolding. For Spring ’19 (v45), the default is empty (maintaining the command’s previous behavior). In Summer ’19 (v46), the default is standard, which provides extended scaffolding to facilitate moving source to and from your orgs.
  1. Change to the directory where you want the DX project located.
  2. Create the DX project. 
    1force:project:create -n MyProject --template standard
    If you don’t indicate an output directory, the project directory is created in the current location. You can also specify the default package directory to target when syncing source to and from the scratch org. If you don’t indicate a default package directory, this command creates a default package directory, force-app.

    The default --template value, empty, creates a project with these sample configuration files to get you started.

    • .forceignore
    • config/project-scratch-def.json
    • sfdx-project.json

    If you select expanded scaffolding (--template standard), you get a complete directory structure that takes the guesswork out of where to put your source. It also provides these files that are especially helpful when using Salesforce Extensions for VS Code.

    • .gitignore: Makes it easier to start using Git for version control.
    • .prettierrc and .prettierignore: Make it easier to start using Prettier to format your Aura components.
    • .vscode/extensions.json: Causes Visual Studio Code, when launched, to prompt you to install the recommended extensions for your project.
    • .vscode/launch.json: Configures Replay Debugger, making it more discoverable and easier to use.
    • .vscode/settings.json: By default, this file has one setting, for push or deploy on save, which is set to false. You can change this value or add other settings.
    DX project directory structure for standard template. Includes VS Code files plus core source directories under force-app/main/default: applications, aura, classes, contentassets, flexipages, layouts, lwc, objects, permissionsets, staticresources, tabs, and triggers.

Example

1sfdx force:project:create --projectname mywork --template standard
1sfdx force:project:create --projectname mywork --defaultpackagedir myapp

Next steps:

  • (Optional) Register the namespace with the Dev Hub org.
  • Configure the project (sfdx-project.json). If you use a namespace, update this file to include it.
  • Create a scratch org definition that produces scratch orgs that mimic the shape of another org you use in development, such as sandbox, packaging, or production. The config directory of your new project contains a sample scratch org definition file (project-scratch-def.json).