@salesforce/plugin-signups 3.0.9 → 3.0.11

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.
package/README.md CHANGED
@@ -123,7 +123,7 @@ EXAMPLES
123
123
  $ sf org create shape --target-org SourceOrg
124
124
  ```
125
125
 
126
- _See code: [src/commands/org/create/shape.ts](https://github.com/salesforcecli/plugin-signups/blob/3.0.9/src/commands/org/create/shape.ts)_
126
+ _See code: [src/commands/org/create/shape.ts](https://github.com/salesforcecli/plugin-signups/blob/3.0.11/src/commands/org/create/shape.ts)_
127
127
 
128
128
  ## `sf org create snapshot`
129
129
 
@@ -179,7 +179,7 @@ FLAG DESCRIPTIONS
179
179
  as a version control system tag or commit ID.
180
180
  ```
181
181
 
182
- _See code: [src/commands/org/create/snapshot.ts](https://github.com/salesforcecli/plugin-signups/blob/3.0.9/src/commands/org/create/snapshot.ts)_
182
+ _See code: [src/commands/org/create/snapshot.ts](https://github.com/salesforcecli/plugin-signups/blob/3.0.11/src/commands/org/create/snapshot.ts)_
183
183
 
184
184
  ## `sf org delete shape`
185
185
 
@@ -219,7 +219,7 @@ EXAMPLES
219
219
  $ sf org delete shape --target-org SourceOrg --no-prompt
220
220
  ```
221
221
 
222
- _See code: [src/commands/org/delete/shape.ts](https://github.com/salesforcecli/plugin-signups/blob/3.0.9/src/commands/org/delete/shape.ts)_
222
+ _See code: [src/commands/org/delete/shape.ts](https://github.com/salesforcecli/plugin-signups/blob/3.0.11/src/commands/org/delete/shape.ts)_
223
223
 
224
224
  ## `sf org delete snapshot`
225
225
 
@@ -264,7 +264,7 @@ FLAG DESCRIPTIONS
264
264
  The IDs of scratch org snapshots start with 0Oo.
265
265
  ```
266
266
 
267
- _See code: [src/commands/org/delete/snapshot.ts](https://github.com/salesforcecli/plugin-signups/blob/3.0.9/src/commands/org/delete/snapshot.ts)_
267
+ _See code: [src/commands/org/delete/snapshot.ts](https://github.com/salesforcecli/plugin-signups/blob/3.0.11/src/commands/org/delete/snapshot.ts)_
268
268
 
269
269
  ## `sf org get snapshot`
270
270
 
@@ -311,7 +311,7 @@ FLAG DESCRIPTIONS
311
311
  The IDs of scratch org snapshots start with 0Oo.
312
312
  ```
313
313
 
314
- _See code: [src/commands/org/get/snapshot.ts](https://github.com/salesforcecli/plugin-signups/blob/3.0.9/src/commands/org/get/snapshot.ts)_
314
+ _See code: [src/commands/org/get/snapshot.ts](https://github.com/salesforcecli/plugin-signups/blob/3.0.11/src/commands/org/get/snapshot.ts)_
315
315
 
316
316
  ## `sf org list shape`
317
317
 
@@ -344,7 +344,7 @@ EXAMPLES
344
344
  $ sf org list shape --json > tmp/MyOrgShapeList.json
345
345
  ```
346
346
 
347
- _See code: [src/commands/org/list/shape.ts](https://github.com/salesforcecli/plugin-signups/blob/3.0.9/src/commands/org/list/shape.ts)_
347
+ _See code: [src/commands/org/list/shape.ts](https://github.com/salesforcecli/plugin-signups/blob/3.0.11/src/commands/org/list/shape.ts)_
348
348
 
349
349
  ## `sf org list snapshot`
350
350
 
@@ -386,6 +386,6 @@ EXAMPLES
386
386
  $ sf org list snapshot --target-dev-hub SnapshotDevHub
387
387
  ```
388
388
 
389
- _See code: [src/commands/org/list/snapshot.ts](https://github.com/salesforcecli/plugin-signups/blob/3.0.9/src/commands/org/list/snapshot.ts)_
389
+ _See code: [src/commands/org/list/snapshot.ts](https://github.com/salesforcecli/plugin-signups/blob/3.0.11/src/commands/org/list/snapshot.ts)_
390
390
 
391
391
  <!-- commandsstop -->
@@ -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:get:snapshot": {
268
+ "org:delete:shape": {
263
269
  "aliases": [
264
- "force:org:snapshot:get"
270
+ "force:org:shape:delete"
265
271
  ],
266
272
  "args": {},
267
273
  "deprecateAliases": true,
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\".",
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
- "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"
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,16 +292,17 @@
286
292
  "multiple": false,
287
293
  "type": "option"
288
294
  },
289
- "target-dev-hub": {
295
+ "target-org": {
290
296
  "aliases": [
291
- "targetdevhubusername"
297
+ "targetusername",
298
+ "u"
292
299
  ],
293
- "char": "v",
300
+ "char": "o",
294
301
  "deprecateAliases": true,
295
- "name": "target-dev-hub",
302
+ "name": "target-org",
296
303
  "noCacheDefault": true,
297
304
  "required": true,
298
- "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.",
305
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
299
306
  "hasDynamicHelp": true,
300
307
  "multiple": false,
301
308
  "type": "option"
@@ -321,78 +328,80 @@
321
328
  "multiple": false,
322
329
  "type": "option"
323
330
  },
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"
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"
333
341
  }
334
342
  },
335
343
  "hasDynamicHelp": true,
336
344
  "hiddenAliases": [],
337
- "id": "org:get:snapshot",
345
+ "id": "org:delete:shape",
338
346
  "pluginAlias": "@salesforce/plugin-signups",
339
347
  "pluginName": "@salesforce/plugin-signups",
340
348
  "pluginType": "core",
341
349
  "strict": true,
342
- "summary": "Get details about a scratch org snapshot.",
350
+ "summary": "Delete all org shapes for a target org.",
343
351
  "enableJsonFlag": true,
344
352
  "isESM": true,
345
353
  "relativePath": [
346
354
  "lib",
347
355
  "commands",
348
356
  "org",
349
- "get",
350
- "snapshot.js"
357
+ "delete",
358
+ "shape.js"
351
359
  ],
352
360
  "aliasPermutations": [
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"
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"
377
385
  ],
378
386
  "permutations": [
379
- "org:get:snapshot",
380
- "get:org:snapshot",
381
- "get:snapshot:org",
382
- "org:snapshot:get",
383
- "snapshot:org:get",
384
- "snapshot:get: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"
385
393
  ]
386
394
  },
387
- "org:create:shape": {
395
+ "org:delete:snapshot": {
388
396
  "aliases": [
389
- "force:org:shape:create"
397
+ "force:org:snapshot:delete"
390
398
  ],
391
399
  "args": {},
392
400
  "deprecateAliases": true,
393
- "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.",
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.",
394
402
  "examples": [
395
- "Create an org shape for the source org with alias SourceOrg:\n<%= config.bin %> <%= command.id %> --target-org SourceOrg"
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"
396
405
  ],
397
406
  "flags": {
398
407
  "json": {
@@ -410,17 +419,16 @@
410
419
  "multiple": false,
411
420
  "type": "option"
412
421
  },
413
- "target-org": {
422
+ "target-dev-hub": {
414
423
  "aliases": [
415
- "targetusername",
416
- "u"
424
+ "targetdevhubusername"
417
425
  ],
418
- "char": "o",
426
+ "char": "v",
419
427
  "deprecateAliases": true,
420
- "name": "target-org",
428
+ "name": "target-dev-hub",
421
429
  "noCacheDefault": true,
422
430
  "required": true,
423
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
431
+ "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.",
424
432
  "hasDynamicHelp": true,
425
433
  "multiple": false,
426
434
  "type": "option"
@@ -445,70 +453,87 @@
445
453
  "hasDynamicHelp": false,
446
454
  "multiple": false,
447
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"
448
473
  }
449
474
  },
450
475
  "hasDynamicHelp": true,
451
476
  "hiddenAliases": [],
452
- "id": "org:create:shape",
477
+ "id": "org:delete:snapshot",
453
478
  "pluginAlias": "@salesforce/plugin-signups",
454
479
  "pluginName": "@salesforce/plugin-signups",
455
480
  "pluginType": "core",
456
481
  "strict": true,
457
- "summary": "Create a scratch org configuration (shape) based on the specified source org.",
482
+ "summary": "Delete a scratch org snapshot.",
458
483
  "enableJsonFlag": true,
459
484
  "isESM": true,
460
485
  "relativePath": [
461
486
  "lib",
462
487
  "commands",
463
488
  "org",
464
- "create",
465
- "shape.js"
489
+ "delete",
490
+ "snapshot.js"
466
491
  ],
467
492
  "aliasPermutations": [
468
- "force:org:shape:create",
469
- "org:force:shape:create",
470
- "org:shape:force:create",
471
- "org:shape:create:force",
472
- "force:shape:org:create",
473
- "shape:force:org:create",
474
- "shape:org:force:create",
475
- "shape:org:create:force",
476
- "force:shape:create:org",
477
- "shape:force:create:org",
478
- "shape:create:force:org",
479
- "shape:create:org:force",
480
- "force:org:create:shape",
481
- "org:force:create:shape",
482
- "org:create:force:shape",
483
- "org:create:shape:force",
484
- "force:create:org:shape",
485
- "create:force:org:shape",
486
- "create:org:force:shape",
487
- "create:org:shape:force",
488
- "force:create:shape:org",
489
- "create:force:shape:org",
490
- "create:shape:force:org",
491
- "create:shape:org:force"
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"
492
517
  ],
493
518
  "permutations": [
494
- "org:create:shape",
495
- "create:org:shape",
496
- "create:shape:org",
497
- "org:shape:create",
498
- "shape:org:create",
499
- "shape:create: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"
500
525
  ]
501
526
  },
502
- "org:create:snapshot": {
527
+ "org:get:snapshot": {
503
528
  "aliases": [
504
- "force:org:snapshot:create"
529
+ "force:org:snapshot:get"
505
530
  ],
506
531
  "args": {},
507
532
  "deprecateAliases": true,
508
- "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.",
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\".",
509
534
  "examples": [
510
- "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'",
511
- "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"
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"
512
537
  ],
513
538
  "flags": {
514
539
  "json": {
@@ -561,37 +586,12 @@
561
586
  "multiple": false,
562
587
  "type": "option"
563
588
  },
564
- "source-org": {
565
- "aliases": [
566
- "sourceorg"
567
- ],
568
- "char": "o",
569
- "deprecateAliases": true,
570
- "name": "source-org",
571
- "required": true,
572
- "summary": "ID or locally authenticated username or alias of scratch org to snapshot.",
573
- "hasDynamicHelp": false,
574
- "multiple": false,
575
- "type": "option"
576
- },
577
- "name": {
578
- "aliases": [
579
- "snapshotname"
580
- ],
581
- "char": "n",
582
- "deprecateAliases": true,
583
- "name": "name",
589
+ "snapshot": {
590
+ "char": "s",
591
+ "description": "The IDs of scratch org snapshots start with 0Oo.",
592
+ "name": "snapshot",
584
593
  "required": true,
585
- "summary": "Unique name of snapshot.",
586
- "hasDynamicHelp": false,
587
- "multiple": false,
588
- "type": "option"
589
- },
590
- "description": {
591
- "char": "d",
592
- "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.",
593
- "name": "description",
594
- "summary": "Description of snapshot.",
594
+ "summary": "Name or ID of snapshot to retrieve.",
595
595
  "hasDynamicHelp": false,
596
596
  "multiple": false,
597
597
  "type": "option"
@@ -599,54 +599,54 @@
599
599
  },
600
600
  "hasDynamicHelp": true,
601
601
  "hiddenAliases": [],
602
- "id": "org:create:snapshot",
602
+ "id": "org:get:snapshot",
603
603
  "pluginAlias": "@salesforce/plugin-signups",
604
604
  "pluginName": "@salesforce/plugin-signups",
605
605
  "pluginType": "core",
606
606
  "strict": true,
607
- "summary": "Create a snapshot of a scratch org.",
607
+ "summary": "Get details about a scratch org snapshot.",
608
608
  "enableJsonFlag": true,
609
609
  "isESM": true,
610
610
  "relativePath": [
611
611
  "lib",
612
612
  "commands",
613
613
  "org",
614
- "create",
614
+ "get",
615
615
  "snapshot.js"
616
616
  ],
617
617
  "aliasPermutations": [
618
- "force:org:snapshot:create",
619
- "org:force:snapshot:create",
620
- "org:snapshot:force:create",
621
- "org:snapshot:create:force",
622
- "force:snapshot:org:create",
623
- "snapshot:force:org:create",
624
- "snapshot:org:force:create",
625
- "snapshot:org:create:force",
626
- "force:snapshot:create:org",
627
- "snapshot:force:create:org",
628
- "snapshot:create:force:org",
629
- "snapshot:create:org:force",
630
- "force:org:create:snapshot",
631
- "org:force:create:snapshot",
632
- "org:create:force:snapshot",
633
- "org:create:snapshot:force",
634
- "force:create:org:snapshot",
635
- "create:force:org:snapshot",
636
- "create:org:force:snapshot",
637
- "create:org:snapshot:force",
638
- "force:create:snapshot:org",
639
- "create:force:snapshot:org",
640
- "create:snapshot:force:org",
641
- "create:snapshot:org:force"
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"
642
642
  ],
643
643
  "permutations": [
644
- "org:create:snapshot",
645
- "create:org:snapshot",
646
- "create:snapshot:org",
647
- "org:snapshot:create",
648
- "snapshot:org:create",
649
- "snapshot:create:org"
644
+ "org:get:snapshot",
645
+ "get:org:snapshot",
646
+ "get:snapshot:org",
647
+ "org:snapshot:get",
648
+ "snapshot:org:get",
649
+ "snapshot:get:org"
650
650
  ]
651
651
  },
652
652
  "org:list:shape": {
@@ -862,5 +862,5 @@
862
862
  ]
863
863
  }
864
864
  },
865
- "version": "3.0.9"
865
+ "version": "3.0.11"
866
866
  }
package/package.json CHANGED
@@ -1,11 +1,11 @@
1
1
  {
2
2
  "name": "@salesforce/plugin-signups",
3
3
  "description": "Commands to interact with org shapes",
4
- "version": "3.0.9",
4
+ "version": "3.0.11",
5
5
  "author": "Salesforce",
6
6
  "bugs": "https://github.com/forcedotcom/cli/issues",
7
7
  "dependencies": {
8
- "@oclif/core": "^5.0.0",
8
+ "@oclif/core": "^5.1.2",
9
9
  "@salesforce/core": "^9.3.0",
10
10
  "@salesforce/kit": "^4.0.1",
11
11
  "@salesforce/sf-plugins-core": "^13.0.5",
@@ -227,7 +227,7 @@
227
227
  "exports": "./lib/index.js",
228
228
  "type": "module",
229
229
  "sfdx": {
230
- "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-signups/3.0.9.crt",
231
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-signups/3.0.9.sig"
230
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-signups/3.0.11.crt",
231
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-signups/3.0.11.sig"
232
232
  }
233
233
  }