Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
c7173ba
Update bundle_create.md
j-nolasco Nov 28, 2025
93eac67
Update bundle_version_create.md
j-nolasco Nov 28, 2025
8020268
Update bundle_version_create.md
j-nolasco Dec 9, 2025
1c88d1f
Update bundle_create.md
j-nolasco Dec 9, 2025
969a571
Update bundle_version_create_list.md
j-nolasco Dec 9, 2025
9432664
Update bundle_version_create_report.md
j-nolasco Dec 9, 2025
8dc8e15
Update bundle_install.md
j-nolasco Dec 9, 2025
ce23fef
Update bundle_install_list.md
j-nolasco Dec 9, 2025
c60ff5e
Update bundle_install_report.md
j-nolasco Dec 9, 2025
954981e
Update bundle_list.md
j-nolasco Dec 9, 2025
b9f9c9e
Update bundle_version_list.md
j-nolasco Dec 9, 2025
9945c66
Update bundle_version_report.md
j-nolasco Dec 9, 2025
5e37838
Update package_bundle_delete.md
j-nolasco Dec 9, 2025
bd63464
Update bundle_create.md
j-nolasco Dec 10, 2025
c20c350
Update bundle_version_create.md
j-nolasco Dec 10, 2025
6c206e0
Update bundle_version_create_list.md
j-nolasco Dec 10, 2025
26fa4dc
Update bundle_version_create_report.md
j-nolasco Dec 10, 2025
b341e94
Update bundle_install.md
j-nolasco Dec 10, 2025
561462f
Update bundle_install_list.md
j-nolasco Dec 10, 2025
4958a6d
Update bundle_install_report.md
j-nolasco Dec 10, 2025
ed48bfd
Update bundle_list.md
j-nolasco Dec 10, 2025
e802d3e
Update bundle_version_list.md
j-nolasco Dec 10, 2025
78e75b0
Update bundle_version_report.md
j-nolasco Dec 10, 2025
cb278b3
Update package_bundle_delete.md
j-nolasco Dec 10, 2025
f313ab0
Update bundle_version_create_list.md
j-nolasco Dec 11, 2025
79771e0
Update bundle_install_list.md
j-nolasco Dec 11, 2025
e93dc92
Update bundle_list.md
j-nolasco Dec 11, 2025
6827631
Update bundle_version_list.md
j-nolasco Dec 11, 2025
0e7e7e3
chore: fix test
btrn11 Dec 11, 2025
fa84dcf
chore: fix test
btrn11 Dec 11, 2025
6c1b757
Merge branch 'main' into j-nolasco-edit-package-bundle-messages
btrn11 Dec 11, 2025
9e01f10
fix: edit joanna's edits
jshackell-sfdc Dec 12, 2025
d8ec5fa
Refine summaries in bundle_install_list.md
jshackell-sfdc Dec 12, 2025
50f6ef4
Refine description and examples in report documentation
jshackell-sfdc Dec 12, 2025
17d6786
Update bundle_install.md
jshackell-sfdc Dec 12, 2025
996919b
Update formatting and content in bundle_list.md
jshackell-sfdc Dec 12, 2025
1eede7a
Revise flag summaries in bundle_version_create_list.md
jshackell-sfdc Dec 12, 2025
194ef96
Revise documentation for bundle version create report
jshackell-sfdc Dec 12, 2025
c04977b
Fix formatting issues in bundle_version_create.md
jshackell-sfdc Dec 12, 2025
88541b7
Update command example in bundle_version_list.md
jshackell-sfdc Dec 12, 2025
da0daf9
Fix formatting in bundle_version_report.md
jshackell-sfdc Dec 12, 2025
aafee20
Merge pull request #1096 from salesforcecli/jshackell-sfdc-patch-1
btrn11 Dec 12, 2025
26ed3d6
Merge branch 'main' into j-nolasco-edit-package-bundle-messages
btrn11 Dec 15, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions messages/bundle_create.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
# summary

Create a package bundle in the Dev Hub org.
Create a package bundle in the Dev Hub org.

# description

A package bundle is an artifact that contains one or more 2GP managed packages.
A bundle can be installed or upgraded as a single artifact.
A package bundle is an artifact composed of one or more 2GP managed packages. With a package bundle, you can develop, install, upgrade, and manage multiple packages as a single unit.

# examples

Create a package bundle in the Dev Hub org; uses the Dev Hub org with the username devhub@example.com:
- Create a package bundle in the Dev Hub org; uses the Dev Hub org with the username devhub@example.com:

sf package bundle create --name "Your bundle name" --description "Your bundle description" --target-dev-hub devhub@example.com
<%= config.bin %> <%= command.id %> --name "Your bundle name" --description "Your bundle description" --target-dev-hub devhub@example.com

# flags.name.summary

Expand All @@ -23,11 +22,11 @@ Description of the package bundle.

# flags.wait.summary

Number of minutes to wait for the bundle creation to complete.
Number of minutes to wait for the package bundle to be created.

# flags.verbose.summary

Display extended bundle creation detail.
Display extended details about the package bundle creation.

# requestInProgress

Expand Down
24 changes: 10 additions & 14 deletions messages/bundle_install.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,44 @@
# summary

Install a package bundle version in the target org.
Install a specific version of a package bundle in the target org.

# description

Install a specific version of a package bundle in the target org. During developer preview, bundles can be installed only in scratch orgs.
During developer preview, package bundles can be installed only in scratch orgs. To install a package bundle in a scratch org, add the PackageBundles feature to the scratch org definition file.

# examples
# examples

- Install a package bundle version in a scratch org:
- Install a package bundle version in a scratch org and wait 10 minutes for the installation to complete:

<%= config.bin %> <%= command.id %> --bundle MyPkgBundle1@0.1 --target-org my-scratch-org --dev-hub-org 00Dxx0000000000 --wait 10

- Install using a bundle version ID:

<%= config.bin %> <%= command.id %> --bundle 1Q8Wt0000000q1pKAA --target-org my-scratch-org --dev-hub-org 00Dxx0000000000 --wait 10
<%= config.bin %> <%= command.id %> --bundle MyPkgBundle1@0.1 --target-org my-scratch-org --dev-hub-org devhub@example.com --wait 10

# flags.bundle.summary

Package bundle version to install (format: BundleName@Version or bundle version ID).
Package bundle version to install. The valid format is BundleName@VersionNumber, such as "MyPkgBundle@0.1".

# flags.target-org.summary

Target org for the bundle installation.
Username or alias of the org in which to install the package bundle version. Not required if the `target-org` configuration variable is already set.

# flags.dev-hub-org.summary

Org ID of the Dev Hub org where the bundle was created.

# flags.dev-hub-org.description

Specify the Dev Hub org ID directly (such as 00Dxx0000000000).
Enter the Dev Hub org ID, such as 00Dxx0000000000.

# flags.wait.summary

Number of minutes to wait for the installation to complete.

# flags.verbose.summary

Display extended installation detail.
Display extended details about the installation.

# requestInProgress

Installing bundle.
Installing package bundle.

# bundleInstallWaitingStatus

Expand Down
14 changes: 7 additions & 7 deletions messages/bundle_install_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,19 @@ Shows the details of each request to install a package bundle version in the tar

All filter parameters are applied using the AND logical operator (not OR).

To get information about a specific request, run "<%= config.bin %> package bundle install report" and supply the request ID.
To get information about a specific request, run "<%= config.bin %> package bundle install report" and enter the request ID.

# flags.status.summary

Status of the installation request, used to filter the list.

# flags.verbose.summary

Displays additional information at a slight performance cost, such as validation text for each package bundle install request.
Display additional information, such as the validation text for each package bundle installation request.

# flags.created-last-days.summary

Number of days since the request was created, starting at 00:00:00 of first day to now. Use 0 for today.
Number of days since the request was created, starting at 0. Use 0 for today.

# examples

Expand All @@ -30,17 +30,17 @@ Number of days since the request was created, starting at 00:00:00 of first day

- List package bundle installation requests from the last 3 days in the Dev Hub org with username devhub@example.com:

<%= config.bin %> <%= command.id %> --created-last-days 3 --target-dev-hub
<%= config.bin %> <%= command.id %> --created-last-days 3 --target-dev-hub devhub@example.com

- List package bundle installation requests with status Error:
- List package bundle installation requests with the Error status:

<%= config.bin %> <%= command.id %> --status Error

- List package bundle installation requests with status Queued:
- List package bundle installation requests with the Queued status:

<%= config.bin %> <%= command.id %> --status Queued

- List package bundle installation requests with status Success that were created today:
- List package bundle install requests from today with the Success status:

<%= config.bin %> <%= command.id %> --created-last-days 0 --status Success

Expand Down
14 changes: 5 additions & 9 deletions messages/bundle_install_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,17 @@ Report on the status of a package bundle installation request.

# description

Use this command to check the status of a package bundle installation request. The command returns information about the request, including its current status and details about the package bundle version being installed.
The command returns information such as the current status of the request and details about the package bundle version being installed.

# examples
# examples

- Report on a package bundle installation request:

<%= config.bin %> <%= command.id %> --package-install-request-id 0Ho0x0000000000000

- Report on a package bundle installation request using an alias:

<%= config.bin %> force:package:bundle:install:report -i 0Ho0x0000000000000

# flags.package-install-request-id.summary

The ID of the package bundle installation request to report on.
ID of the package bundle installation request to report on.

# id

Expand All @@ -38,9 +34,9 @@ Development Organization

# validation-error

Validation Error
Validation Error

# created-date
# created-date

Created Date

Expand Down
18 changes: 9 additions & 9 deletions messages/bundle_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,42 +4,42 @@ List all package bundles in the Dev Hub org.

# examples

List all package bundles in the specified Dev Hub org; uses the Dev Hub org with the username devhub@example.com:
- List all package bundles in the Dev Hub org with the username `devhub@example.com`:

sf package bundle list --target-dev-hub <dev_hub_alias>
<%= config.bin %> <%= command.id %> --target-dev-hub devhub@example.com

# namespace
# namespace

Namespace Prefix
Namespace Prefix

# name

Name

# id

Id
ID

# bundle-id

Package Bundle Id
Package Bundle ID

# alias

Alias
Alias

# description

Description

# flags.verbose.summary

Display extended bundle detail.
Display extended details about the package bundles.

# error-notification-username

Error Notification Username

# createdBy

Created By
Created By
28 changes: 16 additions & 12 deletions messages/bundle_version_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,29 @@ Create a new package bundle version.

# description

Create a new version of a package bundle with the specified components.
Before you create a new bundle version, create a definition file (similar to a scratch org definition file) that contains the list of package versions to include in the bundle. The definition file must be JSON and you must specify the package versions in the correct order of installation. The package bundle version is based on package versions listed in the definition file.

After the first bundle version that you create, make sure to update the version number in the sfdx-project.json file for subsequent bundle versions.

To retrieve details about a package bundle version create request, including status and package bundle version ID (04t), run "sf package version create report -i 08c...".

# examples

Create a new version of a package bundle:
- Create a package bundle version in the Dev Hub org; uses the Dev Hub org with the username devhub@example.com:

sf package bundle version create -b MyBundle -p path/to/definition.json
<%= config.bin %> <%= command.id %> --bundle “Your bundle name” --definition-file resources/definition.json --target-dev-hub devhub@example.com

# flags.bundle.summary

The name or ID of the package bundle to create a version for.
Name or ID of the package bundle to create a version for.

# flags.definition-file.summary

Path to the JSON file containing the list of components to include in the bundle version.
Path to a definition file, similar to a scratch org definition file, that contains the list of package versions to include in the bundle.

# flags.wait.summary

Number of minutes to wait for the command to complete before timing out.
Number of minutes to wait for the package bundle version to be created.

# flags.verbose.summary

Expand All @@ -46,29 +50,29 @@ Waiting for bundle version creation to complete. %s minutes remaining. Current s

# bundleVersionCreateFinalStatus

Package Bundle version creation completed with status: %s
Package bundle version creation completed with status: %s

# multipleErrors

The following errors occurred during bundle version creation:
The following errors occurred during package bundle version creation:
%s

# InProgress

Bundle version creation is %s. Use 'sf package bundle version create report -i %s' to check the status later.
Package bundle version creation is %s. Use "sf package bundle version create report -i %s" to check the status later.

# requestInProgress

Creating bundle version...
Creating package bundle version...

# packageVersionCreateFinalStatus

Package Bundle version creation completed with status: %s
Package bundle version creation completed with status: %s

# packageVersionCreatePerformingValidations

Performing validations on the package bundle version...

# bundleVersionCreateSuccess

Successfully created bundle version for bundle %s
Successfully created package bundle version for bundle %s
26 changes: 13 additions & 13 deletions messages/bundle_version_create_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,43 +8,43 @@ Shows the details of each request to create a package bundle version in the Dev

All filter parameters are applied using the AND logical operator (not OR).

To get information about a specific request, run "<%= config.bin %> package bundle version create report" and supply the request ID.
To get information about a specific request, run "<%= config.bin %> package bundle version create report" and enter the request ID.

# flags.status.summary

Status of the version creation request, used to filter the list.
Status of the installation request, used to filter the list.

# flags.show-conversions-only.summary

Filter the list output to display only converted package bundle version.
Filter the list to display only converted package bundle versions.

# flags.verbose.summary

Displays additional information at a slight performance cost, such as the version name and number for each package version create request.
Display additional information, such as the version name and number for each package bundle version creation request.

# flags.created-last-days.summary

Number of days since the request was created, starting at 00:00:00 of first day to now. Use 0 for today.
Number of days since the request was created, starting at 0. Use 0 for today.

# examples

- List all package bundle version creation requests in your default Dev Hub org:

<%= config.bin %> <%= command.id %>

- List package bundle version creation requests from the last 3 days in the Dev Hub org with username devhub@example.com:
- List package bundle version creation requests from the last three days in the Dev Hub org with the username devhub@example.com:

<%= config.bin %> <%= command.id %> --created-last-days 3 --target-dev-hub
<%= config.bin %> <%= command.id %> --created-last-days 3 --target-dev-hub devhub@example.com

- List package bundle version creation requests with status Error:
- List package bundle version creation requests with the Error status:

<%= config.bin %> <%= command.id %> --status Error

- List package bundle version creation requests with status Queued:
- List package bundle version creation requests with the Queued status:

<%= config.bin %> <%= command.id %> --status Queued

- List package bundle version creation requests with status Success that were created today:
- List package bundle version creation requests from today with the Success status:

<%= config.bin %> <%= command.id %> --created-last-days 0 --status Success

Expand All @@ -58,16 +58,16 @@ Status

# package-id

Package Bundle Id
Package Bundle ID

# packageVersionId

Package Bundle Version Id
Package Bundle Version ID

# createdBy

Created By

# convertedFromVersionId

Converted From Version Id
Converted From Version ID
Loading
Loading