force-org-create Task

Description

Creates a scratch org.

It executes the force:org:create command.

Parameters

In addition to the attributes used by every ant-sfdx task, this task uses the following attributes:

Attribute Command line equivalent Description Required
alias -a An alias for the created scratch org. No
clientid -i Connected app consumer key, as configured in your Dev Hub. No
defaultusername -s If true, sets the created org as the default username. No; defaults to false
definitionfile -f A scratch org definition file. No
durationdays -d Sets the duration of the scratch org, in days. Valid values are from 1-30. No; defaults to 7
noancestors -c If true, do not include second-generation package ancestors in the scratch org. No; defaults to false
nonamespace -n If true, creates the scratch org with no namespace. Useful when using a scratch org to test installations of packages with namespaces. No; defaults to false
targetdevhubusername -v A username or alias for the target Dev Hub org. No
type -t Specifies the type of org to create. Acceptable values are:
  • Scratch: create a Scratch Org..
  • Sandbox: create a Sandbox.
No
wait -w Sets the streaming client socket timeout, in minutes. If the streaming client socket has no contact from the server for a number of minutes, the client exits. Specify a longer wait time if timeouts occur frequently. No; defaults to 6

Parameters specified as nested elements

param

Specifies parameters to be used for the scratch org creation, sent as key=value pairs to the Salesforce DX CLI command. See property for usage guidelines.

Version: 0.0.0-master