org Commands
force:org:clone
Help for force:org:clone
Specify a configuration file with a sourceSandboxName or provide key=value pairs while cloning a sandbox. The --targetusername (-u) must be a production org with sandbox licenses. The —type (-t) is required if cloning a sandbox.
Examples:
1$ sfdx force:org:clone -t sandbox -f config/dev-sandbox-def.json -u prodOrg -a MyDevSandbox1$ sfdx force:org:clone -t sandbox sandboxName=DevSbx1 sourceSandboxName=Sbx2Clone -u prodOrg -a MyDevSandboxCommand Syntax
- sfdx force:org:clone
- [--json]
- [--loglevel LOGLEVEL]
- [-u TARGETUSERNAME]
- [--apiversion APIVERSION]
- -t TYPE
- [-f DEFINITIONFILE]
- [-s]
- [-a SETALIAS]
- [-w WAIT]
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
- -u | --targetusername TARGETUSERNAME
- Optional
-
A username or alias for the target org. Overrides the default target org.
- Type: string
- --apiversion APIVERSION
- Optional
-
Override the API version used for API requests made by this command.
- Type: string
- -t | --type TYPE
- Required
-
The type of org to create. Only "sandbox" is supported.
- Type: enum
- Permissible values are: sandbox
- -f | --definitionfile DEFINITIONFILE
- Optional
-
The path to an org definition file. Either --definitionfile or a vararg value for edition (for example, edition=Developer) is required. Varargs override the values in the scratch org definition file.
- Type: filepath
- -s | --setdefaultusername
- Optional
-
Sets the created org as the default username.
- Type: boolean
- -a | --setalias SETALIAS
- Optional
-
An alias for the created org.
- Type: string
- -w | --wait WAIT
- Optional
-
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.
- Type: minutes
- Default value: 6 minutes
force:org:create
Help for force:org:create
Specify a configuration file or provide key=value pairs while creating a scratch org or a sandbox. When creating scratch orgs, —targetdevhubusername (-v) must be a Dev Hub org. When creating sandboxes, the --targetusername (-u) must be a production org with sandbox licenses. The —type (-t) is required if creating a sandbox.
Examples:
1$ sfdx force:org:create -f config/enterprise-scratch-def.json -a MyScratchOrg1$ sfdx force:org:create edition=Developer -a MyScratchOrg -s -v devHub1$ sfdx force:org:create -f config/enterprise-scratch-def.json -a ScratchOrgWithOverrides username=testuser1@mycompany.org1$ sfdx force:org:create -t sandbox -f config/dev-sandbox-def.json -a MyDevSandbox -u prodOrgCommand Syntax
- sfdx force:org:create
- [--json]
- [--loglevel LOGLEVEL]
- [-v TARGETDEVHUBUSERNAME]
- [-u TARGETUSERNAME]
- [--apiversion APIVERSION]
- [-t TYPE]
- [-f DEFINITIONFILE]
- [-n]
- [-c]
- [-i CLIENTID]
- [-s]
- [-a SETALIAS]
- [-w WAIT]
- [-d DURATIONDAYS]
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
- -v | --targetdevhubusername TARGETDEVHUBUSERNAME
- Optional
-
A username or alias for the target Dev Hub org. Overrides the default Dev Hub org.
- Type: string
- -u | --targetusername TARGETUSERNAME
- Optional
-
A username or alias for the target org. Overrides the default target org.
- Type: string
- --apiversion APIVERSION
- Optional
-
Override the API version used for API requests made by this command.
- Type: string
- -t | --type TYPE
- Optional
-
The type of org to create.
- Type: enum
- Permissible values are: scratch, sandbox
- Default value: scratch
- -f | --definitionfile DEFINITIONFILE
- Optional
-
The path to an org definition file. Either --definitionfile or a vararg value for edition (for example, edition=Developer) is required. Varargs override the values in the scratch org definition file.
- Type: filepath
- -n | --nonamespace
- Optional
-
Creates the scratch org with no namespace. Scratch orgs without a namespace are useful when testing installations of packages with namespaces.
- Type: boolean
- -c | --noancestors
- Optional
-
Prevents the inclusion of second-generation package ancestors in the scratch org.
- Type: boolean
- -i | --clientid CLIENTID
- Optional
-
A connected app consumer key, as configured in your Dev Hub or production org. This parameter is not supported for sandbox org creation.
- Type: string
- -s | --setdefaultusername
- Optional
-
Sets the created org as the default username.
- Type: boolean
- -a | --setalias SETALIAS
- Optional
-
An alias for the created org.
- Type: string
- -w | --wait WAIT
- Optional
-
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.
- Type: minutes
- Default value: 6 minutes
- -d | --durationdays DURATIONDAYS
- Optional
-
Sets the duration of the scratch org, in days. Valid values are from 1-30. The default is 7 days.
- Type: number
force:org:delete
Help for force:org:delete
To mark the org for deletion without being prompted to confirm, specify --noprompt.
Examples:
1$ sfdx force:org:delete -u me@my.org1$ sfdx force:org:delete -u MyOrgAlias -pCommand Syntax
- sfdx force:org:delete
- [--json]
- [--loglevel LOGLEVEL]
- [-v TARGETDEVHUBUSERNAME]
- [-u TARGETUSERNAME]
- [--apiversion APIVERSION]
- [-p]
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
- -v | --targetdevhubusername TARGETDEVHUBUSERNAME
- Optional
-
A username or alias for the target Dev Hub org. Overrides the default Dev Hub org.
- Type: string
- -u | --targetusername TARGETUSERNAME
- Optional
-
A username or alias for the target org. Overrides the default target org.
- Type: string
- --apiversion APIVERSION
- Optional
-
Override the API version used for API requests made by this command.
- Type: string
- -p | --noprompt
- Optional
-
No prompt to confirm deletion.
- Type: boolean
force:org:display
Help for force:org:display
Output includes your access token, client ID, connected status, org ID, instance URL, username, and alias, if applicable.
Use --verbose to include the SFDX auth URL. Including --verbose displays the sfdxAuthUrl property only if you authenticated to the org using force:auth:web:login (not force:auth:jwt:grant).
Examples:
1$ sfdx force:org:display1$ sfdx force:org:display -u me@my.org1$ sfdx force:org:display -u TestOrg1 --json1$ sfdx force:org:display -u TestOrg1 --json > tmp/MyOrgDesc.jsonCommand Syntax
- sfdx force:org:display
- [--json]
- [--loglevel LOGLEVEL]
- [-u TARGETUSERNAME]
- [--apiversion APIVERSION]
- [--verbose]
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
- -u | --targetusername TARGETUSERNAME
- Optional
-
A username or alias for the target org. Overrides the default target org.
- Type: string
- --apiversion APIVERSION
- Optional
-
Override the API version used for API requests made by this command.
- Type: string
- --verbose
- Optional
-
Emit additional command output to stdout.
- Type: boolean
force:org:list
Help for force:org:list
Examples:
1$ sfdx force:org:list1$ sfdx force:org:list --verbose --json1$ sfdx force:org:list --verbose --json > tmp/MyOrgList.jsonCommand Syntax
- sfdx force:org:list
- [--json]
- [--loglevel LOGLEVEL]
- [--verbose]
- [--all]
- [--clean]
- [-p]
- [--skipconnectionstatus]
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
- --verbose
- Optional
-
Lists more information about each org.
- Type: boolean
- --all
- Optional
-
Lists all authenticated orgs, including expired, deleted, and unknown-status scratch orgs.
- Type: boolean
- --clean
- Optional
-
Remove all local org authorizations for deleted or expired orgs.
- Type: boolean
- -p | --noprompt
- Optional
-
Do not prompt for confirmation.
- Type: boolean
- --skipconnectionstatus
- Optional
-
Skips retrieving the connection status of non-scratch orgs
- Type: boolean
force:org:open
Help for force:org:open
Opens your default scratch org, or another org that you specify.
To open a specific page, specify the portion of the URL after "yourInstance.salesforce.com/" as --path.
For example, specify "--path lightning" to open Lightning Experience, or specify "--path /apex/YourPage" to open a Visualforce page.
To generate a URL but not launch your browser, specify --urlonly.
Examples:
1$ sfdx force:org:open1$ sfdx force:org:open -u me@my.org1$ sfdx force:org:open -u MyTestOrg11$ sfdx force:org:open -r -p lightningCommand Syntax
- sfdx force:org:open
- [--json]
- [--loglevel LOGLEVEL]
- [-u TARGETUSERNAME]
- [--apiversion APIVERSION]
- [-p PATH]
- [-r]
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
- -u | --targetusername TARGETUSERNAME
- Optional
-
A username or alias for the target org. Overrides the default target org.
- Type: string
- --apiversion APIVERSION
- Optional
-
Override the API version used for API requests made by this command.
- Type: string
- -p | --path PATH
- Optional
-
Navigation URL path (not including domain).
- Type: string
- -r | --urlonly
- Optional
-
Displays a navigation URL, but doesn’t launch your browser.
- Type: boolean
force:org:shape:create (Beta)
Help for force:org:shape:create
Examples:
1$ sfdx force:org:shape:create -u me@my.org1$ sfdx force:org:shape:create -u me@my.org --json --loglevel debugCommand Syntax
- sfdx force:org:shape:create
- [--json]
- [--loglevel LOGLEVEL]
- [-u TARGETUSERNAME]
- [--apiversion APIVERSION]
- [-f DEFINITIONFILE]
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
- -u | --targetusername TARGETUSERNAME
- Optional
-
A username or alias for the target org. Overrides the default target org.
- Type: string
- --apiversion APIVERSION
- Optional
-
Override the API version used for API requests made by this command.
- Type: string
- -f | --definitionfile DEFINITIONFILE
- Optional
-
Creates a scratch definition file based on the specified source org. This name must end in scratch-def.json. If you specify a name that doesn’t end in scratch-def.json, we’ll append it. The file is generated in the config directory.
- Type: string
force:org:shape:delete (Beta)
Help for force:org:shape:delete
Examples:
1$ sfdx force:org:shape:delete -u me@my.org1$ sfdx force:org:shape:delete -u MyOrgAlias -p1$ sfdx force:org:shape:delete -u me@my.org --json1$ sfdx force:org:shape:delete -u me@my.org -p --json > tmp/MyOrgShapeDelete.jsonCommand Syntax
- sfdx force:org:shape:delete
- [--json]
- [--loglevel LOGLEVEL]
- [-u TARGETUSERNAME]
- [--apiversion APIVERSION]
- [-p]
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
- -u | --targetusername TARGETUSERNAME
- Optional
-
A username or alias for the target org. Overrides the default target org.
- Type: string
- --apiversion APIVERSION
- Optional
-
Override the API version used for API requests made by this command.
- Type: string
- -p | --noprompt
- Optional
-
Do not prompt for confirmation.
- Type: boolean
force:org:shape:list (Beta)
Help for force:org:shape:list
Examples:
1$ sfdx force:org:shape:list1$ sfdx force:org:shape:list --json1$ sfdx force:org:shape:list --json > tmp/MyOrgShapeList.jsonCommand Syntax
- sfdx force:org:shape:list
- [--json]
- [--loglevel LOGLEVEL]
- [--verbose]
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
- --verbose
- Optional
-
Lists more information about each org shape.
- Type: boolean
force:org:snapshot:create (Pilot)
Help for force:org:snapshot:create
A snapshot is a point-in-time export of a scratch org. The export is stored in Salesforce and referenced by its unique name in a scratch definition file.
Use "sfdx force:org:snapshot:get" to get details, including status, about a snapshot creation request.
With "snapshot" in your scratch org definition file, use "sfdx force:org:create" to create a scratch org from a snapshot.
Examples:
1$ sfdx force:org:snapshot:create --sourceorg 00Dxx0000000000 --snapshotname Dependencies --description "Contains PackageA v1.1.0"1$ sfdx force:org:snapshot:create -o myuser@myorg -n NightlyBranch -d "Contains PkgA v2.1.0 and PkgB 3.3.0"Command Syntax
- sfdx force:org:snapshot:create
- [--json]
- [--loglevel LOGLEVEL]
- [-v TARGETDEVHUBUSERNAME]
- [--apiversion APIVERSION]
- -o SOURCEORG
- -n SNAPSHOTNAME
- [-d DESCRIPTION]
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
- -v | --targetdevhubusername TARGETDEVHUBUSERNAME
- Optional
-
A username or alias for the target Dev Hub org. Overrides the default Dev Hub org.
- Type: string
- --apiversion APIVERSION
- Optional
-
Override the API version used for API requests made by this command.
- Type: string
- -o | --sourceorg SOURCEORG
- Required
-
The org ID, or a locally authenticated username or alias, of the scratch org to snapshot.
- Type: string
- -n | --snapshotname SNAPSHOTNAME
- Required
-
The unique name of the snapshot. Use this name to create scratch orgs from the snapshot.
- Type: string
- -d | --description DESCRIPTION
- Optional
-
A description of the snapshot. Use this description to document the contents of the snapshot. We suggest that you include a reference point, such as a version control system tag or commit ID.
- Type: string
force:org:snapshot:delete (Pilot)
Help for force:org:snapshot:delete
Examples:
1$ sfdx force:org:snapshot:delete --snapshot 0Oo...1$ sfdx force:org:snapshot:delete -s BaseSnapshotCommand Syntax
- sfdx force:org:snapshot:delete
- [--json]
- [--loglevel LOGLEVEL]
- [-v TARGETDEVHUBUSERNAME]
- [--apiversion APIVERSION]
- -s SNAPSHOT
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
- -v | --targetdevhubusername TARGETDEVHUBUSERNAME
- Optional
-
A username or alias for the target Dev Hub org. Overrides the default Dev Hub org.
- Type: string
- --apiversion APIVERSION
- Optional
-
Override the API version used for API requests made by this command.
- Type: string
- -s | --snapshot SNAPSHOT
- Required
-
The name or ID (starts with 0Oo) of the snapshot to delete.
- Type: string
force:org:snapshot:get (Pilot)
Help for force:org:snapshot:get
Use "sfdx force:org:snapshot:create" to create a snapshot.
Use "sfdx force:org:snapshot:list" to retrieve all snapshots.
Examples:
1$ sfdx force:org:snapshot:get --snapshot 0Oo...1$ sfdx force:org:snapshot:get -s DependenciesCommand Syntax
- sfdx force:org:snapshot:get
- [--json]
- [--loglevel LOGLEVEL]
- [-v TARGETDEVHUBUSERNAME]
- [--apiversion APIVERSION]
- -s SNAPSHOT
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
- -v | --targetdevhubusername TARGETDEVHUBUSERNAME
- Optional
-
A username or alias for the target Dev Hub org. Overrides the default Dev Hub org.
- Type: string
- --apiversion APIVERSION
- Optional
-
Override the API version used for API requests made by this command.
- Type: string
- -s | --snapshot SNAPSHOT
- Required
-
The name or ID (starts with 0Oo) of the snapshot to retrieve.
- Type: string
force:org:snapshot:list (Pilot)
Help for force:org:snapshot:list
Use "sfdx force:org:snapshot:get" to get details about a snapshot request.
Use "sfdx force:org:snapshot:create" to create a snapshot.
Examples:
1$ sfdx force:org:snapshot:list1$ sfdx force:org:snapshot:list -v OtherDevHub@example.comCommand Syntax
- sfdx force:org:snapshot:list
- [--json]
- [--loglevel LOGLEVEL]
- [-v TARGETDEVHUBUSERNAME]
- [--apiversion APIVERSION]
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
- -v | --targetdevhubusername TARGETDEVHUBUSERNAME
- Optional
-
A username or alias for the target Dev Hub org. Overrides the default Dev Hub org.
- Type: string
- --apiversion APIVERSION
- Optional
-
Override the API version used for API requests made by this command.
- Type: string
force:org:status
Help for force:org:status
Use this command to check the status of your sandbox org creation and, if the org is ready, authenticate to the org.
To specify the number of minutes that the command will wait for the sandbox org creation to complete before returning control of the terminal to you, include a -w | --wait value.
Examples:
1$ sfdx force:org:status -n YourSandboxName -w 10Command Syntax
- sfdx force:org:status
- [--json]
- [--loglevel LOGLEVEL]
- [-u TARGETUSERNAME]
- [--apiversion APIVERSION]
- -n SANDBOXNAME
- [-s]
- [-a SETALIAS]
- [-w WAIT]
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
- -u | --targetusername TARGETUSERNAME
- Optional
-
A username or alias for the target org. Overrides the default target org.
- Type: string
- --apiversion APIVERSION
- Optional
-
Override the API version used for API requests made by this command.
- Type: string
- -n | --sandboxname SANDBOXNAME
- Required
-
The name of the sandbox org whose creation status you want to check.
- Type: string
- -s | --setdefaultusername
- Optional
-
Sets the created org as the default username.
- Type: boolean
- -a | --setalias SETALIAS
- Optional
-
An alias for the created org.
- Type: string
- -w | --wait WAIT
- Optional
-
The number of minutes to wait for the org to be ready while polling for its creation status.
- Type: minutes
- Default value: 6 minutes