@salesforce/plugin-deploy-retrieve 3.15.8 → 3.15.9

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
@@ -112,7 +112,7 @@ DESCRIPTION
112
112
 
113
113
  To convert multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with
114
114
  multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax
115
- applies to --manifest and --source-dir.
115
+ applies to --source-dir.
116
116
 
117
117
  ALIASES
118
118
  $ sf force mdapi convert
@@ -138,10 +138,10 @@ FLAG DESCRIPTIONS
138
138
 
139
139
  -x, --manifest=<value> File path to manifest (package.xml) of metadata types to convert.
140
140
 
141
- If you specify this parameter, don’t specify --metadata or --source-dir.
141
+ If you specify this flag, don’t specify --metadata or --source-dir.
142
142
  ```
143
143
 
144
- _See code: [src/commands/project/convert/mdapi.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.15.8/src/commands/project/convert/mdapi.ts)_
144
+ _See code: [src/commands/project/convert/mdapi.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.15.9/src/commands/project/convert/mdapi.ts)_
145
145
 
146
146
  ## `sf project convert source`
147
147
 
@@ -179,7 +179,7 @@ DESCRIPTION
179
179
 
180
180
  To convert multiple components, either set multiple --metadata <name> flags or a single --metadata flag with multiple
181
181
  names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to
182
- --manifest and --source-dir.
182
+ --source-dir.
183
183
 
184
184
  ALIASES
185
185
  $ sf force source convert
@@ -201,11 +201,11 @@ FLAG DESCRIPTIONS
201
201
  The supplied paths can be to a single file (in which case the operation is applied to only one file) or to a folder
202
202
  (in which case the operation is applied to all metadata types in the directory and its sub-directories).
203
203
 
204
- If you specify this parameter, don’t specify --manifest or --metadata.
204
+ If you specify this flag, don’t specify --manifest or --metadata.
205
205
 
206
206
  -x, --manifest=<value> Path to the manifest (package.xml) file that specifies the metadata types to convert.
207
207
 
208
- If you specify this parameter, don’t specify --metadata or --source-dir.
208
+ If you specify this flag, don’t specify --metadata or --source-dir.
209
209
 
210
210
  --api-version=<value>
211
211
 
@@ -214,7 +214,7 @@ FLAG DESCRIPTIONS
214
214
  Override the api version used for api requests made by this command
215
215
  ```
216
216
 
217
- _See code: [src/commands/project/convert/source.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.15.8/src/commands/project/convert/source.ts)_
217
+ _See code: [src/commands/project/convert/source.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.15.9/src/commands/project/convert/source.ts)_
218
218
 
219
219
  ## `sf project convert source-behavior`
220
220
 
@@ -272,7 +272,7 @@ EXAMPLES
272
272
  $ sf project convert source-behavior --behavior decomposePermissionSetBeta --dry-run --preserve-temp-dir
273
273
  ```
274
274
 
275
- _See code: [src/commands/project/convert/source-behavior.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.15.8/src/commands/project/convert/source-behavior.ts)_
275
+ _See code: [src/commands/project/convert/source-behavior.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.15.9/src/commands/project/convert/source-behavior.ts)_
276
276
 
277
277
  ## `sf project delete source`
278
278
 
@@ -316,7 +316,7 @@ DESCRIPTION
316
316
 
317
317
  To delete multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with
318
318
  multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax
319
- applies to --manifest and --source-dir.
319
+ applies to --source-dir.
320
320
 
321
321
  ALIASES
322
322
  $ sf force source delete
@@ -349,9 +349,9 @@ FLAG DESCRIPTIONS
349
349
  Validates the deleted metadata and runs all Apex tests, but prevents the deletion from being saved to the org.
350
350
 
351
351
  If you change a field type from Master-Detail to Lookup or vice versa, that change isn’t supported when using the
352
- --check-only parameter to test a deletion (validation). This kind of change isn’t supported for test deletions to
353
- avoid the risk of data loss or corruption. If a change that isn’t supported for test deletions is included in a
354
- deletion package, the test deletion fails and issues an error.
352
+ --check-only flag to test a deletion (validation). This kind of change isn’t supported for test deletions to avoid
353
+ the risk of data loss or corruption. If a change that isn’t supported for test deletions is included in a deletion
354
+ package, the test deletion fails and issues an error.
355
355
 
356
356
  If your deletion package changes a field type from Master-Detail to Lookup or vice versa, you can still validate the
357
357
  changes prior to deploying to Production by performing a full deletion to another test Sandbox. A full deletion
@@ -390,14 +390,14 @@ FLAG DESCRIPTIONS
390
390
 
391
391
  -m, --metadata=<value>... Metadata components to delete.
392
392
 
393
- If you specify this parameter, don’t specify --source-dir.
393
+ If you specify this flag, don’t specify --source-dir.
394
394
 
395
395
  -p, --source-dir=<value>... Source file paths to delete.
396
396
 
397
397
  The supplied paths can be a single file (in which case the operation is applied to only one file) or a folder (in
398
398
  which case the operation is applied to all metadata types in the directory and its sub-directories).
399
399
 
400
- If you specify this parameter, don’t specify --metadata.
400
+ If you specify this flag, don’t specify --metadata.
401
401
 
402
402
  -w, --wait=<value> Number of minutes to wait for the command to finish.
403
403
 
@@ -412,7 +412,7 @@ FLAG DESCRIPTIONS
412
412
  - Separate the test names with spaces: --tests Test1 Test2 "Test With Space"
413
413
  ```
414
414
 
415
- _See code: [src/commands/project/delete/source.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.15.8/src/commands/project/delete/source.ts)_
415
+ _See code: [src/commands/project/delete/source.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.15.9/src/commands/project/delete/source.ts)_
416
416
 
417
417
  ## `sf project delete tracking`
418
418
 
@@ -449,7 +449,7 @@ EXAMPLES
449
449
  $ sf project delete tracking --target-org my-scratch
450
450
  ```
451
451
 
452
- _See code: [src/commands/project/delete/tracking.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.15.8/src/commands/project/delete/tracking.ts)_
452
+ _See code: [src/commands/project/delete/tracking.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.15.9/src/commands/project/delete/tracking.ts)_
453
453
 
454
454
  ## `sf project deploy cancel`
455
455
 
@@ -521,7 +521,7 @@ FLAG DESCRIPTIONS
521
521
  project deploy report".
522
522
  ```
523
523
 
524
- _See code: [src/commands/project/deploy/cancel.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.15.8/src/commands/project/deploy/cancel.ts)_
524
+ _See code: [src/commands/project/deploy/cancel.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.15.9/src/commands/project/deploy/cancel.ts)_
525
525
 
526
526
  ## `sf project deploy preview`
527
527
 
@@ -562,7 +562,7 @@ DESCRIPTION
562
562
 
563
563
  To preview the deployment of multiple metadata components, either set multiple --metadata <name> flags or a single
564
564
  --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double
565
- quotes. The same syntax applies to --manifest and --source-dir.
565
+ quotes. The same syntax applies to --source-dir.
566
566
 
567
567
  ALIASES
568
568
  $ sf deploy metadata preview
@@ -604,7 +604,7 @@ FLAG DESCRIPTIONS
604
604
  All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.
605
605
  ```
606
606
 
607
- _See code: [src/commands/project/deploy/preview.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.15.8/src/commands/project/deploy/preview.ts)_
607
+ _See code: [src/commands/project/deploy/preview.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.15.9/src/commands/project/deploy/preview.ts)_
608
608
 
609
609
  ## `sf project deploy quick`
610
610
 
@@ -688,7 +688,7 @@ FLAG DESCRIPTIONS
688
688
  deploy report".
689
689
  ```
690
690
 
691
- _See code: [src/commands/project/deploy/quick.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.15.8/src/commands/project/deploy/quick.ts)_
691
+ _See code: [src/commands/project/deploy/quick.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.15.9/src/commands/project/deploy/quick.ts)_
692
692
 
693
693
  ## `sf project deploy report`
694
694
 
@@ -780,7 +780,7 @@ FLAG DESCRIPTIONS
780
780
  --coverage-formatters lcov --coverage-formatters clover
781
781
  ```
782
782
 
783
- _See code: [src/commands/project/deploy/report.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.15.8/src/commands/project/deploy/report.ts)_
783
+ _See code: [src/commands/project/deploy/report.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.15.9/src/commands/project/deploy/report.ts)_
784
784
 
785
785
  ## `sf project deploy resume`
786
786
 
@@ -865,7 +865,7 @@ FLAG DESCRIPTIONS
865
865
  --coverage-formatters lcov --coverage-formatters clover
866
866
  ```
867
867
 
868
- _See code: [src/commands/project/deploy/resume.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.15.8/src/commands/project/deploy/resume.ts)_
868
+ _See code: [src/commands/project/deploy/resume.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.15.9/src/commands/project/deploy/resume.ts)_
869
869
 
870
870
  ## `sf project deploy start`
871
871
 
@@ -942,7 +942,7 @@ DESCRIPTION
942
942
 
943
943
  To deploy multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with
944
944
  multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax
945
- applies to --manifest and --source-dir.
945
+ applies to --source-dir.
946
946
 
947
947
  ALIASES
948
948
  $ sf deploy metadata
@@ -1101,7 +1101,7 @@ FLAG DESCRIPTIONS
1101
1101
  --coverage-formatters lcov --coverage-formatters clover
1102
1102
  ```
1103
1103
 
1104
- _See code: [src/commands/project/deploy/start.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.15.8/src/commands/project/deploy/start.ts)_
1104
+ _See code: [src/commands/project/deploy/start.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.15.9/src/commands/project/deploy/start.ts)_
1105
1105
 
1106
1106
  ## `sf project deploy validate`
1107
1107
 
@@ -1175,7 +1175,7 @@ DESCRIPTION
1175
1175
 
1176
1176
  To validate the deployment of multiple metadata components, either set multiple --metadata <name> flags or a single
1177
1177
  --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double
1178
- quotes. The same syntax applies to --manifest and --source-dir.
1178
+ quotes. The same syntax applies to --source-dir.
1179
1179
 
1180
1180
  Note: Don't use this command on sandboxes; the command is intended to be used on production orgs. By default,
1181
1181
  sandboxes don't run tests during a deploy. If you want to validate a deployment with tests on a sandbox, use "sf
@@ -1274,7 +1274,7 @@ FLAG DESCRIPTIONS
1274
1274
  --coverage-formatters lcov --coverage-formatters clover
1275
1275
  ```
1276
1276
 
1277
- _See code: [src/commands/project/deploy/validate.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.15.8/src/commands/project/deploy/validate.ts)_
1277
+ _See code: [src/commands/project/deploy/validate.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.15.9/src/commands/project/deploy/validate.ts)_
1278
1278
 
1279
1279
  ## `sf project generate manifest`
1280
1280
 
@@ -1308,10 +1308,10 @@ DESCRIPTION
1308
1308
  Create a project manifest that lists the metadata components you want to deploy or retrieve.
1309
1309
 
1310
1310
  Create a manifest from a list of metadata components (--metadata) or from one or more local directories that contain
1311
- source files (--source-dir). You can specify either of these parameters, not both.
1311
+ source files (--source-dir). You can specify either of these flags, not both.
1312
1312
 
1313
1313
  Use --type to specify the type of manifest you want to create. The resulting manifest files have specific names, such
1314
- as the standard package.xml or destructiveChanges.xml to delete metadata. Valid values for this parameter, and their
1314
+ as the standard package.xml or destructiveChanges.xml to delete metadata. Valid values for this flag, and their
1315
1315
  respective file names, are:
1316
1316
 
1317
1317
  * package : package.xml (default)
@@ -1351,7 +1351,7 @@ EXAMPLES
1351
1351
  $ sf project generate manifest --from-org test@myorg.com --include-packages unlocked
1352
1352
  ```
1353
1353
 
1354
- _See code: [src/commands/project/generate/manifest.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.15.8/src/commands/project/generate/manifest.ts)_
1354
+ _See code: [src/commands/project/generate/manifest.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.15.9/src/commands/project/generate/manifest.ts)_
1355
1355
 
1356
1356
  ## `sf project list ignored`
1357
1357
 
@@ -1393,7 +1393,7 @@ EXAMPLES
1393
1393
  $ sf project list ignored --source-dir package.xml
1394
1394
  ```
1395
1395
 
1396
- _See code: [src/commands/project/list/ignored.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.15.8/src/commands/project/list/ignored.ts)_
1396
+ _See code: [src/commands/project/list/ignored.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.15.9/src/commands/project/list/ignored.ts)_
1397
1397
 
1398
1398
  ## `sf project reset tracking`
1399
1399
 
@@ -1423,8 +1423,8 @@ DESCRIPTION
1423
1423
  files and those in the org. When you next run 'project deploy preview', Salesforce CLI returns no results, even though
1424
1424
  conflicts might actually exist. Salesforce CLI then resumes tracking new source changes as usual.
1425
1425
 
1426
- Use the --revision parameter to reset source tracking to a specific revision number of an org source member. To get
1427
- the revision number, query the SourceMember Tooling API object with the 'data soql' command. For example:
1426
+ Use the --revision flag to reset source tracking to a specific revision number of an org source member. To get the
1427
+ revision number, query the SourceMember Tooling API object with the 'data soql' command. For example:
1428
1428
 
1429
1429
  sf data query --query "SELECT MemberName, MemberType, RevisionCounter FROM SourceMember" --use-tooling-api
1430
1430
  --target-org my-scratch
@@ -1442,7 +1442,7 @@ EXAMPLES
1442
1442
  $ sf project reset tracking --revision 30
1443
1443
  ```
1444
1444
 
1445
- _See code: [src/commands/project/reset/tracking.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.15.8/src/commands/project/reset/tracking.ts)_
1445
+ _See code: [src/commands/project/reset/tracking.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.15.9/src/commands/project/reset/tracking.ts)_
1446
1446
 
1447
1447
  ## `sf project retrieve preview`
1448
1448
 
@@ -1496,7 +1496,7 @@ FLAG DESCRIPTIONS
1496
1496
  production orgs.
1497
1497
  ```
1498
1498
 
1499
- _See code: [src/commands/project/retrieve/preview.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.15.8/src/commands/project/retrieve/preview.ts)_
1499
+ _See code: [src/commands/project/retrieve/preview.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.15.9/src/commands/project/retrieve/preview.ts)_
1500
1500
 
1501
1501
  ## `sf project retrieve start`
1502
1502
 
@@ -1549,7 +1549,7 @@ DESCRIPTION
1549
1549
 
1550
1550
  To retrieve multiple metadata components, either use multiple --metadata <name> flags or use a single --metadata flag
1551
1551
  with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same
1552
- syntax applies to --manifest and --source-dir.
1552
+ syntax applies to --source-dir.
1553
1553
 
1554
1554
  ALIASES
1555
1555
  $ sf retrieve metadata
@@ -1662,9 +1662,9 @@ FLAG DESCRIPTIONS
1662
1662
 
1663
1663
  -x, --manifest=<value> File path for the manifest (package.xml) that specifies the components to retrieve.
1664
1664
 
1665
- If you specify this parameter, don’t specify --metadata or --source-dir.
1665
+ If you specify this flag, don’t specify --metadata or --source-dir.
1666
1666
  ```
1667
1667
 
1668
- _See code: [src/commands/project/retrieve/start.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.15.8/src/commands/project/retrieve/start.ts)_
1668
+ _See code: [src/commands/project/retrieve/start.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.15.9/src/commands/project/retrieve/start.ts)_
1669
1669
 
1670
1670
  <!-- commandsstop -->
@@ -8,7 +8,7 @@ To use Salesforce CLI to work with components that you retrieved via Metadata AP
8
8
 
9
9
  To convert files from the source format back to the metadata format, run "sf project convert source".
10
10
 
11
- To convert multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.
11
+ To convert multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --source-dir.
12
12
 
13
13
  # examples
14
14
 
@@ -42,7 +42,7 @@ Metadata component names to convert.
42
42
 
43
43
  # flags.manifest.description
44
44
 
45
- If you specify this parameter, don’t specify --metadata or --source-dir.
45
+ If you specify this flag, don’t specify --metadata or --source-dir.
46
46
 
47
47
  # flags.metadata-dir.description
48
48
 
@@ -60,7 +60,7 @@ Expected a file but found a directory.
60
60
 
61
61
  # InvalidFlagPath
62
62
 
63
- The %s command parameter specifies an invalid path: %s
63
+ The %s command flag specifies an invalid path: %s
64
64
  %s
65
65
 
66
66
  # notFound
@@ -10,7 +10,7 @@ To convert Metadata API–formatted files into the source format, run "<%= confi
10
10
 
11
11
  To specify a package name that includes spaces, enclose the name in single quotes.
12
12
 
13
- To convert multiple components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.
13
+ To convert multiple components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --source-dir.
14
14
 
15
15
  # examples
16
16
 
@@ -52,13 +52,13 @@ Metadata component names to convert.
52
52
 
53
53
  # flags.manifest.description
54
54
 
55
- If you specify this parameter, don’t specify --metadata or --source-dir.
55
+ If you specify this flag, don’t specify --metadata or --source-dir.
56
56
 
57
57
  # flags.source-dir.description
58
58
 
59
59
  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 metadata types in the directory and its sub-directories).
60
60
 
61
- If you specify this parameter, don’t specify --manifest or --metadata.
61
+ If you specify this flag, don’t specify --manifest or --metadata.
62
62
 
63
63
  # success
64
64
 
@@ -8,7 +8,7 @@ Use this command to delete components from orgs that don’t have source trackin
8
8
 
9
9
  When you run this command, both the local source file and the metadata component in the org are deleted.
10
10
 
11
- To delete multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.
11
+ To delete multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --source-dir.
12
12
 
13
13
  # examples
14
14
 
@@ -70,7 +70,7 @@ IMPORTANT: Where possible, we changed noninclusive terms to align with our compa
70
70
 
71
71
  Validates the deleted metadata and runs all Apex tests, but prevents the deletion from being saved to the org.
72
72
 
73
- If you change a field type from Master-Detail to Lookup or vice versa, that change isn’t supported when using the --check-only parameter to test a deletion (validation). This kind of change isn’t supported for test deletions to avoid the risk of data loss or corruption. If a change that isn’t supported for test deletions is included in a deletion package, the test deletion fails and issues an error.
73
+ If you change a field type from Master-Detail to Lookup or vice versa, that change isn’t supported when using the --check-only flag to test a deletion (validation). This kind of change isn’t supported for test deletions to avoid the risk of data loss or corruption. If a change that isn’t supported for test deletions is included in a deletion package, the test deletion fails and issues an error.
74
74
 
75
75
  If your deletion package changes a field type from Master-Detail to Lookup or vice versa, you can still validate the changes prior to deploying to Production by performing a full deletion to another test Sandbox. A full deletion includes a validation of the changes as part of the deletion process.
76
76
 
@@ -82,13 +82,13 @@ Note: A Metadata API deletion that includes Master-Detail relationships deletes
82
82
 
83
83
  # flags.metadata.description
84
84
 
85
- If you specify this parameter, don’t specify --source-dir.
85
+ If you specify this flag, don’t specify --source-dir.
86
86
 
87
87
  # flags.source-dir.description
88
88
 
89
89
  The supplied paths can be a single file (in which case the operation is applied to only one file) or a folder (in which case the operation is applied to all metadata types in the directory and its sub-directories).
90
90
 
91
- If you specify this parameter, don’t specify --metadata.
91
+ If you specify this flag, don’t specify --metadata.
92
92
 
93
93
  # flags.wait.description
94
94
 
@@ -8,7 +8,7 @@ WARNING: This command deletes or overwrites all existing source tracking files.
8
8
 
9
9
  Resets local and remote source tracking so that Salesforce CLI no longer registers differences between your local files and those in the org. When you next run 'project deploy preview', Salesforce CLI returns no results, even though conflicts might actually exist. Salesforce CLI then resumes tracking new source changes as usual.
10
10
 
11
- Use the --revision parameter to reset source tracking to a specific revision number of an org source member. To get the revision number, query the SourceMember Tooling API object with the 'data soql' command. For example:
11
+ Use the --revision flag to reset source tracking to a specific revision number of an org source member. To get the revision number, query the SourceMember Tooling API object with the 'data soql' command. For example:
12
12
 
13
13
  <%= config.bin %> data query --query "SELECT MemberName, MemberType, RevisionCounter FROM SourceMember" --use-tooling-api --target-org my-scratch
14
14
 
@@ -10,7 +10,7 @@ Metadata components are deployed in source format by default. Deploy them in met
10
10
 
11
11
  If your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production orgs, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the "<%= config.bin %> org create scratch|sandbox" commands.
12
12
 
13
- To deploy multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.
13
+ To deploy multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --source-dir.
14
14
 
15
15
  # examples
16
16
 
@@ -10,7 +10,7 @@ The command outputs a table that describes what will happen if you run the "<%=
10
10
 
11
11
  If your org allows source tracking, then this command displays potential conflicts between the org and your local project. Some orgs, such as production org, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the "<%= config.bin %> org create scratch|sandbox" commands.
12
12
 
13
- To preview the deployment of multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.
13
+ To preview the deployment of multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --source-dir.
14
14
 
15
15
  # examples
16
16
 
@@ -10,7 +10,7 @@ You must run this command from within a project.
10
10
 
11
11
  This command doesn't support source-tracking. When you quick deploy with the resulting job ID, the source you deploy overwrites the corresponding metadata in your org.
12
12
 
13
- To validate the deployment of multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.
13
+ To validate the deployment of multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --source-dir.
14
14
 
15
15
  Note: Don't use this command on sandboxes; the command is intended to be used on production orgs. By default, sandboxes don't run tests during a deploy. If you want to validate a deployment with tests on a sandbox, use "<%= config.bin %> project deploy start --dry-run --test-level RunLocalTests" instead.
16
16
 
@@ -4,9 +4,9 @@ Create a project manifest that lists the metadata components you want to deploy
4
4
 
5
5
  # description
6
6
 
7
- Create a manifest from a list of metadata components (--metadata) or from one or more local directories that contain source files (--source-dir). You can specify either of these parameters, not both.
7
+ Create a manifest from a list of metadata components (--metadata) or from one or more local directories that contain source files (--source-dir). You can specify either of these flags, not both.
8
8
 
9
- Use --type to specify the type of manifest you want to create. The resulting manifest files have specific names, such as the standard package.xml or destructiveChanges.xml to delete metadata. Valid values for this parameter, and their respective file names, are:
9
+ Use --type to specify the type of manifest you want to create. The resulting manifest files have specific names, such as the standard package.xml or destructiveChanges.xml to delete metadata. Valid values for this flag, and their respective file names, are:
10
10
 
11
11
  * package : package.xml (default)
12
12
  * pre : destructiveChangesPre.xml
@@ -10,7 +10,7 @@ Metadata components are retrieved in source format by default. Retrieve them in
10
10
 
11
11
  If your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production orgs, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the "<%= config.bin %> org create scratch|sandbox" commands.
12
12
 
13
- To retrieve multiple metadata components, either use multiple --metadata <name> flags or use a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.
13
+ To retrieve multiple metadata components, either use multiple --metadata <name> flags or use a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --source-dir.
14
14
 
15
15
  # examples
16
16
 
@@ -95,7 +95,7 @@ File path for the manifest (package.xml) that specifies the components to retrie
95
95
 
96
96
  # flags.manifest.description
97
97
 
98
- If you specify this parameter, don’t specify --metadata or --source-dir.
98
+ If you specify this flag, don’t specify --metadata or --source-dir.
99
99
 
100
100
  # flags.metadata.summary
101
101
 
@@ -6,7 +6,7 @@
6
6
  ],
7
7
  "args": {},
8
8
  "deprecateAliases": true,
9
- "description": "To 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 this command.\n\nTo convert files from the source format back to the metadata format, run \"sf project convert source\".\n\nTo convert multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.",
9
+ "description": "To 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 this command.\n\nTo convert files from the source format back to the metadata format, run \"sf project convert source\".\n\nTo convert multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --source-dir.",
10
10
  "examples": [
11
11
  "Convert metadata formatted files in the specified directory into source formatted files; writes converted files to your default package directory:\n$ <%= config.bin %> <%= command.id %> --root-dir path/to/metadata",
12
12
  "Similar to previous example, but writes converted files to the specified output directory:\n$ <%= config.bin %> <%= command.id %> --root-dir path/to/metadata --output-dir path/to/outputdir"
@@ -75,7 +75,7 @@
75
75
  },
76
76
  "manifest": {
77
77
  "char": "x",
78
- "description": "If you specify this parameter, don’t specify --metadata or --source-dir.",
78
+ "description": "If you specify this flag, don’t specify --metadata or --source-dir.",
79
79
  "name": "manifest",
80
80
  "summary": "File path to manifest (package.xml) of metadata types to convert.",
81
81
  "hasDynamicHelp": false,
@@ -248,7 +248,7 @@
248
248
  ],
249
249
  "args": {},
250
250
  "deprecateAliases": true,
251
- "description": "To convert source-formatted files into the metadata format, so that you can deploy them using Metadata API, run this command. Then deploy the metadata using \"<%= config.bin %> project deploy\".\n\nTo convert Metadata API–formatted files into the source format, run \"<%= config.bin %> project convert mdapi\".\n\nTo specify a package name that includes spaces, enclose the name in single quotes.\n\nTo convert multiple components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.",
251
+ "description": "To convert source-formatted files into the metadata format, so that you can deploy them using Metadata API, run this command. Then deploy the metadata using \"<%= config.bin %> project deploy\".\n\nTo convert Metadata API–formatted files into the source format, run \"<%= config.bin %> project convert mdapi\".\n\nTo specify a package name that includes spaces, enclose the name in single quotes.\n\nTo convert multiple components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --source-dir.",
252
252
  "examples": [
253
253
  "Convert source-formatted files in the specified directory into metadata-formatted files; writes converted files into a new directory:\n$ <%= config.bin %> <%= command.id %> --root-dir path/to/source",
254
254
  "Similar to previous example, but writes converted files to the specified output directory and associates the files with the specified package:\n$ <%= config.bin %> <%= command.id %> --root-dir path/to/source --output-dir path/to/outputdir --package-name 'My Package'"
@@ -330,7 +330,7 @@
330
330
  },
331
331
  "manifest": {
332
332
  "char": "x",
333
- "description": "If you specify this parameter, don’t specify --metadata or --source-dir.",
333
+ "description": "If you specify this flag, don’t specify --metadata or --source-dir.",
334
334
  "name": "manifest",
335
335
  "summary": "Path to the manifest (package.xml) file that specifies the metadata types to convert.",
336
336
  "hasDynamicHelp": false,
@@ -343,7 +343,7 @@
343
343
  ],
344
344
  "char": "p",
345
345
  "deprecateAliases": true,
346
- "description": "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 metadata types in the directory and its sub-directories).\n\nIf you specify this parameter, don’t specify --manifest or --metadata.",
346
+ "description": "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 metadata types in the directory and its sub-directories).\n\nIf you specify this flag, don’t specify --manifest or --metadata.",
347
347
  "exclusive": [
348
348
  "manifest",
349
349
  "metadata"
@@ -410,7 +410,7 @@
410
410
  ],
411
411
  "args": {},
412
412
  "deprecateAliases": true,
413
- "description": "Use this command to delete components from orgs that don’t have source tracking. To remove deleted items from orgs that have source tracking enabled, \"<%= config.bin %> project deploy start\".\n\nWhen you run this command, both the local source file and the metadata component in the org are deleted.\n\nTo delete multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.",
413
+ "description": "Use this command to delete components from orgs that don’t have source tracking. To remove deleted items from orgs that have source tracking enabled, \"<%= config.bin %> project deploy start\".\n\nWhen you run this command, both the local source file and the metadata component in the org are deleted.\n\nTo delete multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --source-dir.",
414
414
  "examples": [
415
415
  "Delete all local Apex source files and all Apex classes from the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --metadata ApexClass --target-org my-scratch",
416
416
  "Delete a specific Apex class and a Profile that has a space in it from your default org; don't prompt for confirmation:\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyFabulousApexClass --metadata \"Profile: My Profile\" --no-prompt",
@@ -475,7 +475,7 @@
475
475
  ],
476
476
  "char": "c",
477
477
  "deprecateAliases": true,
478
- "description": "IMPORTANT: 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\nValidates the deleted metadata and runs all Apex tests, but prevents the deletion from being saved to the org.\n\nIf you change a field type from Master-Detail to Lookup or vice versa, that change isn’t supported when using the --check-only parameter to test a deletion (validation). This kind of change isn’t supported for test deletions to avoid the risk of data loss or corruption. If a change that isn’t supported for test deletions is included in a deletion package, the test deletion fails and issues an error.\n\nIf your deletion package changes a field type from Master-Detail to Lookup or vice versa, you can still validate the changes prior to deploying to Production by performing a full deletion to another test Sandbox. A full deletion includes a validation of the changes as part of the deletion process.\n\nNote: A Metadata API deletion that includes Master-Detail relationships deletes all detail records in the Recycle Bin in the following cases.\n\n 1. For a deletion with a new Master-Detail field, soft delete (send to the Recycle Bin) all detail records before proceeding to delete the Master-Detail field, or the deletion fails. During the deletion, detail records are permanently deleted from the Recycle Bin and cannot be recovered.\n\n 2. For a deletion that converts a Lookup field relationship to a Master-Detail relationship, detail records must reference a master record or be soft-deleted (sent to the Recycle Bin) for the deletion to succeed. However, a successful deletion permanently deletes any detail records in the Recycle Bin.",
478
+ "description": "IMPORTANT: 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\nValidates the deleted metadata and runs all Apex tests, but prevents the deletion from being saved to the org.\n\nIf you change a field type from Master-Detail to Lookup or vice versa, that change isn’t supported when using the --check-only flag to test a deletion (validation). This kind of change isn’t supported for test deletions to avoid the risk of data loss or corruption. If a change that isn’t supported for test deletions is included in a deletion package, the test deletion fails and issues an error.\n\nIf your deletion package changes a field type from Master-Detail to Lookup or vice versa, you can still validate the changes prior to deploying to Production by performing a full deletion to another test Sandbox. A full deletion includes a validation of the changes as part of the deletion process.\n\nNote: A Metadata API deletion that includes Master-Detail relationships deletes all detail records in the Recycle Bin in the following cases.\n\n 1. For a deletion with a new Master-Detail field, soft delete (send to the Recycle Bin) all detail records before proceeding to delete the Master-Detail field, or the deletion fails. During the deletion, detail records are permanently deleted from the Recycle Bin and cannot be recovered.\n\n 2. For a deletion that converts a Lookup field relationship to a Master-Detail relationship, detail records must reference a master record or be soft-deleted (sent to the Recycle Bin) for the deletion to succeed. However, a successful deletion permanently deletes any detail records in the Recycle Bin.",
479
479
  "name": "check-only",
480
480
  "summary": "Validate delete command but don't delete anything from the org or the local project.",
481
481
  "allowNo": false,
@@ -532,7 +532,7 @@
532
532
  },
533
533
  "metadata": {
534
534
  "char": "m",
535
- "description": "If you specify this parameter, don’t specify --source-dir.",
535
+ "description": "If you specify this flag, don’t specify --source-dir.",
536
536
  "name": "metadata",
537
537
  "summary": "Metadata components to delete.",
538
538
  "delimiter": ",",
@@ -546,7 +546,7 @@
546
546
  ],
547
547
  "char": "p",
548
548
  "deprecateAliases": true,
549
- "description": "The supplied paths can be a single file (in which case the operation is applied to only one file) or a folder (in which case the operation is applied to all metadata types in the directory and its sub-directories).\n\nIf you specify this parameter, don’t specify --metadata.",
549
+ "description": "The supplied paths can be a single file (in which case the operation is applied to only one file) or a folder (in which case the operation is applied to all metadata types in the directory and its sub-directories).\n\nIf you specify this flag, don’t specify --metadata.",
550
550
  "name": "source-dir",
551
551
  "summary": "Source file paths to delete.",
552
552
  "delimiter": ",",
@@ -868,7 +868,7 @@
868
868
  ],
869
869
  "args": {},
870
870
  "deprecateAliases": true,
871
- "description": "You must run this command from within a project.\n\nThe command outputs a table that describes what will happen if you run the \"<%= config.bin %> project deploy start\" command. The table lists the metadata components that will be deployed and deleted. The table also lists the current conflicts between files in your local project and components in the org. Finally, the table lists the files that won't be deployed because they're included in your .forceignore file.\n\nIf your org allows source tracking, then this command displays potential conflicts between the org and your local project. Some orgs, such as production org, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the \"<%= config.bin %> org create scratch|sandbox\" commands.\n\nTo preview the deployment of multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.",
871
+ "description": "You must run this command from within a project.\n\nThe command outputs a table that describes what will happen if you run the \"<%= config.bin %> project deploy start\" command. The table lists the metadata components that will be deployed and deleted. The table also lists the current conflicts between files in your local project and components in the org. Finally, the table lists the files that won't be deployed because they're included in your .forceignore file.\n\nIf your org allows source tracking, then this command displays potential conflicts between the org and your local project. Some orgs, such as production org, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the \"<%= config.bin %> org create scratch|sandbox\" commands.\n\nTo preview the deployment of multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --source-dir.",
872
872
  "examples": [
873
873
  "NOTE: The commands to preview a deployment and actually deploy it use similar flags. We provide a few preview examples here, but see the help for \"<%= config.bin %> project deploy start\" for more examples that you can adapt for previewing.",
874
874
  "Preview the deployment of source files in a directory, such as force-app, to your default org:\n<%= config.bin %> <%= command.id %> --source-dir force-app",
@@ -1508,7 +1508,7 @@
1508
1508
  ],
1509
1509
  "args": {},
1510
1510
  "deprecateAliases": true,
1511
- "description": "You must run this command from within a project.\n\nMetadata components are deployed in source format by default. Deploy them in metadata format by specifying the --metadata-dir flag, which specifies the root directory or ZIP file that contains the metadata formatted files you want to deploy.\n\nIf your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production orgs, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the \"<%= config.bin %> org create scratch|sandbox\" commands.\n\nTo deploy multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.",
1511
+ "description": "You must run this command from within a project.\n\nMetadata components are deployed in source format by default. Deploy them in metadata format by specifying the --metadata-dir flag, which specifies the root directory or ZIP file that contains the metadata formatted files you want to deploy.\n\nIf your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production orgs, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the \"<%= config.bin %> org create scratch|sandbox\" commands.\n\nTo deploy multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --source-dir.",
1512
1512
  "examples": [
1513
1513
  "Deploy local changes not in the org; uses your default org:\n<%= config.bin %> <%= command.id %>",
1514
1514
  "Deploy all source files in the \"force-app\" directory to an org with alias \"my-scratch\"; show only concise output, in other words don't print a list of all the source that was deployed:\n<%= config.bin %> <%= command.id %> --source-dir force-app --target-org my-scratch --concise",
@@ -1906,7 +1906,7 @@
1906
1906
  ],
1907
1907
  "args": {},
1908
1908
  "deprecateAliases": true,
1909
- "description": "Use this command to verify whether a deployment will succeed without actually deploying the metadata to your org. This command is similar to \"<%= config.bin %> project deploy start\", except you're required to run Apex tests, and the command returns a job ID rather than executing the deployment. If the validation succeeds, then you pass this job ID to the \"<%= config.bin %> project deploy quick\" command to actually deploy the metadata. This quick deploy takes less time because it skips running Apex tests. The job ID is valid for 10 days from when you started the validation. Validating first is useful if the deployment to your production org take several hours and you don’t want to risk a failed deploy.\n\nYou must run this command from within a project.\n\nThis command doesn't support source-tracking. When you quick deploy with the resulting job ID, the source you deploy overwrites the corresponding metadata in your org.\n\nTo validate the deployment of multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.\n\nNote: Don't use this command on sandboxes; the command is intended to be used on production orgs. By default, sandboxes don't run tests during a deploy. If you want to validate a deployment with tests on a sandbox, use \"<%= config.bin %> project deploy start --dry-run --test-level RunLocalTests\" instead.",
1909
+ "description": "Use this command to verify whether a deployment will succeed without actually deploying the metadata to your org. This command is similar to \"<%= config.bin %> project deploy start\", except you're required to run Apex tests, and the command returns a job ID rather than executing the deployment. If the validation succeeds, then you pass this job ID to the \"<%= config.bin %> project deploy quick\" command to actually deploy the metadata. This quick deploy takes less time because it skips running Apex tests. The job ID is valid for 10 days from when you started the validation. Validating first is useful if the deployment to your production org take several hours and you don’t want to risk a failed deploy.\n\nYou must run this command from within a project.\n\nThis command doesn't support source-tracking. When you quick deploy with the resulting job ID, the source you deploy overwrites the corresponding metadata in your org.\n\nTo validate the deployment of multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --source-dir.\n\nNote: Don't use this command on sandboxes; the command is intended to be used on production orgs. By default, sandboxes don't run tests during a deploy. If you want to validate a deployment with tests on a sandbox, use \"<%= config.bin %> project deploy start --dry-run --test-level RunLocalTests\" instead.",
1910
1910
  "examples": [
1911
1911
  "NOTE: These examples focus on validating large deployments. See the help for \"<%= config.bin %> project deploy start\" for examples of deploying smaller sets of metadata which you can also use to validate.",
1912
1912
  "Validate the deployment of all source files in the \"force-app\" directory to the default org:\n<%= config.bin %> <%= command.id %> --source-dir force-app",
@@ -2252,7 +2252,7 @@
2252
2252
  ],
2253
2253
  "args": {},
2254
2254
  "deprecateAliases": true,
2255
- "description": "Create a manifest from a list of metadata components (--metadata) or from one or more local directories that contain source files (--source-dir). You can specify either of these parameters, not both.\n\nUse --type to specify the type of manifest you want to create. The resulting manifest files have specific names, such as the standard package.xml or destructiveChanges.xml to delete metadata. Valid values for this parameter, and their respective file names, are:\n\n * package : package.xml (default)\n * pre : destructiveChangesPre.xml\n * post : destructiveChangesPost.xml\n * destroy : destructiveChanges.xml\n\nSee https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_deleting_files.htm for information about these destructive manifest files.\n\nUse --name to specify a custom name for the generated manifest if the pre-defined ones don’t suit your needs. You can specify either --type or --name, but not both.\n\nTo include multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --include-packages and --source-dir.",
2255
+ "description": "Create a manifest from a list of metadata components (--metadata) or from one or more local directories that contain source files (--source-dir). You can specify either of these flags, not both.\n\nUse --type to specify the type of manifest you want to create. The resulting manifest files have specific names, such as the standard package.xml or destructiveChanges.xml to delete metadata. Valid values for this flag, and their respective file names, are:\n\n * package : package.xml (default)\n * pre : destructiveChangesPre.xml\n * post : destructiveChangesPost.xml\n * destroy : destructiveChanges.xml\n\nSee https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_deleting_files.htm for information about these destructive manifest files.\n\nUse --name to specify a custom name for the generated manifest if the pre-defined ones don’t suit your needs. You can specify either --type or --name, but not both.\n\nTo include multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --include-packages and --source-dir.",
2256
2256
  "examples": [
2257
2257
  "Create a manifest for deploying or retrieving all Apex classes and custom objects:\n$ <%= config.bin %> <%= command.id %> --metadata ApexClass --metadata CustomObject",
2258
2258
  "Create a manifest for deleting the specified Apex class:\n$ <%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --type destroy",
@@ -2552,7 +2552,7 @@
2552
2552
  ],
2553
2553
  "args": {},
2554
2554
  "deprecateAliases": true,
2555
- "description": "WARNING: This command deletes or overwrites all existing source tracking files. Use with extreme caution.\n\nResets local and remote source tracking so that Salesforce CLI no longer registers differences between your local files and those in the org. When you next run 'project deploy preview', Salesforce CLI returns no results, even though conflicts might actually exist. Salesforce CLI then resumes tracking new source changes as usual.\n\nUse the --revision parameter to reset source tracking to a specific revision number of an org source member. To get the revision number, query the SourceMember Tooling API object with the 'data soql' command. For example:\n\n <%= config.bin %> data query --query \"SELECT MemberName, MemberType, RevisionCounter FROM SourceMember\" --use-tooling-api --target-org my-scratch",
2555
+ "description": "WARNING: This command deletes or overwrites all existing source tracking files. Use with extreme caution.\n\nResets local and remote source tracking so that Salesforce CLI no longer registers differences between your local files and those in the org. When you next run 'project deploy preview', Salesforce CLI returns no results, even though conflicts might actually exist. Salesforce CLI then resumes tracking new source changes as usual.\n\nUse the --revision flag to reset source tracking to a specific revision number of an org source member. To get the revision number, query the SourceMember Tooling API object with the 'data soql' command. For example:\n\n <%= config.bin %> data query --query \"SELECT MemberName, MemberType, RevisionCounter FROM SourceMember\" --use-tooling-api --target-org my-scratch",
2556
2556
  "examples": [
2557
2557
  "Reset source tracking for the org with alias \"my-scratch\":\n$ <%= config.bin %> <%= command.id %> --target-org my-scratch",
2558
2558
  "Reset source tracking to revision number 30 for your default org:\n$ <%= config.bin %> <%= command.id %> --revision 30"
@@ -2775,7 +2775,7 @@
2775
2775
  ],
2776
2776
  "args": {},
2777
2777
  "deprecateAliases": true,
2778
- "description": "You must run this command from within a project.\n\nMetadata components are retrieved in source format by default. Retrieve them in metadata format by specifying the --target-metadata-dir flag, which retrieves the components into a ZIP file in the specified directory.\n\nIf your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production orgs, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the \"<%= config.bin %> org create scratch|sandbox\" commands.\n\nTo retrieve multiple metadata components, either use multiple --metadata <name> flags or use a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.",
2778
+ "description": "You must run this command from within a project.\n\nMetadata components are retrieved in source format by default. Retrieve them in metadata format by specifying the --target-metadata-dir flag, which retrieves the components into a ZIP file in the specified directory.\n\nIf your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production orgs, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the \"<%= config.bin %> org create scratch|sandbox\" commands.\n\nTo retrieve multiple metadata components, either use multiple --metadata <name> flags or use a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --source-dir.",
2779
2779
  "examples": [
2780
2780
  "Retrieve all remote changes from your default org:\n<%= config.bin %> <%= command.id %>",
2781
2781
  "Retrieve the source files in the \"force-app\" directory from an org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --source-dir force-app --target-org my-scratch",
@@ -2827,7 +2827,7 @@
2827
2827
  },
2828
2828
  "manifest": {
2829
2829
  "char": "x",
2830
- "description": "If you specify this parameter, don’t specify --metadata or --source-dir.",
2830
+ "description": "If you specify this flag, don’t specify --metadata or --source-dir.",
2831
2831
  "exclusive": [
2832
2832
  "metadata",
2833
2833
  "source-dir"
@@ -3027,5 +3027,5 @@
3027
3027
  ]
3028
3028
  }
3029
3029
  },
3030
- "version": "3.15.8"
3030
+ "version": "3.15.9"
3031
3031
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@salesforce/plugin-deploy-retrieve",
3
3
  "description": "deploy and retrieve commands for sf",
4
- "version": "3.15.8",
4
+ "version": "3.15.9",
5
5
  "author": "Salesforce",
6
6
  "bugs": "https://github.com/forcedotcom/cli/issues",
7
7
  "dependencies": {
@@ -253,7 +253,7 @@
253
253
  "exports": "./lib/index.js",
254
254
  "type": "module",
255
255
  "sfdx": {
256
- "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-deploy-retrieve/3.15.8.crt",
257
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-deploy-retrieve/3.15.8.sig"
256
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-deploy-retrieve/3.15.9.crt",
257
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-deploy-retrieve/3.15.9.sig"
258
258
  }
259
259
  }