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