@salesforce/plugin-org 3.0.2 → 3.0.3

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.
Files changed (4) hide show
  1. package/README.md +15 -15
  2. package/oclif.lock +42 -19
  3. package/oclif.manifest.json +432 -432
  4. package/package.json +6 -6
package/oclif.manifest.json CHANGED
@@ -1,15 +1,16 @@
1
1
  {
2
2
  "commands": {
3
- "org:display": {
4
- "aliases": [
5
- "force:org:display"
6
- ],
3
+ "force:org:clone": {
4
+ "aliases": [],
7
5
  "args": {},
8
- "deprecateAliases": true,
9
- "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 \"org login web\" (not \"org login jwt\").",
6
+ "deprecationOptions": {
7
+ "to": "org:create:sandbox",
8
+ "version": "60.0"
9
+ },
10
+ "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\".",
10
11
  "examples": [
11
- "Display information about your default org:\n$ <%= config.bin %> <%= command.id %>",
12
- "Display information, including the sfdxAuthUrl property, about the org with alias TestOrg1:\n$ <%= config.bin %> <%= command.id %> --target-org TestOrg1 --verbose"
12
+ "$ <%= config.bin %> <%= command.id %> -t sandbox -f config/dev-sandbox-def.json -u prodOrg -a MyDevSandbox",
13
+ "$ <%= config.bin %> <%= command.id %> -t sandbox SandboxName=NewClonedSandbox SourceSandboxName=ExistingSandbox -u prodOrg -a MyDevSandbox"
13
14
  ],
14
15
  "flags": {
15
16
  "json": {
@@ -45,12 +46,54 @@
45
46
  "multiple": false,
46
47
  "type": "option"
47
48
  },
48
- "verbose": {
49
- "name": "verbose",
50
- "summary": "Display the sfdxAuthUrl property.",
49
+ "type": {
50
+ "char": "t",
51
+ "name": "type",
52
+ "required": true,
53
+ "summary": "Type of org to create.",
54
+ "hasDynamicHelp": false,
55
+ "multiple": false,
56
+ "options": [
57
+ "sandbox"
58
+ ],
59
+ "type": "option"
60
+ },
61
+ "definitionfile": {
62
+ "char": "f",
63
+ "name": "definitionfile",
64
+ "summary": "Path to the sandbox definition file.",
65
+ "hasDynamicHelp": false,
66
+ "multiple": false,
67
+ "type": "option"
68
+ },
69
+ "setdefaultusername": {
70
+ "char": "s",
71
+ "name": "setdefaultusername",
72
+ "summary": "Set the cloned org as your default.",
51
73
  "allowNo": false,
52
74
  "type": "boolean"
53
75
  },
76
+ "setalias": {
77
+ "char": "a",
78
+ "name": "setalias",
79
+ "summary": "Alias for the cloned org.",
80
+ "hasDynamicHelp": false,
81
+ "multiple": false,
82
+ "type": "option"
83
+ },
84
+ "wait": {
85
+ "char": "w",
86
+ "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.",
87
+ "name": "wait",
88
+ "summary": "Number of minutes to wait while polling for status.",
89
+ "default": {
90
+ "quantity": 6,
91
+ "unit": 0
92
+ },
93
+ "hasDynamicHelp": false,
94
+ "multiple": false,
95
+ "type": "option"
96
+ },
54
97
  "loglevel": {
55
98
  "deprecated": {
56
99
  "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."
@@ -64,44 +107,46 @@
64
107
  },
65
108
  "hasDynamicHelp": true,
66
109
  "hiddenAliases": [],
67
- "id": "org:display",
110
+ "id": "force:org:clone",
68
111
  "pluginAlias": "@salesforce/plugin-org",
69
112
  "pluginName": "@salesforce/plugin-org",
70
113
  "pluginType": "core",
71
- "strict": true,
72
- "summary": "Display information about an org.",
114
+ "state": "deprecated",
115
+ "strict": false,
116
+ "summary": "Clone a sandbox org.",
73
117
  "enableJsonFlag": true,
74
118
  "SF_ENV": "SF_ENV",
119
+ "SANDBOXDEF_SRC_SANDBOXNAME": "SourceSandboxName",
75
120
  "isESM": true,
76
121
  "relativePath": [
77
122
  "lib",
78
123
  "commands",
124
+ "force",
79
125
  "org",
80
- "display.js"
81
- ],
82
- "aliasPermutations": [
83
- "force:org:display",
84
- "org:force:display",
85
- "org:display:force",
86
- "force:display:org",
87
- "display:force:org",
88
- "display:org:force"
126
+ "clone.js"
89
127
  ],
128
+ "aliasPermutations": [],
90
129
  "permutations": [
91
- "org:display",
92
- "display:org"
130
+ "force:org:clone",
131
+ "org:force:clone",
132
+ "org:clone:force",
133
+ "force:clone:org",
134
+ "clone:force:org",
135
+ "clone:org:force"
93
136
  ]
94
137
  },
95
- "org:list": {
96
- "aliases": [
97
- "force:org:list"
98
- ],
138
+ "force:org:create": {
139
+ "aliases": [],
99
140
  "args": {},
100
- "deprecateAliases": true,
141
+ "deprecationOptions": {
142
+ "message": "The force:org:create command is deprecated. Try \"org create scratch\" or \"org create sandbox\" instead."
143
+ },
144
+ "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.",
101
145
  "examples": [
102
- "List all orgs you've created or authenticated to:\n$ <%= config.bin %> <%= command.id %>",
103
- "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",
104
- "List orgs and remove local org authorization info about non-active scratch orgs:\n$ <%= config.bin %> <%= command.id %> --clean"
146
+ "$ <%= config.bin %> <%= command.id %> -f config/enterprise-scratch-def.json -a MyScratchOrg",
147
+ "$ <%= config.bin %> <%= command.id %> edition=Developer -a MyScratchOrg -s -v devHub",
148
+ "$ <%= config.bin %> <%= command.id %> -f config/enterprise-scratch-def.json -a ScratchOrgWithOverrides username=testuser1@mycompany.org",
149
+ "$ <%= config.bin %> <%= command.id %> -t sandbox -f config/dev-sandbox-def.json -a MyDevSandbox -u prodOrg"
105
150
  ],
106
151
  "flags": {
107
152
  "json": {
@@ -111,47 +156,44 @@
111
156
  "allowNo": false,
112
157
  "type": "boolean"
113
158
  },
114
- "verbose": {
115
- "name": "verbose",
116
- "summary": "List more information about each org.",
117
- "allowNo": false,
118
- "type": "boolean"
119
- },
120
- "all": {
121
- "name": "all",
122
- "summary": "Include expired, deleted, and unknown-status scratch orgs.",
123
- "allowNo": false,
124
- "type": "boolean"
125
- },
126
- "clean": {
127
- "name": "clean",
128
- "summary": "Remove all local org authorizations for non-active scratch orgs. Use \"org logout\" to remove non-scratch orgs.",
129
- "allowNo": false,
130
- "type": "boolean"
131
- },
132
- "no-prompt": {
159
+ "target-org": {
133
160
  "aliases": [
134
- "noprompt"
161
+ "targetusername",
162
+ "u"
135
163
  ],
136
- "char": "p",
137
- "dependsOn": [
138
- "clean"
164
+ "char": "o",
165
+ "deprecateAliases": true,
166
+ "name": "target-org",
167
+ "noCacheDefault": true,
168
+ "summary": "Username or alias of the production org that contains the sandbox license.",
169
+ "hasDynamicHelp": true,
170
+ "multiple": false,
171
+ "type": "option"
172
+ },
173
+ "target-dev-hub": {
174
+ "aliases": [
175
+ "targetdevhubusername"
139
176
  ],
177
+ "char": "v",
140
178
  "deprecateAliases": true,
141
- "name": "no-prompt",
142
- "summary": "Don't prompt for confirmation.",
143
- "allowNo": false,
144
- "type": "boolean"
179
+ "name": "target-dev-hub",
180
+ "noCacheDefault": true,
181
+ "required": false,
182
+ "summary": "Username or alias of the Dev Hub org.",
183
+ "hasDynamicHelp": true,
184
+ "multiple": false,
185
+ "type": "option"
145
186
  },
146
- "skip-connection-status": {
187
+ "api-version": {
147
188
  "aliases": [
148
- "skipconnectionstatus"
189
+ "apiversion"
149
190
  ],
150
191
  "deprecateAliases": true,
151
- "name": "skip-connection-status",
152
- "summary": "Skip retrieving the connection status of non-scratch orgs.",
153
- "allowNo": false,
154
- "type": "boolean"
192
+ "description": "Override the api version used for api requests made by this command",
193
+ "name": "api-version",
194
+ "hasDynamicHelp": false,
195
+ "multiple": false,
196
+ "type": "option"
155
197
  },
156
198
  "loglevel": {
157
199
  "deprecated": {
@@ -162,52 +204,135 @@
162
204
  "hasDynamicHelp": false,
163
205
  "multiple": false,
164
206
  "type": "option"
207
+ },
208
+ "type": {
209
+ "char": "t",
210
+ "name": "type",
211
+ "summary": "Type of org to create.",
212
+ "default": "scratch",
213
+ "hasDynamicHelp": false,
214
+ "multiple": false,
215
+ "options": [
216
+ "scratch",
217
+ "sandbox"
218
+ ],
219
+ "type": "option"
220
+ },
221
+ "definitionfile": {
222
+ "char": "f",
223
+ "name": "definitionfile",
224
+ "summary": "Path to an org definition file.",
225
+ "hasDynamicHelp": false,
226
+ "multiple": false,
227
+ "type": "option"
228
+ },
229
+ "nonamespace": {
230
+ "char": "n",
231
+ "name": "nonamespace",
232
+ "summary": "Create the scratch org with no namespace.",
233
+ "allowNo": false,
234
+ "type": "boolean"
235
+ },
236
+ "noancestors": {
237
+ "char": "c",
238
+ "name": "noancestors",
239
+ "summary": "Do not include second-generation package ancestors in the scratch org.",
240
+ "allowNo": false,
241
+ "type": "boolean"
242
+ },
243
+ "clientid": {
244
+ "char": "i",
245
+ "name": "clientid",
246
+ "summary": "Connected app consumer key; not supported for sandbox org creation.",
247
+ "hasDynamicHelp": false,
248
+ "multiple": false,
249
+ "type": "option"
250
+ },
251
+ "setdefaultusername": {
252
+ "char": "s",
253
+ "name": "setdefaultusername",
254
+ "summary": "Set the created org as the default username.",
255
+ "allowNo": false,
256
+ "type": "boolean"
257
+ },
258
+ "setalias": {
259
+ "char": "a",
260
+ "name": "setalias",
261
+ "summary": "Alias for the created org.",
262
+ "hasDynamicHelp": false,
263
+ "multiple": false,
264
+ "type": "option"
265
+ },
266
+ "wait": {
267
+ "char": "w",
268
+ "name": "wait",
269
+ "summary": "Streaming client socket timeout (in minutes).",
270
+ "default": {
271
+ "quantity": 6,
272
+ "unit": 0
273
+ },
274
+ "hasDynamicHelp": false,
275
+ "multiple": false,
276
+ "type": "option"
277
+ },
278
+ "durationdays": {
279
+ "char": "d",
280
+ "name": "durationdays",
281
+ "summary": "Duration of the scratch org (in days) (default:7, min:1, max:30).",
282
+ "default": 7,
283
+ "hasDynamicHelp": false,
284
+ "multiple": false,
285
+ "type": "option"
286
+ },
287
+ "retry": {
288
+ "hidden": true,
289
+ "name": "retry",
290
+ "summary": "Number of scratch org auth retries after scratch org is successfully signed up.",
291
+ "default": 0,
292
+ "hasDynamicHelp": false,
293
+ "multiple": false,
294
+ "type": "option"
165
295
  }
166
296
  },
167
- "hasDynamicHelp": false,
297
+ "hasDynamicHelp": true,
168
298
  "hiddenAliases": [],
169
- "id": "org:list",
299
+ "id": "force:org:create",
170
300
  "pluginAlias": "@salesforce/plugin-org",
171
301
  "pluginName": "@salesforce/plugin-org",
172
302
  "pluginType": "core",
173
- "strict": true,
174
- "summary": "List all orgs you’ve created or authenticated to.",
303
+ "state": "deprecated",
304
+ "strict": false,
305
+ "summary": "Create a scratch org or sandbox.",
175
306
  "enableJsonFlag": true,
176
307
  "SF_ENV": "SF_ENV",
177
308
  "isESM": true,
178
309
  "relativePath": [
179
310
  "lib",
180
311
  "commands",
312
+ "force",
181
313
  "org",
182
- "list.js"
183
- ],
184
- "aliasPermutations": [
185
- "force:org:list",
186
- "org:force:list",
187
- "org:list:force",
188
- "force:list:org",
189
- "list:force:org",
190
- "list:org:force"
314
+ "create.js"
191
315
  ],
316
+ "aliasPermutations": [],
192
317
  "permutations": [
193
- "org:list",
194
- "list:org"
318
+ "force:org:create",
319
+ "org:force:create",
320
+ "org:create:force",
321
+ "force:create:org",
322
+ "create:force:org",
323
+ "create:org:force"
195
324
  ]
196
325
  },
197
- "org:open": {
198
- "aliases": [
199
- "force:org:open",
200
- "force:source:open"
201
- ],
326
+ "force:org:delete": {
327
+ "aliases": [],
202
328
  "args": {},
203
- "deprecateAliases": true,
204
- "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\nUse the --source-file to open a Lightning Page from your local project in Lightning App Builder. Lightning page files have the suffix .flexipage-meta.xml, and are stored in the \"flexipages\" directory.\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.",
329
+ "deprecationOptions": {
330
+ "message": "The force:org:delete command is deprecated. Try \"org delete scratch\" or \"org delete sandbox\" instead."
331
+ },
332
+ "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.",
205
333
  "examples": [
206
- "Open your default org in your default browser:\n$ <%= config.bin %> <%= command.id %>",
207
- "Open the org with alias MyTestOrg1 in the Firefox browser:\n$ <%= config.bin %> <%= command.id %> --target-org MyTestOrg1 --browser firefox",
208
- "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",
209
- "Open a local Lightning page in your default org's Lightning App Builder:\n$ <%= config.bin %> <%= command.id %> --source-file force-app/main/default/flexipages/Hello.flexipage-meta.xml",
210
- "Open a local Flow in Flow Builder:\n$ <%= config.bin %> <%= command.id %> --source-file force-app/main/default/flows/Hello.flow-meta.xml"
334
+ "$ <%= config.bin %> <%= command.id %> -u me@my.org",
335
+ "$ <%= config.bin %> <%= command.id %> -u MyOrgAlias -p"
211
336
  ],
212
337
  "flags": {
213
338
  "json": {
@@ -225,60 +350,44 @@
225
350
  "char": "o",
226
351
  "deprecateAliases": true,
227
352
  "name": "target-org",
228
- "noCacheDefault": true,
229
353
  "required": true,
230
354
  "summary": "Username or alias of the target org.",
231
355
  "hasDynamicHelp": true,
232
356
  "multiple": false,
233
357
  "type": "option"
234
358
  },
235
- "api-version": {
236
- "aliases": [
237
- "apiversion"
238
- ],
239
- "deprecateAliases": true,
240
- "description": "Override the api version used for api requests made by this command",
241
- "name": "api-version",
242
- "hasDynamicHelp": false,
243
- "multiple": false,
244
- "type": "option"
245
- },
246
- "browser": {
247
- "char": "b",
248
- "exclusive": [
249
- "url-only"
250
- ],
251
- "name": "browser",
252
- "summary": "Browser where the org opens.",
359
+ "targetdevhubusername": {
360
+ "char": "v",
361
+ "deprecated": {
362
+ "version": "58.0",
363
+ "message": "The targetdevhubusername flag exists only for backwards compatibility. It is not necessary and has no effect."
364
+ },
365
+ "hidden": true,
366
+ "name": "targetdevhubusername",
367
+ "summary": "The targetdevhubusername flag exists only for backwards compatibility. It is not necessary and has no effect.",
253
368
  "hasDynamicHelp": false,
254
369
  "multiple": false,
255
- "options": [
256
- "chrome",
257
- "edge",
258
- "firefox"
259
- ],
260
370
  "type": "option"
261
- },
262
- "path": {
263
- "char": "p",
264
- "env": "FORCE_OPEN_URL",
265
- "exclusive": [
266
- "source-file"
371
+ },
372
+ "api-version": {
373
+ "aliases": [
374
+ "apiversion"
267
375
  ],
268
- "name": "path",
269
- "summary": "Navigation URL path to open a specific page.",
376
+ "deprecateAliases": true,
377
+ "description": "Override the api version used for api requests made by this command",
378
+ "name": "api-version",
270
379
  "hasDynamicHelp": false,
271
380
  "multiple": false,
272
381
  "type": "option"
273
382
  },
274
- "url-only": {
383
+ "no-prompt": {
275
384
  "aliases": [
276
- "urlonly"
385
+ "noprompt"
277
386
  ],
278
- "char": "r",
387
+ "char": "p",
279
388
  "deprecateAliases": true,
280
- "name": "url-only",
281
- "summary": "Display navigation URL, but don’t launch browser.",
389
+ "name": "no-prompt",
390
+ "summary": "No prompt to confirm deletion.",
282
391
  "allowNo": false,
283
392
  "type": "boolean"
284
393
  },
@@ -291,70 +400,48 @@
291
400
  "hasDynamicHelp": false,
292
401
  "multiple": false,
293
402
  "type": "option"
294
- },
295
- "source-file": {
296
- "aliases": [
297
- "sourcefile"
298
- ],
299
- "char": "f",
300
- "deprecateAliases": true,
301
- "exclusive": [
302
- "path"
303
- ],
304
- "name": "source-file",
305
- "summary": "Path to an ApexPage or FlexiPage to open in Lightning App Builder.",
306
- "hasDynamicHelp": false,
307
- "multiple": false,
308
- "type": "option"
309
403
  }
310
404
  },
311
405
  "hasDynamicHelp": true,
312
406
  "hiddenAliases": [],
313
- "id": "org:open",
407
+ "id": "force:org:delete",
314
408
  "pluginAlias": "@salesforce/plugin-org",
315
409
  "pluginName": "@salesforce/plugin-org",
316
410
  "pluginType": "core",
411
+ "state": "deprecated",
317
412
  "strict": true,
318
- "summary": "Open your default scratch org, or another specified org, in a browser.",
413
+ "summary": "Delete a scratch or sandbox org.",
319
414
  "enableJsonFlag": true,
320
415
  "SF_ENV": "SF_ENV",
321
416
  "isESM": true,
322
417
  "relativePath": [
323
418
  "lib",
324
419
  "commands",
420
+ "force",
325
421
  "org",
326
- "open.js"
327
- ],
328
- "aliasPermutations": [
329
- "force:org:open",
330
- "org:force:open",
331
- "org:open:force",
332
- "force:open:org",
333
- "open:force:org",
334
- "open:org:force",
335
- "force:source:open",
336
- "source:force:open",
337
- "source:open:force",
338
- "force:open:source",
339
- "open:force:source",
340
- "open:source:force"
422
+ "delete.js"
341
423
  ],
424
+ "aliasPermutations": [],
342
425
  "permutations": [
343
- "org:open",
344
- "open:org"
426
+ "force:org:delete",
427
+ "org:force:delete",
428
+ "org:delete:force",
429
+ "force:delete:org",
430
+ "delete:force:org",
431
+ "delete:org:force"
345
432
  ]
346
433
  },
347
- "force:org:clone": {
434
+ "force:org:status": {
348
435
  "aliases": [],
349
436
  "args": {},
350
437
  "deprecationOptions": {
351
- "to": "org:create:sandbox",
438
+ "to": "org:resume:sandbox",
352
439
  "version": "60.0"
353
440
  },
354
- "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\".",
441
+ "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.",
355
442
  "examples": [
356
- "$ <%= config.bin %> <%= command.id %> -t sandbox -f config/dev-sandbox-def.json -u prodOrg -a MyDevSandbox",
357
- "$ <%= config.bin %> <%= command.id %> -t sandbox SandboxName=NewClonedSandbox SourceSandboxName=ExistingSandbox -u prodOrg -a MyDevSandbox"
443
+ "$ <%= config.bin %> <%= command.id %> --sandboxname DevSbx1 --setalias MySandbox -u prodOrg",
444
+ "$ <%= config.bin %> <%= command.id %> --sandboxname DevSbx1 --wait 45 --setdefaultusername -u prodOrg"
358
445
  ],
359
446
  "flags": {
360
447
  "json": {
@@ -390,22 +477,11 @@
390
477
  "multiple": false,
391
478
  "type": "option"
392
479
  },
393
- "type": {
394
- "char": "t",
395
- "name": "type",
480
+ "sandboxname": {
481
+ "char": "n",
482
+ "name": "sandboxname",
396
483
  "required": true,
397
- "summary": "Type of org to create.",
398
- "hasDynamicHelp": false,
399
- "multiple": false,
400
- "options": [
401
- "sandbox"
402
- ],
403
- "type": "option"
404
- },
405
- "definitionfile": {
406
- "char": "f",
407
- "name": "definitionfile",
408
- "summary": "Path to the sandbox definition file.",
484
+ "summary": "Name of the sandbox org to check status for.",
409
485
  "hasDynamicHelp": false,
410
486
  "multiple": false,
411
487
  "type": "option"
@@ -413,21 +489,20 @@
413
489
  "setdefaultusername": {
414
490
  "char": "s",
415
491
  "name": "setdefaultusername",
416
- "summary": "Set the cloned org as your default.",
492
+ "summary": "Set the created or cloned org as your default.",
417
493
  "allowNo": false,
418
494
  "type": "boolean"
419
495
  },
420
496
  "setalias": {
421
497
  "char": "a",
422
498
  "name": "setalias",
423
- "summary": "Alias for the cloned org.",
499
+ "summary": "Alias for the created or cloned org.",
424
500
  "hasDynamicHelp": false,
425
501
  "multiple": false,
426
502
  "type": "option"
427
503
  },
428
504
  "wait": {
429
505
  "char": "w",
430
- "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.",
431
506
  "name": "wait",
432
507
  "summary": "Number of minutes to wait while polling for status.",
433
508
  "default": {
@@ -451,46 +526,43 @@
451
526
  },
452
527
  "hasDynamicHelp": true,
453
528
  "hiddenAliases": [],
454
- "id": "force:org:clone",
529
+ "id": "force:org:status",
455
530
  "pluginAlias": "@salesforce/plugin-org",
456
531
  "pluginName": "@salesforce/plugin-org",
457
532
  "pluginType": "core",
458
533
  "state": "deprecated",
459
- "strict": false,
460
- "summary": "Clone a sandbox org.",
534
+ "strict": true,
535
+ "summary": "Check the status of a sandbox, and if complete, authenticate to it.",
461
536
  "enableJsonFlag": true,
462
537
  "SF_ENV": "SF_ENV",
463
- "SANDBOXDEF_SRC_SANDBOXNAME": "SourceSandboxName",
464
538
  "isESM": true,
465
539
  "relativePath": [
466
540
  "lib",
467
541
  "commands",
468
542
  "force",
469
543
  "org",
470
- "clone.js"
544
+ "status.js"
471
545
  ],
472
546
  "aliasPermutations": [],
473
547
  "permutations": [
474
- "force:org:clone",
475
- "org:force:clone",
476
- "org:clone:force",
477
- "force:clone:org",
478
- "clone:force:org",
479
- "clone:org:force"
548
+ "force:org:status",
549
+ "org:force:status",
550
+ "org:status:force",
551
+ "force:status:org",
552
+ "status:force:org",
553
+ "status:org:force"
480
554
  ]
481
555
  },
482
- "force:org:create": {
483
- "aliases": [],
556
+ "org:display": {
557
+ "aliases": [
558
+ "force:org:display"
559
+ ],
484
560
  "args": {},
485
- "deprecationOptions": {
486
- "message": "The force:org:create command is deprecated. Try \"org create scratch\" or \"org create sandbox\" instead."
487
- },
488
- "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.",
561
+ "deprecateAliases": true,
562
+ "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 \"org login web\" (not \"org login jwt\").",
489
563
  "examples": [
490
- "$ <%= config.bin %> <%= command.id %> -f config/enterprise-scratch-def.json -a MyScratchOrg",
491
- "$ <%= config.bin %> <%= command.id %> edition=Developer -a MyScratchOrg -s -v devHub",
492
- "$ <%= config.bin %> <%= command.id %> -f config/enterprise-scratch-def.json -a ScratchOrgWithOverrides username=testuser1@mycompany.org",
493
- "$ <%= config.bin %> <%= command.id %> -t sandbox -f config/dev-sandbox-def.json -a MyDevSandbox -u prodOrg"
564
+ "Display information about your default org:\n$ <%= config.bin %> <%= command.id %>",
565
+ "Display information, including the sfdxAuthUrl property, about the org with alias TestOrg1:\n$ <%= config.bin %> <%= command.id %> --target-org TestOrg1 --verbose"
494
566
  ],
495
567
  "flags": {
496
568
  "json": {
@@ -509,21 +581,8 @@
509
581
  "deprecateAliases": true,
510
582
  "name": "target-org",
511
583
  "noCacheDefault": true,
512
- "summary": "Username or alias of the production org that contains the sandbox license.",
513
- "hasDynamicHelp": true,
514
- "multiple": false,
515
- "type": "option"
516
- },
517
- "target-dev-hub": {
518
- "aliases": [
519
- "targetdevhubusername"
520
- ],
521
- "char": "v",
522
- "deprecateAliases": true,
523
- "name": "target-dev-hub",
524
- "noCacheDefault": true,
525
- "required": false,
526
- "summary": "Username or alias of the Dev Hub org.",
584
+ "required": true,
585
+ "summary": "Username or alias of the target org.",
527
586
  "hasDynamicHelp": true,
528
587
  "multiple": false,
529
588
  "type": "option"
@@ -539,6 +598,12 @@
539
598
  "multiple": false,
540
599
  "type": "option"
541
600
  },
601
+ "verbose": {
602
+ "name": "verbose",
603
+ "summary": "Display the sfdxAuthUrl property.",
604
+ "allowNo": false,
605
+ "type": "boolean"
606
+ },
542
607
  "loglevel": {
543
608
  "deprecated": {
544
609
  "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."
@@ -548,135 +613,48 @@
548
613
  "hasDynamicHelp": false,
549
614
  "multiple": false,
550
615
  "type": "option"
551
- },
552
- "type": {
553
- "char": "t",
554
- "name": "type",
555
- "summary": "Type of org to create.",
556
- "default": "scratch",
557
- "hasDynamicHelp": false,
558
- "multiple": false,
559
- "options": [
560
- "scratch",
561
- "sandbox"
562
- ],
563
- "type": "option"
564
- },
565
- "definitionfile": {
566
- "char": "f",
567
- "name": "definitionfile",
568
- "summary": "Path to an org definition file.",
569
- "hasDynamicHelp": false,
570
- "multiple": false,
571
- "type": "option"
572
- },
573
- "nonamespace": {
574
- "char": "n",
575
- "name": "nonamespace",
576
- "summary": "Create the scratch org with no namespace.",
577
- "allowNo": false,
578
- "type": "boolean"
579
- },
580
- "noancestors": {
581
- "char": "c",
582
- "name": "noancestors",
583
- "summary": "Do not include second-generation package ancestors in the scratch org.",
584
- "allowNo": false,
585
- "type": "boolean"
586
- },
587
- "clientid": {
588
- "char": "i",
589
- "name": "clientid",
590
- "summary": "Connected app consumer key; not supported for sandbox org creation.",
591
- "hasDynamicHelp": false,
592
- "multiple": false,
593
- "type": "option"
594
- },
595
- "setdefaultusername": {
596
- "char": "s",
597
- "name": "setdefaultusername",
598
- "summary": "Set the created org as the default username.",
599
- "allowNo": false,
600
- "type": "boolean"
601
- },
602
- "setalias": {
603
- "char": "a",
604
- "name": "setalias",
605
- "summary": "Alias for the created org.",
606
- "hasDynamicHelp": false,
607
- "multiple": false,
608
- "type": "option"
609
- },
610
- "wait": {
611
- "char": "w",
612
- "name": "wait",
613
- "summary": "Streaming client socket timeout (in minutes).",
614
- "default": {
615
- "quantity": 6,
616
- "unit": 0
617
- },
618
- "hasDynamicHelp": false,
619
- "multiple": false,
620
- "type": "option"
621
- },
622
- "durationdays": {
623
- "char": "d",
624
- "name": "durationdays",
625
- "summary": "Duration of the scratch org (in days) (default:7, min:1, max:30).",
626
- "default": 7,
627
- "hasDynamicHelp": false,
628
- "multiple": false,
629
- "type": "option"
630
- },
631
- "retry": {
632
- "hidden": true,
633
- "name": "retry",
634
- "summary": "Number of scratch org auth retries after scratch org is successfully signed up.",
635
- "default": 0,
636
- "hasDynamicHelp": false,
637
- "multiple": false,
638
- "type": "option"
639
616
  }
640
617
  },
641
618
  "hasDynamicHelp": true,
642
619
  "hiddenAliases": [],
643
- "id": "force:org:create",
620
+ "id": "org:display",
644
621
  "pluginAlias": "@salesforce/plugin-org",
645
- "pluginName": "@salesforce/plugin-org",
646
- "pluginType": "core",
647
- "state": "deprecated",
648
- "strict": false,
649
- "summary": "Create a scratch org or sandbox.",
622
+ "pluginName": "@salesforce/plugin-org",
623
+ "pluginType": "core",
624
+ "strict": true,
625
+ "summary": "Display information about an org.",
650
626
  "enableJsonFlag": true,
651
627
  "SF_ENV": "SF_ENV",
652
628
  "isESM": true,
653
629
  "relativePath": [
654
630
  "lib",
655
631
  "commands",
656
- "force",
657
632
  "org",
658
- "create.js"
633
+ "display.js"
634
+ ],
635
+ "aliasPermutations": [
636
+ "force:org:display",
637
+ "org:force:display",
638
+ "org:display:force",
639
+ "force:display:org",
640
+ "display:force:org",
641
+ "display:org:force"
659
642
  ],
660
- "aliasPermutations": [],
661
643
  "permutations": [
662
- "force:org:create",
663
- "org:force:create",
664
- "org:create:force",
665
- "force:create:org",
666
- "create:force:org",
667
- "create:org:force"
644
+ "org:display",
645
+ "display:org"
668
646
  ]
669
647
  },
670
- "force:org:delete": {
671
- "aliases": [],
648
+ "org:list": {
649
+ "aliases": [
650
+ "force:org:list"
651
+ ],
672
652
  "args": {},
673
- "deprecationOptions": {
674
- "message": "The force:org:delete command is deprecated. Try \"org delete scratch\" or \"org delete sandbox\" instead."
675
- },
676
- "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.",
653
+ "deprecateAliases": true,
677
654
  "examples": [
678
- "$ <%= config.bin %> <%= command.id %> -u me@my.org",
679
- "$ <%= config.bin %> <%= command.id %> -u MyOrgAlias -p"
655
+ "List all orgs you've created or authenticated to:\n$ <%= config.bin %> <%= command.id %>",
656
+ "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",
657
+ "List orgs and remove local org authorization info about non-active scratch orgs:\n$ <%= config.bin %> <%= command.id %> --clean"
680
658
  ],
681
659
  "flags": {
682
660
  "json": {
@@ -686,52 +664,45 @@
686
664
  "allowNo": false,
687
665
  "type": "boolean"
688
666
  },
689
- "target-org": {
690
- "aliases": [
691
- "targetusername",
692
- "u"
693
- ],
694
- "char": "o",
695
- "deprecateAliases": true,
696
- "name": "target-org",
697
- "required": true,
698
- "summary": "Username or alias of the target org.",
699
- "hasDynamicHelp": true,
700
- "multiple": false,
701
- "type": "option"
667
+ "verbose": {
668
+ "name": "verbose",
669
+ "summary": "List more information about each org.",
670
+ "allowNo": false,
671
+ "type": "boolean"
702
672
  },
703
- "targetdevhubusername": {
704
- "char": "v",
705
- "deprecated": {
706
- "version": "58.0",
707
- "message": "The targetdevhubusername flag exists only for backwards compatibility. It is not necessary and has no effect."
708
- },
709
- "hidden": true,
710
- "name": "targetdevhubusername",
711
- "summary": "The targetdevhubusername flag exists only for backwards compatibility. It is not necessary and has no effect.",
712
- "hasDynamicHelp": false,
713
- "multiple": false,
714
- "type": "option"
673
+ "all": {
674
+ "name": "all",
675
+ "summary": "Include expired, deleted, and unknown-status scratch orgs.",
676
+ "allowNo": false,
677
+ "type": "boolean"
715
678
  },
716
- "api-version": {
717
- "aliases": [
718
- "apiversion"
719
- ],
720
- "deprecateAliases": true,
721
- "description": "Override the api version used for api requests made by this command",
722
- "name": "api-version",
723
- "hasDynamicHelp": false,
724
- "multiple": false,
725
- "type": "option"
679
+ "clean": {
680
+ "name": "clean",
681
+ "summary": "Remove all local org authorizations for non-active scratch orgs. Use \"org logout\" to remove non-scratch orgs.",
682
+ "allowNo": false,
683
+ "type": "boolean"
726
684
  },
727
685
  "no-prompt": {
728
686
  "aliases": [
729
687
  "noprompt"
730
688
  ],
731
689
  "char": "p",
690
+ "dependsOn": [
691
+ "clean"
692
+ ],
732
693
  "deprecateAliases": true,
733
694
  "name": "no-prompt",
734
- "summary": "No prompt to confirm deletion.",
695
+ "summary": "Don't prompt for confirmation.",
696
+ "allowNo": false,
697
+ "type": "boolean"
698
+ },
699
+ "skip-connection-status": {
700
+ "aliases": [
701
+ "skipconnectionstatus"
702
+ ],
703
+ "deprecateAliases": true,
704
+ "name": "skip-connection-status",
705
+ "summary": "Skip retrieving the connection status of non-scratch orgs.",
735
706
  "allowNo": false,
736
707
  "type": "boolean"
737
708
  },
@@ -746,46 +717,50 @@
746
717
  "type": "option"
747
718
  }
748
719
  },
749
- "hasDynamicHelp": true,
720
+ "hasDynamicHelp": false,
750
721
  "hiddenAliases": [],
751
- "id": "force:org:delete",
722
+ "id": "org:list",
752
723
  "pluginAlias": "@salesforce/plugin-org",
753
724
  "pluginName": "@salesforce/plugin-org",
754
725
  "pluginType": "core",
755
- "state": "deprecated",
756
726
  "strict": true,
757
- "summary": "Delete a scratch or sandbox org.",
727
+ "summary": "List all orgs you’ve created or authenticated to.",
758
728
  "enableJsonFlag": true,
759
729
  "SF_ENV": "SF_ENV",
760
730
  "isESM": true,
761
731
  "relativePath": [
762
732
  "lib",
763
733
  "commands",
764
- "force",
765
734
  "org",
766
- "delete.js"
735
+ "list.js"
736
+ ],
737
+ "aliasPermutations": [
738
+ "force:org:list",
739
+ "org:force:list",
740
+ "org:list:force",
741
+ "force:list:org",
742
+ "list:force:org",
743
+ "list:org:force"
767
744
  ],
768
- "aliasPermutations": [],
769
745
  "permutations": [
770
- "force:org:delete",
771
- "org:force:delete",
772
- "org:delete:force",
773
- "force:delete:org",
774
- "delete:force:org",
775
- "delete:org:force"
746
+ "org:list",
747
+ "list:org"
776
748
  ]
777
749
  },
778
- "force:org:status": {
779
- "aliases": [],
750
+ "org:open": {
751
+ "aliases": [
752
+ "force:org:open",
753
+ "force:source:open"
754
+ ],
780
755
  "args": {},
781
- "deprecationOptions": {
782
- "to": "org:resume:sandbox",
783
- "version": "60.0"
784
- },
785
- "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.",
756
+ "deprecateAliases": true,
757
+ "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\nUse the --source-file to open a Lightning Page from your local project in Lightning App Builder. Lightning page files have the suffix .flexipage-meta.xml, and are stored in the \"flexipages\" directory.\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.",
786
758
  "examples": [
787
- "$ <%= config.bin %> <%= command.id %> --sandboxname DevSbx1 --setalias MySandbox -u prodOrg",
788
- "$ <%= config.bin %> <%= command.id %> --sandboxname DevSbx1 --wait 45 --setdefaultusername -u prodOrg"
759
+ "Open your default org in your default browser:\n$ <%= config.bin %> <%= command.id %>",
760
+ "Open the org with alias MyTestOrg1 in the Firefox browser:\n$ <%= config.bin %> <%= command.id %> --target-org MyTestOrg1 --browser firefox",
761
+ "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",
762
+ "Open a local Lightning page in your default org's Lightning App Builder:\n$ <%= config.bin %> <%= command.id %> --source-file force-app/main/default/flexipages/Hello.flexipage-meta.xml",
763
+ "Open a local Flow in Flow Builder:\n$ <%= config.bin %> <%= command.id %> --source-file force-app/main/default/flows/Hello.flow-meta.xml"
789
764
  ],
790
765
  "flags": {
791
766
  "json": {
@@ -821,41 +796,44 @@
821
796
  "multiple": false,
822
797
  "type": "option"
823
798
  },
824
- "sandboxname": {
825
- "char": "n",
826
- "name": "sandboxname",
827
- "required": true,
828
- "summary": "Name of the sandbox org to check status for.",
799
+ "browser": {
800
+ "char": "b",
801
+ "exclusive": [
802
+ "url-only"
803
+ ],
804
+ "name": "browser",
805
+ "summary": "Browser where the org opens.",
829
806
  "hasDynamicHelp": false,
830
807
  "multiple": false,
808
+ "options": [
809
+ "chrome",
810
+ "edge",
811
+ "firefox"
812
+ ],
831
813
  "type": "option"
832
814
  },
833
- "setdefaultusername": {
834
- "char": "s",
835
- "name": "setdefaultusername",
836
- "summary": "Set the created or cloned org as your default.",
837
- "allowNo": false,
838
- "type": "boolean"
839
- },
840
- "setalias": {
841
- "char": "a",
842
- "name": "setalias",
843
- "summary": "Alias for the created or cloned org.",
815
+ "path": {
816
+ "char": "p",
817
+ "env": "FORCE_OPEN_URL",
818
+ "exclusive": [
819
+ "source-file"
820
+ ],
821
+ "name": "path",
822
+ "summary": "Navigation URL path to open a specific page.",
844
823
  "hasDynamicHelp": false,
845
824
  "multiple": false,
846
825
  "type": "option"
847
826
  },
848
- "wait": {
849
- "char": "w",
850
- "name": "wait",
851
- "summary": "Number of minutes to wait while polling for status.",
852
- "default": {
853
- "quantity": 6,
854
- "unit": 0
855
- },
856
- "hasDynamicHelp": false,
857
- "multiple": false,
858
- "type": "option"
827
+ "url-only": {
828
+ "aliases": [
829
+ "urlonly"
830
+ ],
831
+ "char": "r",
832
+ "deprecateAliases": true,
833
+ "name": "url-only",
834
+ "summary": "Display navigation URL, but don’t launch browser.",
835
+ "allowNo": false,
836
+ "type": "boolean"
859
837
  },
860
838
  "loglevel": {
861
839
  "deprecated": {
@@ -866,35 +844,57 @@
866
844
  "hasDynamicHelp": false,
867
845
  "multiple": false,
868
846
  "type": "option"
847
+ },
848
+ "source-file": {
849
+ "aliases": [
850
+ "sourcefile"
851
+ ],
852
+ "char": "f",
853
+ "deprecateAliases": true,
854
+ "exclusive": [
855
+ "path"
856
+ ],
857
+ "name": "source-file",
858
+ "summary": "Path to an ApexPage or FlexiPage to open in Lightning App Builder.",
859
+ "hasDynamicHelp": false,
860
+ "multiple": false,
861
+ "type": "option"
869
862
  }
870
863
  },
871
864
  "hasDynamicHelp": true,
872
865
  "hiddenAliases": [],
873
- "id": "force:org:status",
866
+ "id": "org:open",
874
867
  "pluginAlias": "@salesforce/plugin-org",
875
868
  "pluginName": "@salesforce/plugin-org",
876
869
  "pluginType": "core",
877
- "state": "deprecated",
878
870
  "strict": true,
879
- "summary": "Check the status of a sandbox, and if complete, authenticate to it.",
871
+ "summary": "Open your default scratch org, or another specified org, in a browser.",
880
872
  "enableJsonFlag": true,
881
873
  "SF_ENV": "SF_ENV",
882
874
  "isESM": true,
883
875
  "relativePath": [
884
876
  "lib",
885
877
  "commands",
886
- "force",
887
878
  "org",
888
- "status.js"
879
+ "open.js"
880
+ ],
881
+ "aliasPermutations": [
882
+ "force:org:open",
883
+ "org:force:open",
884
+ "org:open:force",
885
+ "force:open:org",
886
+ "open:force:org",
887
+ "open:org:force",
888
+ "force:source:open",
889
+ "source:force:open",
890
+ "source:open:force",
891
+ "force:open:source",
892
+ "open:force:source",
893
+ "open:source:force"
889
894
  ],
890
- "aliasPermutations": [],
891
895
  "permutations": [
892
- "force:org:status",
893
- "org:force:status",
894
- "org:status:force",
895
- "force:status:org",
896
- "status:force:org",
897
- "status:org:force"
896
+ "org:open",
897
+ "open:org"
898
898
  ]
899
899
  },
900
900
  "org:create:sandbox": {
@@ -1903,5 +1903,5 @@
1903
1903
  ]
1904
1904
  }
1905
1905
  },
1906
- "version": "3.0.2"
1906
+ "version": "3.0.3"
1907
1907
  }