@salesforce/plugin-org 3.0.3 → 3.0.4

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 +4 -4
  3. package/oclif.manifest.json +430 -430
  4. package/package.json +4 -4
package/oclif.manifest.json CHANGED
@@ -1,16 +1,15 @@
1
1
  {
2
2
  "commands": {
3
- "force:org:clone": {
4
- "aliases": [],
3
+ "org:display": {
4
+ "aliases": [
5
+ "force:org:display"
6
+ ],
5
7
  "args": {},
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\".",
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\").",
11
10
  "examples": [
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"
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"
14
13
  ],
15
14
  "flags": {
16
15
  "json": {
@@ -46,54 +45,12 @@
46
45
  "multiple": false,
47
46
  "type": "option"
48
47
  },
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.",
48
+ "verbose": {
49
+ "name": "verbose",
50
+ "summary": "Display the sfdxAuthUrl property.",
73
51
  "allowNo": false,
74
52
  "type": "boolean"
75
53
  },
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
- },
97
54
  "loglevel": {
98
55
  "deprecated": {
99
56
  "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."
@@ -107,46 +64,44 @@
107
64
  },
108
65
  "hasDynamicHelp": true,
109
66
  "hiddenAliases": [],
110
- "id": "force:org:clone",
67
+ "id": "org:display",
111
68
  "pluginAlias": "@salesforce/plugin-org",
112
69
  "pluginName": "@salesforce/plugin-org",
113
70
  "pluginType": "core",
114
- "state": "deprecated",
115
- "strict": false,
116
- "summary": "Clone a sandbox org.",
71
+ "strict": true,
72
+ "summary": "Display information about an org.",
117
73
  "enableJsonFlag": true,
118
74
  "SF_ENV": "SF_ENV",
119
- "SANDBOXDEF_SRC_SANDBOXNAME": "SourceSandboxName",
120
75
  "isESM": true,
121
76
  "relativePath": [
122
77
  "lib",
123
78
  "commands",
124
- "force",
125
79
  "org",
126
- "clone.js"
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"
127
89
  ],
128
- "aliasPermutations": [],
129
90
  "permutations": [
130
- "force:org:clone",
131
- "org:force:clone",
132
- "org:clone:force",
133
- "force:clone:org",
134
- "clone:force:org",
135
- "clone:org:force"
91
+ "org:display",
92
+ "display:org"
136
93
  ]
137
94
  },
138
- "force:org:create": {
139
- "aliases": [],
95
+ "org:list": {
96
+ "aliases": [
97
+ "force:org:list"
98
+ ],
140
99
  "args": {},
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.",
100
+ "deprecateAliases": true,
145
101
  "examples": [
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"
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"
150
105
  ],
151
106
  "flags": {
152
107
  "json": {
@@ -156,44 +111,47 @@
156
111
  "allowNo": false,
157
112
  "type": "boolean"
158
113
  },
159
- "target-org": {
160
- "aliases": [
161
- "targetusername",
162
- "u"
163
- ],
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"
114
+ "verbose": {
115
+ "name": "verbose",
116
+ "summary": "List more information about each org.",
117
+ "allowNo": false,
118
+ "type": "boolean"
172
119
  },
173
- "target-dev-hub": {
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": {
174
133
  "aliases": [
175
- "targetdevhubusername"
134
+ "noprompt"
135
+ ],
136
+ "char": "p",
137
+ "dependsOn": [
138
+ "clean"
176
139
  ],
177
- "char": "v",
178
140
  "deprecateAliases": true,
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"
141
+ "name": "no-prompt",
142
+ "summary": "Don't prompt for confirmation.",
143
+ "allowNo": false,
144
+ "type": "boolean"
186
145
  },
187
- "api-version": {
146
+ "skip-connection-status": {
188
147
  "aliases": [
189
- "apiversion"
148
+ "skipconnectionstatus"
190
149
  ],
191
150
  "deprecateAliases": true,
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"
151
+ "name": "skip-connection-status",
152
+ "summary": "Skip retrieving the connection status of non-scratch orgs.",
153
+ "allowNo": false,
154
+ "type": "boolean"
197
155
  },
198
156
  "loglevel": {
199
157
  "deprecated": {
@@ -204,135 +162,52 @@
204
162
  "hasDynamicHelp": false,
205
163
  "multiple": false,
206
164
  "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"
295
165
  }
296
166
  },
297
- "hasDynamicHelp": true,
167
+ "hasDynamicHelp": false,
298
168
  "hiddenAliases": [],
299
- "id": "force:org:create",
169
+ "id": "org:list",
300
170
  "pluginAlias": "@salesforce/plugin-org",
301
171
  "pluginName": "@salesforce/plugin-org",
302
172
  "pluginType": "core",
303
- "state": "deprecated",
304
- "strict": false,
305
- "summary": "Create a scratch org or sandbox.",
173
+ "strict": true,
174
+ "summary": "List all orgs you’ve created or authenticated to.",
306
175
  "enableJsonFlag": true,
307
176
  "SF_ENV": "SF_ENV",
308
177
  "isESM": true,
309
178
  "relativePath": [
310
179
  "lib",
311
180
  "commands",
312
- "force",
313
181
  "org",
314
- "create.js"
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"
315
191
  ],
316
- "aliasPermutations": [],
317
192
  "permutations": [
318
- "force:org:create",
319
- "org:force:create",
320
- "org:create:force",
321
- "force:create:org",
322
- "create:force:org",
323
- "create:org:force"
193
+ "org:list",
194
+ "list:org"
324
195
  ]
325
196
  },
326
- "force:org:delete": {
327
- "aliases": [],
197
+ "org:open": {
198
+ "aliases": [
199
+ "force:org:open",
200
+ "force:source:open"
201
+ ],
328
202
  "args": {},
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.",
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.",
333
205
  "examples": [
334
- "$ <%= config.bin %> <%= command.id %> -u me@my.org",
335
- "$ <%= config.bin %> <%= command.id %> -u MyOrgAlias -p"
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"
336
211
  ],
337
212
  "flags": {
338
213
  "json": {
@@ -350,44 +225,60 @@
350
225
  "char": "o",
351
226
  "deprecateAliases": true,
352
227
  "name": "target-org",
228
+ "noCacheDefault": true,
353
229
  "required": true,
354
230
  "summary": "Username or alias of the target org.",
355
231
  "hasDynamicHelp": true,
356
232
  "multiple": false,
357
233
  "type": "option"
358
234
  },
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.",
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",
368
242
  "hasDynamicHelp": false,
369
243
  "multiple": false,
370
244
  "type": "option"
371
245
  },
372
- "api-version": {
373
- "aliases": [
374
- "apiversion"
246
+ "browser": {
247
+ "char": "b",
248
+ "exclusive": [
249
+ "url-only"
250
+ ],
251
+ "name": "browser",
252
+ "summary": "Browser where the org opens.",
253
+ "hasDynamicHelp": false,
254
+ "multiple": false,
255
+ "options": [
256
+ "chrome",
257
+ "edge",
258
+ "firefox"
259
+ ],
260
+ "type": "option"
261
+ },
262
+ "path": {
263
+ "char": "p",
264
+ "env": "FORCE_OPEN_URL",
265
+ "exclusive": [
266
+ "source-file"
375
267
  ],
376
- "deprecateAliases": true,
377
- "description": "Override the api version used for api requests made by this command",
378
- "name": "api-version",
268
+ "name": "path",
269
+ "summary": "Navigation URL path to open a specific page.",
379
270
  "hasDynamicHelp": false,
380
271
  "multiple": false,
381
272
  "type": "option"
382
273
  },
383
- "no-prompt": {
274
+ "url-only": {
384
275
  "aliases": [
385
- "noprompt"
276
+ "urlonly"
386
277
  ],
387
- "char": "p",
278
+ "char": "r",
388
279
  "deprecateAliases": true,
389
- "name": "no-prompt",
390
- "summary": "No prompt to confirm deletion.",
280
+ "name": "url-only",
281
+ "summary": "Display navigation URL, but don’t launch browser.",
391
282
  "allowNo": false,
392
283
  "type": "boolean"
393
284
  },
@@ -400,48 +291,70 @@
400
291
  "hasDynamicHelp": false,
401
292
  "multiple": false,
402
293
  "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"
403
309
  }
404
310
  },
405
311
  "hasDynamicHelp": true,
406
312
  "hiddenAliases": [],
407
- "id": "force:org:delete",
313
+ "id": "org:open",
408
314
  "pluginAlias": "@salesforce/plugin-org",
409
315
  "pluginName": "@salesforce/plugin-org",
410
316
  "pluginType": "core",
411
- "state": "deprecated",
412
317
  "strict": true,
413
- "summary": "Delete a scratch or sandbox org.",
318
+ "summary": "Open your default scratch org, or another specified org, in a browser.",
414
319
  "enableJsonFlag": true,
415
320
  "SF_ENV": "SF_ENV",
416
321
  "isESM": true,
417
322
  "relativePath": [
418
323
  "lib",
419
324
  "commands",
420
- "force",
421
325
  "org",
422
- "delete.js"
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"
423
341
  ],
424
- "aliasPermutations": [],
425
342
  "permutations": [
426
- "force:org:delete",
427
- "org:force:delete",
428
- "org:delete:force",
429
- "force:delete:org",
430
- "delete:force:org",
431
- "delete:org:force"
343
+ "org:open",
344
+ "open:org"
432
345
  ]
433
346
  },
434
- "force:org:status": {
347
+ "force:org:clone": {
435
348
  "aliases": [],
436
349
  "args": {},
437
350
  "deprecationOptions": {
438
- "to": "org:resume:sandbox",
351
+ "to": "org:create:sandbox",
439
352
  "version": "60.0"
440
353
  },
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.",
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\".",
442
355
  "examples": [
443
- "$ <%= config.bin %> <%= command.id %> --sandboxname DevSbx1 --setalias MySandbox -u prodOrg",
444
- "$ <%= config.bin %> <%= command.id %> --sandboxname DevSbx1 --wait 45 --setdefaultusername -u prodOrg"
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"
445
358
  ],
446
359
  "flags": {
447
360
  "json": {
@@ -477,11 +390,22 @@
477
390
  "multiple": false,
478
391
  "type": "option"
479
392
  },
480
- "sandboxname": {
481
- "char": "n",
482
- "name": "sandboxname",
393
+ "type": {
394
+ "char": "t",
395
+ "name": "type",
483
396
  "required": true,
484
- "summary": "Name of the sandbox org to check status for.",
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.",
485
409
  "hasDynamicHelp": false,
486
410
  "multiple": false,
487
411
  "type": "option"
@@ -489,20 +413,21 @@
489
413
  "setdefaultusername": {
490
414
  "char": "s",
491
415
  "name": "setdefaultusername",
492
- "summary": "Set the created or cloned org as your default.",
416
+ "summary": "Set the cloned org as your default.",
493
417
  "allowNo": false,
494
418
  "type": "boolean"
495
419
  },
496
420
  "setalias": {
497
421
  "char": "a",
498
422
  "name": "setalias",
499
- "summary": "Alias for the created or cloned org.",
423
+ "summary": "Alias for the cloned org.",
500
424
  "hasDynamicHelp": false,
501
425
  "multiple": false,
502
426
  "type": "option"
503
427
  },
504
428
  "wait": {
505
429
  "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.",
506
431
  "name": "wait",
507
432
  "summary": "Number of minutes to wait while polling for status.",
508
433
  "default": {
@@ -526,43 +451,46 @@
526
451
  },
527
452
  "hasDynamicHelp": true,
528
453
  "hiddenAliases": [],
529
- "id": "force:org:status",
454
+ "id": "force:org:clone",
530
455
  "pluginAlias": "@salesforce/plugin-org",
531
456
  "pluginName": "@salesforce/plugin-org",
532
457
  "pluginType": "core",
533
458
  "state": "deprecated",
534
- "strict": true,
535
- "summary": "Check the status of a sandbox, and if complete, authenticate to it.",
459
+ "strict": false,
460
+ "summary": "Clone a sandbox org.",
536
461
  "enableJsonFlag": true,
537
462
  "SF_ENV": "SF_ENV",
463
+ "SANDBOXDEF_SRC_SANDBOXNAME": "SourceSandboxName",
538
464
  "isESM": true,
539
465
  "relativePath": [
540
466
  "lib",
541
467
  "commands",
542
468
  "force",
543
469
  "org",
544
- "status.js"
470
+ "clone.js"
545
471
  ],
546
472
  "aliasPermutations": [],
547
473
  "permutations": [
548
- "force:org:status",
549
- "org:force:status",
550
- "org:status:force",
551
- "force:status:org",
552
- "status:force:org",
553
- "status:org:force"
474
+ "force:org:clone",
475
+ "org:force:clone",
476
+ "org:clone:force",
477
+ "force:clone:org",
478
+ "clone:force:org",
479
+ "clone:org:force"
554
480
  ]
555
481
  },
556
- "org:display": {
557
- "aliases": [
558
- "force:org:display"
559
- ],
482
+ "force:org:create": {
483
+ "aliases": [],
560
484
  "args": {},
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\").",
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.",
563
489
  "examples": [
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"
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"
566
494
  ],
567
495
  "flags": {
568
496
  "json": {
@@ -581,8 +509,21 @@
581
509
  "deprecateAliases": true,
582
510
  "name": "target-org",
583
511
  "noCacheDefault": true,
584
- "required": true,
585
- "summary": "Username or alias of the target org.",
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.",
586
527
  "hasDynamicHelp": true,
587
528
  "multiple": false,
588
529
  "type": "option"
@@ -598,12 +539,6 @@
598
539
  "multiple": false,
599
540
  "type": "option"
600
541
  },
601
- "verbose": {
602
- "name": "verbose",
603
- "summary": "Display the sfdxAuthUrl property.",
604
- "allowNo": false,
605
- "type": "boolean"
606
- },
607
542
  "loglevel": {
608
543
  "deprecated": {
609
544
  "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."
@@ -613,48 +548,135 @@
613
548
  "hasDynamicHelp": false,
614
549
  "multiple": false,
615
550
  "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"
616
639
  }
617
640
  },
618
641
  "hasDynamicHelp": true,
619
642
  "hiddenAliases": [],
620
- "id": "org:display",
643
+ "id": "force:org:create",
621
644
  "pluginAlias": "@salesforce/plugin-org",
622
645
  "pluginName": "@salesforce/plugin-org",
623
- "pluginType": "core",
624
- "strict": true,
625
- "summary": "Display information about an org.",
646
+ "pluginType": "core",
647
+ "state": "deprecated",
648
+ "strict": false,
649
+ "summary": "Create a scratch org or sandbox.",
626
650
  "enableJsonFlag": true,
627
651
  "SF_ENV": "SF_ENV",
628
652
  "isESM": true,
629
653
  "relativePath": [
630
654
  "lib",
631
655
  "commands",
656
+ "force",
632
657
  "org",
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"
658
+ "create.js"
642
659
  ],
660
+ "aliasPermutations": [],
643
661
  "permutations": [
644
- "org:display",
645
- "display:org"
662
+ "force:org:create",
663
+ "org:force:create",
664
+ "org:create:force",
665
+ "force:create:org",
666
+ "create:force:org",
667
+ "create:org:force"
646
668
  ]
647
669
  },
648
- "org:list": {
649
- "aliases": [
650
- "force:org:list"
651
- ],
670
+ "force:org:delete": {
671
+ "aliases": [],
652
672
  "args": {},
653
- "deprecateAliases": true,
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.",
654
677
  "examples": [
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"
678
+ "$ <%= config.bin %> <%= command.id %> -u me@my.org",
679
+ "$ <%= config.bin %> <%= command.id %> -u MyOrgAlias -p"
658
680
  ],
659
681
  "flags": {
660
682
  "json": {
@@ -664,45 +686,52 @@
664
686
  "allowNo": false,
665
687
  "type": "boolean"
666
688
  },
667
- "verbose": {
668
- "name": "verbose",
669
- "summary": "List more information about each org.",
670
- "allowNo": false,
671
- "type": "boolean"
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"
672
702
  },
673
- "all": {
674
- "name": "all",
675
- "summary": "Include expired, deleted, and unknown-status scratch orgs.",
676
- "allowNo": false,
677
- "type": "boolean"
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"
678
715
  },
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"
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"
684
726
  },
685
727
  "no-prompt": {
686
728
  "aliases": [
687
729
  "noprompt"
688
730
  ],
689
731
  "char": "p",
690
- "dependsOn": [
691
- "clean"
692
- ],
693
732
  "deprecateAliases": true,
694
733
  "name": "no-prompt",
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.",
734
+ "summary": "No prompt to confirm deletion.",
706
735
  "allowNo": false,
707
736
  "type": "boolean"
708
737
  },
@@ -717,50 +746,46 @@
717
746
  "type": "option"
718
747
  }
719
748
  },
720
- "hasDynamicHelp": false,
749
+ "hasDynamicHelp": true,
721
750
  "hiddenAliases": [],
722
- "id": "org:list",
751
+ "id": "force:org:delete",
723
752
  "pluginAlias": "@salesforce/plugin-org",
724
753
  "pluginName": "@salesforce/plugin-org",
725
754
  "pluginType": "core",
755
+ "state": "deprecated",
726
756
  "strict": true,
727
- "summary": "List all orgs you’ve created or authenticated to.",
757
+ "summary": "Delete a scratch or sandbox org.",
728
758
  "enableJsonFlag": true,
729
759
  "SF_ENV": "SF_ENV",
730
760
  "isESM": true,
731
761
  "relativePath": [
732
762
  "lib",
733
763
  "commands",
764
+ "force",
734
765
  "org",
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"
766
+ "delete.js"
744
767
  ],
768
+ "aliasPermutations": [],
745
769
  "permutations": [
746
- "org:list",
747
- "list:org"
770
+ "force:org:delete",
771
+ "org:force:delete",
772
+ "org:delete:force",
773
+ "force:delete:org",
774
+ "delete:force:org",
775
+ "delete:org:force"
748
776
  ]
749
777
  },
750
- "org:open": {
751
- "aliases": [
752
- "force:org:open",
753
- "force:source:open"
754
- ],
778
+ "force:org:status": {
779
+ "aliases": [],
755
780
  "args": {},
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.",
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.",
758
786
  "examples": [
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"
787
+ "$ <%= config.bin %> <%= command.id %> --sandboxname DevSbx1 --setalias MySandbox -u prodOrg",
788
+ "$ <%= config.bin %> <%= command.id %> --sandboxname DevSbx1 --wait 45 --setdefaultusername -u prodOrg"
764
789
  ],
765
790
  "flags": {
766
791
  "json": {
@@ -796,44 +821,41 @@
796
821
  "multiple": false,
797
822
  "type": "option"
798
823
  },
799
- "browser": {
800
- "char": "b",
801
- "exclusive": [
802
- "url-only"
803
- ],
804
- "name": "browser",
805
- "summary": "Browser where the org opens.",
824
+ "sandboxname": {
825
+ "char": "n",
826
+ "name": "sandboxname",
827
+ "required": true,
828
+ "summary": "Name of the sandbox org to check status for.",
806
829
  "hasDynamicHelp": false,
807
830
  "multiple": false,
808
- "options": [
809
- "chrome",
810
- "edge",
811
- "firefox"
812
- ],
813
831
  "type": "option"
814
832
  },
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.",
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.",
823
844
  "hasDynamicHelp": false,
824
845
  "multiple": false,
825
846
  "type": "option"
826
847
  },
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"
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"
837
859
  },
838
860
  "loglevel": {
839
861
  "deprecated": {
@@ -844,57 +866,35 @@
844
866
  "hasDynamicHelp": false,
845
867
  "multiple": false,
846
868
  "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"
862
869
  }
863
870
  },
864
871
  "hasDynamicHelp": true,
865
872
  "hiddenAliases": [],
866
- "id": "org:open",
873
+ "id": "force:org:status",
867
874
  "pluginAlias": "@salesforce/plugin-org",
868
875
  "pluginName": "@salesforce/plugin-org",
869
876
  "pluginType": "core",
877
+ "state": "deprecated",
870
878
  "strict": true,
871
- "summary": "Open your default scratch org, or another specified org, in a browser.",
879
+ "summary": "Check the status of a sandbox, and if complete, authenticate to it.",
872
880
  "enableJsonFlag": true,
873
881
  "SF_ENV": "SF_ENV",
874
882
  "isESM": true,
875
883
  "relativePath": [
876
884
  "lib",
877
885
  "commands",
886
+ "force",
878
887
  "org",
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"
888
+ "status.js"
894
889
  ],
890
+ "aliasPermutations": [],
895
891
  "permutations": [
896
- "org:open",
897
- "open:org"
892
+ "force:org:status",
893
+ "org:force:status",
894
+ "org:status:force",
895
+ "force:status:org",
896
+ "status:force:org",
897
+ "status:org:force"
898
898
  ]
899
899
  },
900
900
  "org:create:sandbox": {
@@ -1903,5 +1903,5 @@
1903
1903
  ]
1904
1904
  }
1905
1905
  },
1906
- "version": "3.0.3"
1906
+ "version": "3.0.4"
1907
1907
  }