@salesforce/plugin-signups 2.6.28 → 2.6.29

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,14 @@
1
1
  {
2
2
  "commands": {
3
- "org:delete:shape": {
3
+ "org:create:shape": {
4
4
  "aliases": [
5
- "force:org:shape:delete"
5
+ "force:org:shape:create"
6
6
  ],
7
7
  "args": {},
8
8
  "deprecateAliases": true,
9
- "description": "A source org can have only one active org shape. If you try to create an org shape for a source org that already has one, the previous shape is marked inactive and replaced by a new active shape. If you don’t want to create scratch orgs based on this shape, you can delete the org shape.",
9
+ "description": "Scratch org shapes mimic the baseline setup (features, limits, edition, and Metadata API settings) of a source org without the extraneous data and metadata.\n\nRun \"<%= config.bin %> org list shape\" to view the available org shapes and their IDs.\n\nTo create a scratch org from an org shape, include the \"sourceOrg\" property in the scratch org definition file and set it to the org ID of the source org. Then create a scratch org with the \"<%= config.bin %> org create scratch\" command.",
10
10
  "examples": [
11
- "Delete all org shapes for the source org with alias SourceOrg:\n<%= config.bin %> <%= command.id %> --target-org SourceOrg",
12
- "Delete all org shapes without prompting:\n<%= config.bin %> <%= command.id %> --target-org SourceOrg --no-prompt"
11
+ "Create an org shape for the source org with alias SourceOrg:\n<%= config.bin %> <%= command.id %> --target-org SourceOrg"
13
12
  ],
14
13
  "flags": {
15
14
  "json": {
@@ -62,81 +61,70 @@
62
61
  "hasDynamicHelp": false,
63
62
  "multiple": false,
64
63
  "type": "option"
65
- },
66
- "no-prompt": {
67
- "aliases": [
68
- "noprompt"
69
- ],
70
- "char": "p",
71
- "deprecateAliases": true,
72
- "name": "no-prompt",
73
- "summary": "Don't prompt for confirmation.",
74
- "allowNo": false,
75
- "type": "boolean"
76
64
  }
77
65
  },
78
66
  "hasDynamicHelp": true,
79
67
  "hiddenAliases": [],
80
- "id": "org:delete:shape",
68
+ "id": "org:create:shape",
81
69
  "pluginAlias": "@salesforce/plugin-signups",
82
70
  "pluginName": "@salesforce/plugin-signups",
83
71
  "pluginType": "core",
84
72
  "strict": true,
85
- "summary": "Delete all org shapes for a target org.",
73
+ "summary": "Create a scratch org configuration (shape) based on the specified source org.",
86
74
  "enableJsonFlag": true,
87
75
  "isESM": true,
88
76
  "relativePath": [
89
77
  "lib",
90
78
  "commands",
91
79
  "org",
92
- "delete",
80
+ "create",
93
81
  "shape.js"
94
82
  ],
95
83
  "aliasPermutations": [
96
- "force:org:shape:delete",
97
- "org:force:shape:delete",
98
- "org:shape:force:delete",
99
- "org:shape:delete:force",
100
- "force:shape:org:delete",
101
- "shape:force:org:delete",
102
- "shape:org:force:delete",
103
- "shape:org:delete:force",
104
- "force:shape:delete:org",
105
- "shape:force:delete:org",
106
- "shape:delete:force:org",
107
- "shape:delete:org:force",
108
- "force:org:delete:shape",
109
- "org:force:delete:shape",
110
- "org:delete:force:shape",
111
- "org:delete:shape:force",
112
- "force:delete:org:shape",
113
- "delete:force:org:shape",
114
- "delete:org:force:shape",
115
- "delete:org:shape:force",
116
- "force:delete:shape:org",
117
- "delete:force:shape:org",
118
- "delete:shape:force:org",
119
- "delete:shape:org:force"
84
+ "force:org:shape:create",
85
+ "org:force:shape:create",
86
+ "org:shape:force:create",
87
+ "org:shape:create:force",
88
+ "force:shape:org:create",
89
+ "shape:force:org:create",
90
+ "shape:org:force:create",
91
+ "shape:org:create:force",
92
+ "force:shape:create:org",
93
+ "shape:force:create:org",
94
+ "shape:create:force:org",
95
+ "shape:create:org:force",
96
+ "force:org:create:shape",
97
+ "org:force:create:shape",
98
+ "org:create:force:shape",
99
+ "org:create:shape:force",
100
+ "force:create:org:shape",
101
+ "create:force:org:shape",
102
+ "create:org:force:shape",
103
+ "create:org:shape:force",
104
+ "force:create:shape:org",
105
+ "create:force:shape:org",
106
+ "create:shape:force:org",
107
+ "create:shape:org:force"
120
108
  ],
121
109
  "permutations": [
122
- "org:delete:shape",
123
- "delete:org:shape",
124
- "delete:shape:org",
125
- "org:shape:delete",
126
- "shape:org:delete",
127
- "shape:delete:org"
110
+ "org:create:shape",
111
+ "create:org:shape",
112
+ "create:shape:org",
113
+ "org:shape:create",
114
+ "shape:org:create",
115
+ "shape:create:org"
128
116
  ]
129
117
  },
130
- "org:delete:snapshot": {
118
+ "org:create:snapshot": {
131
119
  "aliases": [
132
- "force:org:snapshot:delete"
120
+ "force:org:snapshot:create"
133
121
  ],
134
122
  "args": {},
135
123
  "deprecateAliases": true,
136
- "description": "Dev Hub admins can delete any snapshot. Users can delete only their own snapshots, unless a Dev Hub admin gives the user Modify All permission, which works only with the Salesforce license.",
124
+ "description": "A snapshot is a point-in-time copy of a scratch org. The copy is referenced by its unique name in a scratch org definition file.\n\nUse \"<%= config.bin %> org get snapshot\" to get details, including status, about a snapshot creation request.\n\nTo create a scratch org from a snapshot, include the \"snapshot\" option (instead of \"edition\") in the scratch org definition file and set it to the name of the snapshot. Then use \"<%= config.bin %> org create scratch\" to create the scratch org.",
137
125
  "examples": [
138
- "Delete a snapshot from the default Dev Hub using the snapshot ID:\n<%= config.bin %> <%= command.id %> --snapshot 0Oo...",
139
- "Delete a snapshot from the specified Dev Hub using the snapshot name:\n<%= config.bin %> <%= command.id %> --snapshot BaseSnapshot --target-dev-hub SnapshotDevHub"
126
+ "Create a snapshot called \"Dependencies\" using the source scratch org ID and your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --source-org 00Dxx0000000000 --name Dependencies --description 'Contains PackageA v1.1.0'",
127
+ "Create a snapshot called \"NightlyBranch\" using the source scratch org username and a Dev Hub org with alias NightlyDevHub:\n<%= config.bin %> <%= command.id %> --source-org myuser@myorg --name NightlyBranch --description 'Contains PkgA v2.1.0 and PkgB 3.3.0' --target-dev-hub NightlyDevHub"
140
128
  ],
141
129
  "flags": {
142
130
  "json": {
@@ -189,86 +177,104 @@
189
177
  "multiple": false,
190
178
  "type": "option"
191
179
  },
192
- "snapshot": {
193
- "char": "s",
194
- "description": "The IDs of scratch org snapshots start with 0Oo.",
195
- "name": "snapshot",
180
+ "source-org": {
181
+ "aliases": [
182
+ "sourceorg"
183
+ ],
184
+ "char": "o",
185
+ "deprecateAliases": true,
186
+ "name": "source-org",
196
187
  "required": true,
197
- "summary": "Name or ID of snapshot to delete.",
188
+ "summary": "ID or locally authenticated username or alias of scratch org to snapshot.",
198
189
  "hasDynamicHelp": false,
199
190
  "multiple": false,
200
191
  "type": "option"
201
192
  },
202
- "no-prompt": {
203
- "char": "p",
204
- "name": "no-prompt",
205
- "summary": "Don't prompt the user to confirm the deletion.",
206
- "allowNo": false,
207
- "type": "boolean"
193
+ "name": {
194
+ "aliases": [
195
+ "snapshotname"
196
+ ],
197
+ "char": "n",
198
+ "deprecateAliases": true,
199
+ "name": "name",
200
+ "required": true,
201
+ "summary": "Unique name of snapshot.",
202
+ "hasDynamicHelp": false,
203
+ "multiple": false,
204
+ "type": "option"
205
+ },
206
+ "description": {
207
+ "char": "d",
208
+ "description": "Use this description to document the contents of the snapshot. We suggest that you include a reference point, such as a version control system tag or commit ID.",
209
+ "name": "description",
210
+ "summary": "Description of snapshot.",
211
+ "hasDynamicHelp": false,
212
+ "multiple": false,
213
+ "type": "option"
208
214
  }
209
215
  },
210
216
  "hasDynamicHelp": true,
211
217
  "hiddenAliases": [],
212
- "id": "org:delete:snapshot",
218
+ "id": "org:create:snapshot",
213
219
  "pluginAlias": "@salesforce/plugin-signups",
214
220
  "pluginName": "@salesforce/plugin-signups",
215
221
  "pluginType": "core",
216
222
  "strict": true,
217
- "summary": "Delete a scratch org snapshot.",
223
+ "summary": "Create a snapshot of a scratch org.",
218
224
  "enableJsonFlag": true,
219
225
  "isESM": true,
220
226
  "relativePath": [
221
227
  "lib",
222
228
  "commands",
223
229
  "org",
224
- "delete",
230
+ "create",
225
231
  "snapshot.js"
226
232
  ],
227
233
  "aliasPermutations": [
228
- "force:org:snapshot:delete",
229
- "org:force:snapshot:delete",
230
- "org:snapshot:force:delete",
231
- "org:snapshot:delete:force",
232
- "force:snapshot:org:delete",
233
- "snapshot:force:org:delete",
234
- "snapshot:org:force:delete",
235
- "snapshot:org:delete:force",
236
- "force:snapshot:delete:org",
237
- "snapshot:force:delete:org",
238
- "snapshot:delete:force:org",
239
- "snapshot:delete:org:force",
240
- "force:org:delete:snapshot",
241
- "org:force:delete:snapshot",
242
- "org:delete:force:snapshot",
243
- "org:delete:snapshot:force",
244
- "force:delete:org:snapshot",
245
- "delete:force:org:snapshot",
246
- "delete:org:force:snapshot",
247
- "delete:org:snapshot:force",
248
- "force:delete:snapshot:org",
249
- "delete:force:snapshot:org",
250
- "delete:snapshot:force:org",
251
- "delete:snapshot:org:force"
234
+ "force:org:snapshot:create",
235
+ "org:force:snapshot:create",
236
+ "org:snapshot:force:create",
237
+ "org:snapshot:create:force",
238
+ "force:snapshot:org:create",
239
+ "snapshot:force:org:create",
240
+ "snapshot:org:force:create",
241
+ "snapshot:org:create:force",
242
+ "force:snapshot:create:org",
243
+ "snapshot:force:create:org",
244
+ "snapshot:create:force:org",
245
+ "snapshot:create:org:force",
246
+ "force:org:create:snapshot",
247
+ "org:force:create:snapshot",
248
+ "org:create:force:snapshot",
249
+ "org:create:snapshot:force",
250
+ "force:create:org:snapshot",
251
+ "create:force:org:snapshot",
252
+ "create:org:force:snapshot",
253
+ "create:org:snapshot:force",
254
+ "force:create:snapshot:org",
255
+ "create:force:snapshot:org",
256
+ "create:snapshot:force:org",
257
+ "create:snapshot:org:force"
252
258
  ],
253
259
  "permutations": [
254
- "org:delete:snapshot",
255
- "delete:org:snapshot",
256
- "delete:snapshot:org",
257
- "org:snapshot:delete",
258
- "snapshot:org:delete",
259
- "snapshot:delete:org"
260
+ "org:create:snapshot",
261
+ "create:org:snapshot",
262
+ "create:snapshot:org",
263
+ "org:snapshot:create",
264
+ "snapshot:org:create",
265
+ "snapshot:create:org"
260
266
  ]
261
267
  },
262
- "org:list:shape": {
268
+ "org:delete:shape": {
263
269
  "aliases": [
264
- "force:org:shape:list"
270
+ "force:org:shape:delete"
265
271
  ],
266
272
  "args": {},
267
273
  "deprecateAliases": true,
268
- "description": "The output includes the alias, username, and ID of the source org, the status of the org shape creation, and more. Use the org ID to update your scratch org configuration file so you can create a scratch org based on this org shape.",
274
+ "description": "A source org can have only one active org shape. If you try to create an org shape for a source org that already has one, the previous shape is marked inactive and replaced by a new active shape. If you don’t want to create scratch orgs based on this shape, you can delete the org shape.",
269
275
  "examples": [
270
- "List all org shapes you've created:\n<%= config.bin %> <%= command.id %>",
271
- "List all org shapes in JSON format and write the output to a file:\n<%= config.bin %> <%= command.id %> --json > tmp/MyOrgShapeList.json"
276
+ "Delete all org shapes for the source org with alias SourceOrg:\n<%= config.bin %> <%= command.id %> --target-org SourceOrg",
277
+ "Delete all org shapes without prompting:\n<%= config.bin %> <%= command.id %> --target-org SourceOrg --no-prompt"
272
278
  ],
273
279
  "flags": {
274
280
  "json": {
@@ -286,12 +292,31 @@
286
292
  "multiple": false,
287
293
  "type": "option"
288
294
  },
289
- "verbose": {
290
- "hidden": true,
291
- "name": "verbose",
292
- "summary": "List more information about each org shape.",
293
- "allowNo": false,
294
- "type": "boolean"
295
+ "target-org": {
296
+ "aliases": [
297
+ "targetusername",
298
+ "u"
299
+ ],
300
+ "char": "o",
301
+ "deprecateAliases": true,
302
+ "name": "target-org",
303
+ "noCacheDefault": true,
304
+ "required": true,
305
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
306
+ "hasDynamicHelp": true,
307
+ "multiple": false,
308
+ "type": "option"
309
+ },
310
+ "api-version": {
311
+ "aliases": [
312
+ "apiversion"
313
+ ],
314
+ "deprecateAliases": true,
315
+ "description": "Override the api version used for api requests made by this command",
316
+ "name": "api-version",
317
+ "hasDynamicHelp": false,
318
+ "multiple": false,
319
+ "type": "option"
295
320
  },
296
321
  "loglevel": {
297
322
  "deprecated": {
@@ -302,70 +327,81 @@
302
327
  "hasDynamicHelp": false,
303
328
  "multiple": false,
304
329
  "type": "option"
330
+ },
331
+ "no-prompt": {
332
+ "aliases": [
333
+ "noprompt"
334
+ ],
335
+ "char": "p",
336
+ "deprecateAliases": true,
337
+ "name": "no-prompt",
338
+ "summary": "Don't prompt for confirmation.",
339
+ "allowNo": false,
340
+ "type": "boolean"
305
341
  }
306
342
  },
307
- "hasDynamicHelp": false,
343
+ "hasDynamicHelp": true,
308
344
  "hiddenAliases": [],
309
- "id": "org:list:shape",
345
+ "id": "org:delete:shape",
310
346
  "pluginAlias": "@salesforce/plugin-signups",
311
347
  "pluginName": "@salesforce/plugin-signups",
312
348
  "pluginType": "core",
313
349
  "strict": true,
314
- "summary": "List all org shapes you’ve created.",
350
+ "summary": "Delete all org shapes for a target org.",
315
351
  "enableJsonFlag": true,
316
352
  "isESM": true,
317
353
  "relativePath": [
318
354
  "lib",
319
355
  "commands",
320
356
  "org",
321
- "list",
357
+ "delete",
322
358
  "shape.js"
323
359
  ],
324
360
  "aliasPermutations": [
325
- "force:org:shape:list",
326
- "org:force:shape:list",
327
- "org:shape:force:list",
328
- "org:shape:list:force",
329
- "force:shape:org:list",
330
- "shape:force:org:list",
331
- "shape:org:force:list",
332
- "shape:org:list:force",
333
- "force:shape:list:org",
334
- "shape:force:list:org",
335
- "shape:list:force:org",
336
- "shape:list:org:force",
337
- "force:org:list:shape",
338
- "org:force:list:shape",
339
- "org:list:force:shape",
340
- "org:list:shape:force",
341
- "force:list:org:shape",
342
- "list:force:org:shape",
343
- "list:org:force:shape",
344
- "list:org:shape:force",
345
- "force:list:shape:org",
346
- "list:force:shape:org",
347
- "list:shape:force:org",
348
- "list:shape:org:force"
361
+ "force:org:shape:delete",
362
+ "org:force:shape:delete",
363
+ "org:shape:force:delete",
364
+ "org:shape:delete:force",
365
+ "force:shape:org:delete",
366
+ "shape:force:org:delete",
367
+ "shape:org:force:delete",
368
+ "shape:org:delete:force",
369
+ "force:shape:delete:org",
370
+ "shape:force:delete:org",
371
+ "shape:delete:force:org",
372
+ "shape:delete:org:force",
373
+ "force:org:delete:shape",
374
+ "org:force:delete:shape",
375
+ "org:delete:force:shape",
376
+ "org:delete:shape:force",
377
+ "force:delete:org:shape",
378
+ "delete:force:org:shape",
379
+ "delete:org:force:shape",
380
+ "delete:org:shape:force",
381
+ "force:delete:shape:org",
382
+ "delete:force:shape:org",
383
+ "delete:shape:force:org",
384
+ "delete:shape:org:force"
349
385
  ],
350
386
  "permutations": [
351
- "org:list:shape",
352
- "list:org:shape",
353
- "list:shape:org",
354
- "org:shape:list",
355
- "shape:org:list",
356
- "shape:list:org"
387
+ "org:delete:shape",
388
+ "delete:org:shape",
389
+ "delete:shape:org",
390
+ "org:shape:delete",
391
+ "shape:org:delete",
392
+ "shape:delete:org"
357
393
  ]
358
394
  },
359
- "org:list:snapshot": {
395
+ "org:delete:snapshot": {
360
396
  "aliases": [
361
- "force:org:snapshot:list"
397
+ "force:org:snapshot:delete"
362
398
  ],
363
399
  "args": {},
364
400
  "deprecateAliases": true,
365
- "description": "You can view all the snapshots in a Dev Hub that you have access to. If you’re an admin, you can see all snapshots associated with the Dev Hub org. If you’re a user, you can see only your snapshots unless a Dev Hub admin gives you View All permissions.\n\nTo create a snapshot, use the \"<%= config.bin %> org create snapshot\" command. To get details about a snapshot request, use \"<%= config.bin %> org get snapshot\".",
401
+ "description": "Dev Hub admins can delete any snapshot. Users can delete only their own snapshots, unless a Dev Hub admin gives the user Modify All permission, which works only with the Salesforce license.",
366
402
  "examples": [
367
- "List snapshots in the default Dev Hub:\n<%= config.bin %> <%= command.id %>",
368
- "List snapshots in the Dev Hub with alias SnapshotDevHub:\n<%= config.bin %> <%= command.id %> --target-dev-hub SnapshotDevHub"
403
+ "Delete a snapshot from the default Dev Hub using the snapshot ID:\n<%= config.bin %> <%= command.id %> --snapshot 0Oo...",
404
+ "Delete a snapshot from the specified Dev Hub using the snapshot name:\n<%= config.bin %> <%= command.id %> --snapshot BaseSnapshot --target-dev-hub SnapshotDevHub"
369
405
  ],
370
406
  "flags": {
371
407
  "json": {
@@ -417,58 +453,75 @@
417
453
  "hasDynamicHelp": false,
418
454
  "multiple": false,
419
455
  "type": "option"
456
+ },
457
+ "snapshot": {
458
+ "char": "s",
459
+ "description": "The IDs of scratch org snapshots start with 0Oo.",
460
+ "name": "snapshot",
461
+ "required": true,
462
+ "summary": "Name or ID of snapshot to delete.",
463
+ "hasDynamicHelp": false,
464
+ "multiple": false,
465
+ "type": "option"
466
+ },
467
+ "no-prompt": {
468
+ "char": "p",
469
+ "name": "no-prompt",
470
+ "summary": "Don't prompt the user to confirm the deletion.",
471
+ "allowNo": false,
472
+ "type": "boolean"
420
473
  }
421
474
  },
422
475
  "hasDynamicHelp": true,
423
476
  "hiddenAliases": [],
424
- "id": "org:list:snapshot",
477
+ "id": "org:delete:snapshot",
425
478
  "pluginAlias": "@salesforce/plugin-signups",
426
479
  "pluginName": "@salesforce/plugin-signups",
427
480
  "pluginType": "core",
428
481
  "strict": true,
429
- "summary": "List scratch org snapshots.",
482
+ "summary": "Delete a scratch org snapshot.",
430
483
  "enableJsonFlag": true,
431
484
  "isESM": true,
432
485
  "relativePath": [
433
486
  "lib",
434
487
  "commands",
435
488
  "org",
436
- "list",
489
+ "delete",
437
490
  "snapshot.js"
438
491
  ],
439
- "aliasPermutations": [
440
- "force:org:snapshot:list",
441
- "org:force:snapshot:list",
442
- "org:snapshot:force:list",
443
- "org:snapshot:list:force",
444
- "force:snapshot:org:list",
445
- "snapshot:force:org:list",
446
- "snapshot:org:force:list",
447
- "snapshot:org:list:force",
448
- "force:snapshot:list:org",
449
- "snapshot:force:list:org",
450
- "snapshot:list:force:org",
451
- "snapshot:list:org:force",
452
- "force:org:list:snapshot",
453
- "org:force:list:snapshot",
454
- "org:list:force:snapshot",
455
- "org:list:snapshot:force",
456
- "force:list:org:snapshot",
457
- "list:force:org:snapshot",
458
- "list:org:force:snapshot",
459
- "list:org:snapshot:force",
460
- "force:list:snapshot:org",
461
- "list:force:snapshot:org",
462
- "list:snapshot:force:org",
463
- "list:snapshot:org:force"
492
+ "aliasPermutations": [
493
+ "force:org:snapshot:delete",
494
+ "org:force:snapshot:delete",
495
+ "org:snapshot:force:delete",
496
+ "org:snapshot:delete:force",
497
+ "force:snapshot:org:delete",
498
+ "snapshot:force:org:delete",
499
+ "snapshot:org:force:delete",
500
+ "snapshot:org:delete:force",
501
+ "force:snapshot:delete:org",
502
+ "snapshot:force:delete:org",
503
+ "snapshot:delete:force:org",
504
+ "snapshot:delete:org:force",
505
+ "force:org:delete:snapshot",
506
+ "org:force:delete:snapshot",
507
+ "org:delete:force:snapshot",
508
+ "org:delete:snapshot:force",
509
+ "force:delete:org:snapshot",
510
+ "delete:force:org:snapshot",
511
+ "delete:org:force:snapshot",
512
+ "delete:org:snapshot:force",
513
+ "force:delete:snapshot:org",
514
+ "delete:force:snapshot:org",
515
+ "delete:snapshot:force:org",
516
+ "delete:snapshot:org:force"
464
517
  ],
465
518
  "permutations": [
466
- "org:list:snapshot",
467
- "list:org:snapshot",
468
- "list:snapshot:org",
469
- "org:snapshot:list",
470
- "snapshot:org:list",
471
- "snapshot:list:org"
519
+ "org:delete:snapshot",
520
+ "delete:org:snapshot",
521
+ "delete:snapshot:org",
522
+ "org:snapshot:delete",
523
+ "snapshot:org:delete",
524
+ "snapshot:delete:org"
472
525
  ]
473
526
  },
474
527
  "org:get:snapshot": {
@@ -596,15 +649,16 @@
596
649
  "snapshot:get:org"
597
650
  ]
598
651
  },
599
- "org:create:shape": {
652
+ "org:list:shape": {
600
653
  "aliases": [
601
- "force:org:shape:create"
654
+ "force:org:shape:list"
602
655
  ],
603
656
  "args": {},
604
657
  "deprecateAliases": true,
605
- "description": "Scratch org shapes mimic the baseline setup (features, limits, edition, and Metadata API settings) of a source org without the extraneous data and metadata.\n\nRun \"<%= config.bin %> org list shape\" to view the available org shapes and their IDs.\n\nTo create a scratch org from an org shape, include the \"sourceOrg\" property in the scratch org definition file and set it to the org ID of the source org. Then create a scratch org with the \"<%= config.bin %> org create scratch\" command.",
658
+ "description": "The output includes the alias, username, and ID of the source org, the status of the org shape creation, and more. Use the org ID to update your scratch org configuration file so you can create a scratch org based on this org shape.",
606
659
  "examples": [
607
- "Create an org shape for the source org with alias SourceOrg:\n<%= config.bin %> <%= command.id %> --target-org SourceOrg"
660
+ "List all org shapes you've created:\n<%= config.bin %> <%= command.id %>",
661
+ "List all org shapes in JSON format and write the output to a file:\n<%= config.bin %> <%= command.id %> --json > tmp/MyOrgShapeList.json"
608
662
  ],
609
663
  "flags": {
610
664
  "json": {
@@ -622,31 +676,12 @@
622
676
  "multiple": false,
623
677
  "type": "option"
624
678
  },
625
- "target-org": {
626
- "aliases": [
627
- "targetusername",
628
- "u"
629
- ],
630
- "char": "o",
631
- "deprecateAliases": true,
632
- "name": "target-org",
633
- "noCacheDefault": true,
634
- "required": true,
635
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
636
- "hasDynamicHelp": true,
637
- "multiple": false,
638
- "type": "option"
639
- },
640
- "api-version": {
641
- "aliases": [
642
- "apiversion"
643
- ],
644
- "deprecateAliases": true,
645
- "description": "Override the api version used for api requests made by this command",
646
- "name": "api-version",
647
- "hasDynamicHelp": false,
648
- "multiple": false,
649
- "type": "option"
679
+ "verbose": {
680
+ "hidden": true,
681
+ "name": "verbose",
682
+ "summary": "List more information about each org shape.",
683
+ "allowNo": false,
684
+ "type": "boolean"
650
685
  },
651
686
  "loglevel": {
652
687
  "deprecated": {
@@ -659,68 +694,68 @@
659
694
  "type": "option"
660
695
  }
661
696
  },
662
- "hasDynamicHelp": true,
697
+ "hasDynamicHelp": false,
663
698
  "hiddenAliases": [],
664
- "id": "org:create:shape",
699
+ "id": "org:list:shape",
665
700
  "pluginAlias": "@salesforce/plugin-signups",
666
701
  "pluginName": "@salesforce/plugin-signups",
667
702
  "pluginType": "core",
668
703
  "strict": true,
669
- "summary": "Create a scratch org configuration (shape) based on the specified source org.",
704
+ "summary": "List all org shapes you’ve created.",
670
705
  "enableJsonFlag": true,
671
706
  "isESM": true,
672
707
  "relativePath": [
673
708
  "lib",
674
709
  "commands",
675
710
  "org",
676
- "create",
711
+ "list",
677
712
  "shape.js"
678
713
  ],
679
714
  "aliasPermutations": [
680
- "force:org:shape:create",
681
- "org:force:shape:create",
682
- "org:shape:force:create",
683
- "org:shape:create:force",
684
- "force:shape:org:create",
685
- "shape:force:org:create",
686
- "shape:org:force:create",
687
- "shape:org:create:force",
688
- "force:shape:create:org",
689
- "shape:force:create:org",
690
- "shape:create:force:org",
691
- "shape:create:org:force",
692
- "force:org:create:shape",
693
- "org:force:create:shape",
694
- "org:create:force:shape",
695
- "org:create:shape:force",
696
- "force:create:org:shape",
697
- "create:force:org:shape",
698
- "create:org:force:shape",
699
- "create:org:shape:force",
700
- "force:create:shape:org",
701
- "create:force:shape:org",
702
- "create:shape:force:org",
703
- "create:shape:org:force"
715
+ "force:org:shape:list",
716
+ "org:force:shape:list",
717
+ "org:shape:force:list",
718
+ "org:shape:list:force",
719
+ "force:shape:org:list",
720
+ "shape:force:org:list",
721
+ "shape:org:force:list",
722
+ "shape:org:list:force",
723
+ "force:shape:list:org",
724
+ "shape:force:list:org",
725
+ "shape:list:force:org",
726
+ "shape:list:org:force",
727
+ "force:org:list:shape",
728
+ "org:force:list:shape",
729
+ "org:list:force:shape",
730
+ "org:list:shape:force",
731
+ "force:list:org:shape",
732
+ "list:force:org:shape",
733
+ "list:org:force:shape",
734
+ "list:org:shape:force",
735
+ "force:list:shape:org",
736
+ "list:force:shape:org",
737
+ "list:shape:force:org",
738
+ "list:shape:org:force"
704
739
  ],
705
740
  "permutations": [
706
- "org:create:shape",
707
- "create:org:shape",
708
- "create:shape:org",
709
- "org:shape:create",
710
- "shape:org:create",
711
- "shape:create:org"
741
+ "org:list:shape",
742
+ "list:org:shape",
743
+ "list:shape:org",
744
+ "org:shape:list",
745
+ "shape:org:list",
746
+ "shape:list:org"
712
747
  ]
713
748
  },
714
- "org:create:snapshot": {
749
+ "org:list:snapshot": {
715
750
  "aliases": [
716
- "force:org:snapshot:create"
751
+ "force:org:snapshot:list"
717
752
  ],
718
753
  "args": {},
719
754
  "deprecateAliases": true,
720
- "description": "A snapshot is a point-in-time copy of a scratch org. The copy is referenced by its unique name in a scratch org definition file.\n\nUse \"<%= config.bin %> org get snapshot\" to get details, including status, about a snapshot creation request.\n\nTo create a scratch org from a snapshot, include the \"snapshot\" option (instead of \"edition\") in the scratch org definition file and set it to the name of the snapshot. Then use \"<%= config.bin %> org create scratch\" to create the scratch org.",
755
+ "description": "You can view all the snapshots in a Dev Hub that you have access to. If you’re an admin, you can see all snapshots associated with the Dev Hub org. If you’re a user, you can see only your snapshots unless a Dev Hub admin gives you View All permissions.\n\nTo create a snapshot, use the \"<%= config.bin %> org create snapshot\" command. To get details about a snapshot request, use \"<%= config.bin %> org get snapshot\".",
721
756
  "examples": [
722
- "Create a snapshot called \"Dependencies\" using the source scratch org ID and your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --source-org 00Dxx0000000000 --name Dependencies --description 'Contains PackageA v1.1.0'",
723
- "Create a snapshot called \"NightlyBranch\" using the source scratch org username and a Dev Hub org with alias NightlyDevHub:\n<%= config.bin %> <%= command.id %> --source-org myuser@myorg --name NightlyBranch --description 'Contains PkgA v2.1.0 and PkgB 3.3.0' --target-dev-hub NightlyDevHub"
757
+ "List snapshots in the default Dev Hub:\n<%= config.bin %> <%= command.id %>",
758
+ "List snapshots in the Dev Hub with alias SnapshotDevHub:\n<%= config.bin %> <%= command.id %> --target-dev-hub SnapshotDevHub"
724
759
  ],
725
760
  "flags": {
726
761
  "json": {
@@ -772,95 +807,60 @@
772
807
  "hasDynamicHelp": false,
773
808
  "multiple": false,
774
809
  "type": "option"
775
- },
776
- "source-org": {
777
- "aliases": [
778
- "sourceorg"
779
- ],
780
- "char": "o",
781
- "deprecateAliases": true,
782
- "name": "source-org",
783
- "required": true,
784
- "summary": "ID or locally authenticated username or alias of scratch org to snapshot.",
785
- "hasDynamicHelp": false,
786
- "multiple": false,
787
- "type": "option"
788
- },
789
- "name": {
790
- "aliases": [
791
- "snapshotname"
792
- ],
793
- "char": "n",
794
- "deprecateAliases": true,
795
- "name": "name",
796
- "required": true,
797
- "summary": "Unique name of snapshot.",
798
- "hasDynamicHelp": false,
799
- "multiple": false,
800
- "type": "option"
801
- },
802
- "description": {
803
- "char": "d",
804
- "description": "Use this description to document the contents of the snapshot. We suggest that you include a reference point, such as a version control system tag or commit ID.",
805
- "name": "description",
806
- "summary": "Description of snapshot.",
807
- "hasDynamicHelp": false,
808
- "multiple": false,
809
- "type": "option"
810
810
  }
811
811
  },
812
812
  "hasDynamicHelp": true,
813
813
  "hiddenAliases": [],
814
- "id": "org:create:snapshot",
814
+ "id": "org:list:snapshot",
815
815
  "pluginAlias": "@salesforce/plugin-signups",
816
816
  "pluginName": "@salesforce/plugin-signups",
817
817
  "pluginType": "core",
818
818
  "strict": true,
819
- "summary": "Create a snapshot of a scratch org.",
819
+ "summary": "List scratch org snapshots.",
820
820
  "enableJsonFlag": true,
821
821
  "isESM": true,
822
822
  "relativePath": [
823
823
  "lib",
824
824
  "commands",
825
825
  "org",
826
- "create",
826
+ "list",
827
827
  "snapshot.js"
828
828
  ],
829
829
  "aliasPermutations": [
830
- "force:org:snapshot:create",
831
- "org:force:snapshot:create",
832
- "org:snapshot:force:create",
833
- "org:snapshot:create:force",
834
- "force:snapshot:org:create",
835
- "snapshot:force:org:create",
836
- "snapshot:org:force:create",
837
- "snapshot:org:create:force",
838
- "force:snapshot:create:org",
839
- "snapshot:force:create:org",
840
- "snapshot:create:force:org",
841
- "snapshot:create:org:force",
842
- "force:org:create:snapshot",
843
- "org:force:create:snapshot",
844
- "org:create:force:snapshot",
845
- "org:create:snapshot:force",
846
- "force:create:org:snapshot",
847
- "create:force:org:snapshot",
848
- "create:org:force:snapshot",
849
- "create:org:snapshot:force",
850
- "force:create:snapshot:org",
851
- "create:force:snapshot:org",
852
- "create:snapshot:force:org",
853
- "create:snapshot:org:force"
830
+ "force:org:snapshot:list",
831
+ "org:force:snapshot:list",
832
+ "org:snapshot:force:list",
833
+ "org:snapshot:list:force",
834
+ "force:snapshot:org:list",
835
+ "snapshot:force:org:list",
836
+ "snapshot:org:force:list",
837
+ "snapshot:org:list:force",
838
+ "force:snapshot:list:org",
839
+ "snapshot:force:list:org",
840
+ "snapshot:list:force:org",
841
+ "snapshot:list:org:force",
842
+ "force:org:list:snapshot",
843
+ "org:force:list:snapshot",
844
+ "org:list:force:snapshot",
845
+ "org:list:snapshot:force",
846
+ "force:list:org:snapshot",
847
+ "list:force:org:snapshot",
848
+ "list:org:force:snapshot",
849
+ "list:org:snapshot:force",
850
+ "force:list:snapshot:org",
851
+ "list:force:snapshot:org",
852
+ "list:snapshot:force:org",
853
+ "list:snapshot:org:force"
854
854
  ],
855
855
  "permutations": [
856
- "org:create:snapshot",
857
- "create:org:snapshot",
858
- "create:snapshot:org",
859
- "org:snapshot:create",
860
- "snapshot:org:create",
861
- "snapshot:create:org"
856
+ "org:list:snapshot",
857
+ "list:org:snapshot",
858
+ "list:snapshot:org",
859
+ "org:snapshot:list",
860
+ "snapshot:org:list",
861
+ "snapshot:list:org"
862
862
  ]
863
863
  }
864
864
  },
865
- "version": "2.6.28"
865
+ "version": "2.6.29"
866
866
  }