@salesforce/plugin-deploy-retrieve 3.8.4 → 3.9.0

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.
Files changed (61) hide show
  1. package/README.md +47 -45
  2. package/lib/commands/project/convert/source-behavior.d.ts +4 -4
  3. package/lib/commands/project/convert/source.d.ts +5 -5
  4. package/lib/commands/project/delete/tracking.d.ts +4 -4
  5. package/lib/commands/project/deploy/cancel.d.ts +5 -5
  6. package/lib/commands/project/deploy/preview.d.ts +6 -6
  7. package/lib/commands/project/deploy/quick.d.ts +8 -8
  8. package/lib/commands/project/deploy/report.d.ts +7 -7
  9. package/lib/commands/project/deploy/resume.d.ts +8 -8
  10. package/lib/commands/project/deploy/start.d.ts +23 -23
  11. package/lib/commands/project/deploy/validate.d.ts +20 -20
  12. package/lib/commands/project/generate/manifest.d.ts +9 -9
  13. package/lib/commands/project/list/ignored.d.ts +1 -1
  14. package/lib/commands/project/reset/tracking.d.ts +5 -5
  15. package/lib/commands/project/retrieve/preview.d.ts +3 -3
  16. package/lib/formatters/asyncDeployCancelResultFormatter.js +2 -1
  17. package/lib/formatters/asyncDeployCancelResultFormatter.js.map +1 -1
  18. package/lib/formatters/asyncDeployResultFormatter.js +2 -1
  19. package/lib/formatters/asyncDeployResultFormatter.js.map +1 -1
  20. package/lib/formatters/deleteResultFormatter.js +6 -7
  21. package/lib/formatters/deleteResultFormatter.js.map +1 -1
  22. package/lib/formatters/deployCancelResultFormatter.js +4 -2
  23. package/lib/formatters/deployCancelResultFormatter.js.map +1 -1
  24. package/lib/formatters/deployReportResultFormatter.js +2 -1
  25. package/lib/formatters/deployReportResultFormatter.js.map +1 -1
  26. package/lib/formatters/deployResultFormatter.js +4 -3
  27. package/lib/formatters/deployResultFormatter.js.map +1 -1
  28. package/lib/formatters/metadataConvertResultFormatter.js +3 -2
  29. package/lib/formatters/metadataConvertResultFormatter.js.map +1 -1
  30. package/lib/formatters/metadataRetrieveResultFormatter.js +2 -1
  31. package/lib/formatters/metadataRetrieveResultFormatter.js.map +1 -1
  32. package/lib/formatters/retrieveResultFormatter.js +1 -1
  33. package/lib/formatters/retrieveResultFormatter.js.map +1 -1
  34. package/lib/formatters/sourceConvertResultFormatter.js +2 -1
  35. package/lib/formatters/sourceConvertResultFormatter.js.map +1 -1
  36. package/lib/formatters/testResultsFormatter.js +3 -2
  37. package/lib/formatters/testResultsFormatter.js.map +1 -1
  38. package/lib/utils/conflicts.js +2 -1
  39. package/lib/utils/conflicts.js.map +1 -1
  40. package/lib/utils/flags.d.ts +6 -6
  41. package/lib/utils/previewOutput.js +2 -1
  42. package/lib/utils/previewOutput.js.map +1 -1
  43. package/lib/utils/progressBar.js +3 -3
  44. package/lib/utils/progressBar.js.map +1 -1
  45. package/messages/convert.mdapi.md +2 -2
  46. package/messages/convert.source.md +4 -4
  47. package/messages/delete.source.md +5 -5
  48. package/messages/delete.tracking.md +4 -4
  49. package/messages/deploy.metadata.cancel.md +8 -8
  50. package/messages/deploy.metadata.md +15 -15
  51. package/messages/deploy.metadata.preview.md +7 -7
  52. package/messages/deploy.metadata.quick.md +6 -6
  53. package/messages/deploy.metadata.report.md +7 -7
  54. package/messages/deploy.metadata.resume.md +7 -7
  55. package/messages/deploy.metadata.validate.md +9 -9
  56. package/messages/list.ignored.md +3 -3
  57. package/messages/manifest.generate.md +4 -4
  58. package/messages/retrieve.metadata.preview.md +4 -4
  59. package/messages/retrieve.start.md +16 -16
  60. package/oclif.manifest.json +85 -85
  61. package/package.json +8 -8
@@ -8,7 +8,7 @@ You must run this command from within a project.
8
8
 
9
9
  Metadata 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.
10
10
 
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 "sf org create scratch|sandbox" commands.
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
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.
14
14
 
@@ -16,28 +16,28 @@ To retrieve multiple metadata components, either use multiple --metadata <name>
16
16
 
17
17
  - Retrieve all remote changes from your default org:
18
18
 
19
- sf <%= command.id %>
19
+ <%= config.bin %> <%= command.id %>
20
20
 
21
21
  - Retrieve the source files in the "force-app" directory from an org with alias "my-scratch":
22
22
 
23
- sf <%= command.id %> --source-dir force-app --target-org my-scratch
23
+ <%= config.bin %> <%= command.id %> --source-dir force-app --target-org my-scratch
24
24
 
25
25
  - Retrieve all the Apex classes and custom objects whose source is in the "force-app" directory. The list views, layouts, etc, that are associated with the custom objects are also retrieved. Both examples are equivalent:
26
26
 
27
- sf <%= command.id %> --source-dir force-app/main/default/classes force-app/main/default/objects
28
- sf <%= command.id %> --source-dir force-app/main/default/classes --source-dir force-app/main/default/objects
27
+ <%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes force-app/main/default/objects
28
+ <%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes --source-dir force-app/main/default/objects
29
29
 
30
30
  - Retrieve all Apex classes that are in all package directories defined in the "sfdx-project.json" file:
31
31
 
32
- sf <%= command.id %> --metadata ApexClass
32
+ <%= config.bin %> <%= command.id %> --metadata ApexClass
33
33
 
34
34
  - Retrieve a specific Apex class; ignore any conflicts between the local project and org (be careful with this flag, because it will overwrite the Apex class source files in your local project if there are conflicts!):
35
35
 
36
- sf <%= command.id %> --metadata ApexClass:MyApexClass --ignore-conflicts
36
+ <%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --ignore-conflicts
37
37
 
38
38
  - Retrieve specific Apex classes that match a pattern; in this example, retrieve Apex classes whose names contain the string "MyApex":
39
39
 
40
- sf <%= command.id %> --metadata 'ApexClass:MyApex*'
40
+ <%= config.bin %> <%= command.id %> --metadata 'ApexClass:MyApex*'
41
41
 
42
42
  - Retrieve a custom object called ExcitingObject that's in the SBQQ namespace:
43
43
 
@@ -49,29 +49,29 @@ To retrieve multiple metadata components, either use multiple --metadata <name>
49
49
 
50
50
  - Retrieve all custom objects and Apex classes found in all defined package directories (both examples are equivalent):
51
51
 
52
- sf <%= command.id %> --metadata CustomObject ApexClass
53
- sf <%= command.id %> --metadata CustomObject --metadata ApexClass
52
+ <%= config.bin %> <%= command.id %> --metadata CustomObject ApexClass
53
+ <%= config.bin %> <%= command.id %> --metadata CustomObject --metadata ApexClass
54
54
 
55
55
  - Retrieve all metadata components listed in a manifest:
56
56
 
57
- sf <%= command.id %> --manifest path/to/package.xml
57
+ <%= config.bin %> <%= command.id %> --manifest path/to/package.xml
58
58
 
59
59
  - Retrieve metadata from a package:
60
60
 
61
- sf <%= command.id %> --package-name MyPackageName
61
+ <%= config.bin %> <%= command.id %> --package-name MyPackageName
62
62
 
63
63
  - Retrieve metadata from multiple packages, one of which has a space in its name (both examples are equivalent):
64
64
 
65
- sf <%= command.id %> --package-name Package1 "PackageName With Spaces" Package3
66
- sf <%= command.id %> --package-name Package1 --package-name "PackageName With Spaces" --package-name Package3
65
+ <%= config.bin %> <%= command.id %> --package-name Package1 "PackageName With Spaces" Package3
66
+ <%= config.bin %> <%= command.id %> --package-name Package1 --package-name "PackageName With Spaces" --package-name Package3
67
67
 
68
68
  - Retrieve the metadata components listed in the force-app directory, but retrieve them in metadata format into a ZIP file in the "output" directory:
69
69
 
70
- sf <%= command.id %> --source-dir force-app --target-metadata-dir output
70
+ <%= config.bin %> <%= command.id %> --source-dir force-app --target-metadata-dir output
71
71
 
72
72
  - Retrieve in metadata format and automatically extract the contents into the "output" directory:
73
73
 
74
- sf <%= command.id %> --source-dir force-app --target-metadata-dir output --unzip
74
+ <%= config.bin %> <%= command.id %> --source-dir force-app --target-metadata-dir output --unzip
75
75
 
76
76
  # flags.api-version.summary
77
77
 
@@ -8,8 +8,8 @@
8
8
  "deprecateAliases": true,
9
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.",
10
10
  "examples": [
11
- "Convert metadata formatted files in the specified directory into source formatted files; writes converted files to your default package directory:\n$ sf <%= command.id %> --root-dir path/to/metadata",
12
- "Similar to previous example, but writes converted files to the specified output directory:\n$ sf <%= command.id %> --root-dir path/to/metadata --output-dir path/to/outputdir"
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
+ "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"
13
13
  ],
14
14
  "flags": {
15
15
  "json": {
@@ -246,10 +246,10 @@
246
246
  ],
247
247
  "args": {},
248
248
  "deprecateAliases": true,
249
- "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 \"sf project deploy\".\n\nTo convert Metadata API–formatted files into the source format, run \"sf 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.",
249
+ "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.",
250
250
  "examples": [
251
- "Convert source-formatted files in the specified directory into metadata-formatted files; writes converted files into a new directory:\n$ sf <%= command.id %> --root-dir path/to/source",
252
- "Similar to previous example, but writes converted files to the specified output directory and associates the files with the specified package:\n$ sf <%= command.id %> --root-dir path/to/source --output-dir path/to/outputdir --package-name 'My Package'"
251
+ "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",
252
+ "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'"
253
253
  ],
254
254
  "flags": {
255
255
  "json": {
@@ -309,7 +309,7 @@
309
309
  "deprecateAliases": true,
310
310
  "name": "output-dir",
311
311
  "summary": "Output directory to store the Metadata API–formatted files in.",
312
- "default": "metadataPackage_1717296698220",
312
+ "default": "metadataPackage_1717649514619",
313
313
  "hasDynamicHelp": false,
314
314
  "multiple": false,
315
315
  "type": "option"
@@ -408,12 +408,12 @@
408
408
  ],
409
409
  "args": {},
410
410
  "deprecateAliases": true,
411
- "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, \"sf 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.",
411
+ "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.",
412
412
  "examples": [
413
- "Delete all local Apex source files and all Apex classes from the org with alias \"my-scratch\":\nsf <%= command.id %> --metadata ApexClass --target-org my-scratch",
414
- "Delete a specific Apex class and a Profile that has a space in it from your default org; don't prompt for confirmation:\nsf <%= command.id %> --metadata ApexClass:MyFabulousApexClass --metadata \"Profile: My Profile\" --no-prompt",
415
- "Run the tests that aren’t in any managed packages as part of the deletion; if the delete succeeds, and the org has source-tracking enabled, update the source tracking information:\nsf <%= command.id %> --metadata ApexClass --test-level RunLocalTests --track-source",
416
- "Delete the Apex source files in a directory and the corresponding components from your default org:\nsf <%= command.id %> --source-dir force-app/main/default/classes"
413
+ "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",
414
+ "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",
415
+ "Run the tests that aren’t in any managed packages as part of the deletion; if the delete succeeds, and the org has source-tracking enabled, update the source tracking information:\n<%= config.bin %> <%= command.id %> --metadata ApexClass --test-level RunLocalTests --track-source",
416
+ "Delete the Apex source files in a directory and the corresponding components from your default org:\n<%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes"
417
417
  ],
418
418
  "flags": {
419
419
  "json": {
@@ -630,7 +630,7 @@
630
630
  "deprecateAliases": true,
631
631
  "description": "WARNING: This command deletes or overwrites all existing source tracking files. Use with extreme caution.\n\nDeletes all local source tracking information. When you next run 'project deploy preview', Salesforce CLI displays all local and remote files as changed, and any files with the same name are listed as conflicts.",
632
632
  "examples": [
633
- "Delete local source tracking for the org with alias \"my-scratch\":\n$ sf <%= command.id %> --target-org my-scratch"
633
+ "Delete local source tracking for the org with alias \"my-scratch\":\n$ <%= config.bin %> <%= command.id %> --target-org my-scratch"
634
634
  ],
635
635
  "flags": {
636
636
  "json": {
@@ -757,8 +757,8 @@
757
757
  "deprecateAliases": true,
758
758
  "description": "Use this command to cancel a deploy operation that hasn't yet completed in the org. Deploy operations include standard deploys, quick deploys, deploy validations, and deploy cancellations.\n\nRun this command by either passing it a job ID or specifying the --use-most-recent flag to use the job ID of the most recent deploy operation.",
759
759
  "examples": [
760
- "Cancel a deploy operation using a job ID:\nsf <%= command.id %> --job-id 0Af0x000017yLUFCA2",
761
- "Cancel the most recent deploy operation:\nsf <%= command.id %> --use-most-recent"
760
+ "Cancel a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
761
+ "Cancel the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
762
762
  ],
763
763
  "flags": {
764
764
  "json": {
@@ -786,7 +786,7 @@
786
786
  "type": "option"
787
787
  },
788
788
  "async": {
789
- "description": "The command immediately returns the control of the terminal to you. This way, you can continue to use the CLI. To resume watching the cancellation, run \"sf project deploy resume\". To check the status of the cancellation, run \"sf project deploy report\".",
789
+ "description": "The command immediately returns the control of the terminal to you. This way, you can continue to use the CLI. To resume watching the cancellation, run \"<%= config.bin %> project deploy resume\". To check the status of the cancellation, run \"<%= config.bin %> project deploy report\".",
790
790
  "exclusive": [
791
791
  "wait"
792
792
  ],
@@ -797,7 +797,7 @@
797
797
  },
798
798
  "job-id": {
799
799
  "char": "i",
800
- "description": "These commands return a job ID if they time out or you specified the --async flag:\n\n- sf project deploy start\n- sf project deploy validate\n- sf project deploy quick\n- sf project deploy cancel\n\nThe job ID is valid for 10 days from when you started the deploy operation.",
800
+ "description": "These commands return a job ID if they time out or you specified the --async flag:\n\n- <%= config.bin %> project deploy start\n- <%= config.bin %> project deploy validate\n- <%= config.bin %> project deploy quick\n- <%= config.bin %> project deploy cancel\n\nThe job ID is valid for 10 days from when you started the deploy operation.",
801
801
  "name": "job-id",
802
802
  "summary": "Job ID of the deploy operation you want to cancel.",
803
803
  "hasDynamicHelp": false,
@@ -814,7 +814,7 @@
814
814
  },
815
815
  "wait": {
816
816
  "char": "w",
817
- "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To resume watching the cancellation, run \"sf project deploy resume\". To check the status of the cancellation, run \"sf project deploy report\".",
817
+ "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To resume watching the cancellation, run \"<%= config.bin %> project deploy resume\". To check the status of the cancellation, run \"<%= config.bin %> project deploy report\".",
818
818
  "exclusive": [
819
819
  "async"
820
820
  ],
@@ -866,13 +866,13 @@
866
866
  ],
867
867
  "args": {},
868
868
  "deprecateAliases": true,
869
- "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 \"sf 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 \"sf 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.",
869
+ "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.",
870
870
  "examples": [
871
- "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 \"sf project deploy start\" for more examples that you can adapt for previewing.",
872
- "Preview the deployment of source files in a directory, such as force-app, to your default org:\nsf <%= command.id %> --source-dir force-app",
873
- "Preview the deployment of all Apex classes to an org with alias \"my-scratch\":\nsf <%= command.id %> --metadata ApexClass --target-org my-scratch",
874
- "Preview deployment of a specific Apex class:\nsf <%= command.id %> --metadata ApexClass:MyApexClass",
875
- "Preview deployment of all components listed in a manifest:\nsf <%= command.id %> --manifest path/to/package.xml"
871
+ "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.",
872
+ "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",
873
+ "Preview the deployment of all Apex classes to an org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --metadata ApexClass --target-org my-scratch",
874
+ "Preview deployment of a specific Apex class:\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass",
875
+ "Preview deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
876
876
  ],
877
877
  "flags": {
878
878
  "json": {
@@ -994,10 +994,10 @@
994
994
  ],
995
995
  "args": {},
996
996
  "deprecateAliases": true,
997
- "description": "Before you run this command, first create a validated deployment with the \"sf project deploy validate\" command, which returns a job ID. Validated deployments haven't been deployed to the org yet; you deploy them with this command. Either pass the job ID to this command or use the --use-most-recent flag to use the job ID of the most recently validated deployment. For the quick deploy to succeed, the associated validated deployment must also have succeeded.\n\nExecuting this quick deploy command takes less time than a standard deploy because it skips running Apex tests. These tests were previously run as part of the validation. Validating first and then running a quick deploy is useful if the deployment to your production org take several hours and you don’t want to risk a failed deploy.\n\nThis command doesn't support source-tracking. The source you deploy overwrites the corresponding metadata in your org. This command doesn’t attempt to merge your source with the versions in your org.\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. Use `sf project deploy start` instead.",
997
+ "description": "Before you run this command, first create a validated deployment with the \"<%= config.bin %> project deploy validate\" command, which returns a job ID. Validated deployments haven't been deployed to the org yet; you deploy them with this command. Either pass the job ID to this command or use the --use-most-recent flag to use the job ID of the most recently validated deployment. For the quick deploy to succeed, the associated validated deployment must also have succeeded.\n\nExecuting this quick deploy command takes less time than a standard deploy because it skips running Apex tests. These tests were previously run as part of the validation. Validating first and then running a quick deploy is useful if the deployment to your production org take several hours and you don’t want to risk a failed deploy.\n\nThis command doesn't support source-tracking. The source you deploy overwrites the corresponding metadata in your org. This command doesn’t attempt to merge your source with the versions in your org.\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. Use \"<%= config.bin %> project deploy start\" instead.",
998
998
  "examples": [
999
- "Run a quick deploy to your default org using a job ID:\nsf <%= command.id %> --job-id 0Af0x000017yLUFCA2",
1000
- "Asynchronously run a quick deploy of the most recently validated deployment to an org with alias \"my-prod-org\":\nsf <%= command.id %> --async --use-most-recent --target-org my-prod-org"
999
+ "Run a quick deploy to your default org using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
1000
+ "Asynchronously run a quick deploy of the most recently validated deployment to an org with alias \"my-prod-org\":\n<%= config.bin %> <%= command.id %> --async --use-most-recent --target-org my-prod-org"
1001
1001
  ],
1002
1002
  "flags": {
1003
1003
  "json": {
@@ -1016,7 +1016,7 @@
1016
1016
  "type": "option"
1017
1017
  },
1018
1018
  "async": {
1019
- "description": "The command immediately returns the control of the terminal to you. This way, you can continue to use the CLI. To resume watching the deploy, run \"sf project deploy resume\". To check the status of the deploy, run \"sf project deploy report\".",
1019
+ "description": "The command immediately returns the control of the terminal to you. This way, you can continue to use the CLI. To resume watching the deploy, run \"<%= config.bin %> project deploy resume\". To check the status of the deploy, run \"<%= config.bin %> project deploy report\".",
1020
1020
  "exclusive": [
1021
1021
  "wait"
1022
1022
  ],
@@ -1071,7 +1071,7 @@
1071
1071
  },
1072
1072
  "wait": {
1073
1073
  "char": "w",
1074
- "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To resume watching the deploy, run \"sf project deploy resume\". To check the status of the deploy, run \"sf project deploy report\".",
1074
+ "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To resume watching the deploy, run \"<%= config.bin %> project deploy resume\". To check the status of the deploy, run \"<%= config.bin %> project deploy report\".",
1075
1075
  "exclusive": [
1076
1076
  "async"
1077
1077
  ],
@@ -1168,9 +1168,9 @@
1168
1168
  "deprecateAliases": true,
1169
1169
  "description": "Deploy operations include standard deploys, quick deploys, deploy validations, and deploy cancellations.\n\nRun this command by either passing it a job ID or specifying the --use-most-recent flag to use the job ID of the most recent deploy operation. If you specify the --wait flag, the command polls for the status every second until the timeout of --wait minutes. If you don't specify the --wait flag, the command simply checks and displays the status of the deploy; the command doesn't poll for the status.\n\nYou typically don't specify the --target-org flag because the cached job already references the org to which you deployed. But if you run this command on a computer different than the one from which you deployed, then you must specify the --target-org and it must point to the same org.\n\nThis command doesn't update source tracking information.",
1170
1170
  "examples": [
1171
- "Check the status using a job ID:\nsf <%= command.id %> --job-id 0Af0x000017yLUFCA2",
1172
- "Check the status of the most recent deploy operation:\nsf <%= command.id %> --use-most-recent",
1173
- "Poll for the status using a job ID and target org:\nsf <%= command.id %> --job-id 0Af0x000017yLUFCA2 --target-org me@my.org --wait 30"
1171
+ "Check the status using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
1172
+ "Check the status of the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent",
1173
+ "Poll for the status using a job ID and target org:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2 --target-org me@my.org --wait 30"
1174
1174
  ],
1175
1175
  "flags": {
1176
1176
  "json": {
@@ -1199,7 +1199,7 @@
1199
1199
  },
1200
1200
  "job-id": {
1201
1201
  "char": "i",
1202
- "description": "These commands return a job ID if they time out or you specified the --async flag:\n\n- sf project deploy start\n- sf project deploy validate\n- sf project deploy quick\n- sf project deploy cancel\n\nThe job ID is valid for 10 days from when you started the deploy operation.",
1202
+ "description": "These commands return a job ID if they time out or you specified the --async flag:\n\n- <%= config.bin %> project deploy start\n- <%= config.bin %> project deploy validate\n- <%= config.bin %> project deploy quick\n- <%= config.bin %> project deploy cancel\n\nThe job ID is valid for 10 days from when you started the deploy operation.",
1203
1203
  "name": "job-id",
1204
1204
  "summary": "Job ID of the deploy operation you want to check the status of.",
1205
1205
  "hasDynamicHelp": false,
@@ -1262,7 +1262,7 @@
1262
1262
  },
1263
1263
  "wait": {
1264
1264
  "char": "w",
1265
- "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To resume the deployment, run \"sf project deploy resume\". To check the status of the deployment, run \"sf project deploy report\".",
1265
+ "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To resume the deployment, run \"<%= config.bin %> project deploy resume\". To check the status of the deployment, run \"<%= config.bin %> project deploy report\".",
1266
1266
  "name": "wait",
1267
1267
  "summary": "Number of minutes to wait for command to complete and display results.",
1268
1268
  "hasDynamicHelp": true,
@@ -1313,8 +1313,8 @@
1313
1313
  "deprecateAliases": true,
1314
1314
  "description": "Use this command to resume watching a deploy operation if the original command times out or you specified the --async flag. Deploy operations include standard deploys, quick deploys, deploy validations, and deploy cancellations. This command doesn't resume the original operation itself, because the operation always continues after you've started it, regardless of whether you're watching it or not. When the deploy completes, source tracking information is updated as needed.\n\nRun this command by either passing it a job ID or specifying the --use-most-recent flag to use the job ID of the most recent deploy operation.",
1315
1315
  "examples": [
1316
- "Resume watching a deploy operation using a job ID:\nsf <%= command.id %> --job-id 0Af0x000017yLUFCA2",
1317
- "Resume watching the most recent deploy operation:\nsf <%= command.id %> --use-most-recent"
1316
+ "Resume watching a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
1317
+ "Resume watching the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
1318
1318
  ],
1319
1319
  "flags": {
1320
1320
  "json": {
@@ -1343,7 +1343,7 @@
1343
1343
  },
1344
1344
  "job-id": {
1345
1345
  "char": "i",
1346
- "description": "These commands return a job ID if they time out or you specified the --async flag:\n\n- sf project deploy start\n- sf project deploy validate\n- sf project deploy quick\n- sf project deploy cancel\n\nThe job ID is valid for 10 days from when you started the deploy operation.",
1346
+ "description": "These commands return a job ID if they time out or you specified the --async flag:\n\n- <%= config.bin %> project deploy start\n- <%= config.bin %> project deploy validate\n- <%= config.bin %> project deploy quick\n- <%= config.bin %> project deploy cancel\n\nThe job ID is valid for 10 days from when you started the deploy operation.",
1347
1347
  "name": "job-id",
1348
1348
  "summary": "Job ID of the deploy operation you want to resume.",
1349
1349
  "hasDynamicHelp": false,
@@ -1369,7 +1369,7 @@
1369
1369
  },
1370
1370
  "wait": {
1371
1371
  "char": "w",
1372
- "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To resume watching the deploy operation, run this command again. To check the status of the deploy operation, run \"sf project deploy report\".",
1372
+ "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To resume watching the deploy operation, run this command again. To check the status of the deploy operation, run \"<%= config.bin %> project deploy report\".",
1373
1373
  "name": "wait",
1374
1374
  "summary": "Number of minutes to wait for the command to complete and display results.",
1375
1375
  "hasDynamicHelp": true,
@@ -1506,20 +1506,20 @@
1506
1506
  ],
1507
1507
  "args": {},
1508
1508
  "deprecateAliases": true,
1509
- "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 \"sf 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.",
1509
+ "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.",
1510
1510
  "examples": [
1511
- "Deploy local changes not in the org; uses your default org:\nsf <%= command.id %>",
1512
- "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:\nsf <%= command.id %> --source-dir force-app --target-org my-scratch --concise",
1513
- "Deploy all the Apex classes and custom objects that are in the \"force-app\" directory. The list views, layouts, etc, that are associated with the custom objects are also deployed. Both examples are equivalent:\nsf <%= command.id %> --source-dir force-app/main/default/classes force-app/main/default/objects\nsf <%= command.id %> --source-dir force-app/main/default/classes --source-dir force-app/main/default/objects",
1514
- "Deploy all Apex classes that are in all package directories defined in the \"sfdx-project.json\" file:\nsf <%= command.id %> --metadata ApexClass",
1515
- "Deploy a specific Apex class; ignore any conflicts between the local project and org (be careful with this flag, because it will overwrite the Apex class in the org if there are conflicts!):\nsf <%= command.id %> --metadata ApexClass:MyApexClass --ignore-conflicts",
1516
- "Deploy specific Apex classes that match a pattern; in this example, deploy Apex classes whose names contain the string \"MyApex\". Also ignore any deployment warnings (again, be careful with this flag! You typically want to see the warnings):\nsf <%= command.id %> --metadata 'ApexClass:MyApex*' --ignore-warnings",
1511
+ "Deploy local changes not in the org; uses your default org:\n<%= config.bin %> <%= command.id %>",
1512
+ "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",
1513
+ "Deploy all the Apex classes and custom objects that are in the \"force-app\" directory. The list views, layouts, etc, that are associated with the custom objects are also deployed. Both examples are equivalent:\n<%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes force-app/main/default/objects\n<%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes --source-dir force-app/main/default/objects",
1514
+ "Deploy all Apex classes that are in all package directories defined in the \"sfdx-project.json\" file:\n<%= config.bin %> <%= command.id %> --metadata ApexClass",
1515
+ "Deploy a specific Apex class; ignore any conflicts between the local project and org (be careful with this flag, because it will overwrite the Apex class in the org if there are conflicts!):\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --ignore-conflicts",
1516
+ "Deploy specific Apex classes that match a pattern; in this example, deploy Apex classes whose names contain the string \"MyApex\". Also ignore any deployment warnings (again, be careful with this flag! You typically want to see the warnings):\n<%= config.bin %> <%= command.id %> --metadata 'ApexClass:MyApex*' --ignore-warnings",
1517
1517
  "Deploy a custom object called ExcitingObject that's in the SBQQ namespace:\nsf <%= command.id %> --metadata CustomObject:SBQQ__ExcitingObject",
1518
1518
  "Deploy all custom objects in the SBQQ namespace by using a wildcard and quotes:\nsf <%= command.id %> --metadata 'CustomObject:SBQQ__*'",
1519
- "Deploy all custom objects and Apex classes found in all defined package directories (both examples are equivalent):\nsf <%= command.id %> --metadata CustomObject ApexClass\nsf <%= command.id %> --metadata CustomObject --metadata ApexClass",
1520
- "Deploy all Apex classes and a profile that has a space in its name:\nsf <%= command.id %> --metadata ApexClass --metadata \"Profile:My Profile\"",
1521
- "Deploy all components listed in a manifest:\nsf <%= command.id %> --manifest path/to/package.xml",
1522
- "Run the tests that aren’t in any managed packages as part of a deployment:\nsf <%= command.id %> --metadata ApexClass --test-level RunLocalTests"
1519
+ "Deploy all custom objects and Apex classes found in all defined package directories (both examples are equivalent):\n<%= config.bin %> <%= command.id %> --metadata CustomObject ApexClass\n<%= config.bin %> <%= command.id %> --metadata CustomObject --metadata ApexClass",
1520
+ "Deploy all Apex classes and a profile that has a space in its name:\n<%= config.bin %> <%= command.id %> --metadata ApexClass --metadata \"Profile:My Profile\"",
1521
+ "Deploy all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml",
1522
+ "Run the tests that aren’t in any managed packages as part of a deployment:\n<%= config.bin %> <%= command.id %> --metadata ApexClass --test-level RunLocalTests"
1523
1523
  ],
1524
1524
  "flags": {
1525
1525
  "json": {
@@ -1547,7 +1547,7 @@
1547
1547
  "type": "option"
1548
1548
  },
1549
1549
  "async": {
1550
- "description": "The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume the deployment, run \"sf project deploy resume\". To check the status of the deployment, run \"sf project deploy report\".",
1550
+ "description": "The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume the deployment, run \"<%= config.bin %> project deploy resume\". To check the status of the deployment, run \"<%= config.bin %> project deploy report\".",
1551
1551
  "exclusive": [
1552
1552
  "wait"
1553
1553
  ],
@@ -1709,7 +1709,7 @@
1709
1709
  },
1710
1710
  "wait": {
1711
1711
  "char": "w",
1712
- "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To resume the deployment, run \"sf project deploy resume\". To check the status of the deployment, run \"sf project deploy report\".",
1712
+ "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To resume the deployment, run \"<%= config.bin %> project deploy resume\". To check the status of the deployment, run \"<%= config.bin %> project deploy report\".",
1713
1713
  "exclusive": [
1714
1714
  "async"
1715
1715
  ],
@@ -1903,13 +1903,13 @@
1903
1903
  ],
1904
1904
  "args": {},
1905
1905
  "deprecateAliases": true,
1906
- "description": "Use this command to verify whether a deployment will succeed without actually deploying the metadata to your org. This command is similar to \"sf 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 \"sf 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 \"sf project deploy start --dry-run --test-level RunLocalTests\" instead.",
1906
+ "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.",
1907
1907
  "examples": [
1908
- "NOTE: These examples focus on validating large deployments. See the help for \"sf project deploy start\" for examples of deploying smaller sets of metadata which you can also use to validate.",
1909
- "Validate the deployment of all source files in the \"force-app\" directory to the default org:\nsf <%= command.id %> --source-dir force-app",
1910
- "Validate the deployment of all source files in two directories: \"force-app\" and \"force-app-utils\":\nsf <%= command.id %> --source-dir force-app --source-dir force-app-utils",
1911
- "Asynchronously validate the deployment and run all tests in the org with alias \"my-prod-org\"; command immediately returns the job ID:\nsf <%= command.id %> --source-dir force-app --async --test-level RunAllTestsInOrg --target-org my-prod-org",
1912
- "Validate the deployment of all components listed in a manifest:\nsf <%= command.id %> --manifest path/to/package.xml"
1908
+ "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.",
1909
+ "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",
1910
+ "Validate the deployment of all source files in two directories: \"force-app\" and \"force-app-utils\":\n<%= config.bin %> <%= command.id %> --source-dir force-app --source-dir force-app-utils",
1911
+ "Asynchronously validate the deployment and run all tests in the org with alias \"my-prod-org\"; command immediately returns the job ID:\n<%= config.bin %> <%= command.id %> --source-dir force-app --async --test-level RunAllTestsInOrg --target-org my-prod-org",
1912
+ "Validate the deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
1913
1913
  ],
1914
1914
  "flags": {
1915
1915
  "json": {
@@ -1937,7 +1937,7 @@
1937
1937
  "type": "option"
1938
1938
  },
1939
1939
  "async": {
1940
- "description": "The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume watching the validation, run \"sf project deploy resume\". To check the status of the validation, run \"sf project deploy report\".",
1940
+ "description": "The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume watching the validation, run \"<%= config.bin %> project deploy resume\". To check the status of the validation, run \"<%= config.bin %> project deploy report\".",
1941
1941
  "name": "async",
1942
1942
  "summary": "Run the command asynchronously.",
1943
1943
  "allowNo": false,
@@ -2046,7 +2046,7 @@
2046
2046
  },
2047
2047
  "wait": {
2048
2048
  "char": "w",
2049
- "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To resume watching the validation, run \"sf project deploy resume\". To check the status of the validation, run \"sf project deploy report\".",
2049
+ "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To resume watching the validation, run \"<%= config.bin %> project deploy resume\". To check the status of the validation, run \"<%= config.bin %> project deploy report\".",
2050
2050
  "name": "wait",
2051
2051
  "summary": "Number of minutes to wait for the command to complete and display results.",
2052
2052
  "hasDynamicHelp": true,
@@ -2251,10 +2251,10 @@
2251
2251
  "deprecateAliases": true,
2252
2252
  "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.",
2253
2253
  "examples": [
2254
- "Create a manifest for deploying or retrieving all Apex classes and custom objects:\n$ sf <%= command.id %> --metadata ApexClass --metadata CustomObject",
2255
- "Create a manifest for deleting the specified Apex class:\n$ sf <%= command.id %> --metadata ApexClass:MyApexClass --type destroy",
2256
- "Create a manifest for deploying or retrieving all the metadata components in the specified local directory; name the file myNewManifest.xml:\n$ sf <%= command.id %> --source-dir force-app --name myNewManifest",
2257
- "Create a manifest from the metadata components in the specified org and include metadata in any unlocked packages:\n$ sf <%= command.id %> --from-org test@myorg.com --include-packages unlocked"
2254
+ "Create a manifest for deploying or retrieving all Apex classes and custom objects:\n$ <%= config.bin %> <%= command.id %> --metadata ApexClass --metadata CustomObject",
2255
+ "Create a manifest for deleting the specified Apex class:\n$ <%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --type destroy",
2256
+ "Create a manifest for deploying or retrieving all the metadata components in the specified local directory; name the file myNewManifest.xml:\n$ <%= config.bin %> <%= command.id %> --source-dir force-app --name myNewManifest",
2257
+ "Create a manifest from the metadata components in the specified org and include metadata in any unlocked packages:\n$ <%= config.bin %> <%= command.id %> --from-org test@myorg.com --include-packages unlocked"
2258
2258
  ],
2259
2259
  "flags": {
2260
2260
  "json": {
@@ -2457,9 +2457,9 @@
2457
2457
  "deprecateAliases": true,
2458
2458
  "description": "When deploying or retrieving metadata between your local project and an org, you can specify the source files you want to exclude with a .forceignore file. The .forceignore file structure mimics the .gitignore structure. Each line in .forceignore specifies a pattern that corresponds to one or more files. The files typically represent metadata components, but can be any files you want to exclude, such as LWC configuration JSON files or tests.",
2459
2459
  "examples": [
2460
- "List all the files in all package directories that are ignored:\nsf <%= command.id %>",
2461
- "List all the files in a specific directory that are ignored:\nsf <%= command.id %> --source-dir force-app",
2462
- "Check if a particular file is ignored:\nsf <%= command.id %> --source-dir package.xml"
2460
+ "List all the files in all package directories that are ignored:\n<%= config.bin %> <%= command.id %>",
2461
+ "List all the files in a specific directory that are ignored:\n<%= config.bin %> <%= command.id %> --source-dir force-app",
2462
+ "Check if a particular file is ignored:\n<%= config.bin %> <%= command.id %> --source-dir package.xml"
2463
2463
  ],
2464
2464
  "flags": {
2465
2465
  "json": {
@@ -2549,10 +2549,10 @@
2549
2549
  ],
2550
2550
  "args": {},
2551
2551
  "deprecateAliases": true,
2552
- "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 sf data query --query \"SELECT MemberName, MemberType, RevisionCounter FROM SourceMember\" --use-tooling-api --target-org my-scratch",
2552
+ "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",
2553
2553
  "examples": [
2554
- "Reset source tracking for the org with alias \"my-scratch\":\n$ sf <%= command.id %> --target-org my-scratch",
2555
- "Reset source tracking to revision number 30 for your default org:\n$ sf <%= command.id %> --revision 30"
2554
+ "Reset source tracking for the org with alias \"my-scratch\":\n$ <%= config.bin %> <%= command.id %> --target-org my-scratch",
2555
+ "Reset source tracking to revision number 30 for your default org:\n$ <%= config.bin %> <%= command.id %> --revision 30"
2556
2556
  ],
2557
2557
  "flags": {
2558
2558
  "json": {
@@ -2685,10 +2685,10 @@
2685
2685
  ],
2686
2686
  "args": {},
2687
2687
  "deprecateAliases": true,
2688
- "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 \"sf project retrieve start\" command. The table lists the metadata components that will be retrieved 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 retrieved 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 \"sf org create scratch|sandbox\" commands.",
2688
+ "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 retrieve start\" command. The table lists the metadata components that will be retrieved 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 retrieved 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.",
2689
2689
  "examples": [
2690
- "Preview the retrieve of all changes from your default org:\nsf <%= command.id %>",
2691
- "Preview the retrieve when ignoring any conflicts from an org with alias \"my-scratch\":\nsf <%= command.id %> --ignore-conflicts --target-org my-scratch"
2690
+ "Preview the retrieve of all changes from your default org:\n<%= config.bin %> <%= command.id %>",
2691
+ "Preview the retrieve when ignoring any conflicts from an org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --ignore-conflicts --target-org my-scratch"
2692
2692
  ],
2693
2693
  "flags": {
2694
2694
  "json": {
@@ -2772,22 +2772,22 @@
2772
2772
  ],
2773
2773
  "args": {},
2774
2774
  "deprecateAliases": true,
2775
- "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 \"sf 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.",
2775
+ "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.",
2776
2776
  "examples": [
2777
- "Retrieve all remote changes from your default org:\nsf <%= command.id %>",
2778
- "Retrieve the source files in the \"force-app\" directory from an org with alias \"my-scratch\":\nsf <%= command.id %> --source-dir force-app --target-org my-scratch",
2779
- "Retrieve all the Apex classes and custom objects whose source is in the \"force-app\" directory. The list views, layouts, etc, that are associated with the custom objects are also retrieved. Both examples are equivalent:\nsf <%= command.id %> --source-dir force-app/main/default/classes force-app/main/default/objects\nsf <%= command.id %> --source-dir force-app/main/default/classes --source-dir force-app/main/default/objects",
2780
- "Retrieve all Apex classes that are in all package directories defined in the \"sfdx-project.json\" file:\nsf <%= command.id %> --metadata ApexClass",
2781
- "Retrieve a specific Apex class; ignore any conflicts between the local project and org (be careful with this flag, because it will overwrite the Apex class source files in your local project if there are conflicts!):\nsf <%= command.id %> --metadata ApexClass:MyApexClass --ignore-conflicts",
2782
- "Retrieve specific Apex classes that match a pattern; in this example, retrieve Apex classes whose names contain the string \"MyApex\":\nsf <%= command.id %> --metadata 'ApexClass:MyApex*'",
2777
+ "Retrieve all remote changes from your default org:\n<%= config.bin %> <%= command.id %>",
2778
+ "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",
2779
+ "Retrieve all the Apex classes and custom objects whose source is in the \"force-app\" directory. The list views, layouts, etc, that are associated with the custom objects are also retrieved. Both examples are equivalent:\n<%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes force-app/main/default/objects\n<%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes --source-dir force-app/main/default/objects",
2780
+ "Retrieve all Apex classes that are in all package directories defined in the \"sfdx-project.json\" file:\n<%= config.bin %> <%= command.id %> --metadata ApexClass",
2781
+ "Retrieve a specific Apex class; ignore any conflicts between the local project and org (be careful with this flag, because it will overwrite the Apex class source files in your local project if there are conflicts!):\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --ignore-conflicts",
2782
+ "Retrieve specific Apex classes that match a pattern; in this example, retrieve Apex classes whose names contain the string \"MyApex\":\n<%= config.bin %> <%= command.id %> --metadata 'ApexClass:MyApex*'",
2783
2783
  "Retrieve a custom object called ExcitingObject that's in the SBQQ namespace:\nsf <%= command.id %> --metadata CustomObject:SBQQ__ExcitingObject",
2784
2784
  "Retrieve all custom objects in the SBQQ namespace by using a wildcard and quotes:\nsf <%= command.id %> --metadata 'CustomObject:SBQQ__*'",
2785
- "Retrieve all custom objects and Apex classes found in all defined package directories (both examples are equivalent):\nsf <%= command.id %> --metadata CustomObject ApexClass\nsf <%= command.id %> --metadata CustomObject --metadata ApexClass",
2786
- "Retrieve all metadata components listed in a manifest:\nsf <%= command.id %> --manifest path/to/package.xml",
2787
- "Retrieve metadata from a package:\nsf <%= command.id %> --package-name MyPackageName",
2788
- "Retrieve metadata from multiple packages, one of which has a space in its name (both examples are equivalent):\nsf <%= command.id %> --package-name Package1 \"PackageName With Spaces\" Package3\nsf <%= command.id %> --package-name Package1 --package-name \"PackageName With Spaces\" --package-name Package3",
2789
- "Retrieve the metadata components listed in the force-app directory, but retrieve them in metadata format into a ZIP file in the \"output\" directory:\nsf <%= command.id %> --source-dir force-app --target-metadata-dir output",
2790
- "Retrieve in metadata format and automatically extract the contents into the \"output\" directory:\nsf <%= command.id %> --source-dir force-app --target-metadata-dir output --unzip"
2785
+ "Retrieve all custom objects and Apex classes found in all defined package directories (both examples are equivalent):\n<%= config.bin %> <%= command.id %> --metadata CustomObject ApexClass\n<%= config.bin %> <%= command.id %> --metadata CustomObject --metadata ApexClass",
2786
+ "Retrieve all metadata components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml",
2787
+ "Retrieve metadata from a package:\n<%= config.bin %> <%= command.id %> --package-name MyPackageName",
2788
+ "Retrieve metadata from multiple packages, one of which has a space in its name (both examples are equivalent):\n<%= config.bin %> <%= command.id %> --package-name Package1 \"PackageName With Spaces\" Package3\n<%= config.bin %> <%= command.id %> --package-name Package1 --package-name \"PackageName With Spaces\" --package-name Package3",
2789
+ "Retrieve the metadata components listed in the force-app directory, but retrieve them in metadata format into a ZIP file in the \"output\" directory:\n<%= config.bin %> <%= command.id %> --source-dir force-app --target-metadata-dir output",
2790
+ "Retrieve in metadata format and automatically extract the contents into the \"output\" directory:\n<%= config.bin %> <%= command.id %> --source-dir force-app --target-metadata-dir output --unzip"
2791
2791
  ],
2792
2792
  "flags": {
2793
2793
  "json": {
@@ -3023,5 +3023,5 @@
3023
3023
  ]
3024
3024
  }
3025
3025
  },
3026
- "version": "3.8.4"
3026
+ "version": "3.9.0"
3027
3027
  }
package/package.json CHANGED
@@ -1,25 +1,25 @@
1
1
  {
2
2
  "name": "@salesforce/plugin-deploy-retrieve",
3
3
  "description": "deploy and retrieve commands for sf",
4
- "version": "3.8.4",
4
+ "version": "3.9.0",
5
5
  "author": "Salesforce",
6
6
  "bugs": "https://github.com/forcedotcom/cli/issues",
7
7
  "dependencies": {
8
- "@oclif/core": "^3.26.6",
8
+ "@oclif/core": "^4",
9
9
  "@salesforce/apex-node": "^6.0.0",
10
10
  "@salesforce/core": "^7.3.9",
11
11
  "@salesforce/kit": "^3.1.2",
12
12
  "@salesforce/plugin-info": "^3.3.4",
13
- "@salesforce/sf-plugins-core": "^9.1.0",
14
- "@salesforce/source-deploy-retrieve": "^11.6.3",
15
- "@salesforce/source-tracking": "^6.3.2",
13
+ "@salesforce/sf-plugins-core": "^10.0.0",
14
+ "@salesforce/source-deploy-retrieve": "^11.6.5",
15
+ "@salesforce/source-tracking": "^6.3.4",
16
16
  "@salesforce/ts-types": "^2.0.9",
17
17
  "chalk": "^5.3.0"
18
18
  },
19
19
  "devDependencies": {
20
20
  "@oclif/plugin-command-snapshot": "^5.2.0",
21
21
  "@salesforce/cli-plugins-testkit": "^5.3.8",
22
- "@salesforce/dev-scripts": "^9.1.2",
22
+ "@salesforce/dev-scripts": "^9.1.3",
23
23
  "@salesforce/plugin-command-reference": "^3.0.86",
24
24
  "@salesforce/schemas": "^1.9.0",
25
25
  "@salesforce/source-testkit": "^2.2.22",
@@ -250,7 +250,7 @@
250
250
  "exports": "./lib/index.js",
251
251
  "type": "module",
252
252
  "sfdx": {
253
- "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-deploy-retrieve/3.8.4.crt",
254
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-deploy-retrieve/3.8.4.sig"
253
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-deploy-retrieve/3.9.0.crt",
254
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-deploy-retrieve/3.9.0.sig"
255
255
  }
256
256
  }