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