@salesforce/cli 2.44.7 → 2.44.8

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 CHANGED
@@ -24,7 +24,7 @@ $ npm install -g @salesforce/cli
24
24
  $ sf COMMAND
25
25
  running command...
26
26
  $ sf (--version|-v)
27
- @salesforce/cli/2.44.7 linux-x64 node-v20.13.1
27
+ @salesforce/cli/2.44.8 linux-x64 node-v20.13.1
28
28
  $ sf --help [COMMAND]
29
29
  USAGE
30
30
  $ sf COMMAND
@@ -5719,7 +5719,7 @@ FLAG DESCRIPTIONS
5719
5719
  If you specify this parameter, don’t specify --metadata or --source-dir.
5720
5720
  ```
5721
5721
 
5722
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0/src/commands/project/convert/mdapi.ts)_
5722
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.3/src/commands/project/convert/mdapi.ts)_
5723
5723
 
5724
5724
  ## `sf project convert source`
5725
5725
 
@@ -5731,7 +5731,7 @@ USAGE
5731
5731
  [-p <value> | -x <value> | -m <value>]
5732
5732
 
5733
5733
  FLAGS
5734
- -d, --output-dir=<value> [default: metadataPackage_1716992955026] Output directory to store the Metadata
5734
+ -d, --output-dir=<value> [default: metadataPackage_1717189274100] Output directory to store the Metadata
5735
5735
  API–formatted files in.
5736
5736
  -m, --metadata=<value>... Metadata component names to convert.
5737
5737
  -n, --package-name=<value> Name of the package to associate with the metadata-formatted files.
@@ -5792,7 +5792,7 @@ FLAG DESCRIPTIONS
5792
5792
  Override the api version used for api requests made by this command
5793
5793
  ```
5794
5794
 
5795
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0/src/commands/project/convert/source.ts)_
5795
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.3/src/commands/project/convert/source.ts)_
5796
5796
 
5797
5797
  ## `sf project convert source-behavior`
5798
5798
 
@@ -5809,7 +5809,7 @@ FLAGS
5809
5809
  "sourceBehaviorOption" option in the "sfdx-project.json" file.
5810
5810
  <options: decomposeCustomLabelsBeta|decomposePermissionSetBeta|decomposeSharingRulesBeta|dec
5811
5811
  omposeWorkflowBeta>
5812
- -o, --target-org=<value>
5812
+ -o, --target-org=<value> Username or alias of the target org.
5813
5813
  --dry-run Display what the command would do, but don't make any actual changes.
5814
5814
  --preserve-temp-dir Don't delete the metadata API format temporary directory that this command creates. Useful
5815
5815
  for debugging.
@@ -5849,7 +5849,7 @@ EXAMPLES
5849
5849
  $ sf project convert source-behavior --behavior decomposeCustomLabelsBeta --dry-run --preserve-temp-dir
5850
5850
  ```
5851
5851
 
5852
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0/src/commands/project/convert/source-behavior.ts)_
5852
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.3/src/commands/project/convert/source-behavior.ts)_
5853
5853
 
5854
5854
  ## `sf project delete source`
5855
5855
 
@@ -5989,7 +5989,7 @@ FLAG DESCRIPTIONS
5989
5989
  - Separate the test names with spaces: --tests Test1 Test2 "Test With Space"
5990
5990
  ```
5991
5991
 
5992
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0/src/commands/project/delete/source.ts)_
5992
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.3/src/commands/project/delete/source.ts)_
5993
5993
 
5994
5994
  ## `sf project delete tracking`
5995
5995
 
@@ -6026,7 +6026,7 @@ EXAMPLES
6026
6026
  $ sf project delete tracking --target-org my-scratch
6027
6027
  ```
6028
6028
 
6029
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0/src/commands/project/delete/tracking.ts)_
6029
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.3/src/commands/project/delete/tracking.ts)_
6030
6030
 
6031
6031
  ## `sf project deploy cancel`
6032
6032
 
@@ -6038,7 +6038,7 @@ USAGE
6038
6038
 
6039
6039
  FLAGS
6040
6040
  -i, --job-id=<value> Job ID of the deploy operation you want to cancel.
6041
- -o, --target-org=<value> Login username or alias for the target org.
6041
+ -o, --target-org=<value> Username or alias of the target org.
6042
6042
  -r, --use-most-recent Use the job ID of the most recent deploy operation.
6043
6043
  -w, --wait=<minutes> Number of minutes to wait for the command to complete and display results.
6044
6044
  --async Run the command asynchronously.
@@ -6080,10 +6080,6 @@ FLAG DESCRIPTIONS
6080
6080
 
6081
6081
  The job ID is valid for 10 days from when you started the deploy operation.
6082
6082
 
6083
- -o, --target-org=<value> Login username or alias for the target org.
6084
-
6085
- Overrides your default org.
6086
-
6087
6083
  -r, --use-most-recent Use the job ID of the most recent deploy operation.
6088
6084
 
6089
6085
  For performance reasons, this flag uses job IDs for deploy operations that started only in the past 3 days or less.
@@ -6102,7 +6098,7 @@ FLAG DESCRIPTIONS
6102
6098
  project deploy report".
6103
6099
  ```
6104
6100
 
6105
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0/src/commands/project/deploy/cancel.ts)_
6101
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.3/src/commands/project/deploy/cancel.ts)_
6106
6102
 
6107
6103
  ## `sf project deploy preview`
6108
6104
 
@@ -6117,7 +6113,8 @@ FLAGS
6117
6113
  -c, --ignore-conflicts Don't display conflicts in preview of the deployment.
6118
6114
  -d, --source-dir=<value>... Path to the local source files to preview.
6119
6115
  -m, --metadata=<value>... Metadata component names to preview.
6120
- -o, --target-org=<value> (required) Login username or alias for the target org.
6116
+ -o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
6117
+ configuration variable is already set.
6121
6118
  -x, --manifest=<value> Full file path for manifest (package.xml) of components to preview.
6122
6119
  --concise Show only the changes that will be deployed; omits files that are forceignored.
6123
6120
 
@@ -6179,16 +6176,12 @@ FLAG DESCRIPTIONS
6179
6176
 
6180
6177
  If you specify this flag, don’t specify --metadata or --manifest.
6181
6178
 
6182
- -o, --target-org=<value> Login username or alias for the target org.
6183
-
6184
- Overrides your default org.
6185
-
6186
6179
  -x, --manifest=<value> Full file path for manifest (package.xml) of components to preview.
6187
6180
 
6188
6181
  All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.
6189
6182
  ```
6190
6183
 
6191
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0/src/commands/project/deploy/preview.ts)_
6184
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.3/src/commands/project/deploy/preview.ts)_
6192
6185
 
6193
6186
  ## `sf project deploy quick`
6194
6187
 
@@ -6202,7 +6195,7 @@ USAGE
6202
6195
  FLAGS
6203
6196
  -a, --api-version=<value> Target API version for the deploy.
6204
6197
  -i, --job-id=<value> Job ID of the deployment you want to quick deploy.
6205
- -o, --target-org=<value> Login username or alias for the target org.
6198
+ -o, --target-org=<value> Username or alias of the target org.
6206
6199
  -r, --use-most-recent Use the job ID of the most recently validated deployment.
6207
6200
  -w, --wait=<minutes> [default: 33 minutes] Number of minutes to wait for the command to complete and display
6208
6201
  results.
@@ -6254,10 +6247,6 @@ FLAG DESCRIPTIONS
6254
6247
 
6255
6248
  The job ID is valid for 10 days from when you started the validation.
6256
6249
 
6257
- -o, --target-org=<value> Login username or alias for the target org.
6258
-
6259
- Overrides your default org.
6260
-
6261
6250
  -r, --use-most-recent Use the job ID of the most recently validated deployment.
6262
6251
 
6263
6252
  For performance reasons, this flag uses only job IDs that were validated in the past 3 days or less. If your most
@@ -6285,7 +6274,7 @@ ERROR CODES
6285
6274
  Canceling (69) The deploy is being canceled.
6286
6275
  ```
6287
6276
 
6288
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0/src/commands/project/deploy/quick.ts)_
6277
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.3/src/commands/project/deploy/quick.ts)_
6289
6278
 
6290
6279
  ## `sf project deploy report`
6291
6280
 
@@ -6299,7 +6288,7 @@ USAGE
6299
6288
 
6300
6289
  FLAGS
6301
6290
  -i, --job-id=<value> Job ID of the deploy operation you want to check the status of.
6302
- -o, --target-org=<value> Login username or alias for the target org.
6291
+ -o, --target-org=<value> Username or alias of the target org.
6303
6292
  -r, --use-most-recent Use the job ID of the most recent deploy operation.
6304
6293
  -w, --wait=<minutes> Number of minutes to wait for command to complete and display results.
6305
6294
 
@@ -6358,10 +6347,6 @@ FLAG DESCRIPTIONS
6358
6347
 
6359
6348
  The job ID is valid for 10 days from when you started the deploy operation.
6360
6349
 
6361
- -o, --target-org=<value> Login username or alias for the target org.
6362
-
6363
- Overrides your default org.
6364
-
6365
6350
  -r, --use-most-recent Use the job ID of the most recent deploy operation.
6366
6351
 
6367
6352
  For performance reasons, this flag uses job IDs for deploy operations that started only in the past 3 days or less.
@@ -6381,7 +6366,7 @@ FLAG DESCRIPTIONS
6381
6366
  --coverage-formatters lcov --coverage-formatters clover
6382
6367
  ```
6383
6368
 
6384
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0/src/commands/project/deploy/report.ts)_
6369
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.3/src/commands/project/deploy/report.ts)_
6385
6370
 
6386
6371
  ## `sf project deploy resume`
6387
6372
 
@@ -6478,7 +6463,7 @@ ERROR CODES
6478
6463
  Canceling (69) The deploy is being canceled.
6479
6464
  ```
6480
6465
 
6481
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0/src/commands/project/deploy/resume.ts)_
6466
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.3/src/commands/project/deploy/resume.ts)_
6482
6467
 
6483
6468
  ## `sf project deploy start`
6484
6469
 
@@ -6497,7 +6482,8 @@ FLAGS
6497
6482
  -a, --api-version=<value> Target API version for the deploy.
6498
6483
  -c, --ignore-conflicts Ignore conflicts and deploy local files, even if they overwrite changes in the org.
6499
6484
  -g, --ignore-warnings Ignore warnings and allow a deployment to complete successfully.
6500
- -o, --target-org=<value> (required) Login username or alias for the target org.
6485
+ -o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
6486
+ configuration variable is already set.
6501
6487
  -r, --ignore-errors Ignore any errors and don’t roll back deployment.
6502
6488
  -w, --wait=<minutes> Number of minutes to wait for command to complete and display results.
6503
6489
  --async Run the command asynchronously.
@@ -6591,6 +6577,14 @@ EXAMPLES
6591
6577
 
6592
6578
  $ sf project deploy start --metadata 'ApexClass:MyApex*' --ignore-warnings
6593
6579
 
6580
+ Deploy a custom object called ExcitingObject that's in the SBQQ namespace:
6581
+
6582
+ $ sf project deploy start --metadata CustomObject:SBQQ__ExcitingObject
6583
+
6584
+ Deploy all custom objects in the SBQQ namespace by using a wildcard and quotes:
6585
+
6586
+ $ sf project deploy start --metadata 'CustomObject:SBQQ__*'
6587
+
6594
6588
  Deploy all custom objects and Apex classes found in all defined package directories (both examples are equivalent):
6595
6589
 
6596
6590
  $ sf project deploy start --metadata CustomObject ApexClass
@@ -6658,10 +6652,6 @@ FLAG DESCRIPTIONS
6658
6652
  Deployment](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm)
6659
6653
  in the "Metadata API Developer Guide".
6660
6654
 
6661
- -o, --target-org=<value> Login username or alias for the target org.
6662
-
6663
- Overrides your default org.
6664
-
6665
6655
  -r, --ignore-errors Ignore any errors and don’t roll back deployment.
6666
6656
 
6667
6657
  Never use this flag when deploying to a production org. If you specify it, components without errors are deployed
@@ -6716,7 +6706,7 @@ ERROR CODES
6716
6706
  Canceling (69) The deploy is being canceled.
6717
6707
  ```
6718
6708
 
6719
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0/src/commands/project/deploy/start.ts)_
6709
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.3/src/commands/project/deploy/start.ts)_
6720
6710
 
6721
6711
  ## `sf project deploy validate`
6722
6712
 
@@ -6733,7 +6723,8 @@ USAGE
6733
6723
  FLAGS
6734
6724
  -a, --api-version=<value> Target API version for the validation.
6735
6725
  -g, --ignore-warnings Ignore warnings and allow a deployment to complete successfully.
6736
- -o, --target-org=<value> (required) Login username or alias for the target org.
6726
+ -o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
6727
+ configuration variable is already set.
6737
6728
  -w, --wait=<minutes> Number of minutes to wait for the command to complete and display results.
6738
6729
  --async Run the command asynchronously.
6739
6730
  --concise Show concise output of the validation result.
@@ -6855,10 +6846,6 @@ FLAG DESCRIPTIONS
6855
6846
 
6856
6847
  - RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.
6857
6848
 
6858
- -o, --target-org=<value> Login username or alias for the target org.
6859
-
6860
- Overrides your default org.
6861
-
6862
6849
  -t, --tests=<value>... Apex tests to run when --test-level is RunSpecifiedTests.
6863
6850
 
6864
6851
  If a test name contains a space, enclose it in double quotes.
@@ -6908,7 +6895,7 @@ ERROR CODES
6908
6895
  Canceling (69) The deploy is being canceled.
6909
6896
  ```
6910
6897
 
6911
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0/src/commands/project/deploy/validate.ts)_
6898
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.3/src/commands/project/deploy/validate.ts)_
6912
6899
 
6913
6900
  ## `sf project generate`
6914
6901
 
@@ -7090,7 +7077,7 @@ EXAMPLES
7090
7077
  $ sf project generate manifest --from-org test@myorg.com --include-packages unlocked
7091
7078
  ```
7092
7079
 
7093
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0/src/commands/project/generate/manifest.ts)_
7080
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.3/src/commands/project/generate/manifest.ts)_
7094
7081
 
7095
7082
  ## `sf project list ignored`
7096
7083
 
@@ -7132,7 +7119,7 @@ EXAMPLES
7132
7119
  $ sf project list ignored --source-dir package.xml
7133
7120
  ```
7134
7121
 
7135
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0/src/commands/project/list/ignored.ts)_
7122
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.3/src/commands/project/list/ignored.ts)_
7136
7123
 
7137
7124
  ## `sf project reset tracking`
7138
7125
 
@@ -7181,7 +7168,7 @@ EXAMPLES
7181
7168
  $ sf project reset tracking --revision 30
7182
7169
  ```
7183
7170
 
7184
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0/src/commands/project/reset/tracking.ts)_
7171
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.3/src/commands/project/reset/tracking.ts)_
7185
7172
 
7186
7173
  ## `sf project retrieve preview`
7187
7174
 
@@ -7193,7 +7180,8 @@ USAGE
7193
7180
 
7194
7181
  FLAGS
7195
7182
  -c, --ignore-conflicts Don't display conflicts in the preview of the retrieval.
7196
- -o, --target-org=<value> (required) Login username or alias for the target org.
7183
+ -o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
7184
+ configuration variable is already set.
7197
7185
  --concise Show only the changes that will be retrieved; omits files that are forceignored.
7198
7186
 
7199
7187
  GLOBAL FLAGS
@@ -7232,13 +7220,9 @@ FLAG DESCRIPTIONS
7232
7220
 
7233
7221
  This flag applies only to orgs that allow source tracking. It has no effect on orgs that don't allow it, such as
7234
7222
  production orgs.
7235
-
7236
- -o, --target-org=<value> Login username or alias for the target org.
7237
-
7238
- Overrides your default org.
7239
7223
  ```
7240
7224
 
7241
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0/src/commands/project/retrieve/preview.ts)_
7225
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.3/src/commands/project/retrieve/preview.ts)_
7242
7226
 
7243
7227
  ## `sf project retrieve start`
7244
7228
 
@@ -7257,7 +7241,8 @@ FLAGS
7257
7241
  -m, --metadata=<value>... Metadata component names to retrieve. Wildcards (`*`) supported as long as you use
7258
7242
  quotes, such as `ApexClass:MyClass*`.
7259
7243
  -n, --package-name=<value>... Package names to retrieve.
7260
- -o, --target-org=<value> (required) Login username or alias for the target org.
7244
+ -o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
7245
+ configuration variable is already set.
7261
7246
  -r, --output-dir=<value> Directory root for the retrieved source files.
7262
7247
  -w, --wait=<value> [default: 33 minutes] Number of minutes to wait for the command to complete and display
7263
7248
  results to the terminal window.
@@ -7323,6 +7308,14 @@ EXAMPLES
7323
7308
 
7324
7309
  $ sf project retrieve start --metadata 'ApexClass:MyApex*'
7325
7310
 
7311
+ Retrieve a custom object called ExcitingObject that's in the SBQQ namespace:
7312
+
7313
+ $ sf project retrieve start --metadata CustomObject:SBQQ__ExcitingObject
7314
+
7315
+ Retrieve all custom objects in the SBQQ namespace by using a wildcard and quotes:
7316
+
7317
+ $ sf project retrieve start --metadata 'CustomObject:SBQQ__*'
7318
+
7326
7319
  Retrieve all custom objects and Apex classes found in all defined package directories (both examples are
7327
7320
  equivalent):
7328
7321
 
@@ -7370,10 +7363,6 @@ FLAG DESCRIPTIONS
7370
7363
  The supplied paths can be to a single file (in which case the operation is applied to only one file) or to a folder
7371
7364
  (in which case the operation is applied to all source files in the directory and its subdirectories).
7372
7365
 
7373
- -o, --target-org=<value> Login username or alias for the target org.
7374
-
7375
- Overrides your default org.
7376
-
7377
7366
  -r, --output-dir=<value> Directory root for the retrieved source files.
7378
7367
 
7379
7368
  The root of the directory structure into which the source files are retrieved.
@@ -7397,7 +7386,7 @@ ENVIRONMENT VARIABLES
7397
7386
  SF_USE_PROGRESS_BAR Set to false to disable the progress bar when running the metadata deploy command.
7398
7387
  ```
7399
7388
 
7400
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0/src/commands/project/retrieve/start.ts)_
7389
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.3/src/commands/project/retrieve/start.ts)_
7401
7390
 
7402
7391
  ## `sf schema generate field`
7403
7392