@salesforce/cli 2.44.6 → 2.44.8

package/README.md

@@ -24,7 +24,7 @@ $ npm install -g @salesforce/cli
 $ sf COMMAND
 running command...
 $ sf (--version|-v)
-@salesforce/cli/2.44.6 linux-x64 node-v20.13.1
+@salesforce/cli/2.44.8 linux-x64 node-v20.13.1
 $ sf --help [COMMAND]
 USAGE
   $ sf COMMAND
@@ -148,6 +148,7 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI.
 - [`sf plugins update`](#sf-plugins-update)
 - [`sf project convert mdapi`](#sf-project-convert-mdapi)
 - [`sf project convert source`](#sf-project-convert-source)
+- [`sf project convert source-behavior`](#sf-project-convert-source-behavior)
 - [`sf project delete source`](#sf-project-delete-source)
 - [`sf project delete tracking`](#sf-project-delete-tracking)
 - [`sf project deploy cancel`](#sf-project-deploy-cancel)
@@ -5718,7 +5719,7 @@ FLAG DESCRIPTIONS
     If you specify this parameter, don’t specify --metadata or --source-dir.
 ```
 
-_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10/src/commands/project/convert/mdapi.ts)_
+_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.3/src/commands/project/convert/mdapi.ts)_
 
 ## `sf project convert source`
 
@@ -5730,7 +5731,7 @@ USAGE
     [-p <value> | -x <value> | -m <value>]
 
 FLAGS
-  -d, --output-dir=<value>     [default: metadataPackage_1716916525319] Output directory to store the Metadata
+  -d, --output-dir=<value>     [default: metadataPackage_1717189274100] Output directory to store the Metadata
                                API–formatted files in.
   -m, --metadata=<value>...    Metadata component names to convert.
   -n, --package-name=<value>   Name of the package to associate with the metadata-formatted files.
@@ -5791,7 +5792,64 @@ FLAG DESCRIPTIONS
     Override the api version used for api requests made by this command
 ```
 
-_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10/src/commands/project/convert/source.ts)_
+_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.3/src/commands/project/convert/source.ts)_
+
+## `sf project convert source-behavior`
+
+Enable a behavior of your project source files, and then update your Salesforce DX project to implement the behavior.
+
+```
+USAGE
+  $ sf project convert source-behavior -b
+    decomposeCustomLabelsBeta|decomposePermissionSetBeta|decomposeSharingRulesBeta|decomposeWorkflowBeta [--json]
+    [--flags-dir <value>] [--dry-run] [--preserve-temp-dir] [-o <value>]
+
+FLAGS
+  -b, --behavior=<option>   (required) Behavior to enable; the values correspond to the possible values of the
+                            "sourceBehaviorOption" option in the "sfdx-project.json" file.
+                            <options: decomposeCustomLabelsBeta|decomposePermissionSetBeta|decomposeSharingRulesBeta|dec
+                            omposeWorkflowBeta>
+  -o, --target-org=<value>  Username or alias of the target org.
+      --dry-run             Display what the command would do, but don't make any actual changes.
+      --preserve-temp-dir   Don't delete the metadata API format temporary directory that this command creates. Useful
+                            for debugging.
+
+GLOBAL FLAGS
+  --flags-dir=<value>  Import flag values from a directory.
+  --json               Format output as json.
+
+DESCRIPTION
+  Enable a behavior of your project source files, and then update your Salesforce DX project to implement the behavior.
+
+  Specifically, this command updates the "sourceBehaviorOption" option in the "sfdx-project.json" file and then converts
+  the associated local source files in your project as needed.
+
+  For example, run this command with the "--behavior decomposePermissionSetBeta" flag to start decomposing permission
+  sets when you deploy or retrieve them. Decomposing means breaking up the monolithic metadata API format XML file that
+  corresponds to a metadata component into smaller XML files and directories based on its subtypes. Permission sets are
+  not decomposed by default; you must opt-in to start decomposing them by using this command. When the command finishes,
+  your "sfdx-project.json" file is updated to always decompose permission sets, and the existing permission set files in
+  your local package directories are converted into the new decomposed format. You run this command only once for a
+  given behavior change.
+
+  For more information about the possible values for the --behavior flag, see the "sourceBehaviorOptions" section in the
+  https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_ws_config.htm topic.
+
+EXAMPLES
+  Update your Salesforce DX project to decompose custom labels:
+
+    $ sf project convert source-behavior --behavior decomposeCustomLabelsBeta
+
+  Display what the command would do, but don't change any existing files:
+
+    $ sf project convert source-behavior --behavior decomposeCustomLabelsBeta --dry-run
+
+  Keep the temporary directory that contains the interim metadata API formatted files:
+
+    $ sf project convert source-behavior --behavior decomposeCustomLabelsBeta --dry-run --preserve-temp-dir
+```
+
+_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.3/src/commands/project/convert/source-behavior.ts)_
 
 ## `sf project delete source`
 
@@ -5931,7 +5989,7 @@ FLAG DESCRIPTIONS
     - Separate the test names with spaces: --tests Test1 Test2 "Test With Space"
 ```
 
-_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10/src/commands/project/delete/source.ts)_
+_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.3/src/commands/project/delete/source.ts)_
 
 ## `sf project delete tracking`
 
@@ -5968,7 +6026,7 @@ EXAMPLES
     $ sf project delete tracking --target-org my-scratch
 ```
 
-_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10/src/commands/project/delete/tracking.ts)_
+_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.3/src/commands/project/delete/tracking.ts)_
 
 ## `sf project deploy cancel`
 
@@ -5980,7 +6038,7 @@ USAGE
 
 FLAGS
   -i, --job-id=<value>      Job ID of the deploy operation you want to cancel.
-  -o, --target-org=<value>  Login username or alias for the target org.
+  -o, --target-org=<value>  Username or alias of the target org.
   -r, --use-most-recent     Use the job ID of the most recent deploy operation.
   -w, --wait=<minutes>      Number of minutes to wait for the command to complete and display results.
       --async               Run the command asynchronously.
@@ -6022,10 +6080,6 @@ FLAG DESCRIPTIONS
 
     The job ID is valid for 10 days from when you started the deploy operation.
 
-  -o, --target-org=<value>  Login username or alias for the target org.
-
-    Overrides your default org.
-
   -r, --use-most-recent  Use the job ID of the most recent deploy operation.
 
     For performance reasons, this flag uses job IDs for deploy operations that started only in the past 3 days or less.
@@ -6044,7 +6098,7 @@ FLAG DESCRIPTIONS
     project deploy report".
 ```
 
-_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10/src/commands/project/deploy/cancel.ts)_
+_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.3/src/commands/project/deploy/cancel.ts)_
 
 ## `sf project deploy preview`
 
@@ -6059,7 +6113,8 @@ FLAGS
   -c, --ignore-conflicts       Don't display conflicts in preview of the deployment.
   -d, --source-dir=<value>...  Path to the local source files to preview.
   -m, --metadata=<value>...    Metadata component names to preview.
-  -o, --target-org=<value>     (required) Login username or alias for the target org.
+  -o, --target-org=<value>     (required) Username or alias of the target org. Not required if the `target-org`
+                               configuration variable is already set.
   -x, --manifest=<value>       Full file path for manifest (package.xml) of components to preview.
       --concise                Show only the changes that will be deployed; omits files that are forceignored.
 
@@ -6121,16 +6176,12 @@ FLAG DESCRIPTIONS
 
     If you specify this flag, don’t specify --metadata or --manifest.
 
-  -o, --target-org=<value>  Login username or alias for the target org.
-
-    Overrides your default org.
-
   -x, --manifest=<value>  Full file path for manifest (package.xml) of components to preview.
 
     All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.
 ```
 
-_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10/src/commands/project/deploy/preview.ts)_
+_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.3/src/commands/project/deploy/preview.ts)_
 
 ## `sf project deploy quick`
 
@@ -6144,7 +6195,7 @@ USAGE
 FLAGS
   -a, --api-version=<value>  Target API version for the deploy.
   -i, --job-id=<value>       Job ID of the deployment you want to quick deploy.
-  -o, --target-org=<value>   Login username or alias for the target org.
+  -o, --target-org=<value>   Username or alias of the target org.
   -r, --use-most-recent      Use the job ID of the most recently validated deployment.
   -w, --wait=<minutes>       [default: 33 minutes] Number of minutes to wait for the command to complete and display
                              results.
@@ -6196,10 +6247,6 @@ FLAG DESCRIPTIONS
 
     The job ID is valid for 10 days from when you started the validation.
 
-  -o, --target-org=<value>  Login username or alias for the target org.
-
-    Overrides your default org.
-
   -r, --use-most-recent  Use the job ID of the most recently validated deployment.
 
     For performance reasons, this flag uses only job IDs that were validated in the past 3 days or less. If your most
@@ -6227,7 +6274,7 @@ ERROR CODES
   Canceling (69)         The deploy is being canceled.
 ```
 
-_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10/src/commands/project/deploy/quick.ts)_
+_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.3/src/commands/project/deploy/quick.ts)_
 
 ## `sf project deploy report`
 
@@ -6241,7 +6288,7 @@ USAGE
 
 FLAGS
   -i, --job-id=<value>      Job ID of the deploy operation you want to check the status of.
-  -o, --target-org=<value>  Login username or alias for the target org.
+  -o, --target-org=<value>  Username or alias of the target org.
   -r, --use-most-recent     Use the job ID of the most recent deploy operation.
   -w, --wait=<minutes>      Number of minutes to wait for command to complete and display results.
 
@@ -6300,10 +6347,6 @@ FLAG DESCRIPTIONS
 
     The job ID is valid for 10 days from when you started the deploy operation.
 
-  -o, --target-org=<value>  Login username or alias for the target org.
-
-    Overrides your default org.
-
   -r, --use-most-recent  Use the job ID of the most recent deploy operation.
 
     For performance reasons, this flag uses job IDs for deploy operations that started only in the past 3 days or less.
@@ -6323,7 +6366,7 @@ FLAG DESCRIPTIONS
     --coverage-formatters lcov --coverage-formatters clover
 ```
 
-_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10/src/commands/project/deploy/report.ts)_
+_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.3/src/commands/project/deploy/report.ts)_
 
 ## `sf project deploy resume`
 
@@ -6420,7 +6463,7 @@ ERROR CODES
   Canceling (69)         The deploy is being canceled.
 ```
 
-_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10/src/commands/project/deploy/resume.ts)_
+_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.3/src/commands/project/deploy/resume.ts)_
 
 ## `sf project deploy start`
 
@@ -6439,7 +6482,8 @@ FLAGS
   -a, --api-version=<value>  Target API version for the deploy.
   -c, --ignore-conflicts     Ignore conflicts and deploy local files, even if they overwrite changes in the org.
   -g, --ignore-warnings      Ignore warnings and allow a deployment to complete successfully.
-  -o, --target-org=<value>   (required) Login username or alias for the target org.
+  -o, --target-org=<value>   (required) Username or alias of the target org. Not required if the `target-org`
+                             configuration variable is already set.
   -r, --ignore-errors        Ignore any errors and don’t roll back deployment.
   -w, --wait=<minutes>       Number of minutes to wait for command to complete and display results.
       --async                Run the command asynchronously.
@@ -6533,6 +6577,14 @@ EXAMPLES
 
     $ sf project deploy start --metadata 'ApexClass:MyApex*' --ignore-warnings
 
+  Deploy a custom object called ExcitingObject that's in the SBQQ namespace:
+
+    $ sf project deploy start --metadata CustomObject:SBQQ__ExcitingObject
+
+  Deploy all custom objects in the SBQQ namespace by using a wildcard and quotes:
+
+    $ sf project deploy start --metadata 'CustomObject:SBQQ__*'
+
   Deploy all custom objects and Apex classes found in all defined package directories (both examples are equivalent):
 
     $ sf project deploy start --metadata CustomObject ApexClass
@@ -6600,10 +6652,6 @@ FLAG DESCRIPTIONS
     Deployment](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm)
     in the "Metadata API Developer Guide".
 
-  -o, --target-org=<value>  Login username or alias for the target org.
-
-    Overrides your default org.
-
   -r, --ignore-errors  Ignore any errors and don’t roll back deployment.
 
     Never use this flag when deploying to a production org. If you specify it, components without errors are deployed
@@ -6658,7 +6706,7 @@ ERROR CODES
   Canceling (69)         The deploy is being canceled.
 ```
 
-_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10/src/commands/project/deploy/start.ts)_
+_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.3/src/commands/project/deploy/start.ts)_
 
 ## `sf project deploy validate`
 
@@ -6675,7 +6723,8 @@ USAGE
 FLAGS
   -a, --api-version=<value>  Target API version for the validation.
   -g, --ignore-warnings      Ignore warnings and allow a deployment to complete successfully.
-  -o, --target-org=<value>   (required) Login username or alias for the target org.
+  -o, --target-org=<value>   (required) Username or alias of the target org. Not required if the `target-org`
+                             configuration variable is already set.
   -w, --wait=<minutes>       Number of minutes to wait for the command to complete and display results.
       --async                Run the command asynchronously.
       --concise              Show concise output of the validation result.
@@ -6797,10 +6846,6 @@ FLAG DESCRIPTIONS
 
     - RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.
 
-  -o, --target-org=<value>  Login username or alias for the target org.
-
-    Overrides your default org.
-
   -t, --tests=<value>...  Apex tests to run when --test-level is RunSpecifiedTests.
 
     If a test name contains a space, enclose it in double quotes.
@@ -6850,7 +6895,7 @@ ERROR CODES
   Canceling (69)         The deploy is being canceled.
 ```
 
-_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10/src/commands/project/deploy/validate.ts)_
+_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.3/src/commands/project/deploy/validate.ts)_
 
 ## `sf project generate`
 
@@ -7032,7 +7077,7 @@ EXAMPLES
     $ sf project generate manifest --from-org test@myorg.com --include-packages unlocked
 ```
 
-_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10/src/commands/project/generate/manifest.ts)_
+_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.3/src/commands/project/generate/manifest.ts)_
 
 ## `sf project list ignored`
 
@@ -7074,7 +7119,7 @@ EXAMPLES
     $ sf project list ignored --source-dir package.xml
 ```
 
-_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10/src/commands/project/list/ignored.ts)_
+_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.3/src/commands/project/list/ignored.ts)_
 
 ## `sf project reset tracking`
 
@@ -7123,7 +7168,7 @@ EXAMPLES
     $ sf project reset tracking --revision 30
 ```
 
-_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10/src/commands/project/reset/tracking.ts)_
+_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.3/src/commands/project/reset/tracking.ts)_
 
 ## `sf project retrieve preview`
 
@@ -7135,7 +7180,8 @@ USAGE
 
 FLAGS
   -c, --ignore-conflicts    Don't display conflicts in the preview of the retrieval.
-  -o, --target-org=<value>  (required) Login username or alias for the target org.
+  -o, --target-org=<value>  (required) Username or alias of the target org. Not required if the `target-org`
+                            configuration variable is already set.
       --concise             Show only the changes that will be retrieved; omits files that are forceignored.
 
 GLOBAL FLAGS
@@ -7174,13 +7220,9 @@ FLAG DESCRIPTIONS
 
     This flag applies only to orgs that allow source tracking. It has no effect on orgs that don't allow it, such as
     production orgs.
-
-  -o, --target-org=<value>  Login username or alias for the target org.
-
-    Overrides your default org.
 ```
 
-_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10/src/commands/project/retrieve/preview.ts)_
+_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.3/src/commands/project/retrieve/preview.ts)_
 
 ## `sf project retrieve start`
 
@@ -7199,7 +7241,8 @@ FLAGS
   -m, --metadata=<value>...      Metadata component names to retrieve. Wildcards (`*`) supported as long as you use
                                  quotes, such as `ApexClass:MyClass*`.
   -n, --package-name=<value>...  Package names to retrieve.
-  -o, --target-org=<value>       (required) Login username or alias for the target org.
+  -o, --target-org=<value>       (required) Username or alias of the target org. Not required if the `target-org`
+                                 configuration variable is already set.
   -r, --output-dir=<value>       Directory root for the retrieved source files.
   -w, --wait=<value>             [default: 33 minutes] Number of minutes to wait for the command to complete and display
                                  results to the terminal window.
@@ -7265,6 +7308,14 @@ EXAMPLES
 
     $ sf project retrieve start --metadata 'ApexClass:MyApex*'
 
+  Retrieve a custom object called ExcitingObject that's in the SBQQ namespace:
+
+    $ sf project retrieve start --metadata CustomObject:SBQQ__ExcitingObject
+
+  Retrieve all custom objects in the SBQQ namespace by using a wildcard and quotes:
+
+    $ sf project retrieve start --metadata 'CustomObject:SBQQ__*'
+
   Retrieve all custom objects and Apex classes found in all defined package directories (both examples are
   equivalent):
 
@@ -7312,10 +7363,6 @@ FLAG DESCRIPTIONS
     The supplied paths can be to a single file (in which case the operation is applied to only one file) or to a folder
     (in which case the operation is applied to all source files in the directory and its subdirectories).
 
-  -o, --target-org=<value>  Login username or alias for the target org.
-
-    Overrides your default org.
-
   -r, --output-dir=<value>  Directory root for the retrieved source files.
 
     The root of the directory structure into which the source files are retrieved.
@@ -7339,7 +7386,7 @@ ENVIRONMENT VARIABLES
   SF_USE_PROGRESS_BAR  Set to false to disable the progress bar when running the metadata deploy command.
 ```
 
-_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10/src/commands/project/retrieve/start.ts)_
+_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.3/src/commands/project/retrieve/start.ts)_
 
 ## `sf schema generate field`