@@ -52,6 +52,7 @@ See [DEVELOPING.md](DEVELOPING.md)
52
52
- [ ` sf package version list ` ] ( #sf-package-version-list )
53
53
- [ ` sf package version promote ` ] ( #sf-package-version-promote )
54
54
- [ ` sf package version report ` ] ( #sf-package-version-report )
55
+ - [ ` sf package version retrieve ` ] ( #sf-package-version-retrieve )
55
56
- [ ` sf package version update ` ] ( #sf-package-version-update )
56
57
- [ ` sf package1 version create ` ] ( #sf-package1-version-create )
57
58
- [ ` sf package1 version create get ` ] ( #sf-package1-version-create-get )
@@ -153,7 +154,7 @@ FLAG DESCRIPTIONS
153
154
--installation-key-bypass flag is required.
154
155
```
155
156
156
- _ See code: [ src/commands/package/convert.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.16 .0/src/commands/package/convert.ts ) _
157
+ _ See code: [ src/commands/package/convert.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.17 .0/src/commands/package/convert.ts ) _
157
158
158
159
## ` sf package create `
159
160
@@ -232,7 +233,7 @@ FLAG DESCRIPTIONS
232
233
Org-Dependent Unlocked Packages" in the Salesforce DX Developer Guide.
233
234
```
234
235
235
- _ See code: [ src/commands/package/create.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.16 .0/src/commands/package/create.ts ) _
236
+ _ See code: [ src/commands/package/create.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.17 .0/src/commands/package/create.ts ) _
236
237
237
238
## ` sf package delete `
238
239
@@ -274,7 +275,7 @@ EXAMPLES
274
275
$ sf package delete --package 0Ho... --target-dev-hub [email protected]
275
276
```
276
277
277
- _ See code: [ src/commands/package/delete.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.16 .0/src/commands/package/delete.ts ) _
278
+ _ See code: [ src/commands/package/delete.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.17 .0/src/commands/package/delete.ts ) _
278
279
279
280
## ` sf package install `
280
281
@@ -373,7 +374,7 @@ FLAG DESCRIPTIONS
373
374
- Delete: Delete all removed components that can be safely deleted, and deprecate the other components.
374
375
```
375
376
376
- _ See code: [ src/commands/package/install.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.16 .0/src/commands/package/install.ts ) _
377
+ _ See code: [ src/commands/package/install.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.17 .0/src/commands/package/install.ts ) _
377
378
378
379
## ` sf package install report `
379
380
@@ -406,7 +407,7 @@ EXAMPLES
406
407
$ sf package install report --request-id 0Hf... --target-org [email protected]
407
408
```
408
409
409
- _ See code: [ src/commands/package/install/report.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.16 .0/src/commands/package/install/report.ts ) _
410
+ _ See code: [ src/commands/package/install/report.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.17 .0/src/commands/package/install/report.ts ) _
410
411
411
412
## ` sf package installed list `
412
413
@@ -438,7 +439,7 @@ EXAMPLES
438
439
$ sf package installed list --target-org [email protected]
439
440
```
440
441
441
- _ See code: [ src/commands/package/installed/list.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.16 .0/src/commands/package/installed/list.ts ) _
442
+ _ See code: [ src/commands/package/installed/list.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.17 .0/src/commands/package/installed/list.ts ) _
442
443
443
444
## ` sf package list `
444
445
@@ -476,7 +477,7 @@ EXAMPLES
476
477
$ sf package list --target-dev-hub [email protected] --verbose
477
478
```
478
479
479
- _ See code: [ src/commands/package/list.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.16 .0/src/commands/package/list.ts ) _
480
+ _ See code: [ src/commands/package/list.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.17 .0/src/commands/package/list.ts ) _
480
481
481
482
## ` sf package push-upgrade abort `
482
483
@@ -501,8 +502,7 @@ DESCRIPTION
501
502
Abort a package push upgrade that has been scheduled. Only push upgrade requests with a status of Created or Pending
502
503
can be aborted.
503
504
504
- Specify the request ID for which you want abort the request. If applicable, the command displays errors related to the
505
- request.
505
+ Specify the request ID that you want to abort. If applicable, the command displays errors related to the request.
506
506
507
507
To show all requests in the org, run "sf package pushupgrade list --package 033...".
508
508
@@ -516,7 +516,7 @@ EXAMPLES
516
516
$ sf package push-upgrade abort --push-request-id 0DV... --target-dev-hub [email protected]
517
517
```
518
518
519
- _ See code: [ src/commands/package/push-upgrade/abort.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.16 .0/src/commands/package/push-upgrade/abort.ts ) _
519
+ _ See code: [ src/commands/package/push-upgrade/abort.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.17 .0/src/commands/package/push-upgrade/abort.ts ) _
520
520
521
521
## ` sf package push-upgrade list `
522
522
@@ -575,7 +575,7 @@ EXAMPLES
575
575
$ sf package push-upgrade list --package 033xyz –-status Failed
576
576
```
577
577
578
- _ See code: [ src/commands/package/push-upgrade/list.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.16 .0/src/commands/package/push-upgrade/list.ts ) _
578
+ _ See code: [ src/commands/package/push-upgrade/list.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.17 .0/src/commands/package/push-upgrade/list.ts ) _
579
579
580
580
## ` sf package push-upgrade report `
581
581
@@ -617,7 +617,7 @@ EXAMPLES
617
617
$ sf package push-upgrade report --push-request-id 0DV... --target-dev-hub [email protected]
618
618
```
619
619
620
- _ See code: [ src/commands/package/push-upgrade/report.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.16 .0/src/commands/package/push-upgrade/report.ts ) _
620
+ _ See code: [ src/commands/package/push-upgrade/report.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.17 .0/src/commands/package/push-upgrade/report.ts ) _
621
621
622
622
## ` sf package push-upgrade schedule `
623
623
@@ -629,13 +629,15 @@ USAGE
629
629
<value> | -f <value>] [--migrate-to-2gp]
630
630
631
631
FLAGS
632
- -f, --org-file=<value> Filename of the CSV file that contains the list of orgs that need the package upgrade.
633
- -l, --org-list=<value> Comma-separated list of subscriber org IDs that need the package upgrade.
632
+ -f, --org-file=<value> Filename of the CSV file that contains the list of subscriber org IDs that need the
633
+ package upgrade. Either --org-list or --org-file must be specified.
634
+ -l, --org-list=<value> Comma-separated list of subscriber org IDs that need the package upgrade. Either
635
+ --org-list or --org-file must be specified.
634
636
-p, --package=<value> (required) ID (starts with 04t) of the package version that the package is being
635
637
upgraded to. The package version must be an active, non-beta package version.
636
638
-t, --start-time=<value> Date and time (UTC) when the push upgrade is processed. Set to the earliest time that
637
639
you want Salesforce to attempt to start the upgrade.
638
- -v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org.
640
+ -v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org that owns the package .
639
641
--api-version=<value> Override the api version used for api requests made by this command
640
642
--migrate-to-2gp Upgrade from a first-generation managed package (1GP) to a second-generation managed
641
643
package (2GP). Required when you’re pushing a 2GP package to orgs with the 1GP version
@@ -663,23 +665,26 @@ EXAMPLES
663
665
Schedule a push upgrade that initiates at a specified time:
664
666
665
667
$ sf package push-upgrade schedule --package 04txyz --start-time "2024-12-06T21:00:00" --org-file \
666
- upgrade-orgs.csv
668
+ upgrade-orgs.csv --target-dev-hub myHub
667
669
668
670
Schedule a push upgrade that initiates as soon as possible:
669
671
670
- $ sf package push-upgrade schedule --package 04txyz --org-file upgrade-orgs.csv
672
+ $ sf package push-upgrade schedule --package 04txyz --org-file upgrade-orgs.csv --target-dev-hub myHub
671
673
672
674
Schedule a push migration from a 1GP package to a 2GP package:
673
675
674
676
$ sf package push-upgrade schedule --migrate-to-2gp --package 04txyz --start-time "2024-12-06T21:00:00" \
675
677
--org-file upgrade-orgs.csv --target-dev-hub myHub
676
678
677
679
FLAG DESCRIPTIONS
678
- -f, --org-file=<value> Filename of the CSV file that contains the list of orgs that need the package upgrade.
680
+ -f, --org-file=<value>
681
+
682
+ Filename of the CSV file that contains the list of subscriber org IDs that need the package upgrade. Either
683
+ --org-list or --org-file must be specified.
679
684
680
685
The file must contain one org per line. The org ID must be the only value in each row.
681
686
All listed orgs must have a package version installed in their org that is lower than the package version you
682
- specified for the --package-version flag.
687
+ specified for the --package flag.
683
688
684
689
-t, --start-time=<value>
685
690
@@ -694,12 +699,12 @@ FLAG DESCRIPTIONS
694
699
If you don't specify this flag, the push upgrade is scheduled to run as soon as resources are available on the
695
700
Salesforce instance.
696
701
697
- -v, --target-dev-hub=<value> Username or alias of the Dev Hub org.
702
+ -v, --target-dev-hub=<value> Username or alias of the Dev Hub org that owns the package .
698
703
699
704
Overrides the value of the target-dev-hub configuration variable, if set.
700
705
```
701
706
702
- _ See code: [ src/commands/package/push-upgrade/schedule.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.16 .0/src/commands/package/push-upgrade/schedule.ts ) _
707
+ _ See code: [ src/commands/package/push-upgrade/schedule.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.17 .0/src/commands/package/push-upgrade/schedule.ts ) _
703
708
704
709
## ` sf package uninstall `
705
710
@@ -747,7 +752,7 @@ EXAMPLES
747
752
$ sf package uninstall --package "Undesirable Package Alias"
748
753
```
749
754
750
- _ See code: [ src/commands/package/uninstall.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.16 .0/src/commands/package/uninstall.ts ) _
755
+ _ See code: [ src/commands/package/uninstall.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.17 .0/src/commands/package/uninstall.ts ) _
751
756
752
757
## ` sf package uninstall report `
753
758
@@ -780,7 +785,7 @@ EXAMPLES
780
785
$ sf package uninstall report --request-id 06y... --target-org [email protected]
781
786
```
782
787
783
- _ See code: [ src/commands/package/uninstall/report.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.16 .0/src/commands/package/uninstall/report.ts ) _
788
+ _ See code: [ src/commands/package/uninstall/report.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.17 .0/src/commands/package/uninstall/report.ts ) _
784
789
785
790
## ` sf package update `
786
791
@@ -835,7 +840,7 @@ FLAG DESCRIPTIONS
835
840
associated with your package.
836
841
```
837
842
838
- _ See code: [ src/commands/package/update.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.16 .0/src/commands/package/update.ts ) _
843
+ _ See code: [ src/commands/package/update.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.17 .0/src/commands/package/update.ts ) _
839
844
840
845
## ` sf package version create `
841
846
@@ -1010,7 +1015,7 @@ FLAG DESCRIPTIONS
1010
1015
periods of no output from commands.
1011
1016
```
1012
1017
1013
- _ See code: [ src/commands/package/version/create.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.16 .0/src/commands/package/version/create.ts ) _
1018
+ _ See code: [ src/commands/package/version/create.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.17 .0/src/commands/package/version/create.ts ) _
1014
1019
1015
1020
## ` sf package version create list `
1016
1021
@@ -1071,7 +1076,7 @@ EXAMPLES
1071
1076
$ sf package version create list --created-last-days 0 --status Success
1072
1077
```
1073
1078
1074
- _ See code: [ src/commands/package/version/create/list.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.16 .0/src/commands/package/version/create/list.ts ) _
1079
+ _ See code: [ src/commands/package/version/create/list.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.17 .0/src/commands/package/version/create/list.ts ) _
1075
1080
1076
1081
## ` sf package version create report `
1077
1082
@@ -1114,7 +1119,7 @@ EXAMPLES
1114
1119
$ sf package version create report --package-create-request-id 08c... --target-dev-hub [email protected]
1115
1120
```
1116
1121
1117
- _ See code: [ src/commands/package/version/create/report.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.16 .0/src/commands/package/version/create/report.ts ) _
1122
+ _ See code: [ src/commands/package/version/create/report.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.17 .0/src/commands/package/version/create/report.ts ) _
1118
1123
1119
1124
## ` sf package version delete `
1120
1125
@@ -1155,7 +1160,7 @@ EXAMPLES
1155
1160
$ sf package version delete --package 04t... --target-org [email protected]
1156
1161
```
1157
1162
1158
- _ See code: [ src/commands/package/version/delete.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.16 .0/src/commands/package/version/delete.ts ) _
1163
+ _ See code: [ src/commands/package/version/delete.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.17 .0/src/commands/package/version/delete.ts ) _
1159
1164
1160
1165
## ` sf package version displayancestry `
1161
1166
@@ -1215,7 +1220,7 @@ FLAG DESCRIPTIONS
1215
1220
You can use the DOT code output in graph visualization software to create tree visualizations.
1216
1221
```
1217
1222
1218
- _ See code: [ src/commands/package/version/displayancestry.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.16 .0/src/commands/package/version/displayancestry.ts ) _
1223
+ _ See code: [ src/commands/package/version/displayancestry.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.17 .0/src/commands/package/version/displayancestry.ts ) _
1219
1224
1220
1225
## ` sf package version list `
1221
1226
@@ -1291,7 +1296,7 @@ EXAMPLES
1291
1296
$ sf package version list --packages exp-mgr,exp-mgr-util --released --modified-last-days 0
1292
1297
```
1293
1298
1294
- _ See code: [ src/commands/package/version/list.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.16 .0/src/commands/package/version/list.ts ) _
1299
+ _ See code: [ src/commands/package/version/list.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.17 .0/src/commands/package/version/list.ts ) _
1295
1300
1296
1301
## ` sf package version promote `
1297
1302
@@ -1335,7 +1340,7 @@ EXAMPLES
1335
1340
$ sf package version promote --package "Awesome Package Alias"
1336
1341
```
1337
1342
1338
- _ See code: [ src/commands/package/version/promote.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.16 .0/src/commands/package/version/promote.ts ) _
1343
+ _ See code: [ src/commands/package/version/promote.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.17 .0/src/commands/package/version/promote.ts ) _
1339
1344
1340
1345
## ` sf package version report `
1341
1346
@@ -1375,7 +1380,46 @@ EXAMPLES
1375
1380
$ sf package version report --package "Your Package Alias" --target-dev-hub [email protected]
1376
1381
```
1377
1382
1378
- _ See code: [ src/commands/package/version/report.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.16.0/src/commands/package/version/report.ts ) _
1383
+ _ See code: [ src/commands/package/version/report.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.17.0/src/commands/package/version/report.ts ) _
1384
+
1385
+ ## ` sf package version retrieve `
1386
+
1387
+ Retrieve package metadata for a specified package version. Package metadata can be retrieved for converted second-generation managed package versions only.
1388
+
1389
+ ```
1390
+ USAGE
1391
+ $ sf package version retrieve -v <value> -p <value> [--json] [--flags-dir <value>] [--api-version <value>] [-d
1392
+ <value>]
1393
+
1394
+ FLAGS
1395
+ -d, --output-dir=<value> [default: force-app] Path within your Salesforce DX project directory in which to
1396
+ download the metadata. This directory must be empty.
1397
+ -p, --package=<value> (required) Subscriber package version ID (starts with 04t).
1398
+ -v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the `target-dev-hub`
1399
+ configuration variable is already set.
1400
+ --api-version=<value> Override the api version used for api requests made by this command
1401
+
1402
+ GLOBAL FLAGS
1403
+ --flags-dir=<value> Import flag values from a directory.
1404
+ --json Format output as json.
1405
+
1406
+ DESCRIPTION
1407
+ Retrieve package metadata for a specified package version. Package metadata can be retrieved for converted
1408
+ second-generation managed package versions only.
1409
+
1410
+ Retrieving a package version downloads the metadata into the directory you specify.
1411
+
1412
+ Specify the subscriber package version ID (starts with 04t) and the path to an empty directory when you run this
1413
+ command.
1414
+
1415
+ EXAMPLES
1416
+ Retrieve package metadata for a converted subscriber package version ID (starts with 04t) into my-folder/ within
1417
+ your Salesforce DX project directory:
1418
+
1419
+ $ sf package version retrieve --package 04t... --output-dir my-folder –-target-dev-hub my-devhub
1420
+ ```
1421
+
1422
+ _ See code: [ src/commands/package/version/retrieve.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.17.0/src/commands/package/version/retrieve.ts ) _
1379
1423
1380
1424
## ` sf package version update `
1381
1425
@@ -1428,7 +1472,7 @@ EXAMPLES
1428
1472
$ sf package version update --package 04t... --version-description "New Package Version Description"
1429
1473
```
1430
1474
1431
- _ See code: [ src/commands/package/version/update.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.16 .0/src/commands/package/version/update.ts ) _
1475
+ _ See code: [ src/commands/package/version/update.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.17 .0/src/commands/package/version/update.ts ) _
1432
1476
1433
1477
## ` sf package1 version create `
1434
1478
@@ -1495,7 +1539,7 @@ FLAG DESCRIPTIONS
1495
1539
subscribers.
1496
1540
```
1497
1541
1498
- _ See code: [ src/commands/package1/version/create.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.16 .0/src/commands/package1/version/create.ts ) _
1542
+ _ See code: [ src/commands/package1/version/create.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.17 .0/src/commands/package1/version/create.ts ) _
1499
1543
1500
1544
## ` sf package1 version create get `
1501
1545
@@ -1528,7 +1572,7 @@ EXAMPLES
1528
1572
$ sf package1 version create get --request-id 0HD... --target-org [email protected]
1529
1573
```
1530
1574
1531
- _ See code: [ src/commands/package1/version/create/get.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.16 .0/src/commands/package1/version/create/get.ts ) _
1575
+ _ See code: [ src/commands/package1/version/create/get.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.17 .0/src/commands/package1/version/create/get.ts ) _
1532
1576
1533
1577
## ` sf package1 version display `
1534
1578
@@ -1562,7 +1606,7 @@ EXAMPLES
1562
1606
$ sf package1 version display --package-version-id 04t... --target-org [email protected]
1563
1607
```
1564
1608
1565
- _ See code: [ src/commands/package1/version/display.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.16 .0/src/commands/package1/version/display.ts ) _
1609
+ _ See code: [ src/commands/package1/version/display.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.17 .0/src/commands/package1/version/display.ts ) _
1566
1610
1567
1611
## ` sf package1 version list `
1568
1612
@@ -1600,6 +1644,6 @@ FLAG DESCRIPTIONS
1600
1644
If not specified, shows all versions for all packages (managed and unmanaged) in the org.
1601
1645
```
1602
1646
1603
- _ See code: [ src/commands/package1/version/list.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.16 .0/src/commands/package1/version/list.ts ) _
1647
+ _ See code: [ src/commands/package1/version/list.ts] ( https://github.com/salesforcecli/plugin-packaging/blob/2.17 .0/src/commands/package1/version/list.ts ) _
1604
1648
1605
1649
<!-- commandsstop -->
0 commit comments