salesforce-alm/oclif.manifest.json

This package contains tools, and APIs, for an improved salesforce.com developer experience.

{"version":"53.7.6","commands":{"force":{"id":"force","usage":"<%= command.id %> [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"salesforce-alm","pluginType":"core","hidden":true,"aliases":[],"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)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"}},"args":[]},"force:community:create":{"id":"force:community:create","description":"creates an Experience Cloud site using a template\n\nSee \"Which Experience Cloud Template Should I Use?\" in Salesforce Help for more information about the different template types available for Experience Cloud.\n\nWhen creating a site with the Build Your Own (LWR) template, you must also specify the AuthenticationType value using the format templateParams.AuthenticationType=value, where value is AUTHENTICATED, UNAUTHENTICATED, or AUTHENTICATED_WITH_PUBLIC_ACCESS. Name and values are case-sensitive. See \"ExperienceBundle\" in the Metadata API Developer Guide for more information.\n\nWhen you execute this command, it creates the site in preview status, which means that it isn’t yet live. After you finish building your site, you can make it live.\n\nIf you have an Experience Builder site, publish the site using the sfdx force:community:publish command to make it live.\n\nIf you have a Salesforce Tabs + Visualforce site, activate the site to make it live by updating the status field of the Network type in the Metadata API. Alternatively, in Experience Workspaces, go to Administration | Settings, and click Activate.\n\nFor Experience Builder sites, activating the site just sends out a welcome email to site members.\n\nExamples:\n   $ sfdx force:community:create --name \"My Customer Site\" --templatename \"Customer Service\" --urlpathprefix customers --description \"My customer site\"\n   $ sfdx force:community:create -n partnercentral -t \"Partner Central\" -p partners\n   $ sfdx force:community:create -n lwrsite -t \"Build Your Own (LWR)\" -p lwrsite templateParams.AuthenticatedType=UNAUTHENTICATED","usage":"<%= command.id %> [name=value...] -n <string> -t <string> -p <string> [-d <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"salesforce-alm","pluginType":"core","aliases":[],"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)","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"},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"},"name":{"name":"name","type":"option","char":"n","description":"name of the site to create","required":true},"templatename":{"name":"templatename","type":"option","char":"t","description":"template to use to create a site","required":true},"urlpathprefix":{"name":"urlpathprefix","type":"option","char":"p","description":"URL to append to the domain created when Digital Experiences was enabled for this org","required":true},"description":{"name":"description","type":"option","char":"d","description":"description of the site","required":false}},"args":[]},"force:community:publish":{"id":"force:community:publish","description":"publishes an Experience Builder site to make it live\n\nWhen you publish an Experience Builder site for the first time, you make the site’s URL live and enable login access for site members.\n\nAdditionally, to send a welcome email to all site members, you must activate the site. (Activation is also required to successfully set up SEO for Experience Builder sites.) To activate a site, update the status field of the Network type in the Metadata API. Alternatively, in Experience Workspaces, go to Administration | Settings, and click Activate.\n\nSubsequently, each time you publish the site, you update the live site with all changes made to the site since it was last published.\n\nAn email notification informs you when your changes are live.\n\nExample:\n   $ sfdx force:community:publish --name \"My Customer Site\"","usage":"<%= command.id %> -n <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"salesforce-alm","pluginType":"core","aliases":[],"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)","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"},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"},"name":{"name":"name","type":"option","char":"n","description":"name of the Experience Builder site to publish","required":true}},"args":[]},"force:mdapi:convert":{"id":"force:mdapi:convert","description":"convert metadata from the Metadata API format into the source format\n\nNOTE: This command must be run from within a project.\n\nTo use Salesforce CLI to work with components that you retrieved via Metadata API, first convert your files from the metadata format to the source format using \"sfdx force:mdapi:convert\".\n\nTo convert files from the source format back to the metadata format, so that you can deploy them using \"sfdx force:mdapi:deploy\", run \"sfdx force:source:convert\".\n\nExamples:\n   $ sfdx force:mdapi:convert -r path/to/metadata\n   $ sfdx force:mdapi:convert -r path/to/metadata -d path/to/outputdir","usage":"<%= command.id %> -r <directory> [-d <directory>] [-m <array> | -x <string> | -p <array>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"salesforce-alm","pluginType":"core","aliases":[],"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)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"rootdir":{"name":"rootdir","type":"option","char":"r","description":"the root directory containing the Metadata API–formatted metadata","required":true},"outputdir":{"name":"outputdir","type":"option","char":"d","description":"the output directory to store the source–formatted files","required":false},"manifest":{"name":"manifest","type":"option","char":"x","description":"file path to manifest (package.xml) of metadata types to convert.","required":false},"metadata":{"name":"metadata","type":"option","char":"m","description":"comma-separated list of metadata component names to convert","required":false},"metadatapath":{"name":"metadatapath","type":"option","char":"p","description":"comma-separated list of paths to the local source files to convert","hidden":false,"required":false}},"args":[]},"force:mdapi:deploy":{"id":"force:mdapi:deploy","description":"deploy metadata to an org using Metadata API\n\nIMPORTANT: Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.\n\nSpecify the location of the files to deploy as a .zip file or by the root of the directory tree containing the files. To check the status of a deployment, specify its job ID. To run quick deploy of a recently validated package, use --validateddeployrequestid with the validated ID.\n\nTo wait for the command to finish running no matter how long the deployment takes, set --wait to -1: \"sfdx force mdapi:deploy -w -1 ...\".\n\nIf you don’t specify --wait, the command returns immediately and the metadata deploys asynchronously. Run force:mdapi:deploy:report to check the status of the deploy.","usage":"<%= command.id %> [-c] [-d <directory> | -f <filepath>] [-w <minutes>] [-l NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg] [-r <array>] [-o] [-g] [-q <id>] [-s] [--soapdeploy] [-u <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"salesforce-alm","pluginType":"core","aliases":[],"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)","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"},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"},"checkonly":{"name":"checkonly","type":"boolean","char":"c","description":"validate deploy but don’t save to the org","required":false,"allowNo":false},"deploydir":{"name":"deploydir","type":"option","char":"d","description":"root of directory tree of files to deploy","required":false},"wait":{"name":"wait","type":"option","char":"w","description":"wait time for command to finish in minutes (default: 0)","required":false},"testlevel":{"name":"testlevel","type":"option","char":"l","description":"deployment testing level","required":false,"helpValue":"(NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg)","options":["NoTestRun","RunSpecifiedTests","RunLocalTests","RunAllTestsInOrg"]},"runtests":{"name":"runtests","type":"option","char":"r","description":"tests to run if --testlevel RunSpecifiedTests","required":false},"ignoreerrors":{"name":"ignoreerrors","type":"boolean","char":"o","description":"ignore any errors and do not roll back deployment","required":false,"allowNo":false},"ignorewarnings":{"name":"ignorewarnings","type":"boolean","char":"g","description":"whether a warning will allow a deployment to complete successfully","required":false,"allowNo":false},"validateddeployrequestid":{"name":"validateddeployrequestid","type":"option","char":"q","description":"request ID of the validated deployment to run a Quick Deploy","required":false},"verbose":{"name":"verbose","type":"boolean","description":"verbose output of deploy results","allowNo":false},"zipfile":{"name":"zipfile","type":"option","char":"f","description":"path to .zip file of metadata to deploy","required":false},"singlepackage":{"name":"singlepackage","type":"boolean","char":"s","description":"Indicates that the zip file points to a directory structure for a single package","required":false,"allowNo":false},"soapdeploy":{"name":"soapdeploy","type":"boolean","description":"deploy metadata with SOAP API instead of REST API","required":false,"allowNo":false}},"args":[]},"force:mdapi:retrieve":{"id":"force:mdapi:retrieve","description":"retrieve metadata from an org using Metadata API\n\nThe default target username is the admin user for the default scratch org. You can retrieve and deploy up to 10,000 files or 400 MB (39 MB compressed) at one time.","usage":"<%= command.id %> -r <directory> [-w <minutes>] [-k <filepath>] [-d <directory>] [-p <array>] [-s] [-u <string>] [-a <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"salesforce-alm","pluginType":"core","aliases":[],"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)","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"},"apiversion":{"name":"apiversion","type":"option","char":"a","description":"target API version for the retrieve"},"wait":{"name":"wait","type":"option","char":"w","description":"wait time for command to finish in minutes (default: -1 (no limit))","required":false},"retrievetargetdir":{"name":"retrievetargetdir","type":"option","char":"r","description":"directory root for the retrieved files","required":true},"unpackaged":{"name":"unpackaged","type":"option","char":"k","description":"file path of manifest of components to retrieve","required":false},"verbose":{"name":"verbose","type":"boolean","description":"verbose output of retrieve result","allowNo":false},"sourcedir":{"name":"sourcedir","type":"option","char":"d","description":"source dir to use instead of the default package dir in sfdx-project.json","required":false},"packagenames":{"name":"packagenames","type":"option","char":"p","description":"a comma-separated list of packages to retrieve","required":false},"singlepackage":{"name":"singlepackage","type":"boolean","char":"s","description":"Indicates that the zip file points to a directory structure for a single package","required":false,"allowNo":false}},"args":[]},"force:org:clone":{"id":"force:org:clone","description":"clone a sandbox org\n\nSpecify a configuration file with a sourceSandboxName or provide key=value pairs while cloning a sandbox. The --targetusername (-u) must be a production org with sandbox licenses. The —type (-t) is required if cloning a sandbox.\n\nExamples:\n   $ sfdx force:org:clone -t sandbox -f config/dev-sandbox-def.json -u prodOrg -a MyDevSandbox\n   $ sfdx force:org:clone -t sandbox sandboxName=DevSbx1 sourceSandboxName=Sbx2Clone -u prodOrg -a MyDevSandbox","usage":"<%= command.id %> [name=value...] -t sandbox [-f <filepath>] [-s] [-a <string>] [-w <minutes>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"salesforce-alm","pluginType":"core","aliases":[],"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)","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"},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"},"type":{"name":"type","type":"option","char":"t","description":"type of org to create","required":true,"helpValue":"(sandbox)","options":["sandbox"]},"definitionfile":{"name":"definitionfile","type":"option","char":"f","description":"path to an org definition file","required":false},"definitionjson":{"name":"definitionjson","type":"option","char":"j","description":"org definition in JSON format","hidden":true,"required":false},"setdefaultusername":{"name":"setdefaultusername","type":"boolean","char":"s","description":"set the created org as the default username","required":false,"allowNo":false},"setalias":{"name":"setalias","type":"option","char":"a","description":"alias for the created org","required":false},"wait":{"name":"wait","type":"option","char":"w","description":"the streaming client socket timeout (in minutes)","required":false,"default":{"quantity":6,"unit":0}}},"args":[]},"force:org:create":{"id":"force:org:create","description":"create a scratch or sandbox org\n\nSpecify a configuration file or provide key=value pairs while creating a scratch org or a sandbox. When creating scratch orgs, —targetdevhubusername (-v) must be a Dev Hub org. When creating sandboxes, the --targetusername (-u) must be a production org with sandbox licenses. The —type (-t) is required if creating a sandbox.\n\nExamples:\n   $ sfdx force:org:create -f config/enterprise-scratch-def.json -a MyScratchOrg\n   $ sfdx force:org:create edition=Developer -a MyScratchOrg -s -v devHub\n   $ sfdx force:org:create -f config/enterprise-scratch-def.json -a ScratchOrgWithOverrides username=testuser1@mycompany.org\n   $ sfdx force:org:create -t sandbox -f config/dev-sandbox-def.json -a MyDevSandbox -u prodOrg","usage":"<%= command.id %> [name=value...] [-t scratch|sandbox] [-f <filepath>] [-n] [-c] [-i <string>] [-s] [-a <string>] [-w <minutes>] [-d <integer>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"salesforce-alm","pluginType":"core","aliases":[],"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)","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"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org"},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"},"type":{"name":"type","type":"option","char":"t","description":"type of org to create","helpValue":"(scratch|sandbox)","options":["scratch","sandbox"],"default":"scratch"},"definitionfile":{"name":"definitionfile","type":"option","char":"f","description":"path to an org definition file"},"definitionjson":{"name":"definitionjson","type":"option","char":"j","description":"org definition in JSON format","hidden":true},"nonamespace":{"name":"nonamespace","type":"boolean","char":"n","description":"create the scratch org with no namespace","allowNo":false},"noancestors":{"name":"noancestors","type":"boolean","char":"c","description":"do not include second-generation package ancestors in the scratch org","allowNo":false},"clientid":{"name":"clientid","type":"option","char":"i","description":"connected app consumer key; not supported for sandbox org creation"},"setdefaultusername":{"name":"setdefaultusername","type":"boolean","char":"s","description":"set the created org as the default username","allowNo":false},"setalias":{"name":"setalias","type":"option","char":"a","description":"alias for the created org"},"env":{"name":"env","type":"option","char":"e","description":"environment where the scratch org is created: sandbox*,virtual,prototype","hidden":true,"helpValue":"(sandbox*|virtual|prototype)","options":["sandbox*","virtual","prototype"],"default":"sandbox"},"wait":{"name":"wait","type":"option","char":"w","description":"the streaming client socket timeout (in minutes)","default":{"quantity":6,"unit":0}},"durationdays":{"name":"durationdays","type":"option","char":"d","description":"duration of the scratch org (in days) (default:7, min:1, max:30)"},"retry":{"name":"retry","type":"option","description":"Number of scratch org auth retries after scratch org is successfully signed up.","hidden":true,"default":0}},"args":[]},"force:org:status":{"id":"force:org:status","description":"report sandbox org creation status and authenticate to org\n\nUse this command to check the status of your sandbox org creation and, if the org is ready, authenticate to the org.\nTo specify the number of minutes that the command will wait for the sandbox org creation to complete before returning control of the terminal to you, include a -w | --wait value.\n\nExamples:\n   $ sfdx force:org:status -n YourSandboxName -w 10","usage":"<%= command.id %> -n <string> [-s] [-a <string>] [-w <minutes>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"salesforce-alm","pluginType":"core","aliases":[],"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)","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"},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"},"sandboxname":{"name":"sandboxname","type":"option","char":"n","description":"name of the sandbox org to check status for","required":true},"setdefaultusername":{"name":"setdefaultusername","type":"boolean","char":"s","description":"set the created org as the default username","required":false,"allowNo":false},"setalias":{"name":"setalias","type":"option","char":"a","description":"alias for the created org","required":false},"wait":{"name":"wait","type":"option","char":"w","description":"number of minutes to wait while polling for status","required":false,"default":{"quantity":6,"unit":0}}},"args":[]},"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\".\n\nExamples:\n   $ sfdx force:package:convert --package 033xx0000004Gmn -k password123","usage":"<%= command.id %> -p <string> [-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-alm","pluginType":"core","hidden":true,"aliases":[],"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)","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"},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"},"package":{"name":"package","type":"option","char":"p","description":"ID (starts with 033) of the first-generation package to convert","required":true},"installationkey":{"name":"installationkey","type":"option","char":"k","description":"installation key for key-protected package (either --installationkey or --installationkeybypass is required)","required":false},"installationkeybypass":{"name":"installationkeybypass","type":"boolean","char":"x","description":"bypass the installation key requirement (either --installationkey or --installationkeybypass is required)","required":false,"allowNo":false},"wait":{"name":"wait","type":"option","char":"w","description":"minutes to wait for the package version to be created","required":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,"required":false}},"args":[]},"force:package:create":{"id":"force:package:create","description":"create a package\n\nNOTE: This command must be run from within a project.\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\nExamples:\n   $ sfdx force:package:create -n YourPackageName -t Unlocked -r force-app\n   $ sfdx force:package:create -n YourPackageName -d \"Your Package Descripton\" -t Unlocked -r force-app\n\nRun 'sfdx force:package:list' to list all packages in the Dev Hub org.","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-alm","pluginType":"core","aliases":[],"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)","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"},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"},"name":{"name":"name","type":"option","char":"n","description":"package name","required":true},"packagetype":{"name":"packagetype","type":"option","char":"t","description":"package type","required":true,"helpValue":"(Managed|Unlocked)","options":["Managed","Unlocked"]},"description":{"name":"description","type":"option","char":"d","description":"package description","required":false},"nonamespace":{"name":"nonamespace","type":"boolean","char":"e","description":"creates the package with no namespace; available only for unlocked packages.","required":false,"allowNo":false},"path":{"name":"path","type":"option","char":"r","description":"path to directory that contains the contents of the package","required":true},"orgdependent":{"name":"orgdependent","type":"boolean","description":"depends on unpackaged metadata in the installation org. Applies to unlocked packages only.","required":false,"allowNo":false},"errornotificationusername":{"name":"errornotificationusername","type":"option","char":"o","description":"active Dev Hub user designated to receive email notifications for package errors","required":false}},"args":[]},"force:package:delete":{"id":"force:package:delete","description":"delete a package\n\nNOTE: This command must be run from within a project.\n\nSpecify the ID or alias of the package you want to delete.\n\nExamples:\n   $ sfdx force:package:delete -p \"Your Package Alias\"\n   $ sfdx force:package:delete -p 0Ho...","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-alm","pluginType":"core","aliases":[],"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)","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"},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"},"noprompt":{"name":"noprompt","type":"boolean","char":"n","description":"don’t prompt before deleting the package","required":false,"allowNo":false},"package":{"name":"package","type":"option","char":"p","description":"ID (starts with 0Ho) or alias of the package to delete","required":true},"undelete":{"name":"undelete","type":"boolean","description":"undelete a deleted package","hidden":true,"required":false,"allowNo":false}},"args":[]},"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.\n\nExamples:\n   $ sfdx force:package:install --package 04t... -u me@example.com\n   $ sfdx force:package:install --package awesome_package_alias\n   $ sfdx force:package:install --package \"Awesome Package Alias\"\n   $ sfdx force:package:install --package 04t... -t DeprecateOnly","usage":"<%= command.id %> [-w <minutes>] [-k <string>] [-b <minutes>] [-r] [-p <string>] [-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-alm","pluginType":"core","aliases":[],"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)","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"},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"},"wait":{"name":"wait","type":"option","char":"w","description":"number of minutes to wait for installation status","required":false},"installationkey":{"name":"installationkey","type":"option","char":"k","description":"installation key for key-protected package (default: null)","required":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 ","required":false},"noprompt":{"name":"noprompt","type":"boolean","char":"r","description":"do not prompt for confirmation","required":false,"allowNo":false},"package":{"name":"package","type":"option","char":"p","description":"ID (starts with 04t) or alias of the package version to install","required":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","required":false,"helpValue":"(all|package)","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.)","required":false,"helpValue":"(AllUsers|AdminsOnly)","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","required":false,"helpValue":"(DeprecateOnly|Mixed|Delete)","options":["DeprecateOnly","Mixed","Delete"],"default":"Mixed"}},"args":[]},"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.\n\nExamples:\n   $ sfdx force:package:list -v devhub@example.com\n   $ sfdx force:package:list -v devhub@example.com --verbose","usage":"<%= command.id %> [-v <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"salesforce-alm","pluginType":"core","aliases":[],"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)","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"},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"},"verbose":{"name":"verbose","type":"boolean","description":"display extended package detail","allowNo":false}},"args":[]},"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\nExamples:\n   $ sfdx force:package:uninstall -p 04t... -u me@example.com\n   $ sfdx force:package:uninstall -p undesirable_package_alias\n   $ sfdx force:package:uninstall -p \"Undesirable Package Alias\"\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.","usage":"<%= command.id %> [-w <minutes>] [-p <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"salesforce-alm","pluginType":"core","aliases":[],"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)","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"},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"},"wait":{"name":"wait","type":"option","char":"w","description":"number of minutes to wait for uninstall status","required":false},"package":{"name":"package","type":"option","char":"p","description":"ID (starts with 04t) or alias of the package version to uninstall","required":false}},"args":[]},"force:package:update":{"id":"force:package:update","description":"update package details\n\nNOTE: This command must be run from within a project.\n\nSpecify a new value for each option you want to update.\n\nExamples:\n   $ sfdx force:package:update -p \"Your Package Alias\" -n \"New Package Name\"\n   $ sfdx force:package:update -p 0Ho... -d \"New Package Description\"\n\nRun \"sfdx force:package:list\" to list all packages in the Dev Hub org.","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-alm","pluginType":"core","aliases":[],"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)","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"},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"},"package":{"name":"package","type":"option","char":"p","description":"ID (starts with 0Ho) or alias of the package to update","required":true},"name":{"name":"name","type":"option","char":"n","description":"new package name","required":false},"description":{"name":"description","type":"option","char":"d","description":"new package description","required":false},"errornotificationusername":{"name":"errornotificationusername","type":"option","char":"o","description":"active Dev Hub user designated to receive email notifications for package errors","required":false}},"args":[]},"force:source:pull":{"id":"force:source:pull","description":"pull source from the scratch org to the project\n\nNOTE: This command must be run from within a project.\n\nIf the command detects a conflict, it displays the conflicts but does not complete the process. After reviewing the conflict, rerun the command with the --forceoverwrite parameter.","usage":"<%= command.id %> [-w <minutes>] [-f] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"salesforce-alm","pluginType":"core","aliases":[],"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)","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"},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"},"wait":{"name":"wait","type":"option","char":"w","description":"wait time for command to finish in minutes (default: 33)","required":false,"default":{"quantity":33,"unit":0}},"forceoverwrite":{"name":"forceoverwrite","type":"boolean","char":"f","description":"ignore conflict warnings and overwrite changes to the project","required":false,"allowNo":false}},"args":[]},"force:source:push":{"id":"force:source:push","description":"push source to a scratch org from the project\n\nNOTE: This command must be run from within a project.\n\nIf the command detects a conflict, it displays the conflicts but does not complete the process. After reviewing the conflict, rerun the command with the --forceoverwrite parameter.","usage":"<%= command.id %> [-f] [-g] [-w <minutes>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"salesforce-alm","pluginType":"core","aliases":[],"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)","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"},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"},"forceoverwrite":{"name":"forceoverwrite","type":"boolean","char":"f","description":"ignore conflict warnings and overwrite changes to scratch org","required":false,"allowNo":false},"ignorewarnings":{"name":"ignorewarnings","type":"boolean","char":"g","description":"deploy changes even if warnings are generated","required":false,"allowNo":false},"replacetokens":{"name":"replacetokens","type":"boolean","char":"r","description":"replace tokens in source files prior to deployment","hidden":true,"required":false,"allowNo":false},"wait":{"name":"wait","type":"option","char":"w","description":"wait time for command to finish in minutes (default: 33)","required":false,"default":{"quantity":33,"unit":0}}},"args":[]},"force:source:status":{"id":"force:source:status","description":"list local changes and/or changes in a scratch org\n\nNOTE: This command must be run from within a project.\n\nExamples:\n   $ sfdx force:source:status -l\n   $ sfdx force:source:status -r\n   $ sfdx force:source:status -a\n   $ sfdx force:source:status -a -u me@example.com --json","usage":"<%= command.id %> [-l] [-r] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"salesforce-alm","pluginType":"core","aliases":[],"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)","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"},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"},"all":{"name":"all","type":"boolean","char":"a","description":"(deprecated) list all the changes that have been made","hidden":true,"required":false,"allowNo":false},"local":{"name":"local","type":"boolean","char":"l","description":"list the changes that have been made locally","required":false,"allowNo":false},"remote":{"name":"remote","type":"boolean","char":"r","description":"list the changes that have been made in the scratch org","required":false,"allowNo":false}},"args":[]},"force:community:template:list":{"id":"force:community:template:list","description":"retrieves the list of templates available in your org\n\nSee \"Which Experience Cloud Template Should I Use?\" in Salesforce Help for more information about the different template types available for Experience Cloud.\n\nExample:\n   $ sfdx force:community:template:list","usage":"<%= command.id %> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"salesforce-alm","pluginType":"core","aliases":[],"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)","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"},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"}},"args":[]},"force:mdapi:deploy:report":{"id":"force:mdapi:deploy:report","description":"check the status of a metadata deployment\n\nSpecify the job ID for the deploy you want to check. You can also specify a wait time (minutes) to check for updates to the deploy status.","usage":"<%= command.id %> [-w <minutes>] [-i <id>] [-u <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"salesforce-alm","pluginType":"core","aliases":[],"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)","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"},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"},"wait":{"name":"wait","type":"option","char":"w","description":"wait time for command to finish in minutes (default: 0)","required":false},"jobid":{"name":"jobid","type":"option","char":"i","description":"job ID of the deployment to check; required if you’ve never deployed using Salesforce CLI; if not specified, defaults to your most recent CLI deployment","required":false},"verbose":{"name":"verbose","type":"boolean","description":"verbose output of deploy results","allowNo":false}},"args":[]},"force:mdapi:retrieve:report":{"id":"force:mdapi:retrieve:report","description":"check the status of a metadata retrieval\n\nSpecify the job ID and a target directory for the retrieve you want to check. You can also specify a wait time (minutes) to check for updates to the deploy status. If the retrieve was successful, the resulting zip file will be saved to the location passed in with the retrieve target parameter.","usage":"<%= command.id %> [-w <minutes>] [-r <directory>] [-i <id>] [-u <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"salesforce-alm","pluginType":"core","aliases":[],"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)","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"},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"},"wait":{"name":"wait","type":"option","char":"w","description":"wait time for command to finish in minutes (default: -1 (no limit))","required":false},"retrievetargetdir":{"name":"retrievetargetdir","type":"option","char":"r","description":"directory root for the retrieved files","required":false},"verbose":{"name":"verbose","type":"boolean","description":"verbose output of retrieve