@salesforce/plugin-signups 2.6.7 → 2.6.9

Sign up to get free protection for your applications and to get access to all the features.
@@ -1,14 +1,15 @@
1
1
  {
2
2
  "commands": {
3
- "org:create:shape": {
3
+ "org:delete:shape": {
4
4
  "aliases": [
5
- "force:org:shape:create"
5
+ "force:org:shape:delete"
6
6
  ],
7
7
  "args": {},
8
8
  "deprecateAliases": true,
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.",
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.",
10
10
  "examples": [
11
- "Create an org shape for the source org with alias SourceOrg:\n<%= config.bin %> <%= command.id %> --target-org SourceOrg"
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"
12
13
  ],
13
14
  "flags": {
14
15
  "json": {
@@ -61,70 +62,81 @@
61
62
  "hasDynamicHelp": false,
62
63
  "multiple": false,
63
64
  "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"
64
76
  }
65
77
  },
66
78
  "hasDynamicHelp": true,
67
79
  "hiddenAliases": [],
68
- "id": "org:create:shape",
80
+ "id": "org:delete:shape",
69
81
  "pluginAlias": "@salesforce/plugin-signups",
70
82
  "pluginName": "@salesforce/plugin-signups",
71
83
  "pluginType": "core",
72
84
  "strict": true,
73
- "summary": "Create a scratch org configuration (shape) based on the specified source org.",
85
+ "summary": "Delete all org shapes for a target org.",
74
86
  "enableJsonFlag": true,
75
87
  "isESM": true,
76
88
  "relativePath": [
77
89
  "lib",
78
90
  "commands",
79
91
  "org",
80
- "create",
92
+ "delete",
81
93
  "shape.js"
82
94
  ],
83
95
  "aliasPermutations": [
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"
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"
108
120
  ],
109
121
  "permutations": [
110
- "org:create:shape",
111
- "create:org:shape",
112
- "create:shape:org",
113
- "org:shape:create",
114
- "shape:org:create",
115
- "shape:create:org"
122
+ "org:delete:shape",
123
+ "delete:org:shape",
124
+ "delete:shape:org",
125
+ "org:shape:delete",
126
+ "shape:org:delete",
127
+ "shape:delete:org"
116
128
  ]
117
129
  },
118
- "org:create:snapshot": {
130
+ "org:delete:snapshot": {
119
131
  "aliases": [
120
- "force:org:snapshot:create"
132
+ "force:org:snapshot:delete"
121
133
  ],
122
134
  "args": {},
123
135
  "deprecateAliases": true,
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.",
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.",
125
137
  "examples": [
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"
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"
128
140
  ],
129
141
  "flags": {
130
142
  "json": {
@@ -177,104 +189,86 @@
177
189
  "multiple": false,
178
190
  "type": "option"
179
191
  },
180
- "source-org": {
181
- "aliases": [
182
- "sourceorg"
183
- ],
184
- "char": "o",
185
- "deprecateAliases": true,
186
- "name": "source-org",
187
- "required": true,
188
- "summary": "ID or locally authenticated username or alias of scratch org to snapshot.",
189
- "hasDynamicHelp": false,
190
- "multiple": false,
191
- "type": "option"
192
- },
193
- "name": {
194
- "aliases": [
195
- "snapshotname"
196
- ],
197
- "char": "n",
198
- "deprecateAliases": true,
199
- "name": "name",
192
+ "snapshot": {
193
+ "char": "s",
194
+ "description": "The IDs of scratch org snapshots start with 0Oo.",
195
+ "name": "snapshot",
200
196
  "required": true,
201
- "summary": "Unique name of snapshot.",
197
+ "summary": "Name or ID of snapshot to delete.",
202
198
  "hasDynamicHelp": false,
203
199
  "multiple": false,
204
200
  "type": "option"
205
201
  },
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"
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"
214
208
  }
215
209
  },
216
210
  "hasDynamicHelp": true,
217
211
  "hiddenAliases": [],
218
- "id": "org:create:snapshot",
212
+ "id": "org:delete:snapshot",
219
213
  "pluginAlias": "@salesforce/plugin-signups",
220
214
  "pluginName": "@salesforce/plugin-signups",
221
215
  "pluginType": "core",
222
216
  "strict": true,
223
- "summary": "Create a snapshot of a scratch org.",
217
+ "summary": "Delete a scratch org snapshot.",
224
218
  "enableJsonFlag": true,
225
219
  "isESM": true,
226
220
  "relativePath": [
227
221
  "lib",
228
222
  "commands",
229
223
  "org",
230
- "create",
224
+ "delete",
231
225
  "snapshot.js"
232
226
  ],
233
227
  "aliasPermutations": [
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"
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"
258
252
  ],
259
253
  "permutations": [
260
- "org:create:snapshot",
261
- "create:org:snapshot",
262
- "create:snapshot:org",
263
- "org:snapshot:create",
264
- "snapshot:org:create",
265
- "snapshot:create:org"
254
+ "org:delete:snapshot",
255
+ "delete:org:snapshot",
256
+ "delete:snapshot:org",
257
+ "org:snapshot:delete",
258
+ "snapshot:org:delete",
259
+ "snapshot:delete:org"
266
260
  ]
267
261
  },
268
- "org:delete:shape": {
262
+ "org:get:snapshot": {
269
263
  "aliases": [
270
- "force:org:shape:delete"
264
+ "force:org:snapshot:get"
271
265
  ],
272
266
  "args": {},
273
267
  "deprecateAliases": true,
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.",
268
+ "description": "Snapshot creation can take a while. Use this command with the snapshot name or ID to check its creation status. After the status changes to Active, you can use the snapshot to create scratch orgs.\n\nTo create a snapshot, use the \"<%= config.bin %> org create snapshot\" command. To retrieve a list of all snapshots, use \"<%= config.bin %> org list snapshot\".",
275
269
  "examples": [
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"
270
+ "Get snapshot details using its ID and the default Dev Hub org:\n<%= config.bin %> <%= command.id %> --snapshot 0Oo...",
271
+ "Get snapshot details using its name from a Dev Hub org with alias SnapshotDevHub:\n<%= config.bin %> <%= command.id %> --snapshot Dependencies --target-dev-hub SnapshotDevHub"
278
272
  ],
279
273
  "flags": {
280
274
  "json": {
@@ -292,17 +286,16 @@
292
286
  "multiple": false,
293
287
  "type": "option"
294
288
  },
295
- "target-org": {
289
+ "target-dev-hub": {
296
290
  "aliases": [
297
- "targetusername",
298
- "u"
291
+ "targetdevhubusername"
299
292
  ],
300
- "char": "o",
293
+ "char": "v",
301
294
  "deprecateAliases": true,
302
- "name": "target-org",
295
+ "name": "target-dev-hub",
303
296
  "noCacheDefault": true,
304
297
  "required": true,
305
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
298
+ "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.",
306
299
  "hasDynamicHelp": true,
307
300
  "multiple": false,
308
301
  "type": "option"
@@ -328,80 +321,79 @@
328
321
  "multiple": false,
329
322
  "type": "option"
330
323
  },
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"
324
+ "snapshot": {
325
+ "char": "s",
326
+ "description": "The IDs of scratch org snapshots start with 0Oo.",
327
+ "name": "snapshot",
328
+ "required": true,
329
+ "summary": "Name or ID of snapshot to retrieve.",
330
+ "hasDynamicHelp": false,
331
+ "multiple": false,
332
+ "type": "option"
341
333
  }
342
334
  },
343
335
  "hasDynamicHelp": true,
344
336
  "hiddenAliases": [],
345
- "id": "org:delete:shape",
337
+ "id": "org:get:snapshot",
346
338
  "pluginAlias": "@salesforce/plugin-signups",
347
339
  "pluginName": "@salesforce/plugin-signups",
348
340
  "pluginType": "core",
349
341
  "strict": true,
350
- "summary": "Delete all org shapes for a target org.",
342
+ "summary": "Get details about a scratch org snapshot.",
351
343
  "enableJsonFlag": true,
352
344
  "isESM": true,
353
345
  "relativePath": [
354
346
  "lib",
355
347
  "commands",
356
348
  "org",
357
- "delete",
358
- "shape.js"
349
+ "get",
350
+ "snapshot.js"
359
351
  ],
360
352
  "aliasPermutations": [
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"
353
+ "force:org:snapshot:get",
354
+ "org:force:snapshot:get",
355
+ "org:snapshot:force:get",
356
+ "org:snapshot:get:force",
357
+ "force:snapshot:org:get",
358
+ "snapshot:force:org:get",
359
+ "snapshot:org:force:get",
360
+ "snapshot:org:get:force",
361
+ "force:snapshot:get:org",
362
+ "snapshot:force:get:org",
363
+ "snapshot:get:force:org",
364
+ "snapshot:get:org:force",
365
+ "force:org:get:snapshot",
366
+ "org:force:get:snapshot",
367
+ "org:get:force:snapshot",
368
+ "org:get:snapshot:force",
369
+ "force:get:org:snapshot",
370
+ "get:force:org:snapshot",
371
+ "get:org:force:snapshot",
372
+ "get:org:snapshot:force",
373
+ "force:get:snapshot:org",
374
+ "get:force:snapshot:org",
375
+ "get:snapshot:force:org",
376
+ "get:snapshot:org:force"
385
377
  ],
386
378
  "permutations": [
387
- "org:delete:shape",
388
- "delete:org:shape",
389
- "delete:shape:org",
390
- "org:shape:delete",
391
- "shape:org:delete",
392
- "shape:delete:org"
379
+ "org:get:snapshot",
380
+ "get:org:snapshot",
381
+ "get:snapshot:org",
382
+ "org:snapshot:get",
383
+ "snapshot:org:get",
384
+ "snapshot:get:org"
393
385
  ]
394
386
  },
395
- "org:delete:snapshot": {
387
+ "org:list:shape": {
396
388
  "aliases": [
397
- "force:org:snapshot:delete"
389
+ "force:org:shape:list"
398
390
  ],
399
391
  "args": {},
400
392
  "deprecateAliases": true,
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.",
393
+ "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.",
402
394
  "examples": [
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"
395
+ "List all org shapes you've created:\n<%= config.bin %> <%= command.id %>",
396
+ "List all org shapes in JSON format and write the output to a file:\n<%= config.bin %> <%= command.id %> --json > tmp/MyOrgShapeList.json"
405
397
  ],
406
398
  "flags": {
407
399
  "json": {
@@ -419,30 +411,12 @@
419
411
  "multiple": false,
420
412
  "type": "option"
421
413
  },
422
- "target-dev-hub": {
423
- "aliases": [
424
- "targetdevhubusername"
425
- ],
426
- "char": "v",
427
- "deprecateAliases": true,
428
- "name": "target-dev-hub",
429
- "noCacheDefault": true,
430
- "required": true,
431
- "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.",
432
- "hasDynamicHelp": true,
433
- "multiple": false,
434
- "type": "option"
435
- },
436
- "api-version": {
437
- "aliases": [
438
- "apiversion"
439
- ],
440
- "deprecateAliases": true,
441
- "description": "Override the api version used for api requests made by this command",
442
- "name": "api-version",
443
- "hasDynamicHelp": false,
444
- "multiple": false,
445
- "type": "option"
414
+ "verbose": {
415
+ "hidden": true,
416
+ "name": "verbose",
417
+ "summary": "List more information about each org shape.",
418
+ "allowNo": false,
419
+ "type": "boolean"
446
420
  },
447
421
  "loglevel": {
448
422
  "deprecated": {
@@ -453,87 +427,70 @@
453
427
  "hasDynamicHelp": false,
454
428
  "multiple": false,
455
429
  "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"
473
430
  }
474
431
  },
475
- "hasDynamicHelp": true,
432
+ "hasDynamicHelp": false,
476
433
  "hiddenAliases": [],
477
- "id": "org:delete:snapshot",
434
+ "id": "org:list:shape",
478
435
  "pluginAlias": "@salesforce/plugin-signups",
479
436
  "pluginName": "@salesforce/plugin-signups",
480
437
  "pluginType": "core",
481
438
  "strict": true,
482
- "summary": "Delete a scratch org snapshot.",
439
+ "summary": "List all org shapes you’ve created.",
483
440
  "enableJsonFlag": true,
484
441
  "isESM": true,
485
442
  "relativePath": [
486
443
  "lib",
487
444
  "commands",
488
445
  "org",
489
- "delete",
490
- "snapshot.js"
446
+ "list",
447
+ "shape.js"
491
448
  ],
492
449
  "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"
450
+ "force:org:shape:list",
451
+ "org:force:shape:list",
452
+ "org:shape:force:list",
453
+ "org:shape:list:force",
454
+ "force:shape:org:list",
455
+ "shape:force:org:list",
456
+ "shape:org:force:list",
457
+ "shape:org:list:force",
458
+ "force:shape:list:org",
459
+ "shape:force:list:org",
460
+ "shape:list:force:org",
461
+ "shape:list:org:force",
462
+ "force:org:list:shape",
463
+ "org:force:list:shape",
464
+ "org:list:force:shape",
465
+ "org:list:shape:force",
466
+ "force:list:org:shape",
467
+ "list:force:org:shape",
468
+ "list:org:force:shape",
469
+ "list:org:shape:force",
470
+ "force:list:shape:org",
471
+ "list:force:shape:org",
472
+ "list:shape:force:org",
473
+ "list:shape:org:force"
517
474
  ],
518
475
  "permutations": [
519
- "org:delete:snapshot",
520
- "delete:org:snapshot",
521
- "delete:snapshot:org",
522
- "org:snapshot:delete",
523
- "snapshot:org:delete",
524
- "snapshot:delete:org"
476
+ "org:list:shape",
477
+ "list:org:shape",
478
+ "list:shape:org",
479
+ "org:shape:list",
480
+ "shape:org:list",
481
+ "shape:list:org"
525
482
  ]
526
483
  },
527
- "org:get:snapshot": {
484
+ "org:list:snapshot": {
528
485
  "aliases": [
529
- "force:org:snapshot:get"
486
+ "force:org:snapshot:list"
530
487
  ],
531
488
  "args": {},
532
489
  "deprecateAliases": true,
533
- "description": "Snapshot creation can take a while. Use this command with the snapshot name or ID to check its creation status. After the status changes to Active, you can use the snapshot to create scratch orgs.\n\nTo create a snapshot, use the \"<%= config.bin %> org create snapshot\" command. To retrieve a list of all snapshots, use \"<%= config.bin %> org list snapshot\".",
490
+ "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\".",
534
491
  "examples": [
535
- "Get snapshot details using its ID and the default Dev Hub org:\n<%= config.bin %> <%= command.id %> --snapshot 0Oo...",
536
- "Get snapshot details using its name from a Dev Hub org with alias SnapshotDevHub:\n<%= config.bin %> <%= command.id %> --snapshot Dependencies --target-dev-hub SnapshotDevHub"
492
+ "List snapshots in the default Dev Hub:\n<%= config.bin %> <%= command.id %>",
493
+ "List snapshots in the Dev Hub with alias SnapshotDevHub:\n<%= config.bin %> <%= command.id %> --target-dev-hub SnapshotDevHub"
537
494
  ],
538
495
  "flags": {
539
496
  "json": {
@@ -585,80 +542,69 @@
585
542
  "hasDynamicHelp": false,
586
543
  "multiple": false,
587
544
  "type": "option"
588
- },
589
- "snapshot": {
590
- "char": "s",
591
- "description": "The IDs of scratch org snapshots start with 0Oo.",
592
- "name": "snapshot",
593
- "required": true,
594
- "summary": "Name or ID of snapshot to retrieve.",
595
- "hasDynamicHelp": false,
596
- "multiple": false,
597
- "type": "option"
598
545
  }
599
546
  },
600
547
  "hasDynamicHelp": true,
601
548
  "hiddenAliases": [],
602
- "id": "org:get:snapshot",
549
+ "id": "org:list:snapshot",
603
550
  "pluginAlias": "@salesforce/plugin-signups",
604
551
  "pluginName": "@salesforce/plugin-signups",
605
552
  "pluginType": "core",
606
553
  "strict": true,
607
- "summary": "Get details about a scratch org snapshot.",
554
+ "summary": "List scratch org snapshots.",
608
555
  "enableJsonFlag": true,
609
556
  "isESM": true,
610
557
  "relativePath": [
611
558
  "lib",
612
559
  "commands",
613
560
  "org",
614
- "get",
561
+ "list",
615
562
  "snapshot.js"
616
563
  ],
617
564
  "aliasPermutations": [
618
- "force:org:snapshot:get",
619
- "org:force:snapshot:get",
620
- "org:snapshot:force:get",
621
- "org:snapshot:get:force",
622
- "force:snapshot:org:get",
623
- "snapshot:force:org:get",
624
- "snapshot:org:force:get",
625
- "snapshot:org:get:force",
626
- "force:snapshot:get:org",
627
- "snapshot:force:get:org",
628
- "snapshot:get:force:org",
629
- "snapshot:get:org:force",
630
- "force:org:get:snapshot",
631
- "org:force:get:snapshot",
632
- "org:get:force:snapshot",
633
- "org:get:snapshot:force",
634
- "force:get:org:snapshot",
635
- "get:force:org:snapshot",
636
- "get:org:force:snapshot",
637
- "get:org:snapshot:force",
638
- "force:get:snapshot:org",
639
- "get:force:snapshot:org",
640
- "get:snapshot:force:org",
641
- "get:snapshot:org:force"
565
+ "force:org:snapshot:list",
566
+ "org:force:snapshot:list",
567
+ "org:snapshot:force:list",
568
+ "org:snapshot:list:force",
569
+ "force:snapshot:org:list",
570
+ "snapshot:force:org:list",
571
+ "snapshot:org:force:list",
572
+ "snapshot:org:list:force",
573
+ "force:snapshot:list:org",
574
+ "snapshot:force:list:org",
575
+ "snapshot:list:force:org",
576
+ "snapshot:list:org:force",
577
+ "force:org:list:snapshot",
578
+ "org:force:list:snapshot",
579
+ "org:list:force:snapshot",
580
+ "org:list:snapshot:force",
581
+ "force:list:org:snapshot",
582
+ "list:force:org:snapshot",
583
+ "list:org:force:snapshot",
584
+ "list:org:snapshot:force",
585
+ "force:list:snapshot:org",
586
+ "list:force:snapshot:org",
587
+ "list:snapshot:force:org",
588
+ "list:snapshot:org:force"
642
589
  ],
643
590
  "permutations": [
644
- "org:get:snapshot",
645
- "get:org:snapshot",
646
- "get:snapshot:org",
647
- "org:snapshot:get",
648
- "snapshot:org:get",
649
- "snapshot:get:org"
591
+ "org:list:snapshot",
592
+ "list:org:snapshot",
593
+ "list:snapshot:org",
594
+ "org:snapshot:list",
595
+ "snapshot:org:list",
596
+ "snapshot:list:org"
650
597
  ]
651
598
  },
652
- "org:list:shape": {
599
+ "org:create:shape": {
653
600
  "aliases": [
654
- "force:org:shape:list"
601
+ "force:org:shape:create"
655
602
  ],
656
603
  "args": {},
657
604
  "deprecateAliases": true,
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.",
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.",
659
606
  "examples": [
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"
607
+ "Create an org shape for the source org with alias SourceOrg:\n<%= config.bin %> <%= command.id %> --target-org SourceOrg"
662
608
  ],
663
609
  "flags": {
664
610
  "json": {
@@ -676,12 +622,31 @@
676
622
  "multiple": false,
677
623
  "type": "option"
678
624
  },
679
- "verbose": {
680
- "hidden": true,
681
- "name": "verbose",
682
- "summary": "List more information about each org shape.",
683
- "allowNo": false,
684
- "type": "boolean"
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"
685
650
  },
686
651
  "loglevel": {
687
652
  "deprecated": {
@@ -694,68 +659,68 @@
694
659
  "type": "option"
695
660
  }
696
661
  },
697
- "hasDynamicHelp": false,
662
+ "hasDynamicHelp": true,
698
663
  "hiddenAliases": [],
699
- "id": "org:list:shape",
664
+ "id": "org:create:shape",
700
665
  "pluginAlias": "@salesforce/plugin-signups",
701
666
  "pluginName": "@salesforce/plugin-signups",
702
667
  "pluginType": "core",
703
668
  "strict": true,
704
- "summary": "List all org shapes you’ve created.",
669
+ "summary": "Create a scratch org configuration (shape) based on the specified source org.",
705
670
  "enableJsonFlag": true,
706
671
  "isESM": true,
707
672
  "relativePath": [
708
673
  "lib",
709
674
  "commands",
710
675
  "org",
711
- "list",
676
+ "create",
712
677
  "shape.js"
713
678
  ],
714
679
  "aliasPermutations": [
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"
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"
739
704
  ],
740
705
  "permutations": [
741
- "org:list:shape",
742
- "list:org:shape",
743
- "list:shape:org",
744
- "org:shape:list",
745
- "shape:org:list",
746
- "shape:list:org"
706
+ "org:create:shape",
707
+ "create:org:shape",
708
+ "create:shape:org",
709
+ "org:shape:create",
710
+ "shape:org:create",
711
+ "shape:create:org"
747
712
  ]
748
713
  },
749
- "org:list:snapshot": {
714
+ "org:create:snapshot": {
750
715
  "aliases": [
751
- "force:org:snapshot:list"
716
+ "force:org:snapshot:create"
752
717
  ],
753
718
  "args": {},
754
719
  "deprecateAliases": true,
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\".",
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.",
756
721
  "examples": [
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"
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"
759
724
  ],
760
725
  "flags": {
761
726
  "json": {
@@ -807,60 +772,95 @@
807
772
  "hasDynamicHelp": false,
808
773
  "multiple": false,
809
774
  "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:list:snapshot",
814
+ "id": "org:create:snapshot",
815
815
  "pluginAlias": "@salesforce/plugin-signups",
816
816
  "pluginName": "@salesforce/plugin-signups",
817
817
  "pluginType": "core",
818
818
  "strict": true,
819
- "summary": "List scratch org snapshots.",
819
+ "summary": "Create a snapshot of a scratch org.",
820
820
  "enableJsonFlag": true,
821
821
  "isESM": true,
822
822
  "relativePath": [
823
823
  "lib",
824
824
  "commands",
825
825
  "org",
826
- "list",
826
+ "create",
827
827
  "snapshot.js"
828
828
  ],
829
829
  "aliasPermutations": [
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"
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"
854
854
  ],
855
855
  "permutations": [
856
- "org:list:snapshot",
857
- "list:org:snapshot",
858
- "list:snapshot:org",
859
- "org:snapshot:list",
860
- "snapshot:org:list",
861
- "snapshot:list:org"
856
+ "org:create:snapshot",
857
+ "create:org:snapshot",
858
+ "create:snapshot:org",
859
+ "org:snapshot:create",
860
+ "snapshot:org:create",
861
+ "snapshot:create:org"
862
862
  ]
863
863
  }
864
864
  },
865
- "version": "2.6.7"
865
+ "version": "2.6.9"
866
866
  }