@@ -64,6 +64,7 @@ sf plugins
64
64
65
65
- [ ` sf project convert mdapi ` ] ( #sf-project-convert-mdapi )
66
66
- [ ` sf project convert source ` ] ( #sf-project-convert-source )
67
+ - [ ` sf project convert source-behavior ` ] ( #sf-project-convert-source-behavior )
67
68
- [ ` sf project delete source ` ] ( #sf-project-delete-source )
68
69
- [ ` sf project delete tracking ` ] ( #sf-project-delete-tracking )
69
70
- [ ` sf project deploy cancel ` ] ( #sf-project-deploy-cancel )
@@ -140,7 +141,7 @@ FLAG DESCRIPTIONS
140
141
If you specify this parameter, don’t specify --metadata or --source-dir.
141
142
```
142
143
143
- _ See code: [ src/commands/project/convert/mdapi.ts] ( https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10 /src/commands/project/convert/mdapi.ts ) _
144
+ _ See code: [ src/commands/project/convert/mdapi.ts] ( https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0 /src/commands/project/convert/mdapi.ts ) _
144
145
145
146
## ` sf project convert source `
146
147
@@ -152,7 +153,7 @@ USAGE
152
153
[-p <value> | -x <value> | -m <value>]
153
154
154
155
FLAGS
155
- -d, --output-dir=<value> [default: metadataPackage_1716916326517 ] Output directory to store the Metadata
156
+ -d, --output-dir=<value> [default: metadataPackage_1716992749510 ] Output directory to store the Metadata
156
157
API–formatted files in.
157
158
-m, --metadata=<value>... Metadata component names to convert.
158
159
-n, --package-name=<value> Name of the package to associate with the metadata-formatted files.
@@ -213,7 +214,64 @@ FLAG DESCRIPTIONS
213
214
Override the api version used for api requests made by this command
214
215
```
215
216
216
- _ See code: [ src/commands/project/convert/source.ts] ( https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10/src/commands/project/convert/source.ts ) _
217
+ _ See code: [ src/commands/project/convert/source.ts] ( https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0/src/commands/project/convert/source.ts ) _
218
+
219
+ ## ` sf project convert source-behavior `
220
+
221
+ Enable a behavior of your project source files, and then update your Salesforce DX project to implement the behavior.
222
+
223
+ ```
224
+ USAGE
225
+ $ sf project convert source-behavior -b
226
+ decomposeCustomLabelsBeta|decomposePermissionSetBeta|decomposeSharingRulesBeta|decomposeWorkflowBeta [--json]
227
+ [--flags-dir <value>] [--dry-run] [--preserve-temp-dir] [-o <value>]
228
+
229
+ FLAGS
230
+ -b, --behavior=<option> (required) Behavior to enable; the values correspond to the possible values of the
231
+ "sourceBehaviorOption" option in the "sfdx-project.json" file.
232
+ <options: decomposeCustomLabelsBeta|decomposePermissionSetBeta|decomposeSharingRulesBeta|dec
233
+ omposeWorkflowBeta>
234
+ -o, --target-org=<value>
235
+ --dry-run Display what the command would do, but don't make any actual changes.
236
+ --preserve-temp-dir Don't delete the metadata API format temporary directory that this command creates. Useful
237
+ for debugging.
238
+
239
+ GLOBAL FLAGS
240
+ --flags-dir=<value> Import flag values from a directory.
241
+ --json Format output as json.
242
+
243
+ DESCRIPTION
244
+ Enable a behavior of your project source files, and then update your Salesforce DX project to implement the behavior.
245
+
246
+ Specifically, this command updates the "sourceBehaviorOption" option in the "sfdx-project.json" file and then converts
247
+ the associated local source files in your project as needed.
248
+
249
+ For example, run this command with the "--behavior decomposePermissionSetBeta" flag to start decomposing permission
250
+ sets when you deploy or retrieve them. Decomposing means breaking up the monolithic metadata API format XML file that
251
+ corresponds to a metadata component into smaller XML files and directories based on its subtypes. Permission sets are
252
+ not decomposed by default; you must opt-in to start decomposing them by using this command. When the command finishes,
253
+ your "sfdx-project.json" file is updated to always decompose permission sets, and the existing permission set files in
254
+ your local package directories are converted into the new decomposed format. You run this command only once for a
255
+ given behavior change.
256
+
257
+ For more information about the possible values for the --behavior flag, see the "sourceBehaviorOptions" section in the
258
+ https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_ws_config.htm topic.
259
+
260
+ EXAMPLES
261
+ Update your Salesforce DX project to decompose custom labels:
262
+
263
+ $ sf project convert source-behavior --behavior decomposeCustomLabelsBeta
264
+
265
+ Display what the command would do, but don't change any existing files:
266
+
267
+ $ sf project convert source-behavior --behavior decomposeCustomLabelsBeta --dry-run
268
+
269
+ Keep the temporary directory that contains the interim metadata API formatted files:
270
+
271
+ $ sf project convert source-behavior --behavior decomposeCustomLabelsBeta --dry-run --preserve-temp-dir
272
+ ```
273
+
274
+ _ See code: [ src/commands/project/convert/source-behavior.ts] ( https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0/src/commands/project/convert/source-behavior.ts ) _
217
275
218
276
## ` sf project delete source `
219
277
@@ -353,7 +411,7 @@ FLAG DESCRIPTIONS
353
411
- Separate the test names with spaces: --tests Test1 Test2 "Test With Space"
354
412
```
355
413
356
- _ See code: [ src/commands/project/delete/source.ts] ( https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10 /src/commands/project/delete/source.ts ) _
414
+ _ See code: [ src/commands/project/delete/source.ts] ( https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0 /src/commands/project/delete/source.ts ) _
357
415
358
416
## ` sf project delete tracking `
359
417
@@ -390,7 +448,7 @@ EXAMPLES
390
448
$ sf project delete tracking --target-org my-scratch
391
449
```
392
450
393
- _ See code: [ src/commands/project/delete/tracking.ts] ( https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10 /src/commands/project/delete/tracking.ts ) _
451
+ _ See code: [ src/commands/project/delete/tracking.ts] ( https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0 /src/commands/project/delete/tracking.ts ) _
394
452
395
453
## ` sf project deploy cancel `
396
454
@@ -466,7 +524,7 @@ FLAG DESCRIPTIONS
466
524
project deploy report".
467
525
```
468
526
469
- _ See code: [ src/commands/project/deploy/cancel.ts] ( https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10 /src/commands/project/deploy/cancel.ts ) _
527
+ _ See code: [ src/commands/project/deploy/cancel.ts] ( https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0 /src/commands/project/deploy/cancel.ts ) _
470
528
471
529
## ` sf project deploy preview `
472
530
@@ -552,7 +610,7 @@ FLAG DESCRIPTIONS
552
610
All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.
553
611
```
554
612
555
- _ See code: [ src/commands/project/deploy/preview.ts] ( https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10 /src/commands/project/deploy/preview.ts ) _
613
+ _ See code: [ src/commands/project/deploy/preview.ts] ( https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0 /src/commands/project/deploy/preview.ts ) _
556
614
557
615
## ` sf project deploy quick `
558
616
@@ -640,7 +698,7 @@ FLAG DESCRIPTIONS
640
698
deploy report".
641
699
```
642
700
643
- _ See code: [ src/commands/project/deploy/quick.ts] ( https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10 /src/commands/project/deploy/quick.ts ) _
701
+ _ See code: [ src/commands/project/deploy/quick.ts] ( https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0 /src/commands/project/deploy/quick.ts ) _
644
702
645
703
## ` sf project deploy report `
646
704
@@ -736,7 +794,7 @@ FLAG DESCRIPTIONS
736
794
--coverage-formatters lcov --coverage-formatters clover
737
795
```
738
796
739
- _ See code: [ src/commands/project/deploy/report.ts] ( https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10 /src/commands/project/deploy/report.ts ) _
797
+ _ See code: [ src/commands/project/deploy/report.ts] ( https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0 /src/commands/project/deploy/report.ts ) _
740
798
741
799
## ` sf project deploy resume `
742
800
@@ -821,7 +879,7 @@ FLAG DESCRIPTIONS
821
879
--coverage-formatters lcov --coverage-formatters clover
822
880
```
823
881
824
- _ See code: [ src/commands/project/deploy/resume.ts] ( https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10 /src/commands/project/deploy/resume.ts ) _
882
+ _ See code: [ src/commands/project/deploy/resume.ts] ( https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0 /src/commands/project/deploy/resume.ts ) _
825
883
826
884
## ` sf project deploy start `
827
885
@@ -1042,7 +1100,7 @@ FLAG DESCRIPTIONS
1042
1100
--coverage-formatters lcov --coverage-formatters clover
1043
1101
```
1044
1102
1045
- _ See code: [ src/commands/project/deploy/start.ts] ( https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10 /src/commands/project/deploy/start.ts ) _
1103
+ _ See code: [ src/commands/project/deploy/start.ts] ( https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0 /src/commands/project/deploy/start.ts ) _
1046
1104
1047
1105
## ` sf project deploy validate `
1048
1106
@@ -1217,7 +1275,7 @@ FLAG DESCRIPTIONS
1217
1275
--coverage-formatters lcov --coverage-formatters clover
1218
1276
```
1219
1277
1220
- _ See code: [ src/commands/project/deploy/validate.ts] ( https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10 /src/commands/project/deploy/validate.ts ) _
1278
+ _ See code: [ src/commands/project/deploy/validate.ts] ( https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0 /src/commands/project/deploy/validate.ts ) _
1221
1279
1222
1280
## ` sf project generate manifest `
1223
1281
@@ -1294,7 +1352,7 @@ EXAMPLES
1294
1352
$ sf project generate manifest --from-org [email protected] --include-packages unlocked
1295
1353
```
1296
1354
1297
- _ See code: [ src/commands/project/generate/manifest.ts] ( https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10 /src/commands/project/generate/manifest.ts ) _
1355
+ _ See code: [ src/commands/project/generate/manifest.ts] ( https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0 /src/commands/project/generate/manifest.ts ) _
1298
1356
1299
1357
## ` sf project list ignored `
1300
1358
@@ -1336,7 +1394,7 @@ EXAMPLES
1336
1394
$ sf project list ignored --source-dir package.xml
1337
1395
```
1338
1396
1339
- _ See code: [ src/commands/project/list/ignored.ts] ( https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10 /src/commands/project/list/ignored.ts ) _
1397
+ _ See code: [ src/commands/project/list/ignored.ts] ( https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0 /src/commands/project/list/ignored.ts ) _
1340
1398
1341
1399
## ` sf project reset tracking `
1342
1400
@@ -1385,7 +1443,7 @@ EXAMPLES
1385
1443
$ sf project reset tracking --revision 30
1386
1444
```
1387
1445
1388
- _ See code: [ src/commands/project/reset/tracking.ts] ( https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10 /src/commands/project/reset/tracking.ts ) _
1446
+ _ See code: [ src/commands/project/reset/tracking.ts] ( https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0 /src/commands/project/reset/tracking.ts ) _
1389
1447
1390
1448
## ` sf project retrieve preview `
1391
1449
@@ -1442,7 +1500,7 @@ FLAG DESCRIPTIONS
1442
1500
Overrides your default org.
1443
1501
```
1444
1502
1445
- _ See code: [ src/commands/project/retrieve/preview.ts] ( https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10 /src/commands/project/retrieve/preview.ts ) _
1503
+ _ See code: [ src/commands/project/retrieve/preview.ts] ( https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0 /src/commands/project/retrieve/preview.ts ) _
1446
1504
1447
1505
## ` sf project retrieve start `
1448
1506
@@ -1593,6 +1651,6 @@ FLAG DESCRIPTIONS
1593
1651
If you specify this parameter, don’t specify --metadata or --source-dir.
1594
1652
```
1595
1653
1596
- _ See code: [ src/commands/project/retrieve/start.ts] ( https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.7.10 /src/commands/project/retrieve/start.ts ) _
1654
+ _ See code: [ src/commands/project/retrieve/start.ts] ( https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.8.0 /src/commands/project/retrieve/start.ts ) _
1597
1655
1598
1656
<!-- commandsstop -->
0 commit comments