@salesforce/plugin-deploy-retrieve 1.20.3 → 2.0.1

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 (129) hide show
  1. package/README.md +66 -64
  2. package/lib/commands/deploy.d.ts +1 -1
  3. package/lib/commands/deploy.js +48 -51
  4. package/lib/commands/deploy.js.map +1 -1
  5. package/lib/commands/project/convert/mdapi.d.ts +8 -8
  6. package/lib/commands/project/convert/mdapi.js +63 -63
  7. package/lib/commands/project/convert/mdapi.js.map +1 -1
  8. package/lib/commands/project/convert/source.d.ts +16 -40
  9. package/lib/commands/project/convert/source.js +71 -72
  10. package/lib/commands/project/convert/source.js.map +1 -1
  11. package/lib/commands/project/delete/source.d.ts +9 -61
  12. package/lib/commands/project/delete/source.js +182 -180
  13. package/lib/commands/project/delete/source.js.map +1 -1
  14. package/lib/commands/project/delete/tracking.d.ts +4 -4
  15. package/lib/commands/project/delete/tracking.js +27 -29
  16. package/lib/commands/project/delete/tracking.js.map +1 -1
  17. package/lib/commands/project/deploy/cancel.d.ts +5 -5
  18. package/lib/commands/project/deploy/cancel.js +58 -59
  19. package/lib/commands/project/deploy/cancel.js.map +1 -1
  20. package/lib/commands/project/deploy/preview.d.ts +6 -6
  21. package/lib/commands/project/deploy/preview.js +57 -58
  22. package/lib/commands/project/deploy/preview.js.map +1 -1
  23. package/lib/commands/project/deploy/quick.d.ts +9 -9
  24. package/lib/commands/project/deploy/quick.js +85 -86
  25. package/lib/commands/project/deploy/quick.js.map +1 -1
  26. package/lib/commands/project/deploy/report.d.ts +8 -60
  27. package/lib/commands/project/deploy/report.js +72 -73
  28. package/lib/commands/project/deploy/report.js.map +1 -1
  29. package/lib/commands/project/deploy/resume.d.ts +9 -61
  30. package/lib/commands/project/deploy/resume.js +82 -83
  31. package/lib/commands/project/deploy/resume.js.map +1 -1
  32. package/lib/commands/project/deploy/start.d.ts +24 -128
  33. package/lib/commands/project/deploy/start.js +168 -169
  34. package/lib/commands/project/deploy/start.js.map +1 -1
  35. package/lib/commands/project/deploy/validate.d.ts +21 -125
  36. package/lib/commands/project/deploy/validate.js +149 -149
  37. package/lib/commands/project/deploy/validate.js.map +1 -1
  38. package/lib/commands/project/generate/manifest.d.ts +9 -9
  39. package/lib/commands/project/generate/manifest.js +73 -78
  40. package/lib/commands/project/generate/manifest.js.map +1 -1
  41. package/lib/commands/project/list/ignored.d.ts +1 -1
  42. package/lib/commands/project/list/ignored.js +27 -29
  43. package/lib/commands/project/list/ignored.js.map +1 -1
  44. package/lib/commands/project/reset/tracking.d.ts +5 -5
  45. package/lib/commands/project/reset/tracking.js +33 -35
  46. package/lib/commands/project/reset/tracking.js.map +1 -1
  47. package/lib/commands/project/retrieve/preview.d.ts +3 -3
  48. package/lib/commands/project/retrieve/preview.js +35 -36
  49. package/lib/commands/project/retrieve/preview.js.map +1 -1
  50. package/lib/commands/project/retrieve/start.d.ts +11 -11
  51. package/lib/commands/project/retrieve/start.js +148 -149
  52. package/lib/commands/project/retrieve/start.js.map +1 -1
  53. package/lib/configMeta.js +8 -9
  54. package/lib/configMeta.js.map +1 -1
  55. package/lib/formatters/asyncDeployCancelResultFormatter.d.ts +1 -1
  56. package/lib/formatters/asyncDeployCancelResultFormatter.js +12 -12
  57. package/lib/formatters/asyncDeployCancelResultFormatter.js.map +1 -1
  58. package/lib/formatters/asyncDeployResultFormatter.d.ts +1 -1
  59. package/lib/formatters/asyncDeployResultFormatter.js +14 -14
  60. package/lib/formatters/asyncDeployResultFormatter.js.map +1 -1
  61. package/lib/formatters/deleteResultFormatter.d.ts +2 -2
  62. package/lib/formatters/deleteResultFormatter.js +21 -23
  63. package/lib/formatters/deleteResultFormatter.js.map +1 -1
  64. package/lib/formatters/deployCancelResultFormatter.d.ts +1 -1
  65. package/lib/formatters/deployCancelResultFormatter.js +7 -10
  66. package/lib/formatters/deployCancelResultFormatter.js.map +1 -1
  67. package/lib/formatters/deployReportResultFormatter.d.ts +1 -1
  68. package/lib/formatters/deployReportResultFormatter.js +18 -22
  69. package/lib/formatters/deployReportResultFormatter.js.map +1 -1
  70. package/lib/formatters/deployResultFormatter.d.ts +2 -2
  71. package/lib/formatters/deployResultFormatter.js +53 -50
  72. package/lib/formatters/deployResultFormatter.js.map +1 -1
  73. package/lib/formatters/metadataConvertResultFormatter.d.ts +1 -1
  74. package/lib/formatters/metadataConvertResultFormatter.js +7 -9
  75. package/lib/formatters/metadataConvertResultFormatter.js.map +1 -1
  76. package/lib/formatters/metadataRetrieveResultFormatter.d.ts +1 -1
  77. package/lib/formatters/metadataRetrieveResultFormatter.js +17 -16
  78. package/lib/formatters/metadataRetrieveResultFormatter.js.map +1 -1
  79. package/lib/formatters/retrieveResultFormatter.d.ts +1 -1
  80. package/lib/formatters/retrieveResultFormatter.js +17 -17
  81. package/lib/formatters/retrieveResultFormatter.js.map +1 -1
  82. package/lib/formatters/sourceConvertResultFormatter.d.ts +1 -1
  83. package/lib/formatters/sourceConvertResultFormatter.js +12 -14
  84. package/lib/formatters/sourceConvertResultFormatter.js.map +1 -1
  85. package/lib/formatters/testResultsFormatter.d.ts +1 -1
  86. package/lib/formatters/testResultsFormatter.js +38 -38
  87. package/lib/formatters/testResultsFormatter.js.map +1 -1
  88. package/lib/hooks/deploy.d.ts +1 -1
  89. package/lib/hooks/deploy.js +5 -7
  90. package/lib/hooks/deploy.js.map +1 -1
  91. package/lib/index.d.ts +1 -1
  92. package/lib/index.js +1 -2
  93. package/lib/index.js.map +1 -1
  94. package/lib/utils/conflicts.js +3 -7
  95. package/lib/utils/conflicts.js.map +1 -1
  96. package/lib/utils/coverage.js +20 -30
  97. package/lib/utils/coverage.js.map +1 -1
  98. package/lib/utils/deploy.d.ts +1 -1
  99. package/lib/utils/deploy.js +55 -64
  100. package/lib/utils/deploy.js.map +1 -1
  101. package/lib/utils/deployCache.d.ts +1 -1
  102. package/lib/utils/deployCache.js +12 -16
  103. package/lib/utils/deployCache.js.map +1 -1
  104. package/lib/utils/errorCodes.js +15 -16
  105. package/lib/utils/errorCodes.js.map +1 -1
  106. package/lib/utils/flags.d.ts +25 -7
  107. package/lib/utils/flags.js +24 -27
  108. package/lib/utils/flags.js.map +1 -1
  109. package/lib/utils/manifestCache.js +9 -14
  110. package/lib/utils/manifestCache.js.map +1 -1
  111. package/lib/utils/metadataDeployer.d.ts +1 -1
  112. package/lib/utils/metadataDeployer.js +40 -39
  113. package/lib/utils/metadataDeployer.js.map +1 -1
  114. package/lib/utils/output.js +13 -22
  115. package/lib/utils/output.js.map +1 -1
  116. package/lib/utils/previewOutput.js +46 -52
  117. package/lib/utils/previewOutput.js.map +1 -1
  118. package/lib/utils/progressBar.js +19 -21
  119. package/lib/utils/progressBar.js.map +1 -1
  120. package/lib/utils/project.js +7 -13
  121. package/lib/utils/project.js.map +1 -1
  122. package/lib/utils/promiseQueue.js +3 -7
  123. package/lib/utils/promiseQueue.js.map +1 -1
  124. package/lib/utils/types.js +12 -19
  125. package/lib/utils/types.js.map +1 -1
  126. package/oclif.lock +8667 -0
  127. package/oclif.manifest.json +1442 -942
  128. package/package.json +37 -35
  129. package/schemas/project-retrieve-start.json +14 -11
@@ -1,373 +1,450 @@
1
1
  {
2
- "version": "1.20.3",
3
2
  "commands": {
4
3
  "deploy": {
5
- "id": "deploy",
6
- "summary": "Deploy a project interactively to any Salesforce environment.",
7
- "description": "This command must be run from within a project.\n\nThe command first analyzes your project, your active or logged-into environments, and local defaults to determine what to deploy and where to deploy it. The command then prompts you for information about this particular deployment and provides intelligent choices based on its analysis.\n\nFor example, if your local project contains a source directory with metadata files in source format, the command asks if you want to deploy that Salesforce app to an org. The command lists your connected orgs and asks which one you want to deploy to. The list of orgs starts with scratch orgs, ordered by expiration date with the most recently created one first, and then Dev Hub and production orgs ordered by name. If the command finds Apex tests, it asks if you want to run them and at which level.\n\nThe command stores your responses in the \"deploy-options.json\" file in your local project directory and uses them as defaults when you rerun the command. Specify --interactive to force the command to reprompt.\n\nUse this command for quick and simple deploys. For more complicated deployments, use the environment-specific commands, such as \"<%= config.bin %> project deploy start\", that provide additional flags.",
8
- "strict": true,
9
- "pluginName": "@salesforce/plugin-deploy-retrieve",
10
- "pluginAlias": "@salesforce/plugin-deploy-retrieve",
11
- "pluginType": "core",
12
- "hidden": true,
13
- "state": "deprecated",
14
4
  "aliases": [],
15
- "examples": [
16
- "Deploy a project and use stored values from a previous command run:\n<%= config.bin %> <%= command.id %>",
17
- "Reprompt for all deployment inputs:\n<%= config.bin %> <%= command.id %> --interactive"
18
- ],
5
+ "args": {},
19
6
  "deprecationOptions": {
20
7
  "version": "59.0",
21
8
  "message": "The top-level deploy command is deprecated. You should use `functions deploy` to deploy functions, and use `project deploy start` to deploy metadata to Salesforce orgs."
22
9
  },
10
+ "description": "This command must be run from within a project.\n\nThe command first analyzes your project, your active or logged-into environments, and local defaults to determine what to deploy and where to deploy it. The command then prompts you for information about this particular deployment and provides intelligent choices based on its analysis.\n\nFor example, if your local project contains a source directory with metadata files in source format, the command asks if you want to deploy that Salesforce app to an org. The command lists your connected orgs and asks which one you want to deploy to. The list of orgs starts with scratch orgs, ordered by expiration date with the most recently created one first, and then Dev Hub and production orgs ordered by name. If the command finds Apex tests, it asks if you want to run them and at which level.\n\nThe command stores your responses in the \"deploy-options.json\" file in your local project directory and uses them as defaults when you rerun the command. Specify --interactive to force the command to reprompt.\n\nUse this command for quick and simple deploys. For more complicated deployments, use the environment-specific commands, such as \"<%= config.bin %> project deploy start\", that provide additional flags.",
11
+ "examples": [
12
+ "Deploy a project and use stored values from a previous command run:\n<%= config.bin %> <%= command.id %>",
13
+ "Reprompt for all deployment inputs:\n<%= config.bin %> <%= command.id %> --interactive"
14
+ ],
23
15
  "flags": {
24
16
  "interactive": {
25
17
  "name": "interactive",
26
- "type": "boolean",
27
18
  "summary": "Force the CLI to prompt for all deployment inputs.",
28
- "allowNo": false
19
+ "allowNo": false,
20
+ "type": "boolean"
29
21
  }
30
22
  },
31
- "args": {}
32
- },
33
- "project:convert:mdapi": {
34
- "id": "project:convert:mdapi",
35
- "summary": "Convert metadata retrieved via Metadata API into the source format used in Salesforce DX projects.",
36
- "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 \"<%= config.bin %> 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.",
37
- "strict": true,
38
- "pluginName": "@salesforce/plugin-deploy-retrieve",
23
+ "hasDynamicHelp": false,
24
+ "hidden": true,
25
+ "hiddenAliases": [],
26
+ "id": "deploy",
39
27
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
28
+ "pluginName": "@salesforce/plugin-deploy-retrieve",
40
29
  "pluginType": "core",
30
+ "state": "deprecated",
31
+ "strict": true,
32
+ "summary": "Deploy a project interactively to any Salesforce environment.",
33
+ "enableJsonFlag": false,
34
+ "SF_ENV": "SF_ENV",
35
+ "isESM": true,
36
+ "relativePath": [
37
+ "lib",
38
+ "commands",
39
+ "deploy.js"
40
+ ],
41
+ "aliasPermutations": [],
42
+ "permutations": [
43
+ "deploy"
44
+ ]
45
+ },
46
+ "project:convert:mdapi": {
41
47
  "aliases": [
42
48
  "force:mdapi:convert"
43
49
  ],
50
+ "args": {},
51
+ "deprecateAliases": true,
52
+ "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 \"<%= config.bin %> 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.",
44
53
  "examples": [
45
54
  "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",
46
55
  "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"
47
56
  ],
48
- "deprecateAliases": true,
49
57
  "flags": {
50
58
  "json": {
51
- "name": "json",
52
- "type": "boolean",
53
59
  "description": "Format output as json.",
54
60
  "helpGroup": "GLOBAL",
61
+ "name": "json",
55
62
  "allowNo": false,
56
- "deprecateAliases": true
63
+ "type": "boolean"
57
64
  },
58
65
  "api-version": {
59
- "name": "api-version",
60
- "type": "option",
61
- "description": "Override the api version used for api requests made by this command",
62
- "multiple": false,
63
- "deprecateAliases": true,
64
66
  "aliases": [
65
67
  "apiversion"
66
- ]
68
+ ],
69
+ "deprecateAliases": true,
70
+ "description": "Override the api version used for api requests made by this command",
71
+ "name": "api-version",
72
+ "hasDynamicHelp": false,
73
+ "multiple": false,
74
+ "type": "option"
67
75
  },
68
76
  "loglevel": {
69
- "name": "loglevel",
70
- "type": "option",
71
- "hidden": true,
72
- "multiple": false,
73
77
  "deprecated": {
74
78
  "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
75
79
  },
76
- "deprecateAliases": true
80
+ "hidden": true,
81
+ "name": "loglevel",
82
+ "hasDynamicHelp": false,
83
+ "multiple": false,
84
+ "type": "option"
77
85
  },
78
86
  "root-dir": {
79
- "name": "root-dir",
80
- "type": "option",
87
+ "aliases": [
88
+ "rootdir"
89
+ ],
81
90
  "char": "r",
82
- "summary": "Root directory that contains the Metadata API–formatted metadata.",
91
+ "deprecateAliases": true,
92
+ "name": "root-dir",
83
93
  "required": true,
94
+ "summary": "Root directory that contains the Metadata API–formatted metadata.",
95
+ "hasDynamicHelp": false,
84
96
  "multiple": false,
85
- "deprecateAliases": true,
86
- "aliases": [
87
- "rootdir"
88
- ]
97
+ "type": "option"
89
98
  },
90
99
  "output-dir": {
91
- "name": "output-dir",
92
- "type": "option",
100
+ "aliases": [
101
+ "outputdir"
102
+ ],
93
103
  "char": "d",
104
+ "deprecateAliases": true,
105
+ "name": "output-dir",
94
106
  "summary": "Directory to store your files in after they’re converted to source format; can be an absolute or relative path.",
107
+ "hasDynamicHelp": false,
95
108
  "multiple": false,
96
- "deprecateAliases": true,
97
- "aliases": [
98
- "outputdir"
99
- ]
109
+ "type": "option"
100
110
  },
101
111
  "manifest": {
102
- "name": "manifest",
103
- "type": "option",
104
112
  "char": "x",
105
- "summary": "File path to manifest (package.xml) of metadata types to convert.",
106
113
  "description": "If you specify this parameter, don’t specify --metadata or --source-dir.",
114
+ "name": "manifest",
115
+ "summary": "File path to manifest (package.xml) of metadata types to convert.",
116
+ "hasDynamicHelp": false,
107
117
  "multiple": false,
108
- "deprecateAliases": true
118
+ "type": "option"
109
119
  },
110
120
  "metadata-dir": {
111
- "name": "metadata-dir",
112
- "type": "option",
121
+ "aliases": [
122
+ "metadatapath"
123
+ ],
113
124
  "char": "p",
114
- "summary": "Root of directory or zip file of metadata formatted files to convert.",
125
+ "deprecateAliases": true,
115
126
  "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. If the comma-separated list you’re supplying contains spaces, enclose the entire comma-separated list in one set of double quotes.",
116
- "multiple": true,
117
127
  "exclusive": [
118
128
  "manifest",
119
129
  "metadata"
120
130
  ],
121
- "deprecateAliases": true,
122
- "aliases": [
123
- "metadatapath"
124
- ],
125
- "delimiter": ","
131
+ "name": "metadata-dir",
132
+ "summary": "Root of directory or zip file of metadata formatted files to convert.",
133
+ "delimiter": ",",
134
+ "hasDynamicHelp": false,
135
+ "multiple": true,
136
+ "type": "option"
126
137
  },
127
138
  "metadata": {
128
- "name": "metadata",
129
- "type": "option",
130
139
  "char": "m",
131
- "summary": "Metadata component names to convert.",
132
- "multiple": true,
133
140
  "exclusive": [
134
141
  "manifest",
135
142
  "metadatapath"
136
143
  ],
137
- "deprecateAliases": true,
138
- "delimiter": ","
144
+ "name": "metadata",
145
+ "summary": "Metadata component names to convert.",
146
+ "delimiter": ",",
147
+ "hasDynamicHelp": false,
148
+ "multiple": true,
149
+ "type": "option"
139
150
  }
140
151
  },
141
- "args": {},
142
- "requiresProject": true
143
- },
144
- "project:convert:source": {
145
- "id": "project:convert:source",
146
- "summary": "Convert source-formatted files into metadata that you can deploy using Metadata API.",
147
- "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.",
148
- "strict": true,
149
- "pluginName": "@salesforce/plugin-deploy-retrieve",
152
+ "hasDynamicHelp": false,
153
+ "hiddenAliases": [],
154
+ "id": "project:convert:mdapi",
150
155
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
156
+ "pluginName": "@salesforce/plugin-deploy-retrieve",
151
157
  "pluginType": "core",
158
+ "strict": true,
159
+ "summary": "Convert metadata retrieved via Metadata API into the source format used in Salesforce DX projects.",
160
+ "enableJsonFlag": true,
161
+ "SF_ENV": "SF_ENV",
162
+ "requiresProject": true,
163
+ "isESM": true,
164
+ "relativePath": [
165
+ "lib",
166
+ "commands",
167
+ "project",
168
+ "convert",
169
+ "mdapi.js"
170
+ ],
171
+ "aliasPermutations": [
172
+ "force:mdapi:convert",
173
+ "mdapi:force:convert",
174
+ "mdapi:convert:force",
175
+ "force:convert:mdapi",
176
+ "convert:force:mdapi",
177
+ "convert:mdapi:force"
178
+ ],
179
+ "permutations": [
180
+ "project:convert:mdapi",
181
+ "convert:project:mdapi",
182
+ "convert:mdapi:project",
183
+ "project:mdapi:convert",
184
+ "mdapi:project:convert",
185
+ "mdapi:convert:project"
186
+ ]
187
+ },
188
+ "project:convert:source": {
152
189
  "aliases": [
153
190
  "force:source:convert"
154
191
  ],
192
+ "args": {},
193
+ "deprecateAliases": true,
194
+ "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.",
155
195
  "examples": [
156
196
  "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",
157
197
  "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'"
158
198
  ],
159
- "deprecateAliases": true,
160
199
  "flags": {
161
200
  "json": {
162
- "name": "json",
163
- "type": "boolean",
164
201
  "description": "Format output as json.",
165
202
  "helpGroup": "GLOBAL",
203
+ "name": "json",
166
204
  "allowNo": false,
167
- "deprecateAliases": true
205
+ "type": "boolean"
168
206
  },
169
207
  "api-version": {
208
+ "aliases": [
209
+ "apiversion"
210
+ ],
211
+ "deprecateAliases": true,
212
+ "description": "Override the api version used for api requests made by this command",
170
213
  "name": "api-version",
171
- "type": "option",
172
214
  "summary": "API Version to use in the generated project's manifest. By default, will use the version from sfdx-project.json",
173
- "description": "Override the api version used for api requests made by this command",
215
+ "hasDynamicHelp": false,
174
216
  "multiple": false,
175
- "deprecateAliases": true,
176
- "aliases": [
177
- "apiversion"
178
- ]
217
+ "type": "option"
179
218
  },
180
219
  "loglevel": {
181
- "name": "loglevel",
182
- "type": "option",
183
- "hidden": true,
184
- "multiple": false,
185
220
  "deprecated": {
186
221
  "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
187
222
  },
188
- "deprecateAliases": true
223
+ "hidden": true,
224
+ "name": "loglevel",
225
+ "hasDynamicHelp": false,
226
+ "multiple": false,
227
+ "type": "option"
189
228
  },
190
229
  "root-dir": {
191
- "name": "root-dir",
192
- "type": "option",
230
+ "aliases": [
231
+ "rootdir"
232
+ ],
193
233
  "char": "r",
234
+ "deprecateAliases": true,
235
+ "name": "root-dir",
194
236
  "summary": "Source directory other than the default package to convert.",
237
+ "hasDynamicHelp": false,
195
238
  "multiple": false,
196
- "deprecateAliases": true,
197
- "aliases": [
198
- "rootdir"
199
- ]
239
+ "type": "option"
200
240
  },
201
241
  "output-dir": {
202
- "name": "output-dir",
203
- "type": "option",
242
+ "aliases": [
243
+ "outputdir"
244
+ ],
204
245
  "char": "d",
246
+ "deprecateAliases": true,
247
+ "name": "output-dir",
205
248
  "summary": "Output directory to store the Metadata API–formatted files in.",
249
+ "default": "metadataPackage_1699992997194",
250
+ "hasDynamicHelp": false,
206
251
  "multiple": false,
207
- "default": "metadataPackage_1699692439328",
208
- "deprecateAliases": true,
209
- "aliases": [
210
- "outputdir"
211
- ]
252
+ "type": "option"
212
253
  },
213
254
  "package-name": {
214
- "name": "package-name",
215
- "type": "option",
255
+ "aliases": [
256
+ "packagename"
257
+ ],
216
258
  "char": "n",
259
+ "deprecateAliases": true,
260
+ "name": "package-name",
217
261
  "summary": "Name of the package to associate with the metadata-formatted files.",
262
+ "hasDynamicHelp": false,
218
263
  "multiple": false,
219
- "deprecateAliases": true,
220
- "aliases": [
221
- "packagename"
222
- ]
264
+ "type": "option"
223
265
  },
224
266
  "manifest": {
225
- "name": "manifest",
226
- "type": "option",
227
267
  "char": "x",
228
- "summary": "Path to the manifest (package.xml) file that specifies the metadata types to convert.",
229
268
  "description": "If you specify this parameter, don’t specify --metadata or --source-dir.",
269
+ "name": "manifest",
270
+ "summary": "Path to the manifest (package.xml) file that specifies the metadata types to convert.",
271
+ "hasDynamicHelp": false,
230
272
  "multiple": false,
231
- "deprecateAliases": true
273
+ "type": "option"
232
274
  },
233
275
  "source-dir": {
234
- "name": "source-dir",
235
- "type": "option",
276
+ "aliases": [
277
+ "sourcepath"
278
+ ],
236
279
  "char": "p",
237
- "summary": "Paths to the local source files to convert.",
280
+ "deprecateAliases": true,
238
281
  "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.",
239
- "multiple": true,
240
282
  "exclusive": [
241
283
  "manifest",
242
284
  "metadata"
243
285
  ],
244
- "deprecateAliases": true,
245
- "aliases": [
246
- "sourcepath"
247
- ],
248
- "delimiter": ","
286
+ "name": "source-dir",
287
+ "summary": "Paths to the local source files to convert.",
288
+ "delimiter": ",",
289
+ "hasDynamicHelp": false,
290
+ "multiple": true,
291
+ "type": "option"
249
292
  },
250
293
  "metadata": {
251
- "name": "metadata",
252
- "type": "option",
253
294
  "char": "m",
254
- "summary": "Metadata component names to convert.",
255
- "multiple": true,
256
295
  "exclusive": [
257
296
  "manifest",
258
297
  "sourcepath"
259
298
  ],
260
- "deprecateAliases": true,
261
- "delimiter": ","
299
+ "name": "metadata",
300
+ "summary": "Metadata component names to convert.",
301
+ "delimiter": ",",
302
+ "hasDynamicHelp": false,
303
+ "multiple": true,
304
+ "type": "option"
262
305
  }
263
306
  },
264
- "args": {},
265
- "requiresProject": true
266
- },
267
- "project:delete:source": {
268
- "id": "project:delete:source",
269
- "summary": "Delete source from your project and from a non-source-tracked org.",
270
- "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.",
271
- "strict": true,
272
- "pluginName": "@salesforce/plugin-deploy-retrieve",
307
+ "hasDynamicHelp": false,
308
+ "hiddenAliases": [],
309
+ "id": "project:convert:source",
273
310
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
311
+ "pluginName": "@salesforce/plugin-deploy-retrieve",
274
312
  "pluginType": "core",
313
+ "strict": true,
314
+ "summary": "Convert source-formatted files into metadata that you can deploy using Metadata API.",
315
+ "enableJsonFlag": true,
316
+ "SF_ENV": "SF_ENV",
317
+ "requiresProject": true,
318
+ "isESM": true,
319
+ "relativePath": [
320
+ "lib",
321
+ "commands",
322
+ "project",
323
+ "convert",
324
+ "source.js"
325
+ ],
326
+ "aliasPermutations": [
327
+ "force:source:convert",
328
+ "source:force:convert",
329
+ "source:convert:force",
330
+ "force:convert:source",
331
+ "convert:force:source",
332
+ "convert:source:force"
333
+ ],
334
+ "permutations": [
335
+ "project:convert:source",
336
+ "convert:project:source",
337
+ "convert:source:project",
338
+ "project:source:convert",
339
+ "source:project:convert",
340
+ "source:convert:project"
341
+ ]
342
+ },
343
+ "project:delete:source": {
275
344
  "aliases": [
276
345
  "force:source:delete"
277
346
  ],
347
+ "args": {},
348
+ "deprecateAliases": true,
349
+ "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.",
278
350
  "examples": [
279
351
  "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",
280
352
  "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",
281
353
  "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",
282
354
  "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"
283
355
  ],
284
- "deprecateAliases": true,
285
356
  "flags": {
286
357
  "json": {
287
- "name": "json",
288
- "type": "boolean",
289
358
  "description": "Format output as json.",
290
359
  "helpGroup": "GLOBAL",
360
+ "name": "json",
291
361
  "allowNo": false,
292
- "deprecateAliases": true
362
+ "type": "boolean"
293
363
  },
294
364
  "api-version": {
295
- "name": "api-version",
296
- "type": "option",
297
- "description": "Override the api version used for api requests made by this command",
298
- "multiple": false,
299
- "deprecateAliases": true,
300
365
  "aliases": [
301
366
  "apiversion"
302
- ]
367
+ ],
368
+ "deprecateAliases": true,
369
+ "description": "Override the api version used for api requests made by this command",
370
+ "name": "api-version",
371
+ "hasDynamicHelp": false,
372
+ "multiple": false,
373
+ "type": "option"
303
374
  },
304
375
  "loglevel": {
305
- "name": "loglevel",
306
- "type": "option",
307
- "hidden": true,
308
- "multiple": false,
309
376
  "deprecated": {
310
377
  "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
311
378
  },
312
- "deprecateAliases": true
379
+ "hidden": true,
380
+ "name": "loglevel",
381
+ "hasDynamicHelp": false,
382
+ "multiple": false,
383
+ "type": "option"
313
384
  },
314
385
  "target-org": {
315
- "name": "target-org",
316
- "type": "option",
317
- "char": "o",
318
- "summary": "Username or alias of the target org.",
319
- "required": true,
320
- "multiple": false,
321
- "deprecateAliases": true,
322
386
  "aliases": [
323
387
  "targetusername",
324
388
  "u"
325
- ]
389
+ ],
390
+ "char": "o",
391
+ "deprecateAliases": true,
392
+ "name": "target-org",
393
+ "noCacheDefault": true,
394
+ "required": true,
395
+ "summary": "Username or alias of the target org.",
396
+ "hasDynamicHelp": true,
397
+ "multiple": false,
398
+ "type": "option"
326
399
  },
327
400
  "check-only": {
328
- "name": "check-only",
329
- "type": "boolean",
401
+ "aliases": [
402
+ "checkonly"
403
+ ],
330
404
  "char": "c",
331
- "summary": "Validate delete command but don't delete anything from the org or the local project.",
405
+ "deprecateAliases": true,
332
406
  "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 --chec-konly 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.",
407
+ "name": "check-only",
408
+ "summary": "Validate delete command but don't delete anything from the org or the local project.",
333
409
  "allowNo": false,
334
- "deprecateAliases": true,
335
- "aliases": [
336
- "checkonly"
337
- ]
410
+ "type": "boolean"
338
411
  },
339
412
  "wait": {
340
- "name": "wait",
341
- "type": "option",
342
413
  "char": "w",
343
- "summary": "Number of minutes to wait for the command to finish.",
344
414
  "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you.",
345
- "multiple": false,
415
+ "name": "wait",
416
+ "summary": "Number of minutes to wait for the command to finish.",
346
417
  "default": {
347
418
  "quantity": 33,
348
419
  "unit": 0
349
420
  },
350
- "deprecateAliases": true
351
- },
352
- "tests": {
353
- "name": "tests",
354
- "type": "option",
355
- "summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
356
- "description": "If a test name contains a space, enclose it in double quotes.\nFor multiple test names, use one of the following formats:\n\n- Repeat the flag for multiple test names: --tests Test1 --tests Test2 --tests \"Test With Space\"\n- Separate the test names with spaces: --tests Test1 Test2 \"Test With Space\"",
357
- "helpGroup": "Test",
358
- "multiple": true,
421
+ "hasDynamicHelp": false,
422
+ "multiple": false,
423
+ "type": "option"
424
+ },
425
+ "tests": {
359
426
  "dependsOn": [
360
427
  "test-level"
361
428
  ],
362
- "deprecateAliases": true
429
+ "description": "If a test name contains a space, enclose it in double quotes.\nFor multiple test names, use one of the following formats:\n\n- Repeat the flag for multiple test names: --tests Test1 --tests Test2 --tests \"Test With Space\"\n- Separate the test names with spaces: --tests Test1 Test2 \"Test With Space\"",
430
+ "helpGroup": "Test",
431
+ "name": "tests",
432
+ "summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
433
+ "hasDynamicHelp": false,
434
+ "multiple": true,
435
+ "type": "option"
363
436
  },
364
437
  "test-level": {
365
- "name": "test-level",
366
- "type": "option",
438
+ "aliases": [
439
+ "testlevel"
440
+ ],
367
441
  "char": "l",
368
- "summary": "Deployment Apex testing level.",
442
+ "deprecateAliases": true,
369
443
  "description": "Valid values are:\n\n- NoTestRun — No tests are run. This test level applies only to deployments to development environments, such as sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.\n\n- RunSpecifiedTests — Runs only the tests that you specify with the --tests flag. Code coverage requirements differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and trigger individually and is different than the overall coverage percentage.\n\n- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default for production deployments that include Apex classes or triggers.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.\n\nIf you don’t specify a test level, the default behavior depends on the contents of your deployment package and target org. For more information, see “Running Tests in a Deployment” in the Metadata API Developer Guide.",
370
444
  "helpGroup": "Test",
445
+ "name": "test-level",
446
+ "summary": "Deployment Apex testing level.",
447
+ "hasDynamicHelp": false,
371
448
  "multiple": false,
372
449
  "options": [
373
450
  "NoTestRun",
@@ -375,239 +452,336 @@
375
452
  "RunLocalTests",
376
453
  "RunAllTestsInOrg"
377
454
  ],
378
- "deprecateAliases": true,
379
- "aliases": [
380
- "testlevel"
381
- ]
455
+ "type": "option"
382
456
  },
383
457
  "no-prompt": {
384
- "name": "no-prompt",
385
- "type": "boolean",
458
+ "aliases": [
459
+ "noprompt"
460
+ ],
386
461
  "char": "r",
462
+ "deprecateAliases": true,
463
+ "name": "no-prompt",
387
464
  "summary": "Don't prompt for delete confirmation.",
388
465
  "allowNo": false,
389
- "deprecateAliases": true,
390
- "aliases": [
391
- "noprompt"
392
- ]
466
+ "type": "boolean"
393
467
  },
394
468
  "metadata": {
395
- "name": "metadata",
396
- "type": "option",
397
469
  "char": "m",
398
- "summary": "Metadata components to delete.",
399
470
  "description": "If you specify this parameter, don’t specify --source-dir.",
471
+ "name": "metadata",
472
+ "summary": "Metadata components to delete.",
473
+ "delimiter": ",",
474
+ "hasDynamicHelp": false,
400
475
  "multiple": true,
401
- "deprecateAliases": true,
402
- "delimiter": ","
476
+ "type": "option"
403
477
  },
404
478
  "source-dir": {
405
- "name": "source-dir",
406
- "type": "option",
407
- "char": "p",
408
- "summary": "Source file paths to delete.",
409
- "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.",
410
- "multiple": true,
411
- "deprecateAliases": true,
412
479
  "aliases": [
413
480
  "sourcepath"
414
481
  ],
415
- "delimiter": ","
482
+ "char": "p",
483
+ "deprecateAliases": true,
484
+ "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.",
485
+ "name": "source-dir",
486
+ "summary": "Source file paths to delete.",
487
+ "delimiter": ",",
488
+ "hasDynamicHelp": false,
489
+ "multiple": true,
490
+ "type": "option"
416
491
  },
417
492
  "track-source": {
418
- "name": "track-source",
419
- "type": "boolean",
493
+ "aliases": [
494
+ "tracksource"
495
+ ],
420
496
  "char": "t",
421
- "summary": "If the delete succeeds, update the source tracking information.",
422
- "allowNo": false,
497
+ "deprecateAliases": true,
423
498
  "exclusive": [
424
499
  "check-only"
425
500
  ],
426
- "deprecateAliases": true,
427
- "aliases": [
428
- "tracksource"
429
- ]
501
+ "name": "track-source",
502
+ "summary": "If the delete succeeds, update the source tracking information.",
503
+ "allowNo": false,
504
+ "type": "boolean"
430
505
  },
431
506
  "force-overwrite": {
432
- "name": "force-overwrite",
433
- "type": "boolean",
507
+ "aliases": [
508
+ "forceoverwrite"
509
+ ],
434
510
  "char": "f",
435
- "summary": "Ignore conflict warnings and overwrite changes to the org.",
436
- "allowNo": false,
437
511
  "dependsOn": [
438
512
  "track-source"
439
513
  ],
440
514
  "deprecateAliases": true,
441
- "aliases": [
442
- "forceoverwrite"
443
- ]
515
+ "name": "force-overwrite",
516
+ "summary": "Ignore conflict warnings and overwrite changes to the org.",
517
+ "allowNo": false,
518
+ "type": "boolean"
444
519
  },
445
520
  "verbose": {
446
521
  "name": "verbose",
447
- "type": "boolean",
448
522
  "summary": "Verbose output of the delete result.",
449
523
  "allowNo": false,
450
- "deprecateAliases": true
524
+ "type": "boolean"
451
525
  }
452
526
  },
453
- "args": {},
527
+ "hasDynamicHelp": true,
528
+ "hiddenAliases": [],
529
+ "id": "project:delete:source",
530
+ "pluginAlias": "@salesforce/plugin-deploy-retrieve",
531
+ "pluginName": "@salesforce/plugin-deploy-retrieve",
532
+ "pluginType": "core",
533
+ "strict": true,
534
+ "summary": "Delete source from your project and from a non-source-tracked org.",
535
+ "enableJsonFlag": true,
536
+ "SF_ENV": "SF_ENV",
454
537
  "requiresProject": true,
455
- "hasDynamicHelp": true
538
+ "isESM": true,
539
+ "relativePath": [
540
+ "lib",
541
+ "commands",
542
+ "project",
543
+ "delete",
544
+ "source.js"
545
+ ],
546
+ "aliasPermutations": [
547
+ "force:source:delete",
548
+ "source:force:delete",
549
+ "source:delete:force",
550
+ "force:delete:source",
551
+ "delete:force:source",
552
+ "delete:source:force"
553
+ ],
554
+ "permutations": [
555
+ "project:delete:source",
556
+ "delete:project:source",
557
+ "delete:source:project",
558
+ "project:source:delete",
559
+ "source:project:delete",
560
+ "source:delete:project"
561
+ ]
456
562
  },
457
563
  "project:delete:tracking": {
458
- "id": "project:delete:tracking",
459
- "summary": "Delete all local source tracking information.",
460
- "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.",
461
- "strict": true,
462
- "pluginName": "@salesforce/plugin-deploy-retrieve",
463
- "pluginAlias": "@salesforce/plugin-deploy-retrieve",
464
- "pluginType": "core",
465
564
  "aliases": [
466
565
  "force:source:tracking:clear"
467
566
  ],
567
+ "args": {},
568
+ "deprecateAliases": true,
569
+ "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.",
468
570
  "examples": [
469
571
  "Delete local source tracking for the org with alias \"my-scratch\":\n$ <%= config.bin %> <%= command.id %> --target-org my-scratch"
470
572
  ],
471
- "deprecateAliases": true,
472
573
  "flags": {
473
574
  "json": {
474
- "name": "json",
475
- "type": "boolean",
476
575
  "description": "Format output as json.",
477
576
  "helpGroup": "GLOBAL",
577
+ "name": "json",
478
578
  "allowNo": false,
479
- "deprecateAliases": true
579
+ "type": "boolean"
480
580
  },
481
581
  "api-version": {
482
- "name": "api-version",
483
- "type": "option",
484
- "description": "Override the api version used for api requests made by this command",
485
- "multiple": false,
486
- "deprecateAliases": true,
487
582
  "aliases": [
488
583
  "apiversion"
489
- ]
584
+ ],
585
+ "deprecateAliases": true,
586
+ "description": "Override the api version used for api requests made by this command",
587
+ "name": "api-version",
588
+ "hasDynamicHelp": false,
589
+ "multiple": false,
590
+ "type": "option"
490
591
  },
491
592
  "loglevel": {
492
- "name": "loglevel",
493
- "type": "option",
494
- "hidden": true,
495
- "multiple": false,
496
593
  "deprecated": {
497
594
  "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
498
595
  },
499
- "deprecateAliases": true
596
+ "hidden": true,
597
+ "name": "loglevel",
598
+ "hasDynamicHelp": false,
599
+ "multiple": false,
600
+ "type": "option"
500
601
  },
501
602
  "target-org": {
502
- "name": "target-org",
503
- "type": "option",
504
- "char": "o",
505
- "summary": "Username or alias of the target org.",
506
- "required": true,
507
- "multiple": false,
508
- "deprecateAliases": true,
509
603
  "aliases": [
510
604
  "targetusername",
511
605
  "u"
512
- ]
606
+ ],
607
+ "char": "o",
608
+ "deprecateAliases": true,
609
+ "name": "target-org",
610
+ "noCacheDefault": true,
611
+ "required": true,
612
+ "summary": "Username or alias of the target org.",
613
+ "hasDynamicHelp": true,
614
+ "multiple": false,
615
+ "type": "option"
513
616
  },
514
617
  "no-prompt": {
515
- "name": "no-prompt",
516
- "type": "boolean",
618
+ "aliases": [
619
+ "noprompt"
620
+ ],
517
621
  "char": "p",
622
+ "deprecateAliases": true,
623
+ "name": "no-prompt",
518
624
  "summary": "Don't prompt for source tracking override confirmation.",
519
625
  "allowNo": false,
520
- "deprecateAliases": true,
521
- "aliases": [
522
- "noprompt"
523
- ]
626
+ "type": "boolean"
524
627
  }
525
628
  },
526
- "args": {},
629
+ "hasDynamicHelp": true,
630
+ "hiddenAliases": [],
631
+ "id": "project:delete:tracking",
632
+ "pluginAlias": "@salesforce/plugin-deploy-retrieve",
633
+ "pluginName": "@salesforce/plugin-deploy-retrieve",
634
+ "pluginType": "core",
635
+ "strict": true,
636
+ "summary": "Delete all local source tracking information.",
637
+ "enableJsonFlag": true,
638
+ "SF_ENV": "SF_ENV",
527
639
  "requiresProject": true,
528
- "hasDynamicHelp": true
640
+ "isESM": true,
641
+ "relativePath": [
642
+ "lib",
643
+ "commands",
644
+ "project",
645
+ "delete",
646
+ "tracking.js"
647
+ ],
648
+ "aliasPermutations": [
649
+ "force:source:tracking:clear",
650
+ "source:force:tracking:clear",
651
+ "source:tracking:force:clear",
652
+ "source:tracking:clear:force",
653
+ "force:tracking:source:clear",
654
+ "tracking:force:source:clear",
655
+ "tracking:source:force:clear",
656
+ "tracking:source:clear:force",
657
+ "force:tracking:clear:source",
658
+ "tracking:force:clear:source",
659
+ "tracking:clear:force:source",
660
+ "tracking:clear:source:force",
661
+ "force:source:clear:tracking",
662
+ "source:force:clear:tracking",
663
+ "source:clear:force:tracking",
664
+ "source:clear:tracking:force",
665
+ "force:clear:source:tracking",
666
+ "clear:force:source:tracking",
667
+ "clear:source:force:tracking",
668
+ "clear:source:tracking:force",
669
+ "force:clear:tracking:source",
670
+ "clear:force:tracking:source",
671
+ "clear:tracking:force:source",
672
+ "clear:tracking:source:force"
673
+ ],
674
+ "permutations": [
675
+ "project:delete:tracking",
676
+ "delete:project:tracking",
677
+ "delete:tracking:project",
678
+ "project:tracking:delete",
679
+ "tracking:project:delete",
680
+ "tracking:delete:project"
681
+ ]
529
682
  },
530
683
  "project:deploy:cancel": {
531
- "id": "project:deploy:cancel",
532
- "summary": "Cancel a deploy operation.",
533
- "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.",
534
- "strict": true,
535
- "pluginName": "@salesforce/plugin-deploy-retrieve",
536
- "pluginAlias": "@salesforce/plugin-deploy-retrieve",
537
- "pluginType": "core",
538
684
  "aliases": [
539
685
  "deploy:metadata:cancel"
540
686
  ],
687
+ "args": {},
688
+ "deprecateAliases": true,
689
+ "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.",
541
690
  "examples": [
542
691
  "Cancel a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
543
692
  "Cancel the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
544
693
  ],
545
- "deprecateAliases": true,
546
694
  "flags": {
547
695
  "json": {
548
- "name": "json",
549
- "type": "boolean",
550
696
  "description": "Format output as json.",
551
697
  "helpGroup": "GLOBAL",
698
+ "name": "json",
552
699
  "allowNo": false,
553
- "deprecateAliases": true
700
+ "type": "boolean"
554
701
  },
555
702
  "async": {
556
- "name": "async",
557
- "type": "boolean",
558
- "summary": "Run the command asynchronously.",
559
703
  "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\".",
560
- "allowNo": false,
561
704
  "exclusive": [
562
705
  "wait"
563
706
  ],
564
- "deprecateAliases": true
707
+ "name": "async",
708
+ "summary": "Run the command asynchronously.",
709
+ "allowNo": false,
710
+ "type": "boolean"
565
711
  },
566
712
  "job-id": {
567
- "name": "job-id",
568
- "type": "option",
569
713
  "char": "i",
570
- "summary": "Job ID of the deploy operation you want to cancel.",
571
714
  "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.",
715
+ "name": "job-id",
716
+ "summary": "Job ID of the deploy operation you want to cancel.",
717
+ "hasDynamicHelp": false,
572
718
  "multiple": false,
573
- "deprecateAliases": true
719
+ "type": "option"
574
720
  },
575
721
  "use-most-recent": {
576
- "name": "use-most-recent",
577
- "type": "boolean",
578
722
  "char": "r",
579
- "summary": "Use the job ID of the most recent deploy operation.",
580
723
  "description": "For performance reasons, this flag uses job IDs for deploy operations that started only in the past 3 days or less. If your most recent deploy operations was more than 3 days ago, this flag won't find a job ID.",
724
+ "name": "use-most-recent",
725
+ "summary": "Use the job ID of the most recent deploy operation.",
581
726
  "allowNo": false,
582
- "deprecateAliases": true
727
+ "type": "boolean"
583
728
  },
584
729
  "wait": {
585
- "name": "wait",
586
- "type": "option",
587
730
  "char": "w",
588
- "summary": "Number of minutes to wait for the command to complete and display results.",
589
731
  "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\".",
590
- "helpValue": "<minutes>",
591
- "multiple": false,
592
732
  "exclusive": [
593
733
  "async"
594
734
  ],
595
- "deprecateAliases": true
735
+ "name": "wait",
736
+ "summary": "Number of minutes to wait for the command to complete and display results.",
737
+ "hasDynamicHelp": false,
738
+ "helpValue": "<minutes>",
739
+ "multiple": false,
740
+ "type": "option"
596
741
  }
597
742
  },
598
- "args": {}
599
- },
600
- "project:deploy:preview": {
601
- "id": "project:deploy:preview",
602
- "summary": "Preview a deployment to see what will deploy to the org, the potential conflicts, and the ignored files.",
603
- "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.",
604
- "strict": true,
605
- "pluginName": "@salesforce/plugin-deploy-retrieve",
743
+ "hasDynamicHelp": false,
744
+ "hiddenAliases": [],
745
+ "id": "project:deploy:cancel",
606
746
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
747
+ "pluginName": "@salesforce/plugin-deploy-retrieve",
607
748
  "pluginType": "core",
749
+ "strict": true,
750
+ "summary": "Cancel a deploy operation.",
751
+ "enableJsonFlag": true,
752
+ "SF_ENV": "SF_ENV",
753
+ "isESM": true,
754
+ "relativePath": [
755
+ "lib",
756
+ "commands",
757
+ "project",
758
+ "deploy",
759
+ "cancel.js"
760
+ ],
761
+ "aliasPermutations": [
762
+ "deploy:metadata:cancel",
763
+ "metadata:deploy:cancel",
764
+ "metadata:cancel:deploy",
765
+ "deploy:cancel:metadata",
766
+ "cancel:deploy:metadata",
767
+ "cancel:metadata:deploy"
768
+ ],
769
+ "permutations": [
770
+ "project:deploy:cancel",
771
+ "deploy:project:cancel",
772
+ "deploy:cancel:project",
773
+ "project:cancel:deploy",
774
+ "cancel:project:deploy",
775
+ "cancel:deploy:project"
776
+ ]
777
+ },
778
+ "project:deploy:preview": {
608
779
  "aliases": [
609
780
  "deploy:metadata:preview"
610
781
  ],
782
+ "args": {},
783
+ "deprecateAliases": true,
784
+ "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.",
611
785
  "examples": [
612
786
  "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.",
613
787
  "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",
@@ -615,189 +789,219 @@
615
789
  "Preview deployment of a specific Apex class:\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass",
616
790
  "Preview deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
617
791
  ],
618
- "deprecateAliases": true,
619
792
  "flags": {
620
793
  "json": {
621
- "name": "json",
622
- "type": "boolean",
623
794
  "description": "Format output as json.",
624
795
  "helpGroup": "GLOBAL",
796
+ "name": "json",
625
797
  "allowNo": false,
626
- "deprecateAliases": true
798
+ "type": "boolean"
627
799
  },
628
800
  "ignore-conflicts": {
629
- "name": "ignore-conflicts",
630
- "type": "boolean",
631
801
  "char": "c",
632
- "summary": "Don't display conflicts in preview of the deployment.",
633
802
  "description": "This flag applies only to orgs that allow source tracking. It has no effect on orgs that don't allow it, such as production orgs.",
803
+ "name": "ignore-conflicts",
804
+ "summary": "Don't display conflicts in preview of the deployment.",
634
805
  "allowNo": false,
635
- "deprecateAliases": true
806
+ "type": "boolean"
636
807
  },
637
808
  "manifest": {
638
- "name": "manifest",
639
- "type": "option",
640
809
  "char": "x",
641
- "summary": "Full file path for manifest (package.xml) of components to preview.",
642
810
  "description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
643
- "multiple": false,
644
811
  "exclusive": [
645
812
  "source-dir",
646
813
  "metadata"
647
814
  ],
648
- "deprecateAliases": true
815
+ "name": "manifest",
816
+ "summary": "Full file path for manifest (package.xml) of components to preview.",
817
+ "hasDynamicHelp": false,
818
+ "multiple": false,
819
+ "type": "option"
649
820
  },
650
821
  "metadata": {
651
- "name": "metadata",
652
- "type": "option",
653
822
  "char": "m",
654
- "summary": "Metadata component names to preview.",
655
- "multiple": true,
656
823
  "exclusive": [
657
824
  "manifest",
658
825
  "source-dir"
659
826
  ],
660
- "deprecateAliases": true
827
+ "name": "metadata",
828
+ "summary": "Metadata component names to preview.",
829
+ "hasDynamicHelp": false,
830
+ "multiple": true,
831
+ "type": "option"
661
832
  },
662
833
  "source-dir": {
663
- "name": "source-dir",
664
- "type": "option",
665
834
  "char": "d",
666
- "summary": "Path to the local source files to preview.",
667
835
  "description": "The supplied path 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 subdirectories).\n\nIf you specify this flag, don’t specify --metadata or --manifest.",
668
- "multiple": true,
669
836
  "exclusive": [
670
837
  "manifest",
671
838
  "metadata"
672
839
  ],
673
- "deprecateAliases": true
840
+ "name": "source-dir",
841
+ "summary": "Path to the local source files to preview.",
842
+ "hasDynamicHelp": false,
843
+ "multiple": true,
844
+ "type": "option"
674
845
  },
675
846
  "target-org": {
676
- "name": "target-org",
677
- "type": "option",
678
847
  "char": "o",
679
- "summary": "Login username or alias for the target org.",
680
848
  "description": "Overrides your default org.",
849
+ "name": "target-org",
850
+ "noCacheDefault": true,
681
851
  "required": true,
852
+ "summary": "Login username or alias for the target org.",
853
+ "hasDynamicHelp": true,
682
854
  "multiple": false,
683
- "deprecateAliases": true
855
+ "type": "option"
684
856
  }
685
857
  },
686
- "args": {},
858
+ "hasDynamicHelp": true,
859
+ "hiddenAliases": [],
860
+ "id": "project:deploy:preview",
861
+ "pluginAlias": "@salesforce/plugin-deploy-retrieve",
862
+ "pluginName": "@salesforce/plugin-deploy-retrieve",
863
+ "pluginType": "core",
864
+ "strict": true,
865
+ "summary": "Preview a deployment to see what will deploy to the org, the potential conflicts, and the ignored files.",
866
+ "enableJsonFlag": true,
867
+ "SF_ENV": "SF_ENV",
687
868
  "requiresProject": true,
688
- "hasDynamicHelp": true
869
+ "isESM": true,
870
+ "relativePath": [
871
+ "lib",
872
+ "commands",
873
+ "project",
874
+ "deploy",
875
+ "preview.js"
876
+ ],
877
+ "aliasPermutations": [
878
+ "deploy:metadata:preview",
879
+ "metadata:deploy:preview",
880
+ "metadata:preview:deploy",
881
+ "deploy:preview:metadata",
882
+ "preview:deploy:metadata",
883
+ "preview:metadata:deploy"
884
+ ],
885
+ "permutations": [
886
+ "project:deploy:preview",
887
+ "deploy:project:preview",
888
+ "deploy:preview:project",
889
+ "project:preview:deploy",
890
+ "preview:project:deploy",
891
+ "preview:deploy:project"
892
+ ]
689
893
  },
690
894
  "project:deploy:quick": {
691
- "id": "project:deploy:quick",
692
- "summary": "Quickly deploy a validated deployment to an org.",
693
- "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.",
694
- "strict": true,
695
- "pluginName": "@salesforce/plugin-deploy-retrieve",
696
- "pluginAlias": "@salesforce/plugin-deploy-retrieve",
697
- "pluginType": "core",
698
895
  "aliases": [
699
896
  "deploy:metadata:quick"
700
897
  ],
898
+ "args": {},
899
+ "deprecateAliases": true,
900
+ "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.",
701
901
  "examples": [
702
902
  "Run a quick deploy to your default org using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
703
903
  "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"
704
904
  ],
705
- "deprecateAliases": true,
706
905
  "flags": {
707
906
  "json": {
708
- "name": "json",
709
- "type": "boolean",
710
907
  "description": "Format output as json.",
711
908
  "helpGroup": "GLOBAL",
909
+ "name": "json",
712
910
  "allowNo": false,
713
- "deprecateAliases": true
911
+ "type": "boolean"
714
912
  },
715
913
  "async": {
716
- "name": "async",
717
- "type": "boolean",
718
- "summary": "Run the command asynchronously.",
719
914
  "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\".",
720
- "allowNo": false,
721
915
  "exclusive": [
722
916
  "wait"
723
917
  ],
724
- "deprecateAliases": true
918
+ "name": "async",
919
+ "summary": "Run the command asynchronously.",
920
+ "allowNo": false,
921
+ "type": "boolean"
725
922
  },
726
923
  "concise": {
727
- "name": "concise",
728
- "type": "boolean",
729
- "summary": "Show concise output of the deploy result.",
730
- "allowNo": false,
731
924
  "exclusive": [
732
925
  "verbose"
733
926
  ],
734
- "deprecateAliases": true
927
+ "name": "concise",
928
+ "summary": "Show concise output of the deploy result.",
929
+ "allowNo": false,
930
+ "type": "boolean"
735
931
  },
736
932
  "job-id": {
737
- "name": "job-id",
738
- "type": "option",
739
933
  "char": "i",
740
- "summary": "Job ID of the deployment you want to quick deploy.",
741
934
  "description": "The job ID is valid for 10 days from when you started the validation.",
935
+ "name": "job-id",
936
+ "summary": "Job ID of the deployment you want to quick deploy.",
937
+ "hasDynamicHelp": false,
742
938
  "multiple": false,
743
- "deprecateAliases": true
939
+ "type": "option"
744
940
  },
745
941
  "target-org": {
746
- "name": "target-org",
747
- "type": "option",
748
942
  "char": "o",
749
- "summary": "Login username or alias for the target org.",
750
943
  "description": "Overrides your default org.",
944
+ "name": "target-org",
945
+ "noCacheDefault": true,
946
+ "summary": "Login username or alias for the target org.",
947
+ "hasDynamicHelp": true,
751
948
  "multiple": false,
752
- "deprecateAliases": true
949
+ "type": "option"
753
950
  },
754
951
  "use-most-recent": {
755
- "name": "use-most-recent",
756
- "type": "boolean",
757
952
  "char": "r",
758
- "summary": "Use the job ID of the most recently validated deployment.",
759
953
  "description": "For performance reasons, this flag uses only job IDs that were validated in the past 3 days or less. If your most recent deployment validation was more than 3 days ago, this flag won't find a job ID.",
954
+ "name": "use-most-recent",
955
+ "summary": "Use the job ID of the most recently validated deployment.",
760
956
  "allowNo": false,
761
- "deprecateAliases": true
957
+ "type": "boolean"
762
958
  },
763
959
  "verbose": {
764
- "name": "verbose",
765
- "type": "boolean",
766
- "summary": "Show verbose output of the deploy result.",
767
- "allowNo": false,
768
960
  "exclusive": [
769
961
  "concise"
770
962
  ],
771
- "deprecateAliases": true
963
+ "name": "verbose",
964
+ "summary": "Show verbose output of the deploy result.",
965
+ "allowNo": false,
966
+ "type": "boolean"
772
967
  },
773
968
  "wait": {
774
- "name": "wait",
775
- "type": "option",
776
969
  "char": "w",
777
- "summary": "Number of minutes to wait for the command to complete and display results.",
778
970
  "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\".",
779
- "helpValue": "<minutes>",
780
- "multiple": false,
781
971
  "exclusive": [
782
972
  "async"
783
973
  ],
974
+ "name": "wait",
975
+ "summary": "Number of minutes to wait for the command to complete and display results.",
784
976
  "default": {
785
977
  "quantity": 33,
786
978
  "unit": 0
787
979
  },
788
- "deprecateAliases": true
980
+ "hasDynamicHelp": false,
981
+ "helpValue": "<minutes>",
982
+ "multiple": false,
983
+ "type": "option"
789
984
  },
790
985
  "api-version": {
791
- "name": "api-version",
792
- "type": "option",
793
986
  "char": "a",
794
- "summary": "Target API version for the deploy.",
795
987
  "description": "Use this flag to override the default API version with the API version of your package.xml file. The default API version is the latest version supported by the CLI.",
988
+ "name": "api-version",
989
+ "summary": "Target API version for the deploy.",
990
+ "hasDynamicHelp": false,
796
991
  "multiple": false,
797
- "deprecateAliases": true
992
+ "type": "option"
798
993
  }
799
994
  },
800
- "args": {},
995
+ "hasDynamicHelp": true,
996
+ "hiddenAliases": [],
997
+ "id": "project:deploy:quick",
998
+ "pluginAlias": "@salesforce/plugin-deploy-retrieve",
999
+ "pluginName": "@salesforce/plugin-deploy-retrieve",
1000
+ "pluginType": "core",
1001
+ "strict": true,
1002
+ "summary": "Quickly deploy a validated deployment to an org.",
1003
+ "enableJsonFlag": true,
1004
+ "SF_ENV": "SF_ENV",
801
1005
  "errorCodes": {
802
1006
  "header": "ERROR CODES",
803
1007
  "body": [
@@ -831,67 +1035,84 @@
831
1035
  }
832
1036
  ]
833
1037
  },
834
- "hasDynamicHelp": true
1038
+ "isESM": true,
1039
+ "relativePath": [
1040
+ "lib",
1041
+ "commands",
1042
+ "project",
1043
+ "deploy",
1044
+ "quick.js"
1045
+ ],
1046
+ "aliasPermutations": [
1047
+ "deploy:metadata:quick",
1048
+ "metadata:deploy:quick",
1049
+ "metadata:quick:deploy",
1050
+ "deploy:quick:metadata",
1051
+ "quick:deploy:metadata",
1052
+ "quick:metadata:deploy"
1053
+ ],
1054
+ "permutations": [
1055
+ "project:deploy:quick",
1056
+ "deploy:project:quick",
1057
+ "deploy:quick:project",
1058
+ "project:quick:deploy",
1059
+ "quick:project:deploy",
1060
+ "quick:deploy:project"
1061
+ ]
835
1062
  },
836
1063
  "project:deploy:report": {
837
- "id": "project:deploy:report",
838
- "summary": "Check or poll for the status of a deploy operation.",
839
- "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.",
840
- "strict": true,
841
- "pluginName": "@salesforce/plugin-deploy-retrieve",
842
- "pluginAlias": "@salesforce/plugin-deploy-retrieve",
843
- "pluginType": "core",
844
1064
  "aliases": [
845
1065
  "deploy:metadata:report"
846
1066
  ],
1067
+ "args": {},
1068
+ "deprecateAliases": true,
1069
+ "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.",
847
1070
  "examples": [
848
1071
  "Check the status using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
849
1072
  "Check the status of the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent",
850
1073
  "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"
851
1074
  ],
852
- "deprecateAliases": true,
853
1075
  "flags": {
854
1076
  "json": {
855
- "name": "json",
856
- "type": "boolean",
857
1077
  "description": "Format output as json.",
858
1078
  "helpGroup": "GLOBAL",
1079
+ "name": "json",
859
1080
  "allowNo": false,
860
- "deprecateAliases": true
1081
+ "type": "boolean"
861
1082
  },
862
1083
  "target-org": {
863
- "name": "target-org",
864
- "type": "option",
865
1084
  "char": "o",
866
- "summary": "Login username or alias for the target org.",
867
1085
  "description": "Overrides your default org.",
1086
+ "name": "target-org",
1087
+ "noCacheDefault": true,
1088
+ "summary": "Login username or alias for the target org.",
1089
+ "hasDynamicHelp": true,
868
1090
  "multiple": false,
869
- "deprecateAliases": true
1091
+ "type": "option"
870
1092
  },
871
1093
  "job-id": {
872
- "name": "job-id",
873
- "type": "option",
874
1094
  "char": "i",
875
- "summary": "Job ID of the deploy operation you want to check the status of.",
876
1095
  "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.",
1096
+ "name": "job-id",
1097
+ "summary": "Job ID of the deploy operation you want to check the status of.",
1098
+ "hasDynamicHelp": false,
877
1099
  "multiple": false,
878
- "deprecateAliases": true
1100
+ "type": "option"
879
1101
  },
880
1102
  "use-most-recent": {
881
- "name": "use-most-recent",
882
- "type": "boolean",
883
1103
  "char": "r",
884
- "summary": "Use the job ID of the most recent deploy operation.",
885
1104
  "description": "For performance reasons, this flag uses job IDs for deploy operations that started only in the past 3 days or less. If your most recent operation was more than 3 days ago, this flag won't find a job ID.",
1105
+ "name": "use-most-recent",
1106
+ "summary": "Use the job ID of the most recent deploy operation.",
886
1107
  "allowNo": false,
887
- "deprecateAliases": true
1108
+ "type": "boolean"
888
1109
  },
889
1110
  "coverage-formatters": {
890
- "name": "coverage-formatters",
891
- "type": "option",
892
- "summary": "Format of the code coverage results.",
893
1111
  "description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
894
1112
  "helpGroup": "Test",
1113
+ "name": "coverage-formatters",
1114
+ "summary": "Format of the code coverage results.",
1115
+ "hasDynamicHelp": false,
895
1116
  "multiple": true,
896
1117
  "options": [
897
1118
  "clover",
@@ -906,22 +1127,18 @@
906
1127
  "text",
907
1128
  "text-summary"
908
1129
  ],
909
- "deprecateAliases": true
1130
+ "type": "option"
910
1131
  },
911
1132
  "junit": {
1133
+ "helpGroup": "Test",
912
1134
  "name": "junit",
913
- "type": "boolean",
914
1135
  "summary": "Output JUnit test results.",
915
- "helpGroup": "Test",
916
1136
  "allowNo": false,
917
- "deprecateAliases": true
1137
+ "type": "boolean"
918
1138
  },
919
1139
  "results-dir": {
920
- "name": "results-dir",
921
- "type": "option",
922
- "summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
923
1140
  "helpGroup": "Test",
924
- "multiple": false,
1141
+ "name": "results-dir",
925
1142
  "relationships": [
926
1143
  {
927
1144
  "type": "some",
@@ -931,101 +1148,127 @@
931
1148
  ]
932
1149
  }
933
1150
  ],
934
- "deprecateAliases": true
1151
+ "summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
1152
+ "hasDynamicHelp": false,
1153
+ "multiple": false,
1154
+ "type": "option"
935
1155
  },
936
1156
  "wait": {
937
- "name": "wait",
938
- "type": "option",
939
1157
  "char": "w",
940
- "summary": "Number of minutes to wait for command to complete and display results.",
941
1158
  "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\".",
1159
+ "name": "wait",
1160
+ "summary": "Number of minutes to wait for command to complete and display results.",
1161
+ "hasDynamicHelp": false,
942
1162
  "helpValue": "<minutes>",
943
1163
  "multiple": false,
944
- "deprecateAliases": true
1164
+ "type": "option"
945
1165
  }
946
1166
  },
947
- "args": {},
948
- "hasDynamicHelp": true
949
- },
950
- "project:deploy:resume": {
951
- "id": "project:deploy:resume",
952
- "summary": "Resume watching a deploy operation and update source tracking when the deploy completes.",
953
- "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.",
954
- "strict": true,
955
- "pluginName": "@salesforce/plugin-deploy-retrieve",
1167
+ "hasDynamicHelp": true,
1168
+ "hiddenAliases": [],
1169
+ "id": "project:deploy:report",
956
1170
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
1171
+ "pluginName": "@salesforce/plugin-deploy-retrieve",
957
1172
  "pluginType": "core",
1173
+ "strict": true,
1174
+ "summary": "Check or poll for the status of a deploy operation.",
1175
+ "enableJsonFlag": true,
1176
+ "SF_ENV": "SF_ENV",
1177
+ "isESM": true,
1178
+ "relativePath": [
1179
+ "lib",
1180
+ "commands",
1181
+ "project",
1182
+ "deploy",
1183
+ "report.js"
1184
+ ],
1185
+ "aliasPermutations": [
1186
+ "deploy:metadata:report",
1187
+ "metadata:deploy:report",
1188
+ "metadata:report:deploy",
1189
+ "deploy:report:metadata",
1190
+ "report:deploy:metadata",
1191
+ "report:metadata:deploy"
1192
+ ],
1193
+ "permutations": [
1194
+ "project:deploy:report",
1195
+ "deploy:project:report",
1196
+ "deploy:report:project",
1197
+ "project:report:deploy",
1198
+ "report:project:deploy",
1199
+ "report:deploy:project"
1200
+ ]
1201
+ },
1202
+ "project:deploy:resume": {
958
1203
  "aliases": [
959
1204
  "deploy:metadata:resume"
960
1205
  ],
1206
+ "args": {},
1207
+ "deprecateAliases": true,
1208
+ "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.",
961
1209
  "examples": [
962
1210
  "Resume watching a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
963
1211
  "Resume watching the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
964
1212
  ],
965
- "deprecateAliases": true,
966
1213
  "flags": {
967
1214
  "json": {
968
- "name": "json",
969
- "type": "boolean",
970
1215
  "description": "Format output as json.",
971
1216
  "helpGroup": "GLOBAL",
1217
+ "name": "json",
972
1218
  "allowNo": false,
973
- "deprecateAliases": true
1219
+ "type": "boolean"
974
1220
  },
975
1221
  "concise": {
976
- "name": "concise",
977
- "type": "boolean",
978
- "summary": "Show concise output of the deploy operation result.",
979
- "allowNo": false,
980
1222
  "exclusive": [
981
1223
  "verbose"
982
1224
  ],
983
- "deprecateAliases": true
1225
+ "name": "concise",
1226
+ "summary": "Show concise output of the deploy operation result.",
1227
+ "allowNo": false,
1228
+ "type": "boolean"
984
1229
  },
985
1230
  "job-id": {
986
- "name": "job-id",
987
- "type": "option",
988
1231
  "char": "i",
989
- "summary": "Job ID of the deploy operation you want to resume.",
990
1232
  "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.",
1233
+ "name": "job-id",
1234
+ "summary": "Job ID of the deploy operation you want to resume.",
1235
+ "hasDynamicHelp": false,
991
1236
  "multiple": false,
992
- "deprecateAliases": true
1237
+ "type": "option"
993
1238
  },
994
1239
  "use-most-recent": {
995
- "name": "use-most-recent",
996
- "type": "boolean",
997
1240
  "char": "r",
998
- "summary": "Use the job ID of the most recent deploy operation.",
999
1241
  "description": "For performance reasons, this flag uses job IDs for deploy operations that started only in the past 3 days or less. If your most recent operation was more than 3 days ago, this flag won't find a job ID.",
1242
+ "name": "use-most-recent",
1243
+ "summary": "Use the job ID of the most recent deploy operation.",
1000
1244
  "allowNo": false,
1001
- "deprecateAliases": true
1245
+ "type": "boolean"
1002
1246
  },
1003
1247
  "verbose": {
1004
- "name": "verbose",
1005
- "type": "boolean",
1006
- "summary": "Show verbose output of the deploy operation result.",
1007
- "allowNo": false,
1008
1248
  "exclusive": [
1009
1249
  "concise"
1010
1250
  ],
1011
- "deprecateAliases": true
1251
+ "name": "verbose",
1252
+ "summary": "Show verbose output of the deploy operation result.",
1253
+ "allowNo": false,
1254
+ "type": "boolean"
1012
1255
  },
1013
1256
  "wait": {
1014
- "name": "wait",
1015
- "type": "option",
1016
1257
  "char": "w",
1017
- "summary": "Number of minutes to wait for the command to complete and display results.",
1018
1258
  "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\".",
1259
+ "name": "wait",
1260
+ "summary": "Number of minutes to wait for the command to complete and display results.",
1261
+ "hasDynamicHelp": false,
1019
1262
  "helpValue": "<minutes>",
1020
1263
  "multiple": false,
1021
- "deprecateAliases": true
1264
+ "type": "option"
1022
1265
  },
1023
1266
  "coverage-formatters": {
1024
- "name": "coverage-formatters",
1025
- "type": "option",
1026
- "summary": "Format of the code coverage results.",
1027
1267
  "description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
1028
1268
  "helpGroup": "Test",
1269
+ "name": "coverage-formatters",
1270
+ "summary": "Format of the code coverage results.",
1271
+ "hasDynamicHelp": false,
1029
1272
  "multiple": true,
1030
1273
  "options": [
1031
1274
  "clover",
@@ -1040,22 +1283,18 @@
1040
1283
  "text",
1041
1284
  "text-summary"
1042
1285
  ],
1043
- "deprecateAliases": true
1286
+ "type": "option"
1044
1287
  },
1045
1288
  "junit": {
1289
+ "helpGroup": "Test",
1046
1290
  "name": "junit",
1047
- "type": "boolean",
1048
1291
  "summary": "Output JUnit test results.",
1049
- "helpGroup": "Test",
1050
1292
  "allowNo": false,
1051
- "deprecateAliases": true
1293
+ "type": "boolean"
1052
1294
  },
1053
1295
  "results-dir": {
1054
- "name": "results-dir",
1055
- "type": "option",
1056
- "summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
1057
1296
  "helpGroup": "Test",
1058
- "multiple": false,
1297
+ "name": "results-dir",
1059
1298
  "relationships": [
1060
1299
  {
1061
1300
  "type": "some",
@@ -1065,10 +1304,22 @@
1065
1304
  ]
1066
1305
  }
1067
1306
  ],
1068
- "deprecateAliases": true
1307
+ "summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
1308
+ "hasDynamicHelp": false,
1309
+ "multiple": false,
1310
+ "type": "option"
1069
1311
  }
1070
1312
  },
1071
- "args": {},
1313
+ "hasDynamicHelp": false,
1314
+ "hiddenAliases": [],
1315
+ "id": "project:deploy:resume",
1316
+ "pluginAlias": "@salesforce/plugin-deploy-retrieve",
1317
+ "pluginName": "@salesforce/plugin-deploy-retrieve",
1318
+ "pluginType": "core",
1319
+ "strict": true,
1320
+ "summary": "Resume watching a deploy operation and update source tracking when the deploy completes.",
1321
+ "enableJsonFlag": true,
1322
+ "SF_ENV": "SF_ENV",
1072
1323
  "envVariablesSection": {
1073
1324
  "header": "ENVIRONMENT VARIABLES",
1074
1325
  "body": [
@@ -1110,19 +1361,39 @@
1110
1361
  "description": "The deploy is being canceled."
1111
1362
  }
1112
1363
  ]
1113
- }
1364
+ },
1365
+ "isESM": true,
1366
+ "relativePath": [
1367
+ "lib",
1368
+ "commands",
1369
+ "project",
1370
+ "deploy",
1371
+ "resume.js"
1372
+ ],
1373
+ "aliasPermutations": [
1374
+ "deploy:metadata:resume",
1375
+ "metadata:deploy:resume",
1376
+ "metadata:resume:deploy",
1377
+ "deploy:resume:metadata",
1378
+ "resume:deploy:metadata",
1379
+ "resume:metadata:deploy"
1380
+ ],
1381
+ "permutations": [
1382
+ "project:deploy:resume",
1383
+ "deploy:project:resume",
1384
+ "deploy:resume:project",
1385
+ "project:resume:deploy",
1386
+ "resume:project:deploy",
1387
+ "resume:deploy:project"
1388
+ ]
1114
1389
  },
1115
1390
  "project:deploy:start": {
1116
- "id": "project:deploy:start",
1117
- "summary": "Deploy metadata to an org from your local project.",
1118
- "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 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 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.",
1119
- "strict": true,
1120
- "pluginName": "@salesforce/plugin-deploy-retrieve",
1121
- "pluginAlias": "@salesforce/plugin-deploy-retrieve",
1122
- "pluginType": "core",
1123
1391
  "aliases": [
1124
1392
  "deploy:metadata"
1125
1393
  ],
1394
+ "args": {},
1395
+ "deprecateAliases": true,
1396
+ "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 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 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.",
1126
1397
  "examples": [
1127
1398
  "Deploy local changes not in the org; uses your default org:\n<%= config.bin %> <%= command.id %>",
1128
1399
  "Deploy the source files in a directory to an org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --source-dir path/to/source --target-org my-scratch",
@@ -1135,178 +1406,170 @@
1135
1406
  "Deploy all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml",
1136
1407
  "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"
1137
1408
  ],
1138
- "deprecateAliases": true,
1139
1409
  "flags": {
1140
1410
  "json": {
1141
- "name": "json",
1142
- "type": "boolean",
1143
1411
  "description": "Format output as json.",
1144
1412
  "helpGroup": "GLOBAL",
1413
+ "name": "json",
1145
1414
  "allowNo": false,
1146
- "deprecateAliases": true
1415
+ "type": "boolean"
1147
1416
  },
1148
1417
  "api-version": {
1149
- "name": "api-version",
1150
- "type": "option",
1151
1418
  "char": "a",
1152
- "summary": "Target API version for the deploy.",
1153
1419
  "description": "Use this flag to override the default API version with the API version of your package.xml file. The default API version is the latest version supported by the CLI.",
1420
+ "name": "api-version",
1421
+ "summary": "Target API version for the deploy.",
1422
+ "hasDynamicHelp": false,
1154
1423
  "multiple": false,
1155
- "deprecateAliases": true
1424
+ "type": "option"
1156
1425
  },
1157
1426
  "async": {
1158
- "name": "async",
1159
- "type": "boolean",
1160
- "summary": "Run the command asynchronously.",
1161
1427
  "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\".",
1162
- "allowNo": false,
1163
1428
  "exclusive": [
1164
1429
  "wait"
1165
1430
  ],
1166
- "deprecateAliases": true
1431
+ "name": "async",
1432
+ "summary": "Run the command asynchronously.",
1433
+ "allowNo": false,
1434
+ "type": "boolean"
1167
1435
  },
1168
1436
  "concise": {
1169
- "name": "concise",
1170
- "type": "boolean",
1171
- "summary": "Show concise output of the deploy result.",
1172
- "allowNo": false,
1173
1437
  "exclusive": [
1174
1438
  "verbose"
1175
1439
  ],
1176
- "deprecateAliases": true
1440
+ "name": "concise",
1441
+ "summary": "Show concise output of the deploy result.",
1442
+ "allowNo": false,
1443
+ "type": "boolean"
1177
1444
  },
1178
1445
  "dry-run": {
1179
1446
  "name": "dry-run",
1180
- "type": "boolean",
1181
1447
  "summary": "Validate deploy and run Apex tests but don’t save to the org.",
1182
1448
  "allowNo": false,
1183
- "deprecateAliases": true
1449
+ "type": "boolean"
1184
1450
  },
1185
1451
  "ignore-conflicts": {
1186
- "name": "ignore-conflicts",
1187
- "type": "boolean",
1188
1452
  "char": "c",
1189
- "summary": "Ignore conflicts and deploy local files, even if they overwrite changes in the org.",
1190
1453
  "description": "This flag applies only to orgs that allow source tracking. It has no effect on orgs that don't allow it, such as production orgs.",
1454
+ "name": "ignore-conflicts",
1455
+ "summary": "Ignore conflicts and deploy local files, even if they overwrite changes in the org.",
1191
1456
  "allowNo": false,
1192
- "deprecateAliases": true
1457
+ "type": "boolean"
1193
1458
  },
1194
1459
  "ignore-errors": {
1195
- "name": "ignore-errors",
1196
- "type": "boolean",
1197
1460
  "char": "r",
1198
- "summary": "Ignore any errors and don’t roll back deployment.",
1199
1461
  "description": "When deploying to a production org, keep this flag set to false (default value). When set to true, components without errors are deployed and components with errors are skipped, and could result in an inconsistent production org.",
1462
+ "name": "ignore-errors",
1463
+ "summary": "Ignore any errors and don’t roll back deployment.",
1200
1464
  "allowNo": false,
1201
- "deprecateAliases": true
1465
+ "type": "boolean"
1202
1466
  },
1203
1467
  "ignore-warnings": {
1204
- "name": "ignore-warnings",
1205
- "type": "boolean",
1206
1468
  "char": "g",
1207
- "summary": "Ignore warnings and allow a deployment to complete successfully.",
1208
1469
  "description": "If a warning occurs and this flag is set to true, the success status of the deployment is set to true. When this flag is set to false, success is set to false, and the warning is treated like an error.",
1470
+ "name": "ignore-warnings",
1471
+ "summary": "Ignore warnings and allow a deployment to complete successfully.",
1209
1472
  "allowNo": false,
1210
- "deprecateAliases": true
1473
+ "type": "boolean"
1211
1474
  },
1212
1475
  "manifest": {
1213
- "name": "manifest",
1214
- "type": "option",
1215
1476
  "char": "x",
1216
- "summary": "Full file path for manifest (package.xml) of components to deploy.",
1217
1477
  "description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
1218
- "helpGroup": "Source Format",
1219
- "multiple": false,
1220
1478
  "exclusive": [
1221
1479
  "source-dir",
1222
1480
  "metadata",
1223
1481
  "metadata-dir"
1224
1482
  ],
1225
- "deprecateAliases": true
1483
+ "helpGroup": "Source Format",
1484
+ "name": "manifest",
1485
+ "summary": "Full file path for manifest (package.xml) of components to deploy.",
1486
+ "hasDynamicHelp": false,
1487
+ "multiple": false,
1488
+ "type": "option"
1226
1489
  },
1227
1490
  "metadata": {
1228
- "name": "metadata",
1229
- "type": "option",
1230
1491
  "char": "m",
1231
- "summary": "Metadata component names to deploy. Wildcards ( `*` ) supported as long as you use quotes, such as `ApexClass:MyClass*`",
1232
- "helpGroup": "Source Format",
1233
- "multiple": true,
1234
1492
  "exclusive": [
1235
1493
  "manifest",
1236
1494
  "source-dir",
1237
1495
  "metadata-dir"
1238
1496
  ],
1239
- "deprecateAliases": true
1497
+ "helpGroup": "Source Format",
1498
+ "name": "metadata",
1499
+ "summary": "Metadata component names to deploy. Wildcards ( `*` ) supported as long as you use quotes, such as `ApexClass:MyClass*`",
1500
+ "hasDynamicHelp": false,
1501
+ "multiple": true,
1502
+ "type": "option"
1240
1503
  },
1241
1504
  "metadata-dir": {
1242
- "name": "metadata-dir",
1243
- "type": "option",
1244
- "summary": "Root of directory or zip file of metadata formatted files to deploy.",
1245
- "helpGroup": "Metadata API Format",
1246
- "multiple": false,
1247
1505
  "exclusive": [
1248
1506
  "manifest",
1249
1507
  "source-dir",
1250
1508
  "metadata"
1251
1509
  ],
1252
- "deprecateAliases": true
1510
+ "helpGroup": "Metadata API Format",
1511
+ "name": "metadata-dir",
1512
+ "summary": "Root of directory or zip file of metadata formatted files to deploy.",
1513
+ "hasDynamicHelp": false,
1514
+ "multiple": false,
1515
+ "type": "option"
1253
1516
  },
1254
1517
  "single-package": {
1255
- "name": "single-package",
1256
- "type": "boolean",
1257
- "summary": "Indicates that the metadata zip file points to a directory structure for a single package.",
1258
- "helpGroup": "Metadata API Format",
1259
- "allowNo": false,
1260
1518
  "dependsOn": [
1261
1519
  "metadata-dir"
1262
1520
  ],
1263
- "deprecateAliases": true
1521
+ "helpGroup": "Metadata API Format",
1522
+ "name": "single-package",
1523
+ "summary": "Indicates that the metadata zip file points to a directory structure for a single package.",
1524
+ "allowNo": false,
1525
+ "type": "boolean"
1264
1526
  },
1265
1527
  "source-dir": {
1266
- "name": "source-dir",
1267
- "type": "option",
1268
1528
  "char": "d",
1269
- "summary": "Path to the local source files to deploy.",
1270
1529
  "description": "The supplied path 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 subdirectories).\n\nIf you specify this flag, don’t specify --metadata or --manifest.",
1271
- "helpGroup": "Source Format",
1272
- "multiple": true,
1273
1530
  "exclusive": [
1274
1531
  "manifest",
1275
1532
  "metadata",
1276
1533
  "metadata-dir"
1277
1534
  ],
1278
- "deprecateAliases": true
1535
+ "helpGroup": "Source Format",
1536
+ "name": "source-dir",
1537
+ "summary": "Path to the local source files to deploy.",
1538
+ "hasDynamicHelp": false,
1539
+ "multiple": true,
1540
+ "type": "option"
1279
1541
  },
1280
1542
  "target-org": {
1281
- "name": "target-org",
1282
- "type": "option",
1283
1543
  "char": "o",
1284
- "summary": "Login username or alias for the target org.",
1285
1544
  "description": "Overrides your default org.",
1545
+ "name": "target-org",
1546
+ "noCacheDefault": true,
1286
1547
  "required": true,
1548
+ "summary": "Login username or alias for the target org.",
1549
+ "hasDynamicHelp": true,
1287
1550
  "multiple": false,
1288
- "deprecateAliases": true
1551
+ "type": "option"
1289
1552
  },
1290
1553
  "tests": {
1291
- "name": "tests",
1292
- "type": "option",
1293
1554
  "char": "t",
1294
- "summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
1295
- "description": "If a test name contains a space, enclose it in double quotes.\nFor multiple test names, use one of the following formats:\n\n- Repeat the flag for multiple test names: --tests Test1 --tests Test2 --tests \"Test With Space\"\n- Separate the test names with spaces: --tests Test1 Test2 \"Test With Space\"",
1296
- "helpGroup": "Test",
1297
- "multiple": true,
1298
1555
  "dependsOn": [
1299
1556
  "test-level"
1300
1557
  ],
1301
- "deprecateAliases": true
1558
+ "description": "If a test name contains a space, enclose it in double quotes.\nFor multiple test names, use one of the following formats:\n\n- Repeat the flag for multiple test names: --tests Test1 --tests Test2 --tests \"Test With Space\"\n- Separate the test names with spaces: --tests Test1 Test2 \"Test With Space\"",
1559
+ "helpGroup": "Test",
1560
+ "name": "tests",
1561
+ "summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
1562
+ "hasDynamicHelp": false,
1563
+ "multiple": true,
1564
+ "type": "option"
1302
1565
  },
1303
1566
  "test-level": {
1304
- "name": "test-level",
1305
- "type": "option",
1306
1567
  "char": "l",
1307
- "summary": "Deployment Apex testing level.",
1308
1568
  "description": "Valid values are:\n\n- NoTestRun — No tests are run. This test level applies only to deployments to development environments, such as sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.\n\n- RunSpecifiedTests — Runs only the tests that you specify with the --tests flag. Code coverage requirements differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and trigger individually and is different than the overall coverage percentage.\n\n- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default for production deployments that include Apex classes or triggers.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.\n\n If you don’t specify a test level, the default behavior depends on the contents of your deployment package and target org. For more information, see [Running Tests in a Deployment](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm) in the \"Metadata API Developer Guide\".",
1309
1569
  "helpGroup": "Test",
1570
+ "name": "test-level",
1571
+ "summary": "Deployment Apex testing level.",
1572
+ "hasDynamicHelp": false,
1310
1573
  "multiple": false,
1311
1574
  "options": [
1312
1575
  "NoTestRun",
@@ -1314,44 +1577,40 @@
1314
1577
  "RunLocalTests",
1315
1578
  "RunAllTestsInOrg"
1316
1579
  ],
1317
- "deprecateAliases": true
1580
+ "type": "option"
1318
1581
  },
1319
1582
  "verbose": {
1320
- "name": "verbose",
1321
- "type": "boolean",
1322
- "summary": "Show verbose output of the deploy result.",
1323
- "allowNo": false,
1324
1583
  "exclusive": [
1325
1584
  "concise"
1326
1585
  ],
1327
- "deprecateAliases": true
1586
+ "name": "verbose",
1587
+ "summary": "Show verbose output of the deploy result.",
1588
+ "allowNo": false,
1589
+ "type": "boolean"
1328
1590
  },
1329
1591
  "wait": {
1330
- "name": "wait",
1331
- "type": "option",
1332
1592
  "char": "w",
1333
- "summary": "Number of minutes to wait for command to complete and display results.",
1334
1593
  "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\".",
1335
- "helpValue": "<minutes>",
1336
- "multiple": false,
1337
1594
  "exclusive": [
1338
1595
  "async"
1339
1596
  ],
1597
+ "name": "wait",
1598
+ "summary": "Number of minutes to wait for command to complete and display results.",
1340
1599
  "default": {
1341
1600
  "quantity": 33,
1342
1601
  "unit": 0
1343
1602
  },
1344
- "deprecateAliases": true
1603
+ "hasDynamicHelp": false,
1604
+ "helpValue": "<minutes>",
1605
+ "multiple": false,
1606
+ "type": "option"
1345
1607
  },
1346
1608
  "purge-on-delete": {
1347
- "name": "purge-on-delete",
1348
- "type": "boolean",
1349
- "summary": "Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion rather than being stored in the Recycle Bin.",
1350
- "helpGroup": "Delete",
1351
- "allowNo": false,
1352
1609
  "dependsOn": [
1353
1610
  "manifest"
1354
1611
  ],
1612
+ "helpGroup": "Delete",
1613
+ "name": "purge-on-delete",
1355
1614
  "relationships": [
1356
1615
  {
1357
1616
  "type": "some",
@@ -1361,36 +1620,38 @@
1361
1620
  ]
1362
1621
  }
1363
1622
  ],
1364
- "deprecateAliases": true
1623
+ "summary": "Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion rather than being stored in the Recycle Bin.",
1624
+ "allowNo": false,
1625
+ "type": "boolean"
1365
1626
  },
1366
1627
  "pre-destructive-changes": {
1628
+ "dependsOn": [
1629
+ "manifest"
1630
+ ],
1631
+ "helpGroup": "Delete",
1367
1632
  "name": "pre-destructive-changes",
1368
- "type": "option",
1369
1633
  "summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy",
1370
- "helpGroup": "Delete",
1634
+ "hasDynamicHelp": false,
1371
1635
  "multiple": false,
1636
+ "type": "option"
1637
+ },
1638
+ "post-destructive-changes": {
1372
1639
  "dependsOn": [
1373
1640
  "manifest"
1374
1641
  ],
1375
- "deprecateAliases": true
1376
- },
1377
- "post-destructive-changes": {
1642
+ "helpGroup": "Delete",
1378
1643
  "name": "post-destructive-changes",
1379
- "type": "option",
1380
1644
  "summary": "File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.",
1381
- "helpGroup": "Delete",
1645
+ "hasDynamicHelp": false,
1382
1646
  "multiple": false,
1383
- "dependsOn": [
1384
- "manifest"
1385
- ],
1386
- "deprecateAliases": true
1647
+ "type": "option"
1387
1648
  },
1388
1649
  "coverage-formatters": {
1389
- "name": "coverage-formatters",
1390
- "type": "option",
1391
- "summary": "Format of the code coverage results.",
1392
1650
  "description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
1393
1651
  "helpGroup": "Test",
1652
+ "name": "coverage-formatters",
1653
+ "summary": "Format of the code coverage results.",
1654
+ "hasDynamicHelp": false,
1394
1655
  "multiple": true,
1395
1656
  "options": [
1396
1657
  "clover",
@@ -1405,22 +1666,18 @@
1405
1666
  "text",
1406
1667
  "text-summary"
1407
1668
  ],
1408
- "deprecateAliases": true
1669
+ "type": "option"
1409
1670
  },
1410
1671
  "junit": {
1672
+ "helpGroup": "Test",
1411
1673
  "name": "junit",
1412
- "type": "boolean",
1413
1674
  "summary": "Output JUnit test results.",
1414
- "helpGroup": "Test",
1415
1675
  "allowNo": false,
1416
- "deprecateAliases": true
1676
+ "type": "boolean"
1417
1677
  },
1418
1678
  "results-dir": {
1419
- "name": "results-dir",
1420
- "type": "option",
1421
- "summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
1422
1679
  "helpGroup": "Test",
1423
- "multiple": false,
1680
+ "name": "results-dir",
1424
1681
  "relationships": [
1425
1682
  {
1426
1683
  "type": "some",
@@ -1430,10 +1687,22 @@
1430
1687
  ]
1431
1688
  }
1432
1689
  ],
1433
- "deprecateAliases": true
1690
+ "summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
1691
+ "hasDynamicHelp": false,
1692
+ "multiple": false,
1693
+ "type": "option"
1434
1694
  }
1435
1695
  },
1436
- "args": {},
1696
+ "hasDynamicHelp": true,
1697
+ "hiddenAliases": [],
1698
+ "id": "project:deploy:start",
1699
+ "pluginAlias": "@salesforce/plugin-deploy-retrieve",
1700
+ "pluginName": "@salesforce/plugin-deploy-retrieve",
1701
+ "pluginType": "core",
1702
+ "strict": true,
1703
+ "summary": "Deploy metadata to an org from your local project.",
1704
+ "enableJsonFlag": true,
1705
+ "SF_ENV": "SF_ENV",
1437
1706
  "configurationVariablesSection": {
1438
1707
  "header": "CONFIGURATION VARIABLES",
1439
1708
  "body": [
@@ -1493,188 +1762,197 @@
1493
1762
  }
1494
1763
  ]
1495
1764
  },
1496
- "hasDynamicHelp": true
1765
+ "isESM": true,
1766
+ "relativePath": [
1767
+ "lib",
1768
+ "commands",
1769
+ "project",
1770
+ "deploy",
1771
+ "start.js"
1772
+ ],
1773
+ "aliasPermutations": [
1774
+ "deploy:metadata",
1775
+ "metadata:deploy"
1776
+ ],
1777
+ "permutations": [
1778
+ "project:deploy:start",
1779
+ "deploy:project:start",
1780
+ "deploy:start:project",
1781
+ "project:start:deploy",
1782
+ "start:project:deploy",
1783
+ "start:deploy:project"
1784
+ ]
1497
1785
  },
1498
1786
  "project:deploy:validate": {
1499
- "id": "project:deploy:validate",
1500
- "summary": "Validate a metadata deployment without actually executing it.",
1501
- "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.",
1502
- "strict": true,
1503
- "pluginName": "@salesforce/plugin-deploy-retrieve",
1504
- "pluginAlias": "@salesforce/plugin-deploy-retrieve",
1505
- "pluginType": "core",
1506
1787
  "aliases": [
1507
1788
  "deploy:metadata:validate"
1508
1789
  ],
1790
+ "args": {},
1791
+ "deprecateAliases": true,
1792
+ "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.",
1509
1793
  "examples": [
1510
1794
  "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.",
1511
1795
  "Validate the deployment of all source files in a directory to the default org:\n<%= config.bin %> <%= command.id %> --source-dir path/to/source",
1512
1796
  "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 path/to/source --async --test-level RunAllTestsInOrg --target-org my-prod-org",
1513
1797
  "Validate the deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
1514
1798
  ],
1515
- "deprecateAliases": true,
1516
1799
  "flags": {
1517
1800
  "json": {
1518
- "name": "json",
1519
- "type": "boolean",
1520
1801
  "description": "Format output as json.",
1521
1802
  "helpGroup": "GLOBAL",
1803
+ "name": "json",
1522
1804
  "allowNo": false,
1523
- "deprecateAliases": true
1805
+ "type": "boolean"
1524
1806
  },
1525
1807
  "api-version": {
1526
- "name": "api-version",
1527
- "type": "option",
1528
1808
  "char": "a",
1529
- "summary": "Target API version for the validation.",
1530
1809
  "description": "Use this flag to override the default API version with the API version of your package.xml file. The default API version is the latest version supported by the CLI.",
1810
+ "name": "api-version",
1811
+ "summary": "Target API version for the validation.",
1812
+ "hasDynamicHelp": false,
1531
1813
  "multiple": false,
1532
- "deprecateAliases": true
1814
+ "type": "option"
1533
1815
  },
1534
1816
  "async": {
1817
+ "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\".",
1535
1818
  "name": "async",
1536
- "type": "boolean",
1537
1819
  "summary": "Run the command asynchronously.",
1538
- "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\".",
1539
1820
  "allowNo": false,
1540
- "deprecateAliases": true
1821
+ "type": "boolean"
1541
1822
  },
1542
1823
  "concise": {
1543
- "name": "concise",
1544
- "type": "boolean",
1545
- "summary": "Show concise output of the validation result.",
1546
- "allowNo": false,
1547
1824
  "exclusive": [
1548
1825
  "verbose"
1549
1826
  ],
1550
- "deprecateAliases": true
1827
+ "name": "concise",
1828
+ "summary": "Show concise output of the validation result.",
1829
+ "allowNo": false,
1830
+ "type": "boolean"
1551
1831
  },
1552
1832
  "manifest": {
1553
- "name": "manifest",
1554
- "type": "option",
1555
1833
  "char": "x",
1556
- "summary": "Full file path for manifest (package.xml) of components to validate for deployment.",
1557
1834
  "description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
1558
1835
  "helpGroup": "Source Format",
1836
+ "name": "manifest",
1837
+ "summary": "Full file path for manifest (package.xml) of components to validate for deployment.",
1838
+ "hasDynamicHelp": false,
1559
1839
  "multiple": false,
1560
- "deprecateAliases": true
1840
+ "type": "option"
1561
1841
  },
1562
1842
  "metadata": {
1563
- "name": "metadata",
1564
- "type": "option",
1565
1843
  "char": "m",
1566
- "summary": "Metadata component names to validate for deployment.",
1567
1844
  "helpGroup": "Source Format",
1845
+ "name": "metadata",
1846
+ "summary": "Metadata component names to validate for deployment.",
1847
+ "hasDynamicHelp": false,
1568
1848
  "multiple": true,
1569
- "deprecateAliases": true
1849
+ "type": "option"
1570
1850
  },
1571
1851
  "source-dir": {
1572
- "name": "source-dir",
1573
- "type": "option",
1574
1852
  "char": "d",
1575
- "summary": "Path to the local source files to validate for deployment.",
1576
1853
  "description": "The supplied path 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 subdirectories).\n\nIf you specify this flag, don’t specify --metadata or --manifest.",
1577
1854
  "helpGroup": "Source Format",
1855
+ "name": "source-dir",
1856
+ "summary": "Path to the local source files to validate for deployment.",
1857
+ "hasDynamicHelp": false,
1578
1858
  "multiple": true,
1579
- "deprecateAliases": true
1859
+ "type": "option"
1580
1860
  },
1581
1861
  "metadata-dir": {
1862
+ "helpGroup": "Metadata API Format",
1582
1863
  "name": "metadata-dir",
1583
- "type": "option",
1584
1864
  "summary": "Root of directory or zip file of metadata formatted files to deploy.",
1585
- "helpGroup": "Metadata API Format",
1865
+ "hasDynamicHelp": false,
1586
1866
  "multiple": false,
1587
- "deprecateAliases": true
1867
+ "type": "option"
1588
1868
  },
1589
1869
  "single-package": {
1590
- "name": "single-package",
1591
- "type": "boolean",
1592
- "summary": "Indicates that the metadata zip file points to a directory structure for a single package.",
1593
- "helpGroup": "Metadata API Format",
1594
- "allowNo": false,
1595
1870
  "dependsOn": [
1596
1871
  "metadata-dir"
1597
1872
  ],
1598
- "deprecateAliases": true
1873
+ "helpGroup": "Metadata API Format",
1874
+ "name": "single-package",
1875
+ "summary": "Indicates that the metadata zip file points to a directory structure for a single package.",
1876
+ "allowNo": false,
1877
+ "type": "boolean"
1599
1878
  },
1600
1879
  "target-org": {
1601
- "name": "target-org",
1602
- "type": "option",
1603
1880
  "char": "o",
1604
- "summary": "Login username or alias for the target org.",
1605
1881
  "description": "Overrides your default org.",
1882
+ "name": "target-org",
1883
+ "noCacheDefault": true,
1606
1884
  "required": true,
1885
+ "summary": "Login username or alias for the target org.",
1886
+ "hasDynamicHelp": true,
1607
1887
  "multiple": false,
1608
- "deprecateAliases": true
1888
+ "type": "option"
1609
1889
  },
1610
1890
  "tests": {
1611
- "name": "tests",
1612
- "type": "option",
1613
1891
  "char": "t",
1614
- "summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
1615
- "description": "If a test name contains a space, enclose it in double quotes.\nFor multiple test names, use one of the following formats:\n\n- Repeat the flag for multiple test names: --tests Test1 --tests Test2 --tests \"Test With Space\"\n- Separate the test names with spaces: --tests Test1 Test2 \"Test With Space\"",
1616
- "helpGroup": "Test",
1617
- "multiple": true,
1618
1892
  "dependsOn": [
1619
1893
  "test-level"
1620
1894
  ],
1621
- "deprecateAliases": true
1895
+ "description": "If a test name contains a space, enclose it in double quotes.\nFor multiple test names, use one of the following formats:\n\n- Repeat the flag for multiple test names: --tests Test1 --tests Test2 --tests \"Test With Space\"\n- Separate the test names with spaces: --tests Test1 Test2 \"Test With Space\"",
1896
+ "helpGroup": "Test",
1897
+ "name": "tests",
1898
+ "summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
1899
+ "hasDynamicHelp": false,
1900
+ "multiple": true,
1901
+ "type": "option"
1622
1902
  },
1623
1903
  "test-level": {
1624
- "name": "test-level",
1625
- "type": "option",
1626
1904
  "char": "l",
1627
- "summary": "Deployment Apex testing level.",
1628
1905
  "description": "Valid values are:\n\n- RunSpecifiedTests — Runs only the tests that you specify with the --tests flag. Code coverage requirements differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and trigger individually and is different than the overall coverage percentage.\n\n- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.",
1629
1906
  "helpGroup": "Test",
1907
+ "name": "test-level",
1908
+ "summary": "Deployment Apex testing level.",
1909
+ "default": "RunLocalTests",
1910
+ "hasDynamicHelp": false,
1630
1911
  "multiple": false,
1631
1912
  "options": [
1632
1913
  "RunAllTestsInOrg",
1633
1914
  "RunLocalTests",
1634
1915
  "RunSpecifiedTests"
1635
1916
  ],
1636
- "default": "RunLocalTests",
1637
- "deprecateAliases": true
1917
+ "type": "option"
1638
1918
  },
1639
1919
  "verbose": {
1640
- "name": "verbose",
1641
- "type": "boolean",
1642
- "summary": "Show verbose output of the validation result.",
1643
- "allowNo": false,
1644
1920
  "exclusive": [
1645
1921
  "concise"
1646
1922
  ],
1647
- "deprecateAliases": true
1923
+ "name": "verbose",
1924
+ "summary": "Show verbose output of the validation result.",
1925
+ "allowNo": false,
1926
+ "type": "boolean"
1648
1927
  },
1649
1928
  "wait": {
1650
- "name": "wait",
1651
- "type": "option",
1652
1929
  "char": "w",
1653
- "summary": "Number of minutes to wait for the command to complete and display results.",
1654
1930
  "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\".",
1655
- "helpValue": "<minutes>",
1656
- "multiple": false,
1931
+ "name": "wait",
1932
+ "summary": "Number of minutes to wait for the command to complete and display results.",
1657
1933
  "default": {
1658
1934
  "quantity": 33,
1659
1935
  "unit": 0
1660
1936
  },
1661
- "deprecateAliases": true
1937
+ "hasDynamicHelp": false,
1938
+ "helpValue": "<minutes>",
1939
+ "multiple": false,
1940
+ "type": "option"
1662
1941
  },
1663
1942
  "ignore-warnings": {
1664
- "name": "ignore-warnings",
1665
- "type": "boolean",
1666
1943
  "char": "g",
1667
- "summary": "Ignore warnings and allow a deployment to complete successfully.",
1668
1944
  "description": "If a warning occurs and this flag is set to true, the success status of the deployment is set to true. When this flag is set to false, success is set to false, and the warning is treated like an error.",
1945
+ "name": "ignore-warnings",
1946
+ "summary": "Ignore warnings and allow a deployment to complete successfully.",
1669
1947
  "allowNo": false,
1670
- "deprecateAliases": true
1948
+ "type": "boolean"
1671
1949
  },
1672
1950
  "coverage-formatters": {
1673
- "name": "coverage-formatters",
1674
- "type": "option",
1675
- "summary": "Format of the code coverage results.",
1676
1951
  "description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
1677
1952
  "helpGroup": "Test",
1953
+ "name": "coverage-formatters",
1954
+ "summary": "Format of the code coverage results.",
1955
+ "hasDynamicHelp": false,
1678
1956
  "multiple": true,
1679
1957
  "options": [
1680
1958
  "clover",
@@ -1689,22 +1967,18 @@
1689
1967
  "text",
1690
1968
  "text-summary"
1691
1969
  ],
1692
- "deprecateAliases": true
1970
+ "type": "option"
1693
1971
  },
1694
1972
  "junit": {
1973
+ "helpGroup": "Test",
1695
1974
  "name": "junit",
1696
- "type": "boolean",
1697
1975
  "summary": "Output JUnit test results.",
1698
- "helpGroup": "Test",
1699
1976
  "allowNo": false,
1700
- "deprecateAliases": true
1977
+ "type": "boolean"
1701
1978
  },
1702
1979
  "results-dir": {
1703
- "name": "results-dir",
1704
- "type": "option",
1705
- "summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
1706
1980
  "helpGroup": "Test",
1707
- "multiple": false,
1981
+ "name": "results-dir",
1708
1982
  "relationships": [
1709
1983
  {
1710
1984
  "type": "some",
@@ -1714,17 +1988,17 @@
1714
1988
  ]
1715
1989
  }
1716
1990
  ],
1717
- "deprecateAliases": true
1991
+ "summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
1992
+ "hasDynamicHelp": false,
1993
+ "multiple": false,
1994
+ "type": "option"
1718
1995
  },
1719
1996
  "purge-on-delete": {
1720
- "name": "purge-on-delete",
1721
- "type": "boolean",
1722
- "summary": "Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion rather than being stored in the Recycle Bin.",
1723
- "helpGroup": "Delete",
1724
- "allowNo": false,
1725
1997
  "dependsOn": [
1726
1998
  "manifest"
1727
1999
  ],
2000
+ "helpGroup": "Delete",
2001
+ "name": "purge-on-delete",
1728
2002
  "relationships": [
1729
2003
  {
1730
2004
  "type": "some",
@@ -1734,32 +2008,43 @@
1734
2008
  ]
1735
2009
  }
1736
2010
  ],
1737
- "deprecateAliases": true
2011
+ "summary": "Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion rather than being stored in the Recycle Bin.",
2012
+ "allowNo": false,
2013
+ "type": "boolean"
1738
2014
  },
1739
2015
  "pre-destructive-changes": {
2016
+ "dependsOn": [
2017
+ "manifest"
2018
+ ],
2019
+ "helpGroup": "Delete",
1740
2020
  "name": "pre-destructive-changes",
1741
- "type": "option",
1742
2021
  "summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy",
1743
- "helpGroup": "Delete",
2022
+ "hasDynamicHelp": false,
1744
2023
  "multiple": false,
2024
+ "type": "option"
2025
+ },
2026
+ "post-destructive-changes": {
1745
2027
  "dependsOn": [
1746
2028
  "manifest"
1747
2029
  ],
1748
- "deprecateAliases": true
1749
- },
1750
- "post-destructive-changes": {
2030
+ "helpGroup": "Delete",
1751
2031
  "name": "post-destructive-changes",
1752
- "type": "option",
1753
2032
  "summary": "File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.",
1754
- "helpGroup": "Delete",
2033
+ "hasDynamicHelp": false,
1755
2034
  "multiple": false,
1756
- "dependsOn": [
1757
- "manifest"
1758
- ],
1759
- "deprecateAliases": true
2035
+ "type": "option"
1760
2036
  }
1761
2037
  },
1762
- "args": {},
2038
+ "hasDynamicHelp": true,
2039
+ "hiddenAliases": [],
2040
+ "id": "project:deploy:validate",
2041
+ "pluginAlias": "@salesforce/plugin-deploy-retrieve",
2042
+ "pluginName": "@salesforce/plugin-deploy-retrieve",
2043
+ "pluginType": "core",
2044
+ "strict": true,
2045
+ "summary": "Validate a metadata deployment without actually executing it.",
2046
+ "enableJsonFlag": true,
2047
+ "SF_ENV": "SF_ENV",
1763
2048
  "configurationVariablesSection": {
1764
2049
  "header": "CONFIGURATION VARIABLES",
1765
2050
  "body": [
@@ -1819,95 +2104,122 @@
1819
2104
  }
1820
2105
  ]
1821
2106
  },
1822
- "hasDynamicHelp": true
2107
+ "isESM": true,
2108
+ "relativePath": [
2109
+ "lib",
2110
+ "commands",
2111
+ "project",
2112
+ "deploy",
2113
+ "validate.js"
2114
+ ],
2115
+ "aliasPermutations": [
2116
+ "deploy:metadata:validate",
2117
+ "metadata:deploy:validate",
2118
+ "metadata:validate:deploy",
2119
+ "deploy:validate:metadata",
2120
+ "validate:deploy:metadata",
2121
+ "validate:metadata:deploy"
2122
+ ],
2123
+ "permutations": [
2124
+ "project:deploy:validate",
2125
+ "deploy:project:validate",
2126
+ "deploy:validate:project",
2127
+ "project:validate:deploy",
2128
+ "validate:project:deploy",
2129
+ "validate:deploy:project"
2130
+ ]
1823
2131
  },
1824
2132
  "project:generate:manifest": {
1825
- "id": "project:generate:manifest",
1826
- "summary": "Create a project manifest that lists the metadata components you want to deploy or retrieve.",
1827
- "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.",
1828
- "strict": true,
1829
- "pluginName": "@salesforce/plugin-deploy-retrieve",
1830
- "pluginAlias": "@salesforce/plugin-deploy-retrieve",
1831
- "pluginType": "core",
1832
2133
  "aliases": [
1833
2134
  "force:source:manifest:create"
1834
2135
  ],
2136
+ "args": {},
2137
+ "deprecateAliases": true,
2138
+ "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.",
1835
2139
  "examples": [
1836
2140
  "Create a manifest for deploying or retrieving all Apex classes and custom objects:\n$ <%= config.bin %> <%= command.id %> --metadata ApexClass --metadata CustomObject",
1837
2141
  "Create a manifest for deleting the specified Apex class:\n$ <%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --type destroy",
1838
2142
  "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",
1839
2143
  "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"
1840
2144
  ],
1841
- "deprecateAliases": true,
1842
2145
  "flags": {
1843
2146
  "json": {
1844
- "name": "json",
1845
- "type": "boolean",
1846
2147
  "description": "Format output as json.",
1847
2148
  "helpGroup": "GLOBAL",
2149
+ "name": "json",
1848
2150
  "allowNo": false,
1849
- "deprecateAliases": true
2151
+ "type": "boolean"
1850
2152
  },
1851
2153
  "api-version": {
1852
- "name": "api-version",
1853
- "type": "option",
1854
- "description": "Override the api version used for api requests made by this command",
1855
- "multiple": false,
1856
- "deprecateAliases": true,
1857
2154
  "aliases": [
1858
2155
  "apiversion"
1859
- ]
2156
+ ],
2157
+ "deprecateAliases": true,
2158
+ "description": "Override the api version used for api requests made by this command",
2159
+ "name": "api-version",
2160
+ "hasDynamicHelp": false,
2161
+ "multiple": false,
2162
+ "type": "option"
1860
2163
  },
1861
2164
  "loglevel": {
1862
- "name": "loglevel",
1863
- "type": "option",
1864
- "hidden": true,
1865
- "multiple": false,
1866
2165
  "deprecated": {
1867
2166
  "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
1868
2167
  },
1869
- "deprecateAliases": true
2168
+ "hidden": true,
2169
+ "name": "loglevel",
2170
+ "hasDynamicHelp": false,
2171
+ "multiple": false,
2172
+ "type": "option"
1870
2173
  },
1871
2174
  "metadata": {
1872
- "name": "metadata",
1873
- "type": "option",
1874
2175
  "char": "m",
2176
+ "name": "metadata",
1875
2177
  "summary": "Names of metadata components to include in the manifest.",
2178
+ "delimiter": ",",
2179
+ "hasDynamicHelp": false,
1876
2180
  "multiple": true,
1877
- "deprecateAliases": true,
1878
- "delimiter": ","
2181
+ "type": "option"
1879
2182
  },
1880
2183
  "source-dir": {
1881
- "name": "source-dir",
1882
- "type": "option",
1883
- "char": "p",
1884
- "summary": "Paths to the local source files to include in the manifest.",
1885
- "multiple": true,
1886
- "deprecateAliases": true,
1887
2184
  "aliases": [
1888
2185
  "sourcepath"
1889
2186
  ],
1890
- "delimiter": ","
2187
+ "char": "p",
2188
+ "deprecateAliases": true,
2189
+ "name": "source-dir",
2190
+ "summary": "Paths to the local source files to include in the manifest.",
2191
+ "delimiter": ",",
2192
+ "hasDynamicHelp": false,
2193
+ "multiple": true,
2194
+ "type": "option"
1891
2195
  },
1892
2196
  "name": {
1893
- "name": "name",
1894
- "type": "option",
2197
+ "aliases": [
2198
+ "manifestname"
2199
+ ],
1895
2200
  "char": "n",
1896
- "summary": "Name of a custom manifest file to create.",
1897
- "multiple": false,
2201
+ "deprecateAliases": true,
1898
2202
  "exclusive": [
1899
2203
  "type"
1900
2204
  ],
1901
- "deprecateAliases": true,
1902
- "aliases": [
1903
- "manifestname"
1904
- ]
2205
+ "name": "name",
2206
+ "summary": "Name of a custom manifest file to create.",
2207
+ "hasDynamicHelp": false,
2208
+ "multiple": false,
2209
+ "type": "option"
1905
2210
  },
1906
2211
  "type": {
1907
- "name": "type",
1908
- "type": "option",
2212
+ "aliases": [
2213
+ "manifesttype"
2214
+ ],
1909
2215
  "char": "t",
2216
+ "deprecateAliases": true,
2217
+ "exclusive": [
2218
+ "name"
2219
+ ],
2220
+ "name": "type",
1910
2221
  "summary": "Type of manifest to create; the type determines the name of the created file.",
2222
+ "hasDynamicHelp": false,
1911
2223
  "multiple": false,
1912
2224
  "options": [
1913
2225
  "pre",
@@ -1915,242 +2227,405 @@
1915
2227
  "destroy",
1916
2228
  "package"
1917
2229
  ],
1918
- "exclusive": [
1919
- "name"
1920
- ],
1921
- "deprecateAliases": true,
1922
- "aliases": [
1923
- "manifesttype"
1924
- ]
2230
+ "type": "option"
1925
2231
  },
1926
2232
  "include-packages": {
1927
- "name": "include-packages",
1928
- "type": "option",
1929
- "char": "c",
1930
- "summary": "Package types (managed, unlocked) whose metadata is included in the manifest; by default, metadata in packages is ignored.",
1931
- "multiple": true,
1932
- "options": [
1933
- "managed",
1934
- "unlocked"
2233
+ "aliases": [
2234
+ "includepackages"
1935
2235
  ],
2236
+ "char": "c",
1936
2237
  "dependsOn": [
1937
2238
  "from-org"
1938
2239
  ],
1939
2240
  "deprecateAliases": true,
1940
- "aliases": [
1941
- "includepackages"
2241
+ "name": "include-packages",
2242
+ "summary": "Package types (managed, unlocked) whose metadata is included in the manifest; by default, metadata in packages is ignored.",
2243
+ "delimiter": ",",
2244
+ "hasDynamicHelp": false,
2245
+ "multiple": true,
2246
+ "options": [
2247
+ "managed",
2248
+ "unlocked"
1942
2249
  ],
1943
- "delimiter": ","
2250
+ "type": "option"
1944
2251
  },
1945
2252
  "from-org": {
2253
+ "aliases": [
2254
+ "fromorg"
2255
+ ],
2256
+ "deprecateAliases": true,
1946
2257
  "name": "from-org",
1947
- "type": "option",
1948
2258
  "summary": "Username or alias of the org that contains the metadata components from which to build a manifest.",
2259
+ "hasDynamicHelp": false,
1949
2260
  "multiple": false,
1950
- "deprecateAliases": true,
1951
- "aliases": [
1952
- "fromorg"
1953
- ]
2261
+ "type": "option"
1954
2262
  },
1955
2263
  "output-dir": {
1956
- "name": "output-dir",
1957
- "type": "option",
1958
- "char": "d",
1959
- "summary": "Directory to save the created manifest.",
1960
- "multiple": false,
1961
- "deprecateAliases": true,
1962
2264
  "aliases": [
1963
2265
  "outputdir",
1964
2266
  "o"
1965
- ]
2267
+ ],
2268
+ "char": "d",
2269
+ "deprecateAliases": true,
2270
+ "name": "output-dir",
2271
+ "summary": "Directory to save the created manifest.",
2272
+ "hasDynamicHelp": false,
2273
+ "multiple": false,
2274
+ "type": "option"
1966
2275
  }
1967
2276
  },
1968
- "args": {},
1969
- "requiresProject": true
1970
- },
1971
- "project:list:ignored": {
1972
- "id": "project:list:ignored",
1973
- "summary": "Check your local project package directories for forceignored files.",
1974
- "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.",
1975
- "strict": true,
1976
- "pluginName": "@salesforce/plugin-deploy-retrieve",
2277
+ "hasDynamicHelp": false,
2278
+ "hiddenAliases": [],
2279
+ "id": "project:generate:manifest",
1977
2280
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
2281
+ "pluginName": "@salesforce/plugin-deploy-retrieve",
1978
2282
  "pluginType": "core",
2283
+ "strict": true,
2284
+ "summary": "Create a project manifest that lists the metadata components you want to deploy or retrieve.",
2285
+ "enableJsonFlag": true,
2286
+ "SF_ENV": "SF_ENV",
2287
+ "requiresProject": true,
2288
+ "isESM": true,
2289
+ "relativePath": [
2290
+ "lib",
2291
+ "commands",
2292
+ "project",
2293
+ "generate",
2294
+ "manifest.js"
2295
+ ],
2296
+ "aliasPermutations": [
2297
+ "force:source:manifest:create",
2298
+ "source:force:manifest:create",
2299
+ "source:manifest:force:create",
2300
+ "source:manifest:create:force",
2301
+ "force:manifest:source:create",
2302
+ "manifest:force:source:create",
2303
+ "manifest:source:force:create",
2304
+ "manifest:source:create:force",
2305
+ "force:manifest:create:source",
2306
+ "manifest:force:create:source",
2307
+ "manifest:create:force:source",
2308
+ "manifest:create:source:force",
2309
+ "force:source:create:manifest",
2310
+ "source:force:create:manifest",
2311
+ "source:create:force:manifest",
2312
+ "source:create:manifest:force",
2313
+ "force:create:source:manifest",
2314
+ "create:force:source:manifest",
2315
+ "create:source:force:manifest",
2316
+ "create:source:manifest:force",
2317
+ "force:create:manifest:source",
2318
+ "create:force:manifest:source",
2319
+ "create:manifest:force:source",
2320
+ "create:manifest:source:force"
2321
+ ],
2322
+ "permutations": [
2323
+ "project:generate:manifest",
2324
+ "generate:project:manifest",
2325
+ "generate:manifest:project",
2326
+ "project:manifest:generate",
2327
+ "manifest:project:generate",
2328
+ "manifest:generate:project"
2329
+ ]
2330
+ },
2331
+ "project:list:ignored": {
1979
2332
  "aliases": [
1980
2333
  "force:source:ignored:list"
1981
2334
  ],
2335
+ "args": {},
2336
+ "deprecateAliases": true,
2337
+ "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.",
1982
2338
  "examples": [
1983
2339
  "List all the files in all package directories that are ignored:\n<%= config.bin %> <%= command.id %>",
1984
2340
  "List all the files in a specific directory that are ignored:\n<%= config.bin %> <%= command.id %> --source-dir force-app",
1985
2341
  "Check if a particular file is ignored:\n<%= config.bin %> <%= command.id %> --source-dir package.xml"
1986
2342
  ],
1987
- "deprecateAliases": true,
1988
2343
  "flags": {
1989
2344
  "json": {
1990
- "name": "json",
1991
- "type": "boolean",
1992
2345
  "description": "Format output as json.",
1993
2346
  "helpGroup": "GLOBAL",
2347
+ "name": "json",
1994
2348
  "allowNo": false,
1995
- "deprecateAliases": true
2349
+ "type": "boolean"
1996
2350
  },
1997
2351
  "source-dir": {
1998
- "name": "source-dir",
1999
- "type": "option",
2352
+ "aliases": [
2353
+ "sourcepath"
2354
+ ],
2000
2355
  "char": "p",
2356
+ "deprecateAliases": true,
2357
+ "name": "source-dir",
2001
2358
  "summary": "File or directory of files that the command checks for foreceignored files.",
2359
+ "hasDynamicHelp": false,
2002
2360
  "multiple": false,
2003
- "deprecateAliases": true,
2004
- "aliases": [
2005
- "sourcepath"
2006
- ]
2361
+ "type": "option"
2007
2362
  }
2008
2363
  },
2009
- "args": {},
2010
- "requiresProject": true
2011
- },
2012
- "project:reset:tracking": {
2013
- "id": "project:reset:tracking",
2014
- "summary": "Reset local and remote source tracking.",
2015
- "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",
2016
- "strict": true,
2017
- "pluginName": "@salesforce/plugin-deploy-retrieve",
2364
+ "hasDynamicHelp": false,
2365
+ "hiddenAliases": [],
2366
+ "id": "project:list:ignored",
2018
2367
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
2368
+ "pluginName": "@salesforce/plugin-deploy-retrieve",
2019
2369
  "pluginType": "core",
2370
+ "strict": true,
2371
+ "summary": "Check your local project package directories for forceignored files.",
2372
+ "enableJsonFlag": true,
2373
+ "SF_ENV": "SF_ENV",
2374
+ "requiresProject": true,
2375
+ "isESM": true,
2376
+ "relativePath": [
2377
+ "lib",
2378
+ "commands",
2379
+ "project",
2380
+ "list",
2381
+ "ignored.js"
2382
+ ],
2383
+ "aliasPermutations": [
2384
+ "force:source:ignored:list",
2385
+ "source:force:ignored:list",
2386
+ "source:ignored:force:list",
2387
+ "source:ignored:list:force",
2388
+ "force:ignored:source:list",
2389
+ "ignored:force:source:list",
2390
+ "ignored:source:force:list",
2391
+ "ignored:source:list:force",
2392
+ "force:ignored:list:source",
2393
+ "ignored:force:list:source",
2394
+ "ignored:list:force:source",
2395
+ "ignored:list:source:force",
2396
+ "force:source:list:ignored",
2397
+ "source:force:list:ignored",
2398
+ "source:list:force:ignored",
2399
+ "source:list:ignored:force",
2400
+ "force:list:source:ignored",
2401
+ "list:force:source:ignored",
2402
+ "list:source:force:ignored",
2403
+ "list:source:ignored:force",
2404
+ "force:list:ignored:source",
2405
+ "list:force:ignored:source",
2406
+ "list:ignored:force:source",
2407
+ "list:ignored:source:force"
2408
+ ],
2409
+ "permutations": [
2410
+ "project:list:ignored",
2411
+ "list:project:ignored",
2412
+ "list:ignored:project",
2413
+ "project:ignored:list",
2414
+ "ignored:project:list",
2415
+ "ignored:list:project"
2416
+ ]
2417
+ },
2418
+ "project:reset:tracking": {
2020
2419
  "aliases": [
2021
2420
  "force:source:tracking:reset"
2022
2421
  ],
2422
+ "args": {},
2423
+ "deprecateAliases": true,
2424
+ "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",
2023
2425
  "examples": [
2024
2426
  "Reset source tracking for the org with alias \"my-scratch\":\n$ <%= config.bin %> <%= command.id %> --target-org my-scratch",
2025
2427
  "Reset source tracking to revision number 30 for your default org:\n$ <%= config.bin %> <%= command.id %> --revision 30"
2026
2428
  ],
2027
- "deprecateAliases": true,
2028
2429
  "flags": {
2029
2430
  "json": {
2030
- "name": "json",
2031
- "type": "boolean",
2032
2431
  "description": "Format output as json.",
2033
2432
  "helpGroup": "GLOBAL",
2433
+ "name": "json",
2034
2434
  "allowNo": false,
2035
- "deprecateAliases": true
2435
+ "type": "boolean"
2036
2436
  },
2037
2437
  "target-org": {
2038
- "name": "target-org",
2039
- "type": "option",
2040
- "char": "o",
2041
- "summary": "Username or alias of the target org.",
2042
- "required": true,
2043
- "multiple": false,
2044
- "deprecateAliases": true,
2045
2438
  "aliases": [
2046
2439
  "targetusername",
2047
2440
  "u"
2048
- ]
2441
+ ],
2442
+ "char": "o",
2443
+ "deprecateAliases": true,
2444
+ "name": "target-org",
2445
+ "noCacheDefault": true,
2446
+ "required": true,
2447
+ "summary": "Username or alias of the target org.",
2448
+ "hasDynamicHelp": true,
2449
+ "multiple": false,
2450
+ "type": "option"
2049
2451
  },
2050
2452
  "api-version": {
2051
- "name": "api-version",
2052
- "type": "option",
2053
- "description": "Override the api version used for api requests made by this command",
2054
- "multiple": false,
2055
- "deprecateAliases": true,
2056
2453
  "aliases": [
2057
2454
  "apiversion"
2058
- ]
2455
+ ],
2456
+ "deprecateAliases": true,
2457
+ "description": "Override the api version used for api requests made by this command",
2458
+ "name": "api-version",
2459
+ "hasDynamicHelp": false,
2460
+ "multiple": false,
2461
+ "type": "option"
2059
2462
  },
2060
2463
  "loglevel": {
2061
- "name": "loglevel",
2062
- "type": "option",
2063
- "hidden": true,
2064
- "multiple": false,
2065
2464
  "deprecated": {
2066
2465
  "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
2067
2466
  },
2068
- "deprecateAliases": true
2467
+ "hidden": true,
2468
+ "name": "loglevel",
2469
+ "hasDynamicHelp": false,
2470
+ "multiple": false,
2471
+ "type": "option"
2069
2472
  },
2070
2473
  "revision": {
2071
- "name": "revision",
2072
- "type": "option",
2073
2474
  "char": "r",
2475
+ "name": "revision",
2074
2476
  "summary": "SourceMember revision counter number to reset to.",
2477
+ "hasDynamicHelp": false,
2075
2478
  "multiple": false,
2076
- "deprecateAliases": true
2479
+ "type": "option"
2077
2480
  },
2078
2481
  "no-prompt": {
2079
- "name": "no-prompt",
2080
- "type": "boolean",
2482
+ "aliases": [
2483
+ "noprompt"
2484
+ ],
2081
2485
  "char": "p",
2486
+ "deprecateAliases": true,
2487
+ "name": "no-prompt",
2082
2488
  "summary": "Don't prompt for source tracking override confirmation.",
2083
2489
  "allowNo": false,
2084
- "deprecateAliases": true,
2085
- "aliases": [
2086
- "noprompt"
2087
- ]
2490
+ "type": "boolean"
2088
2491
  }
2089
2492
  },
2090
- "args": {},
2493
+ "hasDynamicHelp": true,
2494
+ "hiddenAliases": [],
2495
+ "id": "project:reset:tracking",
2496
+ "pluginAlias": "@salesforce/plugin-deploy-retrieve",
2497
+ "pluginName": "@salesforce/plugin-deploy-retrieve",
2498
+ "pluginType": "core",
2499
+ "strict": true,
2500
+ "summary": "Reset local and remote source tracking.",
2501
+ "enableJsonFlag": true,
2502
+ "SF_ENV": "SF_ENV",
2091
2503
  "requiresProject": true,
2092
- "hasDynamicHelp": true
2504
+ "isESM": true,
2505
+ "relativePath": [
2506
+ "lib",
2507
+ "commands",
2508
+ "project",
2509
+ "reset",
2510
+ "tracking.js"
2511
+ ],
2512
+ "aliasPermutations": [
2513
+ "force:source:tracking:reset",
2514
+ "source:force:tracking:reset",
2515
+ "source:tracking:force:reset",
2516
+ "source:tracking:reset:force",
2517
+ "force:tracking:source:reset",
2518
+ "tracking:force:source:reset",
2519
+ "tracking:source:force:reset",
2520
+ "tracking:source:reset:force",
2521
+ "force:tracking:reset:source",
2522
+ "tracking:force:reset:source",
2523
+ "tracking:reset:force:source",
2524
+ "tracking:reset:source:force",
2525
+ "force:source:reset:tracking",
2526
+ "source:force:reset:tracking",
2527
+ "source:reset:force:tracking",
2528
+ "source:reset:tracking:force",
2529
+ "force:reset:source:tracking",
2530
+ "reset:force:source:tracking",
2531
+ "reset:source:force:tracking",
2532
+ "reset:source:tracking:force",
2533
+ "force:reset:tracking:source",
2534
+ "reset:force:tracking:source",
2535
+ "reset:tracking:force:source",
2536
+ "reset:tracking:source:force"
2537
+ ],
2538
+ "permutations": [
2539
+ "project:reset:tracking",
2540
+ "reset:project:tracking",
2541
+ "reset:tracking:project",
2542
+ "project:tracking:reset",
2543
+ "tracking:project:reset",
2544
+ "tracking:reset:project"
2545
+ ]
2093
2546
  },
2094
2547
  "project:retrieve:preview": {
2095
- "id": "project:retrieve:preview",
2096
- "summary": "Preview a retrieval to see what will be retrieved from the org, the potential conflicts, and the ignored files.",
2097
- "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.",
2098
- "strict": true,
2099
- "pluginName": "@salesforce/plugin-deploy-retrieve",
2100
- "pluginAlias": "@salesforce/plugin-deploy-retrieve",
2101
- "pluginType": "core",
2102
2548
  "aliases": [
2103
2549
  "retrieve:metadata:preview"
2104
2550
  ],
2551
+ "args": {},
2552
+ "deprecateAliases": true,
2553
+ "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.",
2105
2554
  "examples": [
2106
2555
  "Preview the retrieve of all changes from your default org:\n<%= config.bin %> <%= command.id %>",
2107
2556
  "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"
2108
2557
  ],
2109
- "deprecateAliases": true,
2110
2558
  "flags": {
2111
2559
  "json": {
2112
- "name": "json",
2113
- "type": "boolean",
2114
2560
  "description": "Format output as json.",
2115
2561
  "helpGroup": "GLOBAL",
2562
+ "name": "json",
2116
2563
  "allowNo": false,
2117
- "deprecateAliases": true
2564
+ "type": "boolean"
2118
2565
  },
2119
2566
  "ignore-conflicts": {
2120
- "name": "ignore-conflicts",
2121
- "type": "boolean",
2122
2567
  "char": "c",
2123
- "summary": "Don't display conflicts in the preview of the retrieval.",
2124
2568
  "description": "This flag applies only to orgs that allow source tracking. It has no effect on orgs that don't allow it, such as production orgs.",
2569
+ "name": "ignore-conflicts",
2570
+ "summary": "Don't display conflicts in the preview of the retrieval.",
2125
2571
  "allowNo": false,
2126
- "deprecateAliases": true
2572
+ "type": "boolean"
2127
2573
  },
2128
2574
  "target-org": {
2129
- "name": "target-org",
2130
- "type": "option",
2131
2575
  "char": "o",
2132
- "summary": "Login username or alias for the target org.",
2133
2576
  "description": "Overrides your default org.",
2577
+ "name": "target-org",
2578
+ "noCacheDefault": true,
2134
2579
  "required": true,
2580
+ "summary": "Login username or alias for the target org.",
2581
+ "hasDynamicHelp": true,
2135
2582
  "multiple": false,
2136
- "deprecateAliases": true
2583
+ "type": "option"
2137
2584
  }
2138
2585
  },
2139
- "args": {},
2586
+ "hasDynamicHelp": true,
2587
+ "hiddenAliases": [],
2588
+ "id": "project:retrieve:preview",
2589
+ "pluginAlias": "@salesforce/plugin-deploy-retrieve",
2590
+ "pluginName": "@salesforce/plugin-deploy-retrieve",
2591
+ "pluginType": "core",
2592
+ "strict": true,
2593
+ "summary": "Preview a retrieval to see what will be retrieved from the org, the potential conflicts, and the ignored files.",
2594
+ "enableJsonFlag": true,
2595
+ "SF_ENV": "SF_ENV",
2140
2596
  "requiresProject": true,
2141
- "hasDynamicHelp": true
2597
+ "isESM": true,
2598
+ "relativePath": [
2599
+ "lib",
2600
+ "commands",
2601
+ "project",
2602
+ "retrieve",
2603
+ "preview.js"
2604
+ ],
2605
+ "aliasPermutations": [
2606
+ "retrieve:metadata:preview",
2607
+ "metadata:retrieve:preview",
2608
+ "metadata:preview:retrieve",
2609
+ "retrieve:preview:metadata",
2610
+ "preview:retrieve:metadata",
2611
+ "preview:metadata:retrieve"
2612
+ ],
2613
+ "permutations": [
2614
+ "project:retrieve:preview",
2615
+ "retrieve:project:preview",
2616
+ "retrieve:preview:project",
2617
+ "project:preview:retrieve",
2618
+ "preview:project:retrieve",
2619
+ "preview:retrieve:project"
2620
+ ]
2142
2621
  },
2143
2622
  "project:retrieve:start": {
2144
- "id": "project:retrieve:start",
2145
- "summary": "Retrieve metadata from an org to your local project.",
2146
- "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 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 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.",
2147
- "strict": true,
2148
- "pluginName": "@salesforce/plugin-deploy-retrieve",
2149
- "pluginAlias": "@salesforce/plugin-deploy-retrieve",
2150
- "pluginType": "core",
2151
2623
  "aliases": [
2152
2624
  "retrieve:metadata"
2153
2625
  ],
2626
+ "args": {},
2627
+ "deprecateAliases": true,
2628
+ "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 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 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.",
2154
2629
  "examples": [
2155
2630
  "Retrieve remote changes from your default org:\n<%= config.bin %> <%= command.id %>",
2156
2631
  "Retrieve the source files in a directory from an org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --source-dir path/to/source --target-org my-scratch",
@@ -2165,114 +2640,110 @@
2165
2640
  "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",
2166
2641
  "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"
2167
2642
  ],
2168
- "deprecateAliases": true,
2169
2643
  "flags": {
2170
2644
  "json": {
2171
- "name": "json",
2172
- "type": "boolean",
2173
2645
  "description": "Format output as json.",
2174
2646
  "helpGroup": "GLOBAL",
2647
+ "name": "json",
2175
2648
  "allowNo": false,
2176
- "deprecateAliases": true
2649
+ "type": "boolean"
2177
2650
  },
2178
2651
  "api-version": {
2179
- "name": "api-version",
2180
- "type": "option",
2181
2652
  "char": "a",
2182
- "summary": "Target API version for the retrieve.",
2183
2653
  "description": "Use this flag to override the default API version, which is the latest version supported the CLI, with the API version in your package.xml file.",
2654
+ "name": "api-version",
2655
+ "summary": "Target API version for the retrieve.",
2656
+ "hasDynamicHelp": false,
2184
2657
  "multiple": false,
2185
- "deprecateAliases": true
2658
+ "type": "option"
2186
2659
  },
2187
2660
  "ignore-conflicts": {
2188
- "name": "ignore-conflicts",
2189
- "type": "boolean",
2190
2661
  "char": "c",
2191
- "summary": "Ignore conflicts and retrieve and save files to your local filesystem, even if they overwrite your local changes.",
2192
2662
  "description": "This flag applies only to orgs that allow source tracking. It has no effect on orgs that don't allow it, such as production orgs.",
2663
+ "name": "ignore-conflicts",
2664
+ "summary": "Ignore conflicts and retrieve and save files to your local filesystem, even if they overwrite your local changes.",
2193
2665
  "allowNo": false,
2194
- "deprecateAliases": true
2666
+ "type": "boolean"
2195
2667
  },
2196
2668
  "manifest": {
2197
- "name": "manifest",
2198
- "type": "option",
2199
2669
  "char": "x",
2200
- "summary": "File path for the manifest (package.xml) that specifies the components to retrieve.",
2201
2670
  "description": "If you specify this parameter, don’t specify --metadata or --source-dir.",
2202
- "multiple": false,
2203
2671
  "exclusive": [
2204
2672
  "metadata",
2205
2673
  "source-dir"
2206
2674
  ],
2207
- "deprecateAliases": true
2675
+ "name": "manifest",
2676
+ "summary": "File path for the manifest (package.xml) that specifies the components to retrieve.",
2677
+ "hasDynamicHelp": false,
2678
+ "multiple": false,
2679
+ "type": "option"
2208
2680
  },
2209
2681
  "metadata": {
2210
- "name": "metadata",
2211
- "type": "option",
2212
2682
  "char": "m",
2213
- "summary": "Metadata component names to retrieve. Wildcards ( `*` ) supported as long as you use quotes, such as `ApexClass:MyClass*`",
2214
- "multiple": true,
2215
2683
  "exclusive": [
2216
2684
  "manifest",
2217
2685
  "source-dir"
2218
2686
  ],
2219
- "deprecateAliases": true
2687
+ "name": "metadata",
2688
+ "summary": "Metadata component names to retrieve. Wildcards ( `*` ) supported as long as you use quotes, such as `ApexClass:MyClass*`",
2689
+ "hasDynamicHelp": false,
2690
+ "multiple": true,
2691
+ "type": "option"
2220
2692
  },
2221
2693
  "package-name": {
2222
- "name": "package-name",
2223
- "type": "option",
2224
2694
  "char": "n",
2695
+ "name": "package-name",
2225
2696
  "summary": "Package names to retrieve.",
2697
+ "hasDynamicHelp": false,
2226
2698
  "multiple": true,
2227
- "deprecateAliases": true
2699
+ "type": "option"
2228
2700
  },
2229
2701
  "output-dir": {
2230
- "name": "output-dir",
2231
- "type": "option",
2232
2702
  "char": "r",
2233
- "summary": "Directory root for the retrieved source files.",
2234
2703
  "description": "The root of the directory structure into which the source files are retrieved.\nIf the target directory matches one of the package directories in your sfdx-project.json file, the command fails.\nRunning the command multiple times with the same target adds new files and overwrites existing files.",
2235
- "multiple": false,
2236
2704
  "exclusive": [
2237
2705
  "package-name",
2238
2706
  "source-dir"
2239
2707
  ],
2240
- "deprecateAliases": true
2708
+ "name": "output-dir",
2709
+ "summary": "Directory root for the retrieved source files.",
2710
+ "hasDynamicHelp": false,
2711
+ "multiple": false,
2712
+ "type": "option"
2241
2713
  },
2242
2714
  "single-package": {
2243
- "name": "single-package",
2244
- "type": "boolean",
2245
- "summary": "Indicates that the zip file points to a directory structure for a single package.",
2246
- "helpGroup": "Metadata API Format",
2247
- "allowNo": false,
2248
2715
  "dependsOn": [
2249
2716
  "target-metadata-dir"
2250
2717
  ],
2251
2718
  "exclusive": [
2252
2719
  "ignore-conflicts"
2253
2720
  ],
2254
- "deprecateAliases": true
2721
+ "helpGroup": "Metadata API Format",
2722
+ "name": "single-package",
2723
+ "summary": "Indicates that the zip file points to a directory structure for a single package.",
2724
+ "allowNo": false,
2725
+ "type": "boolean"
2255
2726
  },
2256
2727
  "source-dir": {
2257
- "name": "source-dir",
2258
- "type": "option",
2259
2728
  "char": "d",
2260
- "summary": "File paths for source to retrieve from the org.",
2261
2729
  "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 source files in the directory and its subdirectories).",
2262
- "multiple": true,
2263
2730
  "exclusive": [
2264
2731
  "manifest",
2265
2732
  "metadata"
2266
2733
  ],
2267
- "deprecateAliases": true
2734
+ "name": "source-dir",
2735
+ "summary": "File paths for source to retrieve from the org.",
2736
+ "hasDynamicHelp": false,
2737
+ "multiple": true,
2738
+ "type": "option"
2268
2739
  },
2269
2740
  "target-metadata-dir": {
2270
- "name": "target-metadata-dir",
2271
- "type": "option",
2272
2741
  "char": "t",
2273
- "summary": "Directory that will contain the retrieved metadata format files or ZIP.",
2742
+ "exclusive": [
2743
+ "ignore-conflicts"
2744
+ ],
2274
2745
  "helpGroup": "Metadata API Format",
2275
- "multiple": false,
2746
+ "name": "target-metadata-dir",
2276
2747
  "relationships": [
2277
2748
  {
2278
2749
  "type": "some",
@@ -2284,65 +2755,74 @@
2284
2755
  ]
2285
2756
  }
2286
2757
  ],
2287
- "exclusive": [
2288
- "ignore-conflicts"
2289
- ],
2290
- "deprecateAliases": true
2758
+ "summary": "Directory that will contain the retrieved metadata format files or ZIP.",
2759
+ "hasDynamicHelp": false,
2760
+ "multiple": false,
2761
+ "type": "option"
2291
2762
  },
2292
2763
  "target-org": {
2293
- "name": "target-org",
2294
- "type": "option",
2295
2764
  "char": "o",
2296
- "summary": "Login username or alias for the target org.",
2297
2765
  "description": "Overrides your default org.",
2766
+ "name": "target-org",
2767
+ "noCacheDefault": true,
2298
2768
  "required": true,
2769
+ "summary": "Login username or alias for the target org.",
2770
+ "hasDynamicHelp": true,
2299
2771
  "multiple": false,
2300
- "deprecateAliases": true
2772
+ "type": "option"
2301
2773
  },
2302
2774
  "wait": {
2303
- "name": "wait",
2304
- "type": "option",
2305
2775
  "char": "w",
2306
- "summary": "Number of minutes to wait for the command to complete and display results to the terminal window.",
2307
2776
  "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you.",
2308
- "multiple": false,
2777
+ "name": "wait",
2778
+ "summary": "Number of minutes to wait for the command to complete and display results to the terminal window.",
2309
2779
  "default": {
2310
2780
  "quantity": 33,
2311
2781
  "unit": 0
2312
2782
  },
2313
- "deprecateAliases": true
2783
+ "hasDynamicHelp": false,
2784
+ "multiple": false,
2785
+ "type": "option"
2314
2786
  },
2315
2787
  "unzip": {
2316
- "name": "unzip",
2317
- "type": "boolean",
2318
2788
  "char": "z",
2319
- "summary": "Extract all files from the retrieved zip file.",
2320
- "helpGroup": "Metadata API Format",
2321
- "allowNo": false,
2322
2789
  "dependsOn": [
2323
2790
  "target-metadata-dir"
2324
2791
  ],
2325
2792
  "exclusive": [
2326
2793
  "ignore-conflicts"
2327
2794
  ],
2328
- "deprecateAliases": true
2795
+ "helpGroup": "Metadata API Format",
2796
+ "name": "unzip",
2797
+ "summary": "Extract all files from the retrieved zip file.",
2798
+ "allowNo": false,
2799
+ "type": "boolean"
2329
2800
  },
2330
2801
  "zip-file-name": {
2331
- "name": "zip-file-name",
2332
- "type": "option",
2333
- "summary": "File name to use for the retrieved zip file.",
2334
- "helpGroup": "Metadata API Format",
2335
- "multiple": false,
2336
2802
  "dependsOn": [
2337
2803
  "target-metadata-dir"
2338
2804
  ],
2339
2805
  "exclusive": [
2340
2806
  "ignore-conflicts"
2341
2807
  ],
2342
- "deprecateAliases": true
2808
+ "helpGroup": "Metadata API Format",
2809
+ "name": "zip-file-name",
2810
+ "summary": "File name to use for the retrieved zip file.",
2811
+ "hasDynamicHelp": false,
2812
+ "multiple": false,
2813
+ "type": "option"
2343
2814
  }
2344
2815
  },
2345
- "args": {},
2816
+ "hasDynamicHelp": true,
2817
+ "hiddenAliases": [],
2818
+ "id": "project:retrieve:start",
2819
+ "pluginAlias": "@salesforce/plugin-deploy-retrieve",
2820
+ "pluginName": "@salesforce/plugin-deploy-retrieve",
2821
+ "pluginType": "core",
2822
+ "strict": true,
2823
+ "summary": "Retrieve metadata from an org to your local project.",
2824
+ "enableJsonFlag": true,
2825
+ "SF_ENV": "SF_ENV",
2346
2826
  "configurationVariablesSection": {
2347
2827
  "header": "CONFIGURATION VARIABLES",
2348
2828
  "body": [
@@ -2369,7 +2849,27 @@
2369
2849
  }
2370
2850
  ]
2371
2851
  },
2372
- "hasDynamicHelp": true
2852
+ "isESM": true,
2853
+ "relativePath": [
2854
+ "lib",
2855
+ "commands",
2856
+ "project",
2857
+ "retrieve",
2858
+ "start.js"
2859
+ ],
2860
+ "aliasPermutations": [
2861
+ "retrieve:metadata",
2862
+ "metadata:retrieve"
2863
+ ],
2864
+ "permutations": [
2865
+ "project:retrieve:start",
2866
+ "retrieve:project:start",
2867
+ "retrieve:start:project",
2868
+ "project:start:retrieve",
2869
+ "start:project:retrieve",
2870
+ "start:retrieve:project"
2871
+ ]
2373
2872
  }
2374
- }
2873
+ },
2874
+ "version": "2.0.1"
2375
2875
  }