@salesforce/plugin-packaging 1.12.3 → 1.12.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +0 -2
- package/lib/commands/package/convert.d.ts +23 -0
- package/lib/commands/package/convert.js +128 -0
- package/lib/commands/package/convert.js.map +1 -0
- package/lib/commands/package/create.d.ts +26 -0
- package/lib/commands/package/create.js +92 -0
- package/lib/commands/package/create.js.map +1 -0
- package/lib/commands/package/delete.d.ts +20 -0
- package/lib/commands/package/delete.js +65 -0
- package/lib/commands/package/delete.js.map +1 -0
- package/lib/commands/package/install/report.d.ts +19 -0
- package/lib/commands/package/install/report.js +65 -0
- package/lib/commands/package/install/report.js.map +1 -0
- package/lib/commands/package/install.d.ts +31 -0
- package/lib/commands/{force/package → package}/install.js +72 -76
- package/lib/commands/package/install.js.map +1 -0
- package/lib/commands/package/installed/list.d.ts +24 -0
- package/lib/commands/{force/package → package}/installed/list.js +19 -14
- package/lib/commands/package/installed/list.js.map +1 -0
- package/lib/commands/package/list.d.ts +26 -0
- package/lib/commands/{force/package → package}/list.js +23 -21
- package/lib/commands/package/list.js.map +1 -0
- package/lib/commands/package/uninstall/report.d.ts +15 -0
- package/lib/commands/package/uninstall/report.js +46 -0
- package/lib/commands/package/uninstall/report.js.map +1 -0
- package/lib/commands/package/uninstall.d.ts +19 -0
- package/lib/commands/package/uninstall.js +60 -0
- package/lib/commands/package/uninstall.js.map +1 -0
- package/lib/commands/package/update.d.ts +20 -0
- package/lib/commands/package/update.js +67 -0
- package/lib/commands/package/update.js.map +1 -0
- package/lib/commands/package/version/create/list.d.ts +18 -0
- package/lib/commands/{force/package → package}/version/create/list.js +28 -20
- package/lib/commands/package/version/create/list.js.map +1 -0
- package/lib/commands/package/version/create/report.d.ts +19 -0
- package/lib/commands/{force/package → package}/version/create/report.js +28 -24
- package/lib/commands/package/version/create/report.js.map +1 -0
- package/lib/commands/package/version/create.d.ts +40 -0
- package/lib/commands/package/version/create.js +220 -0
- package/lib/commands/package/version/create.js.map +1 -0
- package/lib/commands/package/version/delete.d.ts +21 -0
- package/lib/commands/package/version/delete.js +71 -0
- package/lib/commands/package/version/delete.js.map +1 -0
- package/lib/commands/package/version/displayancestry.d.ts +19 -0
- package/lib/commands/package/version/displayancestry.js +74 -0
- package/lib/commands/package/version/displayancestry.js.map +1 -0
- package/lib/commands/package/version/list.d.ts +40 -0
- package/lib/commands/{force/package → package}/version/list.js +56 -57
- package/lib/commands/package/version/list.js.map +1 -0
- package/lib/commands/package/version/promote.d.ts +18 -0
- package/lib/commands/{force/package → package}/version/promote.js +28 -25
- package/lib/commands/package/version/promote.js.map +1 -0
- package/lib/commands/package/version/report.d.ts +29 -0
- package/lib/commands/{force/package → package}/version/report.js +34 -32
- package/lib/commands/package/version/report.js.map +1 -0
- package/lib/commands/package/version/update.d.ts +22 -0
- package/lib/commands/package/version/update.js +77 -0
- package/lib/commands/package/version/update.js.map +1 -0
- package/lib/commands/package1/version/create/get.d.ts +15 -0
- package/lib/commands/{force/package1 → package1}/version/create/get.js +22 -14
- package/lib/commands/package1/version/create/get.js.map +1 -0
- package/lib/commands/package1/version/create.d.ts +28 -0
- package/lib/commands/package1/version/create.js +130 -0
- package/lib/commands/package1/version/create.js.map +1 -0
- package/lib/commands/package1/version/display.d.ts +16 -0
- package/lib/commands/{force/package1 → package1}/version/display.js +20 -18
- package/lib/commands/package1/version/display.js.map +1 -0
- package/lib/commands/package1/version/list.d.ts +16 -0
- package/lib/commands/{force/package1 → package1}/version/list.js +21 -20
- package/lib/commands/package1/version/list.js.map +1 -0
- package/messages/package1_version_create.md +33 -44
- package/messages/package1_version_create_get.md +11 -10
- package/messages/package1_version_display.md +10 -8
- package/messages/package1_version_list.md +14 -8
- package/messages/package_convert.md +31 -31
- package/messages/package_create.md +31 -40
- package/messages/package_delete.md +15 -20
- package/messages/package_displayancestry.md +25 -19
- package/messages/package_install.md +43 -52
- package/messages/package_install_report.md +9 -8
- package/messages/package_installed_list.md +9 -4
- package/messages/package_list.md +16 -13
- package/messages/package_uninstall.md +17 -15
- package/messages/package_uninstall_report.md +11 -10
- package/messages/package_update.md +13 -18
- package/messages/package_version_create.md +82 -130
- package/messages/package_version_create_list.md +26 -14
- package/messages/package_version_create_report.md +13 -10
- package/messages/package_version_delete.md +17 -17
- package/messages/package_version_list.md +29 -32
- package/messages/package_version_promote.md +22 -16
- package/messages/package_version_report.md +13 -14
- package/messages/package_version_update.md +23 -37
- package/messages/packaging.md +4 -12
- package/oclif.manifest.json +2455 -1
- package/package.json +60 -75
- package/schemas/package-convert.json +73 -0
- package/schemas/package-create.json +16 -0
- package/schemas/package-delete.json +72 -0
- package/schemas/package-install-report.json +169 -0
- package/schemas/package-install.json +169 -0
- package/schemas/package-installed-list.json +40 -0
- package/schemas/package-list.json +55 -0
- package/schemas/package-uninstall-report.json +51 -0
- package/schemas/package-uninstall.json +54 -0
- package/schemas/package-update.json +72 -0
- package/schemas/package-version-create-list.json +79 -0
- package/schemas/package-version-create-report.json +79 -0
- package/schemas/package-version-create.json +60 -0
- package/schemas/package-version-delete.json +72 -0
- package/schemas/package-version-displayancestry.json +61 -0
- package/schemas/package-version-list.json +146 -0
- package/schemas/package-version-promote.json +72 -0
- package/schemas/package-version-report.json +232 -0
- package/schemas/package-version-update.json +72 -0
- package/schemas/package1-version-create-get.json +91 -0
- package/schemas/package1-version-create.json +94 -0
- package/schemas/package1-version-display.json +37 -0
- package/schemas/package1-version-list.json +37 -0
- package/lib/commands/force/package/convert.d.ts +0 -11
- package/lib/commands/force/package/convert.js +0 -106
- package/lib/commands/force/package/convert.js.map +0 -1
- package/lib/commands/force/package/create.d.ts +0 -13
- package/lib/commands/force/package/create.js +0 -82
- package/lib/commands/force/package/create.js.map +0 -1
- package/lib/commands/force/package/delete.d.ts +0 -12
- package/lib/commands/force/package/delete.js +0 -63
- package/lib/commands/force/package/delete.js.map +0 -1
- package/lib/commands/force/package/install/report.d.ts +0 -12
- package/lib/commands/force/package/install/report.js +0 -39
- package/lib/commands/force/package/install/report.js.map +0 -1
- package/lib/commands/force/package/install.d.ts +0 -20
- package/lib/commands/force/package/install.js.map +0 -1
- package/lib/commands/force/package/installed/list.d.ts +0 -18
- package/lib/commands/force/package/installed/list.js.map +0 -1
- package/lib/commands/force/package/list.d.ts +0 -19
- package/lib/commands/force/package/list.js.map +0 -1
- package/lib/commands/force/package/uninstall/report.d.ts +0 -10
- package/lib/commands/force/package/uninstall/report.js +0 -44
- package/lib/commands/force/package/uninstall/report.js.map +0 -1
- package/lib/commands/force/package/uninstall.d.ts +0 -12
- package/lib/commands/force/package/uninstall.js +0 -55
- package/lib/commands/force/package/uninstall.js.map +0 -1
- package/lib/commands/force/package/update.d.ts +0 -11
- package/lib/commands/force/package/update.js +0 -63
- package/lib/commands/force/package/update.js.map +0 -1
- package/lib/commands/force/package/version/create/list.d.ts +0 -10
- package/lib/commands/force/package/version/create/list.js.map +0 -1
- package/lib/commands/force/package/version/create/report.d.ts +0 -11
- package/lib/commands/force/package/version/create/report.js.map +0 -1
- package/lib/commands/force/package/version/create.d.ts +0 -12
- package/lib/commands/force/package/version/create.js +0 -203
- package/lib/commands/force/package/version/create.js.map +0 -1
- package/lib/commands/force/package/version/delete.d.ts +0 -13
- package/lib/commands/force/package/version/delete.js +0 -66
- package/lib/commands/force/package/version/delete.js.map +0 -1
- package/lib/commands/force/package/version/displayancestry.d.ts +0 -13
- package/lib/commands/force/package/version/displayancestry.js +0 -70
- package/lib/commands/force/package/version/displayancestry.js.map +0 -1
- package/lib/commands/force/package/version/list.d.ts +0 -27
- package/lib/commands/force/package/version/list.js.map +0 -1
- package/lib/commands/force/package/version/promote.d.ts +0 -11
- package/lib/commands/force/package/version/promote.js.map +0 -1
- package/lib/commands/force/package/version/report.d.ts +0 -22
- package/lib/commands/force/package/version/report.js.map +0 -1
- package/lib/commands/force/package/version/update.d.ts +0 -11
- package/lib/commands/force/package/version/update.js +0 -73
- package/lib/commands/force/package/version/update.js.map +0 -1
- package/lib/commands/force/package1/version/create/get.d.ts +0 -10
- package/lib/commands/force/package1/version/create/get.js.map +0 -1
- package/lib/commands/force/package1/version/create.d.ts +0 -13
- package/lib/commands/force/package1/version/create.js +0 -115
- package/lib/commands/force/package1/version/create.js.map +0 -1
- package/lib/commands/force/package1/version/display.d.ts +0 -9
- package/lib/commands/force/package1/version/display.js.map +0 -1
- package/lib/commands/force/package1/version/list.d.ts +0 -9
- package/lib/commands/force/package1/version/list.js.map +0 -1
package/oclif.manifest.json
CHANGED
|
@@ -1 +1,2455 @@
|
|
|
1
|
-
{"version":"1.12.3","commands":{"force:package:convert":{"id":"force:package:convert","description":"creates a second-generation package version from a first-generation package\n\nThe 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 \"sfdx force:package:version:create:report -i 08c...\".\n\nWe recommend specifying the --installationkey 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 \"sfdx force:package:version:create:list\".","strict":true,"usage":"<%= command.id %> -p <id> [-k <string>] [-x] [-w <minutes>] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-packaging","pluginAlias":"@salesforce/plugin-packaging","pluginType":"core","hidden":true,"aliases":["force:package:beta:convert"],"examples":["$ sfdx force:package:convert --package 033xx0000004Gmn -k password123"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetdevhubusername":{"name":"targetdevhubusername","type":"option","char":"v","description":"username or alias for the dev hub org; overrides default dev hub org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"package":{"name":"package","type":"option","char":"p","description":"ID (starts with 033) of the first-generation package to convert","required":true,"multiple":false},"installationkey":{"name":"installationkey","type":"option","char":"k","description":"installation key for key-protected package (either --installationkey or --installationkeybypass is required)","multiple":false},"definitionfile":{"name":"definitionfile","type":"option","char":"f","description":"path to a definition file that contains features and org preferences that the metadata of the package version depends on.","hidden":true,"multiple":false},"installationkeybypass":{"name":"installationkeybypass","type":"boolean","char":"x","description":"bypass the installation key requirement (either --installationkey or --installationkeybypass is required)","allowNo":false},"wait":{"name":"wait","type":"option","char":"w","description":"minutes to wait for the package version to be created","multiple":false,"default":{"quantity":0,"unit":0}},"buildinstance":{"name":"buildinstance","type":"option","char":"s","description":"the instance where the conversion package version will be created——for example, NA50","hidden":true,"multiple":false}},"args":[],"requiresDevhubUsername":true,"flagsConfig":{"package":{"kind":"id","char":"p","description":"ID (starts with 033) of the first-generation package to convert","longDescription":"The ID (starts with 033) or alias of the package to convert.","required":true,"validate":{},"input":[],"multiple":false,"type":"option"},"installationkey":{"kind":"string","char":"k","description":"installation key for key-protected package (either --installationkey or --installationkeybypass is required)","longDescription":"Installation key for creating the key-protected package. Either an --installationkey value or the --installationkeybypass flag is required.","exactlyOne":["installationkey","installationkeybypass"],"input":[],"multiple":false,"type":"option"},"definitionfile":{"kind":"filepath","char":"f","description":"path to a definition file that contains features and org preferences that the metadata of the package version depends on.","longDescription":"The path to a definition file, similar to the scratch org definition file, that contains the list of features and org preferences that the metadata of the package version depends on.","hidden":true,"input":[],"multiple":false,"type":"option"},"installationkeybypass":{"kind":"boolean","char":"x","description":"bypass the installation key requirement (either --installationkey or --installationkeybypass is required)","longDescription":"Bypasses the installation key requirement. If you bypass this requirement, anyone can install your package. Either an --installationkey value or the --installationkeybypass flag is required.","exactlyOne":["installationkey","installationkeybypass"],"allowNo":false,"type":"boolean"},"wait":{"kind":"minutes","char":"w","description":"minutes to wait for the package version to be created","longDescription":"The number of minutes to wait for the package version to be created.","default":{"quantity":0,"unit":0},"input":[],"multiple":false,"type":"option"},"buildinstance":{"kind":"string","char":"s","description":"the instance where the conversion package version will be created——for example, NA50","longDescription":"The instance where the conversion package version will be created——for example, NA50.","hidden":true,"input":[],"multiple":false,"type":"option"}}},"force:package:create":{"id":"force:package:create","description":"create a package\n\nFirst, 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 --nonamespace.\n\nYour --name value must be unique within your namespace.\n\nRun 'sfdx force:package:list' to list all packages in the Dev Hub org.","strict":true,"usage":"<%= command.id %> -n <string> -t Managed|Unlocked -r <directory> [-d <string>] [-e] [--orgdependent] [-o <string>] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-packaging","pluginAlias":"@salesforce/plugin-packaging","pluginType":"core","aliases":["force:package:beta:create"],"examples":["$ sfdx force:package:create -n YourPackageName -t Unlocked -r force-app","$ sfdx force:package:create -n YourPackageName -d \"Your Package Descripton\" -t Unlocked -r force-app"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetdevhubusername":{"name":"targetdevhubusername","type":"option","char":"v","description":"username or alias for the dev hub org; overrides default dev hub org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"name":{"name":"name","type":"option","char":"n","description":"package name","required":true,"multiple":false},"packagetype":{"name":"packagetype","type":"option","char":"t","description":"package type","required":true,"helpValue":"(Managed|Unlocked)","multiple":false,"options":["Managed","Unlocked"]},"description":{"name":"description","type":"option","char":"d","description":"package description","multiple":false},"nonamespace":{"name":"nonamespace","type":"boolean","char":"e","description":"creates the package with no namespace; available only for unlocked packages.","allowNo":false},"path":{"name":"path","type":"option","char":"r","description":"path to directory that contains the contents of the package","required":true,"multiple":false},"orgdependent":{"name":"orgdependent","type":"boolean","description":"depends on unpackaged metadata in the installation org. Applies to unlocked packages only.","allowNo":false},"errornotificationusername":{"name":"errornotificationusername","type":"option","char":"o","description":"active Dev Hub user designated to receive email notifications for package errors","multiple":false}},"args":[],"requiresDevhubUsername":true,"requiresProject":true,"flagsConfig":{"name":{"kind":"string","char":"n","description":"package name","longDescription":"Name of the package to create.","required":true,"input":[],"multiple":false,"type":"option"},"packagetype":{"kind":"enum","helpValue":"(Managed|Unlocked)","char":"t","description":"package type","longDescription":"Package type for the package.\nThe options for package type are Managed and Unlocked (Managed=DeveloperManagedSubscriberManaged, Unlocked=DeveloperControlledSubscriberEditable).\nThese options determine upgrade and editability rules.","required":true,"options":["Managed","Unlocked"],"input":[],"multiple":false,"type":"option"},"description":{"kind":"string","char":"d","description":"package description","longDescription":"Description of the package.","input":[],"multiple":false,"type":"option"},"nonamespace":{"kind":"boolean","char":"e","description":"creates the package with no namespace; available only for unlocked packages.","longDescription":"Creates the package with no namespace. Available only for unlocked packages. Useful when you’re migrating an existing org to packages. But, use a namespaced package for new metadata.","allowNo":false,"type":"boolean"},"path":{"kind":"directory","char":"r","description":"path to directory that contains the contents of the package","longDescription":"The path to the directory that contains the contents of the package.","required":true,"input":[],"multiple":false,"type":"option"},"orgdependent":{"kind":"boolean","description":"depends on unpackaged metadata in the installation org. Applies to unlocked packages only.","longDescription":"Package depends on unpackaged metadata in the installation org. Applies to unlocked packages only.\nUse Source Tracking in Sandboxes to develop your org-dependent unlocked package.\nFor more information, see \"Create Org-Dependent Unlocked Packages\" in the Salesforce DX Developer Guide.","allowNo":false,"type":"boolean"},"errornotificationusername":{"kind":"string","char":"o","description":"active Dev Hub user designated to receive email notifications for package errors","longDescription":"An active Dev Hub org user designated to receive email notifications for unhandled Apex exceptions, and install, upgrade, or uninstall failures associated with your package.","input":[],"multiple":false,"type":"option"}}},"force:package:delete":{"id":"force:package:delete","description":"delete a package\n\nSpecify 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.","strict":true,"usage":"<%= command.id %> -p <string> [-n] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-packaging","pluginAlias":"@salesforce/plugin-packaging","pluginType":"core","aliases":["force:package:beta:delete"],"examples":["$ sfdx force:package:delete -p \"Your Package Alias\"","$ sfdx force:package:delete -p 0Ho..."],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetdevhubusername":{"name":"targetdevhubusername","type":"option","char":"v","description":"username or alias for the dev hub org; overrides default dev hub org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"noprompt":{"name":"noprompt","type":"boolean","char":"n","description":"don’t prompt before deleting the package","allowNo":false},"package":{"name":"package","type":"option","char":"p","description":"ID (starts with 0Ho) or alias of the package to delete","required":true,"multiple":false},"undelete":{"name":"undelete","type":"boolean","description":"undelete a deleted package","hidden":true,"allowNo":false}},"args":[],"requiresDevhubUsername":true,"requiresProject":true,"flagsConfig":{"noprompt":{"kind":"boolean","char":"n","description":"don’t prompt before deleting the package","longDescription":"Don’t prompt before deleting the package.","allowNo":false,"type":"boolean"},"package":{"kind":"string","char":"p","description":"ID (starts with 0Ho) or alias of the package to delete","longDescription":"The ID (starts with 0Ho) or alias of the package to delete.","required":true,"input":[],"multiple":false,"type":"option"},"undelete":{"kind":"boolean","description":"undelete a deleted package","longDescription":"Undelete a deleted package.","hidden":true,"default":false,"allowNo":false,"type":"boolean"}}},"force:package:install":{"id":"force:package:install","description":"install a package in the target org\n\nSupply the ID of the package version to install. The package installs in your default target org unless you supply the username for a different target org.\n\nFor package upgrades, to specify options for component deprecation or deletion of removed components, include an --upgradetype value. To delete components that can be safely deleted and deprecate the others, specify --upgradetype Mixed (the default). To deprecate all removed components, specify --upgradetype DeprecateOnly. To delete all removed components, except for custom objects and custom fields, that don't have dependencies, specify --upgradetype Delete. (Note: This option can result in the loss of data that is associated with the deleted components.) The default is Mixed.","strict":true,"usage":"<%= command.id %> -p <string> [-w <minutes>] [-k <string>] [-b <minutes>] [-r] [-a all|package] [-s AllUsers|AdminsOnly] [-t DeprecateOnly|Mixed|Delete] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-packaging","pluginAlias":"@salesforce/plugin-packaging","pluginType":"core","aliases":["force:package:beta:install"],"examples":["$ sfdx force:package:install --package 04t... -u me@example.com","$ sfdx force:package:install --package awesome_package_alias","$ sfdx force:package:install --package \"Awesome Package Alias\"","$ sfdx force:package:install --package 04t... -t DeprecateOnly"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"wait":{"name":"wait","type":"option","char":"w","description":"number of minutes to wait for installation status","multiple":false,"default":{"quantity":0,"unit":0}},"installationkey":{"name":"installationkey","type":"option","char":"k","description":"installation key for key-protected package (default: null)","multiple":false},"publishwait":{"name":"publishwait","type":"option","char":"b","description":"number of minutes to wait for subscriber package version ID to become available in the target org","multiple":false,"default":{"quantity":0,"unit":0}},"noprompt":{"name":"noprompt","type":"boolean","char":"r","description":"do not prompt for confirmation","allowNo":false},"package":{"name":"package","type":"option","char":"p","description":"ID (starts with 04t) or alias of the package version to install","required":true,"multiple":false},"apexcompile":{"name":"apexcompile","type":"option","char":"a","description":"compile all Apex in the org and package, or only Apex in the package; unlocked packages only","helpValue":"(all|package)","multiple":false,"options":["all","package"],"default":"all"},"securitytype":{"name":"securitytype","type":"option","char":"s","description":"security access type for the installed package (deprecation notice: The default --securitytype value will change from AllUsers to AdminsOnly in v47.0 or later.)","helpValue":"(AllUsers|AdminsOnly)","multiple":false,"options":["AllUsers","AdminsOnly"],"default":"AdminsOnly"},"upgradetype":{"name":"upgradetype","type":"option","char":"t","description":"the upgrade type for the package installation; available only for unlocked packages","helpValue":"(DeprecateOnly|Mixed|Delete)","multiple":false,"options":["DeprecateOnly","Mixed","Delete"],"default":"Mixed"}},"args":[],"requiresUsername":true,"flagsConfig":{"wait":{"kind":"minutes","char":"w","description":"number of minutes to wait for installation status","longDescription":"Maximum number of minutes to wait for installation status. The default is 0.","default":{"quantity":0,"unit":0},"input":[],"multiple":false,"type":"option"},"installationkey":{"kind":"string","char":"k","description":"installation key for key-protected package (default: null)","longDescription":"Installation key for installing a key-protected package. The default is null.","input":[],"multiple":false,"type":"option"},"publishwait":{"kind":"minutes","char":"b","description":"number of minutes to wait for subscriber package version ID to become available in the target org","longDescription":"Maximum number of minutes to wait for the Subscriber Package Version ID to become available in the target org before canceling the install request. The default is 0.","default":{"quantity":0,"unit":0},"input":[],"multiple":false,"type":"option"},"noprompt":{"kind":"boolean","char":"r","description":"do not prompt for confirmation","longDescription":"Allows the following without an explicit confirmation response: 1) Remote Site Settings and Content Security Policy websites to send or receive data, and 2) --upgradetype Delete to proceed.","allowNo":false,"type":"boolean"},"package":{"kind":"string","char":"p","description":"ID (starts with 04t) or alias of the package version to install","longDescription":"The ID (starts with 04t) or alias of the package version to install.","required":true,"input":[],"multiple":false,"type":"option"},"apexcompile":{"kind":"enum","helpValue":"(all|package)","char":"a","description":"compile all Apex in the org and package, or only Apex in the package; unlocked packages only","longDescription":"Applies to unlocked packages only. Specifies whether to compile all Apex in the org and package, or only the Apex in the package.\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.\nThis approach assures that package installs and upgrades don’t impact the performance of an org, and is done even if --apexcompile package is specified.","default":"all","options":["all","package"],"input":[],"multiple":false,"type":"option"},"securitytype":{"kind":"enum","helpValue":"(AllUsers|AdminsOnly)","char":"s","description":"security access type for the installed package (deprecation notice: The default --securitytype value will change from AllUsers to AdminsOnly in v47.0 or later.)","longDescription":"Security access type for the installed package.","default":"AdminsOnly","options":["AllUsers","AdminsOnly"],"input":[],"multiple":false,"type":"option"},"upgradetype":{"kind":"enum","helpValue":"(DeprecateOnly|Mixed|Delete)","char":"t","description":"the upgrade type for the package installation; available only for unlocked packages","longDescription":"For package upgrades, specifies whether to mark all removed components as deprecated (DeprecateOnly), to delete removed components that can be safely deleted and deprecate the others (Mixed), or to delete all removed components, except for custom objects and custom fields, that don't have dependencies (Delete). The default is Mixed. Can specify DeprecateOnly or Delete only for unlocked package upgrades.","default":"Mixed","options":["DeprecateOnly","Mixed","Delete"],"input":[],"multiple":false,"type":"option"}}},"force:package:list":{"id":"force:package:list","description":"list all packages in the Dev Hub org\n\nYou can view the namespace, IDs, and other details for each package.","strict":true,"usage":"<%= command.id %> [-v <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-packaging","pluginAlias":"@salesforce/plugin-packaging","pluginType":"core","aliases":["force:package:beta:list"],"examples":["$ sfdx force:package:list -v devhub@example.com","$ sfdx force:package:list -v devhub@example.com --verbose"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetdevhubusername":{"name":"targetdevhubusername","type":"option","char":"v","description":"username or alias for the dev hub org; overrides default dev hub org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"verbose":{"name":"verbose","type":"boolean","description":"display extended package detail","allowNo":false}},"args":[],"requiresProject":true,"requiresDevhubUsername":true,"flagsConfig":{"verbose":{"description":"display extended package detail","longDescription":"Displays extended package details.","type":"boolean","kind":"boolean","allowNo":false}}},"force:package:uninstall":{"id":"force:package:uninstall","description":"uninstall a second-generation package from the target org\n\nSpecify the package ID for a second-generation package.\n\nTo list the org’s installed packages, run \"sfdx force:package:installed:list\".\n\nTo uninstall a first-generation package, from Setup, enter Installed Packages in the Quick Find box, then select Installed Packages.","strict":true,"usage":"<%= command.id %> -p <string> [-w <minutes>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-packaging","pluginAlias":"@salesforce/plugin-packaging","pluginType":"core","aliases":["force:package:beta:uninstall"],"examples":["$ sfdx force:package:uninstall -p 04t... -u me@example.com","$ sfdx force:package:uninstall -p undesirable_package_alias","$ sfdx force:package:uninstall -p \"Undesirable Package Alias\""],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"wait":{"name":"wait","type":"option","char":"w","description":"number of minutes to wait for uninstall status","multiple":false,"default":{"quantity":0,"unit":0}},"package":{"name":"package","type":"option","char":"p","description":"ID (starts with 04t) or alias of the package version to uninstall","required":true,"multiple":false}},"args":[],"requiresUsername":true,"flagsConfig":{"wait":{"kind":"minutes","char":"w","description":"number of minutes to wait for uninstall status","longDescription":"Maximum number of minutes to wait for uninstall status. The default is 0.","default":{"quantity":0,"unit":0},"input":[],"multiple":false,"type":"option"},"package":{"kind":"string","char":"p","description":"ID (starts with 04t) or alias of the package version to uninstall","longDescription":"The ID (starts with 04t) or alias of the package version to uninstall.","required":true,"input":[],"multiple":false,"type":"option"}}},"force:package:update":{"id":"force:package:update","description":"update package details\n\nSpecify a new value for each option you want to update.\n\nRun \"sfdx force:package:list\" to list all packages in the Dev Hub org.","strict":true,"usage":"<%= command.id %> -p <string> [-n <string>] [-d <string>] [-o <string>] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-packaging","pluginAlias":"@salesforce/plugin-packaging","pluginType":"core","aliases":["force:package:beta:update"],"examples":["$ sfdx force:package:update -p \"Your Package Alias\" -n \"New Package Name\"","$ sfdx force:package:update -p 0Ho... -d \"New Package Description\""],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetdevhubusername":{"name":"targetdevhubusername","type":"option","char":"v","description":"username or alias for the dev hub org; overrides default dev hub org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"package":{"name":"package","type":"option","char":"p","description":"ID (starts with 0Ho) or alias of the package to update","required":true,"multiple":false},"name":{"name":"name","type":"option","char":"n","description":"new package name","multiple":false},"description":{"name":"description","type":"option","char":"d","description":"new package description","multiple":false},"errornotificationusername":{"name":"errornotificationusername","type":"option","char":"o","description":"active Dev Hub user designated to receive email notifications for package errors","multiple":false}},"args":[],"requiresDevhubUsername":true,"requiresProject":true,"flagsConfig":{"package":{"kind":"string","char":"p","description":"ID (starts with 0Ho) or alias of the package to update","longDescription":"The ID (starts with 0Ho) or alias of the package to update.","required":true,"input":[],"multiple":false,"type":"option"},"name":{"kind":"string","char":"n","description":"new package name","longDescription":"New name of the package.","input":[],"multiple":false,"type":"option"},"description":{"kind":"string","char":"d","description":"new package description","longDescription":"New description of the package.","input":[],"multiple":false,"type":"option"},"errornotificationusername":{"kind":"string","char":"o","description":"active Dev Hub user designated to receive email notifications for package errors","longDescription":"An active Dev Hub org user designated to receive email notifications for unhandled Apex exceptions, and install, upgrade, or uninstall failures associated with your package.","input":[],"multiple":false,"type":"option"}}},"force:package:install:report":{"id":"force:package:install:report","description":"retrieve the status of a package installation request","strict":true,"usage":"<%= command.id %> -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-packaging","pluginAlias":"@salesforce/plugin-packaging","pluginType":"core","aliases":["force:package:beta:install:report"],"examples":["$ sfdx force:package:install:report -i 0Hf...","$ sfdx force:package:install:report -i 0Hf... -u me@example.com"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"requestid":{"name":"requestid","type":"option","char":"i","description":"ID of the package install request you want to check","required":true,"multiple":false}},"args":[],"requiresUsername":true,"flagsConfig":{"requestid":{"kind":"id","char":"i","description":"ID of the package install request you want to check","longDescription":"The ID of the package install request you want to check.","required":true,"input":[],"multiple":false,"type":"option"}}},"force:package:installed:list":{"id":"force:package:installed:list","description":"list the org’s installed packages","strict":true,"usage":"<%= command.id %> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-packaging","pluginAlias":"@salesforce/plugin-packaging","pluginType":"core","aliases":["force:package:beta:installed:list"],"examples":["$ sfdx force:package:installed:list","$ sfdx force:package:installed:list -u me@example.com"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false}},"args":[],"requiresUsername":true,"requiresProject":true},"force:package:uninstall:report":{"id":"force:package:uninstall:report","description":"retrieve status of package uninstall request","strict":true,"usage":"<%= command.id %> -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-packaging","pluginAlias":"@salesforce/plugin-packaging","pluginType":"core","aliases":["force:package:beta:uninstall:report"],"examples":["$ sfdx force:package:uninstall:report -i 06y...","$ sfdx force:package:uninstall:report -i 06y... -u me@example.com"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"requestid":{"name":"requestid","type":"option","char":"i","description":"ID of the package uninstall request you want to check","required":true,"multiple":false}},"args":[],"requiresUsername":true,"flagsConfig":{"requestid":{"kind":"id","char":"i","description":"ID of the package uninstall request you want to check","longDescription":"The ID of the package uninstall request you want to check.","required":true,"input":[],"multiple":false,"type":"option"}}},"force:package:version:create":{"id":"force:package:version:create","summary":"create a package version","description":"Creates a package version in the Dev Hub org.\n\nThe 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 \"sfdx force:package:version:create:report -i 08c...\".\n\nWe recommend that you specify the --installationkey 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 \"sfdx force:package:version:create:list\".\n\nTo promote a package version to released, you must use the --codecoverage 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 --skipvalidation.","strict":true,"usage":"<%= command.id %> [-b <string>] [-c | --skipvalidation] [-f <filepath>] [-k <string>] [-x] [-p <string>] [-d <directory>] [--postinstallscript <string>] [--postinstallurl <url>] [--releasenotesurl <url>] [--skipancestorcheck] [-t <string>] [--uninstallscript <string>] [-e <string>] [-a <string>] [-n <string>] [-w <minutes>] [--language <string>] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-packaging","pluginAlias":"@salesforce/plugin-packaging","pluginType":"core","aliases":["force:package:beta:version:create"],"examples":["$ sfdx force:package:version:create -d common -k password123","$ sfdx force:package:version:create -p \"Your Package Alias\" -k password123","$ sfdx force:package:version:create -p 0Ho... -k password123","$ sfdx force:package:version:create -d common -k password123 --skipvalidation"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetdevhubusername":{"name":"targetdevhubusername","type":"option","char":"v","description":"username or alias for the dev hub org; overrides default dev hub org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"branch":{"name":"branch","type":"option","char":"b","description":"the package version’s branch","multiple":false},"buildinstance":{"name":"buildinstance","type":"option","char":"s","description":"the instance where the package version will be created——for example, NA50","hidden":true,"multiple":false},"codecoverage":{"name":"codecoverage","type":"boolean","char":"c","description":"calculate the code coverage by running the packaged Apex tests","allowNo":false,"exclusive":["skipvalidation"]},"definitionfile":{"name":"definitionfile","type":"option","char":"f","description":"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","multiple":false},"installationkey":{"name":"installationkey","type":"option","char":"k","description":"installation key for key-protected package (either --installationkey or --installationkeybypass is required)","multiple":false},"installationkeybypass":{"name":"installationkeybypass","type":"boolean","char":"x","description":"bypass the installation key requirement (either --installationkey or --installationkeybypass is required)","allowNo":false},"package":{"name":"package","type":"option","char":"p","description":"ID (starts with 0Ho) or alias of the package to create a version of","multiple":false},"path":{"name":"path","type":"option","char":"d","description":"path to directory that contains the contents of the package","multiple":false},"postinstallscript":{"name":"postinstallscript","type":"option","description":"post-install script name; managed packages only","multiple":false},"postinstallurl":{"name":"postinstallurl","type":"option","description":"post-install URL","multiple":false},"preserve":{"name":"preserve","type":"boolean","char":"r","description":"temp files are preserved that would otherwise be deleted","hidden":true,"allowNo":false},"releasenotesurl":{"name":"releasenotesurl","type":"option","description":"release notes URL","multiple":false},"skipancestorcheck":{"name":"skipancestorcheck","type":"boolean","description":"Overrides ancestry requirements.","allowNo":false},"skipvalidation":{"name":"skipvalidation","type":"boolean","description":"skip validation during package version creation; you can’t promote unvalidated package versions","allowNo":false,"exclusive":["codecoverage"]},"tag":{"name":"tag","type":"option","char":"t","description":"the package version’s tag","multiple":false},"uninstallscript":{"name":"uninstallscript","type":"option","description":"uninstall script name; managed packages only","multiple":false},"validateschema":{"name":"validateschema","type":"boolean","char":"j","description":"sfdx-project.json is validated against JSON schema","hidden":true,"allowNo":false},"versiondescription":{"name":"versiondescription","type":"option","char":"e","description":"the description of the package version to be created","multiple":false},"versionname":{"name":"versionname","type":"option","char":"a","description":"the name of the package version to be created","multiple":false},"versionnumber":{"name":"versionnumber","type":"option","char":"n","description":"the version number of the package version to be created","multiple":false},"wait":{"name":"wait","type":"option","char":"w","description":"minutes to wait for the package version to be created","multiple":false,"default":{"quantity":0,"unit":0}},"language":{"name":"language","type":"option","description":"The language for the package. Only applies to orgs running API version 57.0 or higher.","multiple":false}},"args":[],"requiresDevhubUsername":true,"requiresProject":true,"flagsConfig":{"branch":{"kind":"string","char":"b","description":"the package version’s branch","longDescription":"Name of the branch in your source control system that the package version is based on.","input":[],"multiple":false,"type":"option"},"buildinstance":{"kind":"string","char":"s","description":"the instance where the package version will be created——for example, NA50","longDescription":"The instance where the package version will be created——for example, NA50.","hidden":true,"input":[],"multiple":false,"type":"option"},"codecoverage":{"kind":"boolean","char":"c","description":"calculate the code coverage by running the packaged Apex tests","longDescription":"Calculate and store the code coverage percentage by running the Apex tests included in this package version. Before you can promote and release a managed or unlocked package version, the Apex code must meet a minimum 75% code coverage requirement. We don’t calculate code coverage for org-dependent unlocked packages or for package versions that specify --skipvalidation.","default":false,"exclusive":["skipvalidation"],"allowNo":false,"type":"boolean"},"definitionfile":{"kind":"filepath","char":"f","description":"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","longDescription":"The 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.","input":[],"multiple":false,"type":"option"},"installationkey":{"kind":"string","char":"k","description":"installation key for key-protected package (either --installationkey or --installationkeybypass is required)","longDescription":"Installation key for creating the key-protected package. Either an --installationkey value or the --installationkeybypass flag is required.","exactlyOne":["installationkey","installationkeybypass"],"input":[],"multiple":false,"type":"option"},"installationkeybypass":{"kind":"boolean","char":"x","description":"bypass the installation key requirement (either --installationkey or --installationkeybypass is required)","longDescription":"Bypasses the installation key requirement. If you bypass this requirement, anyone can install your package. Either an --installationkey value or the --installationkeybypass flag is required.","exactlyOne":["installationkey","installationkeybypass"],"allowNo":false,"type":"boolean"},"package":{"kind":"string","char":"p","description":"ID (starts with 0Ho) or alias of the package to create a version of","longDescription":"The ID (starts with 0Ho) or alias of the package to create a version of.","input":[],"multiple":false,"type":"option"},"path":{"kind":"directory","char":"d","description":"path to directory that contains the contents of the package","longDescription":"The path to the directory that contains the contents of the package.","input":[],"multiple":false,"type":"option"},"postinstallscript":{"kind":"string","description":"post-install script name; managed packages only","longDescription":"Applies to managed packages only. The post-install script name. 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.","input":[],"multiple":false,"type":"option"},"postinstallurl":{"kind":"url","description":"post-install URL","longDescription":"The post-install instructions URL. The contents of the post-installation instructions URL are displayed in the UI after installation of the package version.","input":[],"multiple":false,"type":"option"},"preserve":{"kind":"boolean","char":"r","description":"temp files are preserved that would otherwise be deleted","longDescription":"Specifies that the temp files are preserved that would otherwise be deleted","hidden":true,"allowNo":false,"type":"boolean"},"releasenotesurl":{"kind":"url","description":"release notes URL","longDescription":"The release notes URL. This link is displayed in the package installation UI to provide release notes for this package version to subscribers.","input":[],"multiple":false,"type":"option"},"skipancestorcheck":{"kind":"boolean","description":"Overrides ancestry requirements.","longDescription":"Override ancestry requirements, which allows you to specify a package ancestor that isn’t the highest released package version.","default":false,"allowNo":false,"type":"boolean"},"skipvalidation":{"kind":"boolean","description":"skip validation during package version creation; you can’t promote unvalidated package versions","longDescription":"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.","default":false,"exclusive":["codecoverage"],"allowNo":false,"type":"boolean"},"tag":{"kind":"string","char":"t","description":"the package version’s tag","longDescription":"The package version’s tag.","input":[],"multiple":false,"type":"option"},"uninstallscript":{"kind":"string","description":"uninstall script name; managed packages only","longDescription":"Applies to managed packages only. The uninstall script name. The uninstall script is an Apex class within this package that is run in the installing org after uninstallations of this package.","input":[],"multiple":false,"type":"option"},"validateschema":{"kind":"boolean","char":"j","description":"sfdx-project.json is validated against JSON schema","longDescription":"Specifies that the sfdx-project.json file should be validated against JSON schema.","hidden":true,"allowNo":false,"type":"boolean"},"versiondescription":{"kind":"string","char":"e","description":"the description of the package version to be created","longDescription":"The description of the package version to be created. Overrides the sfdx-project.json value.","input":[],"multiple":false,"type":"option"},"versionname":{"kind":"string","char":"a","description":"the name of the package version to be created","longDescription":"The name of the package version to be created. Overrides the sfdx-project.json value.","input":[],"multiple":false,"type":"option"},"versionnumber":{"kind":"string","char":"n","description":"the version number of the package version to be created","longDescription":"The version number of the package version to be created. Overrides the sfdx-project.json value.","input":[],"multiple":false,"type":"option"},"wait":{"kind":"minutes","char":"w","description":"minutes to wait for the package version to be created","longDescription":"The number of minutes to wait for the package version to be created.","default":{"quantity":0,"unit":0},"input":[],"multiple":false,"type":"option"},"language":{"kind":"string","description":"The language for the package. Only applies to orgs running API version 57.0 or higher.","longDescription":"The language for the package. Specify the language using a language code listed under \"Supported Languages\" in Salesforce Help.\n\nIf no language is specified, the language defaults to the language of the Dev Hub user who created the package.\n\nOnly applies to orgs running API version 57.0 or higher.","input":[],"multiple":false,"type":"option"}}},"force:package:version:delete":{"id":"force:package:version:delete","description":"delete a package version\nSpecify the ID or alias of the package version you want to delete.","strict":true,"usage":"<%= command.id %> -p <string> [-n] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-packaging","pluginAlias":"@salesforce/plugin-packaging","pluginType":"core","aliases":["force:package:beta:version:delete"],"examples":["$ sfdx force:package:version:delete -p \"Your Package Alias\"","$ sfdx force:package:version:delete -p 04t..."],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetdevhubusername":{"name":"targetdevhubusername","type":"option","char":"v","description":"username or alias for the dev hub org; overrides default dev hub org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"noprompt":{"name":"noprompt","type":"boolean","char":"n","description":"don’t prompt before deleting the package version","allowNo":false},"package":{"name":"package","type":"option","char":"p","description":"ID (starts with 04t) or alias of the package to update a version of","required":true,"multiple":false},"undelete":{"name":"undelete","type":"boolean","description":"undelete a deleted package version","hidden":true,"allowNo":false}},"args":[],"requiresDevhubUsername":true,"requiresProject":true,"flagsConfig":{"noprompt":{"kind":"boolean","char":"n","description":"don’t prompt before deleting the package version","longDescription":"don’t prompt before deleting the package version","allowNo":false,"type":"boolean"},"package":{"kind":"string","char":"p","description":"ID (starts with 04t) or alias of the package to update a version of","longDescription":"The ID (starts with 04t) or alias of the package version to delete.","required":true,"input":[],"multiple":false,"type":"option"},"undelete":{"kind":"boolean","description":"undelete a deleted package version","longDescription":"Undelete a deleted package version.","hidden":true,"allowNo":false,"type":"boolean"}}},"force:package:version:displayancestry":{"id":"force:package:version:displayancestry","description":"display the ancestry tree for a 2GP managed package version","strict":true,"usage":"<%= command.id %> -p <string> [--dotcode] [-v <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-packaging","pluginAlias":"@salesforce/plugin-packaging","pluginType":"core","aliases":["force:package:beta:version:displayancestry"],"examples":["$ sfdx force:package:version:displayancestry -p package_version_alias","$ sfdx force:package:version:displayancestry -p package_version_alias --dotcode","$ sfdx force:package:version:displayancestry -p OHo...","$ sfdx force:package:version:displayancestry -p 04t..."],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetdevhubusername":{"name":"targetdevhubusername","type":"option","char":"v","description":"username or alias for the dev hub org; overrides default dev hub org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"package":{"name":"package","type":"option","char":"p","description":"ID or alias of the package (starts with 0Ho) or package version (starts with 04t) to display ancestry for","required":true,"multiple":false},"dotcode":{"name":"dotcode","type":"boolean","description":"display the ancestry tree in DOT code","allowNo":false},"verbose":{"name":"verbose","type":"boolean","description":"display both the package version ID (starts with 04t) and the version number (major.minor.patch.build) in the ancestry tree","allowNo":false}},"args":[],"showProgress":false,"varargs":false,"requiresDevhubUsername":true,"requiresProject":true,"flagsConfig":{"package":{"kind":"string","char":"p","description":"ID or alias of the package (starts with 0Ho) or package version (starts with 04t) to display ancestry for","longDescription":"The ID or alias of the package or package version to display ancestry for. If you specify a package ID (starts with 0Ho) or alias, the ancestor tree for every package version associated with the package ID is displayed.\nIf you specify a package version (starts with 04t) or alias, the ancestry tree of the specified package version is displayed.","required":true,"input":[],"multiple":false,"type":"option"},"dotcode":{"kind":"boolean","description":"display the ancestry tree in DOT code","longDescription":"Displays the ancestry tree in DOT code. You can use the DOT code output in graph visualization software to create tree visualizations.","allowNo":false,"type":"boolean"},"verbose":{"description":"display both the package version ID (starts with 04t) and the version number (major.minor.patch.build) in the ancestry tree","longDescription":"Displays both the package version ID (starts with 04t) and the version number (major.minor.patch.build) in the ancestry tree.","type":"boolean","kind":"boolean","allowNo":false}}},"force:package:version:list":{"id":"force:package:version:list","description":"list all package versions in the Dev Hub org.\n\nDisplays details of each package version in the org.\n\nUse --concise or --verbose to display limited or additional details, respectively.\n\nAll filter parameters are applied using the AND logical operator (not OR).","strict":true,"usage":"<%= command.id %> [-c <number>] [-m <number>] [-p <array>] [-r] [-o <array>] [-v <string>] [--apiversion <string>] [--concise] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-packaging","pluginAlias":"@salesforce/plugin-packaging","pluginType":"core","aliases":["force:package:beta:version:list"],"examples":["$ sfdx force:package:version:list --verbose --createdlastdays 3 --released --orderby PatchVersion","$ sfdx force:package:version:list --packages 0Ho000000000000,0Ho000000000001 --released --modifiedlastdays 0","$ sfdx force:package:version:list --released","$ sfdx force:package:version:list --concise --modifiedlastdays 0","$ sfdx force:package:version:list --concise -c 3 -r","$ sfdx force:package:version:list --packages exp-mgr,exp-mgr-util --released --modifiedlastdays 0"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetdevhubusername":{"name":"targetdevhubusername","type":"option","char":"v","description":"username or alias for the dev hub org; overrides default dev hub org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"createdlastdays":{"name":"createdlastdays","type":"option","char":"c","description":"created in the last specified number of days (starting at 00:00:00 of first day to now; 0 for today)","multiple":false},"concise":{"name":"concise","type":"boolean","description":"display limited package version details","allowNo":false},"modifiedlastdays":{"name":"modifiedlastdays","type":"option","char":"m","description":"list items modified in the specified last number of days (starting at 00:00:00 of first day to now; 0 for today)","multiple":false},"packages":{"name":"packages","type":"option","char":"p","description":"filter results on specified comma-delimited packages (aliases or 0Ho IDs)","multiple":false},"released":{"name":"released","type":"boolean","char":"r","description":"display released versions only","allowNo":false},"orderby":{"name":"orderby","type":"option","char":"o","description":"order by the specified package version fields","multiple":false},"verbose":{"name":"verbose","type":"boolean","description":"display extended package version details","allowNo":false}},"args":[],"requiresDevhubUsername":true,"flagsConfig":{"createdlastdays":{"kind":"number","char":"c","description":"created in the last specified number of days (starting at 00:00:00 of first day to now; 0 for today)","longDescription":"Filters the list based on the specified maximum number of days since the request was created (starting at 00:00:00 of first day to now; 0 for today).","input":[],"multiple":false,"type":"option"},"concise":{"description":"display limited package version details","longDescription":"Displays limited package version details.","type":"boolean","kind":"boolean","allowNo":false},"modifiedlastdays":{"kind":"number","char":"m","description":"list items modified in the specified last number of days (starting at 00:00:00 of first day to now; 0 for today)","longDescription":"Lists the items modified in the specified last number of days, starting at 00:00:00 of first day to now. Use 0 for today.","input":[],"multiple":false,"type":"option"},"packages":{"kind":"array","char":"p","description":"filter results on specified comma-delimited packages (aliases or 0Ho IDs)","longDescription":"Filters results on the specified comma-delimited packages (aliases or 0Ho IDs).","input":[],"multiple":false,"type":"option"},"released":{"kind":"boolean","char":"r","description":"display released versions only","longDescription":"Displays released versions only (IsReleased=true).","allowNo":false,"type":"boolean"},"orderby":{"kind":"array","char":"o","description":"order by the specified package version fields","longDescription":"Orders the list by the specified package version fields.","input":[],"multiple":false,"type":"option"},"verbose":{"description":"display extended package version details","longDescription":"Displays extended package version details.","type":"boolean","kind":"boolean","allowNo":false}}},"force:package:version:promote":{"id":"force:package:version:promote","description":"promote a package version to released\n\nSupply the ID or alias of the package version you want to promote. Promotes the package version to released status.","strict":true,"usage":"<%= command.id %> -p <string> [-n] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-packaging","pluginAlias":"@salesforce/plugin-packaging","pluginType":"core","aliases":["force:package:beta:version:promote"],"examples":["$ sfdx force:package:version:promote -p 04t...","$ sfdx force:package:version:promote -p awesome_package_alias","$ sfdx force:package:version:promote -p \"Awesome Package Alias\""],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetdevhubusername":{"name":"targetdevhubusername","type":"option","char":"v","description":"username or alias for the dev hub org; overrides default dev hub org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"package":{"name":"package","type":"option","char":"p","description":"ID (starts with 04t) or alias of the package version to promote","required":true,"multiple":false},"noprompt":{"name":"noprompt","type":"boolean","char":"n","description":"no prompt to confirm setting the package version as released","allowNo":false}},"args":[],"requiresDevhubUsername":true,"requiresProject":true,"flagsConfig":{"package":{"kind":"string","char":"p","description":"ID (starts with 04t) or alias of the package version to promote","longDescription":"The ID (starts with 04t) or alias of the package version to promote.","required":true,"input":[],"multiple":false,"type":"option"},"noprompt":{"kind":"boolean","char":"n","description":"no prompt to confirm setting the package version as released","longDescription":"Do not prompt to confirm setting the package version as released.","allowNo":false,"type":"boolean"}}},"force:package:version:report":{"id":"force:package:version:report","description":"retrieve details about a package version in the Dev Hub org\n\nTo update package version values, run \"sfdx force:package:version:update\".","strict":true,"usage":"<%= command.id %> -p <string> [-v <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-packaging","pluginAlias":"@salesforce/plugin-packaging","pluginType":"core","aliases":["force:package:beta:version:report"],"examples":["$ sfdx force:package:version:report -p 04t...","$ sfdx force:package:version:report -p \"Your Package Alias\""],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetdevhubusername":{"name":"targetdevhubusername","type":"option","char":"v","description":"username or alias for the dev hub org; overrides default dev hub org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"package":{"name":"package","type":"option","char":"p","description":"ID (starts with 04t) or alias of the package to retrieve details for","required":true,"multiple":false},"verbose":{"name":"verbose","type":"boolean","description":"displays extended package version details","allowNo":false}},"args":[],"requiresDevhubUsername":true,"requiresProject":true,"flagsConfig":{"package":{"kind":"string","char":"p","description":"ID (starts with 04t) or alias of the package to retrieve details for","longDescription":"The ID (starts with 04t) or alias of the package to retrieve details for.","required":true,"input":[],"multiple":false,"type":"option"},"verbose":{"description":"displays extended package version details","longDescription":"Displays extended package version details.","type":"boolean","kind":"boolean","allowNo":false}}},"force:package:version:update":{"id":"force:package:version:update","description":"update a package version\n\nSpecify a new value for each option you want to update.\n\nTo display details about a package version, run \"sfdx force:package:version:report\".","strict":true,"usage":"<%= command.id %> -p <string> [-a <string>] [-e <string>] [-b <string>] [-t <string>] [-k <string>] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-packaging","pluginAlias":"@salesforce/plugin-packaging","pluginType":"core","aliases":["force:package:beta:version:update"],"examples":["$ sfdx force:package:version:update -p \"Your Package Alias\" -k password123","$ sfdx force:package:version:update -p 04t... -b main -t 'Release 1.0.7'","$ sfdx force:package:version:update -p 04t... -e \"New Package Version Description\""],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetdevhubusername":{"name":"targetdevhubusername","type":"option","char":"v","description":"username or alias for the dev hub org; overrides default dev hub org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"package":{"name":"package","type":"option","char":"p","description":"ID (starts with 04t) or alias of the package to update a version of","required":true,"multiple":false},"versionname":{"name":"versionname","type":"option","char":"a","description":"new package version name","multiple":false},"versiondescription":{"name":"versiondescription","type":"option","char":"e","description":"new package version description","multiple":false},"branch":{"name":"branch","type":"option","char":"b","description":"new package version branch","multiple":false},"tag":{"name":"tag","type":"option","char":"t","description":"new package version tag","multiple":false},"installationkey":{"name":"installationkey","type":"option","char":"k","description":"new installation key for key-protected package (default: null)","multiple":false}},"args":[],"requiresDevhubUsername":true,"requiresProject":true,"flagsConfig":{"package":{"kind":"string","char":"p","description":"ID (starts with 04t) or alias of the package to update a version of","longDescription":"The ID (starts with 04t) or alias of the package to update a version of.","required":true,"input":[],"multiple":false,"type":"option"},"versionname":{"kind":"string","char":"a","description":"new package version name","longDescription":"The new package version name.","input":[],"multiple":false,"type":"option"},"versiondescription":{"kind":"string","char":"e","description":"new package version description","longDescription":"The new package version description.","input":[],"multiple":false,"type":"option"},"branch":{"kind":"string","char":"b","description":"new package version branch","longDescription":"The new package version branch.","input":[],"multiple":false,"type":"option"},"tag":{"kind":"string","char":"t","description":"new package version tag","longDescription":"The new package version tag.","input":[],"multiple":false,"type":"option"},"installationkey":{"kind":"string","char":"k","description":"new installation key for key-protected package (default: null)","longDescription":"The new installation key for the key-protected package. The default is null.","input":[],"multiple":false,"type":"option"}}},"force:package1:version:create":{"id":"force:package1:version:create","description":"create a first-generation package version in the release org\nThe package version is based on the contents of the specified metadata package. Omit -m if you want to create an unmanaged package version.","strict":true,"usage":"<%= command.id %> -i <id> -n <string> [-d <string>] [-v <string>] [-m] [-r <url>] [-p <url>] [-k <string>] [-w <minutes>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-packaging","pluginAlias":"@salesforce/plugin-packaging","pluginType":"core","aliases":["force:package1:beta:version:create"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"packageid":{"name":"packageid","type":"option","char":"i","description":"ID of the metadata package (starts with 033) of which you’re creating a new version","required":true,"multiple":false},"name":{"name":"name","type":"option","char":"n","description":"package version name","required":true,"multiple":false},"description":{"name":"description","type":"option","char":"d","description":"package version description","multiple":false},"version":{"name":"version","type":"option","char":"v","description":"package version in major.minor format, for example, 3.2","multiple":false},"managedreleased":{"name":"managedreleased","type":"boolean","char":"m","description":"create a managed package version","allowNo":false},"releasenotesurl":{"name":"releasenotesurl","type":"option","char":"r","description":"release notes URL","multiple":false},"postinstallurl":{"name":"postinstallurl","type":"option","char":"p","description":"post install URL","multiple":false},"installationkey":{"name":"installationkey","type":"option","char":"k","description":"installation key for key-protected package (default: null)","multiple":false},"wait":{"name":"wait","type":"option","char":"w","description":"minutes to wait for the package version to be created (default: 2 minutes)","multiple":false}},"args":[],"requiresUsername":true,"requiresProject":true,"flagsConfig":{"packageid":{"kind":"id","char":"i","description":"ID of the metadata package (starts with 033) of which you’re creating a new version","longDescription":"ID of the metadata package (starts with 033) of which you’re creating a new version.","required":true,"input":[],"multiple":false,"type":"option"},"name":{"kind":"string","char":"n","description":"package version name","longDescription":"Package version name.","required":true,"input":[],"multiple":false,"type":"option"},"description":{"kind":"string","char":"d","description":"package version description","longDescription":"Package version description.","input":[],"multiple":false,"type":"option"},"version":{"kind":"string","char":"v","description":"package version in major.minor format, for example, 3.2","longDescription":"Package version in major.minor format, for example, 3.2.","input":[],"multiple":false,"type":"option"},"managedreleased":{"kind":"boolean","char":"m","description":"create a managed package version","longDescription":"Creates a managed package version. To create a beta version, don’t include this parameter.","allowNo":false,"type":"boolean"},"releasenotesurl":{"kind":"url","char":"r","description":"release notes URL","longDescription":"The release notes URL. This link is displayed in the package installation UI to provide release notes for this package version to subscribers.","input":[],"multiple":false,"type":"option"},"postinstallurl":{"kind":"url","char":"p","description":"post install URL","longDescription":"The post-install instructions URL. The contents of the post-installation instructions URL are displayed in the UI after installation of the package version.","input":[],"multiple":false,"type":"option"},"installationkey":{"kind":"string","char":"k","description":"installation key for key-protected package (default: null)","longDescription":"Installation key for creating the key-protected package. The default is null.","input":[],"multiple":false,"type":"option"},"wait":{"kind":"minutes","char":"w","description":"minutes to wait for the package version to be created (default: 2 minutes)","longDescription":"Minutes to wait for the package version to be created. The default is 2 minutes.","input":[],"multiple":false,"type":"option"}}},"force:package1:version:display":{"id":"force:package1:version:display","description":"display details about a first-generation package version","strict":true,"usage":"<%= command.id %> -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-packaging","pluginAlias":"@salesforce/plugin-packaging","pluginType":"core","aliases":["force:package1:beta:version:display"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"packageversionid":{"name":"packageversionid","type":"option","char":"i","description":"metadata package version ID (starts with 04t)","required":true,"multiple":false}},"args":[],"requiresUsername":true,"flagsConfig":{"packageversionid":{"kind":"id","char":"i","description":"metadata package version ID (starts with 04t)","longDescription":"ID (starts with 04t) of the metadata package version whose details you want to display.","required":true,"input":[],"multiple":false,"type":"option"}}},"force:package1:version:list":{"id":"force:package1:version:list","description":"list package versions for the specified first-generation package or for the org","strict":true,"usage":"<%= command.id %> [-i <id>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-packaging","pluginAlias":"@salesforce/plugin-packaging","pluginType":"core","aliases":["force:package1:beta:version:list"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"packageid":{"name":"packageid","type":"option","char":"i","description":"metadata package ID (starts with 033)","multiple":false}},"args":[],"requiresUsername":true,"flagsConfig":{"packageid":{"kind":"id","char":"i","description":"metadata package ID (starts with 033)","longDescription":"Metadata package ID (starts with 033) whose package versions you want to list. If not specified, shows all versions for all packages (managed and unmanaged) in the org.","input":[],"multiple":false,"type":"option"}}},"force:package:version:create:list":{"id":"force:package:version:create:list","description":"list package version creation requests\n\nShows 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 \"sfdx force:package:version:create:report\" and supply the request ID.","strict":true,"usage":"<%= command.id %> [-c <number>] [-s Queued|InProgress|Success|Error] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-packaging","pluginAlias":"@salesforce/plugin-packaging","pluginType":"core","aliases":["force:package:beta:version:create:list"],"examples":["$ sfdx force:package:version:create:list","$ sfdx force:package:version:create:list --createdlastdays 3","$ sfdx force:package:version:create:list --status Error","$ sfdx force:package:version:create:list -s InProgress","$ sfdx force:package:version:create:list -c 3 -s Success"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetdevhubusername":{"name":"targetdevhubusername","type":"option","char":"v","description":"username or alias for the dev hub org; overrides default dev hub org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"createdlastdays":{"name":"createdlastdays","type":"option","char":"c","description":"created in the last specified number of days (starting at 00:00:00 of first day to now; 0 for today)","multiple":false},"status":{"name":"status","type":"option","char":"s","description":"filter the list by version creation request status","helpValue":"(Queued|InProgress|Success|Error)","multiple":false,"options":["Queued","InProgress","Success","Error"]}},"args":[],"requiresDevhubUsername":true,"flagsConfig":{"createdlastdays":{"kind":"number","char":"c","description":"created in the last specified number of days (starting at 00:00:00 of first day to now; 0 for today)","longDescription":"Filters the list based on the specified maximum number of days since the request was created (starting at 00:00:00 of first day to now; 0 for today).","input":[],"multiple":false,"type":"option"},"status":{"kind":"enum","helpValue":"(Queued|InProgress|Success|Error)","char":"s","description":"filter the list by version creation request status","longDescription":"Filters the list based on the status of version creation requests.","options":["Queued","InProgress","Success","Error"],"input":[],"multiple":false,"type":"option"}}},"force:package:version:create:report":{"id":"force:package:version:create:report","description":"retrieve details about a package version creation request\n\nSpecify 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 \"sfdx force:package:version:create:list\".","strict":true,"usage":"<%= command.id %> -i <id> [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-packaging","pluginAlias":"@salesforce/plugin-packaging","pluginType":"core","aliases":["force:package:beta:version:create:report"],"examples":["$ sfdx force:package:version:create:report -i 08c...","$ sfdx force:package:version:create:report -i 08c... -v devhub@example.com"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetdevhubusername":{"name":"targetdevhubusername","type":"option","char":"v","description":"username or alias for the dev hub org; overrides default dev hub org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"packagecreaterequestid":{"name":"packagecreaterequestid","type":"option","char":"i","description":"package version creation request ID (starts with 08c)","required":true,"multiple":false}},"args":[],"requiresDevhubUsername":true,"flagsConfig":{"packagecreaterequestid":{"kind":"id","char":"i","description":"package version creation request ID (starts with 08c)","longDescription":"The ID (starts with 08c) of the package version creation request you want to display.","required":true,"input":[],"multiple":false,"type":"option"}}},"force:package1:version:create:get":{"id":"force:package1:version:create:get","description":"retrieve the status of a package version creation request","strict":true,"usage":"<%= command.id %> -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-packaging","pluginAlias":"@salesforce/plugin-packaging","pluginType":"core","aliases":["force:package1:beta:version:create:get"],"examples":["$ sfdx force:package1:version:create:get -i 0HD...","$ sfdx force:package1:version:create:get -i 0HD... -u devhub@example.com"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"requestid":{"name":"requestid","type":"option","char":"i","description":"PackageUploadRequest ID","required":true,"multiple":false}},"args":[],"requiresUsername":true,"flagsConfig":{"requestid":{"kind":"id","char":"i","description":"PackageUploadRequest ID","longDescription":"The ID of the PackageUploadRequest.","required":true,"input":[],"multiple":false,"type":"option"}}}}}
|
|
1
|
+
{
|
|
2
|
+
"version": "1.12.5",
|
|
3
|
+
"commands": {
|
|
4
|
+
"package:convert": {
|
|
5
|
+
"id": "package:convert",
|
|
6
|
+
"summary": "Create a second-generation package version from a first-generation package.",
|
|
7
|
+
"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\".",
|
|
8
|
+
"strict": true,
|
|
9
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
10
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
11
|
+
"pluginType": "core",
|
|
12
|
+
"hidden": true,
|
|
13
|
+
"aliases": [
|
|
14
|
+
"force:package:beta:convert",
|
|
15
|
+
"force:package:convert"
|
|
16
|
+
],
|
|
17
|
+
"examples": [
|
|
18
|
+
"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",
|
|
19
|
+
"Similar to previous example, but uses the specified Dev Hub org:\n<%= config.bin %> <%= command.id %> --package 033... --installation-key password123 --target-hub-org devhuborg@example.com"
|
|
20
|
+
],
|
|
21
|
+
"deprecateAliases": true,
|
|
22
|
+
"flags": {
|
|
23
|
+
"json": {
|
|
24
|
+
"name": "json",
|
|
25
|
+
"type": "boolean",
|
|
26
|
+
"description": "Format output as json.",
|
|
27
|
+
"helpGroup": "GLOBAL",
|
|
28
|
+
"allowNo": false,
|
|
29
|
+
"deprecateAliases": true
|
|
30
|
+
},
|
|
31
|
+
"loglevel": {
|
|
32
|
+
"name": "loglevel",
|
|
33
|
+
"type": "option",
|
|
34
|
+
"hidden": true,
|
|
35
|
+
"multiple": false,
|
|
36
|
+
"deprecated": {
|
|
37
|
+
"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."
|
|
38
|
+
},
|
|
39
|
+
"deprecateAliases": true
|
|
40
|
+
},
|
|
41
|
+
"target-hub-org": {
|
|
42
|
+
"name": "target-hub-org",
|
|
43
|
+
"type": "option",
|
|
44
|
+
"char": "v",
|
|
45
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
46
|
+
"required": true,
|
|
47
|
+
"multiple": false,
|
|
48
|
+
"deprecateAliases": true,
|
|
49
|
+
"aliases": [
|
|
50
|
+
"targetdevhubusername"
|
|
51
|
+
]
|
|
52
|
+
},
|
|
53
|
+
"api-version": {
|
|
54
|
+
"name": "api-version",
|
|
55
|
+
"type": "option",
|
|
56
|
+
"description": "Override the api version used for api requests made by this command",
|
|
57
|
+
"multiple": false,
|
|
58
|
+
"deprecateAliases": true,
|
|
59
|
+
"aliases": [
|
|
60
|
+
"apiversion"
|
|
61
|
+
]
|
|
62
|
+
},
|
|
63
|
+
"package": {
|
|
64
|
+
"name": "package",
|
|
65
|
+
"type": "option",
|
|
66
|
+
"char": "p",
|
|
67
|
+
"summary": "ID (starts with 033) of the first-generation package to convert.",
|
|
68
|
+
"required": true,
|
|
69
|
+
"multiple": false,
|
|
70
|
+
"deprecateAliases": true
|
|
71
|
+
},
|
|
72
|
+
"installation-key": {
|
|
73
|
+
"name": "installation-key",
|
|
74
|
+
"type": "option",
|
|
75
|
+
"char": "k",
|
|
76
|
+
"summary": "Installation key for key-protected package.",
|
|
77
|
+
"description": "Either an --installation-key value or the --installation-key-bypass flag is required.",
|
|
78
|
+
"multiple": false,
|
|
79
|
+
"deprecateAliases": true,
|
|
80
|
+
"aliases": [
|
|
81
|
+
"installationkey"
|
|
82
|
+
]
|
|
83
|
+
},
|
|
84
|
+
"definition-file": {
|
|
85
|
+
"name": "definition-file",
|
|
86
|
+
"type": "option",
|
|
87
|
+
"char": "f",
|
|
88
|
+
"summary": "Path to a definition file that contains features and org preferences that the metadata of the package version depends on.",
|
|
89
|
+
"description": "This definition file is similar to the scratch org definition file.",
|
|
90
|
+
"hidden": true,
|
|
91
|
+
"multiple": false,
|
|
92
|
+
"deprecateAliases": true,
|
|
93
|
+
"aliases": [
|
|
94
|
+
"definitionfile"
|
|
95
|
+
]
|
|
96
|
+
},
|
|
97
|
+
"installation-key-bypass": {
|
|
98
|
+
"name": "installation-key-bypass",
|
|
99
|
+
"type": "boolean",
|
|
100
|
+
"char": "x",
|
|
101
|
+
"summary": "Bypass the installation key requirement.",
|
|
102
|
+
"description": "If you bypass this requirement, anyone can install your package. Either an --installation-key value or the --installation-key-bypass flag is required.",
|
|
103
|
+
"allowNo": false,
|
|
104
|
+
"deprecateAliases": true,
|
|
105
|
+
"aliases": [
|
|
106
|
+
"installationkeybypass"
|
|
107
|
+
]
|
|
108
|
+
},
|
|
109
|
+
"wait": {
|
|
110
|
+
"name": "wait",
|
|
111
|
+
"type": "option",
|
|
112
|
+
"char": "w",
|
|
113
|
+
"summary": "Minutes to wait for the package version to be created.",
|
|
114
|
+
"multiple": false,
|
|
115
|
+
"default": {
|
|
116
|
+
"quantity": 0,
|
|
117
|
+
"unit": 0
|
|
118
|
+
},
|
|
119
|
+
"deprecateAliases": true
|
|
120
|
+
},
|
|
121
|
+
"build-instance": {
|
|
122
|
+
"name": "build-instance",
|
|
123
|
+
"type": "option",
|
|
124
|
+
"char": "s",
|
|
125
|
+
"summary": "Instance where the conversion package version will be created, such as NA50.",
|
|
126
|
+
"hidden": true,
|
|
127
|
+
"multiple": false,
|
|
128
|
+
"deprecateAliases": true,
|
|
129
|
+
"aliases": [
|
|
130
|
+
"buildinstance"
|
|
131
|
+
]
|
|
132
|
+
}
|
|
133
|
+
},
|
|
134
|
+
"args": {},
|
|
135
|
+
"hasDynamicHelp": true
|
|
136
|
+
},
|
|
137
|
+
"package:create": {
|
|
138
|
+
"id": "package:create",
|
|
139
|
+
"summary": "Create a package.",
|
|
140
|
+
"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.",
|
|
141
|
+
"strict": true,
|
|
142
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
143
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
144
|
+
"pluginType": "core",
|
|
145
|
+
"aliases": [
|
|
146
|
+
"force:package:beta:create",
|
|
147
|
+
"force:package:create"
|
|
148
|
+
],
|
|
149
|
+
"examples": [
|
|
150
|
+
"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",
|
|
151
|
+
"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-hub-org devhub@example.com"
|
|
152
|
+
],
|
|
153
|
+
"deprecateAliases": true,
|
|
154
|
+
"flags": {
|
|
155
|
+
"json": {
|
|
156
|
+
"name": "json",
|
|
157
|
+
"type": "boolean",
|
|
158
|
+
"description": "Format output as json.",
|
|
159
|
+
"helpGroup": "GLOBAL",
|
|
160
|
+
"allowNo": false,
|
|
161
|
+
"deprecateAliases": true
|
|
162
|
+
},
|
|
163
|
+
"loglevel": {
|
|
164
|
+
"name": "loglevel",
|
|
165
|
+
"type": "option",
|
|
166
|
+
"hidden": true,
|
|
167
|
+
"multiple": false,
|
|
168
|
+
"deprecated": {
|
|
169
|
+
"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."
|
|
170
|
+
},
|
|
171
|
+
"deprecateAliases": true
|
|
172
|
+
},
|
|
173
|
+
"target-hub-org": {
|
|
174
|
+
"name": "target-hub-org",
|
|
175
|
+
"type": "option",
|
|
176
|
+
"char": "v",
|
|
177
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
178
|
+
"required": true,
|
|
179
|
+
"multiple": false,
|
|
180
|
+
"deprecateAliases": true,
|
|
181
|
+
"aliases": [
|
|
182
|
+
"targetdevhubusername"
|
|
183
|
+
]
|
|
184
|
+
},
|
|
185
|
+
"api-version": {
|
|
186
|
+
"name": "api-version",
|
|
187
|
+
"type": "option",
|
|
188
|
+
"description": "Override the api version used for api requests made by this command",
|
|
189
|
+
"multiple": false,
|
|
190
|
+
"deprecateAliases": true,
|
|
191
|
+
"aliases": [
|
|
192
|
+
"apiversion"
|
|
193
|
+
]
|
|
194
|
+
},
|
|
195
|
+
"name": {
|
|
196
|
+
"name": "name",
|
|
197
|
+
"type": "option",
|
|
198
|
+
"char": "n",
|
|
199
|
+
"summary": "Name of the package to create.",
|
|
200
|
+
"required": true,
|
|
201
|
+
"multiple": false,
|
|
202
|
+
"deprecateAliases": true
|
|
203
|
+
},
|
|
204
|
+
"package-type": {
|
|
205
|
+
"name": "package-type",
|
|
206
|
+
"type": "option",
|
|
207
|
+
"char": "t",
|
|
208
|
+
"summary": "Type of package.",
|
|
209
|
+
"description": "The options for package type are Managed and Unlocked (Managed=DeveloperManagedSubscriberManaged, Unlocked=DeveloperControlledSubscriberEditable). These options determine upgrade and editability rules.",
|
|
210
|
+
"required": true,
|
|
211
|
+
"helpValue": "(Managed|Unlocked)",
|
|
212
|
+
"multiple": false,
|
|
213
|
+
"options": [
|
|
214
|
+
"Managed",
|
|
215
|
+
"Unlocked"
|
|
216
|
+
],
|
|
217
|
+
"deprecateAliases": true,
|
|
218
|
+
"aliases": [
|
|
219
|
+
"packagetype"
|
|
220
|
+
]
|
|
221
|
+
},
|
|
222
|
+
"description": {
|
|
223
|
+
"name": "description",
|
|
224
|
+
"type": "option",
|
|
225
|
+
"char": "d",
|
|
226
|
+
"summary": "Description of the package.",
|
|
227
|
+
"multiple": false,
|
|
228
|
+
"deprecateAliases": true
|
|
229
|
+
},
|
|
230
|
+
"no-namespace": {
|
|
231
|
+
"name": "no-namespace",
|
|
232
|
+
"type": "boolean",
|
|
233
|
+
"char": "e",
|
|
234
|
+
"summary": "Create the package with no namespace; available only for unlocked packages.",
|
|
235
|
+
"description": "This flag is useful when you’re migrating an existing org to packages. But use a namespaced package for new metadata.",
|
|
236
|
+
"allowNo": false,
|
|
237
|
+
"deprecateAliases": true,
|
|
238
|
+
"aliases": [
|
|
239
|
+
"nonamespace"
|
|
240
|
+
]
|
|
241
|
+
},
|
|
242
|
+
"path": {
|
|
243
|
+
"name": "path",
|
|
244
|
+
"type": "option",
|
|
245
|
+
"char": "r",
|
|
246
|
+
"summary": "Path to directory that contains the contents of the package.",
|
|
247
|
+
"required": true,
|
|
248
|
+
"multiple": false,
|
|
249
|
+
"deprecateAliases": true
|
|
250
|
+
},
|
|
251
|
+
"org-dependent": {
|
|
252
|
+
"name": "org-dependent",
|
|
253
|
+
"type": "boolean",
|
|
254
|
+
"summary": "Depends on unpackaged metadata in the installation org; applies to unlocked packages only.",
|
|
255
|
+
"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.",
|
|
256
|
+
"allowNo": false,
|
|
257
|
+
"deprecateAliases": true,
|
|
258
|
+
"aliases": [
|
|
259
|
+
"orgdependent"
|
|
260
|
+
]
|
|
261
|
+
},
|
|
262
|
+
"error-notification-username": {
|
|
263
|
+
"name": "error-notification-username",
|
|
264
|
+
"type": "option",
|
|
265
|
+
"char": "o",
|
|
266
|
+
"summary": "Active Dev Hub user designated to receive email notifications for package errors.",
|
|
267
|
+
"description": "Email notifications include information about unhandled Apex exceptions, and install, upgrade, or uninstall failures associated with your package.",
|
|
268
|
+
"multiple": false,
|
|
269
|
+
"deprecateAliases": true,
|
|
270
|
+
"aliases": [
|
|
271
|
+
"errornotificationusername"
|
|
272
|
+
]
|
|
273
|
+
}
|
|
274
|
+
},
|
|
275
|
+
"args": {},
|
|
276
|
+
"requiresProject": true,
|
|
277
|
+
"hasDynamicHelp": true
|
|
278
|
+
},
|
|
279
|
+
"package:delete": {
|
|
280
|
+
"id": "package:delete",
|
|
281
|
+
"summary": "Delete a package.",
|
|
282
|
+
"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.",
|
|
283
|
+
"strict": true,
|
|
284
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
285
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
286
|
+
"pluginType": "core",
|
|
287
|
+
"aliases": [
|
|
288
|
+
"force:package:beta:delete",
|
|
289
|
+
"force:package:delete"
|
|
290
|
+
],
|
|
291
|
+
"examples": [
|
|
292
|
+
"Delete a package using its alias from your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --package \"Your Package Alias\"",
|
|
293
|
+
"Delete a package using its ID from the specified Dev Hub org:\n<%= config.bin %> <%= command.id %> --package 0Ho... --target-hub-org devhub@example.com"
|
|
294
|
+
],
|
|
295
|
+
"deprecateAliases": true,
|
|
296
|
+
"flags": {
|
|
297
|
+
"json": {
|
|
298
|
+
"name": "json",
|
|
299
|
+
"type": "boolean",
|
|
300
|
+
"description": "Format output as json.",
|
|
301
|
+
"helpGroup": "GLOBAL",
|
|
302
|
+
"allowNo": false,
|
|
303
|
+
"deprecateAliases": true
|
|
304
|
+
},
|
|
305
|
+
"loglevel": {
|
|
306
|
+
"name": "loglevel",
|
|
307
|
+
"type": "option",
|
|
308
|
+
"hidden": true,
|
|
309
|
+
"multiple": false,
|
|
310
|
+
"deprecated": {
|
|
311
|
+
"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."
|
|
312
|
+
},
|
|
313
|
+
"deprecateAliases": true
|
|
314
|
+
},
|
|
315
|
+
"target-hub-org": {
|
|
316
|
+
"name": "target-hub-org",
|
|
317
|
+
"type": "option",
|
|
318
|
+
"char": "v",
|
|
319
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
320
|
+
"required": true,
|
|
321
|
+
"multiple": false,
|
|
322
|
+
"deprecateAliases": true,
|
|
323
|
+
"aliases": [
|
|
324
|
+
"targetdevhubusername"
|
|
325
|
+
]
|
|
326
|
+
},
|
|
327
|
+
"api-version": {
|
|
328
|
+
"name": "api-version",
|
|
329
|
+
"type": "option",
|
|
330
|
+
"description": "Override the api version used for api requests made by this command",
|
|
331
|
+
"multiple": false,
|
|
332
|
+
"deprecateAliases": true,
|
|
333
|
+
"aliases": [
|
|
334
|
+
"apiversion"
|
|
335
|
+
]
|
|
336
|
+
},
|
|
337
|
+
"no-prompt": {
|
|
338
|
+
"name": "no-prompt",
|
|
339
|
+
"type": "boolean",
|
|
340
|
+
"char": "n",
|
|
341
|
+
"summary": "Don’t prompt before deleting the package.",
|
|
342
|
+
"allowNo": false,
|
|
343
|
+
"deprecateAliases": true,
|
|
344
|
+
"aliases": [
|
|
345
|
+
"noprompt"
|
|
346
|
+
]
|
|
347
|
+
},
|
|
348
|
+
"package": {
|
|
349
|
+
"name": "package",
|
|
350
|
+
"type": "option",
|
|
351
|
+
"char": "p",
|
|
352
|
+
"summary": "ID (starts with 0Ho) or alias of the package to delete.",
|
|
353
|
+
"required": true,
|
|
354
|
+
"multiple": false,
|
|
355
|
+
"deprecateAliases": true
|
|
356
|
+
},
|
|
357
|
+
"undelete": {
|
|
358
|
+
"name": "undelete",
|
|
359
|
+
"type": "boolean",
|
|
360
|
+
"summary": "Undelete a deleted package.",
|
|
361
|
+
"hidden": true,
|
|
362
|
+
"allowNo": false,
|
|
363
|
+
"deprecateAliases": true
|
|
364
|
+
}
|
|
365
|
+
},
|
|
366
|
+
"args": {},
|
|
367
|
+
"requiresProject": true,
|
|
368
|
+
"hasDynamicHelp": true
|
|
369
|
+
},
|
|
370
|
+
"package:install": {
|
|
371
|
+
"id": "package:install",
|
|
372
|
+
"summary": "Install a version of a package in the target org.",
|
|
373
|
+
"description": "To install 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\nFor package upgrades, to specify options for component deprecation or deletion of removed components, include an --upgrade-type value. 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.) The default is Mixed.",
|
|
374
|
+
"strict": true,
|
|
375
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
376
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
377
|
+
"pluginType": "core",
|
|
378
|
+
"aliases": [
|
|
379
|
+
"force:package:beta:install",
|
|
380
|
+
"force:package:install"
|
|
381
|
+
],
|
|
382
|
+
"examples": [
|
|
383
|
+
"Install 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",
|
|
384
|
+
"Install a package version with the specified alias into your default org:\n<%= config.bin %> <%= command.id %> --package awesome_package_alias",
|
|
385
|
+
"Install a package version with an alias that includes spaces into your default org:\n<%= config.bin %> <%= command.id %> --package \"Awesome Package Alias\"",
|
|
386
|
+
"Install an unlocked package version with the specified ID and deprecate all removed components:\n<%= config.bin %> <%= command.id %> --package 04t... --upgrade-type DeprecateOnly"
|
|
387
|
+
],
|
|
388
|
+
"deprecateAliases": true,
|
|
389
|
+
"flags": {
|
|
390
|
+
"json": {
|
|
391
|
+
"name": "json",
|
|
392
|
+
"type": "boolean",
|
|
393
|
+
"description": "Format output as json.",
|
|
394
|
+
"helpGroup": "GLOBAL",
|
|
395
|
+
"allowNo": false,
|
|
396
|
+
"deprecateAliases": true
|
|
397
|
+
},
|
|
398
|
+
"loglevel": {
|
|
399
|
+
"name": "loglevel",
|
|
400
|
+
"type": "option",
|
|
401
|
+
"hidden": true,
|
|
402
|
+
"multiple": false,
|
|
403
|
+
"deprecated": {
|
|
404
|
+
"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."
|
|
405
|
+
},
|
|
406
|
+
"deprecateAliases": true
|
|
407
|
+
},
|
|
408
|
+
"target-org": {
|
|
409
|
+
"name": "target-org",
|
|
410
|
+
"type": "option",
|
|
411
|
+
"char": "o",
|
|
412
|
+
"summary": "Username or alias of the target org.",
|
|
413
|
+
"required": true,
|
|
414
|
+
"multiple": false,
|
|
415
|
+
"deprecateAliases": true,
|
|
416
|
+
"aliases": [
|
|
417
|
+
"targetusername",
|
|
418
|
+
"u"
|
|
419
|
+
]
|
|
420
|
+
},
|
|
421
|
+
"api-version": {
|
|
422
|
+
"name": "api-version",
|
|
423
|
+
"type": "option",
|
|
424
|
+
"description": "Override the api version used for api requests made by this command",
|
|
425
|
+
"multiple": false,
|
|
426
|
+
"deprecateAliases": true,
|
|
427
|
+
"aliases": [
|
|
428
|
+
"apiversion"
|
|
429
|
+
]
|
|
430
|
+
},
|
|
431
|
+
"wait": {
|
|
432
|
+
"name": "wait",
|
|
433
|
+
"type": "option",
|
|
434
|
+
"char": "w",
|
|
435
|
+
"summary": "Number of minutes to wait for installation status.",
|
|
436
|
+
"multiple": false,
|
|
437
|
+
"default": {
|
|
438
|
+
"quantity": 0,
|
|
439
|
+
"unit": 0
|
|
440
|
+
},
|
|
441
|
+
"deprecateAliases": true
|
|
442
|
+
},
|
|
443
|
+
"installation-key": {
|
|
444
|
+
"name": "installation-key",
|
|
445
|
+
"type": "option",
|
|
446
|
+
"char": "k",
|
|
447
|
+
"summary": "Installation key for key-protected package (default: null).",
|
|
448
|
+
"multiple": false,
|
|
449
|
+
"deprecateAliases": true,
|
|
450
|
+
"aliases": [
|
|
451
|
+
"installationkey"
|
|
452
|
+
]
|
|
453
|
+
},
|
|
454
|
+
"publish-wait": {
|
|
455
|
+
"name": "publish-wait",
|
|
456
|
+
"type": "option",
|
|
457
|
+
"char": "b",
|
|
458
|
+
"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.",
|
|
459
|
+
"multiple": false,
|
|
460
|
+
"default": {
|
|
461
|
+
"quantity": 0,
|
|
462
|
+
"unit": 0
|
|
463
|
+
},
|
|
464
|
+
"deprecateAliases": true,
|
|
465
|
+
"aliases": [
|
|
466
|
+
"publishwait"
|
|
467
|
+
]
|
|
468
|
+
},
|
|
469
|
+
"no-prompt": {
|
|
470
|
+
"name": "no-prompt",
|
|
471
|
+
"type": "boolean",
|
|
472
|
+
"char": "r",
|
|
473
|
+
"summary": "Don't prompt for confirmation.",
|
|
474
|
+
"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.",
|
|
475
|
+
"allowNo": false,
|
|
476
|
+
"deprecateAliases": true,
|
|
477
|
+
"aliases": [
|
|
478
|
+
"noprompt"
|
|
479
|
+
]
|
|
480
|
+
},
|
|
481
|
+
"package": {
|
|
482
|
+
"name": "package",
|
|
483
|
+
"type": "option",
|
|
484
|
+
"char": "p",
|
|
485
|
+
"summary": "ID (starts with 04t) or alias of the package version to install.",
|
|
486
|
+
"required": true,
|
|
487
|
+
"multiple": false,
|
|
488
|
+
"deprecateAliases": true
|
|
489
|
+
},
|
|
490
|
+
"apex-compile": {
|
|
491
|
+
"name": "apex-compile",
|
|
492
|
+
"type": "option",
|
|
493
|
+
"char": "a",
|
|
494
|
+
"summary": "Compile all Apex in the org and package, or only Apex in the package; unlocked packages only.",
|
|
495
|
+
"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.",
|
|
496
|
+
"helpValue": "(all|package)",
|
|
497
|
+
"multiple": false,
|
|
498
|
+
"options": [
|
|
499
|
+
"all",
|
|
500
|
+
"package"
|
|
501
|
+
],
|
|
502
|
+
"default": "all",
|
|
503
|
+
"deprecateAliases": true,
|
|
504
|
+
"aliases": [
|
|
505
|
+
"apexcompile"
|
|
506
|
+
]
|
|
507
|
+
},
|
|
508
|
+
"security-type": {
|
|
509
|
+
"name": "security-type",
|
|
510
|
+
"type": "option",
|
|
511
|
+
"char": "s",
|
|
512
|
+
"summary": "Security access type for the installed package. (deprecation notice: The default --security-type value will change from AllUsers to AdminsOnly in v47.0 or later.)",
|
|
513
|
+
"helpValue": "(AllUsers|AdminsOnly)",
|
|
514
|
+
"multiple": false,
|
|
515
|
+
"options": [
|
|
516
|
+
"AllUsers",
|
|
517
|
+
"AdminsOnly"
|
|
518
|
+
],
|
|
519
|
+
"default": "AdminsOnly",
|
|
520
|
+
"deprecateAliases": true,
|
|
521
|
+
"aliases": [
|
|
522
|
+
"securitytype"
|
|
523
|
+
]
|
|
524
|
+
},
|
|
525
|
+
"upgrade-type": {
|
|
526
|
+
"name": "upgrade-type",
|
|
527
|
+
"type": "option",
|
|
528
|
+
"char": "t",
|
|
529
|
+
"summary": "Upgrade type for the package installation; available only for unlocked packages.",
|
|
530
|
+
"description": "For package upgrades, specifies whether to mark all removed components as deprecated (DeprecateOnly), to delete removed components that can be safely deleted and deprecate the others (Mixed), or to delete all removed components, except for custom objects and custom fields, that don't have dependencies (Delete). The default is Mixed. Can specify DeprecateOnly or Delete only for unlocked package upgrades.",
|
|
531
|
+
"helpValue": "(DeprecateOnly|Mixed|Delete)",
|
|
532
|
+
"multiple": false,
|
|
533
|
+
"options": [
|
|
534
|
+
"DeprecateOnly",
|
|
535
|
+
"Mixed",
|
|
536
|
+
"Delete"
|
|
537
|
+
],
|
|
538
|
+
"default": "Mixed",
|
|
539
|
+
"deprecateAliases": true,
|
|
540
|
+
"aliases": [
|
|
541
|
+
"upgradetype"
|
|
542
|
+
]
|
|
543
|
+
}
|
|
544
|
+
},
|
|
545
|
+
"args": {},
|
|
546
|
+
"hasDynamicHelp": true
|
|
547
|
+
},
|
|
548
|
+
"package:list": {
|
|
549
|
+
"id": "package:list",
|
|
550
|
+
"summary": "List all packages in the Dev Hub org.",
|
|
551
|
+
"description": "Description",
|
|
552
|
+
"strict": true,
|
|
553
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
554
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
555
|
+
"pluginType": "core",
|
|
556
|
+
"aliases": [
|
|
557
|
+
"force:package:beta:list",
|
|
558
|
+
"force:package:list"
|
|
559
|
+
],
|
|
560
|
+
"examples": [
|
|
561
|
+
"List all packages in the specified Dev Hub org:\n<%= config.bin %> <%= command.id %> --target-hub-org devhub@example.com",
|
|
562
|
+
"List all packages details in the specified Dev Hub org, and show extended details about each package:\n<%= config.bin %> <%= command.id %> --target-hub-org devhub@example.com --verbose"
|
|
563
|
+
],
|
|
564
|
+
"deprecateAliases": true,
|
|
565
|
+
"flags": {
|
|
566
|
+
"json": {
|
|
567
|
+
"name": "json",
|
|
568
|
+
"type": "boolean",
|
|
569
|
+
"description": "Format output as json.",
|
|
570
|
+
"helpGroup": "GLOBAL",
|
|
571
|
+
"allowNo": false,
|
|
572
|
+
"deprecateAliases": true
|
|
573
|
+
},
|
|
574
|
+
"loglevel": {
|
|
575
|
+
"name": "loglevel",
|
|
576
|
+
"type": "option",
|
|
577
|
+
"hidden": true,
|
|
578
|
+
"multiple": false,
|
|
579
|
+
"deprecated": {
|
|
580
|
+
"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."
|
|
581
|
+
},
|
|
582
|
+
"deprecateAliases": true
|
|
583
|
+
},
|
|
584
|
+
"target-hub-org": {
|
|
585
|
+
"name": "target-hub-org",
|
|
586
|
+
"type": "option",
|
|
587
|
+
"char": "v",
|
|
588
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
589
|
+
"required": true,
|
|
590
|
+
"multiple": false,
|
|
591
|
+
"deprecateAliases": true,
|
|
592
|
+
"aliases": [
|
|
593
|
+
"targetdevhubusername"
|
|
594
|
+
]
|
|
595
|
+
},
|
|
596
|
+
"api-version": {
|
|
597
|
+
"name": "api-version",
|
|
598
|
+
"type": "option",
|
|
599
|
+
"description": "Override the api version used for api requests made by this command",
|
|
600
|
+
"multiple": false,
|
|
601
|
+
"deprecateAliases": true,
|
|
602
|
+
"aliases": [
|
|
603
|
+
"apiversion"
|
|
604
|
+
]
|
|
605
|
+
},
|
|
606
|
+
"verbose": {
|
|
607
|
+
"name": "verbose",
|
|
608
|
+
"type": "boolean",
|
|
609
|
+
"summary": "Display extended package detail.",
|
|
610
|
+
"allowNo": false,
|
|
611
|
+
"deprecateAliases": true
|
|
612
|
+
}
|
|
613
|
+
},
|
|
614
|
+
"args": {},
|
|
615
|
+
"requiresProject": true,
|
|
616
|
+
"hasDynamicHelp": true
|
|
617
|
+
},
|
|
618
|
+
"package:uninstall": {
|
|
619
|
+
"id": "package:uninstall",
|
|
620
|
+
"summary": "Uninstall a second-generation package from the target org.",
|
|
621
|
+
"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.",
|
|
622
|
+
"strict": true,
|
|
623
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
624
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
625
|
+
"pluginType": "core",
|
|
626
|
+
"aliases": [
|
|
627
|
+
"force:package:beta:uninstall",
|
|
628
|
+
"force:package:uninstall"
|
|
629
|
+
],
|
|
630
|
+
"examples": [
|
|
631
|
+
"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",
|
|
632
|
+
"Uninstall a package with the specified alias from your default org:\n<%= config.bin %> <%= command.id %> --package undesirable_package_alias",
|
|
633
|
+
"Uninstall a package with an alias that contains spaces from your default org:\n<%= config.bin %> <%= command.id %> --package \"Undesirable Package Alias\""
|
|
634
|
+
],
|
|
635
|
+
"deprecateAliases": true,
|
|
636
|
+
"flags": {
|
|
637
|
+
"json": {
|
|
638
|
+
"name": "json",
|
|
639
|
+
"type": "boolean",
|
|
640
|
+
"description": "Format output as json.",
|
|
641
|
+
"helpGroup": "GLOBAL",
|
|
642
|
+
"allowNo": false,
|
|
643
|
+
"deprecateAliases": true
|
|
644
|
+
},
|
|
645
|
+
"loglevel": {
|
|
646
|
+
"name": "loglevel",
|
|
647
|
+
"type": "option",
|
|
648
|
+
"hidden": true,
|
|
649
|
+
"multiple": false,
|
|
650
|
+
"deprecated": {
|
|
651
|
+
"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."
|
|
652
|
+
},
|
|
653
|
+
"deprecateAliases": true
|
|
654
|
+
},
|
|
655
|
+
"target-org": {
|
|
656
|
+
"name": "target-org",
|
|
657
|
+
"type": "option",
|
|
658
|
+
"char": "o",
|
|
659
|
+
"summary": "Username or alias of the target org.",
|
|
660
|
+
"required": true,
|
|
661
|
+
"multiple": false,
|
|
662
|
+
"deprecateAliases": true,
|
|
663
|
+
"aliases": [
|
|
664
|
+
"targetusername",
|
|
665
|
+
"u"
|
|
666
|
+
]
|
|
667
|
+
},
|
|
668
|
+
"api-version": {
|
|
669
|
+
"name": "api-version",
|
|
670
|
+
"type": "option",
|
|
671
|
+
"description": "Override the api version used for api requests made by this command",
|
|
672
|
+
"multiple": false,
|
|
673
|
+
"deprecateAliases": true,
|
|
674
|
+
"aliases": [
|
|
675
|
+
"apiversion"
|
|
676
|
+
]
|
|
677
|
+
},
|
|
678
|
+
"wait": {
|
|
679
|
+
"name": "wait",
|
|
680
|
+
"type": "option",
|
|
681
|
+
"char": "w",
|
|
682
|
+
"summary": "Number of minutes to wait for uninstall status.",
|
|
683
|
+
"multiple": false,
|
|
684
|
+
"default": {
|
|
685
|
+
"quantity": 0,
|
|
686
|
+
"unit": 0
|
|
687
|
+
},
|
|
688
|
+
"deprecateAliases": true
|
|
689
|
+
},
|
|
690
|
+
"package": {
|
|
691
|
+
"name": "package",
|
|
692
|
+
"type": "option",
|
|
693
|
+
"char": "p",
|
|
694
|
+
"summary": "ID (starts with 04t) or alias of the package version to uninstall.",
|
|
695
|
+
"required": true,
|
|
696
|
+
"multiple": false,
|
|
697
|
+
"deprecateAliases": true
|
|
698
|
+
}
|
|
699
|
+
},
|
|
700
|
+
"args": {},
|
|
701
|
+
"hasDynamicHelp": true
|
|
702
|
+
},
|
|
703
|
+
"package:update": {
|
|
704
|
+
"id": "package:update",
|
|
705
|
+
"summary": "Update package details.",
|
|
706
|
+
"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.",
|
|
707
|
+
"strict": true,
|
|
708
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
709
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
710
|
+
"pluginType": "core",
|
|
711
|
+
"aliases": [
|
|
712
|
+
"force:package:beta:update",
|
|
713
|
+
"force:package:update"
|
|
714
|
+
],
|
|
715
|
+
"examples": [
|
|
716
|
+
"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\"",
|
|
717
|
+
"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-hub-org devhub@example.com"
|
|
718
|
+
],
|
|
719
|
+
"deprecateAliases": true,
|
|
720
|
+
"flags": {
|
|
721
|
+
"json": {
|
|
722
|
+
"name": "json",
|
|
723
|
+
"type": "boolean",
|
|
724
|
+
"description": "Format output as json.",
|
|
725
|
+
"helpGroup": "GLOBAL",
|
|
726
|
+
"allowNo": false,
|
|
727
|
+
"deprecateAliases": true
|
|
728
|
+
},
|
|
729
|
+
"loglevel": {
|
|
730
|
+
"name": "loglevel",
|
|
731
|
+
"type": "option",
|
|
732
|
+
"hidden": true,
|
|
733
|
+
"multiple": false,
|
|
734
|
+
"deprecated": {
|
|
735
|
+
"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."
|
|
736
|
+
},
|
|
737
|
+
"deprecateAliases": true
|
|
738
|
+
},
|
|
739
|
+
"target-hub-org": {
|
|
740
|
+
"name": "target-hub-org",
|
|
741
|
+
"type": "option",
|
|
742
|
+
"char": "v",
|
|
743
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
744
|
+
"required": true,
|
|
745
|
+
"multiple": false,
|
|
746
|
+
"deprecateAliases": true,
|
|
747
|
+
"aliases": [
|
|
748
|
+
"targetdevhubusername"
|
|
749
|
+
]
|
|
750
|
+
},
|
|
751
|
+
"api-version": {
|
|
752
|
+
"name": "api-version",
|
|
753
|
+
"type": "option",
|
|
754
|
+
"description": "Override the api version used for api requests made by this command",
|
|
755
|
+
"multiple": false,
|
|
756
|
+
"deprecateAliases": true,
|
|
757
|
+
"aliases": [
|
|
758
|
+
"apiversion"
|
|
759
|
+
]
|
|
760
|
+
},
|
|
761
|
+
"package": {
|
|
762
|
+
"name": "package",
|
|
763
|
+
"type": "option",
|
|
764
|
+
"char": "p",
|
|
765
|
+
"summary": "ID (starts with 0Ho) or alias of the package to update.",
|
|
766
|
+
"required": true,
|
|
767
|
+
"multiple": false,
|
|
768
|
+
"deprecateAliases": true
|
|
769
|
+
},
|
|
770
|
+
"name": {
|
|
771
|
+
"name": "name",
|
|
772
|
+
"type": "option",
|
|
773
|
+
"char": "n",
|
|
774
|
+
"summary": "New name of the package.",
|
|
775
|
+
"multiple": false,
|
|
776
|
+
"deprecateAliases": true
|
|
777
|
+
},
|
|
778
|
+
"description": {
|
|
779
|
+
"name": "description",
|
|
780
|
+
"type": "option",
|
|
781
|
+
"char": "d",
|
|
782
|
+
"summary": "New description of the package.",
|
|
783
|
+
"multiple": false,
|
|
784
|
+
"deprecateAliases": true
|
|
785
|
+
},
|
|
786
|
+
"error-notification-username": {
|
|
787
|
+
"name": "error-notification-username",
|
|
788
|
+
"type": "option",
|
|
789
|
+
"char": "o",
|
|
790
|
+
"summary": "Active Dev Hub user designated to receive email notifications for package errors.",
|
|
791
|
+
"description": "Email notifications include information about unhandled Apex exceptions, and install, upgrade, or uninstall failures associated with your package.",
|
|
792
|
+
"multiple": false,
|
|
793
|
+
"deprecateAliases": true,
|
|
794
|
+
"aliases": [
|
|
795
|
+
"errornotificationusername"
|
|
796
|
+
]
|
|
797
|
+
}
|
|
798
|
+
},
|
|
799
|
+
"args": {},
|
|
800
|
+
"requiresProject": true,
|
|
801
|
+
"hasDynamicHelp": true
|
|
802
|
+
},
|
|
803
|
+
"package:install:report": {
|
|
804
|
+
"id": "package:install:report",
|
|
805
|
+
"summary": "Retrieve the status of a package installation request.",
|
|
806
|
+
"strict": true,
|
|
807
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
808
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
809
|
+
"pluginType": "core",
|
|
810
|
+
"aliases": [
|
|
811
|
+
"force:package:beta:install:report",
|
|
812
|
+
"force:package:install:report"
|
|
813
|
+
],
|
|
814
|
+
"examples": [
|
|
815
|
+
"Retrieve the status of a package installation request with the specified ID on your default org:\n<%= config.bin %> <%= command.id %> --request-id 0Hf...",
|
|
816
|
+
"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"
|
|
817
|
+
],
|
|
818
|
+
"deprecateAliases": true,
|
|
819
|
+
"flags": {
|
|
820
|
+
"json": {
|
|
821
|
+
"name": "json",
|
|
822
|
+
"type": "boolean",
|
|
823
|
+
"description": "Format output as json.",
|
|
824
|
+
"helpGroup": "GLOBAL",
|
|
825
|
+
"allowNo": false,
|
|
826
|
+
"deprecateAliases": true
|
|
827
|
+
},
|
|
828
|
+
"target-org": {
|
|
829
|
+
"name": "target-org",
|
|
830
|
+
"type": "option",
|
|
831
|
+
"char": "o",
|
|
832
|
+
"summary": "Username or alias of the target org.",
|
|
833
|
+
"required": true,
|
|
834
|
+
"multiple": false,
|
|
835
|
+
"deprecateAliases": true,
|
|
836
|
+
"aliases": [
|
|
837
|
+
"targetusername",
|
|
838
|
+
"u"
|
|
839
|
+
]
|
|
840
|
+
},
|
|
841
|
+
"api-version": {
|
|
842
|
+
"name": "api-version",
|
|
843
|
+
"type": "option",
|
|
844
|
+
"description": "Override the api version used for api requests made by this command",
|
|
845
|
+
"multiple": false,
|
|
846
|
+
"deprecateAliases": true,
|
|
847
|
+
"aliases": [
|
|
848
|
+
"apiversion"
|
|
849
|
+
]
|
|
850
|
+
},
|
|
851
|
+
"loglevel": {
|
|
852
|
+
"name": "loglevel",
|
|
853
|
+
"type": "option",
|
|
854
|
+
"hidden": true,
|
|
855
|
+
"multiple": false,
|
|
856
|
+
"deprecated": {
|
|
857
|
+
"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."
|
|
858
|
+
},
|
|
859
|
+
"deprecateAliases": true
|
|
860
|
+
},
|
|
861
|
+
"request-id": {
|
|
862
|
+
"name": "request-id",
|
|
863
|
+
"type": "option",
|
|
864
|
+
"char": "i",
|
|
865
|
+
"summary": "ID of the package install request you want to check; starts with 0Hf.",
|
|
866
|
+
"required": true,
|
|
867
|
+
"multiple": false,
|
|
868
|
+
"deprecateAliases": true,
|
|
869
|
+
"aliases": [
|
|
870
|
+
"requestid"
|
|
871
|
+
]
|
|
872
|
+
}
|
|
873
|
+
},
|
|
874
|
+
"args": {},
|
|
875
|
+
"hasDynamicHelp": true
|
|
876
|
+
},
|
|
877
|
+
"package:installed:list": {
|
|
878
|
+
"id": "package:installed:list",
|
|
879
|
+
"summary": "List the org’s installed packages.",
|
|
880
|
+
"strict": true,
|
|
881
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
882
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
883
|
+
"pluginType": "core",
|
|
884
|
+
"aliases": [
|
|
885
|
+
"force:package:beta:installed:list",
|
|
886
|
+
"force:package:installed:list"
|
|
887
|
+
],
|
|
888
|
+
"examples": [
|
|
889
|
+
"List the installed packages in your default org:\n<%= config.bin %> <%= command.id %>",
|
|
890
|
+
"List the installed packages in the org with username me@example.com:\n<%= config.bin %> <%= command.id %> --target-org me@example.com"
|
|
891
|
+
],
|
|
892
|
+
"deprecateAliases": true,
|
|
893
|
+
"flags": {
|
|
894
|
+
"json": {
|
|
895
|
+
"name": "json",
|
|
896
|
+
"type": "boolean",
|
|
897
|
+
"description": "Format output as json.",
|
|
898
|
+
"helpGroup": "GLOBAL",
|
|
899
|
+
"allowNo": false,
|
|
900
|
+
"deprecateAliases": true
|
|
901
|
+
},
|
|
902
|
+
"loglevel": {
|
|
903
|
+
"name": "loglevel",
|
|
904
|
+
"type": "option",
|
|
905
|
+
"hidden": true,
|
|
906
|
+
"multiple": false,
|
|
907
|
+
"deprecated": {
|
|
908
|
+
"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."
|
|
909
|
+
},
|
|
910
|
+
"deprecateAliases": true
|
|
911
|
+
},
|
|
912
|
+
"target-org": {
|
|
913
|
+
"name": "target-org",
|
|
914
|
+
"type": "option",
|
|
915
|
+
"char": "o",
|
|
916
|
+
"summary": "Username or alias of the target org.",
|
|
917
|
+
"required": true,
|
|
918
|
+
"multiple": false,
|
|
919
|
+
"deprecateAliases": true,
|
|
920
|
+
"aliases": [
|
|
921
|
+
"targetusername",
|
|
922
|
+
"u"
|
|
923
|
+
]
|
|
924
|
+
},
|
|
925
|
+
"api-version": {
|
|
926
|
+
"name": "api-version",
|
|
927
|
+
"type": "option",
|
|
928
|
+
"description": "Override the api version used for api requests made by this command",
|
|
929
|
+
"multiple": false,
|
|
930
|
+
"deprecateAliases": true,
|
|
931
|
+
"aliases": [
|
|
932
|
+
"apiversion"
|
|
933
|
+
]
|
|
934
|
+
}
|
|
935
|
+
},
|
|
936
|
+
"args": {},
|
|
937
|
+
"requiresProject": true,
|
|
938
|
+
"hasDynamicHelp": true
|
|
939
|
+
},
|
|
940
|
+
"package:uninstall:report": {
|
|
941
|
+
"id": "package:uninstall:report",
|
|
942
|
+
"summary": "Retrieve the status of a package uninstall request.",
|
|
943
|
+
"strict": true,
|
|
944
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
945
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
946
|
+
"pluginType": "core",
|
|
947
|
+
"aliases": [
|
|
948
|
+
"force:package:beta:uninstall:report",
|
|
949
|
+
"force:package:uninstall:report"
|
|
950
|
+
],
|
|
951
|
+
"examples": [
|
|
952
|
+
"Retrieve the status of a package uninstall in your default org using the specified request ID:\n<%= config.bin %> <%= command.id %> --request-id 06y...",
|
|
953
|
+
"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"
|
|
954
|
+
],
|
|
955
|
+
"deprecateAliases": true,
|
|
956
|
+
"flags": {
|
|
957
|
+
"json": {
|
|
958
|
+
"name": "json",
|
|
959
|
+
"type": "boolean",
|
|
960
|
+
"description": "Format output as json.",
|
|
961
|
+
"helpGroup": "GLOBAL",
|
|
962
|
+
"allowNo": false,
|
|
963
|
+
"deprecateAliases": true
|
|
964
|
+
},
|
|
965
|
+
"loglevel": {
|
|
966
|
+
"name": "loglevel",
|
|
967
|
+
"type": "option",
|
|
968
|
+
"hidden": true,
|
|
969
|
+
"multiple": false,
|
|
970
|
+
"deprecated": {
|
|
971
|
+
"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."
|
|
972
|
+
},
|
|
973
|
+
"deprecateAliases": true
|
|
974
|
+
},
|
|
975
|
+
"target-org": {
|
|
976
|
+
"name": "target-org",
|
|
977
|
+
"type": "option",
|
|
978
|
+
"char": "o",
|
|
979
|
+
"summary": "Username or alias of the target org.",
|
|
980
|
+
"required": true,
|
|
981
|
+
"multiple": false,
|
|
982
|
+
"deprecateAliases": true,
|
|
983
|
+
"aliases": [
|
|
984
|
+
"targetusername",
|
|
985
|
+
"u"
|
|
986
|
+
]
|
|
987
|
+
},
|
|
988
|
+
"api-version": {
|
|
989
|
+
"name": "api-version",
|
|
990
|
+
"type": "option",
|
|
991
|
+
"description": "Override the api version used for api requests made by this command",
|
|
992
|
+
"multiple": false,
|
|
993
|
+
"deprecateAliases": true,
|
|
994
|
+
"aliases": [
|
|
995
|
+
"apiversion"
|
|
996
|
+
]
|
|
997
|
+
},
|
|
998
|
+
"request-id": {
|
|
999
|
+
"name": "request-id",
|
|
1000
|
+
"type": "option",
|
|
1001
|
+
"char": "i",
|
|
1002
|
+
"summary": "ID of the package uninstall request you want to check; starts with 06y.",
|
|
1003
|
+
"required": true,
|
|
1004
|
+
"multiple": false,
|
|
1005
|
+
"deprecateAliases": true,
|
|
1006
|
+
"aliases": [
|
|
1007
|
+
"requestid"
|
|
1008
|
+
]
|
|
1009
|
+
}
|
|
1010
|
+
},
|
|
1011
|
+
"args": {},
|
|
1012
|
+
"hasDynamicHelp": true
|
|
1013
|
+
},
|
|
1014
|
+
"package:version:create": {
|
|
1015
|
+
"id": "package:version:create",
|
|
1016
|
+
"summary": "Create a package version in the Dev Hub org.",
|
|
1017
|
+
"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.",
|
|
1018
|
+
"strict": true,
|
|
1019
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
1020
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
1021
|
+
"pluginType": "core",
|
|
1022
|
+
"aliases": [
|
|
1023
|
+
"force:package:beta:version:create",
|
|
1024
|
+
"force:package:version:create"
|
|
1025
|
+
],
|
|
1026
|
+
"examples": [
|
|
1027
|
+
"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",
|
|
1028
|
+
"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-hub-org devhub@example.com",
|
|
1029
|
+
"Create a package version from a package with the specified ID:\n<%= config.bin %> <%= command.id %> --package 0Ho... --installation-key password123",
|
|
1030
|
+
"Create a package version and skip the validation step:\n<%= config.bin %> <%= command.id %> --path common --installation-key password123 --skip-validation"
|
|
1031
|
+
],
|
|
1032
|
+
"deprecateAliases": true,
|
|
1033
|
+
"flags": {
|
|
1034
|
+
"json": {
|
|
1035
|
+
"name": "json",
|
|
1036
|
+
"type": "boolean",
|
|
1037
|
+
"description": "Format output as json.",
|
|
1038
|
+
"helpGroup": "GLOBAL",
|
|
1039
|
+
"allowNo": false,
|
|
1040
|
+
"deprecateAliases": true
|
|
1041
|
+
},
|
|
1042
|
+
"loglevel": {
|
|
1043
|
+
"name": "loglevel",
|
|
1044
|
+
"type": "option",
|
|
1045
|
+
"hidden": true,
|
|
1046
|
+
"multiple": false,
|
|
1047
|
+
"deprecated": {
|
|
1048
|
+
"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."
|
|
1049
|
+
},
|
|
1050
|
+
"deprecateAliases": true
|
|
1051
|
+
},
|
|
1052
|
+
"target-hub-org": {
|
|
1053
|
+
"name": "target-hub-org",
|
|
1054
|
+
"type": "option",
|
|
1055
|
+
"char": "v",
|
|
1056
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
1057
|
+
"required": true,
|
|
1058
|
+
"multiple": false,
|
|
1059
|
+
"deprecateAliases": true,
|
|
1060
|
+
"aliases": [
|
|
1061
|
+
"targetdevhubusername"
|
|
1062
|
+
]
|
|
1063
|
+
},
|
|
1064
|
+
"api-version": {
|
|
1065
|
+
"name": "api-version",
|
|
1066
|
+
"type": "option",
|
|
1067
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1068
|
+
"multiple": false,
|
|
1069
|
+
"deprecateAliases": true,
|
|
1070
|
+
"aliases": [
|
|
1071
|
+
"apiversion"
|
|
1072
|
+
]
|
|
1073
|
+
},
|
|
1074
|
+
"branch": {
|
|
1075
|
+
"name": "branch",
|
|
1076
|
+
"type": "option",
|
|
1077
|
+
"char": "b",
|
|
1078
|
+
"summary": "Name of the branch in your source control system that the package version is based on.",
|
|
1079
|
+
"multiple": false,
|
|
1080
|
+
"deprecateAliases": true
|
|
1081
|
+
},
|
|
1082
|
+
"build-instance": {
|
|
1083
|
+
"name": "build-instance",
|
|
1084
|
+
"type": "option",
|
|
1085
|
+
"char": "s",
|
|
1086
|
+
"summary": "Instance where the package version will be created, such as NA50.",
|
|
1087
|
+
"hidden": true,
|
|
1088
|
+
"multiple": false,
|
|
1089
|
+
"deprecateAliases": true,
|
|
1090
|
+
"aliases": [
|
|
1091
|
+
"buildinstance"
|
|
1092
|
+
]
|
|
1093
|
+
},
|
|
1094
|
+
"code-coverage": {
|
|
1095
|
+
"name": "code-coverage",
|
|
1096
|
+
"type": "boolean",
|
|
1097
|
+
"char": "c",
|
|
1098
|
+
"summary": "Calculate and store the code coverage percentage by running the packaged Apex tests included in this package version.",
|
|
1099
|
+
"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.",
|
|
1100
|
+
"allowNo": false,
|
|
1101
|
+
"exclusive": [
|
|
1102
|
+
"skip-validation"
|
|
1103
|
+
],
|
|
1104
|
+
"deprecateAliases": true,
|
|
1105
|
+
"aliases": [
|
|
1106
|
+
"codecoverage"
|
|
1107
|
+
]
|
|
1108
|
+
},
|
|
1109
|
+
"definition-file": {
|
|
1110
|
+
"name": "definition-file",
|
|
1111
|
+
"type": "option",
|
|
1112
|
+
"char": "f",
|
|
1113
|
+
"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.",
|
|
1114
|
+
"multiple": false,
|
|
1115
|
+
"deprecateAliases": true,
|
|
1116
|
+
"aliases": [
|
|
1117
|
+
"definitionfile"
|
|
1118
|
+
]
|
|
1119
|
+
},
|
|
1120
|
+
"installation-key": {
|
|
1121
|
+
"name": "installation-key",
|
|
1122
|
+
"type": "option",
|
|
1123
|
+
"char": "k",
|
|
1124
|
+
"summary": "Installation key for key-protected package. (either --installation-key or --installation-key-bypass is required)",
|
|
1125
|
+
"multiple": false,
|
|
1126
|
+
"deprecateAliases": true,
|
|
1127
|
+
"aliases": [
|
|
1128
|
+
"installationkey"
|
|
1129
|
+
]
|
|
1130
|
+
},
|
|
1131
|
+
"installation-key-bypass": {
|
|
1132
|
+
"name": "installation-key-bypass",
|
|
1133
|
+
"type": "boolean",
|
|
1134
|
+
"char": "x",
|
|
1135
|
+
"summary": "Bypass the installation key requirement. (either --installation-key or --installation-key-bypass is required)",
|
|
1136
|
+
"description": "If you bypass this requirement, anyone can install your package.",
|
|
1137
|
+
"allowNo": false,
|
|
1138
|
+
"deprecateAliases": true,
|
|
1139
|
+
"aliases": [
|
|
1140
|
+
"installationkeybypass"
|
|
1141
|
+
]
|
|
1142
|
+
},
|
|
1143
|
+
"package": {
|
|
1144
|
+
"name": "package",
|
|
1145
|
+
"type": "option",
|
|
1146
|
+
"char": "p",
|
|
1147
|
+
"summary": "ID (starts with 0Ho) or alias of the package to create a version of.",
|
|
1148
|
+
"multiple": false,
|
|
1149
|
+
"deprecateAliases": true
|
|
1150
|
+
},
|
|
1151
|
+
"path": {
|
|
1152
|
+
"name": "path",
|
|
1153
|
+
"type": "option",
|
|
1154
|
+
"char": "d",
|
|
1155
|
+
"summary": "Path to the directory that contains the contents of the package.",
|
|
1156
|
+
"multiple": false,
|
|
1157
|
+
"deprecateAliases": true
|
|
1158
|
+
},
|
|
1159
|
+
"post-install-script": {
|
|
1160
|
+
"name": "post-install-script",
|
|
1161
|
+
"type": "option",
|
|
1162
|
+
"summary": "Name of the post-install script; applies to managed packages only.",
|
|
1163
|
+
"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.",
|
|
1164
|
+
"multiple": false,
|
|
1165
|
+
"deprecateAliases": true,
|
|
1166
|
+
"aliases": [
|
|
1167
|
+
"postinstallscript"
|
|
1168
|
+
]
|
|
1169
|
+
},
|
|
1170
|
+
"post-install-url": {
|
|
1171
|
+
"name": "post-install-url",
|
|
1172
|
+
"type": "option",
|
|
1173
|
+
"summary": "Post-install instructions URL.",
|
|
1174
|
+
"description": "The contents of the post-installation instructions URL are displayed in the UI after installation of the package version.",
|
|
1175
|
+
"multiple": false,
|
|
1176
|
+
"deprecateAliases": true,
|
|
1177
|
+
"aliases": [
|
|
1178
|
+
"postinstallurl"
|
|
1179
|
+
]
|
|
1180
|
+
},
|
|
1181
|
+
"preserve": {
|
|
1182
|
+
"name": "preserve",
|
|
1183
|
+
"type": "boolean",
|
|
1184
|
+
"char": "r",
|
|
1185
|
+
"summary": "Preserve temp files that would otherwise be deleted.",
|
|
1186
|
+
"hidden": true,
|
|
1187
|
+
"allowNo": false,
|
|
1188
|
+
"deprecateAliases": true
|
|
1189
|
+
},
|
|
1190
|
+
"releasenotes-url": {
|
|
1191
|
+
"name": "releasenotes-url",
|
|
1192
|
+
"type": "option",
|
|
1193
|
+
"summary": "Release notes URL.",
|
|
1194
|
+
"description": "This link is displayed in the package installation UI to provide release notes for this package version to subscribers.",
|
|
1195
|
+
"multiple": false,
|
|
1196
|
+
"deprecateAliases": true,
|
|
1197
|
+
"aliases": [
|
|
1198
|
+
"releasenotesurl"
|
|
1199
|
+
]
|
|
1200
|
+
},
|
|
1201
|
+
"skip-ancestor-check": {
|
|
1202
|
+
"name": "skip-ancestor-check",
|
|
1203
|
+
"type": "boolean",
|
|
1204
|
+
"summary": "Overrides ancestry requirements, which allows you to specify a package ancestor that isn’t the highest released package version.",
|
|
1205
|
+
"allowNo": false,
|
|
1206
|
+
"deprecateAliases": true,
|
|
1207
|
+
"aliases": [
|
|
1208
|
+
"skipancestorcheck"
|
|
1209
|
+
]
|
|
1210
|
+
},
|
|
1211
|
+
"skip-validation": {
|
|
1212
|
+
"name": "skip-validation",
|
|
1213
|
+
"type": "boolean",
|
|
1214
|
+
"summary": "Skip validation during package version creation; you can’t promote unvalidated package versions.",
|
|
1215
|
+
"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.",
|
|
1216
|
+
"allowNo": false,
|
|
1217
|
+
"exclusive": [
|
|
1218
|
+
"code-coverage"
|
|
1219
|
+
],
|
|
1220
|
+
"deprecateAliases": true,
|
|
1221
|
+
"aliases": [
|
|
1222
|
+
"skipvalidation"
|
|
1223
|
+
]
|
|
1224
|
+
},
|
|
1225
|
+
"tag": {
|
|
1226
|
+
"name": "tag",
|
|
1227
|
+
"type": "option",
|
|
1228
|
+
"char": "t",
|
|
1229
|
+
"summary": "Package version’s tag.",
|
|
1230
|
+
"multiple": false,
|
|
1231
|
+
"deprecateAliases": true
|
|
1232
|
+
},
|
|
1233
|
+
"uninstall-script": {
|
|
1234
|
+
"name": "uninstall-script",
|
|
1235
|
+
"type": "option",
|
|
1236
|
+
"summary": "Uninstall script name; applies to managed packages only.",
|
|
1237
|
+
"description": "The uninstall script is an Apex class within this package that is run in the installing org after uninstallations of this package.",
|
|
1238
|
+
"multiple": false,
|
|
1239
|
+
"deprecateAliases": true,
|
|
1240
|
+
"aliases": [
|
|
1241
|
+
"uninstallscript"
|
|
1242
|
+
]
|
|
1243
|
+
},
|
|
1244
|
+
"validate-schema": {
|
|
1245
|
+
"name": "validate-schema",
|
|
1246
|
+
"type": "boolean",
|
|
1247
|
+
"char": "j",
|
|
1248
|
+
"summary": "Validate the sfdx-project.json file against the JSON schema.",
|
|
1249
|
+
"hidden": true,
|
|
1250
|
+
"allowNo": false,
|
|
1251
|
+
"deprecateAliases": true,
|
|
1252
|
+
"aliases": [
|
|
1253
|
+
"validateschema"
|
|
1254
|
+
]
|
|
1255
|
+
},
|
|
1256
|
+
"version-description": {
|
|
1257
|
+
"name": "version-description",
|
|
1258
|
+
"type": "option",
|
|
1259
|
+
"char": "e",
|
|
1260
|
+
"summary": "Description of the package version to be created; overrides the sfdx-project.json value.",
|
|
1261
|
+
"multiple": false,
|
|
1262
|
+
"deprecateAliases": true,
|
|
1263
|
+
"aliases": [
|
|
1264
|
+
"versiondescription"
|
|
1265
|
+
]
|
|
1266
|
+
},
|
|
1267
|
+
"version-name": {
|
|
1268
|
+
"name": "version-name",
|
|
1269
|
+
"type": "option",
|
|
1270
|
+
"char": "a",
|
|
1271
|
+
"summary": "Name of the package version to be created; overrides the sfdx-project.json value.",
|
|
1272
|
+
"multiple": false,
|
|
1273
|
+
"deprecateAliases": true,
|
|
1274
|
+
"aliases": [
|
|
1275
|
+
"versionname"
|
|
1276
|
+
]
|
|
1277
|
+
},
|
|
1278
|
+
"version-number": {
|
|
1279
|
+
"name": "version-number",
|
|
1280
|
+
"type": "option",
|
|
1281
|
+
"char": "n",
|
|
1282
|
+
"summary": "Version number of the package version to be created; overrides the sfdx-project.json value.",
|
|
1283
|
+
"multiple": false,
|
|
1284
|
+
"deprecateAliases": true,
|
|
1285
|
+
"aliases": [
|
|
1286
|
+
"versionnumber"
|
|
1287
|
+
]
|
|
1288
|
+
},
|
|
1289
|
+
"wait": {
|
|
1290
|
+
"name": "wait",
|
|
1291
|
+
"type": "option",
|
|
1292
|
+
"char": "w",
|
|
1293
|
+
"summary": "Number of minutes to wait for the package version to be created.",
|
|
1294
|
+
"multiple": false,
|
|
1295
|
+
"default": {
|
|
1296
|
+
"quantity": 0,
|
|
1297
|
+
"unit": 0
|
|
1298
|
+
},
|
|
1299
|
+
"deprecateAliases": true
|
|
1300
|
+
},
|
|
1301
|
+
"language": {
|
|
1302
|
+
"name": "language",
|
|
1303
|
+
"type": "option",
|
|
1304
|
+
"summary": "Language for the package.",
|
|
1305
|
+
"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.",
|
|
1306
|
+
"multiple": false,
|
|
1307
|
+
"deprecateAliases": true
|
|
1308
|
+
}
|
|
1309
|
+
},
|
|
1310
|
+
"args": {},
|
|
1311
|
+
"requiresProject": true,
|
|
1312
|
+
"hasDynamicHelp": true
|
|
1313
|
+
},
|
|
1314
|
+
"package:version:delete": {
|
|
1315
|
+
"id": "package:version:delete",
|
|
1316
|
+
"summary": "Delete a package version.",
|
|
1317
|
+
"description": "Specify the ID or alias of the package version you want to delete.",
|
|
1318
|
+
"strict": true,
|
|
1319
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
1320
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
1321
|
+
"pluginType": "core",
|
|
1322
|
+
"aliases": [
|
|
1323
|
+
"force:package:beta:version:delete",
|
|
1324
|
+
"force:package:version:delete"
|
|
1325
|
+
],
|
|
1326
|
+
"examples": [
|
|
1327
|
+
"Delete a package version with the specified alias using your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --package \"Your Package Alias\"",
|
|
1328
|
+
"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"
|
|
1329
|
+
],
|
|
1330
|
+
"deprecateAliases": true,
|
|
1331
|
+
"flags": {
|
|
1332
|
+
"json": {
|
|
1333
|
+
"name": "json",
|
|
1334
|
+
"type": "boolean",
|
|
1335
|
+
"description": "Format output as json.",
|
|
1336
|
+
"helpGroup": "GLOBAL",
|
|
1337
|
+
"allowNo": false,
|
|
1338
|
+
"deprecateAliases": true
|
|
1339
|
+
},
|
|
1340
|
+
"loglevel": {
|
|
1341
|
+
"name": "loglevel",
|
|
1342
|
+
"type": "option",
|
|
1343
|
+
"hidden": true,
|
|
1344
|
+
"multiple": false,
|
|
1345
|
+
"deprecated": {
|
|
1346
|
+
"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."
|
|
1347
|
+
},
|
|
1348
|
+
"deprecateAliases": true
|
|
1349
|
+
},
|
|
1350
|
+
"target-hub-org": {
|
|
1351
|
+
"name": "target-hub-org",
|
|
1352
|
+
"type": "option",
|
|
1353
|
+
"char": "v",
|
|
1354
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
1355
|
+
"required": true,
|
|
1356
|
+
"multiple": false,
|
|
1357
|
+
"deprecateAliases": true,
|
|
1358
|
+
"aliases": [
|
|
1359
|
+
"targetdevhubusername"
|
|
1360
|
+
]
|
|
1361
|
+
},
|
|
1362
|
+
"api-version": {
|
|
1363
|
+
"name": "api-version",
|
|
1364
|
+
"type": "option",
|
|
1365
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1366
|
+
"multiple": false,
|
|
1367
|
+
"deprecateAliases": true,
|
|
1368
|
+
"aliases": [
|
|
1369
|
+
"apiversion"
|
|
1370
|
+
]
|
|
1371
|
+
},
|
|
1372
|
+
"no-prompt": {
|
|
1373
|
+
"name": "no-prompt",
|
|
1374
|
+
"type": "boolean",
|
|
1375
|
+
"char": "n",
|
|
1376
|
+
"summary": "Don’t prompt before deleting the package version.",
|
|
1377
|
+
"allowNo": false,
|
|
1378
|
+
"deprecateAliases": true,
|
|
1379
|
+
"aliases": [
|
|
1380
|
+
"noprompt"
|
|
1381
|
+
]
|
|
1382
|
+
},
|
|
1383
|
+
"package": {
|
|
1384
|
+
"name": "package",
|
|
1385
|
+
"type": "option",
|
|
1386
|
+
"char": "p",
|
|
1387
|
+
"summary": "ID (starts with 04t) or alias of the package version to delete.",
|
|
1388
|
+
"required": true,
|
|
1389
|
+
"multiple": false,
|
|
1390
|
+
"deprecateAliases": true
|
|
1391
|
+
},
|
|
1392
|
+
"undelete": {
|
|
1393
|
+
"name": "undelete",
|
|
1394
|
+
"type": "boolean",
|
|
1395
|
+
"summary": "Undelete a deleted package version.",
|
|
1396
|
+
"hidden": true,
|
|
1397
|
+
"allowNo": false,
|
|
1398
|
+
"deprecateAliases": true
|
|
1399
|
+
}
|
|
1400
|
+
},
|
|
1401
|
+
"args": {},
|
|
1402
|
+
"requiresProject": true,
|
|
1403
|
+
"hasDynamicHelp": true
|
|
1404
|
+
},
|
|
1405
|
+
"package:version:displayancestry": {
|
|
1406
|
+
"id": "package:version:displayancestry",
|
|
1407
|
+
"summary": "Display the ancestry tree for a 2GP managed package version.",
|
|
1408
|
+
"strict": true,
|
|
1409
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
1410
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
1411
|
+
"pluginType": "core",
|
|
1412
|
+
"aliases": [
|
|
1413
|
+
"force:package:beta:version:displayancestry",
|
|
1414
|
+
"force:package:version:displayancestry"
|
|
1415
|
+
],
|
|
1416
|
+
"examples": [
|
|
1417
|
+
"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",
|
|
1418
|
+
"Similar to previous example, but display the output in DOT code:\n<%= config.bin %> <%= command.id %> --package package_version_alias --dot-code",
|
|
1419
|
+
"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-hub-org devhub@example.com",
|
|
1420
|
+
"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..."
|
|
1421
|
+
],
|
|
1422
|
+
"deprecateAliases": true,
|
|
1423
|
+
"flags": {
|
|
1424
|
+
"json": {
|
|
1425
|
+
"name": "json",
|
|
1426
|
+
"type": "boolean",
|
|
1427
|
+
"description": "Format output as json.",
|
|
1428
|
+
"helpGroup": "GLOBAL",
|
|
1429
|
+
"allowNo": false,
|
|
1430
|
+
"deprecateAliases": true
|
|
1431
|
+
},
|
|
1432
|
+
"loglevel": {
|
|
1433
|
+
"name": "loglevel",
|
|
1434
|
+
"type": "option",
|
|
1435
|
+
"hidden": true,
|
|
1436
|
+
"multiple": false,
|
|
1437
|
+
"deprecated": {
|
|
1438
|
+
"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."
|
|
1439
|
+
},
|
|
1440
|
+
"deprecateAliases": true
|
|
1441
|
+
},
|
|
1442
|
+
"target-hub-org": {
|
|
1443
|
+
"name": "target-hub-org",
|
|
1444
|
+
"type": "option",
|
|
1445
|
+
"char": "v",
|
|
1446
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
1447
|
+
"required": true,
|
|
1448
|
+
"multiple": false,
|
|
1449
|
+
"deprecateAliases": true,
|
|
1450
|
+
"aliases": [
|
|
1451
|
+
"targetdevhubusername"
|
|
1452
|
+
]
|
|
1453
|
+
},
|
|
1454
|
+
"api-version": {
|
|
1455
|
+
"name": "api-version",
|
|
1456
|
+
"type": "option",
|
|
1457
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1458
|
+
"multiple": false,
|
|
1459
|
+
"deprecateAliases": true,
|
|
1460
|
+
"aliases": [
|
|
1461
|
+
"apiversion"
|
|
1462
|
+
]
|
|
1463
|
+
},
|
|
1464
|
+
"package": {
|
|
1465
|
+
"name": "package",
|
|
1466
|
+
"type": "option",
|
|
1467
|
+
"char": "p",
|
|
1468
|
+
"summary": "ID or alias of the package (starts with 0Ho) or package version (starts with 04t) to display ancestry for.",
|
|
1469
|
+
"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.",
|
|
1470
|
+
"required": true,
|
|
1471
|
+
"multiple": false,
|
|
1472
|
+
"deprecateAliases": true
|
|
1473
|
+
},
|
|
1474
|
+
"dot-code": {
|
|
1475
|
+
"name": "dot-code",
|
|
1476
|
+
"type": "boolean",
|
|
1477
|
+
"summary": "Display the ancestry tree in DOT code.",
|
|
1478
|
+
"description": "You can use the DOT code output in graph visualization software to create tree visualizations.",
|
|
1479
|
+
"allowNo": false,
|
|
1480
|
+
"deprecateAliases": true,
|
|
1481
|
+
"aliases": [
|
|
1482
|
+
"dotcode"
|
|
1483
|
+
]
|
|
1484
|
+
},
|
|
1485
|
+
"verbose": {
|
|
1486
|
+
"name": "verbose",
|
|
1487
|
+
"type": "boolean",
|
|
1488
|
+
"summary": "Display both the package version ID (starts with 04t) and the version number (major.minor.patch.build) in the ancestry tree.",
|
|
1489
|
+
"allowNo": false,
|
|
1490
|
+
"deprecateAliases": true
|
|
1491
|
+
}
|
|
1492
|
+
},
|
|
1493
|
+
"args": {},
|
|
1494
|
+
"requiresProject": true,
|
|
1495
|
+
"hasDynamicHelp": true
|
|
1496
|
+
},
|
|
1497
|
+
"package:version:list": {
|
|
1498
|
+
"id": "package:version:list",
|
|
1499
|
+
"summary": "List all package versions in the Dev Hub org.",
|
|
1500
|
+
"description": "Description",
|
|
1501
|
+
"strict": true,
|
|
1502
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
1503
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
1504
|
+
"pluginType": "core",
|
|
1505
|
+
"aliases": [
|
|
1506
|
+
"force:package:beta:version:list",
|
|
1507
|
+
"force:package:version:list"
|
|
1508
|
+
],
|
|
1509
|
+
"examples": [
|
|
1510
|
+
"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",
|
|
1511
|
+
"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-hub-org devhub@example.com",
|
|
1512
|
+
"List all released package versions in your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --released",
|
|
1513
|
+
"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",
|
|
1514
|
+
"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",
|
|
1515
|
+
"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"
|
|
1516
|
+
],
|
|
1517
|
+
"deprecateAliases": true,
|
|
1518
|
+
"flags": {
|
|
1519
|
+
"json": {
|
|
1520
|
+
"name": "json",
|
|
1521
|
+
"type": "boolean",
|
|
1522
|
+
"description": "Format output as json.",
|
|
1523
|
+
"helpGroup": "GLOBAL",
|
|
1524
|
+
"allowNo": false,
|
|
1525
|
+
"deprecateAliases": true
|
|
1526
|
+
},
|
|
1527
|
+
"loglevel": {
|
|
1528
|
+
"name": "loglevel",
|
|
1529
|
+
"type": "option",
|
|
1530
|
+
"hidden": true,
|
|
1531
|
+
"multiple": false,
|
|
1532
|
+
"deprecated": {
|
|
1533
|
+
"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."
|
|
1534
|
+
},
|
|
1535
|
+
"deprecateAliases": true
|
|
1536
|
+
},
|
|
1537
|
+
"target-hub-org": {
|
|
1538
|
+
"name": "target-hub-org",
|
|
1539
|
+
"type": "option",
|
|
1540
|
+
"char": "v",
|
|
1541
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
1542
|
+
"required": true,
|
|
1543
|
+
"multiple": false,
|
|
1544
|
+
"deprecateAliases": true,
|
|
1545
|
+
"aliases": [
|
|
1546
|
+
"targetdevhubusername"
|
|
1547
|
+
]
|
|
1548
|
+
},
|
|
1549
|
+
"api-version": {
|
|
1550
|
+
"name": "api-version",
|
|
1551
|
+
"type": "option",
|
|
1552
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1553
|
+
"multiple": false,
|
|
1554
|
+
"deprecateAliases": true,
|
|
1555
|
+
"aliases": [
|
|
1556
|
+
"apiversion"
|
|
1557
|
+
]
|
|
1558
|
+
},
|
|
1559
|
+
"created-last-days": {
|
|
1560
|
+
"name": "created-last-days",
|
|
1561
|
+
"type": "option",
|
|
1562
|
+
"char": "c",
|
|
1563
|
+
"summary": "Number of days since the request was created, starting at 00:00:00 of first day to now. Use 0 for today.",
|
|
1564
|
+
"multiple": false,
|
|
1565
|
+
"deprecateAliases": true,
|
|
1566
|
+
"aliases": [
|
|
1567
|
+
"createdlastdays"
|
|
1568
|
+
]
|
|
1569
|
+
},
|
|
1570
|
+
"concise": {
|
|
1571
|
+
"name": "concise",
|
|
1572
|
+
"type": "boolean",
|
|
1573
|
+
"summary": "Display limited package version details.",
|
|
1574
|
+
"allowNo": false,
|
|
1575
|
+
"deprecateAliases": true
|
|
1576
|
+
},
|
|
1577
|
+
"modified-last-days": {
|
|
1578
|
+
"name": "modified-last-days",
|
|
1579
|
+
"type": "option",
|
|
1580
|
+
"char": "m",
|
|
1581
|
+
"summary": "Number of days since the items were modified, starting at 00:00:00 of first day to now. Use 0 for today.",
|
|
1582
|
+
"multiple": false,
|
|
1583
|
+
"deprecateAliases": true,
|
|
1584
|
+
"aliases": [
|
|
1585
|
+
"modifiedlastdays"
|
|
1586
|
+
]
|
|
1587
|
+
},
|
|
1588
|
+
"packages": {
|
|
1589
|
+
"name": "packages",
|
|
1590
|
+
"type": "option",
|
|
1591
|
+
"char": "p",
|
|
1592
|
+
"summary": "Comma-delimited list of packages (aliases or 0Ho IDs) to list.",
|
|
1593
|
+
"multiple": false,
|
|
1594
|
+
"deprecateAliases": true
|
|
1595
|
+
},
|
|
1596
|
+
"released": {
|
|
1597
|
+
"name": "released",
|
|
1598
|
+
"type": "boolean",
|
|
1599
|
+
"char": "r",
|
|
1600
|
+
"summary": "Display released versions only (IsReleased=true).",
|
|
1601
|
+
"allowNo": false,
|
|
1602
|
+
"deprecateAliases": true
|
|
1603
|
+
},
|
|
1604
|
+
"order-by": {
|
|
1605
|
+
"name": "order-by",
|
|
1606
|
+
"type": "option",
|
|
1607
|
+
"char": "o",
|
|
1608
|
+
"summary": "Package version fields used to order the list.",
|
|
1609
|
+
"multiple": false,
|
|
1610
|
+
"deprecateAliases": true,
|
|
1611
|
+
"aliases": [
|
|
1612
|
+
"orderby"
|
|
1613
|
+
]
|
|
1614
|
+
},
|
|
1615
|
+
"verbose": {
|
|
1616
|
+
"name": "verbose",
|
|
1617
|
+
"type": "boolean",
|
|
1618
|
+
"summary": "Display extended package version details.",
|
|
1619
|
+
"allowNo": false,
|
|
1620
|
+
"deprecateAliases": true
|
|
1621
|
+
}
|
|
1622
|
+
},
|
|
1623
|
+
"args": {},
|
|
1624
|
+
"hasDynamicHelp": true
|
|
1625
|
+
},
|
|
1626
|
+
"package:version:promote": {
|
|
1627
|
+
"id": "package:version:promote",
|
|
1628
|
+
"summary": "Promote a package version to released.",
|
|
1629
|
+
"description": "Supply the ID or alias of the package version you want to promote. Promotes the package version to released status.",
|
|
1630
|
+
"strict": true,
|
|
1631
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
1632
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
1633
|
+
"pluginType": "core",
|
|
1634
|
+
"aliases": [
|
|
1635
|
+
"force:package:beta:version:promote",
|
|
1636
|
+
"force:package:version:promote"
|
|
1637
|
+
],
|
|
1638
|
+
"examples": [
|
|
1639
|
+
"Promote the package version with the specified ID to released; uses your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --package 04t...",
|
|
1640
|
+
"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-hub-org devhub@example.com",
|
|
1641
|
+
"Promote the package version with an alias that has spaces to released:\n<%= config.bin %> <%= command.id %> --package \"Awesome Package Alias\""
|
|
1642
|
+
],
|
|
1643
|
+
"deprecateAliases": true,
|
|
1644
|
+
"flags": {
|
|
1645
|
+
"json": {
|
|
1646
|
+
"name": "json",
|
|
1647
|
+
"type": "boolean",
|
|
1648
|
+
"description": "Format output as json.",
|
|
1649
|
+
"helpGroup": "GLOBAL",
|
|
1650
|
+
"allowNo": false,
|
|
1651
|
+
"deprecateAliases": true
|
|
1652
|
+
},
|
|
1653
|
+
"loglevel": {
|
|
1654
|
+
"name": "loglevel",
|
|
1655
|
+
"type": "option",
|
|
1656
|
+
"hidden": true,
|
|
1657
|
+
"multiple": false,
|
|
1658
|
+
"deprecated": {
|
|
1659
|
+
"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."
|
|
1660
|
+
},
|
|
1661
|
+
"deprecateAliases": true
|
|
1662
|
+
},
|
|
1663
|
+
"target-hub-org": {
|
|
1664
|
+
"name": "target-hub-org",
|
|
1665
|
+
"type": "option",
|
|
1666
|
+
"char": "v",
|
|
1667
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
1668
|
+
"required": true,
|
|
1669
|
+
"multiple": false,
|
|
1670
|
+
"deprecateAliases": true,
|
|
1671
|
+
"aliases": [
|
|
1672
|
+
"targetdevhubusername"
|
|
1673
|
+
]
|
|
1674
|
+
},
|
|
1675
|
+
"api-version": {
|
|
1676
|
+
"name": "api-version",
|
|
1677
|
+
"type": "option",
|
|
1678
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1679
|
+
"multiple": false,
|
|
1680
|
+
"deprecateAliases": true,
|
|
1681
|
+
"aliases": [
|
|
1682
|
+
"apiversion"
|
|
1683
|
+
]
|
|
1684
|
+
},
|
|
1685
|
+
"package": {
|
|
1686
|
+
"name": "package",
|
|
1687
|
+
"type": "option",
|
|
1688
|
+
"char": "p",
|
|
1689
|
+
"summary": "ID (starts with 04t) or alias of the package version to promote.",
|
|
1690
|
+
"required": true,
|
|
1691
|
+
"multiple": false,
|
|
1692
|
+
"deprecateAliases": true
|
|
1693
|
+
},
|
|
1694
|
+
"no-prompt": {
|
|
1695
|
+
"name": "no-prompt",
|
|
1696
|
+
"type": "boolean",
|
|
1697
|
+
"char": "n",
|
|
1698
|
+
"summary": "Don't prompt to confirm setting the package version as released.",
|
|
1699
|
+
"allowNo": false,
|
|
1700
|
+
"deprecateAliases": true,
|
|
1701
|
+
"aliases": [
|
|
1702
|
+
"noprompt"
|
|
1703
|
+
]
|
|
1704
|
+
}
|
|
1705
|
+
},
|
|
1706
|
+
"args": {},
|
|
1707
|
+
"requiresProject": true,
|
|
1708
|
+
"hasDynamicHelp": true
|
|
1709
|
+
},
|
|
1710
|
+
"package:version:report": {
|
|
1711
|
+
"id": "package:version:report",
|
|
1712
|
+
"summary": "Retrieve details about a package version in the Dev Hub org.",
|
|
1713
|
+
"description": "To update package version values, run \"<%= config.bin %> package version update\".",
|
|
1714
|
+
"strict": true,
|
|
1715
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
1716
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
1717
|
+
"pluginType": "core",
|
|
1718
|
+
"aliases": [
|
|
1719
|
+
"force:package:beta:version:report",
|
|
1720
|
+
"force:package:version:report"
|
|
1721
|
+
],
|
|
1722
|
+
"examples": [
|
|
1723
|
+
"Retrieve details about the package version with the specified ID from your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --package 04t...",
|
|
1724
|
+
"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-hub-org devhub@example.com"
|
|
1725
|
+
],
|
|
1726
|
+
"deprecateAliases": true,
|
|
1727
|
+
"flags": {
|
|
1728
|
+
"json": {
|
|
1729
|
+
"name": "json",
|
|
1730
|
+
"type": "boolean",
|
|
1731
|
+
"description": "Format output as json.",
|
|
1732
|
+
"helpGroup": "GLOBAL",
|
|
1733
|
+
"allowNo": false,
|
|
1734
|
+
"deprecateAliases": true
|
|
1735
|
+
},
|
|
1736
|
+
"loglevel": {
|
|
1737
|
+
"name": "loglevel",
|
|
1738
|
+
"type": "option",
|
|
1739
|
+
"hidden": true,
|
|
1740
|
+
"multiple": false,
|
|
1741
|
+
"deprecated": {
|
|
1742
|
+
"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."
|
|
1743
|
+
},
|
|
1744
|
+
"deprecateAliases": true
|
|
1745
|
+
},
|
|
1746
|
+
"target-hub-org": {
|
|
1747
|
+
"name": "target-hub-org",
|
|
1748
|
+
"type": "option",
|
|
1749
|
+
"char": "v",
|
|
1750
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
1751
|
+
"required": true,
|
|
1752
|
+
"multiple": false,
|
|
1753
|
+
"deprecateAliases": true,
|
|
1754
|
+
"aliases": [
|
|
1755
|
+
"targetdevhubusername"
|
|
1756
|
+
]
|
|
1757
|
+
},
|
|
1758
|
+
"api-version": {
|
|
1759
|
+
"name": "api-version",
|
|
1760
|
+
"type": "option",
|
|
1761
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1762
|
+
"multiple": false,
|
|
1763
|
+
"deprecateAliases": true,
|
|
1764
|
+
"aliases": [
|
|
1765
|
+
"apiversion"
|
|
1766
|
+
]
|
|
1767
|
+
},
|
|
1768
|
+
"package": {
|
|
1769
|
+
"name": "package",
|
|
1770
|
+
"type": "option",
|
|
1771
|
+
"char": "p",
|
|
1772
|
+
"summary": "ID (starts with 04t) or alias of the package to retrieve details for.",
|
|
1773
|
+
"required": true,
|
|
1774
|
+
"multiple": false,
|
|
1775
|
+
"deprecateAliases": true
|
|
1776
|
+
},
|
|
1777
|
+
"verbose": {
|
|
1778
|
+
"name": "verbose",
|
|
1779
|
+
"type": "boolean",
|
|
1780
|
+
"summary": "Display extended package version details.",
|
|
1781
|
+
"allowNo": false,
|
|
1782
|
+
"deprecateAliases": true
|
|
1783
|
+
}
|
|
1784
|
+
},
|
|
1785
|
+
"args": {},
|
|
1786
|
+
"requiresProject": true,
|
|
1787
|
+
"hasDynamicHelp": true
|
|
1788
|
+
},
|
|
1789
|
+
"package:version:update": {
|
|
1790
|
+
"id": "package:version:update",
|
|
1791
|
+
"summary": "Update a package version.",
|
|
1792
|
+
"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\".",
|
|
1793
|
+
"strict": true,
|
|
1794
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
1795
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
1796
|
+
"pluginType": "core",
|
|
1797
|
+
"aliases": [
|
|
1798
|
+
"force:package:beta:version:update",
|
|
1799
|
+
"force:package:version:update"
|
|
1800
|
+
],
|
|
1801
|
+
"examples": [
|
|
1802
|
+
"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",
|
|
1803
|
+
"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-hub-org devhub@example.com",
|
|
1804
|
+
"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\""
|
|
1805
|
+
],
|
|
1806
|
+
"deprecateAliases": true,
|
|
1807
|
+
"flags": {
|
|
1808
|
+
"json": {
|
|
1809
|
+
"name": "json",
|
|
1810
|
+
"type": "boolean",
|
|
1811
|
+
"description": "Format output as json.",
|
|
1812
|
+
"helpGroup": "GLOBAL",
|
|
1813
|
+
"allowNo": false,
|
|
1814
|
+
"deprecateAliases": true
|
|
1815
|
+
},
|
|
1816
|
+
"loglevel": {
|
|
1817
|
+
"name": "loglevel",
|
|
1818
|
+
"type": "option",
|
|
1819
|
+
"hidden": true,
|
|
1820
|
+
"multiple": false,
|
|
1821
|
+
"deprecated": {
|
|
1822
|
+
"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."
|
|
1823
|
+
},
|
|
1824
|
+
"deprecateAliases": true
|
|
1825
|
+
},
|
|
1826
|
+
"target-hub-org": {
|
|
1827
|
+
"name": "target-hub-org",
|
|
1828
|
+
"type": "option",
|
|
1829
|
+
"char": "v",
|
|
1830
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
1831
|
+
"required": true,
|
|
1832
|
+
"multiple": false,
|
|
1833
|
+
"deprecateAliases": true,
|
|
1834
|
+
"aliases": [
|
|
1835
|
+
"targetdevhubusername"
|
|
1836
|
+
]
|
|
1837
|
+
},
|
|
1838
|
+
"api-version": {
|
|
1839
|
+
"name": "api-version",
|
|
1840
|
+
"type": "option",
|
|
1841
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1842
|
+
"multiple": false,
|
|
1843
|
+
"deprecateAliases": true,
|
|
1844
|
+
"aliases": [
|
|
1845
|
+
"apiversion"
|
|
1846
|
+
]
|
|
1847
|
+
},
|
|
1848
|
+
"package": {
|
|
1849
|
+
"name": "package",
|
|
1850
|
+
"type": "option",
|
|
1851
|
+
"char": "p",
|
|
1852
|
+
"summary": "ID (starts with 04t) or alias of the package to update a version of.",
|
|
1853
|
+
"required": true,
|
|
1854
|
+
"multiple": false,
|
|
1855
|
+
"deprecateAliases": true
|
|
1856
|
+
},
|
|
1857
|
+
"version-name": {
|
|
1858
|
+
"name": "version-name",
|
|
1859
|
+
"type": "option",
|
|
1860
|
+
"char": "a",
|
|
1861
|
+
"summary": "New package version name.",
|
|
1862
|
+
"multiple": false,
|
|
1863
|
+
"deprecateAliases": true,
|
|
1864
|
+
"aliases": [
|
|
1865
|
+
"versionname"
|
|
1866
|
+
]
|
|
1867
|
+
},
|
|
1868
|
+
"version-description": {
|
|
1869
|
+
"name": "version-description",
|
|
1870
|
+
"type": "option",
|
|
1871
|
+
"char": "e",
|
|
1872
|
+
"summary": "New package version description.",
|
|
1873
|
+
"multiple": false,
|
|
1874
|
+
"deprecateAliases": true,
|
|
1875
|
+
"aliases": [
|
|
1876
|
+
"versiondescription"
|
|
1877
|
+
]
|
|
1878
|
+
},
|
|
1879
|
+
"branch": {
|
|
1880
|
+
"name": "branch",
|
|
1881
|
+
"type": "option",
|
|
1882
|
+
"char": "b",
|
|
1883
|
+
"summary": "New package version branch.",
|
|
1884
|
+
"multiple": false,
|
|
1885
|
+
"deprecateAliases": true
|
|
1886
|
+
},
|
|
1887
|
+
"tag": {
|
|
1888
|
+
"name": "tag",
|
|
1889
|
+
"type": "option",
|
|
1890
|
+
"char": "t",
|
|
1891
|
+
"summary": "New package version tag.",
|
|
1892
|
+
"multiple": false,
|
|
1893
|
+
"deprecateAliases": true
|
|
1894
|
+
},
|
|
1895
|
+
"installation-key": {
|
|
1896
|
+
"name": "installation-key",
|
|
1897
|
+
"type": "option",
|
|
1898
|
+
"char": "k",
|
|
1899
|
+
"summary": "New installation key for key-protected package (default: null)",
|
|
1900
|
+
"multiple": false,
|
|
1901
|
+
"deprecateAliases": true,
|
|
1902
|
+
"aliases": [
|
|
1903
|
+
"installationkey"
|
|
1904
|
+
]
|
|
1905
|
+
}
|
|
1906
|
+
},
|
|
1907
|
+
"args": {},
|
|
1908
|
+
"requiresProject": true,
|
|
1909
|
+
"hasDynamicHelp": true
|
|
1910
|
+
},
|
|
1911
|
+
"package1:version:create": {
|
|
1912
|
+
"id": "package1:version:create",
|
|
1913
|
+
"summary": "Create a first-generation package version in the release org.",
|
|
1914
|
+
"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.",
|
|
1915
|
+
"strict": true,
|
|
1916
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
1917
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
1918
|
+
"pluginType": "core",
|
|
1919
|
+
"aliases": [
|
|
1920
|
+
"force:package1:beta:version:create",
|
|
1921
|
+
"force:package1:version:create"
|
|
1922
|
+
],
|
|
1923
|
+
"examples": [
|
|
1924
|
+
"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",
|
|
1925
|
+
"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"
|
|
1926
|
+
],
|
|
1927
|
+
"deprecateAliases": true,
|
|
1928
|
+
"flags": {
|
|
1929
|
+
"json": {
|
|
1930
|
+
"name": "json",
|
|
1931
|
+
"type": "boolean",
|
|
1932
|
+
"description": "Format output as json.",
|
|
1933
|
+
"helpGroup": "GLOBAL",
|
|
1934
|
+
"allowNo": false,
|
|
1935
|
+
"deprecateAliases": true
|
|
1936
|
+
},
|
|
1937
|
+
"loglevel": {
|
|
1938
|
+
"name": "loglevel",
|
|
1939
|
+
"type": "option",
|
|
1940
|
+
"hidden": true,
|
|
1941
|
+
"multiple": false,
|
|
1942
|
+
"deprecated": {
|
|
1943
|
+
"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."
|
|
1944
|
+
},
|
|
1945
|
+
"deprecateAliases": true
|
|
1946
|
+
},
|
|
1947
|
+
"target-org": {
|
|
1948
|
+
"name": "target-org",
|
|
1949
|
+
"type": "option",
|
|
1950
|
+
"char": "o",
|
|
1951
|
+
"summary": "Username or alias of the target org.",
|
|
1952
|
+
"required": true,
|
|
1953
|
+
"multiple": false,
|
|
1954
|
+
"deprecateAliases": true,
|
|
1955
|
+
"aliases": [
|
|
1956
|
+
"targetusername",
|
|
1957
|
+
"u"
|
|
1958
|
+
]
|
|
1959
|
+
},
|
|
1960
|
+
"api-version": {
|
|
1961
|
+
"name": "api-version",
|
|
1962
|
+
"type": "option",
|
|
1963
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1964
|
+
"multiple": false,
|
|
1965
|
+
"deprecateAliases": true,
|
|
1966
|
+
"aliases": [
|
|
1967
|
+
"apiversion"
|
|
1968
|
+
]
|
|
1969
|
+
},
|
|
1970
|
+
"package-id": {
|
|
1971
|
+
"name": "package-id",
|
|
1972
|
+
"type": "option",
|
|
1973
|
+
"char": "i",
|
|
1974
|
+
"summary": "ID of the metadata package (starts with 033) of which you’re creating a new version.",
|
|
1975
|
+
"required": true,
|
|
1976
|
+
"multiple": false,
|
|
1977
|
+
"deprecateAliases": true,
|
|
1978
|
+
"aliases": [
|
|
1979
|
+
"packageid"
|
|
1980
|
+
]
|
|
1981
|
+
},
|
|
1982
|
+
"name": {
|
|
1983
|
+
"name": "name",
|
|
1984
|
+
"type": "option",
|
|
1985
|
+
"char": "n",
|
|
1986
|
+
"summary": "Package version name.",
|
|
1987
|
+
"required": true,
|
|
1988
|
+
"multiple": false,
|
|
1989
|
+
"deprecateAliases": true
|
|
1990
|
+
},
|
|
1991
|
+
"description": {
|
|
1992
|
+
"name": "description",
|
|
1993
|
+
"type": "option",
|
|
1994
|
+
"char": "d",
|
|
1995
|
+
"summary": "Package version description.",
|
|
1996
|
+
"multiple": false,
|
|
1997
|
+
"deprecateAliases": true
|
|
1998
|
+
},
|
|
1999
|
+
"version": {
|
|
2000
|
+
"name": "version",
|
|
2001
|
+
"type": "option",
|
|
2002
|
+
"char": "v",
|
|
2003
|
+
"summary": "Package version in major.minor format, for example, 3.2.",
|
|
2004
|
+
"multiple": false,
|
|
2005
|
+
"deprecateAliases": true
|
|
2006
|
+
},
|
|
2007
|
+
"managed-released": {
|
|
2008
|
+
"name": "managed-released",
|
|
2009
|
+
"type": "boolean",
|
|
2010
|
+
"char": "m",
|
|
2011
|
+
"summary": "Create a managed package version.",
|
|
2012
|
+
"description": "To create a beta version, don’t include this parameter.",
|
|
2013
|
+
"allowNo": false,
|
|
2014
|
+
"deprecateAliases": true,
|
|
2015
|
+
"aliases": [
|
|
2016
|
+
"managedrelease"
|
|
2017
|
+
]
|
|
2018
|
+
},
|
|
2019
|
+
"release-notes-url": {
|
|
2020
|
+
"name": "release-notes-url",
|
|
2021
|
+
"type": "option",
|
|
2022
|
+
"char": "r",
|
|
2023
|
+
"summary": "Release notes URL.",
|
|
2024
|
+
"description": "This link is displayed in the package installation UI to provide release notes for this package version to subscribers.",
|
|
2025
|
+
"multiple": false,
|
|
2026
|
+
"deprecateAliases": true,
|
|
2027
|
+
"aliases": [
|
|
2028
|
+
"releasenotesurl"
|
|
2029
|
+
]
|
|
2030
|
+
},
|
|
2031
|
+
"post-install-url": {
|
|
2032
|
+
"name": "post-install-url",
|
|
2033
|
+
"type": "option",
|
|
2034
|
+
"char": "p",
|
|
2035
|
+
"summary": "Post install URL.",
|
|
2036
|
+
"description": "The contents of the post-installation instructions URL are displayed in the UI after installation of the package version.",
|
|
2037
|
+
"multiple": false,
|
|
2038
|
+
"deprecateAliases": true,
|
|
2039
|
+
"aliases": [
|
|
2040
|
+
"postinstallurl"
|
|
2041
|
+
]
|
|
2042
|
+
},
|
|
2043
|
+
"installation-key": {
|
|
2044
|
+
"name": "installation-key",
|
|
2045
|
+
"type": "option",
|
|
2046
|
+
"char": "k",
|
|
2047
|
+
"summary": "Installation key for key-protected package (default: null).",
|
|
2048
|
+
"multiple": false,
|
|
2049
|
+
"deprecateAliases": true,
|
|
2050
|
+
"aliases": [
|
|
2051
|
+
"installationkey"
|
|
2052
|
+
]
|
|
2053
|
+
},
|
|
2054
|
+
"wait": {
|
|
2055
|
+
"name": "wait",
|
|
2056
|
+
"type": "option",
|
|
2057
|
+
"char": "w",
|
|
2058
|
+
"summary": "Minutes to wait for the package version to be created (default: 2 minutes).",
|
|
2059
|
+
"multiple": false,
|
|
2060
|
+
"deprecateAliases": true
|
|
2061
|
+
}
|
|
2062
|
+
},
|
|
2063
|
+
"args": {},
|
|
2064
|
+
"requiresProject": true,
|
|
2065
|
+
"hasDynamicHelp": true
|
|
2066
|
+
},
|
|
2067
|
+
"package1:version:display": {
|
|
2068
|
+
"id": "package1:version:display",
|
|
2069
|
+
"summary": "Display details about a first-generation package version.",
|
|
2070
|
+
"strict": true,
|
|
2071
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
2072
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
2073
|
+
"pluginType": "core",
|
|
2074
|
+
"aliases": [
|
|
2075
|
+
"force:package1:beta:version:display",
|
|
2076
|
+
"force:package1:version:display"
|
|
2077
|
+
],
|
|
2078
|
+
"examples": [
|
|
2079
|
+
"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...",
|
|
2080
|
+
"Same as previous example, but use the specified org:\n<%= config.bin %> <%= command.id %> --package-version-id 04t... --target-org myorg@example.com"
|
|
2081
|
+
],
|
|
2082
|
+
"deprecateAliases": true,
|
|
2083
|
+
"flags": {
|
|
2084
|
+
"json": {
|
|
2085
|
+
"name": "json",
|
|
2086
|
+
"type": "boolean",
|
|
2087
|
+
"description": "Format output as json.",
|
|
2088
|
+
"helpGroup": "GLOBAL",
|
|
2089
|
+
"allowNo": false,
|
|
2090
|
+
"deprecateAliases": true
|
|
2091
|
+
},
|
|
2092
|
+
"loglevel": {
|
|
2093
|
+
"name": "loglevel",
|
|
2094
|
+
"type": "option",
|
|
2095
|
+
"hidden": true,
|
|
2096
|
+
"multiple": false,
|
|
2097
|
+
"deprecated": {
|
|
2098
|
+
"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."
|
|
2099
|
+
},
|
|
2100
|
+
"deprecateAliases": true
|
|
2101
|
+
},
|
|
2102
|
+
"target-org": {
|
|
2103
|
+
"name": "target-org",
|
|
2104
|
+
"type": "option",
|
|
2105
|
+
"char": "o",
|
|
2106
|
+
"summary": "Username or alias of the target org.",
|
|
2107
|
+
"required": true,
|
|
2108
|
+
"multiple": false,
|
|
2109
|
+
"deprecateAliases": true,
|
|
2110
|
+
"aliases": [
|
|
2111
|
+
"targetusername",
|
|
2112
|
+
"u"
|
|
2113
|
+
]
|
|
2114
|
+
},
|
|
2115
|
+
"api-version": {
|
|
2116
|
+
"name": "api-version",
|
|
2117
|
+
"type": "option",
|
|
2118
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2119
|
+
"multiple": false,
|
|
2120
|
+
"deprecateAliases": true,
|
|
2121
|
+
"aliases": [
|
|
2122
|
+
"apiversion"
|
|
2123
|
+
]
|
|
2124
|
+
},
|
|
2125
|
+
"package-version-id": {
|
|
2126
|
+
"name": "package-version-id",
|
|
2127
|
+
"type": "option",
|
|
2128
|
+
"char": "i",
|
|
2129
|
+
"summary": "ID (starts with 04t) of the metadata package version whose details you want to display.",
|
|
2130
|
+
"required": true,
|
|
2131
|
+
"multiple": false,
|
|
2132
|
+
"deprecateAliases": true,
|
|
2133
|
+
"aliases": [
|
|
2134
|
+
"packageversionid"
|
|
2135
|
+
]
|
|
2136
|
+
}
|
|
2137
|
+
},
|
|
2138
|
+
"args": {},
|
|
2139
|
+
"hasDynamicHelp": true
|
|
2140
|
+
},
|
|
2141
|
+
"package1:version:list": {
|
|
2142
|
+
"id": "package1:version:list",
|
|
2143
|
+
"summary": "List package versions for the specified first-generation package or for the org.",
|
|
2144
|
+
"strict": true,
|
|
2145
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
2146
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
2147
|
+
"pluginType": "core",
|
|
2148
|
+
"aliases": [
|
|
2149
|
+
"force:package1:beta:version:list",
|
|
2150
|
+
"force:package1:version:list"
|
|
2151
|
+
],
|
|
2152
|
+
"examples": [
|
|
2153
|
+
"List all first-generation package versions in your default org:\n<%= config.bin %> <%= command.id %>",
|
|
2154
|
+
"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"
|
|
2155
|
+
],
|
|
2156
|
+
"deprecateAliases": true,
|
|
2157
|
+
"flags": {
|
|
2158
|
+
"json": {
|
|
2159
|
+
"name": "json",
|
|
2160
|
+
"type": "boolean",
|
|
2161
|
+
"description": "Format output as json.",
|
|
2162
|
+
"helpGroup": "GLOBAL",
|
|
2163
|
+
"allowNo": false,
|
|
2164
|
+
"deprecateAliases": true
|
|
2165
|
+
},
|
|
2166
|
+
"loglevel": {
|
|
2167
|
+
"name": "loglevel",
|
|
2168
|
+
"type": "option",
|
|
2169
|
+
"hidden": true,
|
|
2170
|
+
"multiple": false,
|
|
2171
|
+
"deprecated": {
|
|
2172
|
+
"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."
|
|
2173
|
+
},
|
|
2174
|
+
"deprecateAliases": true
|
|
2175
|
+
},
|
|
2176
|
+
"target-org": {
|
|
2177
|
+
"name": "target-org",
|
|
2178
|
+
"type": "option",
|
|
2179
|
+
"char": "o",
|
|
2180
|
+
"summary": "Username or alias of the target org.",
|
|
2181
|
+
"required": true,
|
|
2182
|
+
"multiple": false,
|
|
2183
|
+
"deprecateAliases": true,
|
|
2184
|
+
"aliases": [
|
|
2185
|
+
"targetusername",
|
|
2186
|
+
"u"
|
|
2187
|
+
]
|
|
2188
|
+
},
|
|
2189
|
+
"api-version": {
|
|
2190
|
+
"name": "api-version",
|
|
2191
|
+
"type": "option",
|
|
2192
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2193
|
+
"multiple": false,
|
|
2194
|
+
"deprecateAliases": true,
|
|
2195
|
+
"aliases": [
|
|
2196
|
+
"apiversion"
|
|
2197
|
+
]
|
|
2198
|
+
},
|
|
2199
|
+
"package-id": {
|
|
2200
|
+
"name": "package-id",
|
|
2201
|
+
"type": "option",
|
|
2202
|
+
"char": "i",
|
|
2203
|
+
"summary": "Metadata package ID (starts with 033) whose package versions you want to list.",
|
|
2204
|
+
"description": "If not specified, shows all versions for all packages (managed and unmanaged) in the org.",
|
|
2205
|
+
"multiple": false,
|
|
2206
|
+
"deprecateAliases": true,
|
|
2207
|
+
"aliases": [
|
|
2208
|
+
"packageid"
|
|
2209
|
+
]
|
|
2210
|
+
}
|
|
2211
|
+
},
|
|
2212
|
+
"args": {},
|
|
2213
|
+
"hasDynamicHelp": true
|
|
2214
|
+
},
|
|
2215
|
+
"package:version:create:list": {
|
|
2216
|
+
"id": "package:version:create:list",
|
|
2217
|
+
"summary": "List package version creation requests.",
|
|
2218
|
+
"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.",
|
|
2219
|
+
"strict": true,
|
|
2220
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
2221
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
2222
|
+
"pluginType": "core",
|
|
2223
|
+
"aliases": [
|
|
2224
|
+
"force:package:beta:version:create:list",
|
|
2225
|
+
"force:package:version:create:list"
|
|
2226
|
+
],
|
|
2227
|
+
"examples": [
|
|
2228
|
+
"List all package version creation requests in your default Dev Hub org:\n<%= config.bin %> <%= command.id %>",
|
|
2229
|
+
"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-hub-org",
|
|
2230
|
+
"List package version creation requests with status Error:\n<%= config.bin %> <%= command.id %> --status Error",
|
|
2231
|
+
"List package version creation requests with status InProgress:\n<%= config.bin %> <%= command.id %> --status InProgress",
|
|
2232
|
+
"List package version creation requests with status Success that were created today:\n<%= config.bin %> <%= command.id %> --created-last-days 0 --status Success"
|
|
2233
|
+
],
|
|
2234
|
+
"deprecateAliases": true,
|
|
2235
|
+
"flags": {
|
|
2236
|
+
"json": {
|
|
2237
|
+
"name": "json",
|
|
2238
|
+
"type": "boolean",
|
|
2239
|
+
"description": "Format output as json.",
|
|
2240
|
+
"helpGroup": "GLOBAL",
|
|
2241
|
+
"allowNo": false,
|
|
2242
|
+
"deprecateAliases": true
|
|
2243
|
+
},
|
|
2244
|
+
"loglevel": {
|
|
2245
|
+
"name": "loglevel",
|
|
2246
|
+
"type": "option",
|
|
2247
|
+
"hidden": true,
|
|
2248
|
+
"multiple": false,
|
|
2249
|
+
"deprecated": {
|
|
2250
|
+
"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."
|
|
2251
|
+
},
|
|
2252
|
+
"deprecateAliases": true
|
|
2253
|
+
},
|
|
2254
|
+
"target-hub-org": {
|
|
2255
|
+
"name": "target-hub-org",
|
|
2256
|
+
"type": "option",
|
|
2257
|
+
"char": "v",
|
|
2258
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
2259
|
+
"required": true,
|
|
2260
|
+
"multiple": false,
|
|
2261
|
+
"deprecateAliases": true,
|
|
2262
|
+
"aliases": [
|
|
2263
|
+
"targetdevhubusername"
|
|
2264
|
+
]
|
|
2265
|
+
},
|
|
2266
|
+
"api-version": {
|
|
2267
|
+
"name": "api-version",
|
|
2268
|
+
"type": "option",
|
|
2269
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2270
|
+
"multiple": false,
|
|
2271
|
+
"deprecateAliases": true,
|
|
2272
|
+
"aliases": [
|
|
2273
|
+
"apiversion"
|
|
2274
|
+
]
|
|
2275
|
+
},
|
|
2276
|
+
"created-last-days": {
|
|
2277
|
+
"name": "created-last-days",
|
|
2278
|
+
"type": "option",
|
|
2279
|
+
"char": "c",
|
|
2280
|
+
"summary": "Number of days since the request was created, starting at 00:00:00 of first day to now. Use 0 for today.",
|
|
2281
|
+
"multiple": false,
|
|
2282
|
+
"deprecateAliases": true,
|
|
2283
|
+
"aliases": [
|
|
2284
|
+
"createdlastdays"
|
|
2285
|
+
]
|
|
2286
|
+
},
|
|
2287
|
+
"status": {
|
|
2288
|
+
"name": "status",
|
|
2289
|
+
"type": "option",
|
|
2290
|
+
"char": "s",
|
|
2291
|
+
"summary": "Status of the version creation request, used to filter the list.",
|
|
2292
|
+
"helpValue": "(Queued|InProgress|Success|Error)",
|
|
2293
|
+
"multiple": false,
|
|
2294
|
+
"options": [
|
|
2295
|
+
"Queued",
|
|
2296
|
+
"InProgress",
|
|
2297
|
+
"Success",
|
|
2298
|
+
"Error"
|
|
2299
|
+
],
|
|
2300
|
+
"deprecateAliases": true
|
|
2301
|
+
}
|
|
2302
|
+
},
|
|
2303
|
+
"args": {},
|
|
2304
|
+
"hasDynamicHelp": true
|
|
2305
|
+
},
|
|
2306
|
+
"package:version:create:report": {
|
|
2307
|
+
"id": "package:version:create:report",
|
|
2308
|
+
"summary": "Retrieve details about a package version creation request.",
|
|
2309
|
+
"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\".",
|
|
2310
|
+
"strict": true,
|
|
2311
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
2312
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
2313
|
+
"pluginType": "core",
|
|
2314
|
+
"aliases": [
|
|
2315
|
+
"force:package:beta:version:create:report",
|
|
2316
|
+
"force:package:version:create:report"
|
|
2317
|
+
],
|
|
2318
|
+
"examples": [
|
|
2319
|
+
"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...",
|
|
2320
|
+
"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-hub-org devhub@example.com"
|
|
2321
|
+
],
|
|
2322
|
+
"deprecateAliases": true,
|
|
2323
|
+
"flags": {
|
|
2324
|
+
"json": {
|
|
2325
|
+
"name": "json",
|
|
2326
|
+
"type": "boolean",
|
|
2327
|
+
"description": "Format output as json.",
|
|
2328
|
+
"helpGroup": "GLOBAL",
|
|
2329
|
+
"allowNo": false,
|
|
2330
|
+
"deprecateAliases": true
|
|
2331
|
+
},
|
|
2332
|
+
"loglevel": {
|
|
2333
|
+
"name": "loglevel",
|
|
2334
|
+
"type": "option",
|
|
2335
|
+
"hidden": true,
|
|
2336
|
+
"multiple": false,
|
|
2337
|
+
"deprecated": {
|
|
2338
|
+
"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."
|
|
2339
|
+
},
|
|
2340
|
+
"deprecateAliases": true
|
|
2341
|
+
},
|
|
2342
|
+
"target-hub-org": {
|
|
2343
|
+
"name": "target-hub-org",
|
|
2344
|
+
"type": "option",
|
|
2345
|
+
"char": "v",
|
|
2346
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
2347
|
+
"required": true,
|
|
2348
|
+
"multiple": false,
|
|
2349
|
+
"deprecateAliases": true,
|
|
2350
|
+
"aliases": [
|
|
2351
|
+
"targetdevhubusername"
|
|
2352
|
+
]
|
|
2353
|
+
},
|
|
2354
|
+
"api-version": {
|
|
2355
|
+
"name": "api-version",
|
|
2356
|
+
"type": "option",
|
|
2357
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2358
|
+
"multiple": false,
|
|
2359
|
+
"deprecateAliases": true,
|
|
2360
|
+
"aliases": [
|
|
2361
|
+
"apiversion"
|
|
2362
|
+
]
|
|
2363
|
+
},
|
|
2364
|
+
"package-create-request-id": {
|
|
2365
|
+
"name": "package-create-request-id",
|
|
2366
|
+
"type": "option",
|
|
2367
|
+
"char": "i",
|
|
2368
|
+
"summary": "ID (starts with 08c) of the package version creation request you want to display.",
|
|
2369
|
+
"required": true,
|
|
2370
|
+
"multiple": false,
|
|
2371
|
+
"deprecateAliases": true,
|
|
2372
|
+
"aliases": [
|
|
2373
|
+
"packagecreaterequestid"
|
|
2374
|
+
]
|
|
2375
|
+
}
|
|
2376
|
+
},
|
|
2377
|
+
"args": {},
|
|
2378
|
+
"hasDynamicHelp": true
|
|
2379
|
+
},
|
|
2380
|
+
"package1:version:create:get": {
|
|
2381
|
+
"id": "package1:version:create:get",
|
|
2382
|
+
"summary": "Retrieve the status of a package version creation request.",
|
|
2383
|
+
"strict": true,
|
|
2384
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
2385
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
2386
|
+
"pluginType": "core",
|
|
2387
|
+
"aliases": [
|
|
2388
|
+
"force:package1:beta:version:create:get",
|
|
2389
|
+
"force:package1:version:create:get"
|
|
2390
|
+
],
|
|
2391
|
+
"examples": [
|
|
2392
|
+
"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...",
|
|
2393
|
+
"Same as previous example, but use the specified org:\n<%= config.bin %> <%= command.id %> --request-id 0HD... --target-org myorg@example.com"
|
|
2394
|
+
],
|
|
2395
|
+
"deprecateAliases": true,
|
|
2396
|
+
"flags": {
|
|
2397
|
+
"json": {
|
|
2398
|
+
"name": "json",
|
|
2399
|
+
"type": "boolean",
|
|
2400
|
+
"description": "Format output as json.",
|
|
2401
|
+
"helpGroup": "GLOBAL",
|
|
2402
|
+
"allowNo": false,
|
|
2403
|
+
"deprecateAliases": true
|
|
2404
|
+
},
|
|
2405
|
+
"loglevel": {
|
|
2406
|
+
"name": "loglevel",
|
|
2407
|
+
"type": "option",
|
|
2408
|
+
"hidden": true,
|
|
2409
|
+
"multiple": false,
|
|
2410
|
+
"deprecated": {
|
|
2411
|
+
"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."
|
|
2412
|
+
},
|
|
2413
|
+
"deprecateAliases": true
|
|
2414
|
+
},
|
|
2415
|
+
"target-org": {
|
|
2416
|
+
"name": "target-org",
|
|
2417
|
+
"type": "option",
|
|
2418
|
+
"char": "o",
|
|
2419
|
+
"summary": "Username or alias of the target org.",
|
|
2420
|
+
"required": true,
|
|
2421
|
+
"multiple": false,
|
|
2422
|
+
"deprecateAliases": true,
|
|
2423
|
+
"aliases": [
|
|
2424
|
+
"targetusername",
|
|
2425
|
+
"u"
|
|
2426
|
+
]
|
|
2427
|
+
},
|
|
2428
|
+
"api-version": {
|
|
2429
|
+
"name": "api-version",
|
|
2430
|
+
"type": "option",
|
|
2431
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2432
|
+
"multiple": false,
|
|
2433
|
+
"deprecateAliases": true,
|
|
2434
|
+
"aliases": [
|
|
2435
|
+
"apiversion"
|
|
2436
|
+
]
|
|
2437
|
+
},
|
|
2438
|
+
"request-id": {
|
|
2439
|
+
"name": "request-id",
|
|
2440
|
+
"type": "option",
|
|
2441
|
+
"char": "i",
|
|
2442
|
+
"summary": "ID of the PackageUploadRequest (starts with 0HD).",
|
|
2443
|
+
"required": true,
|
|
2444
|
+
"multiple": false,
|
|
2445
|
+
"deprecateAliases": true,
|
|
2446
|
+
"aliases": [
|
|
2447
|
+
"requestid"
|
|
2448
|
+
]
|
|
2449
|
+
}
|
|
2450
|
+
},
|
|
2451
|
+
"args": {},
|
|
2452
|
+
"hasDynamicHelp": true
|
|
2453
|
+
}
|
|
2454
|
+
}
|
|
2455
|
+
}
|