@salesforce/plugin-org 2.2.24 → 2.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -0
- package/lib/commands/force/org/clone.d.ts +21 -9
- package/lib/commands/force/org/clone.js +52 -83
- package/lib/commands/force/org/clone.js.map +1 -1
- package/lib/commands/force/org/create.d.ts +27 -12
- package/lib/commands/force/org/create.js +87 -106
- package/lib/commands/force/org/create.js.map +1 -1
- package/lib/commands/force/org/delete.d.ts +14 -7
- package/lib/commands/force/org/delete.js +26 -16
- package/lib/commands/force/org/delete.js.map +1 -1
- package/lib/commands/force/org/status.d.ts +18 -6
- package/lib/commands/force/org/status.js +43 -37
- package/lib/commands/force/org/status.js.map +1 -1
- package/lib/commands/org/create/sandbox.d.ts +40 -0
- package/lib/commands/org/create/sandbox.js +245 -0
- package/lib/commands/org/create/sandbox.js.map +1 -0
- package/lib/commands/org/create/scratch.d.ts +30 -0
- package/lib/commands/org/create/scratch.js +183 -0
- package/lib/commands/org/create/scratch.js.map +1 -0
- package/lib/commands/org/delete/sandbox.d.ts +18 -0
- package/lib/commands/org/delete/sandbox.js +59 -0
- package/lib/commands/org/delete/sandbox.js.map +1 -0
- package/lib/commands/org/delete/scratch.d.ts +18 -0
- package/lib/commands/org/delete/scratch.js +52 -0
- package/lib/commands/org/delete/scratch.js.map +1 -0
- package/lib/commands/org/display.d.ts +20 -0
- package/lib/commands/{force/org → org}/display.js +38 -27
- package/lib/commands/org/display.js.map +1 -0
- package/lib/commands/org/list.d.ts +26 -0
- package/lib/commands/org/list.js +192 -0
- package/lib/commands/org/list.js.map +1 -0
- package/lib/commands/org/open.d.ts +25 -0
- package/lib/commands/{force/org → org}/open.js +47 -33
- package/lib/commands/org/open.js.map +1 -0
- package/lib/commands/org/resume/sandbox.d.ts +26 -0
- package/lib/commands/org/resume/sandbox.js +199 -0
- package/lib/commands/org/resume/sandbox.js.map +1 -0
- package/lib/commands/org/resume/scratch.d.ts +14 -0
- package/lib/commands/org/resume/scratch.js +61 -0
- package/lib/commands/org/resume/scratch.js.map +1 -0
- package/lib/shared/orgHighlighter.d.ts +2 -2
- package/lib/shared/orgHighlighter.js +7 -5
- package/lib/shared/orgHighlighter.js.map +1 -1
- package/lib/shared/orgHooks.d.ts +24 -0
- package/lib/shared/orgHooks.js +9 -0
- package/lib/shared/orgHooks.js.map +1 -0
- package/lib/shared/orgListUtil.d.ts +15 -25
- package/lib/shared/orgListUtil.js +71 -81
- package/lib/shared/orgListUtil.js.map +1 -1
- package/lib/shared/orgTypes.d.ts +39 -11
- package/lib/shared/sandboxCommandBase.d.ts +33 -0
- package/lib/shared/sandboxCommandBase.js +168 -0
- package/lib/shared/sandboxCommandBase.js.map +1 -0
- package/lib/shared/sandboxProgress.d.ts +28 -0
- package/lib/shared/sandboxProgress.js +104 -0
- package/lib/shared/sandboxProgress.js.map +1 -0
- package/lib/shared/sandboxReporter.d.ts +1 -1
- package/lib/shared/sandboxRequest.d.ts +9 -0
- package/lib/shared/sandboxRequest.js +58 -0
- package/lib/shared/sandboxRequest.js.map +1 -0
- package/lib/shared/scratchOrgOutput.d.ts +9 -0
- package/lib/shared/scratchOrgOutput.js +47 -0
- package/lib/shared/scratchOrgOutput.js.map +1 -0
- package/lib/shared/stagedProgress.d.ts +33 -0
- package/lib/shared/stagedProgress.js +98 -0
- package/lib/shared/stagedProgress.js.map +1 -0
- package/lib/shared/timeUtils.d.ts +10 -0
- package/lib/shared/timeUtils.js +37 -0
- package/lib/shared/timeUtils.js.map +1 -0
- package/lib/shared/utils.d.ts +1 -1
- package/lib/shared/utils.js.map +1 -1
- package/messages/clone.md +67 -0
- package/messages/create.md +125 -0
- package/messages/create.sandbox.md +123 -0
- package/messages/create_scratch.md +109 -0
- package/messages/delete.md +47 -0
- package/messages/delete_sandbox.md +46 -0
- package/messages/delete_scratch.md +42 -0
- package/messages/display.md +33 -0
- package/messages/list.md +65 -0
- package/messages/messages.md +81 -0
- package/messages/open.md +63 -0
- package/messages/resume.sandbox.md +71 -0
- package/messages/resume_scratch.md +41 -0
- package/messages/sandboxbase.md +17 -0
- package/messages/status.md +33 -0
- package/oclif.manifest.json +1191 -1
- package/package.json +136 -26
- package/lib/commands/force/org/display.d.ts +0 -11
- package/lib/commands/force/org/display.js.map +0 -1
- package/lib/commands/force/org/list.d.ts +0 -15
- package/lib/commands/force/org/list.js +0 -191
- package/lib/commands/force/org/list.js.map +0 -1
- package/lib/commands/force/org/open.d.ts +0 -15
- package/lib/commands/force/org/open.js.map +0 -1
- package/messages/clone.json +0 -24
- package/messages/create.json +0 -37
- package/messages/delete.json +0 -13
- package/messages/display.json +0 -11
- package/messages/list.json +0 -19
- package/messages/messages.json +0 -24
- package/messages/open.json +0 -19
- package/messages/status.json +0 -13
package/oclif.manifest.json
CHANGED
|
@@ -1 +1,1191 @@
|
|
|
1
|
-
{"version":"2.2.24","commands":{"force:org:clone":{"id":"force:org:clone","description":"clone a sandbox org\nThere are two ways to clone a sandbox: either specify a sandbox definition file or provide key=value pairs at the command line. Key-value pairs at the command-line override their equivalent sandbox definition file values. In either case, you must specify both the \"SandboxName\" and \"SourceSandboxName\" options to set the names of the new sandbox and the one being cloned, respectively. \n\nSet the --targetusername (-u) parameter to a production org with sandbox licenses. The --type (-t) parameter is required and must be set to \"sandbox\".","strict":true,"usage":"<%= command.id %> [name=value...] -t sandbox [-f <filepath>] [-s] [-a <string>] [-w <minutes>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-org","pluginAlias":"@salesforce/plugin-org","pluginType":"core","aliases":[],"examples":["$ sfdx force:org:clone -t sandbox -f config/dev-sandbox-def.json -u prodOrg -a MyDevSandbox","$ sfdx force:org:clone -t sandbox SandboxName=NewClonedSandbox SourceSandboxName=ExistingSandbox -u prodOrg -a MyDevSandbox"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"type":{"name":"type","type":"option","char":"t","description":"type of org to create","required":true,"helpValue":"(sandbox)","multiple":false,"options":["sandbox"]},"definitionfile":{"name":"definitionfile","type":"option","char":"f","description":"path to the sandbox definition file","multiple":false},"setdefaultusername":{"name":"setdefaultusername","type":"boolean","char":"s","description":"set the cloned org as your default","allowNo":false},"setalias":{"name":"setalias","type":"option","char":"a","description":"alias for the cloned org","multiple":false},"wait":{"name":"wait","type":"option","char":"w","description":"number of minutes to wait while polling for status","multiple":false,"default":{"quantity":6,"unit":0}}},"args":[],"requiresProject":false,"requiresUsername":true,"varargs":true,"SANDBOXDEF_SRC_SANDBOXNAME":"SourceSandboxName","flagsConfig":{"type":{"kind":"enum","helpValue":"(sandbox)","char":"t","description":"type of org to create","required":true,"options":["sandbox"],"input":[],"multiple":false,"type":"option"},"definitionfile":{"kind":"filepath","char":"f","description":"path to the sandbox definition file","input":[],"multiple":false,"type":"option"},"setdefaultusername":{"kind":"boolean","char":"s","description":"set the cloned org as your default","allowNo":false,"type":"boolean"},"setalias":{"kind":"string","char":"a","description":"alias for the cloned org","input":[],"multiple":false,"type":"option"},"wait":{"kind":"minutes","char":"w","description":"number of minutes to wait while polling for status","longDescription":"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.","min":{"quantity":2,"unit":0},"default":{"quantity":6,"unit":0},"input":[],"multiple":false,"type":"option"}}},"force:org:create":{"id":"force:org:create","description":"create a scratch or sandbox org \nCreates 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. 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.\n\n","strict":true,"usage":"<%= command.id %> [name=value...] [-t scratch|sandbox] [-f <filepath>] [-n] [-c] [-i <string>] [-s] [-a <string>] [-w <minutes>] [-d <integer>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-org","pluginAlias":"@salesforce/plugin-org","pluginType":"core","aliases":["force:org:beta:create"],"examples":["$ sfdx force:org:create -f config/enterprise-scratch-def.json -a MyScratchOrg","$ sfdx force:org:create edition=Developer -a MyScratchOrg -s -v devHub","$ sfdx force:org:create -f config/enterprise-scratch-def.json -a ScratchOrgWithOverrides username=testuser1@mycompany.org","$ sfdx force:org:create -t sandbox -f config/dev-sandbox-def.json -a MyDevSandbox -u prodOrg"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetdevhubusername":{"name":"targetdevhubusername","type":"option","char":"v","description":"username or alias for the dev hub org; overrides default dev hub org","multiple":false},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"type":{"name":"type","type":"option","char":"t","description":"type of org to create","helpValue":"(scratch|sandbox)","multiple":false,"options":["scratch","sandbox"],"default":"scratch"},"definitionfile":{"name":"definitionfile","type":"option","char":"f","description":"path to an org definition file","multiple":false},"nonamespace":{"name":"nonamespace","type":"boolean","char":"n","description":"create the scratch org with no namespace","allowNo":false},"noancestors":{"name":"noancestors","type":"boolean","char":"c","description":"do not include second-generation package ancestors in the scratch org","allowNo":false},"clientid":{"name":"clientid","type":"option","char":"i","description":"connected app consumer key; not supported for sandbox org creation","multiple":false},"setdefaultusername":{"name":"setdefaultusername","type":"boolean","char":"s","description":"set the created org as the default username","allowNo":false},"setalias":{"name":"setalias","type":"option","char":"a","description":"alias for the created org","multiple":false},"wait":{"name":"wait","type":"option","char":"w","description":"the streaming client socket timeout (in minutes)","multiple":false,"default":{"quantity":6,"unit":0}},"durationdays":{"name":"durationdays","type":"option","char":"d","description":"duration of the scratch org (in days) (default:7, min:1, max:30)","multiple":false,"default":7},"retry":{"name":"retry","type":"option","description":"Number of scratch org auth retries after scratch org is successfully signed up.","hidden":true,"multiple":false,"default":0}},"args":[],"supportsDevhubUsername":true,"supportsUsername":true,"varargs":true,"flagsConfig":{"type":{"kind":"enum","helpValue":"(scratch|sandbox)","char":"t","description":"type of org to create","options":["scratch","sandbox"],"default":"scratch","input":[],"multiple":false,"type":"option"},"definitionfile":{"kind":"filepath","char":"f","description":"path to an org definition file","input":[],"multiple":false,"type":"option"},"nonamespace":{"kind":"boolean","char":"n","description":"create the scratch org with no namespace","allowNo":false,"type":"boolean"},"noancestors":{"kind":"boolean","char":"c","description":"do not include second-generation package ancestors in the scratch org","allowNo":false,"type":"boolean"},"clientid":{"kind":"string","char":"i","description":"connected app consumer key; not supported for sandbox org creation","input":[],"multiple":false,"type":"option"},"setdefaultusername":{"kind":"boolean","char":"s","description":"set the created org as the default username","allowNo":false,"type":"boolean"},"setalias":{"kind":"string","char":"a","description":"alias for the created org","input":[],"multiple":false,"type":"option"},"wait":{"kind":"minutes","char":"w","description":"the streaming client socket timeout (in minutes)","min":6,"default":{"quantity":6,"unit":0},"input":[],"multiple":false,"type":"option"},"durationdays":{"kind":"integer","char":"d","description":"duration of the scratch org (in days) (default:7, min:1, max:30)","min":1,"max":30,"default":7,"input":[],"multiple":false,"type":"option"},"retry":{"kind":"number","hidden":true,"default":0,"max":10,"description":"Number of scratch org auth retries after scratch org is successfully signed up.","input":[],"multiple":false,"type":"option"}}},"force:org:delete":{"id":"force:org:delete","description":"mark a scratch or sandbox org for deletion \nTo mark the org for deletion without being prompted to confirm, specify --noprompt.","strict":true,"usage":"<%= command.id %> [-p] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-org","pluginAlias":"@salesforce/plugin-org","pluginType":"core","aliases":[],"examples":["$ sfdx force:org:delete -u me@my.org","$ sfdx force:org:delete -u MyOrgAlias -p"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetdevhubusername":{"name":"targetdevhubusername","type":"option","char":"v","description":"username or alias for the dev hub org; overrides default dev hub org","multiple":false},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"noprompt":{"name":"noprompt","type":"boolean","char":"p","description":"no prompt to confirm deletion","allowNo":false}},"args":[],"requiresUsername":true,"supportsDevhubUsername":true,"flagsConfig":{"noprompt":{"kind":"boolean","char":"p","description":"no prompt to confirm deletion","allowNo":false,"type":"boolean"}}},"force:org:display":{"id":"force:org:display","description":"get the description for the current or target org\nOutput includes your access token, client Id, connected status, org ID, instance URL, username, and alias, if applicable.\nUse --verbose to include the SFDX auth URL. WARNING: The SFDX auth URL contains sensitive information, such as a refresh token that can be used to access an org. Don't share or distribute this URL or token.\nIncluding --verbose displays the sfdxAuthUrl property only if you authenticated to the org using auth:web:login (not auth:jwt:grant)","strict":true,"usage":"<%= command.id %> [-u <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-org","pluginAlias":"@salesforce/plugin-org","pluginType":"core","aliases":[],"examples":["$ sfdx force:org:display","$ sfdx force:org:display -u me@my.org","$ sfdx force:org:display -u TestOrg1 --json","$ sfdx force:org:display -u TestOrg1 --json > tmp/MyOrgDesc.json"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"verbose":{"name":"verbose","type":"boolean","description":"emit additional command output to stdout","allowNo":false}},"args":[],"requiresUsername":true,"flagsConfig":{"verbose":{"type":"boolean","kind":"boolean","description":"emit additional command output to stdout","longDescription":"Emit additional command output to stdout.","allowNo":false}}},"force:org:list":{"id":"force:org:list","description":"list all orgs you’ve created or authenticated to","strict":true,"usage":"<%= command.id %> [--all] [-p --clean] [--skipconnectionstatus] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-org","pluginAlias":"@salesforce/plugin-org","pluginType":"core","aliases":[],"examples":["$ sfdx force:org:list","$ sfdx force:org:list --verbose --json","$ sfdx force:org:list --verbose --json > tmp/MyOrgList.json"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"verbose":{"name":"verbose","type":"boolean","description":"list more information about each org","allowNo":false},"all":{"name":"all","type":"boolean","description":"include expired, deleted, and unknown-status scratch orgs","allowNo":false},"clean":{"name":"clean","type":"boolean","description":"remove all local org authorizations for non-active scratch orgs. Use auth:logout to remove non-scratch orgs","allowNo":false},"noprompt":{"name":"noprompt","type":"boolean","char":"p","description":"do not prompt for confirmation","allowNo":false,"dependsOn":["clean"]},"skipconnectionstatus":{"name":"skipconnectionstatus","type":"boolean","description":"skip retrieving the connection status of non-scratch orgs","allowNo":false}},"args":[],"requiresProject":false,"flagsConfig":{"verbose":{"description":"list more information about each org","type":"boolean","kind":"boolean","longDescription":"Emit additional command output to stdout.","allowNo":false},"all":{"kind":"boolean","description":"include expired, deleted, and unknown-status scratch orgs","allowNo":false,"type":"boolean"},"clean":{"kind":"boolean","description":"remove all local org authorizations for non-active scratch orgs. Use auth:logout to remove non-scratch orgs","allowNo":false,"type":"boolean"},"noprompt":{"kind":"boolean","char":"p","description":"do not prompt for confirmation","dependsOn":["clean"],"allowNo":false,"type":"boolean"},"skipconnectionstatus":{"kind":"boolean","description":"skip retrieving the connection status of non-scratch orgs","allowNo":false,"type":"boolean"}}},"force:org:open":{"id":"force:org:open","description":"open your default scratch org, or another specified org\nTo open a specific page, specify the portion of the URL after \"https://MyDomainName.my.salesforce.com/\" as --path.\nFor example, specify \"--path lightning\" to open Lightning Experience, or specify \"--path /apex/YourPage\" to open a Visualforce page.\nTo generate a URL but not launch it in your browser, specify --urlonly.\nTo open in a specific browser, use the --browser parameter. Supported browsers are \"chrome\", \"edge\", and \"firefox\". If you don't specify --browser, the org opens in your default browser.","strict":true,"usage":"<%= command.id %> [-b <string> | -r] [-p <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-org","pluginAlias":"@salesforce/plugin-org","pluginType":"core","aliases":[],"examples":["$ sfdx force:org:open","$ sfdx force:org:open -u me@my.org","$ sfdx force:org:open -u MyTestOrg1","$ sfdx force:org:open -r -p lightning","$ sfdx force:org:open -u me@my.org -b firefox"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"browser":{"name":"browser","type":"option","char":"b","description":"browser where the org opens","multiple":false,"options":["chrome","edge","firefox"],"exclusive":["urlonly"]},"path":{"name":"path","type":"option","char":"p","description":"navigation URL path","multiple":false},"urlonly":{"name":"urlonly","type":"boolean","char":"r","description":"display navigation URL, but don’t launch browser","allowNo":false}},"args":[],"requiresUsername":true,"flagsConfig":{"browser":{"kind":"string","char":"b","description":"browser where the org opens","options":["chrome","edge","firefox"],"exclusive":["urlonly"],"input":[],"multiple":false,"type":"option"},"path":{"kind":"string","char":"p","description":"navigation URL path","env":"FORCE_OPEN_URL","input":[],"multiple":false,"type":"option"},"urlonly":{"kind":"boolean","char":"r","description":"display navigation URL, but don’t launch browser","allowNo":false,"type":"boolean"}}},"force:org:status":{"id":"force:org:status","description":"report status of sandbox creation or clone and authenticate to it\nUse this command to check the status of your sandbox creation or clone and, if the sandbox is ready, authenticate to it.\nUse the --wait (-w) parameter to specify the number of minutes that the command waits for the sandbox creation or clone to complete before returning control of the terminal to you.\nSet the --targetusername (-u) parameter to the username or alias of the production org that contains the sandbox license.","strict":true,"usage":"<%= command.id %> -n <string> [-s] [-a <string>] [-w <minutes>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-org","pluginAlias":"@salesforce/plugin-org","pluginType":"core","aliases":[],"examples":["$ sfdx force:org:status --sandboxname DevSbx1 --setalias MySandbox -u prodOrg","$ sfdx force:org:status --sandboxname DevSbx1 --wait 45 --setdefaultusername -u prodOrg"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"sandboxname":{"name":"sandboxname","type":"option","char":"n","description":"name of the sandbox org to check status for","required":true,"multiple":false},"setdefaultusername":{"name":"setdefaultusername","type":"boolean","char":"s","description":"set the created or cloned org as your default","allowNo":false},"setalias":{"name":"setalias","type":"option","char":"a","description":"alias for the created or cloned org","multiple":false},"wait":{"name":"wait","type":"option","char":"w","description":"number of minutes to wait while polling for status","multiple":false,"default":{"quantity":6,"unit":0}}},"args":[],"requiresProject":false,"requiresUsername":true,"flagsConfig":{"sandboxname":{"kind":"string","char":"n","description":"name of the sandbox org to check status for","required":true,"input":[],"multiple":false,"type":"option"},"setdefaultusername":{"kind":"boolean","char":"s","description":"set the created or cloned org as your default","allowNo":false,"type":"boolean"},"setalias":{"kind":"string","char":"a","description":"alias for the created or cloned org","input":[],"multiple":false,"type":"option"},"wait":{"kind":"minutes","char":"w","description":"number of minutes to wait while polling for status","min":{"quantity":2,"unit":0},"default":{"quantity":6,"unit":0},"input":[],"multiple":false,"type":"option"}}}}}
|
|
1
|
+
{
|
|
2
|
+
"version": "2.3.0",
|
|
3
|
+
"commands": {
|
|
4
|
+
"org:display": {
|
|
5
|
+
"id": "org:display",
|
|
6
|
+
"summary": "Display information about an org.",
|
|
7
|
+
"description": "Output includes your access token, client Id, connected status, org ID, instance URL, username, and alias, if applicable.\n\nUse --verbose to include the SFDX auth URL. WARNING: The SFDX auth URL contains sensitive information, such as a refresh token that can be used to access an org. Don't share or distribute this URL or token.\n\nIncluding --verbose displays the sfdxAuthUrl property only if you authenticated to the org using auth:web:login (not auth:jwt:grant).",
|
|
8
|
+
"strict": true,
|
|
9
|
+
"pluginName": "@salesforce/plugin-org",
|
|
10
|
+
"pluginAlias": "@salesforce/plugin-org",
|
|
11
|
+
"pluginType": "core",
|
|
12
|
+
"aliases": [
|
|
13
|
+
"force:org:display"
|
|
14
|
+
],
|
|
15
|
+
"examples": [
|
|
16
|
+
"Display information about your default org:\n$ <%= config.bin %> <%= command.id %>",
|
|
17
|
+
"Display information, including the sfdxAuthUrl property, about the org with alias TestOrg1:\n$ <%= config.bin %> <%= command.id %> --target-org TestOrg1 --verbose"
|
|
18
|
+
],
|
|
19
|
+
"deprecateAliases": true,
|
|
20
|
+
"flags": {
|
|
21
|
+
"json": {
|
|
22
|
+
"name": "json",
|
|
23
|
+
"type": "boolean",
|
|
24
|
+
"description": "Format output as json.",
|
|
25
|
+
"helpGroup": "GLOBAL",
|
|
26
|
+
"allowNo": false,
|
|
27
|
+
"deprecateAliases": true
|
|
28
|
+
},
|
|
29
|
+
"target-org": {
|
|
30
|
+
"name": "target-org",
|
|
31
|
+
"type": "option",
|
|
32
|
+
"char": "o",
|
|
33
|
+
"summary": "Username or alias of the target org.",
|
|
34
|
+
"required": true,
|
|
35
|
+
"multiple": false,
|
|
36
|
+
"deprecateAliases": true,
|
|
37
|
+
"aliases": [
|
|
38
|
+
"targetusername",
|
|
39
|
+
"u"
|
|
40
|
+
]
|
|
41
|
+
},
|
|
42
|
+
"api-version": {
|
|
43
|
+
"name": "api-version",
|
|
44
|
+
"type": "option",
|
|
45
|
+
"description": "Override the api version used for api requests made by this command",
|
|
46
|
+
"multiple": false,
|
|
47
|
+
"deprecateAliases": true,
|
|
48
|
+
"aliases": [
|
|
49
|
+
"apiversion"
|
|
50
|
+
]
|
|
51
|
+
},
|
|
52
|
+
"verbose": {
|
|
53
|
+
"name": "verbose",
|
|
54
|
+
"type": "boolean",
|
|
55
|
+
"summary": "Display the sfdxAuthUrl property.",
|
|
56
|
+
"allowNo": false,
|
|
57
|
+
"deprecateAliases": true
|
|
58
|
+
},
|
|
59
|
+
"loglevel": {
|
|
60
|
+
"name": "loglevel",
|
|
61
|
+
"type": "option",
|
|
62
|
+
"hidden": true,
|
|
63
|
+
"multiple": false,
|
|
64
|
+
"deprecated": {
|
|
65
|
+
"message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
|
|
66
|
+
},
|
|
67
|
+
"deprecateAliases": true
|
|
68
|
+
}
|
|
69
|
+
},
|
|
70
|
+
"args": {},
|
|
71
|
+
"hasDynamicHelp": true
|
|
72
|
+
},
|
|
73
|
+
"org:list": {
|
|
74
|
+
"id": "org:list",
|
|
75
|
+
"summary": "List all orgs you’ve created or authenticated to.",
|
|
76
|
+
"strict": true,
|
|
77
|
+
"pluginName": "@salesforce/plugin-org",
|
|
78
|
+
"pluginAlias": "@salesforce/plugin-org",
|
|
79
|
+
"pluginType": "core",
|
|
80
|
+
"aliases": [
|
|
81
|
+
"force:org:list"
|
|
82
|
+
],
|
|
83
|
+
"examples": [
|
|
84
|
+
"List all orgs you've created or authenticated to:\n$ <%= config.bin %> <%= command.id %>",
|
|
85
|
+
"List all orgs, including expired, deleted, and unknown-status orgs; don't include the connection status:\n$ <%= config.bin %> <%= command.id %> --skip-connection-status --all",
|
|
86
|
+
"List orgs and remove local org authorization info about non-active scratch orgs:\n$ <%= config.bin %> <%= command.id %> --clean"
|
|
87
|
+
],
|
|
88
|
+
"deprecateAliases": true,
|
|
89
|
+
"flags": {
|
|
90
|
+
"json": {
|
|
91
|
+
"name": "json",
|
|
92
|
+
"type": "boolean",
|
|
93
|
+
"description": "Format output as json.",
|
|
94
|
+
"helpGroup": "GLOBAL",
|
|
95
|
+
"allowNo": false,
|
|
96
|
+
"deprecateAliases": true
|
|
97
|
+
},
|
|
98
|
+
"verbose": {
|
|
99
|
+
"name": "verbose",
|
|
100
|
+
"type": "boolean",
|
|
101
|
+
"summary": "List more information about each org.",
|
|
102
|
+
"allowNo": false,
|
|
103
|
+
"deprecateAliases": true
|
|
104
|
+
},
|
|
105
|
+
"all": {
|
|
106
|
+
"name": "all",
|
|
107
|
+
"type": "boolean",
|
|
108
|
+
"summary": "Include expired, deleted, and unknown-status scratch orgs.",
|
|
109
|
+
"allowNo": false,
|
|
110
|
+
"deprecateAliases": true
|
|
111
|
+
},
|
|
112
|
+
"clean": {
|
|
113
|
+
"name": "clean",
|
|
114
|
+
"type": "boolean",
|
|
115
|
+
"summary": "Remove all local org authorizations for non-active scratch orgs. Use auth:logout to remove non-scratch orgs.",
|
|
116
|
+
"allowNo": false,
|
|
117
|
+
"deprecateAliases": true
|
|
118
|
+
},
|
|
119
|
+
"no-prompt": {
|
|
120
|
+
"name": "no-prompt",
|
|
121
|
+
"type": "boolean",
|
|
122
|
+
"char": "p",
|
|
123
|
+
"summary": "Don't prompt for confirmation.",
|
|
124
|
+
"allowNo": false,
|
|
125
|
+
"dependsOn": [
|
|
126
|
+
"clean"
|
|
127
|
+
],
|
|
128
|
+
"deprecateAliases": true,
|
|
129
|
+
"aliases": [
|
|
130
|
+
"noprompt"
|
|
131
|
+
]
|
|
132
|
+
},
|
|
133
|
+
"skip-connection-status": {
|
|
134
|
+
"name": "skip-connection-status",
|
|
135
|
+
"type": "boolean",
|
|
136
|
+
"summary": "Skip retrieving the connection status of non-scratch orgs.",
|
|
137
|
+
"allowNo": false,
|
|
138
|
+
"deprecateAliases": true,
|
|
139
|
+
"aliases": [
|
|
140
|
+
"skipconnectionstatus"
|
|
141
|
+
]
|
|
142
|
+
},
|
|
143
|
+
"loglevel": {
|
|
144
|
+
"name": "loglevel",
|
|
145
|
+
"type": "option",
|
|
146
|
+
"hidden": true,
|
|
147
|
+
"multiple": false,
|
|
148
|
+
"deprecated": {
|
|
149
|
+
"message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
|
|
150
|
+
},
|
|
151
|
+
"deprecateAliases": true
|
|
152
|
+
}
|
|
153
|
+
},
|
|
154
|
+
"args": {}
|
|
155
|
+
},
|
|
156
|
+
"org:open": {
|
|
157
|
+
"id": "org:open",
|
|
158
|
+
"summary": "Open your default scratch org, or another specified org, in a browser.",
|
|
159
|
+
"description": "To open a specific page, specify the portion of the URL after \"https://MyDomainName.my.salesforce.com/\" as the value for the --path flag. For example, specify \"--path lightning\" to open Lightning Experience, or specify \"--path /apex/YourPage\" to open a Visualforce page.\n\nTo generate a URL but not launch it in your browser, specify --url-only.\n\nTo open in a specific browser, use the --browser flag. Supported browsers are \"chrome\", \"edge\", and \"firefox\". If you don't specify --browser, the org opens in your default browser.",
|
|
160
|
+
"strict": true,
|
|
161
|
+
"pluginName": "@salesforce/plugin-org",
|
|
162
|
+
"pluginAlias": "@salesforce/plugin-org",
|
|
163
|
+
"pluginType": "core",
|
|
164
|
+
"aliases": [
|
|
165
|
+
"force:org:open"
|
|
166
|
+
],
|
|
167
|
+
"examples": [
|
|
168
|
+
"Open your default org in your default browser:\n$ <%= config.bin %> <%= command.id %>",
|
|
169
|
+
"Open the org with alias MyTestOrg1 in the Firefox browser:\n$ <%= config.bin %> <%= command.id %> --target-org MyTestOrg1 --browser firefox",
|
|
170
|
+
"Display the navigation URL for the Lightning Experience page for your default org, but don't open the page in a browser:\n$ <%= config.bin %> <%= command.id %> --url-only --path lightning"
|
|
171
|
+
],
|
|
172
|
+
"flags": {
|
|
173
|
+
"json": {
|
|
174
|
+
"name": "json",
|
|
175
|
+
"type": "boolean",
|
|
176
|
+
"description": "Format output as json.",
|
|
177
|
+
"helpGroup": "GLOBAL",
|
|
178
|
+
"allowNo": false
|
|
179
|
+
},
|
|
180
|
+
"target-org": {
|
|
181
|
+
"name": "target-org",
|
|
182
|
+
"type": "option",
|
|
183
|
+
"char": "o",
|
|
184
|
+
"summary": "Username or alias of the target org.",
|
|
185
|
+
"required": true,
|
|
186
|
+
"multiple": false,
|
|
187
|
+
"aliases": [
|
|
188
|
+
"targetusername",
|
|
189
|
+
"u"
|
|
190
|
+
]
|
|
191
|
+
},
|
|
192
|
+
"api-version": {
|
|
193
|
+
"name": "api-version",
|
|
194
|
+
"type": "option",
|
|
195
|
+
"description": "Override the api version used for api requests made by this command",
|
|
196
|
+
"multiple": false,
|
|
197
|
+
"aliases": [
|
|
198
|
+
"apiversion"
|
|
199
|
+
]
|
|
200
|
+
},
|
|
201
|
+
"browser": {
|
|
202
|
+
"name": "browser",
|
|
203
|
+
"type": "option",
|
|
204
|
+
"char": "b",
|
|
205
|
+
"summary": "Browser where the org opens.",
|
|
206
|
+
"multiple": false,
|
|
207
|
+
"options": [
|
|
208
|
+
"chrome",
|
|
209
|
+
"edge",
|
|
210
|
+
"firefox"
|
|
211
|
+
],
|
|
212
|
+
"exclusive": [
|
|
213
|
+
"url-only"
|
|
214
|
+
]
|
|
215
|
+
},
|
|
216
|
+
"path": {
|
|
217
|
+
"name": "path",
|
|
218
|
+
"type": "option",
|
|
219
|
+
"char": "p",
|
|
220
|
+
"summary": "Navigation URL path to open a specific page.",
|
|
221
|
+
"multiple": false
|
|
222
|
+
},
|
|
223
|
+
"url-only": {
|
|
224
|
+
"name": "url-only",
|
|
225
|
+
"type": "boolean",
|
|
226
|
+
"char": "r",
|
|
227
|
+
"summary": "Display navigation URL, but don’t launch browser.",
|
|
228
|
+
"allowNo": false,
|
|
229
|
+
"aliases": [
|
|
230
|
+
"urlonly"
|
|
231
|
+
]
|
|
232
|
+
},
|
|
233
|
+
"loglevel": {
|
|
234
|
+
"name": "loglevel",
|
|
235
|
+
"type": "option",
|
|
236
|
+
"hidden": true,
|
|
237
|
+
"multiple": false,
|
|
238
|
+
"deprecated": {
|
|
239
|
+
"message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
|
|
240
|
+
}
|
|
241
|
+
}
|
|
242
|
+
},
|
|
243
|
+
"args": {},
|
|
244
|
+
"depreprecateAliases": true,
|
|
245
|
+
"hasDynamicHelp": true
|
|
246
|
+
},
|
|
247
|
+
"force:org:clone": {
|
|
248
|
+
"id": "force:org:clone",
|
|
249
|
+
"summary": "Clone a sandbox org.",
|
|
250
|
+
"description": "There are two ways to clone a sandbox: either specify a sandbox definition file or provide key=value pairs at the command line. Key-value pairs at the command-line override their equivalent sandbox definition file values. In either case, you must specify both the \"SandboxName\" and \"SourceSandboxName\" options to set the names of the new sandbox and the one being cloned, respectively.\n\nSet the --targetusername (-u) parameter to a production org with sandbox licenses. The --type (-t) parameter is required and must be set to \"sandbox\".",
|
|
251
|
+
"strict": false,
|
|
252
|
+
"pluginName": "@salesforce/plugin-org",
|
|
253
|
+
"pluginAlias": "@salesforce/plugin-org",
|
|
254
|
+
"pluginType": "core",
|
|
255
|
+
"state": "deprecated",
|
|
256
|
+
"aliases": [],
|
|
257
|
+
"examples": [
|
|
258
|
+
"$ <%= config.bin %> <%= command.id %> -t sandbox -f config/dev-sandbox-def.json -u prodOrg -a MyDevSandbox",
|
|
259
|
+
"$ <%= config.bin %> <%= command.id %> -t sandbox SandboxName=NewClonedSandbox SourceSandboxName=ExistingSandbox -u prodOrg -a MyDevSandbox"
|
|
260
|
+
],
|
|
261
|
+
"deprecationOptions": {
|
|
262
|
+
"to": "org:create:sandbox",
|
|
263
|
+
"version": "60.0"
|
|
264
|
+
},
|
|
265
|
+
"flags": {
|
|
266
|
+
"json": {
|
|
267
|
+
"name": "json",
|
|
268
|
+
"type": "boolean",
|
|
269
|
+
"description": "Format output as json.",
|
|
270
|
+
"helpGroup": "GLOBAL",
|
|
271
|
+
"allowNo": false
|
|
272
|
+
},
|
|
273
|
+
"target-org": {
|
|
274
|
+
"name": "target-org",
|
|
275
|
+
"type": "option",
|
|
276
|
+
"char": "o",
|
|
277
|
+
"summary": "Username or alias of the target org.",
|
|
278
|
+
"required": true,
|
|
279
|
+
"multiple": false,
|
|
280
|
+
"aliases": [
|
|
281
|
+
"targetusername",
|
|
282
|
+
"u"
|
|
283
|
+
]
|
|
284
|
+
},
|
|
285
|
+
"api-version": {
|
|
286
|
+
"name": "api-version",
|
|
287
|
+
"type": "option",
|
|
288
|
+
"description": "Override the api version used for api requests made by this command",
|
|
289
|
+
"multiple": false,
|
|
290
|
+
"aliases": [
|
|
291
|
+
"apiversion"
|
|
292
|
+
]
|
|
293
|
+
},
|
|
294
|
+
"type": {
|
|
295
|
+
"name": "type",
|
|
296
|
+
"type": "option",
|
|
297
|
+
"char": "t",
|
|
298
|
+
"summary": "Type of org to create.",
|
|
299
|
+
"required": true,
|
|
300
|
+
"multiple": false,
|
|
301
|
+
"options": [
|
|
302
|
+
"sandbox"
|
|
303
|
+
]
|
|
304
|
+
},
|
|
305
|
+
"definitionfile": {
|
|
306
|
+
"name": "definitionfile",
|
|
307
|
+
"type": "option",
|
|
308
|
+
"char": "f",
|
|
309
|
+
"summary": "Path to the sandbox definition file.",
|
|
310
|
+
"multiple": false
|
|
311
|
+
},
|
|
312
|
+
"setdefaultusername": {
|
|
313
|
+
"name": "setdefaultusername",
|
|
314
|
+
"type": "boolean",
|
|
315
|
+
"char": "s",
|
|
316
|
+
"summary": "Set the cloned org as your default.",
|
|
317
|
+
"allowNo": false
|
|
318
|
+
},
|
|
319
|
+
"setalias": {
|
|
320
|
+
"name": "setalias",
|
|
321
|
+
"type": "option",
|
|
322
|
+
"char": "a",
|
|
323
|
+
"summary": "Alias for the cloned org.",
|
|
324
|
+
"multiple": false
|
|
325
|
+
},
|
|
326
|
+
"wait": {
|
|
327
|
+
"name": "wait",
|
|
328
|
+
"type": "option",
|
|
329
|
+
"char": "w",
|
|
330
|
+
"summary": "Number of minutes to wait while polling for status.",
|
|
331
|
+
"description": "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.",
|
|
332
|
+
"multiple": false
|
|
333
|
+
},
|
|
334
|
+
"loglevel": {
|
|
335
|
+
"name": "loglevel",
|
|
336
|
+
"type": "option",
|
|
337
|
+
"hidden": true,
|
|
338
|
+
"multiple": false,
|
|
339
|
+
"deprecated": {
|
|
340
|
+
"message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
|
|
341
|
+
}
|
|
342
|
+
}
|
|
343
|
+
},
|
|
344
|
+
"args": {},
|
|
345
|
+
"SANDBOXDEF_SRC_SANDBOXNAME": "SourceSandboxName",
|
|
346
|
+
"hasDynamicHelp": true
|
|
347
|
+
},
|
|
348
|
+
"force:org:create": {
|
|
349
|
+
"id": "force:org:create",
|
|
350
|
+
"summary": "Create a scratch org or sandbox.",
|
|
351
|
+
"description": "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. 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.",
|
|
352
|
+
"strict": false,
|
|
353
|
+
"pluginName": "@salesforce/plugin-org",
|
|
354
|
+
"pluginAlias": "@salesforce/plugin-org",
|
|
355
|
+
"pluginType": "core",
|
|
356
|
+
"aliases": [],
|
|
357
|
+
"examples": [
|
|
358
|
+
"$ <%= config.bin %> <%= command.id %> -f config/enterprise-scratch-def.json -a MyScratchOrg",
|
|
359
|
+
"$ <%= config.bin %> <%= command.id %> edition=Developer -a MyScratchOrg -s -v devHub",
|
|
360
|
+
"$ <%= config.bin %> <%= command.id %> -f config/enterprise-scratch-def.json -a ScratchOrgWithOverrides username=testuser1@mycompany.org",
|
|
361
|
+
"$ <%= config.bin %> <%= command.id %> -t sandbox -f config/dev-sandbox-def.json -a MyDevSandbox -u prodOrg"
|
|
362
|
+
],
|
|
363
|
+
"flags": {
|
|
364
|
+
"json": {
|
|
365
|
+
"name": "json",
|
|
366
|
+
"type": "boolean",
|
|
367
|
+
"description": "Format output as json.",
|
|
368
|
+
"helpGroup": "GLOBAL",
|
|
369
|
+
"allowNo": false
|
|
370
|
+
},
|
|
371
|
+
"target-org": {
|
|
372
|
+
"name": "target-org",
|
|
373
|
+
"type": "option",
|
|
374
|
+
"char": "o",
|
|
375
|
+
"multiple": false,
|
|
376
|
+
"aliases": [
|
|
377
|
+
"targetusername",
|
|
378
|
+
"u"
|
|
379
|
+
]
|
|
380
|
+
},
|
|
381
|
+
"target-dev-hub": {
|
|
382
|
+
"name": "target-dev-hub",
|
|
383
|
+
"type": "option",
|
|
384
|
+
"char": "v",
|
|
385
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
386
|
+
"required": false,
|
|
387
|
+
"multiple": false,
|
|
388
|
+
"aliases": [
|
|
389
|
+
"targetdevhubusername"
|
|
390
|
+
]
|
|
391
|
+
},
|
|
392
|
+
"api-version": {
|
|
393
|
+
"name": "api-version",
|
|
394
|
+
"type": "option",
|
|
395
|
+
"description": "Override the api version used for api requests made by this command",
|
|
396
|
+
"multiple": false,
|
|
397
|
+
"aliases": [
|
|
398
|
+
"apiversion"
|
|
399
|
+
]
|
|
400
|
+
},
|
|
401
|
+
"loglevel": {
|
|
402
|
+
"name": "loglevel",
|
|
403
|
+
"type": "option",
|
|
404
|
+
"hidden": true,
|
|
405
|
+
"multiple": false,
|
|
406
|
+
"deprecated": {
|
|
407
|
+
"message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
|
|
408
|
+
}
|
|
409
|
+
},
|
|
410
|
+
"type": {
|
|
411
|
+
"name": "type",
|
|
412
|
+
"type": "option",
|
|
413
|
+
"char": "t",
|
|
414
|
+
"summary": "Type of org to create.",
|
|
415
|
+
"multiple": false,
|
|
416
|
+
"options": [
|
|
417
|
+
"scratch",
|
|
418
|
+
"sandbox"
|
|
419
|
+
],
|
|
420
|
+
"default": "scratch"
|
|
421
|
+
},
|
|
422
|
+
"definitionfile": {
|
|
423
|
+
"name": "definitionfile",
|
|
424
|
+
"type": "option",
|
|
425
|
+
"char": "f",
|
|
426
|
+
"summary": "Path to an org definition file.",
|
|
427
|
+
"multiple": false
|
|
428
|
+
},
|
|
429
|
+
"nonamespace": {
|
|
430
|
+
"name": "nonamespace",
|
|
431
|
+
"type": "boolean",
|
|
432
|
+
"char": "n",
|
|
433
|
+
"summary": "Create the scratch org with no namespace.",
|
|
434
|
+
"allowNo": false
|
|
435
|
+
},
|
|
436
|
+
"noancestors": {
|
|
437
|
+
"name": "noancestors",
|
|
438
|
+
"type": "boolean",
|
|
439
|
+
"char": "c",
|
|
440
|
+
"summary": "Do not include second-generation package ancestors in the scratch org.",
|
|
441
|
+
"allowNo": false
|
|
442
|
+
},
|
|
443
|
+
"clientid": {
|
|
444
|
+
"name": "clientid",
|
|
445
|
+
"type": "option",
|
|
446
|
+
"char": "i",
|
|
447
|
+
"summary": "Connected app consumer key; not supported for sandbox org creation.",
|
|
448
|
+
"multiple": false
|
|
449
|
+
},
|
|
450
|
+
"setdefaultusername": {
|
|
451
|
+
"name": "setdefaultusername",
|
|
452
|
+
"type": "boolean",
|
|
453
|
+
"char": "s",
|
|
454
|
+
"summary": "Set the created org as the default username.",
|
|
455
|
+
"allowNo": false
|
|
456
|
+
},
|
|
457
|
+
"setalias": {
|
|
458
|
+
"name": "setalias",
|
|
459
|
+
"type": "option",
|
|
460
|
+
"char": "a",
|
|
461
|
+
"summary": "Alias for the created org.",
|
|
462
|
+
"multiple": false
|
|
463
|
+
},
|
|
464
|
+
"wait": {
|
|
465
|
+
"name": "wait",
|
|
466
|
+
"type": "option",
|
|
467
|
+
"char": "w",
|
|
468
|
+
"summary": "Streaming client socket timeout (in minutes).",
|
|
469
|
+
"multiple": false
|
|
470
|
+
},
|
|
471
|
+
"durationdays": {
|
|
472
|
+
"name": "durationdays",
|
|
473
|
+
"type": "option",
|
|
474
|
+
"char": "d",
|
|
475
|
+
"summary": "Duration of the scratch org (in days) (default:7, min:1, max:30).",
|
|
476
|
+
"multiple": false,
|
|
477
|
+
"default": 7
|
|
478
|
+
},
|
|
479
|
+
"retry": {
|
|
480
|
+
"name": "retry",
|
|
481
|
+
"type": "option",
|
|
482
|
+
"summary": "Number of scratch org auth retries after scratch org is successfully signed up.",
|
|
483
|
+
"hidden": true,
|
|
484
|
+
"multiple": false,
|
|
485
|
+
"default": 0
|
|
486
|
+
}
|
|
487
|
+
},
|
|
488
|
+
"args": {},
|
|
489
|
+
"hasDynamicHelp": true
|
|
490
|
+
},
|
|
491
|
+
"force:org:delete": {
|
|
492
|
+
"id": "force:org:delete",
|
|
493
|
+
"summary": "Delete a scratch or sandbox org.",
|
|
494
|
+
"description": "Salesforce CLI marks the org for deletion in either the Dev Hub org (for scratch orgs) or production org (for sandboxes) and then deletes all local references to the org from your computer.\n\nTo mark the org for deletion without being prompted to confirm, specify --noprompt.",
|
|
495
|
+
"strict": true,
|
|
496
|
+
"pluginName": "@salesforce/plugin-org",
|
|
497
|
+
"pluginAlias": "@salesforce/plugin-org",
|
|
498
|
+
"pluginType": "core",
|
|
499
|
+
"state": "deprecated",
|
|
500
|
+
"aliases": [],
|
|
501
|
+
"examples": [
|
|
502
|
+
"$ <%= config.bin %> <%= command.id %> -u me@my.org",
|
|
503
|
+
"$ <%= config.bin %> <%= command.id %> -u MyOrgAlias -p"
|
|
504
|
+
],
|
|
505
|
+
"deprecationOptions": {
|
|
506
|
+
"message": "The force:org:delete command is deprecated. Use org:delete:scratch or org:delete:sandbox."
|
|
507
|
+
},
|
|
508
|
+
"flags": {
|
|
509
|
+
"json": {
|
|
510
|
+
"name": "json",
|
|
511
|
+
"type": "boolean",
|
|
512
|
+
"description": "Format output as json.",
|
|
513
|
+
"helpGroup": "GLOBAL",
|
|
514
|
+
"allowNo": false
|
|
515
|
+
},
|
|
516
|
+
"target-org": {
|
|
517
|
+
"name": "target-org",
|
|
518
|
+
"type": "option",
|
|
519
|
+
"char": "o",
|
|
520
|
+
"summary": "Username or alias of the target org.",
|
|
521
|
+
"required": true,
|
|
522
|
+
"multiple": false,
|
|
523
|
+
"aliases": [
|
|
524
|
+
"targetusername",
|
|
525
|
+
"u"
|
|
526
|
+
]
|
|
527
|
+
},
|
|
528
|
+
"api-version": {
|
|
529
|
+
"name": "api-version",
|
|
530
|
+
"type": "option",
|
|
531
|
+
"description": "Override the api version used for api requests made by this command",
|
|
532
|
+
"multiple": false,
|
|
533
|
+
"aliases": [
|
|
534
|
+
"apiversion"
|
|
535
|
+
]
|
|
536
|
+
},
|
|
537
|
+
"no-prompt": {
|
|
538
|
+
"name": "no-prompt",
|
|
539
|
+
"type": "boolean",
|
|
540
|
+
"char": "p",
|
|
541
|
+
"summary": "No prompt to confirm deletion.",
|
|
542
|
+
"allowNo": false,
|
|
543
|
+
"aliases": [
|
|
544
|
+
"noprompt"
|
|
545
|
+
]
|
|
546
|
+
},
|
|
547
|
+
"loglevel": {
|
|
548
|
+
"name": "loglevel",
|
|
549
|
+
"type": "option",
|
|
550
|
+
"hidden": true,
|
|
551
|
+
"multiple": false,
|
|
552
|
+
"deprecated": {
|
|
553
|
+
"message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
|
|
554
|
+
}
|
|
555
|
+
}
|
|
556
|
+
},
|
|
557
|
+
"args": {},
|
|
558
|
+
"hasDynamicHelp": true
|
|
559
|
+
},
|
|
560
|
+
"force:org:status": {
|
|
561
|
+
"id": "force:org:status",
|
|
562
|
+
"summary": "Check the status of a sandbox, and if complete, authenticate to it.",
|
|
563
|
+
"description": "Use this command to check the status of your sandbox creation or clone and, if the sandbox is ready, authenticate to it.\n\nUse the --wait (-w) parameter to specify the number of minutes that the command waits for the sandbox creation or clone to complete before returning control of the terminal to you.\n\nSet the --target-org (-o) parameter to the username or alias of the production org that contains the sandbox license.",
|
|
564
|
+
"strict": true,
|
|
565
|
+
"pluginName": "@salesforce/plugin-org",
|
|
566
|
+
"pluginAlias": "@salesforce/plugin-org",
|
|
567
|
+
"pluginType": "core",
|
|
568
|
+
"state": "deprecated",
|
|
569
|
+
"aliases": [],
|
|
570
|
+
"examples": [
|
|
571
|
+
"$ <%= config.bin %> <%= command.id %> --sandboxname DevSbx1 --setalias MySandbox -u prodOrg",
|
|
572
|
+
"$ <%= config.bin %> <%= command.id %> --sandboxname DevSbx1 --wait 45 --setdefaultusername -u prodOrg"
|
|
573
|
+
],
|
|
574
|
+
"deprecationOptions": {
|
|
575
|
+
"to": "org:resume:sandbox",
|
|
576
|
+
"version": "60.0"
|
|
577
|
+
},
|
|
578
|
+
"flags": {
|
|
579
|
+
"json": {
|
|
580
|
+
"name": "json",
|
|
581
|
+
"type": "boolean",
|
|
582
|
+
"description": "Format output as json.",
|
|
583
|
+
"helpGroup": "GLOBAL",
|
|
584
|
+
"allowNo": false
|
|
585
|
+
},
|
|
586
|
+
"target-org": {
|
|
587
|
+
"name": "target-org",
|
|
588
|
+
"type": "option",
|
|
589
|
+
"char": "o",
|
|
590
|
+
"summary": "Username or alias of the target org.",
|
|
591
|
+
"required": true,
|
|
592
|
+
"multiple": false,
|
|
593
|
+
"aliases": [
|
|
594
|
+
"targetusername",
|
|
595
|
+
"u"
|
|
596
|
+
]
|
|
597
|
+
},
|
|
598
|
+
"api-version": {
|
|
599
|
+
"name": "api-version",
|
|
600
|
+
"type": "option",
|
|
601
|
+
"description": "Override the api version used for api requests made by this command",
|
|
602
|
+
"multiple": false,
|
|
603
|
+
"aliases": [
|
|
604
|
+
"apiversion"
|
|
605
|
+
]
|
|
606
|
+
},
|
|
607
|
+
"sandboxname": {
|
|
608
|
+
"name": "sandboxname",
|
|
609
|
+
"type": "option",
|
|
610
|
+
"char": "n",
|
|
611
|
+
"summary": "Name of the sandbox org to check status for.",
|
|
612
|
+
"required": true,
|
|
613
|
+
"multiple": false
|
|
614
|
+
},
|
|
615
|
+
"setdefaultusername": {
|
|
616
|
+
"name": "setdefaultusername",
|
|
617
|
+
"type": "boolean",
|
|
618
|
+
"char": "s",
|
|
619
|
+
"summary": "Set the created or cloned org as your default.",
|
|
620
|
+
"allowNo": false
|
|
621
|
+
},
|
|
622
|
+
"setalias": {
|
|
623
|
+
"name": "setalias",
|
|
624
|
+
"type": "option",
|
|
625
|
+
"char": "a",
|
|
626
|
+
"summary": "Alias for the created or cloned org.",
|
|
627
|
+
"multiple": false
|
|
628
|
+
},
|
|
629
|
+
"wait": {
|
|
630
|
+
"name": "wait",
|
|
631
|
+
"type": "option",
|
|
632
|
+
"char": "w",
|
|
633
|
+
"summary": "Number of minutes to wait while polling for status.",
|
|
634
|
+
"multiple": false
|
|
635
|
+
},
|
|
636
|
+
"loglevel": {
|
|
637
|
+
"name": "loglevel",
|
|
638
|
+
"type": "option",
|
|
639
|
+
"hidden": true,
|
|
640
|
+
"multiple": false,
|
|
641
|
+
"deprecated": {
|
|
642
|
+
"message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
|
|
643
|
+
}
|
|
644
|
+
}
|
|
645
|
+
},
|
|
646
|
+
"args": {},
|
|
647
|
+
"hasDynamicHelp": true
|
|
648
|
+
},
|
|
649
|
+
"org:create:sandbox": {
|
|
650
|
+
"id": "org:create:sandbox",
|
|
651
|
+
"summary": "Create a sandbox org.",
|
|
652
|
+
"description": "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.",
|
|
653
|
+
"strict": true,
|
|
654
|
+
"pluginName": "@salesforce/plugin-org",
|
|
655
|
+
"pluginAlias": "@salesforce/plugin-org",
|
|
656
|
+
"pluginType": "core",
|
|
657
|
+
"state": "beta",
|
|
658
|
+
"aliases": [
|
|
659
|
+
"env:create:sandbox"
|
|
660
|
+
],
|
|
661
|
+
"examples": [
|
|
662
|
+
"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\".\n<%= config.bin %> <%= command.id %> -f config/dev-sandbox-def.json --alias MyDevSandbox --target-org prodOrg",
|
|
663
|
+
"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.\n<%= config.bin %> <%= command.id %> --name mysandbox --license-type Developer --alias MyDevSandbox --target-org prodOrg --set-default"
|
|
664
|
+
],
|
|
665
|
+
"deprecateAliases": true,
|
|
666
|
+
"flags": {
|
|
667
|
+
"json": {
|
|
668
|
+
"name": "json",
|
|
669
|
+
"type": "boolean",
|
|
670
|
+
"description": "Format output as json.",
|
|
671
|
+
"helpGroup": "GLOBAL",
|
|
672
|
+
"allowNo": false,
|
|
673
|
+
"deprecateAliases": true
|
|
674
|
+
},
|
|
675
|
+
"definition-file": {
|
|
676
|
+
"name": "definition-file",
|
|
677
|
+
"type": "option",
|
|
678
|
+
"char": "f",
|
|
679
|
+
"summary": "Path to a sandbox definition file.",
|
|
680
|
+
"description": "The sandbox definition file is a blueprint for the sandbox. You can create different definition files for each sandbox type that you use in the development process. See <https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_sandbox_definition.htm> for all the options you can specify in the defintion file.",
|
|
681
|
+
"multiple": false,
|
|
682
|
+
"exclusive": [
|
|
683
|
+
"name",
|
|
684
|
+
"license-type"
|
|
685
|
+
],
|
|
686
|
+
"deprecateAliases": true
|
|
687
|
+
},
|
|
688
|
+
"set-default": {
|
|
689
|
+
"name": "set-default",
|
|
690
|
+
"type": "boolean",
|
|
691
|
+
"char": "s",
|
|
692
|
+
"summary": "Set the sandbox org as your default org.",
|
|
693
|
+
"allowNo": false,
|
|
694
|
+
"deprecateAliases": true
|
|
695
|
+
},
|
|
696
|
+
"alias": {
|
|
697
|
+
"name": "alias",
|
|
698
|
+
"type": "option",
|
|
699
|
+
"char": "a",
|
|
700
|
+
"summary": "Alias for the sandbox org.",
|
|
701
|
+
"description": "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.",
|
|
702
|
+
"multiple": false,
|
|
703
|
+
"deprecateAliases": true
|
|
704
|
+
},
|
|
705
|
+
"wait": {
|
|
706
|
+
"name": "wait",
|
|
707
|
+
"type": "option",
|
|
708
|
+
"char": "w",
|
|
709
|
+
"summary": "Number of minutes to wait for the sandbox org to be ready.",
|
|
710
|
+
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal to you and displays the \"<%= config.bin %> 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.",
|
|
711
|
+
"helpValue": "<minutes>",
|
|
712
|
+
"multiple": false,
|
|
713
|
+
"exclusive": [
|
|
714
|
+
"async"
|
|
715
|
+
],
|
|
716
|
+
"deprecateAliases": true
|
|
717
|
+
},
|
|
718
|
+
"poll-interval": {
|
|
719
|
+
"name": "poll-interval",
|
|
720
|
+
"type": "option",
|
|
721
|
+
"char": "i",
|
|
722
|
+
"summary": "Number of seconds to wait between retries.",
|
|
723
|
+
"helpValue": "<seconds>",
|
|
724
|
+
"multiple": false,
|
|
725
|
+
"exclusive": [
|
|
726
|
+
"async"
|
|
727
|
+
],
|
|
728
|
+
"deprecateAliases": true
|
|
729
|
+
},
|
|
730
|
+
"async": {
|
|
731
|
+
"name": "async",
|
|
732
|
+
"type": "boolean",
|
|
733
|
+
"summary": "Request the sandbox creation, but don't wait for it to complete.",
|
|
734
|
+
"description": "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 \"<%= config.bin %> org resume sandbox\".",
|
|
735
|
+
"allowNo": false,
|
|
736
|
+
"exclusive": [
|
|
737
|
+
"wait",
|
|
738
|
+
"poll-interval"
|
|
739
|
+
],
|
|
740
|
+
"deprecateAliases": true
|
|
741
|
+
},
|
|
742
|
+
"name": {
|
|
743
|
+
"name": "name",
|
|
744
|
+
"type": "option",
|
|
745
|
+
"char": "n",
|
|
746
|
+
"summary": "Name of the sandbox org.",
|
|
747
|
+
"description": "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.",
|
|
748
|
+
"multiple": false,
|
|
749
|
+
"exclusive": [
|
|
750
|
+
"definition-file"
|
|
751
|
+
],
|
|
752
|
+
"deprecateAliases": true
|
|
753
|
+
},
|
|
754
|
+
"clone": {
|
|
755
|
+
"name": "clone",
|
|
756
|
+
"type": "option",
|
|
757
|
+
"char": "c",
|
|
758
|
+
"summary": "Name of the sandbox org to clone.",
|
|
759
|
+
"description": "The value of clone must be an existing sandbox in the same target-org.",
|
|
760
|
+
"multiple": false,
|
|
761
|
+
"exclusive": [
|
|
762
|
+
"license-type"
|
|
763
|
+
],
|
|
764
|
+
"deprecateAliases": true
|
|
765
|
+
},
|
|
766
|
+
"license-type": {
|
|
767
|
+
"name": "license-type",
|
|
768
|
+
"type": "option",
|
|
769
|
+
"char": "l",
|
|
770
|
+
"summary": "Type of sandbox license.",
|
|
771
|
+
"multiple": false,
|
|
772
|
+
"options": [
|
|
773
|
+
"Developer",
|
|
774
|
+
"Developer_Pro",
|
|
775
|
+
"Partial",
|
|
776
|
+
"Full"
|
|
777
|
+
],
|
|
778
|
+
"exclusive": [
|
|
779
|
+
"definition-file",
|
|
780
|
+
"clone"
|
|
781
|
+
],
|
|
782
|
+
"default": "Developer",
|
|
783
|
+
"deprecateAliases": true
|
|
784
|
+
},
|
|
785
|
+
"target-org": {
|
|
786
|
+
"name": "target-org",
|
|
787
|
+
"type": "option",
|
|
788
|
+
"char": "o",
|
|
789
|
+
"summary": "Username or alias of the production org that contains the sandbox license.",
|
|
790
|
+
"description": "When it creates the sandbox org, Salesforce copies the metadata, and optionally data, from your production org to the new sandbox org.",
|
|
791
|
+
"required": true,
|
|
792
|
+
"multiple": false,
|
|
793
|
+
"deprecateAliases": true
|
|
794
|
+
},
|
|
795
|
+
"no-prompt": {
|
|
796
|
+
"name": "no-prompt",
|
|
797
|
+
"type": "boolean",
|
|
798
|
+
"summary": "Don't prompt for confirmation about the sandbox configuration.",
|
|
799
|
+
"allowNo": false,
|
|
800
|
+
"deprecateAliases": true
|
|
801
|
+
},
|
|
802
|
+
"no-track-source": {
|
|
803
|
+
"name": "no-track-source",
|
|
804
|
+
"type": "boolean",
|
|
805
|
+
"summary": "Do not use source tracking for this sandbox.",
|
|
806
|
+
"description": "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.\n\nTo 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.",
|
|
807
|
+
"allowNo": false,
|
|
808
|
+
"deprecateAliases": true
|
|
809
|
+
}
|
|
810
|
+
},
|
|
811
|
+
"args": {},
|
|
812
|
+
"hasDynamicHelp": true
|
|
813
|
+
},
|
|
814
|
+
"org:create:scratch": {
|
|
815
|
+
"id": "org:create:scratch",
|
|
816
|
+
"summary": "Create a scratch org.",
|
|
817
|
+
"description": "There are two ways to create a scratch org: specify a definition file that contains the options or use the --edition flag to specify the one required option. If you want to set options other than the edition, such as org features or settings, you must use a definition file.\n\nYou must specify a Dev Hub to create a scratch org, either with the --target-dev-hub flag or by setting your default Dev Hub with the target-dev-hub configuration variable.",
|
|
818
|
+
"strict": true,
|
|
819
|
+
"pluginName": "@salesforce/plugin-org",
|
|
820
|
+
"pluginAlias": "@salesforce/plugin-org",
|
|
821
|
+
"pluginType": "core",
|
|
822
|
+
"state": "beta",
|
|
823
|
+
"aliases": [
|
|
824
|
+
"env:create:scratch"
|
|
825
|
+
],
|
|
826
|
+
"examples": [
|
|
827
|
+
"Create a Developer edition scratch org using your default Dev Hub and give the scratch org an alias:\n<%= config.bin %> <%= command.id %> --edition=developer --alias my-scratch-org",
|
|
828
|
+
"Specify the Dev Hub using its alias and a scratch org definition file. Set the scratch org as your default and specify that it expires in 3 days:\n<%= config.bin %> <%= command.id %> --target-dev-hub=MyHub --definition-file config/project-scratch-def.json --set-default --duration-days 3"
|
|
829
|
+
],
|
|
830
|
+
"deprecateAliases": true,
|
|
831
|
+
"flags": {
|
|
832
|
+
"json": {
|
|
833
|
+
"name": "json",
|
|
834
|
+
"type": "boolean",
|
|
835
|
+
"description": "Format output as json.",
|
|
836
|
+
"helpGroup": "GLOBAL",
|
|
837
|
+
"allowNo": false,
|
|
838
|
+
"deprecateAliases": true
|
|
839
|
+
},
|
|
840
|
+
"alias": {
|
|
841
|
+
"name": "alias",
|
|
842
|
+
"type": "option",
|
|
843
|
+
"char": "a",
|
|
844
|
+
"summary": "Alias for the scratch org.",
|
|
845
|
+
"description": "New scratch orgs include one administrator by default. The admin user's username is auto-generated and looks something like test-wvkpnfm5z113@example.com. When you set an alias for a new scratch org, it's assigned this username.",
|
|
846
|
+
"multiple": false,
|
|
847
|
+
"deprecateAliases": true
|
|
848
|
+
},
|
|
849
|
+
"async": {
|
|
850
|
+
"name": "async",
|
|
851
|
+
"type": "boolean",
|
|
852
|
+
"summary": "Request the org, but don't wait for it to complete.",
|
|
853
|
+
"description": "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 resume the scratch org creation, run \"<%= config.bin %> org resume scratch\".",
|
|
854
|
+
"allowNo": false,
|
|
855
|
+
"deprecateAliases": true
|
|
856
|
+
},
|
|
857
|
+
"set-default": {
|
|
858
|
+
"name": "set-default",
|
|
859
|
+
"type": "boolean",
|
|
860
|
+
"char": "d",
|
|
861
|
+
"summary": "Set the scratch org as your default org",
|
|
862
|
+
"allowNo": false,
|
|
863
|
+
"deprecateAliases": true
|
|
864
|
+
},
|
|
865
|
+
"definition-file": {
|
|
866
|
+
"name": "definition-file",
|
|
867
|
+
"type": "option",
|
|
868
|
+
"char": "f",
|
|
869
|
+
"summary": "Path to a scratch org definition file.",
|
|
870
|
+
"description": "The scratch org definition file is a blueprint for the scratch org. It mimics the shape of an org that you use in the development life cycle, such as acceptance testing, packaging, or production. See <https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_scratch_orgs_def_file.htm> for all the option you can specify in the definition file.",
|
|
871
|
+
"multiple": false,
|
|
872
|
+
"deprecateAliases": true
|
|
873
|
+
},
|
|
874
|
+
"target-dev-hub": {
|
|
875
|
+
"name": "target-dev-hub",
|
|
876
|
+
"type": "option",
|
|
877
|
+
"char": "v",
|
|
878
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
879
|
+
"description": "Overrides the value of the target-dev-hub configuration variable, if set.",
|
|
880
|
+
"required": true,
|
|
881
|
+
"multiple": false,
|
|
882
|
+
"deprecateAliases": true
|
|
883
|
+
},
|
|
884
|
+
"no-ancestors": {
|
|
885
|
+
"name": "no-ancestors",
|
|
886
|
+
"type": "boolean",
|
|
887
|
+
"char": "c",
|
|
888
|
+
"summary": "Don't include second-generation managed package (2GP) ancestors in the scratch org.",
|
|
889
|
+
"helpGroup": "Packaging",
|
|
890
|
+
"allowNo": false,
|
|
891
|
+
"deprecateAliases": true
|
|
892
|
+
},
|
|
893
|
+
"edition": {
|
|
894
|
+
"name": "edition",
|
|
895
|
+
"type": "option",
|
|
896
|
+
"char": "e",
|
|
897
|
+
"summary": "Salesforce edition of the scratch org.",
|
|
898
|
+
"description": "The editions that begin with \"partner-\" are available only if the Dev Hub org is a Partner Business Org.",
|
|
899
|
+
"multiple": false,
|
|
900
|
+
"options": [
|
|
901
|
+
"developer",
|
|
902
|
+
"enterprise",
|
|
903
|
+
"group",
|
|
904
|
+
"professional",
|
|
905
|
+
"partner-developer",
|
|
906
|
+
"partner-enterprise",
|
|
907
|
+
"partner-group",
|
|
908
|
+
"partner-professional"
|
|
909
|
+
],
|
|
910
|
+
"deprecateAliases": true
|
|
911
|
+
},
|
|
912
|
+
"no-namespace": {
|
|
913
|
+
"name": "no-namespace",
|
|
914
|
+
"type": "boolean",
|
|
915
|
+
"char": "m",
|
|
916
|
+
"summary": "Create the scratch org with no namespace, even if the Dev Hub has a namespace.",
|
|
917
|
+
"helpGroup": "Packaging",
|
|
918
|
+
"allowNo": false,
|
|
919
|
+
"deprecateAliases": true
|
|
920
|
+
},
|
|
921
|
+
"duration-days": {
|
|
922
|
+
"name": "duration-days",
|
|
923
|
+
"type": "option",
|
|
924
|
+
"char": "y",
|
|
925
|
+
"summary": "Number of days before the org expires.",
|
|
926
|
+
"helpValue": "<days>",
|
|
927
|
+
"multiple": false,
|
|
928
|
+
"deprecateAliases": true
|
|
929
|
+
},
|
|
930
|
+
"wait": {
|
|
931
|
+
"name": "wait",
|
|
932
|
+
"type": "option",
|
|
933
|
+
"char": "w",
|
|
934
|
+
"summary": "Number of minutes to wait for the scratch org to be ready.",
|
|
935
|
+
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal to you and displays the job ID. To resume the scratch org creation, run the org resume scratch command and pass it the job ID.",
|
|
936
|
+
"helpValue": "<minutes>",
|
|
937
|
+
"multiple": false,
|
|
938
|
+
"deprecateAliases": true
|
|
939
|
+
},
|
|
940
|
+
"api-version": {
|
|
941
|
+
"name": "api-version",
|
|
942
|
+
"type": "option",
|
|
943
|
+
"description": "Override the api version used for api requests made by this command",
|
|
944
|
+
"multiple": false,
|
|
945
|
+
"deprecateAliases": true
|
|
946
|
+
},
|
|
947
|
+
"client-id": {
|
|
948
|
+
"name": "client-id",
|
|
949
|
+
"type": "option",
|
|
950
|
+
"char": "i",
|
|
951
|
+
"summary": "Consumer key of the Dev Hub connected app.",
|
|
952
|
+
"multiple": false,
|
|
953
|
+
"deprecateAliases": true
|
|
954
|
+
},
|
|
955
|
+
"track-source": {
|
|
956
|
+
"name": "track-source",
|
|
957
|
+
"type": "boolean",
|
|
958
|
+
"char": "t",
|
|
959
|
+
"summary": "Use source tracking for this scratch org. Set --no-track-source to disable source tracking.",
|
|
960
|
+
"description": "We recommend you enable source tracking in scratch orgs, 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 scratch org, and to detect any conflicts between the two.\n\nTo disable source tracking in the new scratch org, 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 scratch org.",
|
|
961
|
+
"allowNo": true,
|
|
962
|
+
"deprecateAliases": true
|
|
963
|
+
}
|
|
964
|
+
},
|
|
965
|
+
"args": {},
|
|
966
|
+
"hasDynamicHelp": true
|
|
967
|
+
},
|
|
968
|
+
"org:delete:sandbox": {
|
|
969
|
+
"id": "org:delete:sandbox",
|
|
970
|
+
"summary": "Delete a sandbox.",
|
|
971
|
+
"description": "Salesforce CLI marks the org for deletion in the production org that contains the sandbox licenses and then deletes all local references to the org from your computer.\nSpecify a sandbox with either the username you used when you logged into it, or the alias you gave the sandbox when you created it. Run \"<%= config.bin %> org list\" to view all your orgs, including sandboxes, and their aliases.",
|
|
972
|
+
"strict": true,
|
|
973
|
+
"pluginName": "@salesforce/plugin-org",
|
|
974
|
+
"pluginAlias": "@salesforce/plugin-org",
|
|
975
|
+
"pluginType": "core",
|
|
976
|
+
"state": "beta",
|
|
977
|
+
"aliases": [
|
|
978
|
+
"env:delete:sandbox"
|
|
979
|
+
],
|
|
980
|
+
"examples": [
|
|
981
|
+
"Delete a sandbox with alias my-sandbox:\n<%= config.bin %> <%= command.id %> --target-org=my-sandbox",
|
|
982
|
+
"Specify a username instead of an alias:\n<%= config.bin %> <%= command.id %> --target-org=myusername@example.com.qa",
|
|
983
|
+
"Delete the sandbox without prompting to confirm :\n<%= config.bin %> <%= command.id %> --target-org=my-sandbox --no-prompt"
|
|
984
|
+
],
|
|
985
|
+
"deprecateAliases": true,
|
|
986
|
+
"flags": {
|
|
987
|
+
"json": {
|
|
988
|
+
"name": "json",
|
|
989
|
+
"type": "boolean",
|
|
990
|
+
"description": "Format output as json.",
|
|
991
|
+
"helpGroup": "GLOBAL",
|
|
992
|
+
"allowNo": false,
|
|
993
|
+
"deprecateAliases": true
|
|
994
|
+
},
|
|
995
|
+
"target-org": {
|
|
996
|
+
"name": "target-org",
|
|
997
|
+
"type": "option",
|
|
998
|
+
"char": "o",
|
|
999
|
+
"summary": "Sandbox alias or login user.",
|
|
1000
|
+
"required": true,
|
|
1001
|
+
"multiple": false,
|
|
1002
|
+
"deprecateAliases": true
|
|
1003
|
+
},
|
|
1004
|
+
"no-prompt": {
|
|
1005
|
+
"name": "no-prompt",
|
|
1006
|
+
"type": "boolean",
|
|
1007
|
+
"char": "p",
|
|
1008
|
+
"summary": "Don't prompt the user to confirm the deletion.",
|
|
1009
|
+
"allowNo": false,
|
|
1010
|
+
"deprecateAliases": true
|
|
1011
|
+
}
|
|
1012
|
+
},
|
|
1013
|
+
"args": {},
|
|
1014
|
+
"hasDynamicHelp": true
|
|
1015
|
+
},
|
|
1016
|
+
"org:delete:scratch": {
|
|
1017
|
+
"id": "org:delete:scratch",
|
|
1018
|
+
"summary": "Delete a scratch org.",
|
|
1019
|
+
"description": "Salesforce CLI marks the org for deletion in the Dev Hub org and then deletes all local references to the org from your computer.\nSpecify a scratch org with either the username or the alias you gave the scratch org when you created it. Run \"<%= config.bin %> org list\" to view all your orgs, including scratch orgs, and their aliases.",
|
|
1020
|
+
"strict": true,
|
|
1021
|
+
"pluginName": "@salesforce/plugin-org",
|
|
1022
|
+
"pluginAlias": "@salesforce/plugin-org",
|
|
1023
|
+
"pluginType": "core",
|
|
1024
|
+
"state": "beta",
|
|
1025
|
+
"aliases": [
|
|
1026
|
+
"env:delete:scratch"
|
|
1027
|
+
],
|
|
1028
|
+
"examples": [
|
|
1029
|
+
"Delete a scratch org with alias my-scratch-org:\n<%= config.bin %> <%= command.id %> --target-org=my-scratch-org",
|
|
1030
|
+
"Specify a username instead of an alias:\n<%= config.bin %> <%= command.id %> --target-org=test-123456-abcdefg@example.com",
|
|
1031
|
+
"Delete the scratch org without prompting to confirm :\n<%= config.bin %> <%= command.id %> --target-org=my-scratch-org --no-prompt"
|
|
1032
|
+
],
|
|
1033
|
+
"deprecateAliases": true,
|
|
1034
|
+
"flags": {
|
|
1035
|
+
"json": {
|
|
1036
|
+
"name": "json",
|
|
1037
|
+
"type": "boolean",
|
|
1038
|
+
"description": "Format output as json.",
|
|
1039
|
+
"helpGroup": "GLOBAL",
|
|
1040
|
+
"allowNo": false,
|
|
1041
|
+
"deprecateAliases": true
|
|
1042
|
+
},
|
|
1043
|
+
"target-org": {
|
|
1044
|
+
"name": "target-org",
|
|
1045
|
+
"type": "option",
|
|
1046
|
+
"char": "o",
|
|
1047
|
+
"summary": "Scratch org alias or login user.",
|
|
1048
|
+
"required": true,
|
|
1049
|
+
"multiple": false,
|
|
1050
|
+
"deprecateAliases": true
|
|
1051
|
+
},
|
|
1052
|
+
"no-prompt": {
|
|
1053
|
+
"name": "no-prompt",
|
|
1054
|
+
"type": "boolean",
|
|
1055
|
+
"char": "p",
|
|
1056
|
+
"summary": "Don't prompt the user to confirm the deletion.",
|
|
1057
|
+
"allowNo": false,
|
|
1058
|
+
"deprecateAliases": true
|
|
1059
|
+
}
|
|
1060
|
+
},
|
|
1061
|
+
"args": {},
|
|
1062
|
+
"hasDynamicHelp": true
|
|
1063
|
+
},
|
|
1064
|
+
"org:resume:sandbox": {
|
|
1065
|
+
"id": "org:resume:sandbox",
|
|
1066
|
+
"summary": "Check the status of a sandbox creation, and log in to it if it's ready.",
|
|
1067
|
+
"description": "Sandbox creation can take a long time. If the original \"<%= config.bin %> org create sandbox\" command either times out, or you specified the --async flag, the command displays a job ID. Use this job ID to check whether the sandbox creation is complete, and if it is, the command then logs into it.\n\nYou can also use the sandbox name to check the status or the --use-most-recent flag to use the job ID of the most recent sandbox creation.",
|
|
1068
|
+
"strict": true,
|
|
1069
|
+
"pluginName": "@salesforce/plugin-org",
|
|
1070
|
+
"pluginAlias": "@salesforce/plugin-org",
|
|
1071
|
+
"pluginType": "core",
|
|
1072
|
+
"state": "beta",
|
|
1073
|
+
"aliases": [
|
|
1074
|
+
"env:resume:sandbox"
|
|
1075
|
+
],
|
|
1076
|
+
"examples": [
|
|
1077
|
+
"Check the status of a sandbox creation using its name and specify a production org with alias \"prodOrg\":\n<%= config.bin %> <%= command.id %> --name mysandbox --target-org prodOrg",
|
|
1078
|
+
"Check the status using the job ID:\n<%= config.bin %> <%= command.id %> --job-id 0GRxxxxxxxx",
|
|
1079
|
+
"Check the status of the most recent sandbox create request:\n<%= config.bin %> <%= command.id %> --use-most-recent"
|
|
1080
|
+
],
|
|
1081
|
+
"deprecateAliases": true,
|
|
1082
|
+
"flags": {
|
|
1083
|
+
"json": {
|
|
1084
|
+
"name": "json",
|
|
1085
|
+
"type": "boolean",
|
|
1086
|
+
"description": "Format output as json.",
|
|
1087
|
+
"helpGroup": "GLOBAL",
|
|
1088
|
+
"allowNo": false,
|
|
1089
|
+
"deprecateAliases": true
|
|
1090
|
+
},
|
|
1091
|
+
"wait": {
|
|
1092
|
+
"name": "wait",
|
|
1093
|
+
"type": "option",
|
|
1094
|
+
"char": "w",
|
|
1095
|
+
"summary": "Number of minutes to wait for the sandbox org to be ready.",
|
|
1096
|
+
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To resume checking the sandbox creation, rerun this command.",
|
|
1097
|
+
"helpValue": "<minutes>",
|
|
1098
|
+
"multiple": false,
|
|
1099
|
+
"deprecateAliases": true
|
|
1100
|
+
},
|
|
1101
|
+
"name": {
|
|
1102
|
+
"name": "name",
|
|
1103
|
+
"type": "option",
|
|
1104
|
+
"char": "n",
|
|
1105
|
+
"summary": "Name of the sandbox org.",
|
|
1106
|
+
"multiple": false,
|
|
1107
|
+
"exclusive": [
|
|
1108
|
+
"job-id"
|
|
1109
|
+
],
|
|
1110
|
+
"deprecateAliases": true
|
|
1111
|
+
},
|
|
1112
|
+
"job-id": {
|
|
1113
|
+
"name": "job-id",
|
|
1114
|
+
"type": "option",
|
|
1115
|
+
"char": "i",
|
|
1116
|
+
"summary": "Job ID of the incomplete sandbox creation that you want to check the status of.",
|
|
1117
|
+
"description": "The job ID is valid for 24 hours after you start the sandbox creation.",
|
|
1118
|
+
"multiple": false,
|
|
1119
|
+
"exclusive": [
|
|
1120
|
+
"name"
|
|
1121
|
+
],
|
|
1122
|
+
"deprecateAliases": true
|
|
1123
|
+
},
|
|
1124
|
+
"use-most-recent": {
|
|
1125
|
+
"name": "use-most-recent",
|
|
1126
|
+
"type": "boolean",
|
|
1127
|
+
"char": "l",
|
|
1128
|
+
"summary": "Use the most recent sandbox create request.",
|
|
1129
|
+
"allowNo": false,
|
|
1130
|
+
"deprecateAliases": true
|
|
1131
|
+
},
|
|
1132
|
+
"target-org": {
|
|
1133
|
+
"name": "target-org",
|
|
1134
|
+
"type": "option",
|
|
1135
|
+
"char": "o",
|
|
1136
|
+
"summary": "Username or alias of the production org that contains the sandbox license.",
|
|
1137
|
+
"description": "When it creates the sandbox org, Salesforce copies the metadata, and optionally data, from your production org to the new sandbox org.",
|
|
1138
|
+
"multiple": false,
|
|
1139
|
+
"deprecateAliases": true
|
|
1140
|
+
}
|
|
1141
|
+
},
|
|
1142
|
+
"args": {},
|
|
1143
|
+
"hasDynamicHelp": true
|
|
1144
|
+
},
|
|
1145
|
+
"org:resume:scratch": {
|
|
1146
|
+
"id": "org:resume:scratch",
|
|
1147
|
+
"summary": "Resume the creation of an incomplete scratch org.",
|
|
1148
|
+
"description": "When the original \"<%= config.bin %> org create scratch\" command either times out or is run with the --async flag, it displays a job ID.\n\nRun this command by either passing it a job ID or using the --use-most-recent flag to specify the most recent incomplete scratch org.",
|
|
1149
|
+
"strict": true,
|
|
1150
|
+
"pluginName": "@salesforce/plugin-org",
|
|
1151
|
+
"pluginAlias": "@salesforce/plugin-org",
|
|
1152
|
+
"pluginType": "core",
|
|
1153
|
+
"aliases": [
|
|
1154
|
+
"env:resume:scratch"
|
|
1155
|
+
],
|
|
1156
|
+
"examples": [
|
|
1157
|
+
"Resume a scratch org create with a job ID:\n<%= config.bin %> <%= command.id %> --job-id 2SR3u0000008fBDGAY",
|
|
1158
|
+
"Resume your most recent incomplete scratch org:\n<%= config.bin %> <%= command.id %> --use-most-recent"
|
|
1159
|
+
],
|
|
1160
|
+
"deprecateAliases": true,
|
|
1161
|
+
"flags": {
|
|
1162
|
+
"json": {
|
|
1163
|
+
"name": "json",
|
|
1164
|
+
"type": "boolean",
|
|
1165
|
+
"description": "Format output as json.",
|
|
1166
|
+
"helpGroup": "GLOBAL",
|
|
1167
|
+
"allowNo": false,
|
|
1168
|
+
"deprecateAliases": true
|
|
1169
|
+
},
|
|
1170
|
+
"job-id": {
|
|
1171
|
+
"name": "job-id",
|
|
1172
|
+
"type": "option",
|
|
1173
|
+
"char": "i",
|
|
1174
|
+
"summary": "Job ID of the incomplete scratch org create that you want to resume.",
|
|
1175
|
+
"description": "The job ID is the same as the record ID of the incomplete scratch org in the ScratchOrgInfo object of the Dev Hub.\n\nThe job ID is valid for 24 hours after you start the scratch org creation.",
|
|
1176
|
+
"multiple": false,
|
|
1177
|
+
"deprecateAliases": true
|
|
1178
|
+
},
|
|
1179
|
+
"use-most-recent": {
|
|
1180
|
+
"name": "use-most-recent",
|
|
1181
|
+
"type": "boolean",
|
|
1182
|
+
"char": "r",
|
|
1183
|
+
"summary": "Use the job ID of the most recent incomplete scratch org.",
|
|
1184
|
+
"allowNo": false,
|
|
1185
|
+
"deprecateAliases": true
|
|
1186
|
+
}
|
|
1187
|
+
},
|
|
1188
|
+
"args": {}
|
|
1189
|
+
}
|
|
1190
|
+
}
|
|
1191
|
+
}
|