@salesforce/plugin-packaging 1.27.3 → 1.27.5
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 -109
- package/oclif.lock +166 -79
- package/oclif.manifest.json +1728 -1200
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -59,8 +59,8 @@ Create a first-generation package version in the release org.
|
|
|
59
59
|
|
|
60
60
|
```
|
|
61
61
|
USAGE
|
|
62
|
-
$ sf package1:version:create -o <value> -i <value> -n <value> [--api-version <value>] [-d <value>] [-v <value>]
|
|
63
|
-
<value>] [-p <value>] [-k <value>] [-w <value>]
|
|
62
|
+
$ sf package1:version:create -o <value> -i <value> -n <value> [--json] [--api-version <value>] [-d <value>] [-v <value>]
|
|
63
|
+
[-m] [-r <value>] [-p <value>] [-k <value>] [-w <value>]
|
|
64
64
|
|
|
65
65
|
FLAGS
|
|
66
66
|
-d, --description=<value> Package version description.
|
|
@@ -75,7 +75,10 @@ FLAGS
|
|
|
75
75
|
-r, --release-notes-url=<value> Release notes URL.
|
|
76
76
|
-v, --version=<value> Package version in major.minor format, for example, 3.2.
|
|
77
77
|
-w, --wait=<value> Minutes to wait for the package version to be created (default: 2 minutes).
|
|
78
|
-
|
|
78
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
79
|
+
|
|
80
|
+
GLOBAL FLAGS
|
|
81
|
+
--json Format output as json.
|
|
79
82
|
|
|
80
83
|
DESCRIPTION
|
|
81
84
|
Create a first-generation package version in the release org.
|
|
@@ -114,7 +117,7 @@ FLAG DESCRIPTIONS
|
|
|
114
117
|
subscribers.
|
|
115
118
|
```
|
|
116
119
|
|
|
117
|
-
_See code: [src/commands/package1/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
120
|
+
_See code: [src/commands/package1/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.5/src/commands/package1/version/create.ts)_
|
|
118
121
|
|
|
119
122
|
## `sf package1:version:create:get`
|
|
120
123
|
|
|
@@ -122,13 +125,16 @@ Retrieve the status of a package version creation request.
|
|
|
122
125
|
|
|
123
126
|
```
|
|
124
127
|
USAGE
|
|
125
|
-
$ sf package1:version:create:get -o <value> -i <value> [--api-version <value>]
|
|
128
|
+
$ sf package1:version:create:get -o <value> -i <value> [--json] [--api-version <value>]
|
|
126
129
|
|
|
127
130
|
FLAGS
|
|
128
|
-
-i, --request-id=<value>
|
|
129
|
-
-o, --target-org=<value>
|
|
130
|
-
|
|
131
|
-
|
|
131
|
+
-i, --request-id=<value> (required) ID of the PackageUploadRequest (starts with 0HD).
|
|
132
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
133
|
+
configuration variable is already set.
|
|
134
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
135
|
+
|
|
136
|
+
GLOBAL FLAGS
|
|
137
|
+
--json Format output as json.
|
|
132
138
|
|
|
133
139
|
ALIASES
|
|
134
140
|
$ sf force:package1:version:create:get
|
|
@@ -143,7 +149,7 @@ EXAMPLES
|
|
|
143
149
|
$ sf package1:version:create:get --request-id 0HD... --target-org myorg@example.com
|
|
144
150
|
```
|
|
145
151
|
|
|
146
|
-
_See code: [src/commands/package1/version/create/get.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
152
|
+
_See code: [src/commands/package1/version/create/get.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.5/src/commands/package1/version/create/get.ts)_
|
|
147
153
|
|
|
148
154
|
## `sf package1:version:display`
|
|
149
155
|
|
|
@@ -151,14 +157,17 @@ Display details about a first-generation package version.
|
|
|
151
157
|
|
|
152
158
|
```
|
|
153
159
|
USAGE
|
|
154
|
-
$ sf package1:version:display -o <value> -i <value> [--api-version <value>]
|
|
160
|
+
$ sf package1:version:display -o <value> -i <value> [--json] [--api-version <value>]
|
|
155
161
|
|
|
156
162
|
FLAGS
|
|
157
163
|
-i, --package-version-id=<value> (required) ID (starts with 04t) of the metadata package version whose details you
|
|
158
164
|
want to display.
|
|
159
165
|
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
160
166
|
configuration variable is already set.
|
|
161
|
-
|
|
167
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
168
|
+
|
|
169
|
+
GLOBAL FLAGS
|
|
170
|
+
--json Format output as json.
|
|
162
171
|
|
|
163
172
|
ALIASES
|
|
164
173
|
$ sf force:package1:version:display
|
|
@@ -173,7 +182,7 @@ EXAMPLES
|
|
|
173
182
|
$ sf package1:version:display --package-version-id 04t... --target-org myorg@example.com
|
|
174
183
|
```
|
|
175
184
|
|
|
176
|
-
_See code: [src/commands/package1/version/display.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
185
|
+
_See code: [src/commands/package1/version/display.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.5/src/commands/package1/version/display.ts)_
|
|
177
186
|
|
|
178
187
|
## `sf package1:version:list`
|
|
179
188
|
|
|
@@ -181,13 +190,16 @@ List package versions for the specified first-generation package or for the org.
|
|
|
181
190
|
|
|
182
191
|
```
|
|
183
192
|
USAGE
|
|
184
|
-
$ sf package1:version:list -o <value> [--api-version <value>] [-i <value>]
|
|
193
|
+
$ sf package1:version:list -o <value> [--json] [--api-version <value>] [-i <value>]
|
|
185
194
|
|
|
186
195
|
FLAGS
|
|
187
|
-
-i, --package-id=<value>
|
|
188
|
-
-o, --target-org=<value>
|
|
189
|
-
|
|
190
|
-
|
|
196
|
+
-i, --package-id=<value> Metadata package ID (starts with 033) whose package versions you want to list.
|
|
197
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
198
|
+
configuration variable is already set.
|
|
199
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
200
|
+
|
|
201
|
+
GLOBAL FLAGS
|
|
202
|
+
--json Format output as json.
|
|
191
203
|
|
|
192
204
|
ALIASES
|
|
193
205
|
$ sf force:package1:version:list
|
|
@@ -207,7 +219,7 @@ FLAG DESCRIPTIONS
|
|
|
207
219
|
If not specified, shows all versions for all packages (managed and unmanaged) in the org.
|
|
208
220
|
```
|
|
209
221
|
|
|
210
|
-
_See code: [src/commands/package1/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
222
|
+
_See code: [src/commands/package1/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.5/src/commands/package1/version/list.ts)_
|
|
211
223
|
|
|
212
224
|
## `sf package:create`
|
|
213
225
|
|
|
@@ -215,8 +227,8 @@ Create a package.
|
|
|
215
227
|
|
|
216
228
|
```
|
|
217
229
|
USAGE
|
|
218
|
-
$ sf package:create -v <value> -n <value> -t Managed|Unlocked -r <value> [--api-version <value>] [-d
|
|
219
|
-
[--org-dependent] [-o <value>]
|
|
230
|
+
$ sf package:create -v <value> -n <value> -t Managed|Unlocked -r <value> [--json] [--api-version <value>] [-d
|
|
231
|
+
<value>] [-e] [--org-dependent] [-o <value>]
|
|
220
232
|
|
|
221
233
|
FLAGS
|
|
222
234
|
-d, --description=<value> Description of the package.
|
|
@@ -229,10 +241,13 @@ FLAGS
|
|
|
229
241
|
<options: Managed|Unlocked>
|
|
230
242
|
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the
|
|
231
243
|
`target-dev-hub` configuration variable is already set.
|
|
232
|
-
|
|
233
|
-
|
|
244
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
245
|
+
--org-dependent Depends on unpackaged metadata in the installation org; applies to unlocked
|
|
234
246
|
packages only.
|
|
235
247
|
|
|
248
|
+
GLOBAL FLAGS
|
|
249
|
+
--json Format output as json.
|
|
250
|
+
|
|
236
251
|
DESCRIPTION
|
|
237
252
|
Create a package.
|
|
238
253
|
|
|
@@ -282,7 +297,7 @@ FLAG DESCRIPTIONS
|
|
|
282
297
|
Org-Dependent Unlocked Packages" in the Salesforce DX Developer Guide.
|
|
283
298
|
```
|
|
284
299
|
|
|
285
|
-
_See code: [src/commands/package/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
300
|
+
_See code: [src/commands/package/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.5/src/commands/package/create.ts)_
|
|
286
301
|
|
|
287
302
|
## `sf package:delete`
|
|
288
303
|
|
|
@@ -290,14 +305,17 @@ Delete a package.
|
|
|
290
305
|
|
|
291
306
|
```
|
|
292
307
|
USAGE
|
|
293
|
-
$ sf package:delete -v <value> -p <value> [--api-version <value>] [-n]
|
|
308
|
+
$ sf package:delete -v <value> -p <value> [--json] [--api-version <value>] [-n]
|
|
294
309
|
|
|
295
310
|
FLAGS
|
|
296
311
|
-n, --no-prompt Don’t prompt before deleting the package.
|
|
297
312
|
-p, --package=<value> (required) ID (starts with 0Ho) or alias of the package to delete.
|
|
298
313
|
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the `target-dev-hub`
|
|
299
314
|
configuration variable is already set.
|
|
300
|
-
|
|
315
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
316
|
+
|
|
317
|
+
GLOBAL FLAGS
|
|
318
|
+
--json Format output as json.
|
|
301
319
|
|
|
302
320
|
DESCRIPTION
|
|
303
321
|
Delete a package.
|
|
@@ -320,7 +338,7 @@ EXAMPLES
|
|
|
320
338
|
$ sf package:delete --package 0Ho... --target-dev-hub devhub@example.com
|
|
321
339
|
```
|
|
322
340
|
|
|
323
|
-
_See code: [src/commands/package/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
341
|
+
_See code: [src/commands/package/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.5/src/commands/package/delete.ts)_
|
|
324
342
|
|
|
325
343
|
## `sf package:install`
|
|
326
344
|
|
|
@@ -328,8 +346,8 @@ Install a version of a package in the target org.
|
|
|
328
346
|
|
|
329
347
|
```
|
|
330
348
|
USAGE
|
|
331
|
-
$ sf package:install -o <value> -p <value> [--api-version <value>] [-w <value>] [-k <value>] [-b <value>]
|
|
332
|
-
all|package] [-s AllUsers|AdminsOnly] [-t DeprecateOnly|Mixed|Delete]
|
|
349
|
+
$ sf package:install -o <value> -p <value> [--json] [--api-version <value>] [-w <value>] [-k <value>] [-b <value>]
|
|
350
|
+
[-r] [-a all|package] [-s AllUsers|AdminsOnly] [-t DeprecateOnly|Mixed|Delete]
|
|
333
351
|
|
|
334
352
|
FLAGS
|
|
335
353
|
-a, --apex-compile=<option> [default: all] Compile all Apex in the org and package, or only Apex in the package;
|
|
@@ -350,7 +368,10 @@ FLAGS
|
|
|
350
368
|
unlocked packages.
|
|
351
369
|
<options: DeprecateOnly|Mixed|Delete>
|
|
352
370
|
-w, --wait=<value> [default: 0 minutes] Number of minutes to wait for installation status.
|
|
353
|
-
|
|
371
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
372
|
+
|
|
373
|
+
GLOBAL FLAGS
|
|
374
|
+
--json Format output as json.
|
|
354
375
|
|
|
355
376
|
DESCRIPTION
|
|
356
377
|
Install a version of a package in the target org.
|
|
@@ -414,7 +435,7 @@ FLAG DESCRIPTIONS
|
|
|
414
435
|
specify DeprecateOnly or Delete only for unlocked package upgrades.
|
|
415
436
|
```
|
|
416
437
|
|
|
417
|
-
_See code: [src/commands/package/install.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
438
|
+
_See code: [src/commands/package/install.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.5/src/commands/package/install.ts)_
|
|
418
439
|
|
|
419
440
|
## `sf package:install:report`
|
|
420
441
|
|
|
@@ -422,13 +443,16 @@ Retrieve the status of a package installation request.
|
|
|
422
443
|
|
|
423
444
|
```
|
|
424
445
|
USAGE
|
|
425
|
-
$ sf package:install:report -o <value> -i <value> [--api-version <value>]
|
|
446
|
+
$ sf package:install:report -o <value> -i <value> [--json] [--api-version <value>]
|
|
426
447
|
|
|
427
448
|
FLAGS
|
|
428
|
-
-i, --request-id=<value>
|
|
429
|
-
-o, --target-org=<value>
|
|
430
|
-
|
|
431
|
-
|
|
449
|
+
-i, --request-id=<value> (required) ID of the package install request you want to check; starts with 0Hf.
|
|
450
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
451
|
+
configuration variable is already set.
|
|
452
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
453
|
+
|
|
454
|
+
GLOBAL FLAGS
|
|
455
|
+
--json Format output as json.
|
|
432
456
|
|
|
433
457
|
ALIASES
|
|
434
458
|
$ sf force:package:install:report
|
|
@@ -443,7 +467,7 @@ EXAMPLES
|
|
|
443
467
|
$ sf package:install:report --request-id 0Hf... --target-org me@example.com
|
|
444
468
|
```
|
|
445
469
|
|
|
446
|
-
_See code: [src/commands/package/install/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
470
|
+
_See code: [src/commands/package/install/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.5/src/commands/package/install/report.ts)_
|
|
447
471
|
|
|
448
472
|
## `sf package:installed:list`
|
|
449
473
|
|
|
@@ -451,12 +475,15 @@ List the org’s installed packages.
|
|
|
451
475
|
|
|
452
476
|
```
|
|
453
477
|
USAGE
|
|
454
|
-
$ sf package:installed:list -o <value> [--api-version <value>]
|
|
478
|
+
$ sf package:installed:list -o <value> [--json] [--api-version <value>]
|
|
455
479
|
|
|
456
480
|
FLAGS
|
|
457
|
-
-o, --target-org=<value>
|
|
458
|
-
|
|
459
|
-
|
|
481
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
482
|
+
configuration variable is already set.
|
|
483
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
484
|
+
|
|
485
|
+
GLOBAL FLAGS
|
|
486
|
+
--json Format output as json.
|
|
460
487
|
|
|
461
488
|
ALIASES
|
|
462
489
|
$ sf force:package:installed:list
|
|
@@ -471,7 +498,7 @@ EXAMPLES
|
|
|
471
498
|
$ sf package:installed:list --target-org me@example.com
|
|
472
499
|
```
|
|
473
500
|
|
|
474
|
-
_See code: [src/commands/package/installed/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
501
|
+
_See code: [src/commands/package/installed/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.5/src/commands/package/installed/list.ts)_
|
|
475
502
|
|
|
476
503
|
## `sf package:list`
|
|
477
504
|
|
|
@@ -479,13 +506,16 @@ List all packages in the Dev Hub org.
|
|
|
479
506
|
|
|
480
507
|
```
|
|
481
508
|
USAGE
|
|
482
|
-
$ sf package:list -v <value> [--api-version <value>] [--verbose]
|
|
509
|
+
$ sf package:list -v <value> [--json] [--api-version <value>] [--verbose]
|
|
483
510
|
|
|
484
511
|
FLAGS
|
|
485
512
|
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the `target-dev-hub`
|
|
486
513
|
configuration variable is already set.
|
|
487
|
-
|
|
488
|
-
|
|
514
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
515
|
+
--verbose Display extended package detail.
|
|
516
|
+
|
|
517
|
+
GLOBAL FLAGS
|
|
518
|
+
--json Format output as json.
|
|
489
519
|
|
|
490
520
|
DESCRIPTION
|
|
491
521
|
List all packages in the Dev Hub org.
|
|
@@ -505,7 +535,7 @@ EXAMPLES
|
|
|
505
535
|
$ sf package:list --target-dev-hub devhub@example.com --verbose
|
|
506
536
|
```
|
|
507
537
|
|
|
508
|
-
_See code: [src/commands/package/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
538
|
+
_See code: [src/commands/package/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.5/src/commands/package/list.ts)_
|
|
509
539
|
|
|
510
540
|
## `sf package:uninstall`
|
|
511
541
|
|
|
@@ -513,14 +543,17 @@ Uninstall a second-generation package from the target org.
|
|
|
513
543
|
|
|
514
544
|
```
|
|
515
545
|
USAGE
|
|
516
|
-
$ sf package:uninstall -o <value> -p <value> [--api-version <value>] [-w <value>]
|
|
546
|
+
$ sf package:uninstall -o <value> -p <value> [--json] [--api-version <value>] [-w <value>]
|
|
517
547
|
|
|
518
548
|
FLAGS
|
|
519
|
-
-o, --target-org=<value>
|
|
520
|
-
|
|
521
|
-
-p, --package=<value>
|
|
522
|
-
-w, --wait=<value>
|
|
523
|
-
|
|
549
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
550
|
+
configuration variable is already set.
|
|
551
|
+
-p, --package=<value> (required) ID (starts with 04t) or alias of the package version to uninstall.
|
|
552
|
+
-w, --wait=<value> [default: 0 minutes] Number of minutes to wait for uninstall status.
|
|
553
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
554
|
+
|
|
555
|
+
GLOBAL FLAGS
|
|
556
|
+
--json Format output as json.
|
|
524
557
|
|
|
525
558
|
DESCRIPTION
|
|
526
559
|
Uninstall a second-generation package from the target org.
|
|
@@ -549,7 +582,7 @@ EXAMPLES
|
|
|
549
582
|
$ sf package:uninstall --package "Undesirable Package Alias"
|
|
550
583
|
```
|
|
551
584
|
|
|
552
|
-
_See code: [src/commands/package/uninstall.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
585
|
+
_See code: [src/commands/package/uninstall.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.5/src/commands/package/uninstall.ts)_
|
|
553
586
|
|
|
554
587
|
## `sf package:uninstall:report`
|
|
555
588
|
|
|
@@ -557,13 +590,16 @@ Retrieve the status of a package uninstall request.
|
|
|
557
590
|
|
|
558
591
|
```
|
|
559
592
|
USAGE
|
|
560
|
-
$ sf package:uninstall:report -o <value> -i <value> [--api-version <value>]
|
|
593
|
+
$ sf package:uninstall:report -o <value> -i <value> [--json] [--api-version <value>]
|
|
561
594
|
|
|
562
595
|
FLAGS
|
|
563
|
-
-i, --request-id=<value>
|
|
564
|
-
-o, --target-org=<value>
|
|
565
|
-
|
|
566
|
-
|
|
596
|
+
-i, --request-id=<value> (required) ID of the package uninstall request you want to check; starts with 06y.
|
|
597
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
598
|
+
configuration variable is already set.
|
|
599
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
600
|
+
|
|
601
|
+
GLOBAL FLAGS
|
|
602
|
+
--json Format output as json.
|
|
567
603
|
|
|
568
604
|
ALIASES
|
|
569
605
|
$ sf force:package:uninstall:report
|
|
@@ -578,7 +614,7 @@ EXAMPLES
|
|
|
578
614
|
$ sf package:uninstall:report --request-id 06y... --target-org me@example.com
|
|
579
615
|
```
|
|
580
616
|
|
|
581
|
-
_See code: [src/commands/package/uninstall/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
617
|
+
_See code: [src/commands/package/uninstall/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.5/src/commands/package/uninstall/report.ts)_
|
|
582
618
|
|
|
583
619
|
## `sf package:update`
|
|
584
620
|
|
|
@@ -586,7 +622,7 @@ Update package details.
|
|
|
586
622
|
|
|
587
623
|
```
|
|
588
624
|
USAGE
|
|
589
|
-
$ sf package:update -v <value> -p <value> [--api-version <value>] [-n <value>] [-d <value>] [-o <value>]
|
|
625
|
+
$ sf package:update -v <value> -p <value> [--json] [--api-version <value>] [-n <value>] [-d <value>] [-o <value>]
|
|
590
626
|
[--enable-app-analytics]
|
|
591
627
|
|
|
592
628
|
FLAGS
|
|
@@ -597,10 +633,13 @@ FLAGS
|
|
|
597
633
|
-p, --package=<value> (required) ID (starts with 0Ho) or alias of the package to update.
|
|
598
634
|
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the
|
|
599
635
|
`target-dev-hub` configuration variable is already set.
|
|
600
|
-
|
|
601
|
-
|
|
636
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
637
|
+
--[no-]enable-app-analytics Enable AppExchange App Analytics usage data collection on this managed
|
|
602
638
|
package and its components.
|
|
603
639
|
|
|
640
|
+
GLOBAL FLAGS
|
|
641
|
+
--json Format output as json.
|
|
642
|
+
|
|
604
643
|
DESCRIPTION
|
|
605
644
|
Update package details.
|
|
606
645
|
|
|
@@ -629,7 +668,7 @@ FLAG DESCRIPTIONS
|
|
|
629
668
|
associated with your package.
|
|
630
669
|
```
|
|
631
670
|
|
|
632
|
-
_See code: [src/commands/package/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
671
|
+
_See code: [src/commands/package/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.5/src/commands/package/update.ts)_
|
|
633
672
|
|
|
634
673
|
## `sf package:version:create`
|
|
635
674
|
|
|
@@ -637,8 +676,8 @@ Create a package version in the Dev Hub org.
|
|
|
637
676
|
|
|
638
677
|
```
|
|
639
678
|
USAGE
|
|
640
|
-
$ sf package:version:create -v <value> [--api-version <value>] [-b <value>] [-c | --skip-validation] [-f <value>]
|
|
641
|
-
<value>] [-x] [-p <value>] [-d <value>] [--post-install-script <value>] [--post-install-url <value>]
|
|
679
|
+
$ sf package:version:create -v <value> [--json] [--api-version <value>] [-b <value>] [-c | --skip-validation] [-f <value>]
|
|
680
|
+
[-k <value>] [-x] [-p <value>] [-d <value>] [--post-install-script <value>] [--post-install-url <value>]
|
|
642
681
|
[--releasenotes-url <value>] [--skip-ancestor-check] [-t <value>] [--uninstall-script <value>] [-e <value>] [-a
|
|
643
682
|
<value>] [-n <value>] [-w <value>] [--language <value>] [--verbose]
|
|
644
683
|
|
|
@@ -666,17 +705,20 @@ FLAGS
|
|
|
666
705
|
created.
|
|
667
706
|
-x, --installation-key-bypass Bypass the installation key requirement. (either --installation-key or
|
|
668
707
|
--installation-key-bypass is required)
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
708
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
709
|
+
--language=<value> Language for the package.
|
|
710
|
+
--post-install-script=<value> Name of the post-install script; applies to managed packages only.
|
|
711
|
+
--post-install-url=<value> Post-install instructions URL.
|
|
712
|
+
--releasenotes-url=<value> Release notes URL.
|
|
713
|
+
--skip-ancestor-check Overrides ancestry requirements, which allows you to specify a package ancestor
|
|
675
714
|
that isn’t the highest released package version.
|
|
676
|
-
|
|
715
|
+
--skip-validation Skip validation during package version creation; you can’t promote unvalidated
|
|
677
716
|
package versions.
|
|
678
|
-
|
|
679
|
-
|
|
717
|
+
--uninstall-script=<value> Uninstall script name; applies to managed packages only.
|
|
718
|
+
--verbose Display verbose command output.
|
|
719
|
+
|
|
720
|
+
GLOBAL FLAGS
|
|
721
|
+
--json Format output as json.
|
|
680
722
|
|
|
681
723
|
DESCRIPTION
|
|
682
724
|
Create a package version in the Dev Hub org.
|
|
@@ -781,7 +823,7 @@ FLAG DESCRIPTIONS
|
|
|
781
823
|
periods of no output from commands.
|
|
782
824
|
```
|
|
783
825
|
|
|
784
|
-
_See code: [src/commands/package/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
826
|
+
_See code: [src/commands/package/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.5/src/commands/package/version/create.ts)_
|
|
785
827
|
|
|
786
828
|
## `sf package:version:create:list`
|
|
787
829
|
|
|
@@ -789,7 +831,7 @@ List package version creation requests.
|
|
|
789
831
|
|
|
790
832
|
```
|
|
791
833
|
USAGE
|
|
792
|
-
$ sf package:version:create:list -v <value> [--api-version <value>] [-c <value>] [-s Queued|InProgress|Success|Error]
|
|
834
|
+
$ sf package:version:create:list -v <value> [--json] [--api-version <value>] [-c <value>] [-s Queued|InProgress|Success|Error]
|
|
793
835
|
[--show-conversions-only] [--verbose]
|
|
794
836
|
|
|
795
837
|
FLAGS
|
|
@@ -799,11 +841,14 @@ FLAGS
|
|
|
799
841
|
<options: Queued|InProgress|Success|Error>
|
|
800
842
|
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the `target-dev-hub`
|
|
801
843
|
configuration variable is already set.
|
|
802
|
-
|
|
803
|
-
|
|
804
|
-
|
|
844
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
845
|
+
--show-conversions-only Filter the list output to display only converted package version.
|
|
846
|
+
--verbose Displays additional information at a slight performance cost, such as the version
|
|
805
847
|
name and number for each package version create request.
|
|
806
848
|
|
|
849
|
+
GLOBAL FLAGS
|
|
850
|
+
--json Format output as json.
|
|
851
|
+
|
|
807
852
|
DESCRIPTION
|
|
808
853
|
List package version creation requests.
|
|
809
854
|
|
|
@@ -838,7 +883,7 @@ EXAMPLES
|
|
|
838
883
|
$ sf package:version:create:list --created-last-days 0 --status Success
|
|
839
884
|
```
|
|
840
885
|
|
|
841
|
-
_See code: [src/commands/package/version/create/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
886
|
+
_See code: [src/commands/package/version/create/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.5/src/commands/package/version/create/list.ts)_
|
|
842
887
|
|
|
843
888
|
## `sf package:version:create:report`
|
|
844
889
|
|
|
@@ -846,14 +891,17 @@ Retrieve details about a package version creation request.
|
|
|
846
891
|
|
|
847
892
|
```
|
|
848
893
|
USAGE
|
|
849
|
-
$ sf package:version:create:report -v <value> -i <value> [--api-version <value>]
|
|
894
|
+
$ sf package:version:create:report -v <value> -i <value> [--json] [--api-version <value>]
|
|
850
895
|
|
|
851
896
|
FLAGS
|
|
852
897
|
-i, --package-create-request-id=<value> (required) ID (starts with 08c) of the package version creation request you
|
|
853
898
|
want to display.
|
|
854
899
|
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the
|
|
855
900
|
`target-dev-hub` configuration variable is already set.
|
|
856
|
-
|
|
901
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
902
|
+
|
|
903
|
+
GLOBAL FLAGS
|
|
904
|
+
--json Format output as json.
|
|
857
905
|
|
|
858
906
|
DESCRIPTION
|
|
859
907
|
Retrieve details about a package version creation request.
|
|
@@ -877,7 +925,7 @@ EXAMPLES
|
|
|
877
925
|
$ sf package:version:create:report --package-create-request-id 08c... --target-dev-hub devhub@example.com
|
|
878
926
|
```
|
|
879
927
|
|
|
880
|
-
_See code: [src/commands/package/version/create/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
928
|
+
_See code: [src/commands/package/version/create/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.5/src/commands/package/version/create/report.ts)_
|
|
881
929
|
|
|
882
930
|
## `sf package:version:delete`
|
|
883
931
|
|
|
@@ -885,14 +933,17 @@ Delete a package version.
|
|
|
885
933
|
|
|
886
934
|
```
|
|
887
935
|
USAGE
|
|
888
|
-
$ sf package:version:delete -v <value> -p <value> [--api-version <value>] [-n]
|
|
936
|
+
$ sf package:version:delete -v <value> -p <value> [--json] [--api-version <value>] [-n]
|
|
889
937
|
|
|
890
938
|
FLAGS
|
|
891
939
|
-n, --no-prompt Don’t prompt before deleting the package version.
|
|
892
940
|
-p, --package=<value> (required) ID (starts with 04t) or alias of the package version to delete.
|
|
893
941
|
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the `target-dev-hub`
|
|
894
942
|
configuration variable is already set.
|
|
895
|
-
|
|
943
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
944
|
+
|
|
945
|
+
GLOBAL FLAGS
|
|
946
|
+
--json Format output as json.
|
|
896
947
|
|
|
897
948
|
DESCRIPTION
|
|
898
949
|
Delete a package version.
|
|
@@ -912,7 +963,7 @@ EXAMPLES
|
|
|
912
963
|
$ sf package:version:delete --package 04t... --target-org devhub@example.com
|
|
913
964
|
```
|
|
914
965
|
|
|
915
|
-
_See code: [src/commands/package/version/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
966
|
+
_See code: [src/commands/package/version/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.5/src/commands/package/version/delete.ts)_
|
|
916
967
|
|
|
917
968
|
## `sf package:version:displayancestry`
|
|
918
969
|
|
|
@@ -920,18 +971,21 @@ Display the ancestry tree for a 2GP managed package version.
|
|
|
920
971
|
|
|
921
972
|
```
|
|
922
973
|
USAGE
|
|
923
|
-
$ sf package:version:displayancestry -v <value> -p <value> [--api-version <value>] [--dot-code] [--verbose]
|
|
974
|
+
$ sf package:version:displayancestry -v <value> -p <value> [--json] [--api-version <value>] [--dot-code] [--verbose]
|
|
924
975
|
|
|
925
976
|
FLAGS
|
|
926
977
|
-p, --package=<value> (required) ID or alias of the package (starts with 0Ho) or package version (starts with
|
|
927
978
|
04t) to display ancestry for.
|
|
928
979
|
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the `target-dev-hub`
|
|
929
980
|
configuration variable is already set.
|
|
930
|
-
|
|
931
|
-
|
|
932
|
-
|
|
981
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
982
|
+
--dot-code Display the ancestry tree in DOT code.
|
|
983
|
+
--verbose Display both the package version ID (starts with 04t) and the version number
|
|
933
984
|
(major.minor.patch.build) in the ancestry tree.
|
|
934
985
|
|
|
986
|
+
GLOBAL FLAGS
|
|
987
|
+
--json Format output as json.
|
|
988
|
+
|
|
935
989
|
ALIASES
|
|
936
990
|
$ sf force:package:version:displayancestry
|
|
937
991
|
|
|
@@ -967,7 +1021,7 @@ FLAG DESCRIPTIONS
|
|
|
967
1021
|
You can use the DOT code output in graph visualization software to create tree visualizations.
|
|
968
1022
|
```
|
|
969
1023
|
|
|
970
|
-
_See code: [src/commands/package/version/displayancestry.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
1024
|
+
_See code: [src/commands/package/version/displayancestry.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.5/src/commands/package/version/displayancestry.ts)_
|
|
971
1025
|
|
|
972
1026
|
## `sf package:version:list`
|
|
973
1027
|
|
|
@@ -975,8 +1029,8 @@ List all package versions in the Dev Hub org.
|
|
|
975
1029
|
|
|
976
1030
|
```
|
|
977
1031
|
USAGE
|
|
978
|
-
$ sf package:version:list -v <value> [--api-version <value>] [-c <value>] [--concise] [--show-conversions-only]
|
|
979
|
-
<value>] [-p <value>] [-r] [-o <value>] [--verbose]
|
|
1032
|
+
$ sf package:version:list -v <value> [--json] [--api-version <value>] [-c <value>] [--concise] [--show-conversions-only]
|
|
1033
|
+
[-m <value>] [-p <value>] [-r] [-o <value>] [--verbose]
|
|
980
1034
|
|
|
981
1035
|
FLAGS
|
|
982
1036
|
-c, --created-last-days=<value> Number of days since the request was created, starting at 00:00:00 of first day to
|
|
@@ -988,10 +1042,13 @@ FLAGS
|
|
|
988
1042
|
-r, --released Display released versions only (IsReleased=true).
|
|
989
1043
|
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the
|
|
990
1044
|
`target-dev-hub` configuration variable is already set.
|
|
991
|
-
|
|
992
|
-
|
|
993
|
-
|
|
994
|
-
|
|
1045
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
1046
|
+
--concise Display limited package version details.
|
|
1047
|
+
--show-conversions-only Filter the list output to display only converted package version.
|
|
1048
|
+
--verbose Display extended package version details.
|
|
1049
|
+
|
|
1050
|
+
GLOBAL FLAGS
|
|
1051
|
+
--json Format output as json.
|
|
995
1052
|
|
|
996
1053
|
DESCRIPTION
|
|
997
1054
|
List all package versions in the Dev Hub org.
|
|
@@ -1032,7 +1089,7 @@ EXAMPLES
|
|
|
1032
1089
|
$ sf package:version:list --packages exp-mgr,exp-mgr-util --released --modified-last-days 0
|
|
1033
1090
|
```
|
|
1034
1091
|
|
|
1035
|
-
_See code: [src/commands/package/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
1092
|
+
_See code: [src/commands/package/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.5/src/commands/package/version/list.ts)_
|
|
1036
1093
|
|
|
1037
1094
|
## `sf package:version:promote`
|
|
1038
1095
|
|
|
@@ -1040,14 +1097,17 @@ Promote a package version to released.
|
|
|
1040
1097
|
|
|
1041
1098
|
```
|
|
1042
1099
|
USAGE
|
|
1043
|
-
$ sf package:version:promote -v <value> -p <value> [--api-version <value>] [-n]
|
|
1100
|
+
$ sf package:version:promote -v <value> -p <value> [--json] [--api-version <value>] [-n]
|
|
1044
1101
|
|
|
1045
1102
|
FLAGS
|
|
1046
1103
|
-n, --no-prompt Don't prompt to confirm setting the package version as released.
|
|
1047
1104
|
-p, --package=<value> (required) ID (starts with 04t) or alias of the package version to promote.
|
|
1048
1105
|
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the `target-dev-hub`
|
|
1049
1106
|
configuration variable is already set.
|
|
1050
|
-
|
|
1107
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
1108
|
+
|
|
1109
|
+
GLOBAL FLAGS
|
|
1110
|
+
--json Format output as json.
|
|
1051
1111
|
|
|
1052
1112
|
DESCRIPTION
|
|
1053
1113
|
Promote a package version to released.
|
|
@@ -1072,7 +1132,7 @@ EXAMPLES
|
|
|
1072
1132
|
$ sf package:version:promote --package "Awesome Package Alias"
|
|
1073
1133
|
```
|
|
1074
1134
|
|
|
1075
|
-
_See code: [src/commands/package/version/promote.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
1135
|
+
_See code: [src/commands/package/version/promote.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.5/src/commands/package/version/promote.ts)_
|
|
1076
1136
|
|
|
1077
1137
|
## `sf package:version:report`
|
|
1078
1138
|
|
|
@@ -1080,14 +1140,17 @@ Retrieve details about a package version in the Dev Hub org.
|
|
|
1080
1140
|
|
|
1081
1141
|
```
|
|
1082
1142
|
USAGE
|
|
1083
|
-
$ sf package:version:report -v <value> -p <value> [--api-version <value>] [--verbose]
|
|
1143
|
+
$ sf package:version:report -v <value> -p <value> [--json] [--api-version <value>] [--verbose]
|
|
1084
1144
|
|
|
1085
1145
|
FLAGS
|
|
1086
1146
|
-p, --package=<value> (required) ID (starts with 04t) or alias of the package to retrieve details for.
|
|
1087
1147
|
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the `target-dev-hub`
|
|
1088
1148
|
configuration variable is already set.
|
|
1089
|
-
|
|
1090
|
-
|
|
1149
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
1150
|
+
--verbose Display extended package version details.
|
|
1151
|
+
|
|
1152
|
+
GLOBAL FLAGS
|
|
1153
|
+
--json Format output as json.
|
|
1091
1154
|
|
|
1092
1155
|
DESCRIPTION
|
|
1093
1156
|
Retrieve details about a package version in the Dev Hub org.
|
|
@@ -1108,7 +1171,7 @@ EXAMPLES
|
|
|
1108
1171
|
$ sf package:version:report --package "Your Package Alias" --target-dev-hub devhub@example.com
|
|
1109
1172
|
```
|
|
1110
1173
|
|
|
1111
|
-
_See code: [src/commands/package/version/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
1174
|
+
_See code: [src/commands/package/version/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.5/src/commands/package/version/report.ts)_
|
|
1112
1175
|
|
|
1113
1176
|
## `sf package:version:update`
|
|
1114
1177
|
|
|
@@ -1116,8 +1179,8 @@ Update a package version.
|
|
|
1116
1179
|
|
|
1117
1180
|
```
|
|
1118
1181
|
USAGE
|
|
1119
|
-
$ sf package:version:update -v <value> -p <value> [--api-version <value>] [-a <value>] [-e <value>] [-b <value>]
|
|
1120
|
-
<value>] [-k <value>]
|
|
1182
|
+
$ sf package:version:update -v <value> -p <value> [--json] [--api-version <value>] [-a <value>] [-e <value>] [-b <value>]
|
|
1183
|
+
[-t <value>] [-k <value>]
|
|
1121
1184
|
|
|
1122
1185
|
FLAGS
|
|
1123
1186
|
-a, --version-name=<value> New package version name.
|
|
@@ -1128,7 +1191,10 @@ FLAGS
|
|
|
1128
1191
|
-t, --tag=<value> New package version tag.
|
|
1129
1192
|
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the
|
|
1130
1193
|
`target-dev-hub` configuration variable is already set.
|
|
1131
|
-
|
|
1194
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
1195
|
+
|
|
1196
|
+
GLOBAL FLAGS
|
|
1197
|
+
--json Format output as json.
|
|
1132
1198
|
|
|
1133
1199
|
DESCRIPTION
|
|
1134
1200
|
Update a package version.
|
|
@@ -1157,6 +1223,6 @@ EXAMPLES
|
|
|
1157
1223
|
$ sf package:version:update --package 04t... --version-description "New Package Version Description"
|
|
1158
1224
|
```
|
|
1159
1225
|
|
|
1160
|
-
_See code: [src/commands/package/version/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.
|
|
1226
|
+
_See code: [src/commands/package/version/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.5/src/commands/package/version/update.ts)_
|
|
1161
1227
|
|
|
1162
1228
|
<!-- commandsstop -->
|