project Commands (Deprecated)

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

force:project:create (Deprecated)

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

This command is deprecated. As of April 20, 2023, we no longer maintain this section of the command reference. Refer to the reference information about the sf-style commands instead, which we update regularly. We keep this reference information about the sfdx-style commands as-is for historical reference only.

Don't worry, this command and its flags continue to work the same as before, and any scripts that use the command won’t break. However, we recommend that you start using the equivalent sf-style project generate command instead. Here’s how the flags changed between the old and new commands; if a flag isn't listed, the old and new names are the same:

  • Removed flag: --loglevel. Use the SF_LOG_LEVEL environment variable instead.
  • Changed flag name: Old name --apiversion. New name: --api-version.
  • Changed flag name: Old name --outputdir. New name: --output-dir.
  • Changed flag name: Old name --projectname. New name: --name.
  • Changed flag name: Old name --defaultpackagedir. New name: --default-package-dir.

For background information about this change, read this blog post, which describes how we've updated many of the existing sfdx commands to use the improvements we made in sf. We improved this particular command on February 16, 2023.

Warning

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:

1sfdx force:project:create --projectname mywork
1sfdx force:project:create --projectname mywork --defaultpackagedir myapp
1sfdx force:project:create --projectname mywork --defaultpackagedir myapp --manifest
1sfdx 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/.sf/sf.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