Salesforce CLI Command Reference (Beta)

Salesforce CLI Command Reference (Beta)
force Namespace
alias Commands
apex Commands
auth Commands
config Commands
data Commands
doc Commands
lightning Commands
limits Commands
mdapi Commands
org Commands
package Commands
package1 Commands
package2 Commands (Pilot)
project Commands
project:create
project:upgrade
schema Commands
source Commands
user Commands
visualforce Commands
PDF

project Commands

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

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.

Command Syntax

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

Parameters

-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 file. Supplied parameter values or default values are filled into a copy of the template.

Type: string
Permissible values are: Defaultsfdx-project.json
Default value: Defaultsfdx-project.json
-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
-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
--json
Optional




Formats output as JSON.

Type: string
--loglevel LOGLEVEL
Optional




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

Type: string
Permissible values are: trace, debug, info, warn, error, fatal
Default value: error

Help for project:create

Default values are used if the template, namespace, defaultpackagedir, and outputdir aren’t supplied.

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

project:upgrade

Updates project configuration and definition files to the latest format.

Command Syntax

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

Parameters

-f | --forceupgrade
Optional




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

Type: flag
--json
Optional




Format output as JSON.

Type: flag
--loglevel LOGLEVEL
Optional




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

Type: string
Permissible values are: trace, debug, info, warn, error, fatal
Default value: error

Help for project:upgrade

Examples:

$ sfdx force:project:upgrade

$ sfdx force:project:upgrade -f