@salesforce/plugin-packaging 1.12.2 → 1.12.4

package/messages/package1_version_create.md

@@ -1,79 +1,68 @@
-# cliDescription
+# summary
 
-create a first-generation package version in the release org
-The package version is based on the contents of the specified metadata package. Omit -m if you want to create an unmanaged package version.
+Create a first-generation package version in the release org.
 
-# id
+# description
 
-ID of the metadata package (starts with 033) of which you’re creating a new version
+The package version is based on the contents of the specified metadata package. Omit --managed-released if you want to create an unmanaged package version.
 
-# idLong
+# examples
 
-ID of the metadata package (starts with 033) of which you’re creating a new version.
+- Create a first-generation package version from the package with the specified ID and name the package version "example"; use your default org:
 
-# name
+  <%= config.bin %> <%= command.id %> --package-id 033... --name example
 
-package version name
+- Same as previous example, but provide a description and wait for 30 minutes for the package version to be created; use the specified org:
 
-# nameLong
+  <%= config.bin %> <%= command.id %> --package-id 033... --name example --description "example description" --wait 30 --target-org myorg@example.com
 
-Package version name.
+# flags.package-id.summary
 
-# description
-
-package version description
+ID of the metadata package (starts with 033) of which you’re creating a new version.
 
-# descriptionLong
+# flags.name.summary
 
-Package version description.
+Package version name.
 
-# version
+# flags.description.summary
 
-package version in major.minor format, for example, 3.2
+Package version description.
 
-# versionLong
+# flags.version.summary
 
 Package version in major.minor format, for example, 3.2.
 
-# releaseNotes
-
-release notes URL
-
-# releaseNotesLong
-
-The release notes URL. This link is displayed in the package installation UI to provide release notes for this package version to subscribers.
-
-# postInstall
+# flags.release-notes-url.summary
 
-post install URL
+Release notes URL.
 
-# postInstallLong
+# flags.release-notes-url.description
 
-The post-install instructions URL. The contents of the post-installation instructions URL are displayed in the UI after installation of the package version.
+This link is displayed in the package installation UI to provide release notes for this package version to subscribers.
 
-# managedReleased
+# flags.post-install-url.summary
 
-create a managed package version
+Post install URL.
 
-# managedReleasedLong
+# flags.post-install-url.description
 
-Creates a managed package version. To create a beta version, don’t include this parameter.
+The contents of the post-installation instructions URL are displayed in the UI after installation of the package version.
 
-# installationKey
+# flags.managed-release.summary
 
-installation key for key-protected package (default: null)
+Create a managed package version.
 
-# installationKeyLong
+# flags.managed-release.description
 
-Installation key for creating the key-protected package. The default is null.
+To create a beta version, don’t include this parameter.
 
-# wait
+# flags.installation-key.summary
 
-minutes to wait for the package version to be created (default: 2 minutes)
+Installation key for key-protected package (default: null).
 
-# waitLong
+# flags.wait.summary
 
-Minutes to wait for the package version to be created. The default is 2 minutes.
+Minutes to wait for the package version to be created (default: 2 minutes).
 
 # uploadFailure
 
@@ -90,4 +79,4 @@ Successfully uploaded package [%s]
 # QUEUED
 
 PackageUploadRequest has been enqueued. You can query the status using
-sfdx force:package1:version:create:get -i %s -u %s
+%s package1:version:create:get -i %s -o %s

package/messages/package1_version_create_get.md

@@ -1,24 +1,25 @@
-# cliDescription
+# summary
 
-retrieve the status of a package version creation request
+Retrieve the status of a package version creation request.
 
 # examples
 
-$ sfdx force:package1:version:create:get -i 0HD...
-$ sfdx force:package1:version:create:get -i 0HD... -u devhub@example.com
+- Get the status of the creation request for the package version with the specified ID in your default org:
 
-# requestId
+  <%= config.bin %> <%= command.id %> --request-id 0HD...
 
-PackageUploadRequest ID
+- Same as previous example, but use the specified org:
 
-# requestIdLong
+  <%= config.bin %> <%= command.id %> --request-id 0HD... --target-org myorg@example.com
 
-The ID of the PackageUploadRequest.
+# flags.request-id.summary
+
+ID of the PackageUploadRequest (starts with 0HD).
 
 # IN_PROGRESS
 
 PackageUploadRequest is still InProgress. You can query the status using
-sfdx force:package1:version:create:get -i %s -u %s
+%s package1:version:create:get -i %s -o %s
 
 # SUCCESS
 
@@ -27,7 +28,7 @@ Successfully uploaded package [%s]
 # QUEUED
 
 PackageUploadRequest has been enqueued. You can query the status using
-sfdx force:package1:version:create:get -i %s -u %s
+%s package1:version:create:get -i %s -o %s
 
 # uploadFailure
 

package/messages/package1_version_display.md

@@ -1,15 +1,17 @@
-# description
+# summary
 
-display details about a first-generation package version
+Display details about a first-generation package version.
 
-# packageId
+# flags.package-version-id.summary
 
-metadata package version ID (starts with 04t)
+ID (starts with 04t) of the metadata package version whose details you want to display.
 
-# packageIdLong
+# examples
 
-ID (starts with 04t) of the metadata package version whose details you want to display.
+- Display details about the first-generation package version with the specified ID in your default org:
+
+  <%= config.bin %> <%= command.id %> --package-version-id 04t...
 
-# packageIdInvalid
+- Same as previous example, but use the specified org:
 
-Verify that you entered a valid package version ID (starts with 04t) and try again.
+  <%= config.bin %> <%= command.id %> --package-version-id 04t... --target-org myorg@example.com

package/messages/package1_version_list.md

@@ -1,15 +1,21 @@
-# cliDescription
+# summary
 
-list package versions for the specified first-generation package or for the org
+List package versions for the specified first-generation package or for the org.
 
-# packageId
+# flags.package-id.summary
 
-metadata package ID (starts with 033)
+Metadata package ID (starts with 033) whose package versions you want to list.
 
-# packageIdLong
+# flags.package-id.description
 
-Metadata package ID (starts with 033) whose package versions you want to list. If not specified, shows all versions for all packages (managed and unmanaged) in the org.
+If not specified, shows all versions for all packages (managed and unmanaged) in the org.
 
-# packageIdInvalid
+# examples
 
-Verify that you entered a valid package version ID (starts with 033) and try again.
+- List all first-generation package versions in your default org:
+
+  <%= config.bin %> <%= command.id %>
+
+- List package versions for the specified first-generation package in the specifief org:
+
+  <%= config.bin %> <%= command.id %> --package-id 033... --target-org myorg@example.com

package/messages/package_convert.md

@@ -1,6 +1,8 @@
-# cliDescription
+# summary
 
-creates a second-generation package version from a first-generation package
+Create a second-generation package version from a first-generation package.
+
+# description
 
 The package convert creates a new package in the Dev Hub if one does not already exist for the specified first-generation package.
 
@@ -8,60 +10,58 @@ It then creates a new package version in the Dev Hub with contents based on the
 
 The latest released non-patch package version from the specified first-generation package will be converted.
 
-To retrieve details about a package version create request, including status and package version ID (04t), run "sfdx force:package:version:create:report -i 08c...".
+To retrieve details about a package version create request, including status and package version ID (04t), run "<%= config.bin %> package version create report -i 08c...".
 
-We recommend specifying the --installationkey to protect the contents of your package and to prevent unauthorized installation of your package.
+We recommend specifying the --installation-key to protect the contents of your package and to prevent unauthorized installation of your package.
 
-To list package version creation requests in the org, run "sfdx force:package:version:create:list".
+To list package version creation requests in the org, run "<%= config.bin %> package version create list".
 
 # examples
 
-$ sfdx force:package:convert --package 033xx0000004Gmn -k password123
-
-# package
+- Create a second-generation package version from the first-generation package with the specified ID and give it the installation key "password123"; uses your default Dev Hub org:
 
-ID (starts with 033) of the first-generation package to convert
+  <%= config.bin %> <%= command.id %> --package 033... --installation-key password123
 
-# longPackage
+- Similar to previous example, but uses the specified Dev Hub org:
 
-The ID (starts with 033) or alias of the package to convert.
+  <%= config.bin %> <%= command.id %> --package 033... --installation-key password123 --target-hub-org devhuborg@example.com
 
-# key
+# flags.package.summary
 
-installation key for key-protected package (either --installationkey or --installationkeybypass is required)
+ID (starts with 033) of the first-generation package to convert.
 
-# longKey
+# flags.installation-key.summary
 
-Installation key for creating the key-protected package. Either an --installationkey value or the --installationkeybypass flag is required.
+Installation key for key-protected package.
 
-# keyBypass
+# flags.installation-key.description
 
-bypass the installation key requirement (either --installationkey or --installationkeybypass is required)
+Either an --installation-key value or the --installation-key-bypass flag is required.
 
-# longKeyBypass
+# flags.installation-key-bypass.summary
 
-Bypasses the installation key requirement. If you bypass this requirement, anyone can install your package. Either an --installationkey value or the --installationkeybypass flag is required.
+Bypass the installation key requirement.
 
-# definitionfile
+# flags.installation-key-bypass.description
 
-path to a definition file that contains features and org preferences that the metadata of the package version depends on.
+If you bypass this requirement, anyone can install your package. Either an --installation-key value or the --installation-key-bypass flag is required.
 
-# longDefinitionfile
+# flags.definition-file.summary
 
-The path to a definition file, similar to the scratch org definition file, that contains the list of features and org preferences that the metadata of the package version depends on.
+Path to a definition file that contains features and org preferences that the metadata of the package version depends on.
 
-# wait
+# flags.definition-file.description
 
-minutes to wait for the package version to be created
+This definition file is similar to the scratch org definition file.
 
-# longWait
+# flags.wait.summary
 
-The number of minutes to wait for the package version to be created.
+Minutes to wait for the package version to be created.
 
-# instance
+# flags.build-instance.summary
 
-the instance where the conversion package version will be created——for example, NA50
+Instance where the conversion package version will be created, such as NA50.
 
-# longInstance
+# in-progress
 
-The instance where the conversion package version will be created——for example, NA50.
+Request in progress. Will wait a total of %s more seconds before timing out. Current Status='%s'

package/messages/package_create.md

@@ -1,76 +1,67 @@
-# cliDescription
+# summary
 
-create a package
+Create a package.
+
+# description
 
 First, use this command to create a package. Then create a package version.
 
-If you don’t have a namespace defined in your sfdx-project.json file, use --nonamespace.
+If you don’t have a namespace defined in your sfdx-project.json file, use --no-namespace.
 
 Your --name value must be unique within your namespace.
 
-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:create -n YourPackageName -t Unlocked -r force-app
-$ sfdx force:package:create -n YourPackageName -d "Your Package Descripton" -t Unlocked -r force-app
+- Create an unlocked package from the files in the "force-app" directory; uses your default Dev Hub org:
 
-# name
+  <%= config.bin %> <%= command.id %> --name MyUnlockedPackage --package-type Unlocked --path force-app
 
-package name
+- Create a managed packaged from the "force-app" directory files, give the package a description, and use the specified Dev Hub org:
 
-# nameLong
-
-Name of the package to create.
+  <%= config.bin %> <%= command.id %> --name MyManagedPackage --description "Your Package Descripton" --package-type Managed --path force-app --target-hub-org devhub@example.com
 
-# orgDependent
+# flags.name.summary
 
-depends on unpackaged metadata in the installation org. Applies to unlocked packages only.
+Name of the package to create.
 
-# orgDependentLong
+# flags.org-dependent.summary
 
-Package depends on unpackaged metadata in the installation org. Applies to unlocked packages only.
-Use Source Tracking in Sandboxes to develop your org-dependent unlocked package.
-For more information, see "Create Org-Dependent Unlocked Packages" in the Salesforce DX Developer Guide.
+Depends on unpackaged metadata in the installation org; applies to unlocked packages only.
 
-# errorNotificationUsername
+# flags.org-dependent.description
 
-active Dev Hub user designated to receive email notifications for package errors
+Use Source Tracking in Sandboxes to develop your org-dependent unlocked package. For more information, see "Create Org-Dependent Unlocked Packages" in the Salesforce DX Developer Guide.
 
-# errorNotificationUsernameLong
+# flags.error-notification-username.summary
 
-An active Dev Hub org user designated to receive email notifications for unhandled Apex exceptions, and install, upgrade, or uninstall failures associated with your package.
+Active Dev Hub user designated to receive email notifications for package errors.
 
-# description
+# flags.error-notification-username.description
 
-package description
+Email notifications include information about unhandled Apex exceptions, and install, upgrade, or uninstall failures associated with your package.
 
-# descriptionLong
+# flags.description.summary
 
 Description of the package.
 
-# noNamespace
-
-creates the package with no namespace; available only for unlocked packages.
-
-# noNamespaceLong
+# flags.no-namespace.summary
 
-Creates the package with no namespace. Available only for unlocked packages. Useful when you’re migrating an existing org to packages. But, use a namespaced package for new metadata.
+Create the package with no namespace; available only for unlocked packages.
 
-# packageType
+# flags.no-namespace.description
 
-package type
+This flag is useful when you’re migrating an existing org to packages. But use a namespaced package for new metadata.
 
-# packageTypeLong
+# flags.package-type.summary
 
-Package type for the package.
-The options for package type are Managed and Unlocked (Managed=DeveloperManagedSubscriberManaged, Unlocked=DeveloperControlledSubscriberEditable).
-These options determine upgrade and editability rules.
+Type of package.
 
-# path
+# flags.package-type.description
 
-path to directory that contains the contents of the package
+The options for package type are Managed and Unlocked (Managed=DeveloperManagedSubscriberManaged, Unlocked=DeveloperControlledSubscriberEditable). These options determine upgrade and editability rules.
 
-# longPath
+# flags.path.summary
 
-The path to the directory that contains the contents of the package.
+Path to directory that contains the contents of the package.

package/messages/package_delete.md

@@ -1,6 +1,8 @@
-# cliDescription
+# summary
 
-delete a package
+Delete a package.
+
+# description
 
 Specify the ID or alias of the package you want to delete.
 
@@ -8,46 +10,39 @@ Delete unlocked and second-generation managed packages. Before you delete a pack
 
 # examples
 
-$ sfdx force:package:delete -p "Your Package Alias"
-$ sfdx force:package:delete -p 0Ho...
-
-# package
+- Delete a package using its alias from your default Dev Hub org:
 
-ID (starts with 0Ho) or alias of the package to delete
+  <%= config.bin %> <%= command.id %> --package "Your Package Alias"
 
-# packageLong
+- Delete a package using its ID from the specified Dev Hub org:
 
-The ID (starts with 0Ho) or alias of the package to delete.
+  <%= config.bin %> <%= command.id %> --package 0Ho... --target-hub-org devhub@example.com
 
-# undelete
+# flags.package.summary
 
-undelete a deleted package
+ID (starts with 0Ho) or alias of the package to delete.
 
-# undeleteLong
+# flags.undelete.summary
 
 Undelete a deleted package.
 
-# noPrompt
-
-don’t prompt before deleting the package
-
-# noPromptLong
+# flags.no-prompt.summary
 
 Don’t prompt before deleting the package.
 
-# promptDelete
+# prompt-delete
 
 Deleted packages can’t be recovered.
 
 Do you want to continue? (y/n)
 
-# promptUndelete
+# prompt-undelete
 
 This will undelete the package, which may result in unintended consequences for customers. Proceed with caution.
 
 Do you want to continue? (y/n)
 
-# promptDeleteDeny
+# prompt-delete-deny
 
 The request to delete this package was canceled
 

package/messages/package_displayancestry.md

@@ -1,35 +1,41 @@
-# cliDescription
+# summary
 
-display the ancestry tree for a 2GP managed package version
+Display the ancestry tree for a 2GP managed package version.
 
 # examples
 
-$ sfdx force:package:version:displayancestry -p package_version_alias
-$ sfdx force:package:version:displayancestry -p package_version_alias --dotcode
-$ sfdx force:package:version:displayancestry -p OHo...
-$ sfdx force:package:version:displayancestry -p 04t...
+- Display the ancestry tree for a package version with the specified alias, using your default Dev Hub org:
 
-# package
+  <%= config.bin %> <%= command.id %> --package package_version_alias
 
-ID or alias of the package (starts with 0Ho) or package version (starts with 04t) to display ancestry for
+- Similar to previous example, but display the output in DOT code:
 
-# packageLong
+  <%= config.bin %> <%= command.id %> --package package_version_alias --dot-code
 
-The ID or alias of the package or package version to display ancestry for. If you specify a package ID (starts with 0Ho) or alias, the ancestor tree for every package version associated with the package ID is displayed.
-If you specify a package version (starts with 04t) or alias, the ancestry tree of the specified package version is displayed.
+- Display the ancestry tree for a package with the specified ID, using the Dev Hub org with username devhub@example.com:
 
-# dotcode
+  <%= config.bin %> <%= command.id %> --package OHo... --target-hub-org devhub@example.com
 
-display the ancestry tree in DOT code
+- Display the ancestry tree of a package version with the specified ID, using your default Dev Hub org:
 
-# dotcodeLong
+  <%= config.bin %> <%= command.id %> --package 04t...
 
-Displays the ancestry tree in DOT code. You can use the DOT code output in graph visualization software to create tree visualizations.
+# flags.package.summary
 
-# verbose
+ID or alias of the package (starts with 0Ho) or package version (starts with 04t) to display ancestry for.
 
-display both the package version ID (starts with 04t) and the version number (major.minor.patch.build) in the ancestry tree
+# flags.package.description
 
-# verboseLong
+If you specify a package ID (starts with 0Ho) or alias, the ancestor tree for every package version associated with the package ID is displayed. If you specify a package version (starts with 04t) or alias, the ancestry tree of the specified package version is displayed.
 
-Displays both the package version ID (starts with 04t) and the version number (major.minor.patch.build) in the ancestry tree.
+# flags.dot-code.summary
+
+Display the ancestry tree in DOT code.
+
+# flags.dot-code.description
+
+You can use the DOT code output in graph visualization software to create tree visualizations.
+
+# flags.verbose.summary
+
+Display both the package version ID (starts with 04t) and the version number (major.minor.patch.build) in the ancestry tree.