org Commands | Salesforce CLI Command Reference

org:create

Creates a scratch 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.

Command Syntax

sfdx force:org:create: [-f DEFINITIONFILE]; [-n]; [-c]; [-i CLIENTID]; [-s]; [-a SETALIAS]; [-w WAIT]; [-d DURATIONDAYS]; [-v TARGETDEVHUBUSERNAME]; [--json]; [--loglevel LOGLEVEL]

Parameters

-f | --definitionfile DEFINITIONFILE: Optional; Path to a scratch org definition file. Either --definitionfile or --definitionjson is required.; Type: filepath
-n | --nonamespace: Optional; Creates the scratch org with no namespace. Useful when using a scratch org to test installations of packages with namespaces.; Type: flag
-c | --noancestors: Optional; Do not include second-generation package ancestors in the scratch org.; Type: flag
-i | --clientid CLIENTID: Optional; Connected app consumer key, as configured in your Dev Hub.; Type: string
-s | --setdefaultusername: Optional; Sets the created org as the default username.; Type: flag
-a | --setalias SETALIAS: Optional; Sets an alias for for the created scratch 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
-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
-v | --targetdevhubusername TARGETDEVHUBUSERNAME: Optional; A username or alias for the target Dev Hub org. Overrides the default Dev Hub org.; Type: string
--json: Optional; Format output as JSON.; Type: flag
--loglevel LOGLEVEL: Optional; The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.; Type: string; Permissible values are: trace, debug, info, warn, error, fatal; Default value: error

Help for org:create

To set up a connected app for your new scratch org, specify the value that was returned when you created a connected app in your Dev Hub org as --clientid.

Examples:

1$ sfdx force:org:create -f config/enterprise-scratch-def.json -a TestOrg1

1$ sfdx force:org:create -a MyDevOrg -s -v me@myhub.org edition=Developer

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

org:delete

Marks a scratch org for deletion.

Command Syntax

sfdx force:org:delete: [-p]; -u TARGETUSERNAME; [-v TARGETDEVHUBUSERNAME]; [--json]; [--loglevel LOGLEVEL]

Parameters

-p | --noprompt: Optional; No prompt to confirm deletion.; Type: flag
-u | --targetusername TARGETUSERNAME: Required; A username or alias for the target org.; Type: string
-v | --targetdevhubusername TARGETDEVHUBUSERNAME: Optional; A username or alias for the target Dev Hub org. Overrides the default Dev Hub org.; Type: string
--json: Optional; Format output as JSON.; Type: flag
--loglevel LOGLEVEL: Optional; The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.; Type: string; Permissible values are: trace, debug, info, warn, error, fatal; Default value: error

Help for 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

org:display

Gets the description for the current or target org.

Command Syntax

sfdx force:org:display: [-u TARGETUSERNAME]; [--json]; [--loglevel LOGLEVEL]; [--verbose]

Parameters

-u | --targetusername TARGETUSERNAME: Optional; A username or alias for the target org. Overrides the default target org.; Type: string
--json: Optional; Format output as JSON.; Type: flag
--loglevel LOGLEVEL: Optional; The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.; Type: string; Permissible values are: trace, debug, info, warn, error, fatal; Default value: error
--verbose: Optional; Emit additional command output to stdout.; Type: flag

Help for 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

org:list

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

Command Syntax

sfdx force:org:list: [--all]; [--clean]; [-p]; [--json]; [--loglevel LOGLEVEL]

Parameters

--all: Optional; Lists all authenticated orgs, including expired, deleted, and unknown-status scratch orgs.; Type: flag
--clean: Optional; Remove all local org authorizations for deleted or expired orgs.; Type: flag
-p | --noprompt: Optional; Do not prompt for confirmation.; Type: flag
--json: Optional; Format output as JSON.; Type: flag
--loglevel LOGLEVEL: Optional; The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.; Type: string; Permissible values are: trace, debug, info, warn, error, fatal; Default value: error

Help for 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

org:open

Opens an org in your browser.

Command Syntax

sfdx force:org:open: [-p PATH]; [-r]; [-u TARGETUSERNAME]; [--json]; [--loglevel LOGLEVEL]

Parameters

-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: flag
-u | --targetusername TARGETUSERNAME: Optional; A username or alias for the target org. Overrides the default target org.; Type: string
--json: Optional; Format output as JSON.; Type: flag
--loglevel LOGLEVEL: Optional; The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.; Type: string; Permissible values are: trace, debug, info, warn, error, fatal; Default value: error

Help for 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

org:shape:create (Pilot)

Creates a snapshot of org edition, features, and licenses to use for scratch org creation, allowing your scratch org to look like another org for testing.

We provide the org:shape:create command to selected customers through a pilot program that requires agreement to specific terms and conditions. Pilot programs are subject to change, and we can’t guarantee acceptance. The 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.

Note

Command Syntax

sfdx force:org:shape:create: [-u TARGETUSERNAME]; [--json]; [--loglevel LOGLEVEL]

Parameters

-u | --targetusername TARGETUSERNAME: Optional; A username or alias for the target org. Overrides the default target org.; Type: string
--json: Optional; Format output as JSON.; Type: flag
--loglevel LOGLEVEL: Optional; The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.; Type: string; Permissible values are: trace, debug, info, warn, error, fatal; Default value: error

Help for 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

org:shape:delete (Pilot)

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

We provide the org:shape:delete command to selected customers through a pilot program that requires agreement to specific terms and conditions. Pilot programs are subject to change, and we can’t guarantee acceptance. The 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.

Note

Command Syntax

sfdx force:org:shape:delete: [-p]; -u TARGETUSERNAME; [--json]; [--loglevel LOGLEVEL]

Parameters

-p | --noprompt: Optional; Do not prompt for confirmation.; Type: flag
-u | --targetusername TARGETUSERNAME: Required; Username for the target org.; Type: string
--json: Optional; Format output as JSON.; Type: flag
--loglevel LOGLEVEL: Optional; The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.; Type: string; Permissible values are: trace, debug, info, warn, error, fatal; Default value: error

Help for 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

org:shape:list (Pilot)

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

We provide the org:shape:list command to selected customers through a pilot program that requires agreement to specific terms and conditions. Pilot programs are subject to change, and we can’t guarantee acceptance. The 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.

Note

Command Syntax

sfdx force:org:shape:list: [--json]; [--loglevel LOGLEVEL]

Parameters

--json: Optional; Format output as JSON.; Type: flag
--loglevel LOGLEVEL: Optional; The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.; Type: string; Permissible values are: trace, debug, info, warn, error, fatal; Default value: error

Help for 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