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