Salesforce CLI Command Reference

Salesforce CLI Command Reference
alias Namespace
auth Namespace
config Namespace
force Namespace
analytics Commands
apex Commands
auth Commands
cmdt Commands
community Commands
data Commands
lightning Commands
limits Commands
mdapi Commands
org Commands
package Commands
package1 Commands
project Commands
force:project:create
force:project:upgrade
schema Commands
source Commands
user Commands
visualforce Commands
Help for Salesforce CLI Commands
CLI Deprecation Policy
PDF

project Commands

Use the project commands to set up a Salesforce DX project.

force:project:create

Creates a Salesforce DX project in the specified directory or the current working directory. The command creates the necessary configuration files and folders.

Help for force:project:create

If not supplied, the apiversion, template, and outputdir use default values.

The outputdir can be an absolute path or relative to the current working directory.

Examples:

1$ sfdx force:project:create --projectname mywork
1$ sfdx force:project:create --projectname mywork --defaultpackagedir myapp
1$ sfdx force:project:create --projectname mywork --defaultpackagedir myapp --manifest
1$ sfdx force:project:create --projectname mywork --template empty

Command Syntax

sfdx force:project:create
[--json]
[--loglevel LOGLEVEL]
-n PROJECTNAME
[-t TEMPLATE]
[-d OUTPUTDIR]
[-s NAMESPACE]
[-p DEFAULTPACKAGEDIR]
[-x]

Parameters

--json
Optional

Format output as JSON.

Type: boolean
--loglevel LOGLEVEL
Optional

The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.

Type: enum
Permissible values are: trace, debug, info, warn, error, fatal, TRACE, DEBUG, INFO, WARN, ERROR, FATAL
Default value: warn
-n | --projectname PROJECTNAME
Required

The name for the new project. Any valid folder name is accepted.

Type: string
-t | --template TEMPLATE
Optional

The template to use to create the project. Supplied parameter values or default values are filled into a copy of the template.

Type: string
Permissible values are: standard, empty, analytics
Default value: standard
-d | --outputdir OUTPUTDIR
Optional

The directory to store the newly created files. The location can be an absolute path or relative to the current working directory. The default is the current directory.

Type: string
Default value: .
-s | --namespace NAMESPACE
Optional

The namespace associated with this project and any connected scratch orgs.

Type: string
-p | --defaultpackagedir DEFAULTPACKAGEDIR
Optional

The default package directory name. Metadata items such as classes and Lightning bundles are placed inside this folder.

Type: string
Default value: force-app
-x | --manifest
Optional

Generates a default manifest (package.xml) for fetching Apex, Visualforce, Lightning components, and static resources.

Type: boolean

force:project:upgrade

Updates project configuration and definition files to the latest format.

Help for force:project:upgrade

Examples:

$ sfdx force:project:upgrade

$ sfdx force:project:upgrade -f

Command Syntax

sfdx force:project:upgrade
[--json]
[--loglevel LOGLEVEL]
[-f]

Parameters

--json
Optional

Format output as JSON.

Type: boolean
--loglevel LOGLEVEL
Optional

The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.

Type: enum
Permissible values are: trace, debug, info, warn, error, fatal, TRACE, DEBUG, INFO, WARN, ERROR, FATAL
Default value: warn
-f | --forceupgrade
Optional

Run all upgrades, even if the project definition files have already been upgraded.

Type: boolean