org Commands | Salesforce CLI Command Reference

force:org:clone (Beta)

Clones a sandbox org using values specified in a configuration file or key=value pairs that you specify on the command line. Values specified on the command line override values in the configuration file.

This release contains a beta version of the force:org:clone command, which means it’s a high-quality feature with known limitations. The the force:org:clone command isn’t generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. We can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features. You can provide feedback and suggestions for the force:org:clone command in the Salesforce DX group in the Trailblazer Community.

Note

Command 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

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 MyDevSandbox

1$ sfdx force:org:clone -t sandbox sandboxName=DevSbx1 sourceSandboxName=Sbx2Clone -u prodOrg -a MyDevSandbox

force:org:create

Creates a scratch org or a sandbox org using the values specified in a configuration file or key=value pairs that you specify on the command line. Values specified on the command line override values in the configuration file. This release contains a beta version of the sandbox CLI operations, which means it’s a high-quality feature with known limitations.

Command 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. The creation of sandbox orgs is available as a beta release.; 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

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 MyScratchOrg

1$ sfdx force:org:create edition=Developer -a MyScratchOrg -s -v devHub

1$ sfdx force:org:create -f config/enterprise-scratch-def.json -a ScratchOrgWithOverrides username=testuser1@mycompany.org

1$ sfdx force:org:create -t sandbox -f config/dev-sandbox-def.json -a MyDevSandbox -u prodOrg

force:org:delete

Marks a scratch or sandbox org for deletion.

Command 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

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.org

1$ sfdx force:org:delete -u MyOrgAlias -p

force:org:display

Gets the description for the current or target org.

Command 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

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:display

1$ sfdx force:org:display -u me@my.org

1$ sfdx force:org:display -u TestOrg1 --json

1$ sfdx force:org:display -u TestOrg1 --json > tmp/MyOrgDesc.json

force:org:list

Lists all orgs that the Salesforce CLI has created or authenticated to.

Command 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

Help for force:org:list

Examples:

1$ sfdx force:org:list

1$ sfdx force:org:list --verbose --json

1$ sfdx force:org:list --verbose --json > tmp/MyOrgList.json

force:org:open

Opens an org in your browser.

Command 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

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:open

1$ sfdx force:org:open -u me@my.org

1$ sfdx force:org:open -u MyTestOrg1

1$ sfdx force:org:open -r -p lightning

force:org:shape:create (Pilot)

Create a scratch org configuration (shape) based on the specified source org.

We provide the force:org:shape:create command to selected customers through an invitation-only pilot program that requires agreement to specific terms and conditions. Pilot programs are subject to change, and we can’t guarantee acceptance. The force:org:shape:create command isn’t generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. We can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features. You can provide feedback and suggestions for the force:org:shape:create command in the W19 Pilot: Org Shape for Scratch Orgs group in the Trailblazer Community.

Note

Command 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

Help for force:org:shape:create

Examples:

1$ sfdx force:org:shape:create -u me@my.org

1$ sfdx force:org:shape:create -u me@my.org --json --loglevel debug

force:org:shape:delete (Pilot)

Deletes all org shapes that you’ve created for an org using the Salesforce CLI.

We provide the force:org:shape:delete command to selected customers through an invitation-only pilot program that requires agreement to specific terms and conditions. Pilot programs are subject to change, and we can’t guarantee acceptance. The force:org:shape:delete command isn’t generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. We can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features. You can provide feedback and suggestions for the force:org:shape:delete command in the W19 Pilot: Org Shape for Scratch Orgs group in the Trailblazer Community.

Note

Command 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

Help for force:org:shape:delete

Examples:

1$ sfdx force:org:shape:delete -u me@my.org

1$ sfdx force:org:shape:delete -u MyOrgAlias -p

1$ sfdx force:org:shape:delete -u me@my.org --json

1$ sfdx force:org:shape:delete -u me@my.org -p --json > tmp/MyOrgShapeDelete.json

force:org:shape:list (Pilot)

Lists all org shapes that you’ve created using the Salesforce CLI.

We provide the force:org:shape:list command to selected customers through an invitation-only pilot program that requires agreement to specific terms and conditions. Pilot programs are subject to change, and we can’t guarantee acceptance. The force:org:shape:list command isn’t generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. We can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features. You can provide feedback and suggestions for the force:org:shape:list command in the W19 Pilot: Org Shape for Scratch Orgs group in the Trailblazer Community.

Note

Command 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

Help for force:org:shape:list

Examples:

1$ sfdx force:org:shape:list

1$ sfdx force:org:shape:list --json

1$ sfdx force:org:shape:list --json > tmp/MyOrgShapeList.json

force:org:snapshot:create (Pilot)

Creates a snapshot of a scratch org.

We provide the force:org:snapshot:create command to selected customers through an invitation-only pilot program that requires agreement to specific terms and conditions. Pilot programs are subject to change, and we can’t guarantee acceptance. The force:org:snapshot:create command isn’t generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. We can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features. You can provide feedback and suggestions for the force:org:snapshot:create command in the W19 Pilot: Scratch Org Snapshots group in the Trailblazer Community.

Note

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

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"

force:org:snapshot:delete (Pilot)

Deletes a scratch org snapshot.

We provide the force:org:snapshot:delete command to selected customers through an invitation-only pilot program that requires agreement to specific terms and conditions. Pilot programs are subject to change, and we can’t guarantee acceptance. The force:org:snapshot:delete command isn’t generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. We can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features. You can provide feedback and suggestions for the force:org:snapshot:delete command in the W19 Pilot: Scratch Org Snapshots group in the Trailblazer Community.

Note

Command 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

Help for force:org:snapshot:delete

Examples:

1$ sfdx force:org:snapshot:delete --snapshot 0Oo...

1$ sfdx force:org:snapshot:delete -s BaseSnapshot

force:org:snapshot:get (Pilot)

Retrieves details about a scratch org snapshot.

We provide the force:org:snapshot:get command to selected customers through an invitation-only pilot program that requires agreement to specific terms and conditions. Pilot programs are subject to change, and we can’t guarantee acceptance. The force:org:snapshot:get command isn’t generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. We can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features. You can provide feedback and suggestions for the force:org:snapshot:get command in the W19 Pilot: Scratch Org Snapshots group in the Trailblazer Community.

Note

Command 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

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 Dependencies

force:org:snapshot:list (Pilot)

Lists scratch org snapshots for your Dev Hub.

We provide the force:org:snapshot:list command to selected customers through an invitation-only pilot program that requires agreement to specific terms and conditions. Pilot programs are subject to change, and we can’t guarantee acceptance. The force:org:snapshot:list command isn’t generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. We can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features. You can provide feedback and suggestions for the force:org:snapshot:list command in the W19 Pilot: Scratch Org Snapshots group in the Trailblazer Community.

Note

Command 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

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:list

1$ sfdx force:org:snapshot:list -v OtherDevHub@example.com

force:org:status (Beta)

Reports sandbox org creation status. If the org is ready, authenticates to the org.

This release contains a beta version of the force:org:status command, which means it’s a high-quality feature with known limitations. The the force:org:status command isn’t generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. We can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features. You can provide feedback and suggestions for the force:org:status command in the Salesforce DX group in the Trailblazer Community.

Note

Command 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

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 10