plugin-packaging;

  

$3

Install

This plugin is bundled with the Salesforce CLI, so you typically don't need to install it. However, if you want to install a specific version of the plugin you can run:

``bash
sf plugins:install @salesforce/plugin-packaging@x.y.z
`

_NOTE: If you install a specific version of a bundled plugin you will not get an updated packaging plugin when the CLI updates. You must either update to the packaging plugin version you want manually, or uninstall the version of the plugin you have to go back to the CLI bundled version._

Issues

Please report any issues at https://github.com/forcedotcom/cli/issues

Contributing

See CONTRIBUTING.md

Developing

See DEVELOPING.md

Commands

- sf package convert
- sf package create
- sf package delete
- sf package install
- sf package install report
- sf package installed list
- sf package list
- sf package push-upgrade abort
- sf package push-upgrade list
- sf package push-upgrade report
- sf package push-upgrade schedule
- sf package uninstall
- sf package uninstall report
- sf package update
- sf package version create
- sf package version create list
- sf package version create report
- sf package version delete
- sf package version displayancestry
- sf package version displaydependencies
- sf package version list
- sf package version promote
- sf package version report
- sf package version retrieve
- sf package version update
- sf package1 version create
- sf package1 version create get
- sf package1 version display
- sf package1 version list

sf package convert

Convert a managed-released first-generation managed package into a second-generation managed package.

`
USAGE
$ sf package convert -v -p [--json] [--flags-dir ] [--api-version ] [-k ] [-f
] [-x] [-w ] [-m ] [--verbose] [-a ] [-c]

FLAGS
-a, --patch-version= Specific released patch version to be converted.
-c, --code-coverage Calculate and store the code coverage percentage by running the packaged Apex tests
included in this package version.
-f, --definition-file= Path to a definition file that contains features and org preferences that the metadata
of the package version depends on.
-k, --installation-key= Installation key for key-protected package.
-m, --seed-metadata= Directory containing metadata to be deployed prior to conversion.
-p, --package= (required) ID (starts with 033) of the first-generation managed package to convert.
-v, --target-dev-hub= (required) Username or alias of the Dev Hub org. Not required if the target-dev-hub
configuration variable is already set.
-w, --wait= Minutes to wait for the package version to be created.
-x, --installation-key-bypass Bypass the installation key requirement.
--api-version= Override the api version used for api requests made by this command
--verbose Display verbose command output.

GLOBAL FLAGS
--flags-dir= Import flag values from a directory.
--json Format output as json.

DESCRIPTION
Convert a managed-released first-generation managed package into a second-generation managed package.

The package conversion command automatically selects the latest released major.minor first-generation managed package
version, and converts it into a second-generation managed package version.

Use --patch-version to specify a released patch version.

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

To protect the contents of your package and to prevent unauthorized installation of your package, specify the
--installation-key flag.

To promote a package version to released, you must use the --code-coverage parameter. The package must also meet the
code coverage requirements.

To list package version creation requests in the org, run "sf package version create list".

ALIASES
$ sf force package convert

EXAMPLES
Create a second-generation managed package version from the first-generation managed package with the specified ID
and give it the installation key "password123"; uses your default Dev Hub org:

$ sf package convert --package 033... --installation-key password123

Similar to previous example, but uses the specified Dev Hub org:

$ sf package convert --package 033... --installation-key password123 --target-dev-hub devhuborg@example.com

FLAG DESCRIPTIONS
-a, --patch-version= Specific released patch version to be converted.

Specify a released patch version as major.minor.patch to convert to a second-generation managed package version.

-c, --code-coverage

Calculate and store the code coverage percentage by running the packaged Apex tests included in this package
version.

Before you can promote and release a managed package version, the Apex code must meet a minimum 75% code coverage
requirement.

-f, --definition-file=

Path to a definition file that contains features and org preferences that the metadata of the package version
depends on.

This definition file is similar to the scratch org definition file.

-k, --installation-key= Installation key for key-protected package.

Either an --installation-key value or the --installation-key-bypass flag is required.

-m, --seed-metadata= Directory containing metadata to be deployed prior to conversion.

The directory containing metadata that will be deployed on the build org prior to attempting package conversion.

-x, --installation-key-bypass Bypass the installation key requirement.

If you bypass this requirement, anyone can install your package. Either an --installation-key value or the
--installation-key-bypass flag is required.
`

_See code: src/commands/package/convert.ts_

sf package create

Create a package.

`
USAGE
$ sf package create -v -n -t Managed|Unlocked -r [--json] [--flags-dir ]
[--api-version ] [-d ] [-e] [--org-dependent] [-o ]

FLAGS
-d, --description= Description of the package.
-e, --no-namespace Create the package with no namespace; available only for unlocked packages.
-n, --name= (required) Name of the package to create.
-o, --error-notification-username= Active Dev Hub user designated to receive email notifications for package
errors.
-r, --path= (required) Path to directory that contains the contents of the package.
-t, --package-type= (required) Type of package.

-v, --target-dev-hub= (required) Username or alias of the Dev Hub org. Not required if the
target-dev-hub configuration variable is already set.
--api-version= Override the api version used for api requests made by this command
--org-dependent Depends on unpackaged metadata in the installation org; applies to unlocked
packages only.

GLOBAL FLAGS
--flags-dir= Import flag values from a directory.
--json Format output as json.

DESCRIPTION
Create a package.

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 --no-namespace.

Your --name value must be unique within your namespace.

Run 'sf package list to list all packages in the Dev Hub org.

ALIASES
$ sf force package create

EXAMPLES
Create an unlocked package from the files in the "force-app" directory; uses your default Dev Hub org:

$ sf package create --name MyUnlockedPackage --package-type Unlocked --path force-app

Create a managed packaged from the "force-app" directory files, give the package a description, and use the
specified Dev Hub org:

$ sf package create --name MyManagedPackage --description "Your Package Descripton" --package-type Managed \
--path force-app --target-dev-hub devhub@example.com

FLAG DESCRIPTIONS
-e, --no-namespace Create the package with no namespace; available only for unlocked packages.

This flag is useful when you’re migrating an existing org to packages. But use a namespaced package for new
metadata.

-o, --error-notification-username=

Active Dev Hub user designated to receive email notifications for package errors.

Email notifications include information about unhandled Apex exceptions, and install, upgrade, or uninstall failures
associated with your package.

-t, --package-type=Managed|Unlocked Type of package.

The options for package type are Managed and Unlocked (Managed=DeveloperManagedSubscriberManaged,
Unlocked=DeveloperControlledSubscriberEditable). These options determine upgrade and editability rules.

--org-dependent 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.
`

_See code: src/commands/package/create.ts_

sf package delete

Delete a package.

`
USAGE
$ sf package delete -v -p [--json] [--flags-dir ] [--api-version ] [-n]

FLAGS
-n, --no-prompt Don't prompt before deleting the package.
-p, --package= (required) ID (starts with 0Ho) or alias of the package to delete.
-v, --target-dev-hub= (required) Username or alias of the Dev Hub org. Not required if the target-dev-hub
configuration variable is already set.
--api-version= Override the api version used for api requests made by this command

GLOBAL FLAGS
--flags-dir= Import flag values from a directory.
--json Format output as json.

DESCRIPTION
Delete a package.

Specify the ID or alias of the package you want to delete.

Delete unlocked and second-generation managed packages. Before you delete a package, first delete all associated
package versions.

ALIASES
$ sf force package delete

EXAMPLES
Delete a package using its alias from your default Dev Hub org:

$ sf package delete --package "Your Package Alias"

Delete a package using its ID from the specified Dev Hub org:

$ sf package delete --package 0Ho... --target-dev-hub devhub@example.com
`

_See code: src/commands/package/delete.ts_

sf package install

Install or upgrade a version of a package in the target org.

`
USAGE
$ sf package install -o -p [--json] [--flags-dir ] [--api-version ] [-w ] [-k
] [-b ] [-r] [-a all|package] [-s AllUsers|AdminsOnly] [-t DeprecateOnly|Mixed|Delete]

FLAGS
-a, --apex-compile= [default: all] Compile all Apex in the org and package, or only Apex in the package;
unlocked packages only.

-b, --publish-wait= Maximum number of minutes to wait for the Subscriber Package Version ID to become
available in the target org before canceling the install request.
-k, --installation-key= Installation key for key-protected package (default: null).
-o, --target-org= (required) Username or alias of the target org. Not required if the target-org
configuration variable is already set.
-p, --package= (required) ID (starts with 04t) or alias of the package version to install.
-r, --no-prompt Don't prompt for confirmation.
-s, --security-type= [default: AdminsOnly] Security access type for the installed package. Available
options are AdminsOnly and AllUsers.

-t, --upgrade-type= [default: Mixed] Upgrade type for the package installation; available only for
unlocked packages.

-w, --wait= Number of minutes to wait for installation status.
--api-version= Override the api version used for api requests made by this command

GLOBAL FLAGS
--flags-dir= Import flag values from a directory.
--json Format output as json.

DESCRIPTION
Install or upgrade a version of a package in the target org.

To install or upgrade 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.

When upgrading an unlocked package, include the --upgrade-type value to specify whether any removed components are
deprecated or deleted. 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.)

ALIASES
$ sf force package install

EXAMPLES
Install or upgrade a package version with the specified ID in the org with username "me@example.com":

$ sf package install --package 04t... --target-org me@example.com

Install or upgrade a package version with the specified alias into your default org:

$ sf package install --package awesome_package_alias

Install or upgrade a package version with an alias that includes spaces into your default org:

$ sf package install --package "Awesome Package Alias"

Upgrade an unlocked package version with the specified ID and deprecate all removed components:

$ sf package install --package 04t... --upgrade-type DeprecateOnly

FLAG DESCRIPTIONS
-a, --apex-compile=all|package

Compile all Apex in the org and package, or only Apex in the package; unlocked packages only.

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
--apex-compile package is specified.

-r, --no-prompt Don't prompt for confirmation.

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.

-t, --upgrade-type=DeprecateOnly|Mixed|Delete

Upgrade type for the package installation; available only for unlocked packages.

For unlocked package upgrades, set this flag to one of these values:

- DeprecateOnly: Mark all removed components as deprecated.
- Mixed: Delete all removed components that can be safely deleted and deprecate the other components.
- Delete: Delete removed components, except for custom objects and custom fields, that don't have dependencies.
`

_See code: src/commands/package/install.ts_

sf package install report

Retrieve the status of a package installation request.

`
USAGE
$ sf package install report -o -i [--json] [--flags-dir ] [--api-version ]

FLAGS
-i, --request-id= (required) ID of the package install request you want to check; starts with 0Hf.
-o, --target-org= (required) Username or alias of the target org. Not required if the target-org
configuration variable is already set.
--api-version= Override the api version used for api requests made by this command

GLOBAL FLAGS
--flags-dir= Import flag values from a directory.
--json Format output as json.

ALIASES
$ sf force package install report

EXAMPLES
Retrieve the status of a package installation request with the specified ID on your default org:

$ sf package install report --request-id 0Hf...

Similar to previous example, except use the org with username me@example.com:

$ sf package install report --request-id 0Hf... --target-org me@example.com
`

_See code: src/commands/package/install/report.ts_

sf package installed list

List the org’s installed packages.

`
USAGE
$ sf package installed list -o [--json] [--flags-dir ] [--api-version ]

FLAGS
-o, --target-org= (required) Username or alias of the target org. Not required if the target-org
configuration variable is already set.
--api-version= Override the api version used for api requests made by this command

GLOBAL FLAGS
--flags-dir= Import flag values from a directory.
--json Format output as json.

ALIASES
$ sf force package installed list

EXAMPLES
List the installed packages in your default org:

$ sf package installed list

List the installed packages in the org with username me@example.com:

$ sf package installed list --target-org me@example.com
`

_See code: src/commands/package/installed/list.ts_

sf package list

List all packages in the Dev Hub org.

`
USAGE
$ sf package list -v [--json] [--flags-dir ] [--api-version ] [--verbose]

FLAGS
-v, --target-dev-hub= (required) Username or alias of the Dev Hub org. Not required if the target-dev-hub
configuration variable is already set.
--api-version= Override the api version used for api requests made by this command
--verbose Display extended package detail.

GLOBAL FLAGS
--flags-dir= Import flag values from a directory.
--json Format output as json.

DESCRIPTION
List all packages in the Dev Hub org.

Description

ALIASES
$ sf force package list

EXAMPLES
List all packages in the specified Dev Hub org:

$ sf package list --target-dev-hub devhub@example.com

List all packages details in the specified Dev Hub org, and show extended details about each package:

$ sf package list --target-dev-hub devhub@example.com --verbose
`

_See code: src/commands/package/list.ts_

sf package push-upgrade abort

Abort a package push upgrade that has been scheduled. Only push upgrade requests with a status of Created or Pending can be aborted.

`
USAGE
$ sf package push-upgrade abort -v -i [--json] [--flags-dir ] [--api-version ]

FLAGS
-i, --push-request-id= (required) ID of the package push request (starts with 0DV). This ID is returned after
the package push-upgrade schedule command completes successfully.
-v, --target-dev-hub= (required) Username or alias of the Dev Hub org. Not required if the target-dev-hub
configuration variable is already set.
--api-version= Override the api version used for api requests made by this command

GLOBAL FLAGS
--flags-dir= Import flag values from a directory.
--json Format output as json.

DESCRIPTION
Abort a package push upgrade that has been scheduled. Only push upgrade requests with a status of Created or Pending
can be aborted.

Specify the request ID that you want to abort. If applicable, the command displays errors related to the request.

To show all requests in the org, run "sf package pushupgrade list --package 033...".

EXAMPLES
Cancel the specified package push upgrade request with the specified ID; uses your default Dev Hub org:

$ sf package push-upgrade abort --push-request-id 0DV...

Cancel the specified package push upgrade request in the Dev Hub org with username devhub@example.com:

$ sf package push-upgrade abort --push-request-id 0DV... --target-dev-hub devhub@example.com
`

_See code: src/commands/package/push-upgrade/abort.ts_

sf package push-upgrade list

Lists the status of push upgrade requests for a given package.

`
USAGE
$ sf package push-upgrade list -v -p [--json] [--flags-dir ] [--api-version ] [-l ] [-s
Created|Cancelled|Pending|In Progress|Failed|Succeeded] [--show-push-migrations-only]

FLAGS
-l, --scheduled-last-days= Number of days in the past for which to display the list of push upgrade requests
that were scheduled. Used to filter the list output to only recently scheduled push
upgrades.
-p, --package= (required) Package ID (starts with 033) of the package that you want push upgrade
information for.
-s, --status= Status used to filter the list output Valid values are: Created, Canceled, Pending,
In Progress, Failed, or Succeeded

-v, --target-dev-hub= (required) Username or alias of the Dev Hub org. Not required if the
target-dev-hub configuration variable is already set.
--api-version= Override the api version used for api requests made by this command
--show-push-migrations-only Display only push upgrade requests for package migrations.

GLOBAL FLAGS
--flags-dir= Import flag values from a directory.
--json Format output as json.

DESCRIPTION
Lists the status of push upgrade requests for a given package.

Shows the details of each request to create a push upgrade in the Dev Hub org.

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

To get information about a specific request, run "sf package pushupgrade report" and supply the request ID.

ALIASES
$ sf force package push-upgrade list

EXAMPLES
List all package push upgrade requests in the specified Dev Hub org:

$ sf package push-upgrade list --package 033xyz --target-dev-hub myHub

List all package push upgrade requests in the specified Dev Hub org scheduled in the last 30 days:

$ sf package push-upgrade list --package 033xyz --scheduled-last-days 30 --target-dev-hub myHub

List all package push upgrade with a status Succeeded:

$ sf package push-upgrade list --package 033xyz –-status Succeeded

List all package push upgrade with a status Failed:

$ sf package push-upgrade list --package 033xyz –-status Failed
`

_See code: src/commands/package/push-upgrade/list.ts_

sf package push-upgrade report

Retrieve the status of a package push upgrade.

`
USAGE
$ sf package push-upgrade report -v -i [--json] [--flags-dir ] [--api-version ]

FLAGS
-i, --push-request-id= (required) ID of the package push request (starts with 0DV). This ID is returned after
the package push-upgrade schedule command completes successfully.
-v, --target-dev-hub= (required) Username or alias of the Dev Hub org. Not required if the target-dev-hub
configuration variable is already set.
--api-version= Override the api version used for api requests made by this command

GLOBAL FLAGS
--flags-dir= Import flag values from a directory.
--json Format output as json.

DESCRIPTION
Retrieve the status of a package push upgrade.

Specify the request ID for which you want to view details. If applicable, the command displays errors related to the
request.

To show all requests in the org, run "sf package pushupgrade list".

ALIASES
$ sf force package push-upgrade report

EXAMPLES
Retrieve details about the package push upgrade with the specified ID; uses your default Dev Hub org:

$ sf package push-upgrade report --push-request-id 0DV...

Retrieve details about the specified package push request in the Dev Hub org with username devhub@example.com:

$ sf package push-upgrade report --push-request-id 0DV... --target-dev-hub devhub@example.com
`

_See code: src/commands/package/push-upgrade/report.ts_

sf package push-upgrade schedule

Schedule a package push upgrade.

`
USAGE
$ sf package push-upgrade schedule -v -p [--json] [--flags-dir ] [--api-version ] [-t ] [-l
| -f ] [--migrate-to-2gp]

FLAGS
-f, --org-file= Filename of the CSV file that contains the list of subscriber org IDs that need the
package upgrade. Either --org-list or --org-file must be specified.
-l, --org-list= Comma-separated list of subscriber org IDs that need the package upgrade. Either
--org-list or --org-file must be specified.
-p, --package= (required) ID (starts with 04t) of the package version that the package is being
upgraded to. The package version must be an active, non-beta package version.
-t, --start-time= Date and time (UTC) when the push upgrade is processed. Set to the earliest time that
you want Salesforce to attempt to start the upgrade.
-v, --target-dev-hub= (required) Username or alias of the Dev Hub org that owns the package.
--api-version= Override the api version used for api requests made by this command
--migrate-to-2gp Upgrade from a first-generation managed package (1GP) to a second-generation managed
package (2GP). Required when you’re pushing a 2GP package to orgs with the 1GP version
installed.

GLOBAL FLAGS
--flags-dir= Import flag values from a directory.
--json Format output as json.

DESCRIPTION
Schedule a package push upgrade.

Represents a push upgrade request for upgrading a package in one or many orgs from one version to another version.
To initiate a push upgrade for an unlocked or second-generation managed package, the Create and Update
Second-Generation Packages user permission is required.
For second-generation managed packages, the push upgrade feature is available only for packages that have passed
AppExchange security review. To enable push upgrades for your managed package, log a support case in the Salesforce
Partner Community.
For unlocked packages, push upgrades are enabled by default.

Use the -–migrate-to-2GP flag to indicate you’re installing a converted second-generation managed package into an org
that has the first-generation managed package version of that package installed.

EXAMPLES
Schedule a push upgrade that initiates at a specified time:

$ sf package push-upgrade schedule --package 04txyz --start-time "2024-12-06T21:00:00" --org-file \
upgrade-orgs.csv --target-dev-hub myHub

Schedule a push upgrade that initiates as soon as possible:

$ sf package push-upgrade schedule --package 04txyz --org-file upgrade-orgs.csv --target-dev-hub myHub

Schedule a push migration from a 1GP package to a 2GP package:

$ sf package push-upgrade schedule --migrate-to-2gp --package 04txyz --start-time "2024-12-06T21:00:00" \
--org-file upgrade-orgs.csv --target-dev-hub myHub

FLAG DESCRIPTIONS
-f, --org-file=

Filename of the CSV file that contains the list of subscriber org IDs that need the package upgrade. Either
--org-list or --org-file must be specified.

The file must contain one org per line. The org ID must be the only value in each row.
All listed orgs must have a package version installed in their org that is lower than the package version you
specified for the --package flag.

-t, --start-time=

Date and time (UTC) when the push upgrade is processed. Set to the earliest time that you want Salesforce to attempt
to start the upgrade.

Scheduled push upgrades begin as soon as resources are available on the Salesforce instance, which is either at or
after the start time you specify. In certain scenarios, the push upgrade starts a few hours after the scheduled
start time.

As a best practice, schedule push upgrades at off-peak hours like 1:00 AM Saturday.
If you don't specify this flag, the push upgrade is scheduled to run as soon as resources are available on the
Salesforce instance.

-v, --target-dev-hub= Username or alias of the Dev Hub org that owns the package.

Overrides the value of the target-dev-hub configuration variable, if set.
`

_See code: src/commands/package/push-upgrade/schedule.ts_

sf package uninstall

Uninstall a second-generation package from the target org.

`
USAGE
$ sf package uninstall -o -p [--json] [--flags-dir ] [--api-version ] [-w ]

FLAGS
-o, --target-org= (required) Username or alias of the target org. Not required if the target-org
configuration variable is already set.
-p, --package= (required) ID (starts with 04t) or alias of the package version to uninstall.
-w, --wait= Number of minutes to wait for uninstall status.
--api-version= Override the api version used for api requests made by this command

GLOBAL FLAGS
--flags-dir= Import flag values from a directory.
--json Format output as json.

DESCRIPTION
Uninstall a second-generation package from the target org.

Specify the package ID for a second-generation package.

To list the org’s installed packages, run "sf package installed list".

To uninstall a first-generation package, from Setup, enter Installed Packages in the Quick Find box, then select
Installed Packages.

ALIASES
$ sf force package uninstall

EXAMPLES
Uninstall a package with specified ID from an org with username me@example.com:

$ sf package uninstall --package 04t... --target-org me@example.com

Uninstall a package with the specified alias from your default org:

$ sf package uninstall --package undesirable_package_alias

Uninstall a package with an alias that contains spaces from your default org:

$ sf package uninstall --package "Undesirable Package Alias"
`

_See code: src/commands/package/uninstall.ts_

sf package uninstall report

Retrieve the status of a package uninstall request.

`
USAGE
$ sf package uninstall report -o -i [--json] [--flags-dir ] [--api-version ]

FLAGS
-i, --request-id= (required) ID of the package uninstall request you want to check; starts with 06y.
-o, --target-org= (required) Username or alias of the target org. Not required if the target-org
configuration variable is already set.
--api-version= Override the api version used for api requests made by this command

GLOBAL FLAGS
--flags-dir= Import flag values from a directory.
--json Format output as json.

ALIASES
$ sf force package uninstall report

EXAMPLES
Retrieve the status of a package uninstall in your default org using the specified request ID:

$ sf package uninstall report --request-id 06y...

Similar to previous example, but use the org with username me@example.com:

$ sf package uninstall report --request-id 06y... --target-org me@example.com
`

_See code: src/commands/package/uninstall/report.ts_

sf package update

Update package details.

`
USAGE
$ sf package update -v -p [--json] [--flags-dir ] [--api-version ] [-n ] [-d
] [-o ] [--enable-app-analytics] [-r ] [--skip-ancestor-check]

FLAGS
-d, --description= New description of the package.
-n, --name= New name of the package.
-o, --error-notification-username= Active Dev Hub user designated to receive email notifications for package
errors.
-p, --package= (required) ID (starts with 0Ho) or alias of the package to update.
-r, --recommended-version-id= 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.
-v, --target-dev-hub= (required) Username or alias of the Dev Hub org. Not required if the
target-dev-hub configuration variable is already set.
--api-version= Override the api version used for api requests made by this command
--[no-]enable-app-analytics Enable AppExchange App Analytics usage data collection on this managed
package and its components.
--skip-ancestor-check Bypass the ancestry check for setting a recommended version.

GLOBAL FLAGS
--flags-dir= Import flag values from a directory.
--json Format output as json.

DESCRIPTION
Update package details.

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
$ sf force package update

EXAMPLES
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

FLAG DESCRIPTIONS
-o, --error-notification-username=

Active Dev Hub user designated to receive email notifications for package errors.

Email notifications include information about unhandled Apex exceptions, and install, upgrade, or uninstall failures
associated with your package.

-r, --recommended-version-id=

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.

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.
`

_See code: src/commands/package/update.ts_

sf package version create

Create a package version in the Dev Hub org.

`
USAGE
$ sf package version create -v [--json] [--flags-dir ] [--api-version ] [-b ] [-c |
--skip-validation] [-f ] [-k ] [-x] [-p ] [-d ] [--post-install-script ]
[--post-install-url ] [--releasenotes-url ] [--skip-ancestor-check] [--async-validation | ]
[--generate-pkg-zip] [-t ] [--uninstall-script ] [-e ] [-a ] [-n ] [-w ]
[--language ] [--verbose]

FLAGS
-a, --version-name= Name of the package version to be created; overrides the sfdx-project.json value.
-b, --branch= Name of the branch in your source control system that the package version is based
on.
-c, --code-coverage Calculate and store the code coverage percentage by running the packaged Apex tests
included in this package version.
-d, --path= Path to the directory that contains the contents of the package.
-e, --version-description= Description of the package version to be created; overrides the sfdx-project.json
value.
-f, --definition-file= Path to a definition file similar to scratch org definition file that contains the
list of features and org preferences that the metadata of the package version
depends on.
-k, --installation-key= Installation key for key-protected package. (either --installation-key or
--installation-key-bypass is required)
-n, --version-number= Version number of the package version to be created; overrides the
sfdx-project.json value.
-p, --package= ID (starts with 0Ho) or alias of the package to create a version of.
-t, --tag= Package version’s tag.
-v, --target-dev-hub= (required) Username or alias of the Dev Hub org. Not required if the
target-dev-hub configuration variable is already set.
-w, --wait= Number of minutes to wait for the package version to be created.
-x, --installation-key-bypass Bypass the installation key requirement. (either --installation-key or
--installation-key-bypass is required)
--api-version= Override the api version used for api requests made by this command
--async-validation Return a new package version before completing package validations.
--generate-pkg-zip Generate a package ZIP file that you can use for debugging or to examine the
package contents.
--language= Language for the package.
--post-install-script= Name of the post-install script; applies to managed packages only.
--post-install-url= Post-install instructions URL.
--releasenotes-url= Release notes URL.
--skip-ancestor-check Override ancestry requirements, which allows you to specify a package ancestor that
isn’t the highest released package version.
--skip-validation Skip validation during package version creation; you can’t promote unvalidated
package versions.
--uninstall-script= Uninstall script name; applies to managed packages only.
--verbose Display verbose command output.

GLOBAL FLAGS
--flags-dir= Import flag values from a directory.
--json Format output as json.

DESCRIPTION
Create a package version in the Dev Hub org.

The package version is based on the package contents in the specified directory.

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

We recommend that you specify the --installation-key parameter 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 "sf package version create list".
To promote a package version to released, you must use the --code-coverage parameter. The package must also meet the
code coverage requirements. This requirement applies to both managed and unlocked packages.

We don’t calculate code coverage for org-dependent unlocked packages, or for package versions that specify
--skip-validation.

ALIASES
$ sf force package version create

EXAMPLES
Create a package version from the contents of the "common" directory and give it an installation key of
"password123"; uses your default Dev Hub org:

$ sf package version create --path common --installation-key password123

Create a package version from a package with the specified alias; uses the Dev Hub org with username
devhub@example.com:

$ sf package version create --package "Your Package Alias" --installation-key password123 --target-dev-hub \
devhub@example.com

Create a package version from a package with the specified ID:

$ sf package version create --package 0Ho... --installation-key password123

Create a package version and skip the validation step:

$ sf package version create --path common --installation-key password123 --skip-validation

Create a package version and perform package validations asynchronously:

$ sf package version create --path common --installation-key password123 --async-validation

FLAG DESCRIPTIONS
-c, --code-coverage

Calculate and store the code coverage percentage by running the packaged Apex tests included in this package
version.

Before you can promote and release a managed or unlocked package version, the Apex code must meet a minimum 75% code
coverage requirement. We don’t calculate code coverage for org-dependent unlocked packages or for package versions
that specify --skip-validation.

-f, --definition-file=

Path to a definition file similar to scratch org definition file that contains the list of features and org
preferences that the metadata of the package version depends on.

For a patch version, the features specified in this file are ignored, and instead the features specified for the
ancestor version are used.

-n, --version-number=

Version number of the package version to be created; overrides the sfdx-project.json value.

For information about the format of the version number, see
https://developer.salesforce.com/docs/atlas.en-us.pkg2_dev.meta/pkg2_dev/sfdx_dev2gp_config_file.htm.

-x, --installation-key-bypass

Bypass the installation key requirement. (either --installation-key or --installation-key-bypass is required)

If you bypass this requirement, anyone can install your package.

--async-validation Return a new package version before completing package validations.

Specifying async validation returns the package version earlier in the process, allowing you to install and test the
new version right away. If your development team is using continuous integration (CI) scripts, async validation can
reduce your overall CI run time.

--language= Language for the package.

Specify the language using a language code listed under "Supported Languages" in Salesforce Help. If no language is
specified, the language defaults to the language of the Dev Hub user who created the package.

--post-install-script= Name of the post-install script; applies to managed packages only.

The post-install script is an Apex class within this package that is run in the installing org after installations
or upgrades of this package version.

--post-install-url= Post-install instructions URL.

The contents of the post-installation instructions URL are displayed in the UI after installation of the package
version.

--releasenotes-url= Release notes URL.

This link is displayed in the package installation UI to provide release notes for this package version to
subscribers.

--skip-validation Skip validation during package version creation; you can’t promote unvalidated package versions.

Skips validation of dependencies, package ancestors, and metadata during package version creation. Skipping
validation reduces the time it takes to create a new package version, but you can promote only validated package
versions. Skipping validation can suppress important errors that can surface at a later stage. You can specify skip
validation or code coverage, but not both. Code coverage is calculated during validation.

--uninstall-script= Uninstall script name; applies to managed packages only.

The uninstall script is an Apex class within this package that is run in the installing org after uninstallations of
this package.

--verbose Display verbose command output.

Display verbose command output. When polling for the status of the creation, this will output status and timeout
data on a separate line for each poll request, which is useful in CI systems where timeouts can occur with long
periods of no output from commands.
`

_See code: src/commands/package/version/create.ts_

sf package version create list

List package version creation requests.

`
USAGE
$ sf package version create list -v [--json] [--flags-dir ] [--api-version ] [-c ] [-s
Queued|InProgress|Success|Error] [--show-conversions-only] [--verbose]

FLAGS
-c, --created-last-days= Number of days since the request was created, starting at 00:00:00 of first day to
now. Use 0 for today.
-s, --status= Status of the version creation request, used to filter the list.

-v, --target-dev-hub= (required) Username or alias of the Dev Hub org. Not required if the target-dev-hub
configuration variable is already set.
--api-version= Override the api version used for api requests made by this command
--show-conversions-only Filter the list output to display only converted package version.
--verbose Displays additional information at a slight performance cost, such as the version
name and number for each package version create request.

GLOBAL FLAGS
--flags-dir= Import flag values from a directory.
--json Format output as json.

DESCRIPTION
List package version creation requests.

Shows the details of each request to create a package version in the Dev Hub org.

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

To get information about a specific request, run "sf package version create report" and supply the request ID.

ALIASES
$ sf force package version create list

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

$ sf package version create list

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

$ sf package version create list --created-last-days 3 --target-dev-hub

List package version creation requests with status Error:

$ sf package version create list --status Error

List package version creation requests with status InProgress:

$ sf package version create list --status InProgress

List package version creation requests with status Success that were created today:

$ sf package version create list --created-last-days 0 --status Success
`

_See code: src/commands/package/version/create/list.ts_

sf package version create report

Retrieve details about a package version creation request.

`
USAGE
$ sf package version create report -v -i [--json] [--flags-dir ] [--api-version ]

FLAGS
-i, --package-create-request-id= (required) ID (starts with 08c) of the package version creation request you
want to display.
-v, --target-dev-hub= (required) Username or alias of the Dev Hub org. Not required if the
target-dev-hub configuration variable is already set.
--api-version= Override the api version used for api requests made by this command

GLOBAL FLAGS
--flags-dir= Import flag values from a directory.
--json Format output as json.

DESCRIPTION
Retrieve details about a package version creation request.

Specify the request ID for which you want to view details. If applicable, the command displays errors related to the
request.

To show all requests in the org, run "sf package version create list".

ALIASES
$ sf force package version create report

EXAMPLES
Retrieve details about the package version creation request with the specified ID; uses your default Dev Hub org:

$ sf package version create report --package-create-request-id 08c...

Retrieve details about the specified package version creation request in the Dev Hub org with username
devhub@example.com:

$ sf package version create report --package-create-request-id 08c... --target-dev-hub devhub@example.com
`

_See code: src/commands/package/version/create/report.ts_

sf package version delete

Delete a package version.

`
USAGE
$ sf package version delete -v -p [--json] [--flags-dir ] [--api-version ] [-n]

FLAGS
-n, --no-prompt Don’t prompt before deleting the package version.
-p, --package= (required) ID (starts with 04t) or alias of the package version to delete.
-v, --target-dev-hub= (required) Username or alias of the Dev Hub org. Not required if the target-dev-hub
configuration variable is already set.
--api-version= Override the api version used for api requests made by this command

GLOBAL FLAGS
--flags-dir= Import flag values from a directory.
--json Format output as json.

DESCRIPTION
Delete a package version.

Specify the ID or alias of the package version you want to delete. In second-generation managed packaging, only beta
package versions can be deleted. Before deleting a package version, review the considerations outlined in
https://developer.salesforce.com/docs/atlas.en-us.pkg2_dev.meta/pkg2_dev/sfdx_dev_dev2gp_package_deletion.htm.

ALIASES
$ sf force package version delete

EXAMPLES
Delete a package version with the specified alias using your default Dev Hub org:

$ sf package version delete --package "Your Package Alias"

Delete a package version with the specified ID using the Dev Hub org with username "devhub@example.com":

$ sf package version delete --package 04t... --target-org devhub@example.com
`

_See code: src/commands/package/version/delete.ts_

sf package version displayancestry

Display the ancestry tree for a 2GP managed package version.

`
USAGE
$ sf package version displayancestry -v -p [--json] [--flags-dir ] [--api-version ] [--dot-code]
[--verbose]

FLAGS
-p, --package= (required) ID or alias of the package (starts with 0Ho) or package version (starts with
04t) to display ancestry for.
-v, --target-dev-hub= (required) Username or alias of the Dev Hub org. Not required if the target-dev-hub
configuration variable is already set.
--api-version= Override the api version used for api requests made by this command
--dot-code Display the ancestry tree in DOT code.
--verbose Display both the package version ID (starts with 04t) and the version number
(major.minor.patch.build) in the ancestry tree.

GLOBAL FLAGS
--flags-dir= Import flag values from a directory.
--json Format output as json.

ALIASES
$ sf force package version displayancestry

EXAMPLES
Display the ancestry tree for a package version with the specified alias, using your default Dev Hub org:

$ sf package version displayancestry --package package_version_alias

Similar to previous example, but display the output in DOT code:

$ sf package version displayancestry --package package_version_alias --dot-code

Display the ancestry tree for a package with the specified ID, using the Dev Hub org with username
devhub@example.com:

$ sf package version displayancestry --package OHo... --target-dev-hub devhub@example.com

Display the ancestry tree of a package version with the specified ID, using your default Dev Hub org:

$ sf package version displayancestry --package 04t...

FLAG DESCRIPTIONS
-p, --package=

ID or alias of the package (starts with 0Ho) or package version (starts with 04t) 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.

--dot-code Display the ancestry tree in DOT code.

You can use the DOT code output in graph visualization software to create tree visualizations.
`

_See code: src/commands/package/version/displayancestry.ts_

sf package version displaydependencies

Display the dependency graph for an unlocked or 2GP managed package version.

`
USAGE
$ sf package version displaydependencies -v -p [--json] [--flags-dir ] [--api-version ] [--edge-direction
root-first|root-last] [--verbose]

FLAGS
-p, --package= (required) ID or alias of the package version (starts with 04t) or the package version
create request (starts with 08c) to display the dependency graph for.
-v, --target-dev-hub= (required) Username or alias of the Dev Hub org. Not required if the target-dev-hub
configuration variable is already set.
--api-version= Override the api version used for api requests made by this command
--edge-direction= [default: root-first] Order (root-first or root-last) in which the dependencies are
displayed.

--verbose Display both the package version ID (starts with 04t) and the version number
(major.minor.patch.build) in each node.

GLOBAL FLAGS
--flags-dir= Import flag values from a directory.
--json Format output as json.

EXAMPLES
Display the dependency graph for a package version with the specified alias, using your default Dev Hub org and the
default edge-direction:

$ sf package version displaydependencies --package package_version_alias

Display the dependency graph for a package version with the specified ID and display the graph using a root-last
edge direction. Use the Dev Hub org with username devhub@example.com:

$ sf package version displaydependencies --package 04t... --edge-direction root-last --target-dev-hub \
devhub@example.com

Display the dependency graph of a version create request with the specified ID, using your default Dev Hub org and
the default edge-direction:

$ sf package version displaydependencies --package 08c...

FLAG DESCRIPTIONS
-p, --package=

ID or alias of the package version (starts with 04t) or the package version create request (starts with 08c) to
display the dependency graph for.

Before running this command, update your sfdx-project.json file to specify the calculateTransitiveDependencies
attribute, and set the value to true. This command returns GraphViz code, which can be compiled to a graph using DOT
code or another graph visualization software.

--edge-direction=root-first|root-last Order (root-first or root-last) in which the dependencies are displayed.

A root-first graph declares the root as the package that must be installed last. A root-last graph is the reverse
order of root-first. If you specify "--edge-direction root-last", the graph displays the packages in the order they
must be installed. The root starts with the farthest leaf of the package dependencies and ends with the base
package, which must be installed last.
`

_See code: src/commands/package/version/displaydependencies.ts_

sf package version list

List all package versions in the Dev Hub org.

`
USAGE
$ sf package version list -v [--json] [--flags-dir ] [--api-version ] [-c ] [--concise]
[--show-conversions-only] [-m ] [-p ] [-r] [-b ] [-o ] [--verbose]

FLAGS
-b, --branch= Branch in your source control system used to filter the results; only package
versions based on the specified branch are listed.
-c, --created-last-days= Number of days since the request was created, starting at 00:00:00 of first day to
now. Use 0 for today.
-m, --modified-last-days= Number of days since the items were modified, starting at 00:00:00 of first day to
now. Use 0 for today.
-o, --order-by= Package version fields used to order the list.
-p, --packages= Comma-delimited list of packages (aliases or 0Ho IDs) to list.
-r, --released Display released versions only (IsReleased=true).
-v, --target-dev-hub= (required) Username or alias of the Dev Hub org. Not required if the
target-dev-hub configuration variable is already set.
--api-version= Override the api version used for api requests made by this command
--concise Display limited package version details.
--show-conversions-only Filter the list output to display only converted package version.
--verbose Display extended package version details.

GLOBAL FLAGS
--flags-dir= Import flag values from a directory.
--json Format output as json.

DESCRIPTION
List all package versions in the Dev Hub org.

Description

ALIASES
$ sf force package version list

EXAMPLES
List package versions in your default Dev Hub org that were created in the last 3 days; show only the released
versions and order the list using the PatchVersion field. Display extended details about each package version:

$ sf package version list --verbose --created-last-days 3 --released --order-by PatchVersion

List the released package versions for the two specified packages that were modified today; use the Dev Hub org with
username devhub@example.com:

$ sf package version list --packages 0Ho000000000000,0Ho000000000001 --released --modified-last-days 0 \
--target-dev-hub devhub@example.com

List all released package versions in your default Dev Hub org:

$ sf package version list --released

List package versions that were modified today in your default Dev Hub org; show limited details about each one:

$ sf package version list --concise --modified-last-days 0

List package versions that are based on the "featureA" branch in your source control system that were modified today
in your default Dev Hub org; show limited details about each one:

$ sf package version list --concise --modified-last-days 0 --branch featureA

List released package versions that were created in the last 3 days in your default Dev Hub org; show limited
details:

$ sf package version list --concise --created-last-days 3 --released

List released package versions that were modified today for the two packages with specified aliases in your default
Dev Hub org:

$ sf package version list --packages exp-mgr,exp-mgr-util --released --modified-last-days 0
`

_See code: src/commands/package/version/list.ts_

sf package version promote

Promote a package version to released.

`
USAGE
$ sf package version promote -v -p [--json] [--flags-dir ] [--api-version ] [-n]

FLAGS
-n, --no-prompt Don't prompt to confirm setting the package version as released.
-p, --package= (required) ID (starts with 04t) or alias of the package version to promote.
-v, --target-dev-hub= (required) Username or alias of the Dev Hub org. Not required if the target-dev-hub`
configuration variable is already set.
--api-version= Override the api version used for api requests made by this command

GLOBAL FLAGS
--flags-dir= Import flag values from a directory.
--json Format output as json.

DESCRIPTION
Promote a package version to released.

Supply the ID or alias of the package version you want to promote. Promotes the package version to released status.

ALIASES
$ sf force package version promote

EXAMPLES
Promote the package version with the specified