package Commands

Description for package create

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.

Examples for package create

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

Flags

--json

Optional

Format output as json.

Type: boolean

--flags-dir FLAGS-DIR

Optional

Import flag values from a directory.

Type: option

-v | --target-dev-hub TARGET-DEV-HUB

Required

Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.

Type: option

--api-version API-VERSION

Optional

Override the api version used for api requests made by this command

Type: option

-n | --name NAME

Required

Name of the package to create.

Type: option

-t | --package-type PACKAGE-TYPE

Required

Type of package.

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

Type: option

Permissible values are: Managed, Unlocked

-d | --description DESCRIPTION

Optional

Description of the package.

Type: option

-e | --no-namespace

Optional

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.

Type: boolean

-r | --path PATH

Required

Path to directory that contains the contents of the package.

Type: option

--org-dependent

Optional

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.

Type: boolean

-o | --error-notification-username ERROR-NOTIFICATION-USERNAME

Optional

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.

Type: option

Aliases for package create

force:package:create

Description for package delete

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.

Examples for package delete

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

Flags

--json

Optional

Format output as json.

Type: boolean

--flags-dir FLAGS-DIR

Optional

Import flag values from a directory.

Type: option

-v | --target-dev-hub TARGET-DEV-HUB

Required

Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.

Type: option

--api-version API-VERSION

Optional

Override the api version used for api requests made by this command

Type: option

-n | --no-prompt

Optional

Don’t prompt before deleting the package.

Type: boolean

-p | --package PACKAGE

Required

ID (starts with 0Ho) or alias of the package to delete.

Type: option

Aliases for package delete

force:package:delete

Description for package install

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

Examples for package install

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

Flags

--json

Optional

Format output as json.

Type: boolean

--flags-dir FLAGS-DIR

Optional

Import flag values from a directory.

Type: option

-o | --target-org TARGET-ORG

Required

Username or alias of the target org. Not required if the `target-org` configuration variable is already set.

Type: option

--api-version API-VERSION

Optional

Override the api version used for api requests made by this command

Type: option

-w | --wait WAIT

Optional

Number of minutes to wait for installation status.

Type: option

Default value: 0 minutes

-k | --installation-key INSTALLATION-KEY

Optional

Installation key for key-protected package (default: null).

Type: option

-b | --publish-wait PUBLISH-WAIT

Optional

Maximum number of minutes to wait for the Subscriber Package Version ID to become available in the target org before canceling the install request.

Type: option

Default value: 0 minutes

-r | --no-prompt

Optional

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.

Type: boolean

-p | --package PACKAGE

Required

ID (starts with 04t) or alias of the package version to install.

Type: option

-a | --apex-compile APEX-COMPILE

Optional

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.

Type: option

Permissible values are: all, package

Default value: all

-s | --security-type SECURITY-TYPE

Optional

Security access type for the installed package. Available options are AdminsOnly and AllUsers.

Type: option

Permissible values are: AllUsers, AdminsOnly

Default value: AdminsOnly

-t | --upgrade-type UPGRADE-TYPE

Optional

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 removed components, except for custom objects and custom fields, that don't have dependencies.

- Delete: Delete all removed components that can be safely deleted, and deprecate the other components.

Type: option

Permissible values are: DeprecateOnly, Mixed, Delete

Default value: Mixed

Aliases for package install

force:package:install

Examples for package install report

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

Flags

--json

Optional

Format output as json.

Type: boolean

--flags-dir FLAGS-DIR

Optional

Import flag values from a directory.

Type: option

-o | --target-org TARGET-ORG

Required

Username or alias of the target org. Not required if the `target-org` configuration variable is already set.

Type: option

--api-version API-VERSION

Optional

Override the api version used for api requests made by this command

Type: option

-i | --request-id REQUEST-ID

Required

ID of the package install request you want to check; starts with 0Hf.

Type: option

Aliases for package install report

force:package:install:report

Examples for package installed list

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

Flags

--json

Optional

Format output as json.

Type: boolean

--flags-dir FLAGS-DIR

Optional

Import flag values from a directory.

Type: option

-o | --target-org TARGET-ORG

Required

Username or alias of the target org. Not required if the `target-org` configuration variable is already set.

Type: option

--api-version API-VERSION

Optional

Override the api version used for api requests made by this command

Type: option

Aliases for package installed list

force:package:installed:list

Description for package list

Description

Examples for package list

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

Flags

--json

Optional

Format output as json.

Type: boolean

--flags-dir FLAGS-DIR

Optional

Import flag values from a directory.

Type: option

-v | --target-dev-hub TARGET-DEV-HUB

Required

Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.

Type: option

--api-version API-VERSION

Optional

Override the api version used for api requests made by this command

Type: option

--verbose

Optional

Display extended package detail.

Type: boolean

Aliases for package list

force:package:list

Description for package uninstall

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.

Examples for package uninstall

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"

Flags

--json

Optional

Format output as json.

Type: boolean

--flags-dir FLAGS-DIR

Optional

Import flag values from a directory.

Type: option

-o | --target-org TARGET-ORG

Required

Username or alias of the target org. Not required if the `target-org` configuration variable is already set.

Type: option

--api-version API-VERSION

Optional

Override the api version used for api requests made by this command

Type: option

-w | --wait WAIT

Optional

Number of minutes to wait for uninstall status.

Type: option

Default value: 0 minutes

-p | --package PACKAGE

Required

ID (starts with 04t) or alias of the package version to uninstall.

Type: option

Aliases for package uninstall

force:package:uninstall

Examples for package uninstall report

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

Flags

--json

Optional

Format output as json.

Type: boolean

--flags-dir FLAGS-DIR

Optional

Import flag values from a directory.

Type: option

-o | --target-org TARGET-ORG

Required

Username or alias of the target org. Not required if the `target-org` configuration variable is already set.

Type: option

--api-version API-VERSION

Optional

Override the api version used for api requests made by this command

Type: option

-i | --request-id REQUEST-ID

Required

ID of the package uninstall request you want to check; starts with 06y.

Type: option

Aliases for package uninstall report

force:package:uninstall:report

Description for package update

Specify a new value for each option you want to update.

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

Examples for package update

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

Flags

--json

Optional

Format output as json.

Type: boolean

--flags-dir FLAGS-DIR

Optional

Import flag values from a directory.

Type: option

-v | --target-dev-hub TARGET-DEV-HUB

Required

Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.

Type: option

--api-version API-VERSION

Optional

Override the api version used for api requests made by this command

Type: option

-p | --package PACKAGE

Required

ID (starts with 0Ho) or alias of the package to update.

Type: option

-n | --name NAME

Optional

New name of the package.

Type: option

-d | --description DESCRIPTION

Optional

New description of the package.

Type: option

-o | --error-notification-username ERROR-NOTIFICATION-USERNAME

Optional

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.

Type: option

--enable-app-analytics

Optional

Enable AppExchange App Analytics usage data collection on this managed package and its components.

Type: boolean

Aliases for package update

force:package:update

Description for package version create

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.

Examples for package version create

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

Flags

--json

Optional

Format output as json.

Type: boolean

--flags-dir FLAGS-DIR

Optional

Import flag values from a directory.

Type: option

-v | --target-dev-hub TARGET-DEV-HUB

Required

Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.

Type: option

--api-version API-VERSION

Optional

Override the api version used for api requests made by this command

Type: option

-b | --branch BRANCH

Optional

Name of the branch in your source control system that the package version is based on.

Type: option

-c | --code-coverage

Optional

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.

Type: boolean

-f | --definition-file DEFINITION-FILE

Optional

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.

Type: option

-k | --installation-key INSTALLATION-KEY

Optional

Installation key for key-protected package. (either --installation-key or --installation-key-bypass is required)

Type: option

-x | --installation-key-bypass

Optional

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

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

Type: boolean

-p | --package PACKAGE

Optional

ID (starts with 0Ho) or alias of the package to create a version of.

Type: option

-d | --path PATH

Optional

Path to the directory that contains the contents of the package.

Type: option

--post-install-script POST-INSTALL-SCRIPT

Optional

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.

Type: option

--post-install-url POST-INSTALL-URL

Optional

Post-install instructions URL.

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

Type: option

--releasenotes-url RELEASENOTES-URL

Optional

Release notes URL.

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

Type: option

--skip-ancestor-check

Optional

Overrides ancestry requirements, which allows you to specify a package ancestor that isn’t the highest released package version.

Type: boolean

--skip-validation

Optional

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.

Type: boolean

--async-validation

Optional

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.

Type: boolean

-t | --tag TAG

Optional

Package version’s tag.

Type: option

--uninstall-script UNINSTALL-SCRIPT

Optional

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.

Type: option

-e | --version-description VERSION-DESCRIPTION

Optional

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

Type: option

-a | --version-name VERSION-NAME

Optional

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

Type: option

-n | --version-number VERSION-NUMBER

Optional

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.

Type: option

-w | --wait WAIT

Optional

Number of minutes to wait for the package version to be created.

Type: option

Default value: 0 minutes

--language LANGUAGE

Optional

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.

Type: option

--verbose

Optional

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.

Type: boolean

Aliases for package version create

force:package:version:create

Description for package version create list

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.

Examples for package version create list

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

Flags

--json

Optional

Format output as json.

Type: boolean

--flags-dir FLAGS-DIR

Optional

Import flag values from a directory.

Type: option

-v | --target-dev-hub TARGET-DEV-HUB

Required

Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.

Type: option

--api-version API-VERSION

Optional

Override the api version used for api requests made by this command

Type: option

-c | --created-last-days CREATED-LAST-DAYS

Optional

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

Type: option

-s | --status STATUS

Optional

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

Type: option

Permissible values are: Queued, InProgress, Success, Error

--show-conversions-only

Optional

Filter the list output to display only converted package version.

Type: boolean

--verbose

Optional

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

Type: boolean

Aliases for package version create list

force:package:version:create:list

Description for package version create report

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

Examples for package version create report

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

Flags

--json

Optional

Format output as json.

Type: boolean

--flags-dir FLAGS-DIR

Optional

Import flag values from a directory.

Type: option

-v | --target-dev-hub TARGET-DEV-HUB

Required

Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.

Type: option

--api-version API-VERSION

Optional

Override the api version used for api requests made by this command

Type: option

-i | --package-create-request-id PACKAGE-CREATE-REQUEST-ID

Required

ID (starts with 08c) of the package version creation request you want to display.

Type: option

Aliases for package version create report

force:package:version:create:report

Description for package version delete

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.

Examples for package version delete

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

Flags

--json

Optional

Format output as json.

Type: boolean

--flags-dir FLAGS-DIR

Optional

Import flag values from a directory.

Type: option

-v | --target-dev-hub TARGET-DEV-HUB

Required

Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.

Type: option

--api-version API-VERSION

Optional

Override the api version used for api requests made by this command

Type: option

-n | --no-prompt

Optional

Don’t prompt before deleting the package version.

Type: boolean

-p | --package PACKAGE

Required

ID (starts with 04t) or alias of the package version to delete.

Type: option

Aliases for package version delete

force:package:version:delete

Examples for package version displayancestry

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

Flags

--json

Optional

Format output as json.

Type: boolean

--flags-dir FLAGS-DIR

Optional

Import flag values from a directory.

Type: option

-v | --target-dev-hub TARGET-DEV-HUB

Required

Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.

Type: option

--api-version API-VERSION

Optional

Override the api version used for api requests made by this command

Type: option

-p | --package PACKAGE

Required

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.

Type: option

--dot-code

Optional

Display the ancestry tree in DOT code.

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

Type: boolean

--verbose

Optional

Display both the package version ID (starts with 04t) and the version number (major.minor.patch.build) in the ancestry tree.

Type: boolean

Aliases for package version displayancestry

force:package:version:displayancestry

Description for package version list

Description

Examples for package version list

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

Flags

--json

Optional

Format output as json.

Type: boolean

--flags-dir FLAGS-DIR

Optional

Import flag values from a directory.

Type: option

-v | --target-dev-hub TARGET-DEV-HUB

Required

Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.

Type: option

--api-version API-VERSION

Optional

Override the api version used for api requests made by this command

Type: option

-c | --created-last-days CREATED-LAST-DAYS

Optional

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

Type: option

--concise

Optional

Display limited package version details.

Type: boolean

--show-conversions-only

Optional

Filter the list output to display only converted package version.

Type: boolean

-m | --modified-last-days MODIFIED-LAST-DAYS

Optional

Number of days since the items were modified, starting at 00:00:00 of first day to now. Use 0 for today.

Type: option

-p | --packages PACKAGES

Optional

Comma-delimited list of packages (aliases or 0Ho IDs) to list.

Type: option

-r | --released

Optional

Display released versions only (IsReleased=true).

Type: boolean

-b | --branch BRANCH

Optional

Branch in your source control system used to filter the results; only package versions based on the specified branch are listed.

Type: option

-o | --order-by ORDER-BY

Optional

Package version fields used to order the list.

Type: option

--verbose

Optional

Display extended package version details.

Type: boolean

Aliases for package version list

force:package:version:list

Description for package version promote

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

Examples for package version promote

Promote the package version with the specified ID to released; uses your default Dev Hub org:

sf package version promote --package 04t...

Promote the package version with the specified alias to released; uses the Dev Hub org with username devhub@example.com:

sf package version promote --package awesome_package_alias --target-dev-hub devhub@example.com

Promote the package version with an alias that has spaces to released:

sf package version promote --package "Awesome Package Alias"

Flags

--json

Optional

Format output as json.

Type: boolean

--flags-dir FLAGS-DIR

Optional

Import flag values from a directory.

Type: option

-v | --target-dev-hub TARGET-DEV-HUB

Required

Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.

Type: option

--api-version API-VERSION

Optional

Override the api version used for api requests made by this command

Type: option

-p | --package PACKAGE

Required

ID (starts with 04t) or alias of the package version to promote.

Type: option

-n | --no-prompt

Optional

Don't prompt to confirm setting the package version as released.

Type: boolean

Aliases for package version promote

force:package:version:promote

Description for package version report

To update package version values, run "sf package version update".

Examples for package version report

Retrieve details about the package version with the specified ID from your default Dev Hub org:

sf package version report --package 04t...

Retrieve details about the package version with the specified alias (that contains spaces) from the Dev Hub org with username devhub@example.com:

sf package version report --package "Your Package Alias" --target-dev-hub devhub@example.com

Flags

--json

Optional

Format output as json.

Type: boolean

--flags-dir FLAGS-DIR

Optional

Import flag values from a directory.

Type: option

-v | --target-dev-hub TARGET-DEV-HUB

Required

Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.

Type: option

--api-version API-VERSION

Optional

Override the api version used for api requests made by this command

Type: option

-p | --package PACKAGE

Required

ID (starts with 04t) or alias of the package to retrieve details for.

Type: option

--verbose

Optional

Display extended package version details.

Type: boolean

Aliases for package version report

force:package:version:report

Description for package version update

Specify a new value for each option you want to update.

To display details about a package version, run "sf package version display".

Examples for package version update

Update the package version that has the specified alias (that contains spaces) with a new installation key "password123"; uses your default Dev Hub org:

sf package version update --package "Your Package Alias" --installation-key password123

Update the package version that has the specified ID with a new branch and tag; use the Dev Hub org with username devhub@example.com:

sf package version update --package 04t... --branch main --tag 'Release 1.0.7' --target-dev-hub devhub@example.com

Update the package version that has the specified ID with a new description:

sf package version update --package 04t... --version-description "New Package Version Description"

Flags

--json

Optional

Format output as json.

Type: boolean

--flags-dir FLAGS-DIR

Optional

Import flag values from a directory.

Type: option

-v | --target-dev-hub TARGET-DEV-HUB

Required

Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.

Type: option

--api-version API-VERSION

Optional

Override the api version used for api requests made by this command

Type: option

-p | --package PACKAGE

Required

ID (starts with 04t) or alias of the package to update a version of.

Type: option

-a | --version-name VERSION-NAME

Optional

New package version name.

Type: option

-e | --version-description VERSION-DESCRIPTION

Optional

New package version description.

Type: option

-b | --branch BRANCH

Optional

New package version branch.

Type: option

-t | --tag TAG

Optional

New package version tag.

Type: option

-k | --installation-key INSTALLATION-KEY

Optional

New installation key for key-protected package (default: null)

Type: option

Aliases for package version update

force:package:version:update