@salesforce/plugin-packaging

{ "commands": { "package:convert": { "aliases": [ "force:package:convert" ], "args": {}, "deprecateAliases": true, "description": "The package convert creates a new package in the Dev Hub if one does not already exist for the specified first-generation package.\n\nIt then creates a new package version in the Dev Hub with contents based on the specified first-generation package.\n\nThe latest released non-patch package version from the specified first-generation package will be converted.\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 specifying the --installation-key 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\".", "examples": [ "Create a second-generation package version from the first-generation 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 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 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" } }, "hasDynamicHelp": true, "hidden": true, "hiddenAliases": [], "id": "package:convert", "pluginAlias": "@salesforce/plugin-packaging", "pluginName": "@salesforce/plugin-packaging", "pluginType": "core", "strict": true, "summary": "Create a second-generation package version from a first-generation package.", "enableJsonFlag": 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 removed components, except for custom objects and custom fields, that don't have dependencies.\n- Delete: Delete all removed components that can be safely deleted, and deprecate the other components.", "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" } }, "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: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: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: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 che