Skip to content

Commit 38b7dd4

Browse files
Merge pull request #1061 from salesforcecli/jn-edit-package-version-retrieve-message
W-19842308: Update package_version_retrieve.md
2 parents 29d2505 + e4a377e commit 38b7dd4

1 file changed

Lines changed: 14 additions & 4 deletions

File tree

messages/package_version_retrieve.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
11
# summary
22

3-
Retrieve package metadata for a specified package version. Package metadata can be retrieved for converted second-generation managed package versions only.
3+
Retrieve package metadata for a specified package version. Package metadata can be retrieved for second-generation managed package versions or unlocked packages only.
44

55
# description
66

77
Retrieving a package version downloads the metadata into the directory you specify.
88

9-
Specify the subscriber package version ID (starts with 04t) and the path to an empty directory when you run this command.
9+
When you run this command, specify the subscriber package version ID (starts with 04t) and the path to an empty directory.
10+
11+
By default, the package version retrieve command is available to 2GP managed packages that were converted from 1GP. To use this command with a managed package created using 2GP (not converted from 1GP) or with an unlocked package, specify IsDevUsePkgZipRequested = true in the Package2VersionCreateRequest Tooling API object. If you run this command and the zip folder with the package version’s source files is missing, confirm that IsDevUsePkgZipRequested is set to true.
1012

1113
# examples
1214

13-
- Retrieve package metadata for a converted subscriber package version ID (starts with 04t) into my-folder/ within your Salesforce DX project directory:
15+
Retrieve package metadata for a converted subscriber package version ID (starts with 04t) into my-directory/ within your Salesforce DX project directory:
1416

15-
<%= config.bin %> <%= command.id %> --package 04t... --output-dir my-folder –-target-dev-hub my-devhub
17+
<%= config.bin %> <%= command.id %> --package 04tXXX --output-dir my-directory/ --target-dev-hub devhub@example.com
1618

1719
# flags.package.summary
1820

@@ -22,6 +24,14 @@ Subscriber package version ID (starts with 04t).
2224

2325
Path within your Salesforce DX project directory in which to download the metadata. This directory must be empty.
2426

27+
# flags.target-dev-hub.summary
28+
29+
Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.
30+
31+
# flags.api-version.summary
32+
33+
Override the API version used for requests made by this command.
34+
2535
# headers.fullName
2636

2737
FULL NAME

0 commit comments

Comments
 (0)