@@ -52,6 +52,7 @@ See [DEVELOPING.md](DEVELOPING.md)
5252- [ ` sf package version list ` ] ( #sf-package-version-list )
5353- [ ` sf package version promote ` ] ( #sf-package-version-promote )
5454- [ ` sf package version report ` ] ( #sf-package-version-report )
55+ - [ ` sf package version retrieve ` ] ( #sf-package-version-retrieve )
5556- [ ` sf package version update ` ] ( #sf-package-version-update )
5657- [ ` sf package1 version create ` ] ( #sf-package1-version-create )
5758- [ ` sf package1 version create get ` ] ( #sf-package1-version-create-get )
@@ -153,7 +154,7 @@ FLAG DESCRIPTIONS
153154 --installation-key-bypass flag is required.
154155```
155156
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 ) _
157158
158159## ` sf package create `
159160
@@ -232,7 +233,7 @@ FLAG DESCRIPTIONS
232233 Org-Dependent Unlocked Packages" in the Salesforce DX Developer Guide.
233234```
234235
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 ) _
236237
237238## ` sf package delete `
238239
@@ -274,7 +275,7 @@ EXAMPLES
274275 $ sf package delete --package 0Ho... --target-dev-hub devhub@example.com
275276```
276277
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 ) _
278279
279280## ` sf package install `
280281
@@ -373,7 +374,7 @@ FLAG DESCRIPTIONS
373374 - Delete: Delete all removed components that can be safely deleted, and deprecate the other components.
374375```
375376
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 ) _
377378
378379## ` sf package install report `
379380
@@ -406,7 +407,7 @@ EXAMPLES
406407 $ sf package install report --request-id 0Hf... --target-org me@example.com
407408```
408409
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 ) _
410411
411412## ` sf package installed list `
412413
@@ -438,7 +439,7 @@ EXAMPLES
438439 $ sf package installed list --target-org me@example.com
439440```
440441
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 ) _
442443
443444## ` sf package list `
444445
@@ -476,7 +477,7 @@ EXAMPLES
476477 $ sf package list --target-dev-hub devhub@example.com --verbose
477478```
478479
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 ) _
480481
481482## ` sf package push-upgrade abort `
482483
@@ -501,8 +502,7 @@ DESCRIPTION
501502 Abort a package push upgrade that has been scheduled. Only push upgrade requests with a status of Created or Pending
502503 can be aborted.
503504
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.
506506
507507 To show all requests in the org, run "sf package pushupgrade list --package 033...".
508508
@@ -516,7 +516,7 @@ EXAMPLES
516516 $ sf package push-upgrade abort --push-request-id 0DV... --target-dev-hub devhub@example.com
517517```
518518
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 ) _
520520
521521## ` sf package push-upgrade list `
522522
@@ -575,7 +575,7 @@ EXAMPLES
575575 $ sf package push-upgrade list --package 033xyz –-status Failed
576576```
577577
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 ) _
579579
580580## ` sf package push-upgrade report `
581581
@@ -617,7 +617,7 @@ EXAMPLES
617617 $ sf package push-upgrade report --push-request-id 0DV... --target-dev-hub devhub@example.com
618618```
619619
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 ) _
621621
622622## ` sf package push-upgrade schedule `
623623
@@ -629,13 +629,15 @@ USAGE
629629 <value> | -f <value>] [--migrate-to-2gp]
630630
631631FLAGS
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.
634636 -p, --package=<value> (required) ID (starts with 04t) of the package version that the package is being
635637 upgraded to. The package version must be an active, non-beta package version.
636638 -t, --start-time=<value> Date and time (UTC) when the push upgrade is processed. Set to the earliest time that
637639 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 .
639641 --api-version=<value> Override the api version used for api requests made by this command
640642 --migrate-to-2gp Upgrade from a first-generation managed package (1GP) to a second-generation managed
641643 package (2GP). Required when you’re pushing a 2GP package to orgs with the 1GP version
@@ -663,23 +665,26 @@ EXAMPLES
663665 Schedule a push upgrade that initiates at a specified time:
664666
665667 $ 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
667669
668670 Schedule a push upgrade that initiates as soon as possible:
669671
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
671673
672674 Schedule a push migration from a 1GP package to a 2GP package:
673675
674676 $ sf package push-upgrade schedule --migrate-to-2gp --package 04txyz --start-time "2024-12-06T21:00:00" \
675677 --org-file upgrade-orgs.csv --target-dev-hub myHub
676678
677679FLAG 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.
679684
680685 The file must contain one org per line. The org ID must be the only value in each row.
681686 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.
683688
684689 -t, --start-time=<value>
685690
@@ -694,12 +699,12 @@ FLAG DESCRIPTIONS
694699 If you don't specify this flag, the push upgrade is scheduled to run as soon as resources are available on the
695700 Salesforce instance.
696701
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 .
698703
699704 Overrides the value of the target-dev-hub configuration variable, if set.
700705```
701706
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 ) _
703708
704709## ` sf package uninstall `
705710
@@ -747,7 +752,7 @@ EXAMPLES
747752 $ sf package uninstall --package "Undesirable Package Alias"
748753```
749754
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 ) _
751756
752757## ` sf package uninstall report `
753758
@@ -780,7 +785,7 @@ EXAMPLES
780785 $ sf package uninstall report --request-id 06y... --target-org me@example.com
781786```
782787
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 ) _
784789
785790## ` sf package update `
786791
@@ -835,7 +840,7 @@ FLAG DESCRIPTIONS
835840 associated with your package.
836841```
837842
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 ) _
839844
840845## ` sf package version create `
841846
@@ -1010,7 +1015,7 @@ FLAG DESCRIPTIONS
10101015 periods of no output from commands.
10111016```
10121017
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 ) _
10141019
10151020## ` sf package version create list `
10161021
@@ -1071,7 +1076,7 @@ EXAMPLES
10711076 $ sf package version create list --created-last-days 0 --status Success
10721077```
10731078
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 ) _
10751080
10761081## ` sf package version create report `
10771082
@@ -1114,7 +1119,7 @@ EXAMPLES
11141119 $ sf package version create report --package-create-request-id 08c... --target-dev-hub devhub@example.com
11151120```
11161121
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 ) _
11181123
11191124## ` sf package version delete `
11201125
@@ -1155,7 +1160,7 @@ EXAMPLES
11551160 $ sf package version delete --package 04t... --target-org devhub@example.com
11561161```
11571162
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 ) _
11591164
11601165## ` sf package version displayancestry `
11611166
@@ -1215,7 +1220,7 @@ FLAG DESCRIPTIONS
12151220 You can use the DOT code output in graph visualization software to create tree visualizations.
12161221```
12171222
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 ) _
12191224
12201225## ` sf package version list `
12211226
@@ -1291,7 +1296,7 @@ EXAMPLES
12911296 $ sf package version list --packages exp-mgr,exp-mgr-util --released --modified-last-days 0
12921297```
12931298
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 ) _
12951300
12961301## ` sf package version promote `
12971302
@@ -1335,7 +1340,7 @@ EXAMPLES
13351340 $ sf package version promote --package "Awesome Package Alias"
13361341```
13371342
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 ) _
13391344
13401345## ` sf package version report `
13411346
@@ -1375,7 +1380,46 @@ EXAMPLES
13751380 $ sf package version report --package "Your Package Alias" --target-dev-hub devhub@example.com
13761381```
13771382
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 ) _
13791423
13801424## ` sf package version update `
13811425
@@ -1428,7 +1472,7 @@ EXAMPLES
14281472 $ sf package version update --package 04t... --version-description "New Package Version Description"
14291473```
14301474
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 ) _
14321476
14331477## ` sf package1 version create `
14341478
@@ -1495,7 +1539,7 @@ FLAG DESCRIPTIONS
14951539 subscribers.
14961540```
14971541
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 ) _
14991543
15001544## ` sf package1 version create get `
15011545
@@ -1528,7 +1572,7 @@ EXAMPLES
15281572 $ sf package1 version create get --request-id 0HD... --target-org myorg@example.com
15291573```
15301574
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 ) _
15321576
15331577## ` sf package1 version display `
15341578
@@ -1562,7 +1606,7 @@ EXAMPLES
15621606 $ sf package1 version display --package-version-id 04t... --target-org myorg@example.com
15631607```
15641608
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 ) _
15661610
15671611## ` sf package1 version list `
15681612
@@ -1600,6 +1644,6 @@ FLAG DESCRIPTIONS
16001644 If not specified, shows all versions for all packages (managed and unmanaged) in the org.
16011645```
16021646
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 ) _
16041648
16051649<!-- commandsstop -->
0 commit comments