This command lists sandboxes and their statuses from the specified production org. You can filter the results by sandbox name and status.
Availability
✅
❌
From
September 24
-v, --targetdevhubusername=<value>
No
Username or alias of the production org
-n, --name=<value>
No
Filter results by sandbox name (max 10 characters)
-s, --status=<value>
No
Filter results by sandbox status
--json
No
Format output as JSON
--loglevel=<option>
No
Logging level for this command invocation
Available status options: 'Pending', 'Processing', 'Completed', 'Deleted', 'Deleting', 'Discarding', 'Locked', 'Locking', 'Sampling', 'Stopped', 'Suspended', 'Activating'
This command updates the configuration of an existing sandbox or refreshes it.
Availability
✅
❌
From
August 24
-v, --targetdevhubusername=<value>
No
Username or alias of the production org
-n, --name=<value>
Yes (if no definition file)
Name of the sandbox to update
-f, --definition-file=<value>
No
Path to a sandbox definition file
--json
No
Format output as JSON
--loglevel=<option>
No
Logging level for this command invocation
If using a definition file, create a JSON file (default location: config/sandbox-def.json) with the following structure:
Note: When using a definition file, the --name flag is ignored.
Delete one or more Salesforce sandbox orgs.
Availability
✅
❌
From
August 24
-v, --targetdevhubusername=<value>
No
Username or alias of the production org
-n, --name=<value>
Yes
Comma-separated list of sandbox names to delete
--json
No
Format output as JSON
--loglevel=<option>
No
Logging level for this command invocation
This command logs in to a specified sandbox org using the authentication details of the user who requested the creation of sandbox
Availability
✅
❌
From
August 24
-v, --targetdevhubusername=<value>
No
Username or alias of the production org
-n, --name=<value>
Yes
Name of the sandbox to log in to (max 10 characters)
-a, --alias=<value>
No
Alias to set for the authenticated sandbox org
-w, --write-file
No
Write login details to a file (org-info.json)
--json
No
Format output as JSON
--loglevel=<option>
No
Logging level for this command invocation
Create a new Salesforce sandbox org.
This command creates a new sandbox org from a source org (production or another sandbox). You can specify the sandbox configuration using command-line options or a definition file.
If using a definition file, create a JSON file (default location: config/sandbox-def.json) with the following structure:
Note: When using a definition file, the --name and --sourcesandbox flags are ignored.
Availability
✅
❌
From
August 24
-v, --targetdevhubusername=<value>
No
Username or alias of the production org
-n, --name=<value>
Yes (if no definition file)
Name of the sandbox to create
-s, --sourcesandbox=<value>
No
Name of the source sandbox to clone
-f, --definition-file=<value>
No
Path to a sandbox definition file
-d, --description=<value>
No
Description of the sandbox
--json
No
Format output as JSON
--loglevel=<option>
No
Logging level for this command invocation