Product
Socket Now Supports uv.lock Files
Socket now supports uv.lock files to ensure consistent, secure dependency resolution for Python projects and enhance supply chain security.
By Trevor Norris - Jan 09, 2025
Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@salesforce/plugin-packaging
Advanced tools
What is @salesforce/plugin-packaging?
@salesforce/plugin-packaging is an npm package designed to help Salesforce developers manage and automate the packaging of Salesforce applications. It provides a set of CLI commands that facilitate the creation, versioning, and deployment of Salesforce packages.
What are @salesforce/plugin-packaging's main functionalities?
Create a Package
This command creates a new Salesforce package with the specified name, description, type, path, and target DevHub username.
sfdx force:package:create --name 'MyPackage' --description 'My new package' --packagetype 'Unlocked' --path 'force-app' --targetdevhubusername 'DevHub'List Packages
This command lists all the packages available in the specified DevHub.
sfdx force:package:list --targetdevhubusername 'DevHub'Create a Package Version
This command creates a new version of the specified package with an installation key and waits for the specified duration.
sfdx force:package:version:create --package 'MyPackage' --installationkey 'mykey' --wait 10 --targetdevhubusername 'DevHub'Promote a Package Version
This command promotes a specified package version to released status without prompting for confirmation.
sfdx force:package:version:promote --package 'MyPackage@1.0.0-1' --noprompt --targetdevhubusername 'DevHub'Install a Package
This command installs a specified package version into a target Salesforce org, with specified wait times for installation and publishing.
sfdx force:package:install --package 'MyPackage@1.0.0-1' --targetusername 'MyOrg' --wait 10 --publishwait 10Other packages similar to @salesforce/plugin-packaging
sfdx-cli
The sfdx-cli package is the official Salesforce CLI tool that provides a wide range of commands for Salesforce development, including packaging, metadata management, and org management. While it includes some packaging functionalities, it is broader in scope compared to @salesforce/plugin-packaging.
jsforce
The jsforce package is a powerful library for interacting with Salesforce APIs, including metadata and tooling APIs. While it can be used to manage packages programmatically, it is more general-purpose and not specifically focused on packaging like @salesforce/plugin-packaging.
plugin-packaging;
:warning: This plugin is currently in beta. We appreciate any feedback via https://github.com/forcedotcom/cli/issues
This plugin provides the sfdx cli commands that support Salesforce Packaging Platform
Install
sfdx plugins:install @salesforce/plugin-packaging@x.y.z
Issues
Please report any issues at https://github.com/forcedotcom/cli/issues
Contributing
- Please read our Code of Conduct
- Create a new issue before starting your project so that we can keep track of what you are trying to add/fix. That way, we can also offer suggestions or let you know if there is already an effort in progress.
- Fork this repository.
- Build the plugin locally
- Create a topic branch in your fork. Note, this step is recommended but technically not required if contributing using a fork.
- Edit the code in your fork.
- Write appropriate tests for your changes. Try to achieve at least 95% code coverage on any new code. No pull request will be accepted without unit tests.
- Sign CLA (see CLA below).
- Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in.
CLA
External contributors will be required to sign a Contributor's License Agreement. You can do so by going to https://cla.salesforce.com/sign-cla.
Build
To build the plugin locally, make sure to have yarn installed and run the following commands:
# Clone the repository
git clone git@github.com:salesforcecli/plugin-packaging.git
# Install the dependencies and compile
yarn install
yarn build
To use your plugin, run using the local ./bin/run or ./bin/run.cmd file.
# Run using local run file.
./bin/run package:create --help
There should be no differences when running via the Salesforce CLI or using the local run file. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine.
# Link your plugin to the sfdx cli
sfdx plugins:link .
# To verify
sfdx plugins
Commands
sfdx force:package1:beta:version:create -i <id> -n <string> [-d <string>] [-v <string>] [-m] [-r <url>] [-p <url>] [-k <string>] [-w <minutes>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:package1:beta:version:create:get -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:package1:beta:version:display -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:package1:beta:version:list [-i <id>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:package:beta:create -n <string> -t Managed|Unlocked -r <directory> [-d <string>] [-e] [--orgdependent] [-o <string>] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:package:beta:delete -p <string> [-n] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:package:beta:install -p <string> [-w <minutes>] [-k <string>] [-b <minutes>] [-r] [-a all|package] [-s AllUsers|AdminsOnly] [-t DeprecateOnly|Mixed|Delete] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:package:beta:install:report -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:package:beta:installed:list [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:package:beta:list [-v <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:package:beta:uninstall -p <string> [-w <minutes>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:package:beta:uninstall:report -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:package:beta:update -p <string> [-n <string>] [-d <string>] [-o <string>] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:package:beta:version:create [-b <string>] [-c | --skipvalidation] [-f <filepath>] [-k <string>] [-x] [-p <string>] [-d <directory>] [--postinstallscript <string>] [--postinstallurl <url>] [--releasenotesurl <url>] [--skipancestorcheck] [-t <string>] [--uninstallscript <string>] [-e <string>] [-a <string>] [-n <string>] [-w <minutes>] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:package:beta:version:create:list [-c <number>] [-s Queued|InProgress|Success|Error] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:package:beta:version:create:report -i <id> [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:package:beta:version:delete -p <string> [-n] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:package:beta:version:displayancestry -p <string> [--dotcode] [-v <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:package:beta:version:list [-c <number>] [-m <number>] [-p <array>] [-r] [-o <array>] [-v <string>] [--apiversion <string>] [--concise] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:package:beta:version:promote -p <string> [-n] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:package:beta:version:report -p <string> [-v <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx force:package:beta:version:update -p <string> [-a <string>] [-e <string>] [-b <string>] [-t <string>] [-k <string>] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx force:package1:beta:version:create -i <id> -n <string> [-d <string>] [-v <string>] [-m] [-r <url>] [-p <url>] [-k <string>] [-w <minutes>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
create a first-generation package version in the release org
USAGE
$ sfdx force:package1:beta:version:create -i <id> -n <string> [-d <string>] [-v <string>] [-m] [-r <url>] [-p <url>] [-k <string>] [-w
<minutes>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-d, --description=<value> package version description
-i, --packageid=<value> (required) ID of the metadata
package (starts with 033) of which
you’re creating a new version
-k, --installationkey=<value> installation key for key-protected
package (default: null)
-m, --managedreleased create a managed package version
-n, --name=<value> (required) package version name
-p, --postinstallurl=<value> post install URL
-r, --releasenotesurl=<value> release notes URL
-u, --targetusername=<value> username or alias for the target
org; overrides default target org
-v, --version=<value> package version in major.minor
format, for example, 3.2
-w, --wait=<value> minutes to wait for the package
version to be created (default: 2
minutes)
--apiversion=<value> override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
DESCRIPTION
create a first-generation package version in the release org
The package version is based on the contents of the specified metadata package. Omit -m if you want to create an
unmanaged package version.
See code: src/commands/force/package1/beta/version/create.ts
sfdx force:package1:beta:version:create:get -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
retrieve the status of a package version creation request
USAGE
$ sfdx force:package1:beta:version:create:get -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-i, --requestid=<value> (required) PackageUploadRequest ID
-u, --targetusername=<value> username or alias for the target
org; overrides default target org
--apiversion=<value> override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
DESCRIPTION
retrieve the status of a package version creation request
EXAMPLES
$ sfdx force:package1:version:create:get -i 0HD...
$ sfdx force:package1:version:create:get -i 0HD... -u devhub@example.com
See code: src/commands/force/package1/beta/version/create/get.ts
sfdx force:package1:beta:version:display -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
display details about a first-generation package version
USAGE
$ sfdx force:package1:beta:version:display -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-i, --packageversionid=<value> (required) metadata package version
ID (starts with 04t)
-u, --targetusername=<value> username or alias for the target
org; overrides default target org
--apiversion=<value> override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
DESCRIPTION
display details about a first-generation package version
See code: src/commands/force/package1/beta/version/display.ts
sfdx force:package1:beta:version:list [-i <id>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
list package versions for the specified first-generation package or for the org
USAGE
$ sfdx force:package1:beta:version:list [-i <id>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-i, --packageid=<value> metadata package ID (starts with
033)
-u, --targetusername=<value> username or alias for the target
org; overrides default target org
--apiversion=<value> override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
DESCRIPTION
list package versions for the specified first-generation package or for the org
See code: src/commands/force/package1/beta/version/list.ts
sfdx force:package:beta:create -n <string> -t Managed|Unlocked -r <directory> [-d <string>] [-e] [--orgdependent] [-o <string>] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
create a package
USAGE
$ sfdx force:package:beta:create -n <string> -t Managed|Unlocked -r <directory> [-d <string>] [-e] [--orgdependent] [-o
<string>] [-v <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-d, --description=<value> package description
-e, --nonamespace creates the package with no
namespace; available only for
unlocked packages.
-n, --name=<value> (required) package name
-o, --errornotificationusername=<value> active Dev Hub user designated to
receive email notifications for
package errors
-r, --path=<value> (required) path to directory that
contains the contents of the package
-t, --packagetype=(Managed|Unlocked) (required) package type
-v, --targetdevhubusername=<value> username or alias for the dev hub
org; overrides default dev hub org
--apiversion=<value> override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
--orgdependent depends on unpackaged metadata in
the installation org. Applies to
unlocked packages only.
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 --nonamespace.
Your --name value must be unique within your namespace.
Run 'sfdx force:package:list' to list all packages in the Dev Hub org.
EXAMPLES
$ sfdx force:package:create -n YourPackageName -t Unlocked -r force-app
$ sfdx force:package:create -n YourPackageName -d "Your Package Descripton" -t Unlocked -r force-app
See code: src/commands/force/package/beta/create.ts
sfdx force:package:beta:delete -p <string> [-n] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
delete a package
USAGE
$ sfdx force:package:beta:delete -p <string> [-n] [-v <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-n, --noprompt don’t prompt before deleting the
package
-p, --package=<value> (required) ID (starts with 0Ho) or
alias of the package to delete
-v, --targetdevhubusername=<value> username or alias for the dev hub
org; overrides default dev hub org
--apiversion=<value> override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
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.
EXAMPLES
$ sfdx force:package:delete -p "Your Package Alias"
$ sfdx force:package:delete -p 0Ho...
See code: src/commands/force/package/beta/delete.ts
sfdx force:package:beta:install -p <string> [-w <minutes>] [-k <string>] [-b <minutes>] [-r] [-a all|package] [-s AllUsers|AdminsOnly] [-t DeprecateOnly|Mixed|Delete] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
install a package in the target org
USAGE
$ sfdx force:package:beta:install -p <string> [-w <minutes>] [-k <string>] [-b <minutes>] [-r] [-a all|package] [-s
AllUsers|AdminsOnly] [-t DeprecateOnly|Mixed|Delete] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-a, --apexcompile=(all|package)
[default: all] compile all Apex in the org and package, or only Apex in the package; unlocked packages only
-b, --publishwait=<value>
number of minutes to wait for subscriber package version ID to become available in the target org
-k, --installationkey=<value>
installation key for key-protected package (default: null)
-p, --package=<value>
(required) ID (starts with 04t) or alias of the package version to install
-r, --noprompt
do not prompt for confirmation
-s, --securitytype=(AllUsers|AdminsOnly)
[default: AdminsOnly] security access type for the installed package (deprecation notice: The default --securitytype
value will change from AllUsers to AdminsOnly in v47.0 or later.)
-t, --upgradetype=(DeprecateOnly|Mixed|Delete)
[default: Mixed] the upgrade type for the package installation; available only for unlocked packages
-u, --targetusername=<value>
username or alias for the target org; overrides default target org
-w, --wait=<value>
number of minutes to wait for installation status
--apiversion=<value>
override the api version used for api requests made by this command
--json
format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)
[default: warn] logging level for this command invocation
DESCRIPTION
install a package in the target org
Supply the ID of the package version to install. The package installs in your default target org unless you supply the
username for a different target org.
For package upgrades, to specify options for component deprecation or deletion of removed components, include an
--upgradetype value. To delete components that can be safely deleted and deprecate the others, specify --upgradetype
Mixed (the default). To deprecate all removed components, specify --upgradetype DeprecateOnly. To delete all removed
components, except for custom objects and custom fields, that don't have dependencies, specify --upgradetype Delete.
(Note: This option can result in the loss of data that is associated with the deleted components.) The default is
Mixed.
EXAMPLES
$ sfdx force:package:beta:install --package 04t... -u me@example.com
$ sfdx force:package:beta:install --package awesome_package_alias
$ sfdx force:package:beta:install --package "Awesome Package Alias"
$ sfdx force:package:beta:install --package 04t... -t DeprecateOnly
See code: src/commands/force/package/beta/install.ts
sfdx force:package:beta:install:report -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
retrieve the status of a package installation request
USAGE
$ sfdx force:package:beta:install:report -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-i, --requestid=<value> (required) ID of the package install
request you want to check
-u, --targetusername=<value> username or alias for the target
org; overrides default target org
--apiversion=<value> override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
DESCRIPTION
retrieve the status of a package installation request
EXAMPLES
$ sfdx force:package:install:report -i 0Hf...
$ sfdx force:package:install:report -i 0Hf... -u me@example.com
See code: src/commands/force/package/beta/install/report.ts
sfdx force:package:beta:installed:list [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
list the org’s installed packages
USAGE
$ sfdx force:package:beta:installed:list [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-u, --targetusername=<value> username or alias for the target
org; overrides default target org
--apiversion=<value> override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
DESCRIPTION
list the org’s installed packages
EXAMPLES
$ sfdx force:package:installed:list
$ sfdx force:package:installed:list -u me@example.com
See code: src/commands/force/package/beta/installed/list.ts
sfdx force:package:beta:list [-v <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
list all packages in the Dev Hub org
USAGE
$ sfdx force:package:beta:list [-v <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-v, --targetdevhubusername=<value> username or alias for the dev hub
org; overrides default dev hub org
--apiversion=<value> override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
--verbose display extended package detail
DESCRIPTION
list all packages in the Dev Hub org
You can view the namespace, IDs, and other details for each package.
EXAMPLES
$ sfdx force:package:list -v devhub@example.com
$ sfdx force:package:list -v devhub@example.com --verbose
See code: src/commands/force/package/beta/list.ts
sfdx force:package:beta:uninstall -p <string> [-w <minutes>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
uninstall a second-generation package from the target org
USAGE
$ sfdx force:package:beta:uninstall -p <string> [-w <minutes>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-p, --package=<value> (required) ID (starts with 04t) or
alias of the package version to
uninstall
-u, --targetusername=<value> username or alias for the target
org; overrides default target org
-w, --wait=<value> [default: 0 minutes] number of
minutes to wait for uninstall status
--apiversion=<value> override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
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 "sfdx force:package:beta:installed:list".
To uninstall a first-generation package, from Setup, enter Installed Packages in the Quick Find box, then select
Installed Packages.
EXAMPLES
$ sfdx force:package:beta:uninstall -p 04t... -u me@example.com
$ sfdx force:package:beta:uninstall -p undesirable_package_alias
$ sfdx force:package:beta:uninstall -p "Undesirable Package Alias"
See code: src/commands/force/package/beta/uninstall.ts
sfdx force:package:beta:uninstall:report -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
retrieve status of package uninstall request
USAGE
$ sfdx force:package:beta:uninstall:report -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-i, --requestid=<value> (required) ID of the package
uninstall request you want to check
-u, --targetusername=<value> username or alias for the target
org; overrides default target org
--apiversion=<value> override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
DESCRIPTION
retrieve status of package uninstall request
EXAMPLES
$ sfdx force:package:beta:uninstall:report -i 06y...
$ sfdx force:package:beta:uninstall:report -i 06y... -u me@example.com
See code: src/commands/force/package/beta/uninstall/report.ts
sfdx force:package:beta:update -p <string> [-n <string>] [-d <string>] [-o <string>] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
update package details
USAGE
$ sfdx force:package:beta:update -p <string> [-n <string>] [-d <string>] [-o <string>] [-v <string>] [--apiversion <string>]
[--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-d, --description=<value> new package description
-n, --name=<value> new package name
-o, --errornotificationusername=<value> active Dev Hub user designated to
receive email notifications for
package errors
-p, --package=<value> (required) ID (starts with 0Ho) or
alias of the package to update
-v, --targetdevhubusername=<value> username or alias for the dev hub
org; overrides default dev hub org
--apiversion=<value> override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
DESCRIPTION
update package details
Specify a new value for each option you want to update.
Run "sfdx force:package:list" to list all packages in the Dev Hub org.
EXAMPLES
$ sfdx force:package:update -p "Your Package Alias" -n "New Package Name"
$ sfdx force:package:update -p 0Ho... -d "New Package Description"
See code: src/commands/force/package/beta/update.ts
sfdx force:package:beta:version:create [-b <string>] [-c | --skipvalidation] [-f <filepath>] [-k <string>] [-x] [-p <string>] [-d <directory>] [--postinstallscript <string>] [--postinstallurl <url>] [--releasenotesurl <url>] [--skipancestorcheck] [-t <string>] [--uninstallscript <string>] [-e <string>] [-a <string>] [-n <string>] [-w <minutes>] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
create a package version
USAGE
$ sfdx force:package:beta:version:create [-b <string>] [-c | --skipvalidation] [-f <filepath>] [-k <string>] [-x] [-p <string>] [-d
<directory>] [--postinstallscript <string>] [--postinstallurl <url>] [--releasenotesurl <url>] [--skipancestorcheck]
[-t <string>] [--uninstallscript <string>] [-e <string>] [-a <string>] [-n <string>] [-w <minutes>] [-v <string>]
[--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-a, --versionname=<value> the name of the package version to
be created
-b, --branch=<value> the package version’s branch
-c, --codecoverage calculate the code coverage by
running the packaged Apex tests
-d, --path=<value> path to directory that contains the
contents of the package
-e, --versiondescription=<value> the description of the package
version to be created
-f, --definitionfile=<value> 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, --installationkey=<value> installation key for key-protected
package (either --installationkey or
--installationkeybypass is required)
-n, --versionnumber=<value> the version number of the package
version to be created
-p, --package=<value> ID (starts with 0Ho) or alias of the
package to create a version of
-t, --tag=<value> the package version’s tag
-v, --targetdevhubusername=<value> username or alias for the dev hub
org; overrides default dev hub org
-w, --wait=<value> [default: 0 minutes] minutes to wait
for the package version to be
created
-x, --installationkeybypass bypass the installation key
requirement (either
--installationkey or
--installationkeybypass is required)
--apiversion=<value> override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
--postinstallscript=<value> post-install script name; managed
packages only
--postinstallurl=<value> post-install URL
--releasenotesurl=<value> release notes URL
--skipancestorcheck Overrides ancestry requirements.
--skipvalidation skip validation during package
version creation; you can’t promote
unvalidated package versions
--uninstallscript=<value> uninstall script name; managed
packages only
DESCRIPTION
create a package version
EXAMPLES
$ sfdx force:package:version:create -d common -k password123
$ sfdx force:package:version:create -p "Your Package Alias" -k password123
$ sfdx force:package:version:create -p 0Ho... -k password123
$ sfdx force:package:version:create -d common -k password123 --skipvalidation
See code: src/commands/force/package/beta/version/create.ts
sfdx force:package:beta:version:create:list [-c <number>] [-s Queued|InProgress|Success|Error] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
list package version creation requests
USAGE
$ sfdx force:package:beta:version:create:list [-c <number>] [-s Queued|InProgress|Success|Error] [-v <string>] [--apiversion <string>]
[--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-c, --createdlastdays=<value> created in the last specified number
of days (starting at 00:00:00 of
first day to now; 0 for today)
-s, --status=(Queued|InProgress|Success|Error) filter the list by version creation
request status
-v, --targetdevhubusername=<value> username or alias for the dev hub
org; overrides default dev hub org
--apiversion=<value> override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
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 "sfdx force:package:version:create:report" and supply the request ID.
EXAMPLES
$ sfdx force:package:version:create:list
$ sfdx force:package:version:create:list --createdlastdays 3
$ sfdx force:package:version:create:list --status Error
$ sfdx force:package:version:create:list -s InProgress
$ sfdx force:package:version:create:list -c 3 -s Success
See code: src/commands/force/package/beta/version/create/list.ts
sfdx force:package:beta:version:create:report -i <id> [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
retrieve details about a package version creation request
USAGE
$ sfdx force:package:beta:version:create:report -i <id> [-v <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-i, --packagecreaterequestid=<value> (required) package version creation
request ID (starts with 08c)
-v, --targetdevhubusername=<value> username or alias for the dev hub
org; overrides default dev hub org
--apiversion=<value> override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
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 "sfdx force:package:version:create:list".
EXAMPLES
$ sfdx force:package:version:create:report -i 08c...
$ sfdx force:package:version:create:report -i 08c... -v devhub@example.com
See code: src/commands/force/package/beta/version/create/report.ts
sfdx force:package:beta:version:delete -p <string> [-n] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
delete a package version
USAGE
$ sfdx force:package:beta:version:delete -p <string> [-n] [-v <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-n, --noprompt don’t prompt before deleting the
package version
-p, --package=<value> (required) ID (starts with 04t) or
alias of the package to update a
version of
-v, --targetdevhubusername=<value> username or alias for the dev hub
org; overrides default dev hub org
--apiversion=<value> override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
DESCRIPTION
delete a package version
Specify the ID or alias of the package version you want to delete.
EXAMPLES
$ sfdx force:package:version:delete -p "Your Package Alias"
$ sfdx force:package:version:delete -p 04t...
See code: src/commands/force/package/beta/version/delete.ts
sfdx force:package:beta:version:displayancestry -p <string> [--dotcode] [-v <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
display the ancestry tree for a 2GP managed package version
USAGE
$ sfdx force:package:beta:version:displayancestry -p <string> [--dotcode] [-v <string>] [--apiversion <string>] [--verbose] [--json]
[--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-p, --package=<value> (required) ID or alias of the
package (starts with 0Ho) or package
version (starts with 04t) to display
ancestry for
-v, --targetdevhubusername=<value> username or alias for the dev hub
org; overrides default dev hub org
--apiversion=<value> override the api version used for
api requests made by this command
--dotcode display the ancestry tree in DOT
code
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
--verbose display both the package version ID
(starts with 04t) and the version
number (major.minor.patch.build) in
the ancestry tree
DESCRIPTION
display the ancestry tree for a 2GP managed package version
EXAMPLES
$ sfdx force:package:version:displayancestry -p package_version_alias
$ sfdx force:package:version:displayancestry -p package_version_alias --dotcode
$ sfdx force:package:version:displayancestry -p OHo...
$ sfdx force:package:version:displayancestry -p 04t...
See code: src/commands/force/package/beta/version/displayancestry.ts
sfdx force:package:beta:version:list [-c <number>] [-m <number>] [-p <array>] [-r] [-o <array>] [-v <string>] [--apiversion <string>] [--concise] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
list all package versions in the Dev Hub org.
USAGE
$ sfdx force:package:beta:version:list [-c <number>] [-m <number>] [-p <array>] [-r] [-o <array>] [-v <string>] [--apiversion
<string>] [--concise] [--verbose] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-c, --createdlastdays=<value> created in the last specified number
of days (starting at 00:00:00 of
first day to now; 0 for today)
-m, --modifiedlastdays=<value> list items modified in the specified
last number of days (starting at
00:00:00 of first day to now; 0 for
today)
-o, --orderby=<value> order by the specified package
version fields
-p, --packages=<value> filter results on specified
comma-delimited packages (aliases or
0Ho IDs)
-r, --released display released versions only
-v, --targetdevhubusername=<value> username or alias for the dev hub
org; overrides default dev hub org
--apiversion=<value> override the api version used for
api requests made by this command
--concise display limited package version
details
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
--verbose display extended package version
details
DESCRIPTION
list all package versions in the Dev Hub org.
Displays details of each package version in the org.
Use --concise or --verbose to display limited or additional details, respectively.
All filter parameters are applied using the AND logical operator (not OR).
EXAMPLES
$ sfdx force:package:version:list --verbose --createdlastdays 3 --released --orderby PatchVersion
$ sfdx force:package:version:list --packages 0Ho000000000000,0Ho000000000001 --released --modifiedlastdays 0
$ sfdx force:package:version:list --released
$ sfdx force:package:version:list --concise --modifiedlastdays 0
$ sfdx force:package:version:list --concise -c 3 -r
$ sfdx force:package:version:list --packages exp-mgr,exp-mgr-util --released --modifiedlastdays 0
See code: src/commands/force/package/beta/version/list.ts
sfdx force:package:beta:version:promote -p <string> [-n] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
promote a package version to released
USAGE
$ sfdx force:package:beta:version:promote -p <string> [-n] [-v <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-n, --noprompt no prompt to confirm setting the
package version as released
-p, --package=<value> (required) ID (starts with 04t) or
alias of the package version to
promote
-v, --targetdevhubusername=<value> username or alias for the dev hub
org; overrides default dev hub org
--apiversion=<value> override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
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.
EXAMPLES
$ sfdx force:package:version:promote -p 04t...
$ sfdx force:package:version:promote -p awesome_package_alias
$ sfdx force:package:version:promote -p "Awesome Package Alias"
See code: src/commands/force/package/beta/version/promote.ts
sfdx force:package:beta:version:report -p <string> [-v <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
retrieve details about a package version in the Dev Hub org
USAGE
$ sfdx force:package:beta:version:report -p <string> [-v <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-p, --package=<value> (required) ID (starts with 04t) or
alias of the package to retrieve
details for
-v, --targetdevhubusername=<value> username or alias for the dev hub
org; overrides default dev hub org
--apiversion=<value> override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
--verbose displays extended package version
details
DESCRIPTION
retrieve details about a package version in the Dev Hub org
To update package version values, run "sfdx force:package:version:update".
EXAMPLES
$ sfdx force:package:version:report -p 04t...
$ sfdx force:package:version:report -p "Your Package Alias"
See code: src/commands/force/package/beta/version/report.ts
sfdx force:package:beta:version:update -p <string> [-a <string>] [-e <string>] [-b <string>] [-t <string>] [-k <string>] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
update a package version
USAGE
$ sfdx force:package:beta:version:update -p <string> [-a <string>] [-e <string>] [-b <string>] [-t <string>] [-k <string>] [-v
<string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-a, --versionname=<value> new package version name
-b, --branch=<value> new package version branch
-e, --versiondescription=<value> new package version description
-k, --installationkey=<value> new installation key for
key-protected package (default:
null)
-p, --package=<value> (required) ID (starts with 04t) or
alias of the package to update a
version of
-t, --tag=<value> new package version tag
-v, --targetdevhubusername=<value> username or alias for the dev hub
org; overrides default dev hub org
--apiversion=<value> override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
DESCRIPTION
update a package version
Specify a new value for each option you want to update.
To display details about a package version, run "sfdx force:package:version:report".
EXAMPLES
$ sfdx force:package:version:update -p "Your Package Alias" -k password123
$ sfdx force:package:version:update -p 04t... -b main -t 'Release 1.0.7'
$ sfdx force:package:version:update -p 04t... -e "New Package Version Description"
1.9.0 (2022-09-13)
Bug Fixes
- add direct chalk dependency (11e7b49)
- add direct chalk dependency (cf18904)
- add force:package:beta:install:report command (1044e0e)
- add package version displayancestry command (30f6d5b)
- add package:beta:update, NUT (80ade7b)
- add package:beta:version:promote and NUT (8db94c2)
- add package:beta:version:update and NUT (1ac77a8)
- add package:uninstall command (86db455)
- add package:version:create:list command, NUT (5a4e558)
- add package:version:uninstall:report command, NUT, cleanup SfError/message (d9f72f2)
- add package1:beta:version:create:get command, UTs, placeholder NUT (9d3f4f5)
- add package1:version:list command, UTs, NUTs (ecfbcd4)
- add pvr and pvcr (79d27cf)
- add spinner and fix perserve file location msg (7d732ae)
- adds unit tests and NUTs (24dbd52)
- apply fixes for qa issues (7a944da)
- build out some of pvl - not building (7c166a3)
- bump packaging lib version (ab11694)
- bump packaging library (759b31e)
- bump version number to 1.1.1 (d472ff1)
- bump version of package lib (5a93522)
- correct output (40662fc)
- edit messages for cli ref (afd97a2)
- edit messages for cli ref (9d8ad57)
- edit messages for cli ref (70a6f16)
- edit messages for cli ref (c1135e1)
- edit messages so they don't break the cli ref command generator (7554897)
- finish pvl, add NUT (a4fe3f0)
- force version bump (7c2c878)
- keep only examples in #examples section (44a13c9)
- lint fixes (ac8cceb)
- look up 05i id if 04t is found for package:promote (256dbdb)
- make command output clearer for un-implemented commands (65cab44)
- messages files are breaking the CLI Ref command generation (9da58a6)
- only examples in # examples sections (d68d002)
- only examples in #example section (23195a2)
- only examples in #examples section (08492cd)
- only examples in #examples section (d3c0b5f)
- only required refactoring - waiting on packaging to enable na40 to convert (c81f083)
- package list (9d88ff5)
- package:installed:list command (3169872)
- pass installation key when getting external sites (982a2f2)
- pkg create and delete commands (f872b2b)
- pkg create and delete commands (c71ca30)
- remove longDescription and help for description (8ea4663)
- return results even if not json (b08c91b)
- several fixes for pkg commands (22c81af)
- several fixes for pkg commands (bc1614d)
- some install command work (1adbf01)
- some install command work (1adfd60)
- suppot 15-char IDs (0674125)
- type on event consumer for pvc (e4200cc)
- update README and fix test output (ad00150)
- update tests (fe81cab)
- update version number (f4f6989)
- use correct message based on flags (84a3d96)
- use os specific line endings (fd431e8)
Features
FAQs
SF plugin that support Salesforce Packaging Platform
The npm package @salesforce/plugin-packaging receives a total of 90,605 weekly downloads. As such, @salesforce/plugin-packaging popularity was classified as popular.
We found that @salesforce/plugin-packaging demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Package last updated on 09 Sep 2022
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Related posts
Research
Security News
Gmail For Exfiltration: Malicious npm Packages Target Solana Private Keys and Drain Victims' Wallets
Socket researchers have discovered multiple malicious npm packages targeting Solana private keys, abusing Gmail to exfiltrate the data and drain Solana wallets.
By Kirill Boychenko - Jan 08, 2025
Security News
New Python Packaging Proposal Aims to Solve Phantom Dependency Problem with SBOMs
PEP 770 proposes adding SBOM support to Python packages to improve transparency and catch hidden non-Python dependencies that security tools often miss.
By Sarah Gooding - Jan 07, 2025