{ "commands": { "package:convert": { "aliases": [ "force:package:convert" ], "args": {}, "deprecateAliases": true, "description": "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.\n\nUse --patch-version to specify a released patch version.\n\nTo retrieve details about a package version create request, including status and package version ID (04t), run \"<%= config.bin %> package version create report -i 08c...\".\n\nTo protect the contents of your package and to prevent unauthorized installation of your package, specify the --installation-key flag.\n\nTo promote a package version to released, you must use the --code-coverage parameter. The package must also meet the code coverage requirements.\n\nTo list package version creation requests in the org, run \"<%= config.bin %> package version create list\".", "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:\n<%= config.bin %> <%= command.id %> --package 033... --installation-key password123", "Similar to previous example, but uses the specified Dev Hub org:\n<%= config.bin %> <%= command.id %> --package 033... --installation-key password123 --target-dev-hub devhuborg@example.com" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-dev-hub": { "aliases": [ "targetdevhubusername", "target-hub-org" ], "char": "v", "deprecateAliases": true, "name": "target-dev-hub", "noCacheDefault": true, "required": true, "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "package": { "char": "p", "name": "package", "required": true, "summary": "ID (starts with 033) of the first-generation managed package to convert.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "installation-key": { "aliases": [ "installationkey" ], "char": "k", "deprecateAliases": true, "description": "Either an --installation-key value or the --installation-key-bypass flag is required.", "name": "installation-key", "summary": "Installation key for key-protected package.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "definition-file": { "aliases": [ "definitionfile" ], "char": "f", "deprecateAliases": true, "description": "This definition file is similar to the scratch org definition file.", "name": "definition-file", "summary": "Path to a definition file that contains features and org preferences that the metadata of the package version depends on.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "installation-key-bypass": { "aliases": [ "installationkeybypass" ], "char": "x", "deprecateAliases": true, "description": "If you bypass this requirement, anyone can install your package. Either an --installation-key value or the --installation-key-bypass flag is required.", "name": "installation-key-bypass", "summary": "Bypass the installation key requirement.", "allowNo": false, "type": "boolean" }, "wait": { "char": "w", "name": "wait", "summary": "Minutes to wait for the package version to be created.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "build-instance": { "aliases": [ "buildinstance" ], "char": "s", "deprecateAliases": true, "hidden": true, "name": "build-instance", "summary": "Instance where the conversion package version will be created, such as NA50.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "seed-metadata": { "char": "m", "description": "The directory containing metadata that will be deployed on the build org prior to attempting package conversion.", "name": "seed-metadata", "summary": "Directory containing metadata to be deployed prior to conversion.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "verbose": { "name": "verbose", "summary": "Display verbose command output.", "allowNo": false, "type": "boolean" }, "patch-version": { "aliases": [ "patchversion" ], "char": "a", "deprecateAliases": true, "description": "Specify a released patch version as major.minor.patch to convert to a second-generation managed package version.", "name": "patch-version", "summary": "Specific released patch version to be converted.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "code-coverage": { "char": "c", "description": "Before you can promote and release a managed package version, the Apex code must meet a minimum 75% code coverage requirement.", "name": "code-coverage", "summary": "Calculate and store the code coverage percentage by running the packaged Apex tests included in this package version.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "package:convert", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "strict": true, "summary": "Convert a managed-released first-generation managed package into a second-generation managed package.", "enableJsonFlag": true, "requiresProject": true, "isESM": true, "relativePath": [ "lib", "commands", "package", "convert.js" ], "aliasPermutations": [ "force:package:convert", "package:force:convert", "package:convert:force", "force:convert:package", "convert:force:package", "convert:package:force" ], "permutations": [ "package:convert", "convert:package" ] }, "package:create": { "aliases": [ "force:package:create" ], "args": {}, "deprecateAliases": true, "description": "First, use this command to create a package. Then create a package version.\n\nIf you don’t have a namespace defined in your sfdx-project.json file, use --no-namespace.\n\nYour --name value must be unique within your namespace.\n\nRun '<%= config.bin %> package list to list all packages in the Dev Hub org.", "examples": [ "Create an unlocked package from the files in the \"force-app\" directory; uses your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --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:\n<%= config.bin %> <%= command.id %> --name MyManagedPackage --description \"Your Package Descripton\" --package-type Managed --path force-app --target-dev-hub devhub@example.com" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-dev-hub": { "aliases": [ "targetdevhubusername", "target-hub-org" ], "char": "v", "deprecateAliases": true, "name": "target-dev-hub", "noCacheDefault": true, "required": true, "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "char": "n", "name": "name", "required": true, "summary": "Name of the package to create.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "package-type": { "aliases": [ "packagetype" ], "char": "t", "deprecateAliases": true, "description": "The options for package type are Managed and Unlocked (Managed=DeveloperManagedSubscriberManaged, Unlocked=DeveloperControlledSubscriberEditable). These options determine upgrade and editability rules.", "name": "package-type", "required": true, "summary": "Type of package.", "hasDynamicHelp": false, "multiple": false, "options": [ "Managed", "Unlocked" ], "type": "option" }, "description": { "char": "d", "name": "description", "summary": "Description of the package.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-namespace": { "aliases": [ "nonamespace" ], "char": "e", "deprecateAliases": true, "description": "This flag is useful when you’re migrating an existing org to packages. But use a namespaced package for new metadata.", "name": "no-namespace", "summary": "Create the package with no namespace; available only for unlocked packages.", "allowNo": false, "type": "boolean" }, "path": { "char": "r", "name": "path", "required": true, "summary": "Path to directory that contains the contents of the package.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "org-dependent": { "aliases": [ "orgdependent" ], "deprecateAliases": true, "description": "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.", "name": "org-dependent", "summary": "Depends on unpackaged metadata in the installation org; applies to unlocked packages only.", "allowNo": false, "type": "boolean" }, "error-notification-username": { "aliases": [ "errornotificationusername" ], "char": "o", "deprecateAliases": true, "description": "Email notifications include information about unhandled Apex exceptions, and install, upgrade, or uninstall failures associated with your package.", "name": "error-notification-username", "summary": "Active Dev Hub user designated to receive email notifications for package errors.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "package:create", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "strict": true, "summary": "Create a package.", "enableJsonFlag": true, "requiresProject": true, "isESM": true, "relativePath": [ "lib", "commands", "package", "create.js" ], "aliasPermutations": [ "force:package:create", "package:force:create", "package:create:force", "force:create:package", "create:force:package", "create:package:force" ], "permutations": [ "package:create", "create:package" ] }, "package:delete": { "aliases": [ "force:package:delete" ], "args": {}, "deprecateAliases": true, "description": "Specify the ID or alias of the package you want to delete.\n\nDelete unlocked and second-generation managed packages. Before you delete a package, first delete all associated package versions.", "examples": [ "Delete a package using its alias from your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --package \"Your Package Alias\"", "Delete a package using its ID from the specified Dev Hub org:\n<%= config.bin %> <%= command.id %> --package 0Ho... --target-dev-hub devhub@example.com" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-dev-hub": { "aliases": [ "targetdevhubusername", "target-hub-org" ], "char": "v", "deprecateAliases": true, "name": "target-dev-hub", "noCacheDefault": true, "required": true, "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-prompt": { "aliases": [ "noprompt" ], "char": "n", "deprecateAliases": true, "name": "no-prompt", "summary": "Don't prompt before deleting the package.", "allowNo": false, "type": "boolean" }, "package": { "char": "p", "name": "package", "required": true, "summary": "ID (starts with 0Ho) or alias of the package to delete.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "undelete": { "hidden": true, "name": "undelete", "summary": "Undelete a deleted package.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "package:delete", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "strict": true, "summary": "Delete a package.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "package", "delete.js" ], "aliasPermutations": [ "force:package:delete", "package:force:delete", "package:delete:force", "force:delete:package", "delete:force:package", "delete:package:force" ], "permutations": [ "package:delete", "delete:package" ] }, "package:install": { "aliases": [ "force:package:install" ], "args": {}, "deprecateAliases": true, "description": "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.\n\nWhen 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": [ "Install or upgrade a package version with the specified ID in the org with username \"me@example.com\":\n<%= config.bin %> <%= command.id %> --package 04t... --target-org me@example.com", "Install or upgrade a package version with the specified alias into your default org:\n<%= config.bin %> <%= command.id %> --package awesome_package_alias", "Install or upgrade a package version with an alias that includes spaces into your default org:\n<%= config.bin %> <%= command.id %> --package \"Awesome Package Alias\"", "Upgrade an unlocked package version with the specified ID and deprecate all removed components:\n<%= config.bin %> <%= command.id %> --package 04t... --upgrade-type DeprecateOnly" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-org": { "aliases": [ "targetusername", "u" ], "char": "o", "deprecateAliases": true, "name": "target-org", "noCacheDefault": true, "required": true, "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "wait": { "char": "w", "name": "wait", "summary": "Number of minutes to wait for installation status.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "installation-key": { "aliases": [ "installationkey" ], "char": "k", "deprecateAliases": true, "name": "installation-key", "summary": "Installation key for key-protected package (default: null).", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "publish-wait": { "aliases": [ "publishwait" ], "char": "b", "deprecateAliases": true, "name": "publish-wait", "summary": "Maximum number of minutes to wait for the Subscriber Package Version ID to become available in the target org before canceling the install request.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "no-prompt": { "aliases": [ "noprompt" ], "char": "r", "deprecateAliases": true, "description": "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.", "name": "no-prompt", "summary": "Don't prompt for confirmation.", "allowNo": false, "type": "boolean" }, "package": { "char": "p", "name": "package", "required": true, "summary": "ID (starts with 04t) or alias of the package version to install.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "apex-compile": { "aliases": [ "apexcompile" ], "char": "a", "deprecateAliases": true, "description": "Applies to unlocked packages only. Specifies whether to compile all Apex in the org and package, or only the Apex in the package.\n\nFor 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.\n\nThis 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.", "name": "apex-compile", "summary": "Compile all Apex in the org and package, or only Apex in the package; unlocked packages only.", "default": "all", "hasDynamicHelp": false, "multiple": false, "options": [ "all", "package" ], "type": "option" }, "security-type": { "aliases": [ "securitytype" ], "char": "s", "deprecateAliases": true, "name": "security-type", "summary": "Security access type for the installed package. Available options are AdminsOnly and AllUsers.", "default": "AdminsOnly", "hasDynamicHelp": false, "multiple": false, "options": [ "AllUsers", "AdminsOnly" ], "type": "option" }, "upgrade-type": { "aliases": [ "upgradetype" ], "char": "t", "deprecateAliases": true, "description": "For unlocked package upgrades, set this flag to one of these values:\n\n- DeprecateOnly: Mark all removed components as deprecated.\n- Mixed: Delete all removed components that can be safely deleted and deprecate the other components.\n- Delete: Delete removed components, except for custom objects and custom fields, that don't have dependencies.", "name": "upgrade-type", "summary": "Upgrade type for the package installation; available only for unlocked packages.", "default": "Mixed", "hasDynamicHelp": false, "multiple": false, "options": [ "DeprecateOnly", "Mixed", "Delete" ], "type": "option" }, "skip-handlers": { "char": "l", "description": "Allows the installer of a package to optionally skip install handlers in order to decrease overall installation time (available handlers: FeatureEnforcement).", "hidden": true, "name": "skip-handlers", "summary": "Skip install handlers (available handlers: FeatureEnforcement).", "hasDynamicHelp": false, "multiple": true, "options": [ "FeatureEnforcement" ], "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "package:install", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "strict": true, "summary": "Install or upgrade a version of a package in the target org.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "package", "install.js" ], "aliasPermutations": [ "force:package:install", "package:force:install", "package:install:force", "force:install:package", "install:force:package", "install:package:force" ], "permutations": [ "package:install", "install:package" ] }, "package:list": { "aliases": [ "force:package:list" ], "args": {}, "deprecateAliases": true, "description": "Description", "examples": [ "List all packages in the specified Dev Hub org:\n<%= config.bin %> <%= command.id %> --target-dev-hub devhub@example.com", "List all packages details in the specified Dev Hub org, and show extended details about each package:\n<%= config.bin %> <%= command.id %> --target-dev-hub devhub@example.com --verbose" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-dev-hub": { "aliases": [ "targetdevhubusername", "target-hub-org" ], "char": "v", "deprecateAliases": true, "name": "target-dev-hub", "noCacheDefault": true, "required": true, "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "verbose": { "name": "verbose", "summary": "Display extended package detail.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "package:list", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "strict": true, "summary": "List all packages in the Dev Hub org.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "package", "list.js" ], "aliasPermutations": [ "force:package:list", "package:force:list", "package:list:force", "force:list:package", "list:force:package", "list:package:force" ], "permutations": [ "package:list", "list:package" ] }, "package:uninstall": { "aliases": [ "force:package:uninstall" ], "args": {}, "deprecateAliases": true, "description": "Specify the package ID for a second-generation package.\n\nTo list the org’s installed packages, run \"<%= config.bin %> package installed list\".\n\nTo uninstall a first-generation package, from Setup, enter Installed Packages in the Quick Find box, then select Installed Packages.", "examples": [ "Uninstall a package with specified ID from an org with username me@example.com:\n<%= config.bin %> <%= command.id %> --package 04t... --target-org me@example.com", "Uninstall a package with the specified alias from your default org:\n<%= config.bin %> <%= command.id %> --package undesirable_package_alias", "Uninstall a package with an alias that contains spaces from your default org:\n<%= config.bin %> <%= command.id %> --package \"Undesirable Package Alias\"" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-org": { "aliases": [ "targetusername", "u" ], "char": "o", "deprecateAliases": true, "name": "target-org", "noCacheDefault": true, "required": true, "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "wait": { "char": "w", "name": "wait", "summary": "Number of minutes to wait for uninstall status.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "package": { "char": "p", "name": "package", "required": true, "summary": "ID (starts with 04t) or alias of the package version to uninstall.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "package:uninstall", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "strict": true, "summary": "Uninstall a second-generation package from the target org.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "package", "uninstall.js" ], "aliasPermutations": [ "force:package:uninstall", "package:force:uninstall", "package:uninstall:force", "force:uninstall:package", "uninstall:force:package", "uninstall:package:force" ], "permutations": [ "package:uninstall", "uninstall:package" ] }, "package:update": { "aliases": [ "force:package:update" ], "args": {}, "deprecateAliases": true, "description": "Specify a new value for each option you want to update.\n\nRun \"<%= config.bin %> package list\" to list all packages in the Dev Hub org.", "examples": [ "Update the name of the package with the specified alias; uses your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --package \"Your Package Alias\" --name \"New Package Name\"", "Update the description of the package with the specified ID; uses the specified Dev Hub org:\n<%= config.bin %> <%= command.id %> --package 0Ho... --description \"New Package Description\" --target-dev-hub devhub@example.com" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-dev-hub": { "aliases": [ "targetdevhubusername", "target-hub-org" ], "char": "v", "deprecateAliases": true, "name": "target-dev-hub", "noCacheDefault": true, "required": true, "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "package": { "char": "p", "name": "package", "required": true, "summary": "ID (starts with 0Ho) or alias of the package to update.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "char": "n", "name": "name", "summary": "New name of the package.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "description": { "char": "d", "name": "description", "summary": "New description of the package.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "error-notification-username": { "aliases": [ "errornotificationusername" ], "char": "o", "deprecateAliases": true, "description": "Email notifications include information about unhandled Apex exceptions, and install, upgrade, or uninstall failures associated with your package.", "name": "error-notification-username", "summary": "Active Dev Hub user designated to receive email notifications for package errors.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "enable-app-analytics": { "name": "enable-app-analytics", "summary": "Enable AppExchange App Analytics usage data collection on this managed package and its components.", "allowNo": true, "type": "boolean" }, "recommended-version-id": { "char": "r", "description": "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.", "name": "recommended-version-id", "summary": "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.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "skip-ancestor-check": { "name": "skip-ancestor-check", "summary": "Bypass the ancestry check for setting a recommended version.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "package:update", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "strict": true, "summary": "Update package details.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "package", "update.js" ], "aliasPermutations": [ "force:package:update", "package:force:update", "package:update:force", "force:update:package", "update:force:package", "update:package:force" ], "permutations": [ "package:update", "update:package" ] }, "package:bundle:create": { "aliases": [], "args": {}, "description": "A package bundle is an artifact composed of one or more 2GP managed packages. With a package bundle, you can develop, install, upgrade, and manage multiple packages as a single unit.", "examples": [ "Create a package bundle in the Dev Hub org; uses the Dev Hub org with the username devhub@example.com:\n<%= config.bin %> <%= command.id %> --name \"Your bundle name\" --description \"Your bundle description\" --target-dev-hub devhub@example.com" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "char": "n", "name": "name", "required": true, "summary": "Name of the package bundle.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "description": { "char": "d", "name": "description", "summary": "Description of the package bundle.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-dev-hub": { "aliases": [ "targetdevhubusername", "target-hub-org" ], "char": "v", "deprecateAliases": true, "name": "target-dev-hub", "noCacheDefault": true, "required": true, "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hidden": true, "hiddenAliases": [], "id": "package:bundle:create", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "state": "beta", "strict": true, "summary": "Create a package bundle in the Dev Hub org.", "enableJsonFlag": true, "requiresProject": true, "isESM": true, "relativePath": [ "lib", "commands", "package", "bundle", "create.js" ], "aliasPermutations": [], "permutations": [ "package:bundle:create", "bundle:package:create", "bundle:create:package", "package:create:bundle", "create:package:bundle", "create:bundle:package" ] }, "package:bundle:delete": { "aliases": [], "args": {}, "description": "Specify the ID or alias of the package bundle you want to delete. Before you delete a package bundle, first delete all associated package bundle versions.", "examples": [ "Delete a package bundle using its alias from your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --bundle \"Your Bundle Alias\"", "Delete a package bundle using its ID from the specified Dev Hub org:\n<%= config.bin %> <%= command.id %> --bundle 1Fl... --target-dev-hub devhub@example.com" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-dev-hub": { "aliases": [ "targetdevhubusername", "target-hub-org" ], "char": "v", "deprecateAliases": true, "name": "target-dev-hub", "noCacheDefault": true, "required": true, "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-prompt": { "char": "n", "name": "no-prompt", "summary": "Don't prompt before deleting the package bundle.", "allowNo": false, "type": "boolean" }, "bundle": { "char": "b", "name": "bundle", "required": true, "summary": "ID (starts with 1Fl) or alias of the package bundle to delete.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hidden": true, "hiddenAliases": [], "id": "package:bundle:delete", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "state": "beta", "strict": true, "summary": "Delete a package bundle.", "enableJsonFlag": true, "requiresProject": true, "isESM": true, "relativePath": [ "lib", "commands", "package", "bundle", "delete.js" ], "aliasPermutations": [], "permutations": [ "package:bundle:delete", "bundle:package:delete", "bundle:delete:package", "package:delete:bundle", "delete:package:bundle", "delete:bundle:package" ] }, "package:bundle:install": { "aliases": [], "args": {}, "description": "During developer preview, package bundles can be installed only in scratch orgs. To install a package bundle in a scratch org, add the PackageBundles feature to the scratch org definition file.", "examples": [ "Install a package bundle version in a scratch org and wait 10 minutes for the installation to complete:\n<%= config.bin %> <%= command.id %> --bundle MyPkgBundle1@0.1 --target-org my-scratch-org --dev-hub-org devhub@example.com --wait 10" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "bundle": { "char": "b", "name": "bundle", "required": true, "summary": "Package bundle version to install. The valid format is BundleName@VersionNumber, such as \"MyPkgBundle@0.1\".", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-org": { "aliases": [ "targetusername", "u" ], "char": "o", "deprecateAliases": true, "name": "target-org", "noCacheDefault": true, "required": true, "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "dev-hub-org": { "char": "d", "description": "Enter the username, alias, or ID of the Dev Hub org, such as \"admin@example.com\", \"myDevHub\", or \"00Dxx0000000000\".", "name": "dev-hub-org", "required": true, "summary": "Username, alias, or ID of the Dev Hub org where the bundle was created.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "wait": { "char": "w", "name": "wait", "summary": "Number of minutes to wait for the installation to complete.", "default": 0, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "verbose": { "name": "verbose", "summary": "Display extended details about the installation.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": true, "hidden": true, "hiddenAliases": [], "id": "package:bundle:install", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "state": "beta", "strict": true, "summary": "Install a specific version of a package bundle in the target org.", "enableJsonFlag": true, "requiresProject": true, "isESM": true, "relativePath": [ "lib", "commands", "package", "bundle", "install.js" ], "aliasPermutations": [], "permutations": [ "package:bundle:install", "bundle:package:install", "bundle:install:package", "package:install:bundle", "install:package:bundle", "install:bundle:package" ] }, "package:bundle:list": { "aliases": [], "args": {}, "examples": [ "List all package bundles in the Dev Hub org with the username `devhub@example.com`:\n<%= config.bin %> <%= command.id %> --target-dev-hub devhub@example.com" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-dev-hub": { "aliases": [ "targetdevhubusername", "target-hub-org" ], "char": "v", "deprecateAliases": true, "name": "target-dev-hub", "noCacheDefault": true, "required": true, "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "verbose": { "name": "verbose", "summary": "Display extended details about the package bundles.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": true, "hidden": true, "hiddenAliases": [], "id": "package:bundle:list", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "state": "beta", "strict": true, "summary": "List all package bundles in the Dev Hub org.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "package", "bundle", "list.js" ], "aliasPermutations": [], "permutations": [ "package:bundle:list", "bundle:package:list", "bundle:list:package", "package:list:bundle", "list:package:bundle", "list:bundle:package" ] }, "package:bundle:uninstall": { "aliases": [], "args": {}, "description": "To start an uninstall request, provide the package bundle version ID or alias and the target org. Optionally enter the number of minutes to wait for the uninstall to complete. If the time to uninstall exceeds the number of minutes, the request times out.", "examples": [ "Uninstall a bundle version by ID from the example org myorg@example.com:\n<%= config.bin %> <%= command.id %> --bundle 1Q8... --target-org myorg@example.com", "Uninstall a bundle version by alias from your default org and wait up to 10 minutes to complete:\n<%= config.bin %> <%= command.id %> --bundle MyBundle@1.2 --wait 10" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "bundle": { "char": "b", "name": "bundle", "required": true, "summary": "ID (starts with 1Q8) or alias of the package bundle version to uninstall.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-org": { "aliases": [ "targetusername", "u" ], "char": "o", "deprecateAliases": true, "name": "target-org", "noCacheDefault": true, "required": true, "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "wait": { "char": "w", "name": "wait", "summary": "Number of minutes to wait for the uninstall request to complete.", "default": 0, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "verbose": { "name": "verbose", "summary": "Show additional progress information while waiting for the uninstall to finish.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": true, "hidden": true, "hiddenAliases": [], "id": "package:bundle:uninstall", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "state": "beta", "strict": true, "summary": "Uninstall a package bundle version from a target org.", "enableJsonFlag": true, "requiresProject": true, "isESM": true, "relativePath": [ "lib", "commands", "package", "bundle", "uninstall.js" ], "aliasPermutations": [], "permutations": [ "package:bundle:uninstall", "bundle:package:uninstall", "bundle:uninstall:package", "package:uninstall:bundle", "uninstall:package:bundle", "uninstall:bundle:package" ] }, "package:install:report": { "aliases": [ "force:package:install:report" ], "args": {}, "deprecateAliases": true, "examples": [ "Retrieve the status of a package installation request with the specified ID on your default org:\n<%= config.bin %> <%= command.id %> --request-id 0Hf...", "Similar to previous example, except use the org with username me@example.com:\n<%= config.bin %> <%= command.id %> --request-id 0Hf... --target-org me@example.com" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-org": { "aliases": [ "targetusername", "u" ], "char": "o", "deprecateAliases": true, "name": "target-org", "noCacheDefault": true, "required": true, "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "request-id": { "aliases": [ "requestid" ], "char": "i", "deprecateAliases": true, "name": "request-id", "required": true, "summary": "ID of the package install request you want to check; starts with 0Hf.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "package:install:report", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "strict": true, "summary": "Retrieve the status of a package installation request.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "package", "install", "report.js" ], "aliasPermutations": [ "force:package:install:report", "package:force:install:report", "package:install:force:report", "package:install:report:force", "force:install:package:report", "install:force:package:report", "install:package:force:report", "install:package:report:force", "force:install:report:package", "install:force:report:package", "install:report:force:package", "install:report:package:force", "force:package:report:install", "package:force:report:install", "package:report:force:install", "package:report:install:force", "force:report:package:install", "report:force:package:install", "report:package:force:install", "report:package:install:force", "force:report:install:package", "report:force:install:package", "report:install:force:package", "report:install:package:force" ], "permutations": [ "package:install:report", "install:package:report", "install:report:package", "package:report:install", "report:package:install", "report:install:package" ] }, "package:installed:list": { "aliases": [ "force:package:installed:list" ], "args": {}, "deprecateAliases": true, "examples": [ "List the installed packages in your default org:\n<%= config.bin %> <%= command.id %>", "List the installed packages in the org with username me@example.com:\n<%= config.bin %> <%= command.id %> --target-org me@example.com" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-org": { "aliases": [ "targetusername", "u" ], "char": "o", "deprecateAliases": true, "name": "target-org", "noCacheDefault": true, "required": true, "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "package:installed:list", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "strict": true, "summary": "List the org’s installed packages.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "package", "installed", "list.js" ], "aliasPermutations": [ "force:package:installed:list", "package:force:installed:list", "package:installed:force:list", "package:installed:list:force", "force:installed:package:list", "installed:force:package:list", "installed:package:force:list", "installed:package:list:force", "force:installed:list:package", "installed:force:list:package", "installed:list:force:package", "installed:list:package:force", "force:package:list:installed", "package:force:list:installed", "package:list:force:installed", "package:list:installed:force", "force:list:package:installed", "list:force:package:installed", "list:package:force:installed", "list:package:installed:force", "force:list:installed:package", "list:force:installed:package", "list:installed:force:package", "list:installed:package:force" ], "permutations": [ "package:installed:list", "installed:package:list", "installed:list:package", "package:list:installed", "list:package:installed", "list:installed:package" ] }, "package:push-upgrade:abort": { "aliases": [], "args": {}, "description": "Specify the request ID that you want to abort. If applicable, the command displays errors related to the request.\n\nTo show all requests in the org, run \"<%= config.bin %> package pushupgrade list --package 033...\".", "examples": [ "Cancel the specified package push upgrade request with the specified ID; uses your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --push-request-id 0DV...", "Cancel the specified package push upgrade request in the Dev Hub org with username devhub@example.com:\n<%= config.bin %> <%= command.id %> --push-request-id 0DV... --target-dev-hub devhub@example.com" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-dev-hub": { "char": "v", "name": "target-dev-hub", "noCacheDefault": true, "required": true, "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "push-request-id": { "char": "i", "name": "push-request-id", "required": true, "summary": "ID of the package push request (starts with 0DV). This ID is returned after the package push-upgrade schedule command completes successfully.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "package:push-upgrade:abort", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "strict": true, "summary": "Abort a package push upgrade that has been scheduled. Only push upgrade requests with a status of Created or Pending can be aborted.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "package", "push-upgrade", "abort.js" ], "aliasPermutations": [], "permutations": [ "package:push-upgrade:abort", "push-upgrade:package:abort", "push-upgrade:abort:package", "package:abort:push-upgrade", "abort:package:push-upgrade", "abort:push-upgrade:package" ] }, "package:push-upgrade:list": { "aliases": [ "force:package:push-upgrade:list" ], "args": {}, "description": "Shows the details of each request to create a push upgrade in the Dev Hub org.\n\nAll filter parameters are applied using the AND logical operator (not OR).\n\nTo get information about a specific request, run \"sf package pushupgrade report\" and supply the request ID.", "examples": [ "List all package push upgrade requests in the specified Dev Hub org:\n<%= config.bin %> <%= command.id %> --package 033xyz --target-dev-hub myHub", "List all package push upgrade requests in the specified Dev Hub org scheduled in the last 30 days:\n<%= config.bin %> <%= command.id %> --package 033xyz --scheduled-last-days 30 --target-dev-hub myHub", "List all package push upgrade with a status Succeeded:\n<%= config.bin %> <%= command.id %> --package 033xyz –-status Succeeded", "List all package push upgrade with a status Failed:\n<%= config.bin %> <%= command.id %> --package 033xyz –-status Failed" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-dev-hub": { "aliases": [ "targetdevhubusername", "target-hub-org" ], "char": "v", "deprecateAliases": true, "name": "target-dev-hub", "noCacheDefault": true, "required": true, "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "package": { "char": "p", "name": "package", "required": true, "summary": "Package ID (starts with 033) of the package that you want push upgrade information for.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "scheduled-last-days": { "aliases": [ "scheduledlastdays" ], "char": "l", "deprecateAliases": true, "name": "scheduled-last-days", "summary": "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.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "status": { "char": "s", "name": "status", "summary": "Status used to filter the list output Valid values are: Created, Canceled, Pending, In Progress, Failed, or Succeeded", "hasDynamicHelp": false, "multiple": false, "options": [ "Created", "Cancelled", "Pending", "In Progress", "Failed", "Succeeded" ], "type": "option" }, "show-push-migrations-only": { "name": "show-push-migrations-only", "summary": "Display only push upgrade requests for package migrations.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "package:push-upgrade:list", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "strict": true, "summary": "Lists the status of push upgrade requests for a given package.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "package", "push-upgrade", "list.js" ], "aliasPermutations": [ "force:package:push-upgrade:list", "package:force:push-upgrade:list", "package:push-upgrade:force:list", "package:push-upgrade:list:force", "force:push-upgrade:package:list", "push-upgrade:force:package:list", "push-upgrade:package:force:list", "push-upgrade:package:list:force", "force:push-upgrade:list:package", "push-upgrade:force:list:package", "push-upgrade:list:force:package", "push-upgrade:list:package:force", "force:package:list:push-upgrade", "package:force:list:push-upgrade", "package:list:force:push-upgrade", "package:list:push-upgrade:force", "force:list:package:push-upgrade", "list:force:package:push-upgrade", "list:package:force:push-upgrade", "list:package:push-upgrade:force", "force:list:push-upgrade:package", "list:force:push-upgrade:package", "list:push-upgrade:force:package", "list:push-upgrade:package:force" ], "permutations": [ "package:push-upgrade:list", "push-upgrade:package:list", "push-upgrade:list:package", "package:list:push-upgrade", "list:package:push-upgrade", "list:push-upgrade:package" ] }, "package:push-upgrade:report": { "aliases": [ "force:package:push-upgrade:report" ], "args": {}, "deprecateAliases": true, "description": "Specify the request ID for which you want to view details. If applicable, the command displays errors related to the request.\n\nTo show all requests in the org, run \"<%= config.bin %> package pushupgrade list\".", "examples": [ "Retrieve details about the package push upgrade with the specified ID; uses your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --push-request-id 0DV...", "Retrieve details about the specified package push request in the Dev Hub org with username devhub@example.com:\n<%= config.bin %> <%= command.id %> --push-request-id 0DV... --target-dev-hub devhub@example.com" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-dev-hub": { "aliases": [ "targetdevhubusername", "target-hub-org" ], "char": "v", "deprecateAliases": true, "name": "target-dev-hub", "noCacheDefault": true, "required": true, "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "push-request-id": { "aliases": [ "pushrequestid" ], "char": "i", "deprecateAliases": true, "name": "push-request-id", "required": true, "summary": "ID of the package push request (starts with 0DV). This ID is returned after the package push-upgrade schedule command completes successfully.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "package:push-upgrade:report", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "strict": true, "summary": "Retrieve the status of a package push upgrade.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "package", "push-upgrade", "report.js" ], "aliasPermutations": [ "force:package:push-upgrade:report", "package:force:push-upgrade:report", "package:push-upgrade:force:report", "package:push-upgrade:report:force", "force:push-upgrade:package:report", "push-upgrade:force:package:report", "push-upgrade:package:force:report", "push-upgrade:package:report:force", "force:push-upgrade:report:package", "push-upgrade:force:report:package", "push-upgrade:report:force:package", "push-upgrade:report:package:force", "force:package:report:push-upgrade", "package:force:report:push-upgrade", "package:report:force:push-upgrade", "package:report:push-upgrade:force", "force:report:package:push-upgrade", "report:force:package:push-upgrade", "report:package:force:push-upgrade", "report:package:push-upgrade:force", "force:report:push-upgrade:package", "report:force:push-upgrade:package", "report:push-upgrade:force:package", "report:push-upgrade:package:force" ], "permutations": [ "package:push-upgrade:report", "push-upgrade:package:report", "push-upgrade:report:package", "package:report:push-upgrade", "report:package:push-upgrade", "report:push-upgrade:package" ] }, "package:push-upgrade:schedule": { "aliases": [], "args": {}, "description": "Represents a push upgrade request for upgrading a package in one or many orgs from one version to another version.\nTo initiate a push upgrade for an unlocked or second-generation managed package, the Create and Update Second-Generation Packages user permission is required.\nFor 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.\nFor unlocked packages, push upgrades are enabled by default.\n\nUse 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:\n<%= config.bin %> <%= command.id %> --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:\n<%= config.bin %> <%= command.id %> --package 04txyz --org-file upgrade-orgs.csv --target-dev-hub myHub", "Schedule a push migration from a 1GP package to a 2GP package:\n<%= config.bin %> <%= command.id %> --migrate-to-2gp --package 04txyz --start-time \"2024-12-06T21:00:00\" --org-file upgrade-orgs.csv --target-dev-hub myHub" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-dev-hub": { "char": "v", "description": "Overrides the value of the target-dev-hub configuration variable, if set.", "name": "target-dev-hub", "noCacheDefault": true, "required": true, "summary": "Username or alias of the Dev Hub org that owns the package.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "package": { "char": "p", "name": "package", "required": true, "summary": "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.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "start-time": { "char": "t", "description": "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.\n\nAs a best practice, schedule push upgrades at off-peak hours like 1:00 AM Saturday. \nIf you don't specify this flag, the push upgrade is scheduled to run as soon as resources are available on the Salesforce instance.", "name": "start-time", "summary": "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.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "org-list": { "char": "l", "exclusive": [ "org-file" ], "name": "org-list", "summary": "Comma-separated list of subscriber org IDs that need the package upgrade. Either --org-list or --org-file must be specified.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "org-file": { "char": "f", "description": "The file must contain one org per line. The org ID must be the only value in each row.\nAll listed orgs must have a package version installed in their org that is lower than the package version you specified for the --package flag.", "exclusive": [ "org-list" ], "name": "org-file", "summary": "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.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "migrate-to-2gp": { "name": "migrate-to-2gp", "summary": "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.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "package:push-upgrade:schedule", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "strict": true, "summary": "Schedule a package push upgrade.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "package", "push-upgrade", "schedule.js" ], "aliasPermutations": [], "permutations": [ "package:push-upgrade:schedule", "push-upgrade:package:schedule", "push-upgrade:schedule:package", "package:schedule:push-upgrade", "schedule:package:push-upgrade", "schedule:push-upgrade:package" ] }, "package:uninstall:report": { "aliases": [ "force:package:uninstall:report" ], "args": {}, "deprecateAliases": true, "examples": [ "Retrieve the status of a package uninstall in your default org using the specified request ID:\n<%= config.bin %> <%= command.id %> --request-id 06y...", "Similar to previous example, but use the org with username me@example.com:\n<%= config.bin %> <%= command.id %> --request-id 06y... --target-org me@example.com" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-org": { "aliases": [ "targetusername", "u" ], "char": "o", "deprecateAliases": true, "name": "target-org", "noCacheDefault": true, "required": true, "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "request-id": { "aliases": [ "requestid" ], "char": "i", "deprecateAliases": true, "name": "request-id", "required": true, "summary": "ID of the package uninstall request you want to check; starts with 06y.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "package:uninstall:report", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "strict": true, "summary": "Retrieve the status of a package uninstall request.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "package", "uninstall", "report.js" ], "aliasPermutations": [ "force:package:uninstall:report", "package:force:uninstall:report", "package:uninstall:force:report", "package:uninstall:report:force", "force:uninstall:package:report", "uninstall:force:package:report", "uninstall:package:force:report", "uninstall:package:report:force", "force:uninstall:report:package", "uninstall:force:report:package", "uninstall:report:force:package", "uninstall:report:package:force", "force:package:report:uninstall", "package:force:report:uninstall", "package:report:force:uninstall", "package:report:uninstall:force", "force:report:package:uninstall", "report:force:package:uninstall", "report:package:force:uninstall", "report:package:uninstall:force", "force:report:uninstall:package", "report:force:uninstall:package", "report:uninstall:force:package", "report:uninstall:package:force" ], "permutations": [ "package:uninstall:report", "uninstall:package:report", "uninstall:report:package", "package:report:uninstall", "report:package:uninstall", "report:uninstall:package" ] }, "package:version:create": { "aliases": [ "force:package:version:create" ], "args": {}, "deprecateAliases": true, "description": "The package version is based on the package contents in the specified directory.\n\nTo retrieve details about a package version create request, including status and package version ID (04t), run \"<%= config.bin %> package version create report -i 08c...\".\n\nWe recommend that you specify the --installation-key parameter to protect the contents of your package and to prevent unauthorized installation of your package.\n\nTo list package version creation requests in the org, run \"<%= config.bin %> package version create list\".\nTo 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.\n\nWe don’t calculate code coverage for org-dependent unlocked packages, or for package versions that specify --skip-validation.", "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:\n<%= config.bin %> <%= command.id %> --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:\n<%= config.bin %> <%= command.id %> --package \"Your Package Alias\" --installation-key password123 --target-dev-hub devhub@example.com", "Create a package version from a package with the specified ID:\n<%= config.bin %> <%= command.id %> --package 0Ho... --installation-key password123", "Create a package version and skip the validation step:\n<%= config.bin %> <%= command.id %> --path common --installation-key password123 --skip-validation", "Create a package version and perform package validations asynchronously:\n<%= config.bin %> <%= command.id %> --path common --installation-key password123 --async-validation" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-dev-hub": { "aliases": [ "targetdevhubusername", "target-hub-org" ], "char": "v", "deprecateAliases": true, "name": "target-dev-hub", "noCacheDefault": true, "required": true, "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "branch": { "char": "b", "name": "branch", "summary": "Name of the branch in your source control system that the package version is based on.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "build-instance": { "aliases": [ "buildinstance" ], "char": "s", "deprecateAliases": true, "hidden": true, "name": "build-instance", "summary": "Instance where the package version will be created, such as NA50.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "code-coverage": { "aliases": [ "codecoverage" ], "char": "c", "deprecateAliases": true, "description": "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.", "exclusive": [ "skip-validation" ], "name": "code-coverage", "summary": "Calculate and store the code coverage percentage by running the packaged Apex tests included in this package version.", "allowNo": false, "type": "boolean" }, "definition-file": { "aliases": [ "definitionfile" ], "char": "f", "deprecateAliases": true, "description": "For a patch version, the features specified in this file are ignored, and instead the features specified for the ancestor version are used.", "name": "definition-file", "summary": "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.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "installation-key": { "aliases": [ "installationkey" ], "char": "k", "deprecateAliases": true, "name": "installation-key", "summary": "Installation key for key-protected package. (either --installation-key or --installation-key-bypass is required)", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "installation-key-bypass": { "aliases": [ "installationkeybypass" ], "char": "x", "deprecateAliases": true, "description": "If you bypass this requirement, anyone can install your package.", "name": "installation-key-bypass", "summary": "Bypass the installation key requirement. (either --installation-key or --installation-key-bypass is required)", "allowNo": false, "type": "boolean" }, "package": { "char": "p", "name": "package", "summary": "ID (starts with 0Ho) or alias of the package to create a version of.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "path": { "char": "d", "name": "path", "summary": "Path to the directory that contains the contents of the package.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "post-install-script": { "aliases": [ "postinstallscript" ], "deprecateAliases": true, "description": "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.", "name": "post-install-script", "summary": "Name of the post-install script; applies to managed packages only.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "post-install-url": { "aliases": [ "postinstallurl" ], "deprecateAliases": true, "description": "The contents of the post-installation instructions URL are displayed in the UI after installation of the package version.", "name": "post-install-url", "summary": "Post-install instructions URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "preserve": { "char": "r", "hidden": true, "name": "preserve", "summary": "Preserve temp files that would otherwise be deleted.", "allowNo": false, "type": "boolean" }, "releasenotes-url": { "aliases": [ "releasenotesurl" ], "deprecateAliases": true, "description": "This link is displayed in the package installation UI to provide release notes for this package version to subscribers.", "name": "releasenotes-url", "summary": "Release notes URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "skip-ancestor-check": { "aliases": [ "skipancestorcheck" ], "deprecateAliases": true, "name": "skip-ancestor-check", "summary": "Override ancestry requirements, which allows you to specify a package ancestor that isn’t the highest released package version.", "allowNo": false, "type": "boolean" }, "skip-validation": { "aliases": [ "skipvalidation" ], "deprecateAliases": true, "description": "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.", "exclusive": [ "code-coverage", "async-validation" ], "name": "skip-validation", "summary": "Skip validation during package version creation; you can’t promote unvalidated package versions.", "allowNo": false, "type": "boolean" }, "async-validation": { "description": "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.", "exclusive": [ "skip-validation" ], "name": "async-validation", "summary": "Return a new package version before completing package validations.", "allowNo": false, "type": "boolean" }, "generate-pkg-zip": { "name": "generate-pkg-zip", "summary": "Generate a package ZIP file that you can use for debugging or to examine the package contents.", "allowNo": false, "type": "boolean" }, "tag": { "char": "t", "name": "tag", "summary": "Package version’s tag.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "uninstall-script": { "aliases": [ "uninstallscript" ], "deprecateAliases": true, "description": "The uninstall script is an Apex class within this package that is run in the installing org after uninstallations of this package.", "name": "uninstall-script", "summary": "Uninstall script name; applies to managed packages only.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "validate-schema": { "aliases": [ "validateschema" ], "char": "j", "deprecateAliases": true, "hidden": true, "name": "validate-schema", "summary": "Validate the sfdx-project.json file against the JSON schema.", "allowNo": false, "type": "boolean" }, "version-description": { "aliases": [ "versiondescription" ], "char": "e", "deprecateAliases": true, "name": "version-description", "summary": "Description of the package version to be created; overrides the sfdx-project.json value.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "version-name": { "aliases": [ "versionname" ], "char": "a", "deprecateAliases": true, "name": "version-name", "summary": "Name of the package version to be created; overrides the sfdx-project.json value.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "version-number": { "aliases": [ "versionnumber" ], "char": "n", "deprecateAliases": true, "description": "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.", "name": "version-number", "summary": "Version number of the package version to be created; overrides the sfdx-project.json value.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "wait": { "char": "w", "name": "wait", "summary": "Number of minutes to wait for the package version to be created.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "language": { "description": "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.", "name": "language", "summary": "Language for the package.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "verbose": { "description": "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.", "name": "verbose", "summary": "Display verbose command output.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "package:version:create", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "strict": true, "summary": "Create a package version in the Dev Hub org.", "enableJsonFlag": true, "requiresProject": true, "isESM": true, "relativePath": [ "lib", "commands", "package", "version", "create.js" ], "aliasPermutations": [ "force:package:version:create", "package:force:version:create", "package:version:force:create", "package:version:create:force", "force:version:package:create", "version:force:package:create", "version:package:force:create", "version:package:create:force", "force:version:create:package", "version:force:create:package", "version:create:force:package", "version:create:package:force", "force:package:create:version", "package:force:create:version", "package:create:force:version", "package:create:version:force", "force:create:package:version", "create:force:package:version", "create:package:force:version", "create:package:version:force", "force:create:version:package", "create:force:version:package", "create:version:force:package", "create:version:package:force" ], "permutations": [ "package:version:create", "version:package:create", "version:create:package", "package:create:version", "create:package:version", "create:version:package" ] }, "package:version:delete": { "aliases": [ "force:package:version:delete" ], "args": {}, "deprecateAliases": true, "description": "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": [ "Delete a package version with the specified alias using your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --package \"Your Package Alias\"", "Delete a package version with the specified ID using the Dev Hub org with username \"devhub@example.com\":\n<%= config.bin %> <%= command.id %> --package 04t... --target-org devhub@example.com" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-dev-hub": { "aliases": [ "targetdevhubusername", "target-hub-org" ], "char": "v", "deprecateAliases": true, "name": "target-dev-hub", "noCacheDefault": true, "required": true, "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-prompt": { "aliases": [ "noprompt" ], "char": "n", "deprecateAliases": true, "name": "no-prompt", "summary": "Don’t prompt before deleting the package version.", "allowNo": false, "type": "boolean" }, "package": { "char": "p", "name": "package", "required": true, "summary": "ID (starts with 04t) or alias of the package version to delete.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "undelete": { "hidden": true, "name": "undelete", "summary": "Undelete a deleted package version.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "package:version:delete", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "strict": true, "summary": "Delete a package version.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "package", "version", "delete.js" ], "aliasPermutations": [ "force:package:version:delete", "package:force:version:delete", "package:version:force:delete", "package:version:delete:force", "force:version:package:delete", "version:force:package:delete", "version:package:force:delete", "version:package:delete:force", "force:version:delete:package", "version:force:delete:package", "version:delete:force:package", "version:delete:package:force", "force:package:delete:version", "package:force:delete:version", "package:delete:force:version", "package:delete:version:force", "force:delete:package:version", "delete:force:package:version", "delete:package:force:version", "delete:package:version:force", "force:delete:version:package", "delete:force:version:package", "delete:version:force:package", "delete:version:package:force" ], "permutations": [ "package:version:delete", "version:package:delete", "version:delete:package", "package:delete:version", "delete:package:version", "delete:version:package" ] }, "package:version:displayancestry": { "aliases": [ "force:package:version:displayancestry" ], "args": {}, "deprecateAliases": true, "examples": [ "Display the ancestry tree for a package version with the specified alias, using your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --package package_version_alias", "Similar to previous example, but display the output in DOT code:\n<%= config.bin %> <%= command.id %> --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:\n<%= config.bin %> <%= command.id %> --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:\n<%= config.bin %> <%= command.id %> --package 04t..." ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-dev-hub": { "aliases": [ "targetdevhubusername", "target-hub-org" ], "char": "v", "deprecateAliases": true, "name": "target-dev-hub", "noCacheDefault": true, "required": true, "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "package": { "char": "p", "description": "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.", "name": "package", "required": true, "summary": "ID or alias of the package (starts with 0Ho) or package version (starts with 04t) to display ancestry for.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "dot-code": { "aliases": [ "dotcode" ], "deprecateAliases": true, "description": "You can use the DOT code output in graph visualization software to create tree visualizations.", "name": "dot-code", "summary": "Display the ancestry tree in DOT code.", "allowNo": false, "type": "boolean" }, "verbose": { "name": "verbose", "summary": "Display both the package version ID (starts with 04t) and the version number (major.minor.patch.build) in the ancestry tree.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "package:version:displayancestry", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "strict": true, "summary": "Display the ancestry tree for a 2GP managed package version.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "package", "version", "displayancestry.js" ], "aliasPermutations": [ "force:package:version:displayancestry", "package:force:version:displayancestry", "package:version:force:displayancestry", "package:version:displayancestry:force", "force:version:package:displayancestry", "version:force:package:displayancestry", "version:package:force:displayancestry", "version:package:displayancestry:force", "force:version:displayancestry:package", "version:force:displayancestry:package", "version:displayancestry:force:package", "version:displayancestry:package:force", "force:package:displayancestry:version", "package:force:displayancestry:version", "package:displayancestry:force:version", "package:displayancestry:version:force", "force:displayancestry:package:version", "displayancestry:force:package:version", "displayancestry:package:force:version", "displayancestry:package:version:force", "force:displayancestry:version:package", "displayancestry:force:version:package", "displayancestry:version:force:package", "displayancestry:version:package:force" ], "permutations": [ "package:version:displayancestry", "version:package:displayancestry", "version:displayancestry:package", "package:displayancestry:version", "displayancestry:package:version", "displayancestry:version:package" ] }, "package:version:displaydependencies": { "aliases": [], "args": {}, "deprecateAliases": true, "examples": [ "Display the dependency graph for a package version with the specified alias, using your default Dev Hub org and the default edge-direction:\n<%= config.bin %> <%= command.id %> --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:\n<%= config.bin %> <%= command.id %> --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:\n<%= config.bin %> <%= command.id %> --package 08c..." ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-dev-hub": { "aliases": [ "targetdevhubusername", "target-hub-org" ], "char": "v", "deprecateAliases": true, "name": "target-dev-hub", "noCacheDefault": true, "required": true, "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "package": { "char": "p", "description": "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.", "name": "package", "required": true, "summary": "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.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "edge-direction": { "description": "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.", "name": "edge-direction", "summary": "Order (root-first or root-last) in which the dependencies are displayed.", "default": "root-first", "hasDynamicHelp": false, "multiple": false, "options": [ "root-first", "root-last" ], "type": "option" }, "verbose": { "name": "verbose", "summary": "Display both the package version ID (starts with 04t) and the version number (major.minor.patch.build) in each node.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "package:version:displaydependencies", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "strict": true, "summary": "Display the dependency graph for an unlocked or 2GP managed package version.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "package", "version", "displaydependencies.js" ], "aliasPermutations": [], "permutations": [ "package:version:displaydependencies", "version:package:displaydependencies", "version:displaydependencies:package", "package:displaydependencies:version", "displaydependencies:package:version", "displaydependencies:version:package" ] }, "package:version:list": { "aliases": [ "force:package:version:list" ], "args": {}, "deprecateAliases": true, "description": "Description", "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:\n<%= config.bin %> <%= command.id %> --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:\n<%= config.bin %> <%= command.id %> --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:\n<%= config.bin %> <%= command.id %> --released", "List package versions that were modified today in your default Dev Hub org; show limited details about each one:\n<%= config.bin %> <%= command.id %> --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:\n<%= config.bin %> <%= command.id %> --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:\n<%= config.bin %> <%= command.id %> --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:\n<%= config.bin %> <%= command.id %> --packages exp-mgr,exp-mgr-util --released --modified-last-days 0" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-dev-hub": { "aliases": [ "targetdevhubusername", "target-hub-org" ], "char": "v", "deprecateAliases": true, "name": "target-dev-hub", "noCacheDefault": true, "required": true, "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "created-last-days": { "aliases": [ "createdlastdays" ], "char": "c", "deprecateAliases": true, "name": "created-last-days", "summary": "Number of days since the request was created, starting at 00:00:00 of first day to now. Use 0 for today.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "concise": { "name": "concise", "summary": "Display limited package version details.", "allowNo": false, "type": "boolean" }, "show-conversions-only": { "name": "show-conversions-only", "summary": "Filter the list output to display only converted package version.", "allowNo": false, "type": "boolean" }, "modified-last-days": { "aliases": [ "modifiedlastdays" ], "char": "m", "deprecateAliases": true, "name": "modified-last-days", "summary": "Number of days since the items were modified, starting at 00:00:00 of first day to now. Use 0 for today.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "packages": { "char": "p", "name": "packages", "summary": "Comma-delimited list of packages (aliases or 0Ho IDs) to list.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "released": { "char": "r", "name": "released", "summary": "Display released versions only (IsReleased=true).", "allowNo": false, "type": "boolean" }, "branch": { "char": "b", "name": "branch", "summary": "Branch in your source control system used to filter the results; only package versions based on the specified branch are listed.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "order-by": { "aliases": [ "orderby" ], "char": "o", "deprecateAliases": true, "name": "order-by", "summary": "Package version fields used to order the list.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "verbose": { "name": "verbose", "summary": "Display extended package version details.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "package:version:list", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "strict": true, "summary": "List all package versions in the Dev Hub org.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "package", "version", "list.js" ], "aliasPermutations": [ "force:package:version:list", "package:force:version:list", "package:version:force:list", "package:version:list:force", "force:version:package:list", "version:force:package:list", "version:package:force:list", "version:package:list:force", "force:version:list:package", "version:force:list:package", "version:list:force:package", "version:list:package:force", "force:package:list:version", "package:force:list:version", "package:list:force:version", "package:list:version:force", "force:list:package:version", "list:force:package:version", "list:package:force:version", "list:package:version:force", "force:list:version:package", "list:force:version:package", "list:version:force:package", "list:version:package:force" ], "permutations": [ "package:version:list", "version:package:list", "version:list:package", "package:list:version", "list:package:version", "list:version:package" ] }, "package:version:promote": { "aliases": [ "force:package:version:promote" ], "args": {}, "deprecateAliases": true, "description": "Supply the ID or alias of the package version you want to promote. Promotes the package version to released status.", "examples": [ "Promote the package version with the specified ID to released; uses your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --package 04t...", "Promote the package version with the specified alias to released; uses the Dev Hub org with username devhub@example.com:\n<%= config.bin %> <%= command.id %> --package awesome_package_alias --target-dev-hub devhub@example.com", "Promote the package version with an alias that has spaces to released:\n<%= config.bin %> <%= command.id %> --package \"Awesome Package Alias\"" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-dev-hub": { "aliases": [ "targetdevhubusername", "target-hub-org" ], "char": "v", "deprecateAliases": true, "name": "target-dev-hub", "noCacheDefault": true, "required": true, "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "package": { "char": "p", "name": "package", "required": true, "summary": "ID (starts with 04t) or alias of the package version to promote.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-prompt": { "aliases": [ "noprompt" ], "char": "n", "deprecateAliases": true, "name": "no-prompt", "summary": "Don't prompt to confirm setting the package version as released.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "package:version:promote", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "strict": true, "summary": "Promote a package version to released.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "package", "version", "promote.js" ], "aliasPermutations": [ "force:package:version:promote", "package:force:version:promote", "package:version:force:promote", "package:version:promote:force", "force:version:package:promote", "version:force:package:promote", "version:package:force:promote", "version:package:promote:force", "force:version:promote:package", "version:force:promote:package", "version:promote:force:package", "version:promote:package:force", "force:package:promote:version", "package:force:promote:version", "package:promote:force:version", "package:promote:version:force", "force:promote:package:version", "promote:force:package:version", "promote:package:force:version", "promote:package:version:force", "force:promote:version:package", "promote:force:version:package", "promote:version:force:package", "promote:version:package:force" ], "permutations": [ "package:version:promote", "version:package:promote", "version:promote:package", "package:promote:version", "promote:package:version", "promote:version:package" ] }, "package:version:report": { "aliases": [ "force:package:version:report" ], "args": {}, "deprecateAliases": true, "description": "To update package version values, run \"<%= config.bin %> package version update\".", "examples": [ "Retrieve details about the package version with the specified ID from your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --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:\n<%= config.bin %> <%= command.id %> --package \"Your Package Alias\" --target-dev-hub devhub@example.com" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-dev-hub": { "aliases": [ "targetdevhubusername", "target-hub-org" ], "char": "v", "deprecateAliases": true, "name": "target-dev-hub", "noCacheDefault": true, "required": true, "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "package": { "char": "p", "name": "package", "required": true, "summary": "ID (starts with 04t) or alias of the package to retrieve details for.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "verbose": { "name": "verbose", "summary": "Display extended package version details.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "package:version:report", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "strict": true, "summary": "Retrieve details about a package version in the Dev Hub org.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "package", "version", "report.js" ], "aliasPermutations": [ "force:package:version:report", "package:force:version:report", "package:version:force:report", "package:version:report:force", "force:version:package:report", "version:force:package:report", "version:package:force:report", "version:package:report:force", "force:version:report:package", "version:force:report:package", "version:report:force:package", "version:report:package:force", "force:package:report:version", "package:force:report:version", "package:report:force:version", "package:report:version:force", "force:report:package:version", "report:force:package:version", "report:package:force:version", "report:package:version:force", "force:report:version:package", "report:force:version:package", "report:version:force:package", "report:version:package:force" ], "permutations": [ "package:version:report", "version:package:report", "version:report:package", "package:report:version", "report:package:version", "report:version:package" ] }, "package:version:retrieve": { "aliases": [], "args": {}, "description": "Retrieving a package version downloads the metadata into the directory you specify.\n\nWhen you run this command, specify the subscriber package version ID (starts with 04t) and the path to an empty directory.\n\nBy default, the package version retrieve command is available to 2GP managed packages that were converted from 1GP. To use this command with a managed package created using 2GP (not converted from 1GP) or with an unlocked package, specify IsDevUsePkgZipRequested = true in the Package2VersionCreateRequest Tooling API object. If you run this command and the zip folder with the package version’s source files is missing, confirm that IsDevUsePkgZipRequested is set to true.", "examples": [ "Retrieve package metadata for a converted subscriber package version ID (starts with 04t) into my-directory/ within your Salesforce DX project directory:\n<%= config.bin %> <%= command.id %> --package 04tXXX --output-dir my-directory/ --target-dev-hub devhub@example.com" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-dev-hub": { "aliases": [ "targetdevhubusername" ], "char": "v", "deprecateAliases": true, "name": "target-dev-hub", "noCacheDefault": true, "required": true, "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "package": { "char": "p", "name": "package", "required": true, "summary": "Subscriber package version ID (starts with 04t).", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "output-dir": { "char": "d", "name": "output-dir", "summary": "Path within your Salesforce DX project directory in which to download the metadata. This directory must be empty.", "default": "force-app", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "package:version:retrieve", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "strict": true, "summary": "Retrieve package metadata for a specified package version. Package metadata can be retrieved for only second-generation managed package versions or unlocked packages.", "enableJsonFlag": true, "requiresProject": true, "isESM": true, "relativePath": [ "lib", "commands", "package", "version", "retrieve.js" ], "aliasPermutations": [], "permutations": [ "package:version:retrieve", "version:package:retrieve", "version:retrieve:package", "package:retrieve:version", "retrieve:package:version", "retrieve:version:package" ] }, "package:version:update": { "aliases": [ "force:package:version:update" ], "args": {}, "deprecateAliases": true, "description": "Specify a new value for each option you want to update.\n\nTo display details about a package version, run \"<%= config.bin %> package version display\".", "examples": [ "Update the package version that has the specified alias (that contains spaces) with a new installation key \"password123\"; uses your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --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:\n<%= config.bin %> <%= command.id %> --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:\n<%= config.bin %> <%= command.id %> --package 04t... --version-description \"New Package Version Description\"" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-dev-hub": { "aliases": [ "targetdevhubusername", "target-hub-org" ], "char": "v", "deprecateAliases": true, "name": "target-dev-hub", "noCacheDefault": true, "required": true, "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "package": { "char": "p", "name": "package", "required": true, "summary": "ID (starts with 04t) or alias of the package to update a version of.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "version-name": { "aliases": [ "versionname" ], "char": "a", "deprecateAliases": true, "name": "version-name", "summary": "New package version name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "version-description": { "aliases": [ "versiondescription" ], "char": "e", "deprecateAliases": true, "name": "version-description", "summary": "New package version description.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "branch": { "char": "b", "name": "branch", "summary": "New package version branch.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "tag": { "char": "t", "name": "tag", "summary": "New package version tag.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "installation-key": { "aliases": [ "installationkey" ], "char": "k", "deprecateAliases": true, "name": "installation-key", "summary": "New installation key for key-protected package (default: null)", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "package:version:update", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "strict": true, "summary": "Update a package version.", "enableJsonFlag": true, "requiresProject": true, "isESM": true, "relativePath": [ "lib", "commands", "package", "version", "update.js" ], "aliasPermutations": [ "force:package:version:update", "package:force:version:update", "package:version:force:update", "package:version:update:force", "force:version:package:update", "version:force:package:update", "version:package:force:update", "version:package:update:force", "force:version:update:package", "version:force:update:package", "version:update:force:package", "version:update:package:force", "force:package:update:version", "package:force:update:version", "package:update:force:version", "package:update:version:force", "force:update:package:version", "update:force:package:version", "update:package:force:version", "update:package:version:force", "force:update:version:package", "update:force:version:package", "update:version:force:package", "update:version:package:force" ], "permutations": [ "package:version:update", "version:package:update", "version:update:package", "package:update:version", "update:package:version", "update:version:package" ] }, "package1:version:create": { "aliases": [ "force:package1:version:create" ], "args": {}, "deprecateAliases": true, "description": "The package version is based on the contents of the specified metadata package. Omit --managed-released if you want to create an unmanaged package version.", "examples": [ "Create a first-generation package version from the package with the specified ID and name the package version \"example\"; use your default org:\n<%= config.bin %> <%= command.id %> --package-id 033... --name example", "Same as previous example, but provide a description and wait for 30 minutes for the package version to be created; use the specified org:\n<%= config.bin %> <%= command.id %> --package-id 033... --name example --description \"example description\" --wait 30 --target-org myorg@example.com" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-org": { "aliases": [ "targetusername", "u" ], "char": "o", "deprecateAliases": true, "name": "target-org", "noCacheDefault": true, "required": true, "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "package-id": { "aliases": [ "packageid" ], "char": "i", "deprecateAliases": true, "name": "package-id", "required": true, "summary": "ID of the metadata package (starts with 033) of which you’re creating a new version.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "char": "n", "name": "name", "required": true, "summary": "Package version name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "description": { "char": "d", "name": "description", "summary": "Package version description.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "version": { "char": "v", "name": "version", "summary": "Package version in major.minor format, for example, 3.2.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "managed-released": { "aliases": [ "managedrelease" ], "char": "m", "deprecateAliases": true, "description": "To create a beta version, don’t include this parameter.", "name": "managed-released", "summary": "Create a managed package version.", "allowNo": false, "type": "boolean" }, "release-notes-url": { "aliases": [ "releasenotesurl" ], "char": "r", "deprecateAliases": true, "description": "This link is displayed in the package installation UI to provide release notes for this package version to subscribers.", "name": "release-notes-url", "summary": "Release notes URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "post-install-url": { "aliases": [ "postinstallurl" ], "char": "p", "deprecateAliases": true, "description": "The contents of the post-installation instructions URL are displayed in the UI after installation of the package version.", "name": "post-install-url", "summary": "Post install URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "installation-key": { "aliases": [ "installationkey" ], "char": "k", "deprecateAliases": true, "name": "installation-key", "summary": "Installation key for key-protected package (default: null).", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "wait": { "char": "w", "name": "wait", "summary": "Minutes to wait for the package version to be created (default: 2 minutes).", "hasDynamicHelp": true, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "package1:version:create", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "strict": true, "summary": "Create a first-generation package version in the release org.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "package1", "version", "create.js" ], "aliasPermutations": [ "force:package1:version:create", "package1:force:version:create", "package1:version:force:create", "package1:version:create:force", "force:version:package1:create", "version:force:package1:create", "version:package1:force:create", "version:package1:create:force", "force:version:create:package1", "version:force:create:package1", "version:create:force:package1", "version:create:package1:force", "force:package1:create:version", "package1:force:create:version", "package1:create:force:version", "package1:create:version:force", "force:create:package1:version", "create:force:package1:version", "create:package1:force:version", "create:package1:version:force", "force:create:version:package1", "create:force:version:package1", "create:version:force:package1", "create:version:package1:force" ], "permutations": [ "package1:version:create", "version:package1:create", "version:create:package1", "package1:create:version", "create:package1:version", "create:version:package1" ] }, "package1:version:display": { "aliases": [ "force:package1:version:display" ], "args": {}, "deprecateAliases": true, "examples": [ "Display details about the first-generation package version with the specified ID in your default org:\n<%= config.bin %> <%= command.id %> --package-version-id 04t...", "Same as previous example, but use the specified org:\n<%= config.bin %> <%= command.id %> --package-version-id 04t... --target-org myorg@example.com" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-org": { "aliases": [ "targetusername", "u" ], "char": "o", "deprecateAliases": true, "name": "target-org", "noCacheDefault": true, "required": true, "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "package-version-id": { "aliases": [ "packageversionid" ], "char": "i", "deprecateAliases": true, "name": "package-version-id", "required": true, "summary": "ID (starts with 04t) of the metadata package version whose details you want to display.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "package1:version:display", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "strict": true, "summary": "Display details about a first-generation package version.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "package1", "version", "display.js" ], "aliasPermutations": [ "force:package1:version:display", "package1:force:version:display", "package1:version:force:display", "package1:version:display:force", "force:version:package1:display", "version:force:package1:display", "version:package1:force:display", "version:package1:display:force", "force:version:display:package1", "version:force:display:package1", "version:display:force:package1", "version:display:package1:force", "force:package1:display:version", "package1:force:display:version", "package1:display:force:version", "package1:display:version:force", "force:display:package1:version", "display:force:package1:version", "display:package1:force:version", "display:package1:version:force", "force:display:version:package1", "display:force:version:package1", "display:version:force:package1", "display:version:package1:force" ], "permutations": [ "package1:version:display", "version:package1:display", "version:display:package1", "package1:display:version", "display:package1:version", "display:version:package1" ] }, "package1:version:list": { "aliases": [ "force:package1:version:list" ], "args": {}, "deprecateAliases": true, "examples": [ "List all first-generation package versions in your default org:\n<%= config.bin %> <%= command.id %>", "List package versions for the specified first-generation package in the specifief org:\n<%= config.bin %> <%= command.id %> --package-id 033... --target-org myorg@example.com" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-org": { "aliases": [ "targetusername", "u" ], "char": "o", "deprecateAliases": true, "name": "target-org", "noCacheDefault": true, "required": true, "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "package-id": { "aliases": [ "packageid" ], "char": "i", "deprecateAliases": true, "description": "If not specified, shows all versions for all packages (managed and unmanaged) in the org.", "name": "package-id", "summary": "Metadata package ID (starts with 033) whose package versions you want to list.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "package1:version:list", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "strict": true, "summary": "List package versions for the specified first-generation package or for the org.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "package1", "version", "list.js" ], "aliasPermutations": [ "force:package1:version:list", "package1:force:version:list", "package1:version:force:list", "package1:version:list:force", "force:version:package1:list", "version:force:package1:list", "version:package1:force:list", "version:package1:list:force", "force:version:list:package1", "version:force:list:package1", "version:list:force:package1", "version:list:package1:force", "force:package1:list:version", "package1:force:list:version", "package1:list:force:version", "package1:list:version:force", "force:list:package1:version", "list:force:package1:version", "list:package1:force:version", "list:package1:version:force", "force:list:version:package1", "list:force:version:package1", "list:version:force:package1", "list:version:package1:force" ], "permutations": [ "package1:version:list", "version:package1:list", "version:list:package1", "package1:list:version", "list:package1:version", "list:version:package1" ] }, "package:bundle:install:report": { "aliases": [], "args": {}, "description": "The command returns information such as the current status of the request and details about the package bundle version being installed.", "examples": [ "Report on a package bundle installation request:\n<%= config.bin %> <%= command.id %> --package-install-request-id 0Ho0x0000000000000" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-org": { "aliases": [ "targetusername", "u" ], "char": "o", "deprecateAliases": true, "name": "target-org", "noCacheDefault": true, "required": true, "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "package-install-request-id": { "char": "i", "name": "package-install-request-id", "required": true, "summary": "ID of the package bundle installation request to report on.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "verbose": { "name": "verbose", "required": false, "summary": "Show verbose output.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": true, "hidden": true, "hiddenAliases": [], "id": "package:bundle:install:report", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "state": "beta", "strict": true, "summary": "Report on the status of a package bundle installation request.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "package", "bundle", "install", "report.js" ], "aliasPermutations": [], "permutations": [ "package:bundle:install:report", "bundle:package:install:report", "bundle:install:package:report", "bundle:install:report:package", "package:install:bundle:report", "install:package:bundle:report", "install:bundle:package:report", "install:bundle:report:package", "package:install:report:bundle", "install:package:report:bundle", "install:report:package:bundle", "install:report:bundle:package", "package:bundle:report:install", "bundle:package:report:install", "bundle:report:package:install", "bundle:report:install:package", "package:report:bundle:install", "report:package:bundle:install", "report:bundle:package:install", "report:bundle:install:package", "package:report:install:bundle", "report:package:install:bundle", "report:install:package:bundle", "report:install:bundle:package" ] }, "package:bundle:installed:list": { "aliases": [], "args": {}, "description": "Displays information about all package bundles installed in the target org, including the bundle details and the associated packages with their expected and actual versions.", "examples": [ "List all installed package bundles in your default org:\n<%= config.bin %> <%= command.id %>", "List all installed package bundles in the example org myorg@example.com:\n<%= config.bin %> <%= command.id %> --target-org myorg@example.com" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-org": { "aliases": [ "targetusername", "u" ], "char": "o", "deprecateAliases": true, "name": "target-org", "noCacheDefault": true, "required": true, "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hidden": true, "hiddenAliases": [], "id": "package:bundle:installed:list", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "state": "beta", "strict": true, "summary": "List all installed package bundles in the target org.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "package", "bundle", "installed", "list.js" ], "aliasPermutations": [], "permutations": [ "package:bundle:installed:list", "bundle:package:installed:list", "bundle:installed:package:list", "bundle:installed:list:package", "package:installed:bundle:list", "installed:package:bundle:list", "installed:bundle:package:list", "installed:bundle:list:package", "package:installed:list:bundle", "installed:package:list:bundle", "installed:list:package:bundle", "installed:list:bundle:package", "package:bundle:list:installed", "bundle:package:list:installed", "bundle:list:package:installed", "bundle:list:installed:package", "package:list:bundle:installed", "list:package:bundle:installed", "list:bundle:package:installed", "list:bundle:installed:package", "package:list:installed:bundle", "list:package:installed:bundle", "list:installed:package:bundle", "list:installed:bundle:package" ] }, "package:bundle:version:create": { "aliases": [], "args": {}, "description": "Before you create a new bundle version, create a definition file (similar to a scratch org definition file) that contains the list of package versions to include in the bundle. The definition file must be JSON and you must specify the package versions in the correct order of installation. The package bundle version is based on package versions listed in the definition file.\n\nAfter the first bundle version that you create, make sure to update the version number in the sfdx-project.json file for subsequent bundle versions.\n\nTo retrieve details about a package bundle version create request, including status and package bundle version ID (04t), run \"sf package version create report -i 08c...\".", "examples": [ "Create a package bundle version in the Dev Hub org; uses the Dev Hub org with the username devhub@example.com:\n<%= config.bin %> <%= command.id %> --bundle “Your bundle name” --definition-file resources/definition.json --target-dev-hub devhub@example.com" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "bundle": { "char": "b", "name": "bundle", "required": true, "summary": "Name or ID of the package bundle to create a version for.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "description": { "char": "d", "name": "description", "summary": "Description of the package bundle version.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "definition-file": { "char": "p", "name": "definition-file", "required": true, "summary": "Path to a definition file, similar to a scratch org definition file, that contains the list of package versions to include in the bundle.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-dev-hub": { "aliases": [ "targetdevhubusername", "target-hub-org" ], "char": "v", "deprecateAliases": true, "name": "target-dev-hub", "noCacheDefault": true, "required": true, "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "wait": { "char": "w", "name": "wait", "summary": "Number of minutes to wait for the package bundle version to be created.", "default": 0, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "verbose": { "name": "verbose", "summary": "Show verbose output of the command execution.", "allowNo": false, "type": "boolean" }, "version-number": { "char": "n", "name": "version-number", "summary": "Version number of the package bundle version to be created; overrides the sfdx-project.json value.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hidden": true, "hiddenAliases": [], "id": "package:bundle:version:create", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "state": "beta", "strict": true, "summary": "Create a new package bundle version.", "enableJsonFlag": true, "requiresProject": true, "isESM": true, "relativePath": [ "lib", "commands", "package", "bundle", "version", "create.js" ], "aliasPermutations": [], "permutations": [ "package:bundle:version:create", "bundle:package:version:create", "bundle:version:package:create", "bundle:version:create:package", "package:version:bundle:create", "version:package:bundle:create", "version:bundle:package:create", "version:bundle:create:package", "package:version:create:bundle", "version:package:create:bundle", "version:create:package:bundle", "version:create:bundle:package", "package:bundle:create:version", "bundle:package:create:version", "bundle:create:package:version", "bundle:create:version:package", "package:create:bundle:version", "create:package:bundle:version", "create:bundle:package:version", "create:bundle:version:package", "package:create:version:bundle", "create:package:version:bundle", "create:version:package:bundle", "create:version:bundle:package" ] }, "package:bundle:version:list": { "aliases": [], "args": {}, "examples": [ "List package bundle versions in the Dev Hub org with the username devhub@example.com:\n<%= config.bin %> <%= command.id %> --target-dev-hub devhub@example.com" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-dev-hub": { "aliases": [ "targetdevhubusername", "target-hub-org" ], "char": "v", "deprecateAliases": true, "name": "target-dev-hub", "noCacheDefault": true, "required": true, "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "verbose": { "name": "verbose", "summary": "Display extended details about the package bundle versions.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": true, "hidden": true, "hiddenAliases": [], "id": "package:bundle:version:list", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "state": "beta", "strict": true, "summary": "List all package bundle versions in the Dev Hub org.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "package", "bundle", "version", "list.js" ], "aliasPermutations": [], "permutations": [ "package:bundle:version:list", "bundle:package:version:list", "bundle:version:package:list", "bundle:version:list:package", "package:version:bundle:list", "version:package:bundle:list", "version:bundle:package:list", "version:bundle:list:package", "package:version:list:bundle", "version:package:list:bundle", "version:list:package:bundle", "version:list:bundle:package", "package:bundle:list:version", "bundle:package:list:version", "bundle:list:package:version", "bundle:list:version:package", "package:list:bundle:version", "list:package:bundle:version", "list:bundle:package:version", "list:bundle:version:package", "package:list:version:bundle", "list:package:version:bundle", "list:version:package:bundle", "list:version:bundle:package" ] }, "package:bundle:version:report": { "aliases": [], "args": {}, "examples": [ "Retrieve details about the package bundle version; uses the Dev Hub org with the username devhub@example.com:\n<%= config.bin %> <%= command.id %> --bundle-version \"Your bundle version name or ID\" --target-dev-hub devhub@example.com" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-dev-hub": { "aliases": [ "targetdevhubusername", "target-hub-org" ], "char": "v", "deprecateAliases": true, "name": "target-dev-hub", "noCacheDefault": true, "required": true, "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "bundle-version": { "char": "b", "name": "bundle-version", "required": true, "summary": "Name or ID of the package bundle version to retrieve details about.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "verbose": { "name": "verbose", "summary": "Display extended details about the package bundle version.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": true, "hidden": true, "hiddenAliases": [], "id": "package:bundle:version:report", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "state": "beta", "strict": true, "summary": "Retrieve details about a specific package bundle version.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "package", "bundle", "version", "report.js" ], "aliasPermutations": [], "permutations": [ "package:bundle:version:report", "bundle:package:version:report", "bundle:version:package:report", "bundle:version:report:package", "package:version:bundle:report", "version:package:bundle:report", "version:bundle:package:report", "version:bundle:report:package", "package:version:report:bundle", "version:package:report:bundle", "version:report:package:bundle", "version:report:bundle:package", "package:bundle:report:version", "bundle:package:report:version", "bundle:report:package:version", "bundle:report:version:package", "package:report:bundle:version", "report:package:bundle:version", "report:bundle:package:version", "report:bundle:version:package", "package:report:version:bundle", "report:package:version:bundle", "report:version:package:bundle", "report:version:bundle:package" ] }, "package:version:create:list": { "aliases": [ "force:package:version:create:list" ], "args": {}, "deprecateAliases": true, "description": "Shows the details of each request to create a package version in the Dev Hub org.\n\nAll filter parameters are applied using the AND logical operator (not OR).\n\nTo get information about a specific request, run \"<%= config.bin %> package version create report\" and supply the request ID.", "examples": [ "List all package version creation requests in your default Dev Hub org:\n<%= config.bin %> <%= command.id %>", "List package version creation requests from the last 3 days in the Dev Hub org with username devhub@example.com:\n<%= config.bin %> <%= command.id %> --created-last-days 3 --target-dev-hub", "List package version creation requests with status Error:\n<%= config.bin %> <%= command.id %> --status Error", "List package version creation requests with status InProgress:\n<%= config.bin %> <%= command.id %> --status InProgress", "List package version creation requests with status Success that were created today:\n<%= config.bin %> <%= command.id %> --created-last-days 0 --status Success" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-dev-hub": { "aliases": [ "targetdevhubusername", "target-hub-org" ], "char": "v", "deprecateAliases": true, "name": "target-dev-hub", "noCacheDefault": true, "required": true, "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "created-last-days": { "aliases": [ "createdlastdays" ], "char": "c", "deprecateAliases": true, "name": "created-last-days", "summary": "Number of days since the request was created, starting at 00:00:00 of first day to now. Use 0 for today.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "status": { "char": "s", "name": "status", "summary": "Status of the version creation request, used to filter the list.", "hasDynamicHelp": false, "multiple": false, "options": [ "Queued", "InProgress", "Success", "Error" ], "type": "option" }, "show-conversions-only": { "name": "show-conversions-only", "summary": "Filter the list output to display only converted package version.", "allowNo": false, "type": "boolean" }, "verbose": { "name": "verbose", "summary": "Displays additional information at a slight performance cost, such as the version name and number for each package version create request.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "package:version:create:list", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "strict": true, "summary": "List package version creation requests.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "package", "version", "create", "list.js" ], "aliasPermutations": [ "force:package:version:create:list", "package:force:version:create:list", "package:version:force:create:list", "package:version:create:force:list", "package:version:create:list:force", "force:version:package:create:list", "version:force:package:create:list", "version:package:force:create:list", "version:package:create:force:list", "version:package:create:list:force", "force:version:create:package:list", "version:force:create:package:list", "version:create:force:package:list", "version:create:package:force:list", "version:create:package:list:force", "force:version:create:list:package", "version:force:create:list:package", "version:create:force:list:package", "version:create:list:force:package", "version:create:list:package:force", "force:package:create:version:list", "package:force:create:version:list", "package:create:force:version:list", "package:create:version:force:list", "package:create:version:list:force", "force:create:package:version:list", "create:force:package:version:list", "create:package:force:version:list", "create:package:version:force:list", "create:package:version:list:force", "force:create:version:package:list", "create:force:version:package:list", "create:version:force:package:list", "create:version:package:force:list", "create:version:package:list:force", "force:create:version:list:package", "create:force:version:list:package", "create:version:force:list:package", "create:version:list:force:package", "create:version:list:package:force", "force:package:create:list:version", "package:force:create:list:version", "package:create:force:list:version", "package:create:list:force:version", "package:create:list:version:force", "force:create:package:list:version", "create:force:package:list:version", "create:package:force:list:version", "create:package:list:force:version", "create:package:list:version:force", "force:create:list:package:version", "create:force:list:package:version", "create:list:force:package:version", "create:list:package:force:version", "create:list:package:version:force", "force:create:list:version:package", "create:force:list:version:package", "create:list:force:version:package", "create:list:version:force:package", "create:list:version:package:force", "force:package:version:list:create", "package:force:version:list:create", "package:version:force:list:create", "package:version:list:force:create", "package:version:list:create:force", "force:version:package:list:create", "version:force:package:list:create", "version:package:force:list:create", "version:package:list:force:create", "version:package:list:create:force", "force:version:list:package:create", "version:force:list:package:create", "version:list:force:package:create", "version:list:package:force:create", "version:list:package:create:force", "force:version:list:create:package", "version:force:list:create:package", "version:list:force:create:package", "version:list:create:force:package", "version:list:create:package:force", "force:package:list:version:create", "package:force:list:version:create", "package:list:force:version:create", "package:list:version:force:create", "package:list:version:create:force", "force:list:package:version:create", "list:force:package:version:create", "list:package:force:version:create", "list:package:version:force:create", "list:package:version:create:force", "force:list:version:package:create", "list:force:version:package:create", "list:version:force:package:create", "list:version:package:force:create", "list:version:package:create:force", "force:list:version:create:package", "list:force:version:create:package", "list:version:force:create:package", "list:version:create:force:package", "list:version:create:package:force", "force:package:list:create:version", "package:force:list:create:version", "package:list:force:create:version", "package:list:create:force:version", "package:list:create:version:force", "force:list:package:create:version", "list:force:package:create:version", "list:package:force:create:version", "list:package:create:force:version", "list:package:create:version:force", "force:list:create:package:version", "list:force:create:package:version", "list:create:force:package:version", "list:create:package:force:version", "list:create:package:version:force", "force:list:create:version:package", "list:force:create:version:package", "list:create:force:version:package", "list:create:version:force:package", "list:create:version:package:force" ], "permutations": [ "package:version:create:list", "version:package:create:list", "version:create:package:list", "version:create:list:package", "package:create:version:list", "create:package:version:list", "create:version:package:list", "create:version:list:package", "package:create:list:version", "create:package:list:version", "create:list:package:version", "create:list:version:package", "package:version:list:create", "version:package:list:create", "version:list:package:create", "version:list:create:package", "package:list:version:create", "list:package:version:create", "list:version:package:create", "list:version:create:package", "package:list:create:version", "list:package:create:version", "list:create:package:version", "list:create:version:package" ] }, "package:version:create:report": { "aliases": [ "force:package:version:create:report" ], "args": {}, "deprecateAliases": true, "description": "Specify the request ID for which you want to view details. If applicable, the command displays errors related to the request.\n\nTo show all requests in the org, run \"<%= config.bin %> package version create list\".", "examples": [ "Retrieve details about the package version creation request with the specified ID; uses your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --package-create-request-id 08c...", "Retrieve details about the specified package version creation request in the Dev Hub org with username devhub@example.com:\n<%= config.bin %> <%= command.id %> --package-create-request-id 08c... --target-dev-hub devhub@example.com" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-dev-hub": { "aliases": [ "targetdevhubusername", "target-hub-org" ], "char": "v", "deprecateAliases": true, "name": "target-dev-hub", "noCacheDefault": true, "required": true, "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "package-create-request-id": { "aliases": [ "packagecreaterequestid" ], "char": "i", "deprecateAliases": true, "name": "package-create-request-id", "required": true, "summary": "ID (starts with 08c) of the package version creation request you want to display.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "package:version:create:report", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "strict": true, "summary": "Retrieve details about a package version creation request.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "package", "version", "create", "report.js" ], "aliasPermutations": [ "force:package:version:create:report", "package:force:version:create:report", "package:version:force:create:report", "package:version:create:force:report", "package:version:create:report:force", "force:version:package:create:report", "version:force:package:create:report", "version:package:force:create:report", "version:package:create:force:report", "version:package:create:report:force", "force:version:create:package:report", "version:force:create:package:report", "version:create:force:package:report", "version:create:package:force:report", "version:create:package:report:force", "force:version:create:report:package", "version:force:create:report:package", "version:create:force:report:package", "version:create:report:force:package", "version:create:report:package:force", "force:package:create:version:report", "package:force:create:version:report", "package:create:force:version:report", "package:create:version:force:report", "package:create:version:report:force", "force:create:package:version:report", "create:force:package:version:report", "create:package:force:version:report", "create:package:version:force:report", "create:package:version:report:force", "force:create:version:package:report", "create:force:version:package:report", "create:version:force:package:report", "create:version:package:force:report", "create:version:package:report:force", "force:create:version:report:package", "create:force:version:report:package", "create:version:force:report:package", "create:version:report:force:package", "create:version:report:package:force", "force:package:create:report:version", "package:force:create:report:version", "package:create:force:report:version", "package:create:report:force:version", "package:create:report:version:force", "force:create:package:report:version", "create:force:package:report:version", "create:package:force:report:version", "create:package:report:force:version", "create:package:report:version:force", "force:create:report:package:version", "create:force:report:package:version", "create:report:force:package:version", "create:report:package:force:version", "create:report:package:version:force", "force:create:report:version:package", "create:force:report:version:package", "create:report:force:version:package", "create:report:version:force:package", "create:report:version:package:force", "force:package:version:report:create", "package:force:version:report:create", "package:version:force:report:create", "package:version:report:force:create", "package:version:report:create:force", "force:version:package:report:create", "version:force:package:report:create", "version:package:force:report:create", "version:package:report:force:create", "version:package:report:create:force", "force:version:report:package:create", "version:force:report:package:create", "version:report:force:package:create", "version:report:package:force:create", "version:report:package:create:force", "force:version:report:create:package", "version:force:report:create:package", "version:report:force:create:package", "version:report:create:force:package", "version:report:create:package:force", "force:package:report:version:create", "package:force:report:version:create", "package:report:force:version:create", "package:report:version:force:create", "package:report:version:create:force", "force:report:package:version:create", "report:force:package:version:create", "report:package:force:version:create", "report:package:version:force:create", "report:package:version:create:force", "force:report:version:package:create", "report:force:version:package:create", "report:version:force:package:create", "report:version:package:force:create", "report:version:package:create:force", "force:report:version:create:package", "report:force:version:create:package", "report:version:force:create:package", "report:version:create:force:package", "report:version:create:package:force", "force:package:report:create:version", "package:force:report:create:version", "package:report:force:create:version", "package:report:create:force:version", "package:report:create:version:force", "force:report:package:create:version", "report:force:package:create:version", "report:package:force:create:version", "report:package:create:force:version", "report:package:create:version:force", "force:report:create:package:version", "report:force:create:package:version", "report:create:force:package:version", "report:create:package:force:version", "report:create:package:version:force", "force:report:create:version:package", "report:force:create:version:package", "report:create:force:version:package", "report:create:version:force:package", "report:create:version:package:force" ], "permutations": [ "package:version:create:report", "version:package:create:report", "version:create:package:report", "version:create:report:package", "package:create:version:report", "create:package:version:report", "create:version:package:report", "create:version:report:package", "package:create:report:version", "create:package:report:version", "create:report:package:version", "create:report:version:package", "package:version:report:create", "version:package:report:create", "version:report:package:create", "version:report:create:package", "package:report:version:create", "report:package:version:create", "report:version:package:create", "report:version:create:package", "package:report:create:version", "report:package:create:version", "report:create:package:version", "report:create:version:package" ] }, "package1:version:create:get": { "aliases": [ "force:package1:version:create:get" ], "args": {}, "deprecateAliases": true, "examples": [ "Get the status of the creation request for the package version with the specified ID in your default org:\n<%= config.bin %> <%= command.id %> --request-id 0HD...", "Same as previous example, but use the specified org:\n<%= config.bin %> <%= command.id %> --request-id 0HD... --target-org myorg@example.com" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-org": { "aliases": [ "targetusername", "u" ], "char": "o", "deprecateAliases": true, "name": "target-org", "noCacheDefault": true, "required": true, "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "request-id": { "aliases": [ "requestid" ], "char": "i", "deprecateAliases": true, "name": "request-id", "required": true, "summary": "ID of the PackageUploadRequest (starts with 0HD).", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "package1:version:create:get", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "strict": true, "summary": "Retrieve the status of a package version creation request.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "package1", "version", "create", "get.js" ], "aliasPermutations": [ "force:package1:version:create:get", "package1:force:version:create:get", "package1:version:force:create:get", "package1:version:create:force:get", "package1:version:create:get:force", "force:version:package1:create:get", "version:force:package1:create:get", "version:package1:force:create:get", "version:package1:create:force:get", "version:package1:create:get:force", "force:version:create:package1:get", "version:force:create:package1:get", "version:create:force:package1:get", "version:create:package1:force:get", "version:create:package1:get:force", "force:version:create:get:package1", "version:force:create:get:package1", "version:create:force:get:package1", "version:create:get:force:package1", "version:create:get:package1:force", "force:package1:create:version:get", "package1:force:create:version:get", "package1:create:force:version:get", "package1:create:version:force:get", "package1:create:version:get:force", "force:create:package1:version:get", "create:force:package1:version:get", "create:package1:force:version:get", "create:package1:version:force:get", "create:package1:version:get:force", "force:create:version:package1:get", "create:force:version:package1:get", "create:version:force:package1:get", "create:version:package1:force:get", "create:version:package1:get:force", "force:create:version:get:package1", "create:force:version:get:package1", "create:version:force:get:package1", "create:version:get:force:package1", "create:version:get:package1:force", "force:package1:create:get:version", "package1:force:create:get:version", "package1:create:force:get:version", "package1:create:get:force:version", "package1:create:get:version:force", "force:create:package1:get:version", "create:force:package1:get:version", "create:package1:force:get:version", "create:package1:get:force:version", "create:package1:get:version:force", "force:create:get:package1:version", "create:force:get:package1:version", "create:get:force:package1:version", "create:get:package1:force:version", "create:get:package1:version:force", "force:create:get:version:package1", "create:force:get:version:package1", "create:get:force:version:package1", "create:get:version:force:package1", "create:get:version:package1:force", "force:package1:version:get:create", "package1:force:version:get:create", "package1:version:force:get:create", "package1:version:get:force:create", "package1:version:get:create:force", "force:version:package1:get:create", "version:force:package1:get:create", "version:package1:force:get:create", "version:package1:get:force:create", "version:package1:get:create:force", "force:version:get:package1:create", "version:force:get:package1:create", "version:get:force:package1:create", "version:get:package1:force:create", "version:get:package1:create:force", "force:version:get:create:package1", "version:force:get:create:package1", "version:get:force:create:package1", "version:get:create:force:package1", "version:get:create:package1:force", "force:package1:get:version:create", "package1:force:get:version:create", "package1:get:force:version:create", "package1:get:version:force:create", "package1:get:version:create:force", "force:get:package1:version:create", "get:force:package1:version:create", "get:package1:force:version:create", "get:package1:version:force:create", "get:package1:version:create:force", "force:get:version:package1:create", "get:force:version:package1:create", "get:version:force:package1:create", "get:version:package1:force:create", "get:version:package1:create:force", "force:get:version:create:package1", "get:force:version:create:package1", "get:version:force:create:package1", "get:version:create:force:package1", "get:version:create:package1:force", "force:package1:get:create:version", "package1:force:get:create:version", "package1:get:force:create:version", "package1:get:create:force:version", "package1:get:create:version:force", "force:get:package1:create:version", "get:force:package1:create:version", "get:package1:force:create:version", "get:package1:create:force:version", "get:package1:create:version:force", "force:get:create:package1:version", "get:force:create:package1:version", "get:create:force:package1:version", "get:create:package1:force:version", "get:create:package1:version:force", "force:get:create:version:package1", "get:force:create:version:package1", "get:create:force:version:package1", "get:create:version:force:package1", "get:create:version:package1:force" ], "permutations": [ "package1:version:create:get", "version:package1:create:get", "version:create:package1:get", "version:create:get:package1", "package1:create:version:get", "create:package1:version:get", "create:version:package1:get", "create:version:get:package1", "package1:create:get:version", "create:package1:get:version", "create:get:package1:version", "create:get:version:package1", "package1:version:get:create", "version:package1:get:create", "version:get:package1:create", "version:get:create:package1", "package1:get:version:create", "get:package1:version:create", "get:version:package1:create", "get:version:create:package1", "package1:get:create:version", "get:package1:create:version", "get:create:package1:version", "get:create:version:package1" ] }, "package:bundle:version:create:list": { "aliases": [], "args": {}, "description": "Shows the details of each request to create a package bundle version in the Dev Hub org.\n\nAll filter parameters are applied using the AND logical operator (not OR).\n\nTo get information about a specific request, run \"<%= config.bin %> package bundle version create report\" and enter the request ID.", "examples": [ "List all package bundle version creation requests in your default Dev Hub org:\n<%= config.bin %> <%= command.id %>", "List package bundle version creation requests from the last three days in the Dev Hub org with the username devhub@example.com:\n<%= config.bin %> <%= command.id %> --created-last-days 3 --target-dev-hub devhub@example.com", "List package bundle version creation requests with the Error status:\n<%= config.bin %> <%= command.id %> --status Error", "List package bundle version creation requests with the Queued status:\n<%= config.bin %> <%= command.id %> --status Queued", "List package bundle version creation requests from today with the Success status:\n<%= config.bin %> <%= command.id %> --created-last-days 0 --status Success" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-dev-hub": { "aliases": [ "targetdevhubusername", "target-hub-org" ], "char": "v", "deprecateAliases": true, "name": "target-dev-hub", "noCacheDefault": true, "required": true, "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "created-last-days": { "char": "c", "name": "created-last-days", "summary": "Number of days since the request was created, starting at 0. Use 0 for today.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "status": { "char": "s", "name": "status", "summary": "Status of the installation request, used to filter the list.", "hasDynamicHelp": false, "multiple": false, "options": [ "Queued", "InProgress", "Success", "Error" ], "type": "option" }, "verbose": { "name": "verbose", "summary": "Display additional information, such as the version name and number for each package bundle version creation request.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": true, "hidden": true, "hiddenAliases": [], "id": "package:bundle:version:create:list", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "state": "beta", "strict": true, "summary": "List package bundle version creation requests.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "package", "bundle", "version", "create", "list.js" ], "aliasPermutations": [], "permutations": [ "package:bundle:version:create:list", "bundle:package:version:create:list", "bundle:version:package:create:list", "bundle:version:create:package:list", "bundle:version:create:list:package", "package:version:bundle:create:list", "version:package:bundle:create:list", "version:bundle:package:create:list", "version:bundle:create:package:list", "version:bundle:create:list:package", "package:version:create:bundle:list", "version:package:create:bundle:list", "version:create:package:bundle:list", "version:create:bundle:package:list", "version:create:bundle:list:package", "package:version:create:list:bundle", "version:package:create:list:bundle", "version:create:package:list:bundle", "version:create:list:package:bundle", "version:create:list:bundle:package", "package:bundle:create:version:list", "bundle:package:create:version:list", "bundle:create:package:version:list", "bundle:create:version:package:list", "bundle:create:version:list:package", "package:create:bundle:version:list", "create:package:bundle:version:list", "create:bundle:package:version:list", "create:bundle:version:package:list", "create:bundle:version:list:package", "package:create:version:bundle:list", "create:package:version:bundle:list", "create:version:package:bundle:list", "create:version:bundle:package:list", "create:version:bundle:list:package", "package:create:version:list:bundle", "create:package:version:list:bundle", "create:version:package:list:bundle", "create:version:list:package:bundle", "create:version:list:bundle:package", "package:bundle:create:list:version", "bundle:package:create:list:version", "bundle:create:package:list:version", "bundle:create:list:package:version", "bundle:create:list:version:package", "package:create:bundle:list:version", "create:package:bundle:list:version", "create:bundle:package:list:version", "create:bundle:list:package:version", "create:bundle:list:version:package", "package:create:list:bundle:version", "create:package:list:bundle:version", "create:list:package:bundle:version", "create:list:bundle:package:version", "create:list:bundle:version:package", "package:create:list:version:bundle", "create:package:list:version:bundle", "create:list:package:version:bundle", "create:list:version:package:bundle", "create:list:version:bundle:package", "package:bundle:version:list:create", "bundle:package:version:list:create", "bundle:version:package:list:create", "bundle:version:list:package:create", "bundle:version:list:create:package", "package:version:bundle:list:create", "version:package:bundle:list:create", "version:bundle:package:list:create", "version:bundle:list:package:create", "version:bundle:list:create:package", "package:version:list:bundle:create", "version:package:list:bundle:create", "version:list:package:bundle:create", "version:list:bundle:package:create", "version:list:bundle:create:package", "package:version:list:create:bundle", "version:package:list:create:bundle", "version:list:package:create:bundle", "version:list:create:package:bundle", "version:list:create:bundle:package", "package:bundle:list:version:create", "bundle:package:list:version:create", "bundle:list:package:version:create", "bundle:list:version:package:create", "bundle:list:version:create:package", "package:list:bundle:version:create", "list:package:bundle:version:create", "list:bundle:package:version:create", "list:bundle:version:package:create", "list:bundle:version:create:package", "package:list:version:bundle:create", "list:package:version:bundle:create", "list:version:package:bundle:create", "list:version:bundle:package:create", "list:version:bundle:create:package", "package:list:version:create:bundle", "list:package:version:create:bundle", "list:version:package:create:bundle", "list:version:create:package:bundle", "list:version:create:bundle:package", "package:bundle:list:create:version", "bundle:package:list:create:version", "bundle:list:package:create:version", "bundle:list:create:package:version", "bundle:list:create:version:package", "package:list:bundle:create:version", "list:package:bundle:create:version", "list:bundle:package:create:version", "list:bundle:create:package:version", "list:bundle:create:version:package", "package:list:create:bundle:version", "list:package:create:bundle:version", "list:create:package:bundle:version", "list:create:bundle:package:version", "list:create:bundle:version:package", "package:list:create:version:bundle", "list:package:create:version:bundle", "list:create:package:version:bundle", "list:create:version:package:bundle", "list:create:version:bundle:package" ] }, "package:bundle:version:create:report": { "aliases": [], "args": {}, "description": "The command returns information such as the request's current status and details about the package bundle version being created.", "examples": [ "Report on a package bundle version creation request:\n<%= config.bin %> <%= command.id %> --package-create-request-id 0Ho0x0000000000000" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-dev-hub": { "aliases": [ "targetdevhubusername", "target-hub-org" ], "char": "v", "deprecateAliases": true, "name": "target-dev-hub", "noCacheDefault": true, "required": true, "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "bundle-version-create-request-id": { "char": "i", "name": "bundle-version-create-request-id", "required": true, "summary": "ID of the package bundle version creation request to report on.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hidden": true, "hiddenAliases": [], "id": "package:bundle:version:create:report", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "state": "beta", "strict": true, "summary": "Report on the status of a package bundle version creation request.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "package", "bundle", "version", "create", "report.js" ], "aliasPermutations": [], "permutations": [ "package:bundle:version:create:report", "bundle:package:version:create:report", "bundle:version:package:create:report", "bundle:version:create:package:report", "bundle:version:create:report:package", "package:version:bundle:create:report", "version:package:bundle:create:report", "version:bundle:package:create:report", "version:bundle:create:package:report", "version:bundle:create:report:package", "package:version:create:bundle:report", "version:package:create:bundle:report", "version:create:package:bundle:report", "version:create:bundle:package:report", "version:create:bundle:report:package", "package:version:create:report:bundle", "version:package:create:report:bundle", "version:create:package:report:bundle", "version:create:report:package:bundle", "version:create:report:bundle:package", "package:bundle:create:version:report", "bundle:package:create:version:report", "bundle:create:package:version:report", "bundle:create:version:package:report", "bundle:create:version:report:package", "package:create:bundle:version:report", "create:package:bundle:version:report", "create:bundle:package:version:report", "create:bundle:version:package:report", "create:bundle:version:report:package", "package:create:version:bundle:report", "create:package:version:bundle:report", "create:version:package:bundle:report", "create:version:bundle:package:report", "create:version:bundle:report:package", "package:create:version:report:bundle", "create:package:version:report:bundle", "create:version:package:report:bundle", "create:version:report:package:bundle", "create:version:report:bundle:package", "package:bundle:create:report:version", "bundle:package:create:report:version", "bundle:create:package:report:version", "bundle:create:report:package:version", "bundle:create:report:version:package", "package:create:bundle:report:version", "create:package:bundle:report:version", "create:bundle:package:report:version", "create:bundle:report:package:version", "create:bundle:report:version:package", "package:create:report:bundle:version", "create:package:report:bundle:version", "create:report:package:bundle:version", "create:report:bundle:package:version", "create:report:bundle:version:package", "package:create:report:version:bundle", "create:package:report:version:bundle", "create:report:package:version:bundle", "create:report:version:package:bundle", "create:report:version:bundle:package", "package:bundle:version:report:create", "bundle:package:version:report:create", "bundle:version:package:report:create", "bundle:version:report:package:create", "bundle:version:report:create:package", "package:version:bundle:report:create", "version:package:bundle:report:create", "version:bundle:package:report:create", "version:bundle:report:package:create", "version:bundle:report:create:package", "package:version:report:bundle:create", "version:package:report:bundle:create", "version:report:package:bundle:create", "version:report:bundle:package:create", "version:report:bundle:create:package", "package:version:report:create:bundle", "version:package:report:create:bundle", "version:report:package:create:bundle", "version:report:create:package:bundle", "version:report:create:bundle:package", "package:bundle:report:version:create", "bundle:package:report:version:create", "bundle:report:package:version:create", "bundle:report:version:package:create", "bundle:report:version:create:package", "package:report:bundle:version:create", "report:package:bundle:version:create", "report:bundle:package:version:create", "report:bundle:version:package:create", "report:bundle:version:create:package", "package:report:version:bundle:create", "report:package:version:bundle:create", "report:version:package:bundle:create", "report:version:bundle:package:create", "report:version:bundle:create:package", "package:report:version:create:bundle", "report:package:version:create:bundle", "report:version:package:create:bundle", "report:version:create:package:bundle", "report:version:create:bundle:package", "package:bundle:report:create:version", "bundle:package:report:create:version", "bundle:report:package:create:version", "bundle:report:create:package:version", "bundle:report:create:version:package", "package:report:bundle:create:version", "report:package:bundle:create:version", "report:bundle:package:create:version", "report:bundle:create:package:version", "report:bundle:create:version:package", "package:report:create:bundle:version", "report:package:create:bundle:version", "report:create:package:bundle:version", "report:create:bundle:package:version", "report:create:bundle:version:package", "package:report:create:version:bundle", "report:package:create:version:bundle", "report:create:package:version:bundle", "report:create:version:package:bundle", "report:create:version:bundle:package" ] } }, "version": "2.28.3" }