@salesforce/plugin-packaging 1.12.2 → 1.12.4

package/messages/package_install.md

@@ -1,97 +1,88 @@
-# cliDescription
+# summary
 
-install a package in the target org
+Install a version of a package in the target org.
 
-Supply the ID of the package version to install. The package installs in your default target org unless you supply the username for a different target org.
+# description
 
-For package upgrades, to specify options for component deprecation or deletion of removed components, include an --upgradetype value. To delete components that can be safely deleted and deprecate the others, specify --upgradetype Mixed (the default). To deprecate all removed components, specify --upgradetype DeprecateOnly. To delete all removed components, except for custom objects and custom fields, that don't have dependencies, specify --upgradetype Delete. (Note: This option can result in the loss of data that is associated with the deleted components.) The default is Mixed.
+To install a package, specify a specific version of the package using the 04t package ID. The package and the version you specified installs in your default target org unless you supply the username for a different target org.
+
+For package upgrades, to specify options for component deprecation or deletion of removed components, include an --upgrade-type value. To delete components that can be safely deleted and deprecate the others, specify --upgrade-type Mixed (the default). To deprecate all removed components, specify --upgrade-type DeprecateOnly. To delete all removed components, except for custom objects and custom fields, that don't have dependencies, specify --upgrade-type Delete. (Note: This option can result in the loss of data that is associated with the deleted components.) The default is Mixed.
 
 # examples
 
-$ sfdx force:package:install --package 04t... -u me@example.com
-$ sfdx force:package:install --package awesome_package_alias
-$ sfdx force:package:install --package "Awesome Package Alias"
-$ sfdx force:package:install --package 04t... -t DeprecateOnly
+- Install a package version with the specified ID in the org with username "me@example.com":
 
-# wait
+  <%= config.bin %> <%= command.id %> --package 04t... --target-org me@example.com
 
-number of minutes to wait for installation status
+- Install a package version with the specified alias into your default org:
 
-# waitLong
+  <%= config.bin %> <%= command.id %> --package awesome_package_alias
 
-Maximum number of minutes to wait for installation status. The default is 0.
+- Install a package version with an alias that includes spaces into your default org:
 
-# installationKey
+  <%= config.bin %> <%= command.id %> --package "Awesome Package Alias"
 
-installation key for key-protected package (default: null)
+- Install an unlocked package version with the specified ID and deprecate all removed components:
 
-# installationKeyLong
+  <%= config.bin %> <%= command.id %> --package 04t... --upgrade-type DeprecateOnly
 
-Installation key for installing a key-protected package. The default is null.
+# flags.wait.summary
 
-# noPrompt
+Number of minutes to wait for installation status.
 
-do not prompt for confirmation
+# flags.installation-key.summary
 
-# noPromptLong
+Installation key for key-protected package (default: null).
 
-Allows the following without an explicit confirmation response: 1) Remote Site Settings and Content Security Policy websites to send or receive data, and 2) --upgradetype Delete to proceed.
+# flags.no-prompt.summary
 
-# promptUpgradeType
+Don't prompt for confirmation.
 
-The Delete upgrade type permanently deletes metadata types that have been removed from the package. Deleted metadata can’t be recovered. We don't delete custom objects and custom fields. Instead, we deprecate them.
+# flags.no-prompt.description
 
-Do you want to continue? (y/n)
+Allows the following without an explicit confirmation response: 1) Remote Site Settings and Content Security Policy websites to send or receive data, and 2) --upgrade-type Delete to proceed.
 
-# promptUpgradeTypeDeny
+# prompt-upgrade-type
 
-We canceled this package installation per your request.
-
-# publishWait
+The Delete upgrade type permanently deletes metadata types that have been removed from the package. Deleted metadata can’t be recovered. We don't delete custom objects and custom fields. Instead, we deprecate them.
 
-number of minutes to wait for subscriber package version ID to become available in the target org
+Do you want to continue? (y/n)
 
-# publishWaitLong
+# flags.publish-wait.summary
 
-Maximum number of minutes to wait for the Subscriber Package Version ID to become available in the target org before canceling the install request. The default is 0.
+Maximum number of minutes to wait for the Subscriber Package Version ID to become available in the target org before canceling the install request.
 
-# packageInstallSuccess
+# package-install-success
 
 Successfully installed package [%s]
 
-# package
-
-ID (starts with 04t) or alias of the package version to install
-
-# packageLong
-
-The ID (starts with 04t) or alias of the package version to install.
+# flags.package.summary
 
-# securityType
+ID (starts with 04t) or alias of the package version to install.
 
-security access type for the installed package (deprecation notice: The default --securitytype value will change from AllUsers to AdminsOnly in v47.0 or later.)
+# flags.security-type.summary
 
-# securityTypeLong
+Security access type for the installed package. (deprecation notice: The default --security-type value will change from AllUsers to AdminsOnly in v47.0 or later.)
 
-Security access type for the installed package.
+# flags.upgrade-type.summary
 
-# upgradeType
+Upgrade type for the package installation; available only for unlocked packages.
 
-the upgrade type for the package installation; available only for unlocked packages
-
-# upgradeTypeLong
+# flags.upgrade-type.description
 
 For package upgrades, specifies whether to mark all removed components as deprecated (DeprecateOnly), to delete removed components that can be safely deleted and deprecate the others (Mixed), or to delete all removed components, except for custom objects and custom fields, that don't have dependencies (Delete). The default is Mixed. Can specify DeprecateOnly or Delete only for unlocked package upgrades.
 
-# apexCompile
+# flags.apex-compile.summary
 
-compile all Apex in the org and package, or only Apex in the package; unlocked packages only
+Compile all Apex in the org and package, or only Apex in the package; unlocked packages only.
 
-# apexCompileLong
+# flags.apex-compile.description
 
 Applies to unlocked packages only. Specifies whether to compile all Apex in the org and package, or only the Apex in the package.
+
 For package installs into production orgs, or any org that has Apex Compile on Deploy enabled, the platform compiles all Apex in the org after the package install or upgrade operation completes.
-This approach assures that package installs and upgrades don’t impact the performance of an org, and is done even if --apexcompile package is specified.
+
+This approach assures that package installs and upgrades don’t impact the performance of an org, and is done even if --apex-compile package is specified.
 
 # promptEnableRss
 
@@ -101,7 +92,7 @@ This package might send or receive data from these third-party websites:
 
 Grant access (y/n)?
 
-# promptUpgradeType
+# prompt-upgrade-type
 
 The Delete upgrade type permanently deletes metadata types that have been removed from the package. Deleted metadata can’t be recovered. We don't delete custom objects and custom fields. Instead, we deprecate them.
 
@@ -118,7 +109,7 @@ This command is supported only on API versions 36.0 and higher
 # packageInstallInProgress
 
 PackageInstallRequest is currently InProgress. You can continue to query the status using
-sfdx force:package:install:report -i %s -u %s
+%s package:install:report -i %s -o %s
 
 # packageInstallError
 

package/messages/package_install_report.md

@@ -1,16 +1,17 @@
-# cliDescription
+# summary
 
-retrieve the status of a package installation request
+Retrieve the status of a package installation request.
 
 # examples
 
-$ sfdx force:package:install:report -i 0Hf...
-$ sfdx force:package:install:report -i 0Hf... -u me@example.com
+- Retrieve the status of a package installation request with the specified ID on your default org:
 
-# requestId
+  <%= config.bin %> <%= command.id %> --request-id 0Hf...
 
-ID of the package install request you want to check
+- Similar to previous example, except use the org with username me@example.com:
 
-# requestIdLong
+  <%= config.bin %> <%= command.id %> --request-id 0Hf... --target-org me@example.com
 
-The ID of the package install request you want to check.
+# flags.request-id.summary
+
+ID of the package install request you want to check; starts with 0Hf.

package/messages/package_installed_list.md

@@ -1,8 +1,13 @@
-# cliDescription
+# summary
 
-list the org’s installed packages
+List the org’s installed packages.
 
 # examples
 
-$ sfdx force:package:installed:list
-$ sfdx force:package:installed:list -u me@example.com
+- List the installed packages in your default org:
+
+  <%= config.bin %> <%= command.id %>
+
+- List the installed packages in the org with username me@example.com:
+
+  <%= config.bin %> <%= command.id %> --target-org me@example.com

package/messages/package_list.md

@@ -1,13 +1,20 @@
-# cliDescription
+# summary
 
-list all packages in the Dev Hub org
+List all packages in the Dev Hub org.
+
+# description
 
 You can view the namespace, IDs, and other details for each package.
 
 # examples
 
-$ sfdx force:package:list -v devhub@example.com
-$ sfdx force:package:list -v devhub@example.com --verbose
+- List all packages in the specified Dev Hub org:
+
+  <%= config.bin %> <%= command.id %> --target-hub-org devhub@example.com
+
+- List all packages details in the specified Dev Hub org, and show extended details about each package:
+
+  <%= config.bin %> <%= command.id %> --target-hub-org devhub@example.com --verbose
 
 # namespace
 
@@ -21,7 +28,7 @@ Name
 
 Id
 
-# packageId
+# package-id
 
 Subscriber Package Id
 
@@ -33,17 +40,13 @@ Alias
 
 Description
 
-# packageType
+# package-type
 
 Type
 
-# verboseDescription
-
-display extended package detail
-
-# verboseLongDescription
+# flags.verbose.summary
 
-Displays extended package details.
+Display extended package detail.
 
 # convertedFromPackageId
 
@@ -53,7 +56,7 @@ Converted From Package Id
 
 Org-Dependent Unlocked Package
 
-# errorNotificationUsername
+# error-notification-username
 
 Error Notification Username
 

package/messages/package_uninstall.md

@@ -1,39 +1,41 @@
-# cliDescription
+# summary
 
-uninstall a second-generation package from the target org
+Uninstall a second-generation package from the target org.
+
+# description
 
 Specify the package ID for a second-generation package.
 
-To list the org’s installed packages, run "sfdx force:package:installed:list".
+To list the org’s installed packages, run "<%= config.bin %> package installed list".
 
 To uninstall a first-generation package, from Setup, enter Installed Packages in the Quick Find box, then select Installed Packages.
 
 # examples
 
-$ sfdx force:package:uninstall -p 04t... -u me@example.com
-$ sfdx force:package:uninstall -p undesirable_package_alias
-$ sfdx force:package:uninstall -p "Undesirable Package Alias"
+- Uninstall a package with specified ID from an org with username me@example.com:
+
+  <%= config.bin %> <%= command.id %> --package 04t... --target-org me@example.com
 
-# wait
+- Uninstall a package with the specified alias from your default org:
 
-number of minutes to wait for uninstall status
+  <%= config.bin %> <%= command.id %> --package undesirable_package_alias
 
-# waitLong
+- Uninstall a package with an alias that contains spaces from your default org:
 
-Maximum number of minutes to wait for uninstall status. The default is 0.
+  <%= config.bin %> <%= command.id %> --package "Undesirable Package Alias"
 
-# package
+# flags.wait.summary
 
-ID (starts with 04t) or alias of the package version to uninstall
+Number of minutes to wait for uninstall status.
 
-# packageLong
+# flags.package.summary
 
-The ID (starts with 04t) or alias of the package version to uninstall.
+ID (starts with 04t) or alias of the package version to uninstall.
 
 # InProgress
 
 PackageUninstallRequest is currently InProgress.
-You can continue to query the status using sfdx force:package:uninstall:report -i %s -u %s
+You can continue to query the status using %s package uninstall report -i %s -o %s
 
 # Success
 

package/messages/package_uninstall_report.md

@@ -1,24 +1,25 @@
-# cliDescription
+# summary
 
-retrieve status of package uninstall request
+Retrieve the status of a package uninstall request.
 
 # examples
 
-$ sfdx force:package:uninstall:report -i 06y...
-$ sfdx force:package:uninstall:report -i 06y... -u me@example.com
+- Retrieve the status of a package uninstall in your default org using the specified request ID:
 
-# requestId
+  <%= config.bin %> <%= command.id %> --request-id 06y...
 
-ID of the package uninstall request you want to check
+- Similar to previous example, but use the org with username me@example.com:
 
-# requestIdLong
+  <%= config.bin %> <%= command.id %> --request-id 06y... --target-org me@example.com
 
-The ID of the package uninstall request you want to check.
+# flags.request-id.summary
+
+ID of the package uninstall request you want to check; starts with 06y.
 
 # InProgress
 
 PackageUninstallRequest is currently InProgress. You can continue to query the status using
-sfdx force:package:uninstall:report -i %s -u %s
+%s package:uninstall:report -i %s -o %s
 
 # Unknown
 
@@ -28,6 +29,6 @@ TODO: fix me
 
 Successfully uninstalled package [%s]
 
-# packageIdInvalid
+# package-id-invalid
 
 Verify that you entered a valid package uninstall request ID (starts with 06y) and try again.

package/messages/package_update.md

@@ -1,37 +1,32 @@
-# cliDescription
+# summary
 
-update package details
+Update package details.
+
+# description
 
 Specify a new value for each option you want to update.
 
-Run "sfdx force:package:list" to list all packages in the Dev Hub org.
+Run "<%= config.bin %> package list" to list all packages in the Dev Hub org.
 
 # examples
 
-$ sfdx force:package:update -p "Your Package Alias" -n "New Package Name"
-$ sfdx force:package:update -p 0Ho... -d "New Package Description"
-
-# package
+- Update the name of the package with the specified alias; uses your default Dev Hub org:
 
-ID (starts with 0Ho) or alias of the package to update
+  <%= config.bin %> <%= command.id %> --package "Your Package Alias" --name "New Package Name"
 
-# packageLong
+- Update the description of the package with the specified ID; uses the specified Dev Hub org:
 
-The ID (starts with 0Ho) or alias of the package to update.
+  <%= config.bin %> <%= command.id %> --package 0Ho... --description "New Package Description" --target-hub-org devhub@example.com
 
-# name
+# flags.package.summary
 
-new package name
+ID (starts with 0Ho) or alias of the package to update.
 
-# nameLong
+# flags.name.summary
 
 New name of the package.
 
-# description
-
-new package description
-
-# descriptionLong
+# flags.description.summary
 
 New description of the package.