Project
In Salesforce DX, a Project is a local directory containing a sfdx-project.json configuration file, source-format metadata, and Git history that developers use with Salesforce CLI (sf, the unified…
Definition
In Salesforce DX, a Project is a local directory containing a sfdx-project.json configuration file, source-format metadata, and Git history that developers use with Salesforce CLI (sf, the unified CLI that replaced the original sfdx in 2023) to build and deploy customizations. The Project is the unit of work for source-driven Salesforce development and is typically synonymous with DX Project or Local Project.
In plain English
“In Salesforce DX, a Project is the folder on your laptop that holds Salesforce metadata as source code. It has a sfdx-project.json manifest, source-format folders for Apex, LWCs, and configuration, and Git history. Commands like "sf project deploy start" and "sf project retrieve start" work against this Project - it is the unit of work for source-driven Salesforce development.”
Worked example
A developer at Opalwood Labs initializes a new Salesforce Project by running "sf project generate -n commerce-extensions" in her terminal. The command creates a new directory with a scaffolded sfdx-project.json, a force-app package directory, and a .gitignore configured for Salesforce development. She imports an existing managed-package dependency by editing sfdx-project.json, then runs "sf project deploy start -o production" to push the initial source into a QA sandbox, confirming the Project roundtrips correctly before committing the scaffold to Git.
Why Project matters
In Salesforce DX, a Project is a local project directory containing the sfdx-project.json file, source code, and metadata that developers use to build and deploy customizations to Salesforce orgs using the Salesforce CLI. The project structure follows DX conventions, with metadata organized into directories that can be tracked in Git for version control and collaboration.
DX projects are foundational to source-driven Salesforce development. Developers clone the project from Git, use the Salesforce CLI to push source to scratch orgs or sandboxes, work on changes, pull updates back to the project, and commit to Git. This workflow makes Salesforce development feel like modern web development with proper version control and collaboration. Mature Salesforce teams organize their work entirely around DX projects.
How organizations use Project
All developers work in DX projects cloned from Git, using scratch orgs as their development environment.
Maintains entire metadata in Git as DX projects, treating Salesforce code like any other software project.
Builds CI/CD pipelines around DX projects for automated deployment.
Trust & references
Straight from the source - Salesforce's reference material on Project.
- Salesforce DX Developer GuideSalesforce Developers
Test your knowledge
Q1. What is a Project in Salesforce DX?
Q2. What enables Git-based collaboration?
Q3. What file defines project configuration?
Discussion
Loading discussion…