There are two ways to create a sandbox org: specify a definition file that contains the sandbox options or use the –name and –license-type flags to specify the two required options. If you want to set an option other than name or license type, such as apexClassId, you must use a definition file.
You can also use this command to clone an existing sandbox. Use the –source-sandbox-name flag to specify the existing sandbox name and the –name flag to the name of the new sandbox.
Aliases for org create sandbox
env:create:sandbox
Flags
Flag Name (Long)
Flag Name (Short)
Description
‑‑alias
‑a
Type: Value
Alias for the sandbox org.
When you create a sandbox, the generated usernames are based on the usernames present in the production org. To ensure uniqueness, the new usernames are appended with the name of the sandbox. For example, the username “user@example.com” in the production org results in the username “user@example.com.mysandbox” in a sandbox named “mysandbox”. When you set an alias for a sandbox org, it’s assigned to the resulting username of the user running this command.
‑‑async
N/A
Type: Boolean
Request the sandbox creation, but don’t wait for it to complete.
The command immediately displays the job ID and returns control of the terminal to you. This way, you can continue to use the CLI. To check the status of the sandbox creation, run “sf org resume sandbox”.
Type: Value Valid Values:Developer, Developer_Pro, Partial, Full
Type of sandbox license.
‑‑name
‑n
Type: Value
Name of the sandbox org.
The name must be a unique alphanumeric string (10 or fewer characters) to identify the sandbox. You can’t reuse a name while a sandbox is in the process of being deleted.
‑‑no‑prompt
N/A
Type: Boolean
Don’t prompt for confirmation about the sandbox configuration.
‑‑no‑track‑source
N/A
Type: Boolean
Do not use source tracking for this sandbox.
We recommend you enable source tracking in Developer and Developer Pro sandbox, which is why it’s the default behavior. Source tracking allows you to track the changes you make to your metadata, both in your local project and in the sandbox, and to detect any conflicts between the two.
To disable source tracking in the new sandbox, specify the –no-track-source flag. The main reason to disable source tracking is for performance. For example, while you probably want to deploy metadata and run Apex tests in your CI/CD jobs, you probably don’t want to incur the costs of source tracking (checking for conflicts, polling the SourceMember object, various file system operations.) This is a good use case for disabling source tracking in the sandbox.
‑‑poll‑interval
‑i
Type: Value Default value:30 seconds
Number of seconds to wait between retries.
‑‑set‑default
‑s
Type: Boolean
Set the sandbox org as your default org.
‑‑source‑id
N/A
Type: Value
ID of the sandbox org to clone.
The value of –source-id must be an existing sandbox (SandboxInfo.Id). The existing sandbox, and the new sandbox specified with the –name flag, must both be associated with the production org (–target-org) that contains the sandbox licenses.
You can specify either –source-sandbox-name or –source-id when cloning an existing sandbox, but not both.
‑‑source‑sandbox‑name
N/A
Type: Value
Name of the sandbox org to clone.
The value of –source-sandbox-name must be an existing sandbox. The existing sandbox, and the new sandbox specified with the –name flag, must both be associated with the production org (–target-org) that contains the sandbox licenses.
You can specify either –source-sandbox-name or –source-id when cloning an existing sandbox, but not both.
‑‑target‑org
‑o
Type: Value Required
Username or alias of the production org that contains the sandbox license.
When it creates the sandbox org, Salesforce copies the metadata, and optionally data, from your production org to the new sandbox org.
‑‑wait
‑w
Type: Value Default value:30 minutes
Number of minutes to wait for the sandbox org to be ready.
If the command continues to run after the wait period, the CLI returns control of the terminal to you and displays the “sf org resume sandbox” command you run to check the status of the create. The displayed command includes the job ID for the running sandbox creation.
Examples for org create sandbox
Create a sandbox org using a definition file and give it the alias “MyDevSandbox”. The production org that contains the sandbox license has the alias “prodOrg”.
Create a sandbox org by directly specifying its name and type of license (Developer) instead of using a definition file. Set the sandbox org as your default.
Clone the existing sandbox with name “ExistingSandbox” and name the new sandbox “NewClonedSandbox”. Set the new sandbox as your default org. Wait for 30 minutes for the sandbox creation to complete.
j