Update package details.
Description for package update
Specify a new value for each option you want to update.
Run "sf package list" to list all packages in the Dev Hub org.
Aliases for package update
force:package:update
Flags
| Flag Name (Long) | Flag Name (Short) | Description |
|---|---|---|
| <code>‑‑api‑version</code> | N/A | Type: Value<br><br>Override the api version used for api requests made by this command |
| <code>‑‑description</code> | <code>‑d</code> | Type: Value<br><br>New description of the package. |
| <code>‑‑enable‑app‑analytics</code> | N/A | Type: Boolean<br><br>Enable AppExchange App Analytics usage data collection on this managed package and its components. |
| <code>‑‑error‑notification‑username</code> | <code>‑o</code> | Type: Value<br><br>Active Dev Hub user designated to receive email notifications for package errors.<br><br>Email notifications include information about unhandled Apex exceptions, and install, upgrade, or uninstall failures associated with your package. |
| <code>‑‑flags‑dir</code> | N/A | Type: Value<br><br>Import flag values from a directory. |
| <code>‑‑json</code> | N/A | Type: Boolean<br><br>Format output as json. |
| <code>‑‑name</code> | <code>‑n</code> | Type: Value<br><br>New name of the package. |
| <code>‑‑package</code> | <code>‑p</code> | Type: Value<br>Required<br><br>ID (starts with 0Ho) or alias of the package to update. |
| <code>‑‑recommended‑version‑id</code> | <code>‑r</code> | Type: Value<br><br>ID of the package version that's installed when subscribers click the Upgrade to Recommended Version option on the Installed Packages page of their org.<br><br>Specify the recommended package version for subscribers to install. If a subscriber has a package version installed in their org that's lower than the version you set, the subscriber sees the Upgrade to Recommended Version option on the Installed Packages page. Only released package versions can be set as the recommended version. |
| <code>‑‑skip‑ancestor‑check</code> | N/A | Type: Boolean<br><br>Bypass the ancestry check for setting a recommended version. |
| <code>‑‑target‑dev‑hub</code> | <code>‑v</code> | Type: Value<br>Required<br><br>Username or alias of the Dev Hub org. Not required if the target-dev-hub configuration variable is already set. |
Examples for package update
Update the name of the package with the specified alias; uses your default Dev Hub org:
sf package update --package "Your Package Alias" --name "New Package Name"
Update the description of the package with the specified ID; uses the specified Dev Hub org:
sf package update --package 0Ho... --description "New Package Description" --target-dev-hub devhub@example.com
<!-- prettier-ignore-end -->