sf-project

name	sf-project
description	Project management commands including metadata retrieval, deployment, manifest generation, and source tracking.

sf project Operations

Commands for managing Salesforce DX projects.

sf project generate

Create a new Salesforce DX project.

# Create standard project
sf project generate --name my-project

# Create project with manifest
sf project generate --name my-project --manifest

# Create empty project
sf project generate --name my-project --template empty

Project Structure

my-project/
├── sfdx-project.json      # Project configuration
├── .forceignore           # Files to ignore during deploy
├── force-app/
│   └── main/
│       └── default/
│           ├── classes/          # Apex classes
│           ├── objects/          # Custom objects
│           ├── lwc/              # Lightning Web Components
├── manifest/
│   └── package.xml        # Metadata package definition

sf project retrieve start

Retrieve metadata from org to local project.

# Retrieve all metadata (use cautiously)
sf project retrieve start --target-org myOrg --metadata "*"

# Retrieve specific metadata types
sf project retrieve start --target-org myOrg --metadata ApexClass,ApexTrigger
sf project retrieve start --target-org myOrg --metadata CustomObject:Account

# Retrieve using manifest
sf project retrieve start --target-org myOrg --manifest manifest/package.xml

Retrieve BotVersion

Beginning in version 2.128.5, the project retrieve start command correctly retrieves specific versions of the Bot metadata type (BotVersion).

# Retrieve version 3 of the Local_Info_Agent Bot
sf project retrieve start --metadata Bot:Local_Info_Agent --metadata BotVersion:Local_Info_Agent.v3

sf project deploy start

Deploy metadata to org.

# Deploy source directory
sf project deploy start --target-org myOrg --source-dir force-app

# Deploy specific metadata
sf project deploy start --target-org myOrg --metadata ApexClass:MyClass

# Deploy using manifest
sf project deploy start --target-org myOrg --manifest manifest/package.xml

# Dry run (validate only)
sf project deploy start --target-org myOrg --source-dir force-app --dry-run

Combined Destructive and Manifest Changes

Version 2.128.5 ensures that the project deploy start command works correctly when using both a destructive change file and a standard manifest file simultaneously.

# Deploy with manifest and pre-destructive changes
sf project deploy start --target-org myOrg \
  --manifest manifest/package.xml \
  --pre-destructive-changes manifest/destructiveChangesPre.xml

sf project deploy validate / quick

Validate deployment and perform quick deploy.

# Validate deployment
sf project deploy validate --target-org myOrg --source-dir force-app \
  --test-level RunLocalTests

# Quick deploy using validation ID (returned by validate)
sf project deploy quick --target-org myOrg --job-id <validation-id>

sf project deploy report / cancel / resume

Manage deployment status.

# Check status
sf project deploy report --target-org myOrg --job-id <job-id>

# Cancel deployment
sf project deploy cancel --target-org myOrg --job-id <job-id>

# Resume deployment
sf project deploy resume --job-id <job-id> --target-org myOrg

sf project convert

Convert between source and MDAPI formats.

# Source to MDAPI
sf project convert source --root-dir force-app --output-dir mdapi-output

# MDAPI to source
sf project convert mdapi --root-dir mdapi-output --output-dir force-app

sf project generate manifest

Generate package.xml manifest.

sf project generate manifest --source-dir force-app --output-dir manifest

sf project reset tracking / delete tracking

Reset or delete source tracking information.

# Reset tracking for org
sf project reset tracking --target-org myOrg

# Delete all tracking
sf project delete tracking --all