@salesforce/plugin-signups 2.0.29 → 2.0.30

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
@@ -78,305 +78,8 @@ sfdx plugins
78
78
 
79
79
  <!-- commands -->
80
80
 
81
- - [`sf org create shape`](#sf-org-create-shape)
82
- - [`sf org create snapshot`](#sf-org-create-snapshot)
83
- - [`sf org delete shape`](#sf-org-delete-shape)
84
- - [`sf org delete snapshot`](#sf-org-delete-snapshot)
85
- - [`sf org get snapshot`](#sf-org-get-snapshot)
86
- - [`sf org list shape`](#sf-org-list-shape)
87
- - [`sf org list snapshot`](#sf-org-list-snapshot)
81
+ # Command Topics
88
82
 
89
- ## `sf org create shape`
90
-
91
- Create a scratch org configuration (shape) based on the specified source org.
92
-
93
- ```
94
- USAGE
95
- $ sf org create shape -o <value> [--json] [--api-version <value>]
96
-
97
- FLAGS
98
- -o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
99
- configuration variable is already set.
100
- --api-version=<value> Override the api version used for api requests made by this command
101
-
102
- GLOBAL FLAGS
103
- --json Format output as json.
104
-
105
- DESCRIPTION
106
- Create a scratch org configuration (shape) based on the specified source org.
107
-
108
- Scratch org shapes mimic the baseline setup (features, limits, edition, and Metadata API settings) of a source org
109
- without the extraneous data and metadata.
110
-
111
- Run "sf org list shape" to view the available org shapes and their IDs.
112
-
113
- To create a scratch org from an org shape, include the "sourceOrg" property in the scratch org definition file and set
114
- it to the org ID of the source org. Then create a scratch org with the "sf force:org:create" command.
115
-
116
- ALIASES
117
- $ sf force org shape create
118
-
119
- EXAMPLES
120
- Create an org shape for the source org with alias SourceOrg:
121
-
122
- $ sf org create shape --target-org SourceOrg
123
- ```
124
-
125
- _See code: [src/commands/org/create/shape.ts](https://github.com/salesforcecli/plugin-signups/blob/2.0.29/src/commands/org/create/shape.ts)_
126
-
127
- ## `sf org create snapshot`
128
-
129
- Create a snapshot of a scratch org.
130
-
131
- ```
132
- USAGE
133
- $ sf org create snapshot -v <value> -o <value> -n <value> [--json] [--api-version <value>] [-d <value>]
134
-
135
- FLAGS
136
- -d, --description=<value> Description of snapshot.
137
- -n, --name=<value> (required) Unique name of snapshot.
138
- -o, --source-org=<value> (required) ID or locally authenticated username or alias of scratch org to snapshot.
139
- -v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the `target-dev-hub`
140
- configuration variable is already set.
141
- --api-version=<value> Override the api version used for api requests made by this command
142
-
143
- GLOBAL FLAGS
144
- --json Format output as json.
145
-
146
- DESCRIPTION
147
- Create a snapshot of a scratch org.
148
-
149
- A snapshot is a point-in-time copy of a scratch org. The copy is referenced by its unique name in a scratch org
150
- definition file.
151
-
152
- Use "sf org get snapshot" to get details, including status, about a snapshot creation request.
153
-
154
- To create a scratch org from a snapshot, include the "snapshot" option (instead of "edition") in the scratch org
155
- definition file and set it to the name of the snapshot. Then use "sf force:org:create" to create the scratch org.
156
-
157
- ALIASES
158
- $ sf force org snapshot create
159
-
160
- EXAMPLES
161
- Create a snapshot called "Dependencies" using the source scratch org ID and your default Dev Hub org:
162
-
163
- $ sf org create snapshot --source-org 00Dxx0000000000 --name Dependencies --description 'Contains PackageA \
164
- v1.1.0'
165
-
166
- Create a snapshot called "NightlyBranch" using the source scratch org username and a Dev Hub org with alias
167
- NightlyDevHub:
168
-
169
- $ sf org create snapshot --source-org myuser@myorg --name NightlyBranch --description 'Contains PkgA v2.1.0 and \
170
- PkgB 3.3.0' --target-dev-hub NightlyDevHub
171
-
172
- FLAG DESCRIPTIONS
173
- -d, --description=<value> Description of snapshot.
174
-
175
- Use this description to document the contents of the snapshot. We suggest that you include a reference point, such
176
- as a version control system tag or commit ID.
177
- ```
178
-
179
- _See code: [src/commands/org/create/snapshot.ts](https://github.com/salesforcecli/plugin-signups/blob/2.0.29/src/commands/org/create/snapshot.ts)_
180
-
181
- ## `sf org delete shape`
182
-
183
- Delete all org shapes for a target org.
184
-
185
- ```
186
- USAGE
187
- $ sf org delete shape -o <value> [--json] [--api-version <value>] [-p]
188
-
189
- FLAGS
190
- -o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
191
- configuration variable is already set.
192
- -p, --no-prompt Don't prompt for confirmation.
193
- --api-version=<value> Override the api version used for api requests made by this command
194
-
195
- GLOBAL FLAGS
196
- --json Format output as json.
197
-
198
- DESCRIPTION
199
- Delete all org shapes for a target org.
200
-
201
- 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
202
- one, the previous shape is marked inactive and replaced by a new active shape. If you don’t want to create scratch
203
- orgs based on this shape, you can delete the org shape.
204
-
205
- ALIASES
206
- $ sf force org shape delete
207
-
208
- EXAMPLES
209
- Delete all org shapes for the source org with alias SourceOrg:
210
-
211
- $ sf org delete shape --target-org SourceOrg
212
-
213
- Delete all org shapes without prompting:
214
-
215
- $ sf org delete shape --target-org SourceOrg --no-prompt
216
- ```
217
-
218
- _See code: [src/commands/org/delete/shape.ts](https://github.com/salesforcecli/plugin-signups/blob/2.0.29/src/commands/org/delete/shape.ts)_
219
-
220
- ## `sf org delete snapshot`
221
-
222
- Delete a scratch org snapshot.
223
-
224
- ```
225
- USAGE
226
- $ sf org delete snapshot -v <value> -s <value> [--json] [--api-version <value>]
227
-
228
- FLAGS
229
- -s, --snapshot=<value> (required) Name or ID of snapshot to delete.
230
- -v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the `target-dev-hub`
231
- configuration variable is already set.
232
- --api-version=<value> Override the api version used for api requests made by this command
233
-
234
- GLOBAL FLAGS
235
- --json Format output as json.
236
-
237
- DESCRIPTION
238
- Delete a scratch org snapshot.
239
-
240
- Dev Hub admins can delete any snapshot, while users can delete only their own unless a Dev Hub admin gives the user
241
- Modify All permissions.
242
-
243
- ALIASES
244
- $ sf force org snapshot delete
245
-
246
- EXAMPLES
247
- Delete a snapshot from the default Dev Hub using the snapshot ID:
248
-
249
- $ sf org delete snapshot --snapshot 0Oo...
250
-
251
- Delete a snapshot from the specified Dev Hub using the snapshot name:
252
-
253
- $ sf org delete snapshot --snapshot BaseSnapshot --target-dev-hub SnapshotDevHub
254
-
255
- FLAG DESCRIPTIONS
256
- -s, --snapshot=<value> Name or ID of snapshot to delete.
257
-
258
- The IDs of scratch org snapshots start with 0Oo.
259
- ```
260
-
261
- _See code: [src/commands/org/delete/snapshot.ts](https://github.com/salesforcecli/plugin-signups/blob/2.0.29/src/commands/org/delete/snapshot.ts)_
262
-
263
- ## `sf org get snapshot`
264
-
265
- Get details about a scratch org snapshot.
266
-
267
- ```
268
- USAGE
269
- $ sf org get snapshot -v <value> -s <value> [--json] [--api-version <value>]
270
-
271
- FLAGS
272
- -s, --snapshot=<value> (required) Name or ID of snapshot to retrieve.
273
- -v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the `target-dev-hub`
274
- configuration variable is already set.
275
- --api-version=<value> Override the api version used for api requests made by this command
276
-
277
- GLOBAL FLAGS
278
- --json Format output as json.
279
-
280
- DESCRIPTION
281
- Get details about a scratch org snapshot.
282
-
283
- Snapshot creation can take a while. Use this command with the snapshot name or ID to check its creation status. After
284
- the status changes to Active, you can use the snapshot to create scratch orgs.
285
-
286
- To create a snapshot, use the "sf org create snapshot" command. To retrieve a list of all snapshots, use "sf org list
287
- snapshot".
288
-
289
- ALIASES
290
- $ sf force org snapshot get
291
-
292
- EXAMPLES
293
- Get snapshot details using its ID and the default Dev Hub org:
294
-
295
- $ sf org get snapshot --snapshot 0Oo...
296
-
297
- Get snapshot details using its name from a Dev Hub org with alias SnapshotDevHub:
298
-
299
- $ sf org get snapshot --snapshot Dependencies --target-dev-hub SnapshotDevHub
300
-
301
- FLAG DESCRIPTIONS
302
- -s, --snapshot=<value> Name or ID of snapshot to retrieve.
303
-
304
- The IDs of scratch org snapshots start with 0Oo.
305
- ```
306
-
307
- _See code: [src/commands/org/get/snapshot.ts](https://github.com/salesforcecli/plugin-signups/blob/2.0.29/src/commands/org/get/snapshot.ts)_
308
-
309
- ## `sf org list shape`
310
-
311
- List all org shapes you’ve created.
312
-
313
- ```
314
- USAGE
315
- $ sf org list shape [--json]
316
-
317
- GLOBAL FLAGS
318
- --json Format output as json.
319
-
320
- DESCRIPTION
321
- List all org shapes you’ve created.
322
-
323
- The output includes the alias, username, and ID of the source org, the status of the org shape creation, and more. Use
324
- the org ID to update your scratch org configuration file so you can create a scratch org based on this org shape.
325
-
326
- ALIASES
327
- $ sf force org shape list
328
-
329
- EXAMPLES
330
- List all org shapes you've created:
331
-
332
- $ sf org list shape
333
-
334
- List all org shapes in JSON format and write the output to a file:
335
-
336
- $ sf org list shape --json > tmp/MyOrgShapeList.json
337
- ```
338
-
339
- _See code: [src/commands/org/list/shape.ts](https://github.com/salesforcecli/plugin-signups/blob/2.0.29/src/commands/org/list/shape.ts)_
340
-
341
- ## `sf org list snapshot`
342
-
343
- List scratch org snapshots.
344
-
345
- ```
346
- USAGE
347
- $ sf org list snapshot -v <value> [--json] [--api-version <value>]
348
-
349
- FLAGS
350
- -v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the `target-dev-hub`
351
- configuration variable is already set.
352
- --api-version=<value> Override the api version used for api requests made by this command
353
-
354
- GLOBAL FLAGS
355
- --json Format output as json.
356
-
357
- DESCRIPTION
358
- List scratch org snapshots.
359
-
360
- 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
361
- associated with the Dev Hub org. If you’re a user, you can see only your snapshots unless a Dev Hub admin gives you
362
- View All permissions.
363
-
364
- To create a snapshot, use the "sf org create snapshot" command. To get details about a snapshot request, use "sf org
365
- get snapshot".
366
-
367
- ALIASES
368
- $ sf force org snapshot list
369
-
370
- EXAMPLES
371
- List snapshots in the default Dev Hub:
372
-
373
- $ sf org list snapshot
374
-
375
- List snapshots in the Dev Hub with alias SnapshotDevHub:
376
-
377
- $ sf org list snapshot --target-dev-hub SnapshotDevHub
378
- ```
379
-
380
- _See code: [src/commands/org/list/snapshot.ts](https://github.com/salesforcecli/plugin-signups/blob/2.0.29/src/commands/org/list/snapshot.ts)_
83
+ - [`sf org`](docs/org.md) - Commands to manage org shapes and snapshots.
381
84
 
382
85
  <!-- commandsstop -->