@salesforce/plugin-org 2.11.7 → 3.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (89) hide show
  1. package/README.md +114 -114
  2. package/lib/commands/force/org/clone.d.ts +8 -8
  3. package/lib/commands/force/org/clone.js +65 -66
  4. package/lib/commands/force/org/clone.js.map +1 -1
  5. package/lib/commands/force/org/create.d.ts +18 -42
  6. package/lib/commands/force/org/create.js +104 -106
  7. package/lib/commands/force/org/create.js.map +1 -1
  8. package/lib/commands/force/org/delete.d.ts +5 -5
  9. package/lib/commands/force/org/delete.js +42 -44
  10. package/lib/commands/force/org/delete.js.map +1 -1
  11. package/lib/commands/force/org/status.d.ts +7 -7
  12. package/lib/commands/force/org/status.js +48 -50
  13. package/lib/commands/force/org/status.js.map +1 -1
  14. package/lib/commands/org/create/sandbox.d.ts +11 -11
  15. package/lib/commands/org/create/sandbox.js +106 -106
  16. package/lib/commands/org/create/sandbox.js.map +1 -1
  17. package/lib/commands/org/create/scratch.d.ts +20 -20
  18. package/lib/commands/org/create/scratch.js +140 -142
  19. package/lib/commands/org/create/scratch.js.map +1 -1
  20. package/lib/commands/org/delete/sandbox.d.ts +2 -2
  21. package/lib/commands/org/delete/sandbox.js +27 -28
  22. package/lib/commands/org/delete/sandbox.js.map +1 -1
  23. package/lib/commands/org/delete/scratch.d.ts +2 -2
  24. package/lib/commands/org/delete/scratch.js +26 -27
  25. package/lib/commands/org/delete/scratch.js.map +1 -1
  26. package/lib/commands/org/display.d.ts +5 -5
  27. package/lib/commands/org/display.js +33 -34
  28. package/lib/commands/org/display.js.map +1 -1
  29. package/lib/commands/org/list/metadata-types.d.ts +5 -5
  30. package/lib/commands/org/list/metadata-types.js +38 -40
  31. package/lib/commands/org/list/metadata-types.js.map +1 -1
  32. package/lib/commands/org/list/metadata.d.ts +6 -6
  33. package/lib/commands/org/list/metadata.js +39 -41
  34. package/lib/commands/org/list/metadata.js.map +1 -1
  35. package/lib/commands/org/list.d.ts +2 -2
  36. package/lib/commands/org/list.js +56 -57
  37. package/lib/commands/org/list.js.map +1 -1
  38. package/lib/commands/org/open.d.ts +7 -7
  39. package/lib/commands/org/open.js +65 -62
  40. package/lib/commands/org/open.js.map +1 -1
  41. package/lib/commands/org/resume/sandbox.d.ts +6 -6
  42. package/lib/commands/org/resume/sandbox.js +61 -61
  43. package/lib/commands/org/resume/sandbox.js.map +1 -1
  44. package/lib/commands/org/resume/scratch.d.ts +3 -3
  45. package/lib/commands/org/resume/scratch.js +35 -36
  46. package/lib/commands/org/resume/scratch.js.map +1 -1
  47. package/lib/index.d.ts +1 -1
  48. package/lib/index.js +1 -2
  49. package/lib/index.js.map +1 -1
  50. package/lib/shared/flags.d.ts +4 -1
  51. package/lib/shared/flags.js +10 -11
  52. package/lib/shared/flags.js.map +1 -1
  53. package/lib/shared/orgHighlighter.d.ts +1 -1
  54. package/lib/shared/orgHighlighter.js +4 -9
  55. package/lib/shared/orgHighlighter.js.map +1 -1
  56. package/lib/shared/orgHooks.js +1 -2
  57. package/lib/shared/orgHooks.js.map +1 -1
  58. package/lib/shared/orgListUtil.d.ts +1 -1
  59. package/lib/shared/orgListUtil.js +27 -31
  60. package/lib/shared/orgListUtil.js.map +1 -1
  61. package/lib/shared/orgTypes.js +2 -5
  62. package/lib/shared/orgTypes.js.map +1 -1
  63. package/lib/shared/sandboxCommandBase.d.ts +2 -2
  64. package/lib/shared/sandboxCommandBase.js +33 -28
  65. package/lib/shared/sandboxCommandBase.js.map +1 -1
  66. package/lib/shared/sandboxProgress.d.ts +1 -1
  67. package/lib/shared/sandboxProgress.js +11 -17
  68. package/lib/shared/sandboxProgress.js.map +1 -1
  69. package/lib/shared/sandboxReporter.js +5 -9
  70. package/lib/shared/sandboxReporter.js.map +1 -1
  71. package/lib/shared/sandboxRequest.d.ts +5 -0
  72. package/lib/shared/sandboxRequest.js +21 -20
  73. package/lib/shared/sandboxRequest.js.map +1 -1
  74. package/lib/shared/scratchOrgOutput.js +20 -31
  75. package/lib/shared/scratchOrgOutput.js.map +1 -1
  76. package/lib/shared/scratchOrgRequest.d.ts +1 -1
  77. package/lib/shared/scratchOrgRequest.js +4 -8
  78. package/lib/shared/scratchOrgRequest.js.map +1 -1
  79. package/lib/shared/stagedProgress.d.ts +1 -1
  80. package/lib/shared/stagedProgress.js +19 -19
  81. package/lib/shared/stagedProgress.js.map +1 -1
  82. package/lib/shared/timeUtils.js +10 -16
  83. package/lib/shared/timeUtils.js.map +1 -1
  84. package/lib/shared/utils.d.ts +9 -2
  85. package/lib/shared/utils.js +13 -14
  86. package/lib/shared/utils.js.map +1 -1
  87. package/oclif.lock +7993 -0
  88. package/oclif.manifest.json +1089 -687
  89. package/package.json +34 -53
@@ -1,170 +1,207 @@
1
1
  {
2
- "version": "2.11.7",
3
2
  "commands": {
4
3
  "org:display": {
5
- "id": "org:display",
6
- "summary": "Display information about an org.",
7
- "description": "Output includes your access token, client Id, connected status, org ID, instance URL, username, and alias, if applicable.\n\nUse --verbose to include the SFDX auth URL. WARNING: The SFDX auth URL contains sensitive information, such as a refresh token that can be used to access an org. Don't share or distribute this URL or token.\n\nIncluding --verbose displays the sfdxAuthUrl property only if you authenticated to the org using \"org login web\" (not \"org login jwt\").",
8
- "strict": true,
9
- "pluginName": "@salesforce/plugin-org",
10
- "pluginAlias": "@salesforce/plugin-org",
11
- "pluginType": "core",
12
4
  "aliases": [
13
5
  "force:org:display"
14
6
  ],
7
+ "args": {},
8
+ "deprecateAliases": true,
9
+ "description": "Output includes your access token, client Id, connected status, org ID, instance URL, username, and alias, if applicable.\n\nUse --verbose to include the SFDX auth URL. WARNING: The SFDX auth URL contains sensitive information, such as a refresh token that can be used to access an org. Don't share or distribute this URL or token.\n\nIncluding --verbose displays the sfdxAuthUrl property only if you authenticated to the org using \"org login web\" (not \"org login jwt\").",
15
10
  "examples": [
16
11
  "Display information about your default org:\n$ <%= config.bin %> <%= command.id %>",
17
12
  "Display information, including the sfdxAuthUrl property, about the org with alias TestOrg1:\n$ <%= config.bin %> <%= command.id %> --target-org TestOrg1 --verbose"
18
13
  ],
19
- "deprecateAliases": true,
20
14
  "flags": {
21
15
  "json": {
22
- "name": "json",
23
- "type": "boolean",
24
16
  "description": "Format output as json.",
25
17
  "helpGroup": "GLOBAL",
18
+ "name": "json",
26
19
  "allowNo": false,
27
- "deprecateAliases": true
20
+ "type": "boolean"
28
21
  },
29
22
  "target-org": {
30
- "name": "target-org",
31
- "type": "option",
32
- "char": "o",
33
- "summary": "Username or alias of the target org.",
34
- "required": true,
35
- "multiple": false,
36
- "deprecateAliases": true,
37
23
  "aliases": [
38
24
  "targetusername",
39
25
  "u"
40
- ]
26
+ ],
27
+ "char": "o",
28
+ "deprecateAliases": true,
29
+ "name": "target-org",
30
+ "noCacheDefault": true,
31
+ "required": true,
32
+ "summary": "Username or alias of the target org.",
33
+ "hasDynamicHelp": true,
34
+ "multiple": false,
35
+ "type": "option"
41
36
  },
42
37
  "api-version": {
43
- "name": "api-version",
44
- "type": "option",
45
- "description": "Override the api version used for api requests made by this command",
46
- "multiple": false,
47
- "deprecateAliases": true,
48
38
  "aliases": [
49
39
  "apiversion"
50
- ]
40
+ ],
41
+ "deprecateAliases": true,
42
+ "description": "Override the api version used for api requests made by this command",
43
+ "name": "api-version",
44
+ "hasDynamicHelp": false,
45
+ "multiple": false,
46
+ "type": "option"
51
47
  },
52
48
  "verbose": {
53
49
  "name": "verbose",
54
- "type": "boolean",
55
50
  "summary": "Display the sfdxAuthUrl property.",
56
51
  "allowNo": false,
57
- "deprecateAliases": true
52
+ "type": "boolean"
58
53
  },
59
54
  "loglevel": {
60
- "name": "loglevel",
61
- "type": "option",
62
- "hidden": true,
63
- "multiple": false,
64
55
  "deprecated": {
65
56
  "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."
66
57
  },
67
- "deprecateAliases": true
58
+ "hidden": true,
59
+ "name": "loglevel",
60
+ "hasDynamicHelp": false,
61
+ "multiple": false,
62
+ "type": "option"
68
63
  }
69
64
  },
70
- "args": {},
71
- "hasDynamicHelp": true
72
- },
73
- "org:list": {
74
- "id": "org:list",
75
- "summary": "List all orgs you’ve created or authenticated to.",
76
- "strict": true,
77
- "pluginName": "@salesforce/plugin-org",
65
+ "hasDynamicHelp": true,
66
+ "hiddenAliases": [],
67
+ "id": "org:display",
78
68
  "pluginAlias": "@salesforce/plugin-org",
69
+ "pluginName": "@salesforce/plugin-org",
79
70
  "pluginType": "core",
71
+ "strict": true,
72
+ "summary": "Display information about an org.",
73
+ "enableJsonFlag": true,
74
+ "SF_ENV": "SF_ENV",
75
+ "isESM": true,
76
+ "relativePath": [
77
+ "lib",
78
+ "commands",
79
+ "org",
80
+ "display.js"
81
+ ],
82
+ "aliasPermutations": [
83
+ "force:org:display",
84
+ "org:force:display",
85
+ "org:display:force",
86
+ "force:display:org",
87
+ "display:force:org",
88
+ "display:org:force"
89
+ ],
90
+ "permutations": [
91
+ "org:display",
92
+ "display:org"
93
+ ]
94
+ },
95
+ "org:list": {
80
96
  "aliases": [
81
97
  "force:org:list"
82
98
  ],
99
+ "args": {},
100
+ "deprecateAliases": true,
83
101
  "examples": [
84
102
  "List all orgs you've created or authenticated to:\n$ <%= config.bin %> <%= command.id %>",
85
103
  "List all orgs, including expired, deleted, and unknown-status orgs; don't include the connection status:\n$ <%= config.bin %> <%= command.id %> --skip-connection-status --all",
86
104
  "List orgs and remove local org authorization info about non-active scratch orgs:\n$ <%= config.bin %> <%= command.id %> --clean"
87
105
  ],
88
- "deprecateAliases": true,
89
106
  "flags": {
90
107
  "json": {
91
- "name": "json",
92
- "type": "boolean",
93
108
  "description": "Format output as json.",
94
109
  "helpGroup": "GLOBAL",
110
+ "name": "json",
95
111
  "allowNo": false,
96
- "deprecateAliases": true
112
+ "type": "boolean"
97
113
  },
98
114
  "verbose": {
99
115
  "name": "verbose",
100
- "type": "boolean",
101
116
  "summary": "List more information about each org.",
102
117
  "allowNo": false,
103
- "deprecateAliases": true
118
+ "type": "boolean"
104
119
  },
105
120
  "all": {
106
121
  "name": "all",
107
- "type": "boolean",
108
122
  "summary": "Include expired, deleted, and unknown-status scratch orgs.",
109
123
  "allowNo": false,
110
- "deprecateAliases": true
124
+ "type": "boolean"
111
125
  },
112
126
  "clean": {
113
127
  "name": "clean",
114
- "type": "boolean",
115
128
  "summary": "Remove all local org authorizations for non-active scratch orgs. Use \"org logout\" to remove non-scratch orgs.",
116
129
  "allowNo": false,
117
- "deprecateAliases": true
130
+ "type": "boolean"
118
131
  },
119
132
  "no-prompt": {
120
- "name": "no-prompt",
121
- "type": "boolean",
133
+ "aliases": [
134
+ "noprompt"
135
+ ],
122
136
  "char": "p",
123
- "summary": "Don't prompt for confirmation.",
124
- "allowNo": false,
125
137
  "dependsOn": [
126
138
  "clean"
127
139
  ],
128
140
  "deprecateAliases": true,
129
- "aliases": [
130
- "noprompt"
131
- ]
141
+ "name": "no-prompt",
142
+ "summary": "Don't prompt for confirmation.",
143
+ "allowNo": false,
144
+ "type": "boolean"
132
145
  },
133
146
  "skip-connection-status": {
147
+ "aliases": [
148
+ "skipconnectionstatus"
149
+ ],
150
+ "deprecateAliases": true,
134
151
  "name": "skip-connection-status",
135
- "type": "boolean",
136
152
  "summary": "Skip retrieving the connection status of non-scratch orgs.",
137
153
  "allowNo": false,
138
- "deprecateAliases": true,
139
- "aliases": [
140
- "skipconnectionstatus"
141
- ]
154
+ "type": "boolean"
142
155
  },
143
156
  "loglevel": {
144
- "name": "loglevel",
145
- "type": "option",
146
- "hidden": true,
147
- "multiple": false,
148
157
  "deprecated": {
149
158
  "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."
150
159
  },
151
- "deprecateAliases": true
160
+ "hidden": true,
161
+ "name": "loglevel",
162
+ "hasDynamicHelp": false,
163
+ "multiple": false,
164
+ "type": "option"
152
165
  }
153
166
  },
154
- "args": {}
155
- },
156
- "org:open": {
157
- "id": "org:open",
158
- "summary": "Open your default scratch org, or another specified org, in a browser.",
159
- "description": "To open a specific page, specify the portion of the URL after \"https://MyDomainName.my.salesforce.com/\" as the value for the --path flag. For example, specify \"--path lightning\" to open Lightning Experience, or specify \"--path /apex/YourPage\" to open a Visualforce page.\n\nUse the --source-file to open a Lightning Page from your local project in Lightning App Builder. Lightning page files have the suffix .flexipage-meta.xml, and are stored in the \"flexipages\" directory.\n\nTo generate a URL but not launch it in your browser, specify --url-only.\n\nTo open in a specific browser, use the --browser flag. Supported browsers are \"chrome\", \"edge\", and \"firefox\". If you don't specify --browser, the org opens in your default browser.",
160
- "strict": true,
161
- "pluginName": "@salesforce/plugin-org",
167
+ "hasDynamicHelp": false,
168
+ "hiddenAliases": [],
169
+ "id": "org:list",
162
170
  "pluginAlias": "@salesforce/plugin-org",
171
+ "pluginName": "@salesforce/plugin-org",
163
172
  "pluginType": "core",
173
+ "strict": true,
174
+ "summary": "List all orgs you’ve created or authenticated to.",
175
+ "enableJsonFlag": true,
176
+ "SF_ENV": "SF_ENV",
177
+ "isESM": true,
178
+ "relativePath": [
179
+ "lib",
180
+ "commands",
181
+ "org",
182
+ "list.js"
183
+ ],
184
+ "aliasPermutations": [
185
+ "force:org:list",
186
+ "org:force:list",
187
+ "org:list:force",
188
+ "force:list:org",
189
+ "list:force:org",
190
+ "list:org:force"
191
+ ],
192
+ "permutations": [
193
+ "org:list",
194
+ "list:org"
195
+ ]
196
+ },
197
+ "org:open": {
164
198
  "aliases": [
165
199
  "force:org:open",
166
200
  "force:source:open"
167
201
  ],
202
+ "args": {},
203
+ "deprecateAliases": true,
204
+ "description": "To open a specific page, specify the portion of the URL after \"https://MyDomainName.my.salesforce.com/\" as the value for the --path flag. For example, specify \"--path lightning\" to open Lightning Experience, or specify \"--path /apex/YourPage\" to open a Visualforce page.\n\nUse the --source-file to open a Lightning Page from your local project in Lightning App Builder. Lightning page files have the suffix .flexipage-meta.xml, and are stored in the \"flexipages\" directory.\n\nTo generate a URL but not launch it in your browser, specify --url-only.\n\nTo open in a specific browser, use the --browser flag. Supported browsers are \"chrome\", \"edge\", and \"firefox\". If you don't specify --browser, the org opens in your default browser.",
168
205
  "examples": [
169
206
  "Open your default org in your default browser:\n$ <%= config.bin %> <%= command.id %>",
170
207
  "Open the org with alias MyTestOrg1 in the Firefox browser:\n$ <%= config.bin %> <%= command.id %> --target-org MyTestOrg1 --browser firefox",
@@ -172,665 +209,819 @@
172
209
  "Open a local Lightning page in your default org's Lightning App Builder:\n$ <%= config.bin %> <%= command.id %> --source-file force-app/main/default/flexipages/Hello.flexipage-meta.xml",
173
210
  "Open a local Flow in Flow Builder:\n$ <%= config.bin %> <%= command.id %> --source-file force-app/main/default/flows/Hello.flow-meta.xml"
174
211
  ],
175
- "deprecateAliases": true,
176
212
  "flags": {
177
213
  "json": {
178
- "name": "json",
179
- "type": "boolean",
180
214
  "description": "Format output as json.",
181
215
  "helpGroup": "GLOBAL",
216
+ "name": "json",
182
217
  "allowNo": false,
183
- "deprecateAliases": true
218
+ "type": "boolean"
184
219
  },
185
220
  "target-org": {
186
- "name": "target-org",
187
- "type": "option",
188
- "char": "o",
189
- "summary": "Username or alias of the target org.",
190
- "required": true,
191
- "multiple": false,
192
- "deprecateAliases": true,
193
221
  "aliases": [
194
222
  "targetusername",
195
223
  "u"
196
- ]
224
+ ],
225
+ "char": "o",
226
+ "deprecateAliases": true,
227
+ "name": "target-org",
228
+ "noCacheDefault": true,
229
+ "required": true,
230
+ "summary": "Username or alias of the target org.",
231
+ "hasDynamicHelp": true,
232
+ "multiple": false,
233
+ "type": "option"
197
234
  },
198
235
  "api-version": {
199
- "name": "api-version",
200
- "type": "option",
201
- "description": "Override the api version used for api requests made by this command",
202
- "multiple": false,
203
- "deprecateAliases": true,
204
236
  "aliases": [
205
237
  "apiversion"
206
- ]
238
+ ],
239
+ "deprecateAliases": true,
240
+ "description": "Override the api version used for api requests made by this command",
241
+ "name": "api-version",
242
+ "hasDynamicHelp": false,
243
+ "multiple": false,
244
+ "type": "option"
207
245
  },
208
246
  "browser": {
209
- "name": "browser",
210
- "type": "option",
211
247
  "char": "b",
248
+ "exclusive": [
249
+ "url-only"
250
+ ],
251
+ "name": "browser",
212
252
  "summary": "Browser where the org opens.",
253
+ "hasDynamicHelp": false,
213
254
  "multiple": false,
214
255
  "options": [
215
256
  "chrome",
216
257
  "edge",
217
258
  "firefox"
218
259
  ],
219
- "exclusive": [
220
- "url-only"
221
- ],
222
- "deprecateAliases": true
260
+ "type": "option"
223
261
  },
224
262
  "path": {
225
- "name": "path",
226
- "type": "option",
227
263
  "char": "p",
228
- "summary": "Navigation URL path to open a specific page.",
229
- "multiple": false,
264
+ "env": "FORCE_OPEN_URL",
230
265
  "exclusive": [
231
266
  "source-file"
232
267
  ],
233
- "deprecateAliases": true
268
+ "name": "path",
269
+ "summary": "Navigation URL path to open a specific page.",
270
+ "hasDynamicHelp": false,
271
+ "multiple": false,
272
+ "type": "option"
234
273
  },
235
274
  "url-only": {
236
- "name": "url-only",
237
- "type": "boolean",
275
+ "aliases": [
276
+ "urlonly"
277
+ ],
238
278
  "char": "r",
279
+ "deprecateAliases": true,
280
+ "name": "url-only",
239
281
  "summary": "Display navigation URL, but don’t launch browser.",
240
282
  "allowNo": false,
241
- "deprecateAliases": true,
242
- "aliases": [
243
- "urlonly"
244
- ]
283
+ "type": "boolean"
245
284
  },
246
285
  "loglevel": {
247
- "name": "loglevel",
248
- "type": "option",
249
- "hidden": true,
250
- "multiple": false,
251
286
  "deprecated": {
252
287
  "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."
253
288
  },
254
- "deprecateAliases": true
289
+ "hidden": true,
290
+ "name": "loglevel",
291
+ "hasDynamicHelp": false,
292
+ "multiple": false,
293
+ "type": "option"
255
294
  },
256
295
  "source-file": {
257
- "name": "source-file",
258
- "type": "option",
296
+ "aliases": [
297
+ "sourcefile"
298
+ ],
259
299
  "char": "f",
260
- "summary": "Path to an ApexPage or FlexiPage to open in Lightning App Builder.",
261
- "multiple": false,
300
+ "deprecateAliases": true,
262
301
  "exclusive": [
263
302
  "path"
264
303
  ],
265
- "deprecateAliases": true,
266
- "aliases": [
267
- "sourcefile"
268
- ]
304
+ "name": "source-file",
305
+ "summary": "Path to an ApexPage or FlexiPage to open in Lightning App Builder.",
306
+ "hasDynamicHelp": false,
307
+ "multiple": false,
308
+ "type": "option"
269
309
  }
270
310
  },
271
- "args": {},
272
- "hasDynamicHelp": true
273
- },
274
- "force:org:clone": {
275
- "id": "force:org:clone",
276
- "summary": "Clone a sandbox org.",
277
- "description": "There are two ways to clone a sandbox: either specify a sandbox definition file or provide key=value pairs at the command line. Key-value pairs at the command-line override their equivalent sandbox definition file values. In either case, you must specify both the \"SandboxName\" and \"SourceSandboxName\" options to set the names of the new sandbox and the one being cloned, respectively.\n\nSet the --targetusername (-u) parameter to a production org with sandbox licenses. The --type (-t) parameter is required and must be set to \"sandbox\".",
278
- "strict": false,
279
- "pluginName": "@salesforce/plugin-org",
311
+ "hasDynamicHelp": true,
312
+ "hiddenAliases": [],
313
+ "id": "org:open",
280
314
  "pluginAlias": "@salesforce/plugin-org",
315
+ "pluginName": "@salesforce/plugin-org",
281
316
  "pluginType": "core",
282
- "state": "deprecated",
283
- "aliases": [],
284
- "examples": [
285
- "$ <%= config.bin %> <%= command.id %> -t sandbox -f config/dev-sandbox-def.json -u prodOrg -a MyDevSandbox",
286
- "$ <%= config.bin %> <%= command.id %> -t sandbox SandboxName=NewClonedSandbox SourceSandboxName=ExistingSandbox -u prodOrg -a MyDevSandbox"
317
+ "strict": true,
318
+ "summary": "Open your default scratch org, or another specified org, in a browser.",
319
+ "enableJsonFlag": true,
320
+ "SF_ENV": "SF_ENV",
321
+ "isESM": true,
322
+ "relativePath": [
323
+ "lib",
324
+ "commands",
325
+ "org",
326
+ "open.js"
327
+ ],
328
+ "aliasPermutations": [
329
+ "force:org:open",
330
+ "org:force:open",
331
+ "org:open:force",
332
+ "force:open:org",
333
+ "open:force:org",
334
+ "open:org:force",
335
+ "force:source:open",
336
+ "source:force:open",
337
+ "source:open:force",
338
+ "force:open:source",
339
+ "open:force:source",
340
+ "open:source:force"
287
341
  ],
342
+ "permutations": [
343
+ "org:open",
344
+ "open:org"
345
+ ]
346
+ },
347
+ "force:org:clone": {
348
+ "aliases": [],
349
+ "args": {},
288
350
  "deprecationOptions": {
289
351
  "to": "org:create:sandbox",
290
352
  "version": "60.0"
291
353
  },
354
+ "description": "There are two ways to clone a sandbox: either specify a sandbox definition file or provide key=value pairs at the command line. Key-value pairs at the command-line override their equivalent sandbox definition file values. In either case, you must specify both the \"SandboxName\" and \"SourceSandboxName\" options to set the names of the new sandbox and the one being cloned, respectively.\n\nSet the --targetusername (-u) parameter to a production org with sandbox licenses. The --type (-t) parameter is required and must be set to \"sandbox\".",
355
+ "examples": [
356
+ "$ <%= config.bin %> <%= command.id %> -t sandbox -f config/dev-sandbox-def.json -u prodOrg -a MyDevSandbox",
357
+ "$ <%= config.bin %> <%= command.id %> -t sandbox SandboxName=NewClonedSandbox SourceSandboxName=ExistingSandbox -u prodOrg -a MyDevSandbox"
358
+ ],
292
359
  "flags": {
293
360
  "json": {
294
- "name": "json",
295
- "type": "boolean",
296
361
  "description": "Format output as json.",
297
362
  "helpGroup": "GLOBAL",
298
- "allowNo": false
363
+ "name": "json",
364
+ "allowNo": false,
365
+ "type": "boolean"
299
366
  },
300
367
  "target-org": {
301
- "name": "target-org",
302
- "type": "option",
303
- "char": "o",
304
- "summary": "Username or alias of the target org.",
305
- "required": true,
306
- "multiple": false,
307
368
  "aliases": [
308
369
  "targetusername",
309
370
  "u"
310
- ]
371
+ ],
372
+ "char": "o",
373
+ "deprecateAliases": true,
374
+ "name": "target-org",
375
+ "noCacheDefault": true,
376
+ "required": true,
377
+ "summary": "Username or alias of the target org.",
378
+ "hasDynamicHelp": true,
379
+ "multiple": false,
380
+ "type": "option"
311
381
  },
312
382
  "api-version": {
313
- "name": "api-version",
314
- "type": "option",
315
- "description": "Override the api version used for api requests made by this command",
316
- "multiple": false,
317
383
  "aliases": [
318
384
  "apiversion"
319
- ]
385
+ ],
386
+ "deprecateAliases": true,
387
+ "description": "Override the api version used for api requests made by this command",
388
+ "name": "api-version",
389
+ "hasDynamicHelp": false,
390
+ "multiple": false,
391
+ "type": "option"
320
392
  },
321
393
  "type": {
322
- "name": "type",
323
- "type": "option",
324
394
  "char": "t",
325
- "summary": "Type of org to create.",
395
+ "name": "type",
326
396
  "required": true,
397
+ "summary": "Type of org to create.",
398
+ "hasDynamicHelp": false,
327
399
  "multiple": false,
328
400
  "options": [
329
401
  "sandbox"
330
- ]
402
+ ],
403
+ "type": "option"
331
404
  },
332
405
  "definitionfile": {
333
- "name": "definitionfile",
334
- "type": "option",
335
406
  "char": "f",
407
+ "name": "definitionfile",
336
408
  "summary": "Path to the sandbox definition file.",
337
- "multiple": false
409
+ "hasDynamicHelp": false,
410
+ "multiple": false,
411
+ "type": "option"
338
412
  },
339
413
  "setdefaultusername": {
340
- "name": "setdefaultusername",
341
- "type": "boolean",
342
414
  "char": "s",
415
+ "name": "setdefaultusername",
343
416
  "summary": "Set the cloned org as your default.",
344
- "allowNo": false
417
+ "allowNo": false,
418
+ "type": "boolean"
345
419
  },
346
420
  "setalias": {
347
- "name": "setalias",
348
- "type": "option",
349
421
  "char": "a",
422
+ "name": "setalias",
350
423
  "summary": "Alias for the cloned org.",
351
- "multiple": false
424
+ "hasDynamicHelp": false,
425
+ "multiple": false,
426
+ "type": "option"
352
427
  },
353
428
  "wait": {
354
- "name": "wait",
355
- "type": "option",
356
429
  "char": "w",
357
- "summary": "Number of minutes to wait while polling for status.",
358
430
  "description": "Sets the streaming client socket timeout, in minutes. If the streaming client socket has no contact from the server for a number of minutes, the client exits. Specify a longer wait time if timeouts occur frequently.",
359
- "multiple": false,
431
+ "name": "wait",
432
+ "summary": "Number of minutes to wait while polling for status.",
360
433
  "default": {
361
434
  "quantity": 6,
362
435
  "unit": 0
363
- }
436
+ },
437
+ "hasDynamicHelp": false,
438
+ "multiple": false,
439
+ "type": "option"
364
440
  },
365
441
  "loglevel": {
366
- "name": "loglevel",
367
- "type": "option",
368
- "hidden": true,
369
- "multiple": false,
370
442
  "deprecated": {
371
443
  "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."
372
- }
444
+ },
445
+ "hidden": true,
446
+ "name": "loglevel",
447
+ "hasDynamicHelp": false,
448
+ "multiple": false,
449
+ "type": "option"
373
450
  }
374
451
  },
375
- "args": {},
376
- "SANDBOXDEF_SRC_SANDBOXNAME": "SourceSandboxName",
377
- "hasDynamicHelp": true
378
- },
379
- "force:org:create": {
380
- "id": "force:org:create",
381
- "summary": "Create a scratch org or sandbox.",
382
- "description": "Creates a scratch org or a sandbox org using the values specified in a configuration file or key=value pairs that you specify on the command line. Values specified on the command line override values in the configuration file. Specify a configuration file or provide key=value pairs while creating a scratch org or a sandbox. When creating scratch orgs, —targetdevhubusername (-v) must be a Dev Hub org. When creating sandboxes, the --targetusername (-u) must be a production org with sandbox licenses. The —type (-t) is required if creating a sandbox.",
383
- "strict": false,
384
- "pluginName": "@salesforce/plugin-org",
452
+ "hasDynamicHelp": true,
453
+ "hiddenAliases": [],
454
+ "id": "force:org:clone",
385
455
  "pluginAlias": "@salesforce/plugin-org",
456
+ "pluginName": "@salesforce/plugin-org",
386
457
  "pluginType": "core",
387
458
  "state": "deprecated",
459
+ "strict": false,
460
+ "summary": "Clone a sandbox org.",
461
+ "enableJsonFlag": true,
462
+ "SF_ENV": "SF_ENV",
463
+ "SANDBOXDEF_SRC_SANDBOXNAME": "SourceSandboxName",
464
+ "isESM": true,
465
+ "relativePath": [
466
+ "lib",
467
+ "commands",
468
+ "force",
469
+ "org",
470
+ "clone.js"
471
+ ],
472
+ "aliasPermutations": [],
473
+ "permutations": [
474
+ "force:org:clone",
475
+ "org:force:clone",
476
+ "org:clone:force",
477
+ "force:clone:org",
478
+ "clone:force:org",
479
+ "clone:org:force"
480
+ ]
481
+ },
482
+ "force:org:create": {
388
483
  "aliases": [],
484
+ "args": {},
485
+ "deprecationOptions": {
486
+ "message": "The force:org:create command is deprecated. Try \"org create scratch\" or \"org create sandbox\" instead."
487
+ },
488
+ "description": "Creates a scratch org or a sandbox org using the values specified in a configuration file or key=value pairs that you specify on the command line. Values specified on the command line override values in the configuration file. Specify a configuration file or provide key=value pairs while creating a scratch org or a sandbox. When creating scratch orgs, —targetdevhubusername (-v) must be a Dev Hub org. When creating sandboxes, the --targetusername (-u) must be a production org with sandbox licenses. The —type (-t) is required if creating a sandbox.",
389
489
  "examples": [
390
490
  "$ <%= config.bin %> <%= command.id %> -f config/enterprise-scratch-def.json -a MyScratchOrg",
391
491
  "$ <%= config.bin %> <%= command.id %> edition=Developer -a MyScratchOrg -s -v devHub",
392
492
  "$ <%= config.bin %> <%= command.id %> -f config/enterprise-scratch-def.json -a ScratchOrgWithOverrides username=testuser1@mycompany.org",
393
493
  "$ <%= config.bin %> <%= command.id %> -t sandbox -f config/dev-sandbox-def.json -a MyDevSandbox -u prodOrg"
394
494
  ],
395
- "deprecationOptions": {
396
- "message": "The force:org:create command is deprecated. Try \"org create scratch\" or \"org create sandbox\" instead."
397
- },
398
495
  "flags": {
399
496
  "json": {
400
- "name": "json",
401
- "type": "boolean",
402
497
  "description": "Format output as json.",
403
498
  "helpGroup": "GLOBAL",
404
- "allowNo": false
499
+ "name": "json",
500
+ "allowNo": false,
501
+ "type": "boolean"
405
502
  },
406
503
  "target-org": {
407
- "name": "target-org",
408
- "type": "option",
409
- "char": "o",
410
- "summary": "Username or alias of the production org that contains the sandbox license.",
411
- "multiple": false,
412
504
  "aliases": [
413
505
  "targetusername",
414
506
  "u"
415
- ]
507
+ ],
508
+ "char": "o",
509
+ "deprecateAliases": true,
510
+ "name": "target-org",
511
+ "noCacheDefault": true,
512
+ "summary": "Username or alias of the production org that contains the sandbox license.",
513
+ "hasDynamicHelp": true,
514
+ "multiple": false,
515
+ "type": "option"
416
516
  },
417
517
  "target-dev-hub": {
418
- "name": "target-dev-hub",
419
- "type": "option",
518
+ "aliases": [
519
+ "targetdevhubusername"
520
+ ],
420
521
  "char": "v",
421
- "summary": "Username or alias of the Dev Hub org.",
522
+ "deprecateAliases": true,
523
+ "name": "target-dev-hub",
524
+ "noCacheDefault": true,
422
525
  "required": false,
526
+ "summary": "Username or alias of the Dev Hub org.",
527
+ "hasDynamicHelp": true,
423
528
  "multiple": false,
424
- "aliases": [
425
- "targetdevhubusername"
426
- ]
529
+ "type": "option"
427
530
  },
428
531
  "api-version": {
429
- "name": "api-version",
430
- "type": "option",
431
- "description": "Override the api version used for api requests made by this command",
432
- "multiple": false,
433
532
  "aliases": [
434
533
  "apiversion"
435
- ]
534
+ ],
535
+ "deprecateAliases": true,
536
+ "description": "Override the api version used for api requests made by this command",
537
+ "name": "api-version",
538
+ "hasDynamicHelp": false,
539
+ "multiple": false,
540
+ "type": "option"
436
541
  },
437
542
  "loglevel": {
438
- "name": "loglevel",
439
- "type": "option",
440
- "hidden": true,
441
- "multiple": false,
442
543
  "deprecated": {
443
544
  "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."
444
- }
545
+ },
546
+ "hidden": true,
547
+ "name": "loglevel",
548
+ "hasDynamicHelp": false,
549
+ "multiple": false,
550
+ "type": "option"
445
551
  },
446
552
  "type": {
447
- "name": "type",
448
- "type": "option",
449
553
  "char": "t",
554
+ "name": "type",
450
555
  "summary": "Type of org to create.",
556
+ "default": "scratch",
557
+ "hasDynamicHelp": false,
451
558
  "multiple": false,
452
559
  "options": [
453
560
  "scratch",
454
561
  "sandbox"
455
562
  ],
456
- "default": "scratch"
563
+ "type": "option"
457
564
  },
458
565
  "definitionfile": {
459
- "name": "definitionfile",
460
- "type": "option",
461
566
  "char": "f",
567
+ "name": "definitionfile",
462
568
  "summary": "Path to an org definition file.",
463
- "multiple": false
569
+ "hasDynamicHelp": false,
570
+ "multiple": false,
571
+ "type": "option"
464
572
  },
465
573
  "nonamespace": {
466
- "name": "nonamespace",
467
- "type": "boolean",
468
574
  "char": "n",
575
+ "name": "nonamespace",
469
576
  "summary": "Create the scratch org with no namespace.",
470
- "allowNo": false
577
+ "allowNo": false,
578
+ "type": "boolean"
471
579
  },
472
580
  "noancestors": {
473
- "name": "noancestors",
474
- "type": "boolean",
475
581
  "char": "c",
582
+ "name": "noancestors",
476
583
  "summary": "Do not include second-generation package ancestors in the scratch org.",
477
- "allowNo": false
584
+ "allowNo": false,
585
+ "type": "boolean"
478
586
  },
479
587
  "clientid": {
480
- "name": "clientid",
481
- "type": "option",
482
588
  "char": "i",
589
+ "name": "clientid",
483
590
  "summary": "Connected app consumer key; not supported for sandbox org creation.",
484
- "multiple": false
591
+ "hasDynamicHelp": false,
592
+ "multiple": false,
593
+ "type": "option"
485
594
  },
486
595
  "setdefaultusername": {
487
- "name": "setdefaultusername",
488
- "type": "boolean",
489
596
  "char": "s",
597
+ "name": "setdefaultusername",
490
598
  "summary": "Set the created org as the default username.",
491
- "allowNo": false
599
+ "allowNo": false,
600
+ "type": "boolean"
492
601
  },
493
602
  "setalias": {
494
- "name": "setalias",
495
- "type": "option",
496
603
  "char": "a",
604
+ "name": "setalias",
497
605
  "summary": "Alias for the created org.",
498
- "multiple": false
606
+ "hasDynamicHelp": false,
607
+ "multiple": false,
608
+ "type": "option"
499
609
  },
500
610
  "wait": {
501
- "name": "wait",
502
- "type": "option",
503
611
  "char": "w",
612
+ "name": "wait",
504
613
  "summary": "Streaming client socket timeout (in minutes).",
505
- "multiple": false,
506
614
  "default": {
507
615
  "quantity": 6,
508
616
  "unit": 0
509
- }
617
+ },
618
+ "hasDynamicHelp": false,
619
+ "multiple": false,
620
+ "type": "option"
510
621
  },
511
622
  "durationdays": {
512
- "name": "durationdays",
513
- "type": "option",
514
623
  "char": "d",
624
+ "name": "durationdays",
515
625
  "summary": "Duration of the scratch org (in days) (default:7, min:1, max:30).",
626
+ "default": 7,
627
+ "hasDynamicHelp": false,
516
628
  "multiple": false,
517
- "default": 7
629
+ "type": "option"
518
630
  },
519
631
  "retry": {
632
+ "hidden": true,
520
633
  "name": "retry",
521
- "type": "option",
522
634
  "summary": "Number of scratch org auth retries after scratch org is successfully signed up.",
523
- "hidden": true,
635
+ "default": 0,
636
+ "hasDynamicHelp": false,
524
637
  "multiple": false,
525
- "default": 0
638
+ "type": "option"
526
639
  }
527
640
  },
528
- "args": {},
529
- "hasDynamicHelp": true
530
- },
531
- "force:org:delete": {
532
- "id": "force:org:delete",
533
- "summary": "Delete a scratch or sandbox org.",
534
- "description": "Salesforce CLI marks the org for deletion in either the Dev Hub org (for scratch orgs) or production org (for sandboxes) and then deletes all local references to the org from your computer.\n\nTo mark the org for deletion without being prompted to confirm, specify --noprompt.",
535
- "strict": true,
536
- "pluginName": "@salesforce/plugin-org",
641
+ "hasDynamicHelp": true,
642
+ "hiddenAliases": [],
643
+ "id": "force:org:create",
537
644
  "pluginAlias": "@salesforce/plugin-org",
645
+ "pluginName": "@salesforce/plugin-org",
538
646
  "pluginType": "core",
539
647
  "state": "deprecated",
648
+ "strict": false,
649
+ "summary": "Create a scratch org or sandbox.",
650
+ "enableJsonFlag": true,
651
+ "SF_ENV": "SF_ENV",
652
+ "isESM": true,
653
+ "relativePath": [
654
+ "lib",
655
+ "commands",
656
+ "force",
657
+ "org",
658
+ "create.js"
659
+ ],
660
+ "aliasPermutations": [],
661
+ "permutations": [
662
+ "force:org:create",
663
+ "org:force:create",
664
+ "org:create:force",
665
+ "force:create:org",
666
+ "create:force:org",
667
+ "create:org:force"
668
+ ]
669
+ },
670
+ "force:org:delete": {
540
671
  "aliases": [],
672
+ "args": {},
673
+ "deprecationOptions": {
674
+ "message": "The force:org:delete command is deprecated. Try \"org delete scratch\" or \"org delete sandbox\" instead."
675
+ },
676
+ "description": "Salesforce CLI marks the org for deletion in either the Dev Hub org (for scratch orgs) or production org (for sandboxes) and then deletes all local references to the org from your computer.\n\nTo mark the org for deletion without being prompted to confirm, specify --noprompt.",
541
677
  "examples": [
542
678
  "$ <%= config.bin %> <%= command.id %> -u me@my.org",
543
679
  "$ <%= config.bin %> <%= command.id %> -u MyOrgAlias -p"
544
680
  ],
545
- "deprecationOptions": {
546
- "message": "The force:org:delete command is deprecated. Try \"org delete scratch\" or \"org delete sandbox\" instead."
547
- },
548
681
  "flags": {
549
682
  "json": {
550
- "name": "json",
551
- "type": "boolean",
552
683
  "description": "Format output as json.",
553
684
  "helpGroup": "GLOBAL",
554
- "allowNo": false
685
+ "name": "json",
686
+ "allowNo": false,
687
+ "type": "boolean"
555
688
  },
556
689
  "target-org": {
557
- "name": "target-org",
558
- "type": "option",
559
- "char": "o",
560
- "summary": "Username or alias of the target org.",
561
- "required": true,
562
- "multiple": false,
563
690
  "aliases": [
564
691
  "targetusername",
565
692
  "u"
566
- ]
693
+ ],
694
+ "char": "o",
695
+ "deprecateAliases": true,
696
+ "name": "target-org",
697
+ "required": true,
698
+ "summary": "Username or alias of the target org.",
699
+ "hasDynamicHelp": true,
700
+ "multiple": false,
701
+ "type": "option"
567
702
  },
568
703
  "targetdevhubusername": {
569
- "name": "targetdevhubusername",
570
- "type": "option",
571
704
  "char": "v",
572
- "summary": "The targetdevhubusername flag exists only for backwards compatibility. It is not necessary and has no effect.",
573
- "hidden": true,
574
- "multiple": false,
575
705
  "deprecated": {
576
706
  "version": "58.0",
577
707
  "message": "The targetdevhubusername flag exists only for backwards compatibility. It is not necessary and has no effect."
578
- }
708
+ },
709
+ "hidden": true,
710
+ "name": "targetdevhubusername",
711
+ "summary": "The targetdevhubusername flag exists only for backwards compatibility. It is not necessary and has no effect.",
712
+ "hasDynamicHelp": false,
713
+ "multiple": false,
714
+ "type": "option"
579
715
  },
580
716
  "api-version": {
581
- "name": "api-version",
582
- "type": "option",
583
- "description": "Override the api version used for api requests made by this command",
584
- "multiple": false,
585
717
  "aliases": [
586
718
  "apiversion"
587
- ]
719
+ ],
720
+ "deprecateAliases": true,
721
+ "description": "Override the api version used for api requests made by this command",
722
+ "name": "api-version",
723
+ "hasDynamicHelp": false,
724
+ "multiple": false,
725
+ "type": "option"
588
726
  },
589
727
  "no-prompt": {
590
- "name": "no-prompt",
591
- "type": "boolean",
728
+ "aliases": [
729
+ "noprompt"
730
+ ],
592
731
  "char": "p",
732
+ "deprecateAliases": true,
733
+ "name": "no-prompt",
593
734
  "summary": "No prompt to confirm deletion.",
594
735
  "allowNo": false,
595
- "aliases": [
596
- "noprompt"
597
- ]
736
+ "type": "boolean"
598
737
  },
599
738
  "loglevel": {
600
- "name": "loglevel",
601
- "type": "option",
602
- "hidden": true,
603
- "multiple": false,
604
739
  "deprecated": {
605
740
  "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."
606
- }
741
+ },
742
+ "hidden": true,
743
+ "name": "loglevel",
744
+ "hasDynamicHelp": false,
745
+ "multiple": false,
746
+ "type": "option"
607
747
  }
608
748
  },
609
- "args": {},
610
- "hasDynamicHelp": true
611
- },
612
- "force:org:status": {
613
- "id": "force:org:status",
614
- "summary": "Check the status of a sandbox, and if complete, authenticate to it.",
615
- "description": "Use this command to check the status of your sandbox creation or clone and, if the sandbox is ready, authenticate to it.\n\nUse the --wait (-w) parameter to specify the number of minutes that the command waits for the sandbox creation or clone to complete before returning control of the terminal to you.\n\nSet the --target-org (-o) parameter to the username or alias of the production org that contains the sandbox license.",
616
- "strict": true,
617
- "pluginName": "@salesforce/plugin-org",
749
+ "hasDynamicHelp": true,
750
+ "hiddenAliases": [],
751
+ "id": "force:org:delete",
618
752
  "pluginAlias": "@salesforce/plugin-org",
753
+ "pluginName": "@salesforce/plugin-org",
619
754
  "pluginType": "core",
620
755
  "state": "deprecated",
621
- "aliases": [],
622
- "examples": [
623
- "$ <%= config.bin %> <%= command.id %> --sandboxname DevSbx1 --setalias MySandbox -u prodOrg",
624
- "$ <%= config.bin %> <%= command.id %> --sandboxname DevSbx1 --wait 45 --setdefaultusername -u prodOrg"
756
+ "strict": true,
757
+ "summary": "Delete a scratch or sandbox org.",
758
+ "enableJsonFlag": true,
759
+ "SF_ENV": "SF_ENV",
760
+ "isESM": true,
761
+ "relativePath": [
762
+ "lib",
763
+ "commands",
764
+ "force",
765
+ "org",
766
+ "delete.js"
625
767
  ],
768
+ "aliasPermutations": [],
769
+ "permutations": [
770
+ "force:org:delete",
771
+ "org:force:delete",
772
+ "org:delete:force",
773
+ "force:delete:org",
774
+ "delete:force:org",
775
+ "delete:org:force"
776
+ ]
777
+ },
778
+ "force:org:status": {
779
+ "aliases": [],
780
+ "args": {},
626
781
  "deprecationOptions": {
627
782
  "to": "org:resume:sandbox",
628
783
  "version": "60.0"
629
784
  },
785
+ "description": "Use this command to check the status of your sandbox creation or clone and, if the sandbox is ready, authenticate to it.\n\nUse the --wait (-w) parameter to specify the number of minutes that the command waits for the sandbox creation or clone to complete before returning control of the terminal to you.\n\nSet the --target-org (-o) parameter to the username or alias of the production org that contains the sandbox license.",
786
+ "examples": [
787
+ "$ <%= config.bin %> <%= command.id %> --sandboxname DevSbx1 --setalias MySandbox -u prodOrg",
788
+ "$ <%= config.bin %> <%= command.id %> --sandboxname DevSbx1 --wait 45 --setdefaultusername -u prodOrg"
789
+ ],
630
790
  "flags": {
631
791
  "json": {
632
- "name": "json",
633
- "type": "boolean",
634
792
  "description": "Format output as json.",
635
793
  "helpGroup": "GLOBAL",
636
- "allowNo": false
794
+ "name": "json",
795
+ "allowNo": false,
796
+ "type": "boolean"
637
797
  },
638
798
  "target-org": {
639
- "name": "target-org",
640
- "type": "option",
641
- "char": "o",
642
- "summary": "Username or alias of the target org.",
643
- "required": true,
644
- "multiple": false,
645
799
  "aliases": [
646
800
  "targetusername",
647
801
  "u"
648
- ]
802
+ ],
803
+ "char": "o",
804
+ "deprecateAliases": true,
805
+ "name": "target-org",
806
+ "noCacheDefault": true,
807
+ "required": true,
808
+ "summary": "Username or alias of the target org.",
809
+ "hasDynamicHelp": true,
810
+ "multiple": false,
811
+ "type": "option"
649
812
  },
650
813
  "api-version": {
651
- "name": "api-version",
652
- "type": "option",
653
- "description": "Override the api version used for api requests made by this command",
654
- "multiple": false,
655
814
  "aliases": [
656
815
  "apiversion"
657
- ]
816
+ ],
817
+ "deprecateAliases": true,
818
+ "description": "Override the api version used for api requests made by this command",
819
+ "name": "api-version",
820
+ "hasDynamicHelp": false,
821
+ "multiple": false,
822
+ "type": "option"
658
823
  },
659
824
  "sandboxname": {
660
- "name": "sandboxname",
661
- "type": "option",
662
825
  "char": "n",
663
- "summary": "Name of the sandbox org to check status for.",
826
+ "name": "sandboxname",
664
827
  "required": true,
665
- "multiple": false
828
+ "summary": "Name of the sandbox org to check status for.",
829
+ "hasDynamicHelp": false,
830
+ "multiple": false,
831
+ "type": "option"
666
832
  },
667
833
  "setdefaultusername": {
668
- "name": "setdefaultusername",
669
- "type": "boolean",
670
834
  "char": "s",
835
+ "name": "setdefaultusername",
671
836
  "summary": "Set the created or cloned org as your default.",
672
- "allowNo": false
837
+ "allowNo": false,
838
+ "type": "boolean"
673
839
  },
674
840
  "setalias": {
675
- "name": "setalias",
676
- "type": "option",
677
841
  "char": "a",
842
+ "name": "setalias",
678
843
  "summary": "Alias for the created or cloned org.",
679
- "multiple": false
844
+ "hasDynamicHelp": false,
845
+ "multiple": false,
846
+ "type": "option"
680
847
  },
681
848
  "wait": {
682
- "name": "wait",
683
- "type": "option",
684
849
  "char": "w",
850
+ "name": "wait",
685
851
  "summary": "Number of minutes to wait while polling for status.",
686
- "multiple": false,
687
852
  "default": {
688
853
  "quantity": 6,
689
854
  "unit": 0
690
- }
855
+ },
856
+ "hasDynamicHelp": false,
857
+ "multiple": false,
858
+ "type": "option"
691
859
  },
692
860
  "loglevel": {
693
- "name": "loglevel",
694
- "type": "option",
695
- "hidden": true,
696
- "multiple": false,
697
861
  "deprecated": {
698
862
  "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."
699
- }
863
+ },
864
+ "hidden": true,
865
+ "name": "loglevel",
866
+ "hasDynamicHelp": false,
867
+ "multiple": false,
868
+ "type": "option"
700
869
  }
701
870
  },
702
- "args": {},
703
- "hasDynamicHelp": true
704
- },
705
- "org:create:sandbox": {
706
- "id": "org:create:sandbox",
707
- "summary": "Create a sandbox org.",
708
- "description": "There are two ways to create a sandbox org: specify a definition file that contains the sandbox options or use the --name and --license-type flags to specify the two required options. If you want to set an option other than name or license type, such as apexClassId, you must use a definition file.",
709
- "strict": true,
710
- "pluginName": "@salesforce/plugin-org",
871
+ "hasDynamicHelp": true,
872
+ "hiddenAliases": [],
873
+ "id": "force:org:status",
711
874
  "pluginAlias": "@salesforce/plugin-org",
875
+ "pluginName": "@salesforce/plugin-org",
712
876
  "pluginType": "core",
877
+ "state": "deprecated",
878
+ "strict": true,
879
+ "summary": "Check the status of a sandbox, and if complete, authenticate to it.",
880
+ "enableJsonFlag": true,
881
+ "SF_ENV": "SF_ENV",
882
+ "isESM": true,
883
+ "relativePath": [
884
+ "lib",
885
+ "commands",
886
+ "force",
887
+ "org",
888
+ "status.js"
889
+ ],
890
+ "aliasPermutations": [],
891
+ "permutations": [
892
+ "force:org:status",
893
+ "org:force:status",
894
+ "org:status:force",
895
+ "force:status:org",
896
+ "status:force:org",
897
+ "status:org:force"
898
+ ]
899
+ },
900
+ "org:create:sandbox": {
713
901
  "aliases": [
714
902
  "env:create:sandbox"
715
903
  ],
904
+ "args": {},
905
+ "deprecateAliases": true,
906
+ "description": "There are two ways to create a sandbox org: specify a definition file that contains the sandbox options or use the --name and --license-type flags to specify the two required options. If you want to set an option other than name or license type, such as apexClassId, you must use a definition file.",
716
907
  "examples": [
717
908
  "Create a sandbox org using a definition file and give it the alias \"MyDevSandbox\". The production org that contains the sandbox license has the alias \"prodOrg\".\n<%= config.bin %> <%= command.id %> -f config/dev-sandbox-def.json --alias MyDevSandbox --target-org prodOrg",
718
909
  "Create a sandbox org by directly specifying its name and type of license (Developer) instead of using a definition file. Set the sandbox org as your default.\n<%= config.bin %> <%= command.id %> --name mysandbox --license-type Developer --alias MyDevSandbox --target-org prodOrg --set-default"
719
910
  ],
720
- "deprecateAliases": true,
721
911
  "flags": {
722
912
  "json": {
723
- "name": "json",
724
- "type": "boolean",
725
913
  "description": "Format output as json.",
726
914
  "helpGroup": "GLOBAL",
915
+ "name": "json",
727
916
  "allowNo": false,
728
- "deprecateAliases": true
917
+ "type": "boolean"
729
918
  },
730
919
  "definition-file": {
731
- "name": "definition-file",
732
- "type": "option",
733
920
  "char": "f",
734
- "summary": "Path to a sandbox definition file.",
735
921
  "description": "The sandbox definition file is a blueprint for the sandbox. You can create different definition files for each sandbox type that you use in the development process. See <https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_sandbox_definition.htm> for all the options you can specify in the defintion file.",
736
- "multiple": false,
737
922
  "exclusive": [
738
923
  "name",
739
924
  "license-type"
740
925
  ],
741
- "deprecateAliases": true
926
+ "name": "definition-file",
927
+ "summary": "Path to a sandbox definition file.",
928
+ "hasDynamicHelp": false,
929
+ "multiple": false,
930
+ "type": "option"
742
931
  },
743
932
  "set-default": {
744
- "name": "set-default",
745
- "type": "boolean",
746
933
  "char": "s",
934
+ "name": "set-default",
747
935
  "summary": "Set the sandbox org as your default org.",
748
936
  "allowNo": false,
749
- "deprecateAliases": true
937
+ "type": "boolean"
750
938
  },
751
939
  "alias": {
752
- "name": "alias",
753
- "type": "option",
754
940
  "char": "a",
755
- "summary": "Alias for the sandbox org.",
756
941
  "description": "When you create a sandbox, the generated usernames are based on the usernames present in the production org. To ensure uniqueness, the new usernames are appended with the name of the sandbox. For example, the username \"user@example.com\" in the production org results in the username \"user@example.com.mysandbox\" in a sandbox named \"mysandbox\". When you set an alias for a sandbox org, it's assigned to the resulting username of the user running this command.",
942
+ "name": "alias",
943
+ "summary": "Alias for the sandbox org.",
944
+ "hasDynamicHelp": false,
757
945
  "multiple": false,
758
- "deprecateAliases": true
946
+ "type": "option"
759
947
  },
760
948
  "wait": {
761
- "name": "wait",
762
- "type": "option",
763
949
  "char": "w",
764
- "summary": "Number of minutes to wait for the sandbox org to be ready.",
765
950
  "description": "If the command continues to run after the wait period, the CLI returns control of the terminal to you and displays the \"<%= config.bin %> org resume sandbox\" command you run to check the status of the create. The displayed command includes the job ID for the running sandbox creation.",
766
- "helpValue": "<minutes>",
767
- "multiple": false,
768
951
  "exclusive": [
769
952
  "async"
770
953
  ],
954
+ "name": "wait",
955
+ "summary": "Number of minutes to wait for the sandbox org to be ready.",
771
956
  "default": {
772
957
  "quantity": 30,
773
958
  "unit": 0
774
959
  },
775
- "deprecateAliases": true
960
+ "hasDynamicHelp": false,
961
+ "helpValue": "<minutes>",
962
+ "multiple": false,
963
+ "type": "option"
776
964
  },
777
965
  "poll-interval": {
778
- "name": "poll-interval",
779
- "type": "option",
780
966
  "char": "i",
781
- "summary": "Number of seconds to wait between retries.",
782
- "helpValue": "<seconds>",
783
- "multiple": false,
784
967
  "exclusive": [
785
968
  "async"
786
969
  ],
970
+ "name": "poll-interval",
971
+ "summary": "Number of seconds to wait between retries.",
787
972
  "default": {
788
973
  "quantity": 30,
789
974
  "unit": 2
790
975
  },
791
- "deprecateAliases": true
976
+ "hasDynamicHelp": false,
977
+ "helpValue": "<seconds>",
978
+ "multiple": false,
979
+ "type": "option"
792
980
  },
793
981
  "async": {
794
- "name": "async",
795
- "type": "boolean",
796
- "summary": "Request the sandbox creation, but don't wait for it to complete.",
797
982
  "description": "The command immediately displays the job ID and returns control of the terminal to you. This way, you can continue to use the CLI. To check the status of the sandbox creation, run \"<%= config.bin %> org resume sandbox\".",
798
- "allowNo": false,
799
983
  "exclusive": [
800
984
  "wait",
801
985
  "poll-interval"
802
986
  ],
803
- "deprecateAliases": true
987
+ "name": "async",
988
+ "summary": "Request the sandbox creation, but don't wait for it to complete.",
989
+ "allowNo": false,
990
+ "type": "boolean"
804
991
  },
805
992
  "name": {
806
- "name": "name",
807
- "type": "option",
808
993
  "char": "n",
809
- "summary": "Name of the sandbox org.",
810
994
  "description": "The name must be a unique alphanumeric string (10 or fewer characters) to identify the sandbox. You can’t reuse a name while a sandbox is in the process of being deleted.",
811
- "multiple": false,
812
995
  "exclusive": [
813
996
  "definition-file"
814
997
  ],
815
- "deprecateAliases": true
998
+ "name": "name",
999
+ "summary": "Name of the sandbox org.",
1000
+ "hasDynamicHelp": false,
1001
+ "multiple": false,
1002
+ "type": "option"
816
1003
  },
817
1004
  "clone": {
818
- "name": "clone",
819
- "type": "option",
820
1005
  "char": "c",
821
- "summary": "Name of the sandbox org to clone.",
822
1006
  "description": "The value of clone must be an existing sandbox in the same target-org.",
823
- "multiple": false,
824
1007
  "exclusive": [
825
1008
  "license-type"
826
1009
  ],
827
- "deprecateAliases": true
1010
+ "name": "clone",
1011
+ "summary": "Name of the sandbox org to clone.",
1012
+ "hasDynamicHelp": false,
1013
+ "multiple": false,
1014
+ "type": "option"
828
1015
  },
829
1016
  "license-type": {
830
- "name": "license-type",
831
- "type": "option",
832
1017
  "char": "l",
1018
+ "exclusive": [
1019
+ "definition-file",
1020
+ "clone"
1021
+ ],
1022
+ "name": "license-type",
833
1023
  "summary": "Type of sandbox license.",
1024
+ "hasDynamicHelp": false,
834
1025
  "multiple": false,
835
1026
  "options": [
836
1027
  "Developer",
@@ -838,127 +1029,144 @@
838
1029
  "Partial",
839
1030
  "Full"
840
1031
  ],
841
- "exclusive": [
842
- "definition-file",
843
- "clone"
844
- ],
845
- "deprecateAliases": true
1032
+ "type": "option"
846
1033
  },
847
1034
  "target-org": {
848
- "name": "target-org",
849
- "type": "option",
850
1035
  "char": "o",
851
- "summary": "Username or alias of the production org that contains the sandbox license.",
852
1036
  "description": "When it creates the sandbox org, Salesforce copies the metadata, and optionally data, from your production org to the new sandbox org.",
1037
+ "name": "target-org",
1038
+ "noCacheDefault": true,
853
1039
  "required": true,
1040
+ "summary": "Username or alias of the production org that contains the sandbox license.",
1041
+ "hasDynamicHelp": true,
854
1042
  "multiple": false,
855
- "deprecateAliases": true
1043
+ "type": "option"
856
1044
  },
857
1045
  "no-prompt": {
858
1046
  "name": "no-prompt",
859
- "type": "boolean",
860
1047
  "summary": "Don't prompt for confirmation about the sandbox configuration.",
861
1048
  "allowNo": false,
862
- "deprecateAliases": true
1049
+ "type": "boolean"
863
1050
  },
864
1051
  "no-track-source": {
1052
+ "description": "We recommend you enable source tracking in Developer and Developer Pro sandbox, which is why it's the default behavior. Source tracking allows you to track the changes you make to your metadata, both in your local project and in the sandbox, and to detect any conflicts between the two.\n\nTo disable source tracking in the new sandbox, specify the --no-track-source flag. The main reason to disable source tracking is for performance. For example, while you probably want to deploy metadata and run Apex tests in your CI/CD jobs, you probably don't want to incur the costs of source tracking (checking for conflicts, polling the SourceMember object, various file system operations.) This is a good use case for disabling source tracking in the sandbox.",
865
1053
  "name": "no-track-source",
866
- "type": "boolean",
867
1054
  "summary": "Do not use source tracking for this sandbox.",
868
- "description": "We recommend you enable source tracking in Developer and Developer Pro sandbox, which is why it's the default behavior. Source tracking allows you to track the changes you make to your metadata, both in your local project and in the sandbox, and to detect any conflicts between the two.\n\nTo disable source tracking in the new sandbox, specify the --no-track-source flag. The main reason to disable source tracking is for performance. For example, while you probably want to deploy metadata and run Apex tests in your CI/CD jobs, you probably don't want to incur the costs of source tracking (checking for conflicts, polling the SourceMember object, various file system operations.) This is a good use case for disabling source tracking in the sandbox.",
869
1055
  "allowNo": false,
870
- "deprecateAliases": true
1056
+ "type": "boolean"
871
1057
  }
872
1058
  },
873
- "args": {},
874
- "hasDynamicHelp": true
875
- },
876
- "org:create:scratch": {
877
- "id": "org:create:scratch",
878
- "summary": "Create a scratch org.",
879
- "description": "There are two ways to create a scratch org: either specify a definition file that contains the options or use the --edition flag to specify the one required option.\n\nFor either method, you can also use these flags; if you use them with --definition-file, they override their equivalent option in the scratch org definition file:\n\n * --description\n * --name (equivalent to the \"orgName\" option)\n * --username\n * --release\n * --edition\n * --admin-email (equivalent to the \"adminEmail\" option)\n * --source-org (equivalent to the \"sourceOrg\" option)\n\nIf you want to set options other than the preceding ones, such as org features or settings, you must use a definition file.\n\nYou must specify a Dev Hub to create a scratch org, either with the --target-dev-hub flag or by setting your default Dev Hub with the target-dev-hub configuration variable.",
880
- "strict": true,
881
- "pluginName": "@salesforce/plugin-org",
1059
+ "hasDynamicHelp": true,
1060
+ "hiddenAliases": [],
1061
+ "id": "org:create:sandbox",
882
1062
  "pluginAlias": "@salesforce/plugin-org",
1063
+ "pluginName": "@salesforce/plugin-org",
883
1064
  "pluginType": "core",
1065
+ "strict": true,
1066
+ "summary": "Create a sandbox org.",
1067
+ "isESM": true,
1068
+ "relativePath": [
1069
+ "lib",
1070
+ "commands",
1071
+ "org",
1072
+ "create",
1073
+ "sandbox.js"
1074
+ ],
1075
+ "aliasPermutations": [
1076
+ "env:create:sandbox",
1077
+ "create:env:sandbox",
1078
+ "create:sandbox:env",
1079
+ "env:sandbox:create",
1080
+ "sandbox:env:create",
1081
+ "sandbox:create:env"
1082
+ ],
1083
+ "permutations": [
1084
+ "org:create:sandbox",
1085
+ "create:org:sandbox",
1086
+ "create:sandbox:org",
1087
+ "org:sandbox:create",
1088
+ "sandbox:org:create",
1089
+ "sandbox:create:org"
1090
+ ]
1091
+ },
1092
+ "org:create:scratch": {
884
1093
  "aliases": [
885
1094
  "env:create:scratch"
886
1095
  ],
1096
+ "args": {},
1097
+ "deprecateAliases": true,
1098
+ "description": "There are two ways to create a scratch org: either specify a definition file that contains the options or use the --edition flag to specify the one required option.\n\nFor either method, you can also use these flags; if you use them with --definition-file, they override their equivalent option in the scratch org definition file:\n\n * --description\n * --name (equivalent to the \"orgName\" option)\n * --username\n * --release\n * --edition\n * --admin-email (equivalent to the \"adminEmail\" option)\n * --source-org (equivalent to the \"sourceOrg\" option)\n\nIf you want to set options other than the preceding ones, such as org features or settings, you must use a definition file.\n\nYou must specify a Dev Hub to create a scratch org, either with the --target-dev-hub flag or by setting your default Dev Hub with the target-dev-hub configuration variable.",
887
1099
  "examples": [
888
1100
  "Create a Developer edition scratch org using your default Dev Hub and give the scratch org an alias:\n<%= config.bin %> <%= command.id %> --edition developer --alias my-scratch-org",
889
1101
  "Create a scratch org with a definition file. Specify the Dev Hub using its alias, set the scratch org as your default, and specify that it expires in 3 days:\n<%= config.bin %> <%= command.id %> --target-dev-hub MyHub --definition-file config/project-scratch-def.json --set-default --duration-days 3",
890
1102
  "Create a preview Enterprise edition scratch org; for use only during Salesforce release transition periods:\n<%= config.bin %> <%= command.id %> --edition enterprise --alias my-scratch-org --target-dev-hub MyHub --release preview"
891
1103
  ],
892
- "deprecateAliases": true,
893
1104
  "flags": {
894
1105
  "json": {
895
- "name": "json",
896
- "type": "boolean",
897
1106
  "description": "Format output as json.",
898
1107
  "helpGroup": "GLOBAL",
1108
+ "name": "json",
899
1109
  "allowNo": false,
900
- "deprecateAliases": true
1110
+ "type": "boolean"
901
1111
  },
902
1112
  "alias": {
903
- "name": "alias",
904
- "type": "option",
905
1113
  "char": "a",
906
- "summary": "Alias for the scratch org.",
907
1114
  "description": "New scratch orgs include one administrator by default. The admin user's username is auto-generated and looks something like test-wvkpnfm5z113@example.com. When you set an alias for a new scratch org, it's assigned this username.",
1115
+ "name": "alias",
1116
+ "summary": "Alias for the scratch org.",
1117
+ "hasDynamicHelp": false,
908
1118
  "multiple": false,
909
- "deprecateAliases": true
1119
+ "type": "option"
910
1120
  },
911
1121
  "async": {
1122
+ "description": "The command immediately displays the job ID and returns control of the terminal to you. This way, you can continue to use the CLI. To resume the scratch org creation, run \"<%= config.bin %> org resume scratch\".",
912
1123
  "name": "async",
913
- "type": "boolean",
914
1124
  "summary": "Request the org, but don't wait for it to complete.",
915
- "description": "The command immediately displays the job ID and returns control of the terminal to you. This way, you can continue to use the CLI. To resume the scratch org creation, run \"<%= config.bin %> org resume scratch\".",
916
1125
  "allowNo": false,
917
- "deprecateAliases": true
1126
+ "type": "boolean"
918
1127
  },
919
1128
  "set-default": {
920
- "name": "set-default",
921
- "type": "boolean",
922
1129
  "char": "d",
1130
+ "name": "set-default",
923
1131
  "summary": "Set the scratch org as your default org",
924
1132
  "allowNo": false,
925
- "deprecateAliases": true
1133
+ "type": "boolean"
926
1134
  },
927
1135
  "definition-file": {
928
- "name": "definition-file",
929
- "type": "option",
930
1136
  "char": "f",
931
- "summary": "Path to a scratch org definition file.",
932
1137
  "description": "The scratch org definition file is a blueprint for the scratch org. It mimics the shape of an org that you use in the development life cycle, such as acceptance testing, packaging, or production. See <https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_scratch_orgs_def_file.htm> for all the option you can specify in the definition file.",
1138
+ "name": "definition-file",
1139
+ "summary": "Path to a scratch org definition file.",
1140
+ "hasDynamicHelp": false,
933
1141
  "multiple": false,
934
- "deprecateAliases": true
1142
+ "type": "option"
935
1143
  },
936
1144
  "target-dev-hub": {
937
- "name": "target-dev-hub",
938
- "type": "option",
939
1145
  "char": "v",
940
- "summary": "Username or alias of the Dev Hub org.",
941
1146
  "description": "Overrides the value of the target-dev-hub configuration variable, if set.",
1147
+ "name": "target-dev-hub",
1148
+ "noCacheDefault": true,
942
1149
  "required": true,
1150
+ "summary": "Username or alias of the Dev Hub org.",
1151
+ "hasDynamicHelp": true,
943
1152
  "multiple": false,
944
- "deprecateAliases": true
1153
+ "type": "option"
945
1154
  },
946
1155
  "no-ancestors": {
947
- "name": "no-ancestors",
948
- "type": "boolean",
949
1156
  "char": "c",
950
- "summary": "Don't include second-generation managed package (2GP) ancestors in the scratch org.",
951
1157
  "helpGroup": "Packaging",
1158
+ "name": "no-ancestors",
1159
+ "summary": "Don't include second-generation managed package (2GP) ancestors in the scratch org.",
952
1160
  "allowNo": false,
953
- "deprecateAliases": true
1161
+ "type": "boolean"
954
1162
  },
955
1163
  "edition": {
956
- "name": "edition",
957
- "type": "option",
958
1164
  "char": "e",
959
- "summary": "Salesforce edition of the scratch org. Overrides the value of the \"edition\" option in the definition file, if set.",
960
1165
  "description": "The editions that begin with \"partner-\" are available only if the Dev Hub org is a Partner Business Org.",
961
1166
  "helpGroup": "Definition File Override",
1167
+ "name": "edition",
1168
+ "summary": "Salesforce edition of the scratch org. Overrides the value of the \"edition\" option in the definition file, if set.",
1169
+ "hasDynamicHelp": false,
962
1170
  "multiple": false,
963
1171
  "options": [
964
1172
  "developer",
@@ -970,536 +1178,730 @@
970
1178
  "partner-group",
971
1179
  "partner-professional"
972
1180
  ],
973
- "deprecateAliases": true
1181
+ "type": "option"
974
1182
  },
975
1183
  "no-namespace": {
976
- "name": "no-namespace",
977
- "type": "boolean",
978
1184
  "char": "m",
979
- "summary": "Create the scratch org with no namespace, even if the Dev Hub has a namespace.",
980
1185
  "helpGroup": "Packaging",
1186
+ "name": "no-namespace",
1187
+ "summary": "Create the scratch org with no namespace, even if the Dev Hub has a namespace.",
981
1188
  "allowNo": false,
982
- "deprecateAliases": true
1189
+ "type": "boolean"
983
1190
  },
984
1191
  "duration-days": {
985
- "name": "duration-days",
986
- "type": "option",
987
1192
  "char": "y",
1193
+ "name": "duration-days",
988
1194
  "summary": "Number of days before the org expires.",
989
- "helpValue": "<days>",
990
- "multiple": false,
991
1195
  "default": {
992
1196
  "quantity": 7,
993
1197
  "unit": 4
994
1198
  },
995
- "deprecateAliases": true
1199
+ "hasDynamicHelp": false,
1200
+ "helpValue": "<days>",
1201
+ "multiple": false,
1202
+ "type": "option"
996
1203
  },
997
1204
  "wait": {
998
- "name": "wait",
999
- "type": "option",
1000
1205
  "char": "w",
1001
- "summary": "Number of minutes to wait for the scratch org to be ready.",
1002
1206
  "description": "If the command continues to run after the wait period, the CLI returns control of the terminal to you and displays the job ID. To resume the scratch org creation, run the org resume scratch command and pass it the job ID.",
1003
- "helpValue": "<minutes>",
1004
- "multiple": false,
1207
+ "name": "wait",
1208
+ "summary": "Number of minutes to wait for the scratch org to be ready.",
1005
1209
  "default": {
1006
1210
  "quantity": 5,
1007
1211
  "unit": 0
1008
1212
  },
1009
- "deprecateAliases": true
1213
+ "hasDynamicHelp": false,
1214
+ "helpValue": "<minutes>",
1215
+ "multiple": false,
1216
+ "type": "option"
1010
1217
  },
1011
1218
  "api-version": {
1012
- "name": "api-version",
1013
- "type": "option",
1014
1219
  "description": "Override the api version used for api requests made by this command",
1220
+ "name": "api-version",
1221
+ "hasDynamicHelp": false,
1015
1222
  "multiple": false,
1016
- "deprecateAliases": true
1223
+ "type": "option"
1017
1224
  },
1018
1225
  "client-id": {
1019
- "name": "client-id",
1020
- "type": "option",
1021
1226
  "char": "i",
1227
+ "name": "client-id",
1022
1228
  "summary": "Consumer key of the Dev Hub connected app.",
1229
+ "hasDynamicHelp": false,
1023
1230
  "multiple": false,
1024
- "deprecateAliases": true
1231
+ "type": "option"
1025
1232
  },
1026
1233
  "track-source": {
1027
- "name": "track-source",
1028
- "type": "boolean",
1029
1234
  "char": "t",
1030
- "summary": "Use source tracking for this scratch org. Set --no-track-source to disable source tracking.",
1031
1235
  "description": "We recommend you enable source tracking in scratch orgs, which is why it's the default behavior. Source tracking allows you to track the changes you make to your metadata, both in your local project and in the scratch org, and to detect any conflicts between the two.\n\nTo disable source tracking in the new scratch org, specify the --no-track-source flag. The main reason to disable source tracking is for performance. For example, while you probably want to deploy metadata and run Apex tests in your CI/CD jobs, you probably don't want to incur the costs of source tracking (checking for conflicts, polling the SourceMember object, various file system operations.) This is a good use case for disabling source tracking in the scratch org.",
1236
+ "name": "track-source",
1237
+ "summary": "Use source tracking for this scratch org. Set --no-track-source to disable source tracking.",
1032
1238
  "allowNo": true,
1033
- "deprecateAliases": true
1239
+ "type": "boolean"
1034
1240
  },
1035
1241
  "username": {
1036
- "name": "username",
1037
- "type": "option",
1038
- "summary": "Username of the scratch org admin user. Overrides the value of the \"username\" option in the definition file, if set.",
1039
1242
  "description": "The username must be unique within the entire scratch org and sandbox universe. You must add your own logic to ensure uniqueness.\n\nOmit this flag to have Salesforce generate a unique username for your org.",
1040
1243
  "helpGroup": "Definition File Override",
1244
+ "name": "username",
1245
+ "summary": "Username of the scratch org admin user. Overrides the value of the \"username\" option in the definition file, if set.",
1246
+ "hasDynamicHelp": false,
1041
1247
  "multiple": false,
1042
- "deprecateAliases": true
1248
+ "type": "option"
1043
1249
  },
1044
1250
  "description": {
1251
+ "helpGroup": "Definition File Override",
1045
1252
  "name": "description",
1046
- "type": "option",
1047
1253
  "summary": "Description of the scratch org in the Dev Hub. Overrides the value of the \"description\" option in the definition file, if set.",
1048
- "helpGroup": "Definition File Override",
1254
+ "hasDynamicHelp": false,
1049
1255
  "multiple": false,
1050
- "deprecateAliases": true
1256
+ "type": "option"
1051
1257
  },
1052
1258
  "name": {
1259
+ "helpGroup": "Definition File Override",
1053
1260
  "name": "name",
1054
- "type": "option",
1055
1261
  "summary": "Name of the org, such as \"Acme Company\". Overrides the value of the \"orgName\" option in the definition file, if set.",
1056
- "helpGroup": "Definition File Override",
1262
+ "hasDynamicHelp": false,
1057
1263
  "multiple": false,
1058
- "deprecateAliases": true
1264
+ "type": "option"
1059
1265
  },
1060
1266
  "release": {
1061
- "name": "release",
1062
- "type": "option",
1063
- "summary": "Release of the scratch org as compared to the Dev Hub release.",
1064
1267
  "description": "By default, scratch orgs are on the same release as the Dev Hub. During Salesforce release transition periods, you can override this default behavior and opt in or out of the new release.",
1065
1268
  "helpGroup": "Definition File Override",
1269
+ "name": "release",
1270
+ "summary": "Release of the scratch org as compared to the Dev Hub release.",
1271
+ "hasDynamicHelp": false,
1066
1272
  "multiple": false,
1067
1273
  "options": [
1068
1274
  "preview",
1069
1275
  "previous"
1070
1276
  ],
1071
- "deprecateAliases": true
1277
+ "type": "option"
1072
1278
  },
1073
1279
  "admin-email": {
1280
+ "helpGroup": "Definition File Override",
1074
1281
  "name": "admin-email",
1075
- "type": "option",
1076
1282
  "summary": "Email address that will be applied to the org's admin user. Overrides the value of the \"adminEmail\" option in the definition file, if set.",
1077
- "helpGroup": "Definition File Override",
1283
+ "hasDynamicHelp": false,
1078
1284
  "multiple": false,
1079
- "deprecateAliases": true
1285
+ "type": "option"
1080
1286
  },
1081
1287
  "source-org": {
1288
+ "helpGroup": "Definition File Override",
1082
1289
  "name": "source-org",
1083
- "type": "option",
1084
1290
  "summary": "15-character ID of the org whose shape the new scratch org will be based on. Overrides the value of the \"sourceOrg\" option in the definition file, if set.",
1085
- "helpGroup": "Definition File Override",
1291
+ "hasDynamicHelp": false,
1086
1292
  "multiple": false,
1087
- "deprecateAliases": true
1293
+ "type": "option"
1088
1294
  }
1089
1295
  },
1090
- "args": {},
1091
- "hasDynamicHelp": true
1092
- },
1093
- "org:delete:sandbox": {
1094
- "id": "org:delete:sandbox",
1095
- "summary": "Delete a sandbox.",
1096
- "description": "Salesforce CLI marks the org for deletion in the production org that contains the sandbox licenses and then deletes all local references to the org from your computer.\nSpecify a sandbox with either the username you used when you logged into it, or the alias you gave the sandbox when you created it. Run \"<%= config.bin %> org list\" to view all your orgs, including sandboxes, and their aliases.",
1097
- "strict": true,
1098
- "pluginName": "@salesforce/plugin-org",
1296
+ "hasDynamicHelp": true,
1297
+ "hiddenAliases": [],
1298
+ "id": "org:create:scratch",
1099
1299
  "pluginAlias": "@salesforce/plugin-org",
1300
+ "pluginName": "@salesforce/plugin-org",
1100
1301
  "pluginType": "core",
1302
+ "strict": true,
1303
+ "summary": "Create a scratch org.",
1304
+ "enableJsonFlag": true,
1305
+ "SF_ENV": "SF_ENV",
1306
+ "isESM": true,
1307
+ "relativePath": [
1308
+ "lib",
1309
+ "commands",
1310
+ "org",
1311
+ "create",
1312
+ "scratch.js"
1313
+ ],
1314
+ "aliasPermutations": [
1315
+ "env:create:scratch",
1316
+ "create:env:scratch",
1317
+ "create:scratch:env",
1318
+ "env:scratch:create",
1319
+ "scratch:env:create",
1320
+ "scratch:create:env"
1321
+ ],
1322
+ "permutations": [
1323
+ "org:create:scratch",
1324
+ "create:org:scratch",
1325
+ "create:scratch:org",
1326
+ "org:scratch:create",
1327
+ "scratch:org:create",
1328
+ "scratch:create:org"
1329
+ ]
1330
+ },
1331
+ "org:delete:sandbox": {
1101
1332
  "aliases": [
1102
1333
  "env:delete:sandbox"
1103
1334
  ],
1335
+ "args": {},
1336
+ "deprecateAliases": true,
1337
+ "description": "Salesforce CLI marks the org for deletion in the production org that contains the sandbox licenses and then deletes all local references to the org from your computer.\nSpecify a sandbox with either the username you used when you logged into it, or the alias you gave the sandbox when you created it. Run \"<%= config.bin %> org list\" to view all your orgs, including sandboxes, and their aliases.",
1104
1338
  "examples": [
1105
1339
  "Delete a sandbox with alias my-sandbox:\n<%= config.bin %> <%= command.id %> --target-org my-sandbox",
1106
1340
  "Specify a username instead of an alias:\n<%= config.bin %> <%= command.id %> --target-org myusername@example.com.qa",
1107
1341
  "Delete the sandbox without prompting to confirm :\n<%= config.bin %> <%= command.id %> --target-org my-sandbox --no-prompt"
1108
1342
  ],
1109
- "deprecateAliases": true,
1110
1343
  "flags": {
1111
1344
  "json": {
1112
- "name": "json",
1113
- "type": "boolean",
1114
1345
  "description": "Format output as json.",
1115
1346
  "helpGroup": "GLOBAL",
1347
+ "name": "json",
1116
1348
  "allowNo": false,
1117
- "deprecateAliases": true
1349
+ "type": "boolean"
1118
1350
  },
1119
1351
  "target-org": {
1120
- "name": "target-org",
1121
- "type": "option",
1122
- "char": "o",
1123
- "summary": "Sandbox alias or login user.",
1124
- "required": true,
1125
- "multiple": false,
1126
- "deprecateAliases": true,
1127
1352
  "aliases": [
1128
1353
  "targetusername",
1129
1354
  "u"
1130
- ]
1355
+ ],
1356
+ "char": "o",
1357
+ "deprecateAliases": true,
1358
+ "name": "target-org",
1359
+ "required": true,
1360
+ "summary": "Sandbox alias or login user.",
1361
+ "hasDynamicHelp": true,
1362
+ "multiple": false,
1363
+ "type": "option"
1131
1364
  },
1132
1365
  "no-prompt": {
1133
- "name": "no-prompt",
1134
- "type": "boolean",
1135
1366
  "char": "p",
1367
+ "name": "no-prompt",
1136
1368
  "summary": "Don't prompt the user to confirm the deletion.",
1137
1369
  "allowNo": false,
1138
- "deprecateAliases": true
1370
+ "type": "boolean"
1139
1371
  }
1140
1372
  },
1141
- "args": {},
1142
- "hasDynamicHelp": true
1143
- },
1144
- "org:delete:scratch": {
1145
- "id": "org:delete:scratch",
1146
- "summary": "Delete a scratch org.",
1147
- "description": "Salesforce CLI marks the org for deletion in the Dev Hub org and then deletes all local references to the org from your computer.\nSpecify a scratch org with either the username or the alias you gave the scratch org when you created it. Run \"<%= config.bin %> org list\" to view all your orgs, including scratch orgs, and their aliases.",
1148
- "strict": true,
1149
- "pluginName": "@salesforce/plugin-org",
1373
+ "hasDynamicHelp": true,
1374
+ "hiddenAliases": [],
1375
+ "id": "org:delete:sandbox",
1150
1376
  "pluginAlias": "@salesforce/plugin-org",
1377
+ "pluginName": "@salesforce/plugin-org",
1151
1378
  "pluginType": "core",
1379
+ "strict": true,
1380
+ "summary": "Delete a sandbox.",
1381
+ "enableJsonFlag": true,
1382
+ "SF_ENV": "SF_ENV",
1383
+ "isESM": true,
1384
+ "relativePath": [
1385
+ "lib",
1386
+ "commands",
1387
+ "org",
1388
+ "delete",
1389
+ "sandbox.js"
1390
+ ],
1391
+ "aliasPermutations": [
1392
+ "env:delete:sandbox",
1393
+ "delete:env:sandbox",
1394
+ "delete:sandbox:env",
1395
+ "env:sandbox:delete",
1396
+ "sandbox:env:delete",
1397
+ "sandbox:delete:env"
1398
+ ],
1399
+ "permutations": [
1400
+ "org:delete:sandbox",
1401
+ "delete:org:sandbox",
1402
+ "delete:sandbox:org",
1403
+ "org:sandbox:delete",
1404
+ "sandbox:org:delete",
1405
+ "sandbox:delete:org"
1406
+ ]
1407
+ },
1408
+ "org:delete:scratch": {
1152
1409
  "aliases": [
1153
1410
  "env:delete:scratch"
1154
1411
  ],
1412
+ "args": {},
1413
+ "deprecateAliases": true,
1414
+ "description": "Salesforce CLI marks the org for deletion in the Dev Hub org and then deletes all local references to the org from your computer.\nSpecify a scratch org with either the username or the alias you gave the scratch org when you created it. Run \"<%= config.bin %> org list\" to view all your orgs, including scratch orgs, and their aliases.",
1155
1415
  "examples": [
1156
1416
  "Delete a scratch org with alias my-scratch-org:\n<%= config.bin %> <%= command.id %> --target-org my-scratch-org",
1157
1417
  "Specify a username instead of an alias:\n<%= config.bin %> <%= command.id %> --target-org test-123456-abcdefg@example.com",
1158
1418
  "Delete the scratch org without prompting to confirm :\n<%= config.bin %> <%= command.id %> --target-org my-scratch-org --no-prompt"
1159
1419
  ],
1160
- "deprecateAliases": true,
1161
1420
  "flags": {
1162
1421
  "json": {
1163
- "name": "json",
1164
- "type": "boolean",
1165
1422
  "description": "Format output as json.",
1166
1423
  "helpGroup": "GLOBAL",
1424
+ "name": "json",
1167
1425
  "allowNo": false,
1168
- "deprecateAliases": true
1426
+ "type": "boolean"
1169
1427
  },
1170
1428
  "target-org": {
1171
- "name": "target-org",
1172
- "type": "option",
1173
- "char": "o",
1174
- "summary": "Scratch org alias or login user.",
1175
- "required": true,
1176
- "multiple": false,
1177
- "deprecateAliases": true,
1178
1429
  "aliases": [
1179
1430
  "targetusername",
1180
1431
  "u"
1181
- ]
1432
+ ],
1433
+ "char": "o",
1434
+ "deprecateAliases": true,
1435
+ "name": "target-org",
1436
+ "required": true,
1437
+ "summary": "Scratch org alias or login user.",
1438
+ "hasDynamicHelp": true,
1439
+ "multiple": false,
1440
+ "type": "option"
1182
1441
  },
1183
1442
  "no-prompt": {
1184
- "name": "no-prompt",
1185
- "type": "boolean",
1186
1443
  "char": "p",
1444
+ "name": "no-prompt",
1187
1445
  "summary": "Don't prompt the user to confirm the deletion.",
1188
1446
  "allowNo": false,
1189
- "deprecateAliases": true
1447
+ "type": "boolean"
1190
1448
  }
1191
1449
  },
1192
- "args": {},
1193
- "hasDynamicHelp": true
1194
- },
1195
- "org:list:metadata-types": {
1196
- "id": "org:list:metadata-types",
1197
- "summary": "Display details about the metadata types that are enabled for your org.",
1198
- "description": "The information includes Apex classes and triggers, custom objects, custom fields on standard objects, tab sets that define an app, and many other metadata types. Use this information to identify the syntax needed for a <name> element in a manifest file (package.xml).\n\nThe username that you use to connect to the org must have the Modify All Data or Modify Metadata Through Metadata API Functions permission.",
1199
- "strict": true,
1200
- "pluginName": "@salesforce/plugin-org",
1450
+ "hasDynamicHelp": true,
1451
+ "hiddenAliases": [],
1452
+ "id": "org:delete:scratch",
1201
1453
  "pluginAlias": "@salesforce/plugin-org",
1454
+ "pluginName": "@salesforce/plugin-org",
1202
1455
  "pluginType": "core",
1456
+ "strict": true,
1457
+ "summary": "Delete a scratch org.",
1458
+ "enableJsonFlag": true,
1459
+ "SF_ENV": "SF_ENV",
1460
+ "isESM": true,
1461
+ "relativePath": [
1462
+ "lib",
1463
+ "commands",
1464
+ "org",
1465
+ "delete",
1466
+ "scratch.js"
1467
+ ],
1468
+ "aliasPermutations": [
1469
+ "env:delete:scratch",
1470
+ "delete:env:scratch",
1471
+ "delete:scratch:env",
1472
+ "env:scratch:delete",
1473
+ "scratch:env:delete",
1474
+ "scratch:delete:env"
1475
+ ],
1476
+ "permutations": [
1477
+ "org:delete:scratch",
1478
+ "delete:org:scratch",
1479
+ "delete:scratch:org",
1480
+ "org:scratch:delete",
1481
+ "scratch:org:delete",
1482
+ "scratch:delete:org"
1483
+ ]
1484
+ },
1485
+ "org:list:metadata-types": {
1203
1486
  "aliases": [
1204
1487
  "force:mdapi:describemetadata"
1205
1488
  ],
1489
+ "args": {},
1490
+ "deprecateAliases": true,
1491
+ "description": "The information includes Apex classes and triggers, custom objects, custom fields on standard objects, tab sets that define an app, and many other metadata types. Use this information to identify the syntax needed for a <name> element in a manifest file (package.xml).\n\nThe username that you use to connect to the org must have the Modify All Data or Modify Metadata Through Metadata API Functions permission.",
1206
1492
  "examples": [
1207
1493
  "Display information about all known and enabled metadata types in the org with alias \"my-dev-org\" using API version 57.0:\n$ <%= config.bin %> <%= command.id %> --api-version 57.0 --target-org my-dev-org",
1208
1494
  "Display only the metadata types that aren't yet supported by Salesforce CLI in your default org and write the results to the specified file:\n$ <%= config.bin %> <%= command.id %> --output-file /path/to/outputfilename.txt --filter-known"
1209
1495
  ],
1210
- "deprecateAliases": true,
1211
1496
  "flags": {
1212
1497
  "json": {
1213
- "name": "json",
1214
- "type": "boolean",
1215
1498
  "description": "Format output as json.",
1216
1499
  "helpGroup": "GLOBAL",
1500
+ "name": "json",
1217
1501
  "allowNo": false,
1218
- "deprecateAliases": true
1502
+ "type": "boolean"
1219
1503
  },
1220
1504
  "api-version": {
1221
- "name": "api-version",
1222
- "type": "option",
1223
- "summary": "API version to use; default is the most recent API version.",
1224
- "description": "Override the api version used for api requests made by this command",
1225
- "multiple": false,
1226
- "deprecateAliases": true,
1227
1505
  "aliases": [
1228
1506
  "apiversion",
1229
1507
  "a"
1230
- ]
1508
+ ],
1509
+ "deprecateAliases": true,
1510
+ "description": "Override the api version used for api requests made by this command",
1511
+ "name": "api-version",
1512
+ "summary": "API version to use; default is the most recent API version.",
1513
+ "hasDynamicHelp": false,
1514
+ "multiple": false,
1515
+ "type": "option"
1231
1516
  },
1232
1517
  "loglevel": {
1233
- "name": "loglevel",
1234
- "type": "option",
1235
- "hidden": true,
1236
- "multiple": false,
1237
1518
  "deprecated": {
1238
1519
  "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."
1239
1520
  },
1240
- "deprecateAliases": true
1521
+ "hidden": true,
1522
+ "name": "loglevel",
1523
+ "hasDynamicHelp": false,
1524
+ "multiple": false,
1525
+ "type": "option"
1241
1526
  },
1242
1527
  "target-org": {
1243
- "name": "target-org",
1244
- "type": "option",
1245
- "char": "o",
1246
- "summary": "Username or alias of the target org.",
1247
- "required": true,
1248
- "multiple": false,
1249
- "deprecateAliases": true,
1250
1528
  "aliases": [
1251
1529
  "targetusername",
1252
1530
  "u"
1253
- ]
1531
+ ],
1532
+ "char": "o",
1533
+ "deprecateAliases": true,
1534
+ "name": "target-org",
1535
+ "noCacheDefault": true,
1536
+ "required": true,
1537
+ "summary": "Username or alias of the target org.",
1538
+ "hasDynamicHelp": true,
1539
+ "multiple": false,
1540
+ "type": "option"
1254
1541
  },
1255
1542
  "output-file": {
1256
- "name": "output-file",
1257
- "type": "option",
1543
+ "aliases": [
1544
+ "resultfile"
1545
+ ],
1258
1546
  "char": "f",
1259
- "summary": "Pathname of the file in which to write the results.",
1547
+ "deprecateAliases": true,
1260
1548
  "description": "Directing the output to a file makes it easier to extract relevant information for your package.xml manifest file. The default output destination is the terminal or command window console.",
1549
+ "name": "output-file",
1550
+ "summary": "Pathname of the file in which to write the results.",
1551
+ "hasDynamicHelp": false,
1261
1552
  "multiple": false,
1262
- "deprecateAliases": true,
1263
- "aliases": [
1264
- "resultfile"
1265
- ]
1553
+ "type": "option"
1266
1554
  },
1267
1555
  "filter-known": {
1268
- "name": "filter-known",
1269
- "type": "boolean",
1556
+ "aliases": [
1557
+ "filterknown"
1558
+ ],
1270
1559
  "char": "k",
1271
- "summary": "Filter the known metadata types from the result to display only the types not yet fully supported by Salesforce CLI.\n\nfilter metadata known by the CLI",
1560
+ "deprecateAliases": true,
1272
1561
  "hidden": true,
1562
+ "name": "filter-known",
1563
+ "summary": "Filter the known metadata types from the result to display only the types not yet fully supported by Salesforce CLI.\n\nfilter metadata known by the CLI",
1273
1564
  "allowNo": false,
1274
- "deprecateAliases": true,
1275
- "aliases": [
1276
- "filterknown"
1277
- ]
1565
+ "type": "boolean"
1278
1566
  }
1279
1567
  },
1280
- "args": {},
1281
- "hasDynamicHelp": true
1282
- },
1283
- "org:list:metadata": {
1284
- "id": "org:list:metadata",
1285
- "summary": "List the metadata components and properties of a specified type.",
1286
- "description": "Use this command to identify individual components in your manifest file or if you want a high-level view of particular metadata types in your org. For example, you can use this command to return a list of names of all the CustomObject or Layout components in your org, then use this information in a retrieve command that returns a subset of these components.\n\nThe username that you use to connect to the org must have the Modify All Data or Modify Metadata Through Metadata API Functions permission.",
1287
- "strict": true,
1288
- "pluginName": "@salesforce/plugin-org",
1568
+ "hasDynamicHelp": true,
1569
+ "hiddenAliases": [],
1570
+ "id": "org:list:metadata-types",
1289
1571
  "pluginAlias": "@salesforce/plugin-org",
1572
+ "pluginName": "@salesforce/plugin-org",
1290
1573
  "pluginType": "core",
1574
+ "strict": true,
1575
+ "summary": "Display details about the metadata types that are enabled for your org.",
1576
+ "enableJsonFlag": true,
1577
+ "SF_ENV": "SF_ENV",
1578
+ "isESM": true,
1579
+ "relativePath": [
1580
+ "lib",
1581
+ "commands",
1582
+ "org",
1583
+ "list",
1584
+ "metadata-types.js"
1585
+ ],
1586
+ "aliasPermutations": [
1587
+ "force:mdapi:describemetadata",
1588
+ "mdapi:force:describemetadata",
1589
+ "mdapi:describemetadata:force",
1590
+ "force:describemetadata:mdapi",
1591
+ "describemetadata:force:mdapi",
1592
+ "describemetadata:mdapi:force"
1593
+ ],
1594
+ "permutations": [
1595
+ "org:list:metadata-types",
1596
+ "list:org:metadata-types",
1597
+ "list:metadata-types:org",
1598
+ "org:metadata-types:list",
1599
+ "metadata-types:org:list",
1600
+ "metadata-types:list:org"
1601
+ ]
1602
+ },
1603
+ "org:list:metadata": {
1291
1604
  "aliases": [
1292
1605
  "force:mdapi:listmetadata"
1293
1606
  ],
1607
+ "args": {},
1608
+ "deprecateAliases": true,
1609
+ "description": "Use this command to identify individual components in your manifest file or if you want a high-level view of particular metadata types in your org. For example, you can use this command to return a list of names of all the CustomObject or Layout components in your org, then use this information in a retrieve command that returns a subset of these components.\n\nThe username that you use to connect to the org must have the Modify All Data or Modify Metadata Through Metadata API Functions permission.",
1294
1610
  "examples": [
1295
1611
  "List the CustomObject components, and their properties, in the org with alias \"my-dev-org\":\n$ <%= config.bin %> <%= command.id %> --metadata-type CustomObject --target-org my-dev-org",
1296
1612
  "List the CustomObject components in your default org, write the output to the specified file, and use API version 57.0:\n$ <%= config.bin %> <%= command.id %> --metadata-type CustomObject --api-version 57.0 --output-file /path/to/outputfilename.txt",
1297
1613
  "List the Dashboard components in your default org that are contained in the \"folderSales\" folder, write the output to the specified file, and use API version 57.0:\n$ <%= config.bin %> <%= command.id %> --metadata-type Dashboard --folder folderSales --api-version 57.0 --output-file /path/to/outputfilename.txt"
1298
1614
  ],
1299
- "deprecateAliases": true,
1300
1615
  "flags": {
1301
1616
  "json": {
1302
- "name": "json",
1303
- "type": "boolean",
1304
1617
  "description": "Format output as json.",
1305
1618
  "helpGroup": "GLOBAL",
1619
+ "name": "json",
1306
1620
  "allowNo": false,
1307
- "deprecateAliases": true
1621
+ "type": "boolean"
1308
1622
  },
1309
1623
  "api-version": {
1310
- "name": "api-version",
1311
- "type": "option",
1312
- "summary": "API version to use; default is the most recent API version.",
1313
- "description": "Override the api version used for api requests made by this command",
1314
- "multiple": false,
1315
- "deprecateAliases": true,
1316
1624
  "aliases": [
1317
1625
  "apiversion",
1318
1626
  "a"
1319
- ]
1627
+ ],
1628
+ "deprecateAliases": true,
1629
+ "description": "Override the api version used for api requests made by this command",
1630
+ "name": "api-version",
1631
+ "summary": "API version to use; default is the most recent API version.",
1632
+ "hasDynamicHelp": false,
1633
+ "multiple": false,
1634
+ "type": "option"
1320
1635
  },
1321
1636
  "loglevel": {
1322
- "name": "loglevel",
1323
- "type": "option",
1324
- "hidden": true,
1325
- "multiple": false,
1326
1637
  "deprecated": {
1327
1638
  "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."
1328
1639
  },
1329
- "deprecateAliases": true
1640
+ "hidden": true,
1641
+ "name": "loglevel",
1642
+ "hasDynamicHelp": false,
1643
+ "multiple": false,
1644
+ "type": "option"
1330
1645
  },
1331
1646
  "target-org": {
1332
- "name": "target-org",
1333
- "type": "option",
1334
- "char": "o",
1335
- "summary": "Username or alias of the target org.",
1336
- "required": true,
1337
- "multiple": false,
1338
- "deprecateAliases": true,
1339
1647
  "aliases": [
1340
1648
  "targetusername",
1341
1649
  "u"
1342
- ]
1650
+ ],
1651
+ "char": "o",
1652
+ "deprecateAliases": true,
1653
+ "name": "target-org",
1654
+ "noCacheDefault": true,
1655
+ "required": true,
1656
+ "summary": "Username or alias of the target org.",
1657
+ "hasDynamicHelp": true,
1658
+ "multiple": false,
1659
+ "type": "option"
1343
1660
  },
1344
1661
  "output-file": {
1345
- "name": "output-file",
1346
- "type": "option",
1662
+ "aliases": [
1663
+ "resultfile"
1664
+ ],
1347
1665
  "char": "f",
1666
+ "deprecateAliases": true,
1667
+ "name": "output-file",
1348
1668
  "summary": "Pathname of the file in which to write the results.",
1669
+ "hasDynamicHelp": false,
1349
1670
  "multiple": false,
1350
- "deprecateAliases": true,
1351
- "aliases": [
1352
- "resultfile"
1353
- ]
1671
+ "type": "option"
1354
1672
  },
1355
1673
  "metadata-type": {
1356
- "name": "metadata-type",
1357
- "type": "option",
1674
+ "aliases": [
1675
+ "metadatatype"
1676
+ ],
1358
1677
  "char": "m",
1359
- "summary": "Metadata type to be retrieved, such as CustomObject; metadata type names are case-sensitive.",
1678
+ "deprecateAliases": true,
1679
+ "name": "metadata-type",
1360
1680
  "required": true,
1681
+ "summary": "Metadata type to be retrieved, such as CustomObject; metadata type names are case-sensitive.",
1682
+ "hasDynamicHelp": false,
1361
1683
  "multiple": false,
1362
- "deprecateAliases": true,
1363
- "aliases": [
1364
- "metadatatype"
1365
- ]
1684
+ "type": "option"
1366
1685
  },
1367
1686
  "folder": {
1687
+ "description": "Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.",
1368
1688
  "name": "folder",
1369
- "type": "option",
1370
1689
  "summary": "Folder associated with the component; required for components that use folders; folder names are case-sensitive.",
1371
- "description": "Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.",
1690
+ "hasDynamicHelp": false,
1372
1691
  "multiple": false,
1373
- "deprecateAliases": true
1692
+ "type": "option"
1374
1693
  }
1375
1694
  },
1376
- "args": {},
1377
- "hasDynamicHelp": true
1378
- },
1379
- "org:resume:sandbox": {
1380
- "id": "org:resume:sandbox",
1381
- "summary": "Check the status of a sandbox creation, and log in to it if it's ready.",
1382
- "description": "Sandbox creation can take a long time. If the original \"<%= config.bin %> org create sandbox\" command either times out, or you specified the --async flag, the command displays a job ID. Use this job ID to check whether the sandbox creation is complete, and if it is, the command then logs into it.\n\nYou can also use the sandbox name to check the status or the --use-most-recent flag to use the job ID of the most recent sandbox creation.",
1383
- "strict": true,
1384
- "pluginName": "@salesforce/plugin-org",
1695
+ "hasDynamicHelp": true,
1696
+ "hiddenAliases": [],
1697
+ "id": "org:list:metadata",
1385
1698
  "pluginAlias": "@salesforce/plugin-org",
1699
+ "pluginName": "@salesforce/plugin-org",
1386
1700
  "pluginType": "core",
1701
+ "strict": true,
1702
+ "summary": "List the metadata components and properties of a specified type.",
1703
+ "enableJsonFlag": true,
1704
+ "SF_ENV": "SF_ENV",
1705
+ "isESM": true,
1706
+ "relativePath": [
1707
+ "lib",
1708
+ "commands",
1709
+ "org",
1710
+ "list",
1711
+ "metadata.js"
1712
+ ],
1713
+ "aliasPermutations": [
1714
+ "force:mdapi:listmetadata",
1715
+ "mdapi:force:listmetadata",
1716
+ "mdapi:listmetadata:force",
1717
+ "force:listmetadata:mdapi",
1718
+ "listmetadata:force:mdapi",
1719
+ "listmetadata:mdapi:force"
1720
+ ],
1721
+ "permutations": [
1722
+ "org:list:metadata",
1723
+ "list:org:metadata",
1724
+ "list:metadata:org",
1725
+ "org:metadata:list",
1726
+ "metadata:org:list",
1727
+ "metadata:list:org"
1728
+ ]
1729
+ },
1730
+ "org:resume:sandbox": {
1387
1731
  "aliases": [
1388
1732
  "env:resume:sandbox"
1389
1733
  ],
1734
+ "args": {},
1735
+ "deprecateAliases": true,
1736
+ "description": "Sandbox creation can take a long time. If the original \"<%= config.bin %> org create sandbox\" command either times out, or you specified the --async flag, the command displays a job ID. Use this job ID to check whether the sandbox creation is complete, and if it is, the command then logs into it.\n\nYou can also use the sandbox name to check the status or the --use-most-recent flag to use the job ID of the most recent sandbox creation.",
1390
1737
  "examples": [
1391
1738
  "Check the status of a sandbox creation using its name and specify a production org with alias \"prodOrg\":\n<%= config.bin %> <%= command.id %> --name mysandbox --target-org prodOrg",
1392
1739
  "Check the status using the job ID:\n<%= config.bin %> <%= command.id %> --job-id 0GRxxxxxxxx",
1393
1740
  "Check the status of the most recent sandbox create request:\n<%= config.bin %> <%= command.id %> --use-most-recent"
1394
1741
  ],
1395
- "deprecateAliases": true,
1396
1742
  "flags": {
1397
1743
  "json": {
1398
- "name": "json",
1399
- "type": "boolean",
1400
1744
  "description": "Format output as json.",
1401
1745
  "helpGroup": "GLOBAL",
1746
+ "name": "json",
1402
1747
  "allowNo": false,
1403
- "deprecateAliases": true
1748
+ "type": "boolean"
1404
1749
  },
1405
1750
  "wait": {
1406
- "name": "wait",
1407
- "type": "option",
1408
1751
  "char": "w",
1409
- "summary": "Number of minutes to wait for the sandbox org to be ready.",
1410
1752
  "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 checking the sandbox creation, rerun this command.",
1753
+ "name": "wait",
1754
+ "summary": "Number of minutes to wait for the sandbox org to be ready.",
1755
+ "hasDynamicHelp": false,
1411
1756
  "helpValue": "<minutes>",
1412
1757
  "multiple": false,
1413
- "deprecateAliases": true
1758
+ "type": "option"
1414
1759
  },
1415
1760
  "name": {
1416
- "name": "name",
1417
- "type": "option",
1418
1761
  "char": "n",
1419
- "summary": "Name of the sandbox org.",
1420
- "multiple": false,
1421
1762
  "exclusive": [
1422
1763
  "job-id"
1423
1764
  ],
1424
- "deprecateAliases": true
1765
+ "name": "name",
1766
+ "summary": "Name of the sandbox org.",
1767
+ "hasDynamicHelp": false,
1768
+ "multiple": false,
1769
+ "type": "option"
1425
1770
  },
1426
1771
  "job-id": {
1427
- "name": "job-id",
1428
- "type": "option",
1429
1772
  "char": "i",
1430
- "summary": "Job ID of the incomplete sandbox creation that you want to check the status of.",
1431
1773
  "description": "The job ID is valid for 24 hours after you start the sandbox creation.",
1432
- "multiple": false,
1433
1774
  "exclusive": [
1434
1775
  "name"
1435
1776
  ],
1436
- "deprecateAliases": true
1777
+ "name": "job-id",
1778
+ "summary": "Job ID of the incomplete sandbox creation that you want to check the status of.",
1779
+ "hasDynamicHelp": false,
1780
+ "multiple": false,
1781
+ "type": "option"
1437
1782
  },
1438
1783
  "use-most-recent": {
1439
- "name": "use-most-recent",
1440
- "type": "boolean",
1441
1784
  "char": "l",
1785
+ "name": "use-most-recent",
1442
1786
  "summary": "Use the most recent sandbox create request.",
1443
1787
  "allowNo": false,
1444
- "deprecateAliases": true
1788
+ "type": "boolean"
1445
1789
  },
1446
1790
  "target-org": {
1447
- "name": "target-org",
1448
- "type": "option",
1449
1791
  "char": "o",
1450
- "summary": "Username or alias of the production org that contains the sandbox license.",
1451
1792
  "description": "When it creates the sandbox org, Salesforce copies the metadata, and optionally data, from your production org to the new sandbox org.",
1793
+ "name": "target-org",
1794
+ "noCacheDefault": true,
1795
+ "summary": "Username or alias of the production org that contains the sandbox license.",
1796
+ "hasDynamicHelp": true,
1452
1797
  "multiple": false,
1453
- "deprecateAliases": true
1798
+ "type": "option"
1454
1799
  }
1455
1800
  },
1456
- "args": {},
1457
- "hasDynamicHelp": true
1458
- },
1459
- "org:resume:scratch": {
1460
- "id": "org:resume:scratch",
1461
- "summary": "Resume the creation of an incomplete scratch org.",
1462
- "description": "When the original \"<%= config.bin %> org create scratch\" command either times out or is run with the --async flag, it displays a job ID.\n\nRun this command by either passing it a job ID or using the --use-most-recent flag to specify the most recent incomplete scratch org.",
1463
- "strict": true,
1464
- "pluginName": "@salesforce/plugin-org",
1801
+ "hasDynamicHelp": true,
1802
+ "hiddenAliases": [],
1803
+ "id": "org:resume:sandbox",
1465
1804
  "pluginAlias": "@salesforce/plugin-org",
1805
+ "pluginName": "@salesforce/plugin-org",
1466
1806
  "pluginType": "core",
1807
+ "strict": true,
1808
+ "summary": "Check the status of a sandbox creation, and log in to it if it's ready.",
1809
+ "isESM": true,
1810
+ "relativePath": [
1811
+ "lib",
1812
+ "commands",
1813
+ "org",
1814
+ "resume",
1815
+ "sandbox.js"
1816
+ ],
1817
+ "aliasPermutations": [
1818
+ "env:resume:sandbox",
1819
+ "resume:env:sandbox",
1820
+ "resume:sandbox:env",
1821
+ "env:sandbox:resume",
1822
+ "sandbox:env:resume",
1823
+ "sandbox:resume:env"
1824
+ ],
1825
+ "permutations": [
1826
+ "org:resume:sandbox",
1827
+ "resume:org:sandbox",
1828
+ "resume:sandbox:org",
1829
+ "org:sandbox:resume",
1830
+ "sandbox:org:resume",
1831
+ "sandbox:resume:org"
1832
+ ]
1833
+ },
1834
+ "org:resume:scratch": {
1467
1835
  "aliases": [
1468
1836
  "env:resume:scratch"
1469
1837
  ],
1838
+ "args": {},
1839
+ "deprecateAliases": true,
1840
+ "description": "When the original \"<%= config.bin %> org create scratch\" command either times out or is run with the --async flag, it displays a job ID.\n\nRun this command by either passing it a job ID or using the --use-most-recent flag to specify the most recent incomplete scratch org.",
1470
1841
  "examples": [
1471
1842
  "Resume a scratch org create with a job ID:\n<%= config.bin %> <%= command.id %> --job-id 2SR3u0000008fBDGAY",
1472
1843
  "Resume your most recent incomplete scratch org:\n<%= config.bin %> <%= command.id %> --use-most-recent"
1473
1844
  ],
1474
- "deprecateAliases": true,
1475
1845
  "flags": {
1476
1846
  "json": {
1477
- "name": "json",
1478
- "type": "boolean",
1479
1847
  "description": "Format output as json.",
1480
1848
  "helpGroup": "GLOBAL",
1849
+ "name": "json",
1481
1850
  "allowNo": false,
1482
- "deprecateAliases": true
1851
+ "type": "boolean"
1483
1852
  },
1484
1853
  "job-id": {
1485
- "name": "job-id",
1486
- "type": "option",
1487
1854
  "char": "i",
1488
- "summary": "Job ID of the incomplete scratch org create that you want to resume.",
1489
1855
  "description": "The job ID is the same as the record ID of the incomplete scratch org in the ScratchOrgInfo object of the Dev Hub.\n\nThe job ID is valid for 24 hours after you start the scratch org creation.",
1856
+ "name": "job-id",
1857
+ "summary": "Job ID of the incomplete scratch org create that you want to resume.",
1858
+ "hasDynamicHelp": false,
1490
1859
  "multiple": false,
1491
- "deprecateAliases": true
1860
+ "type": "option"
1492
1861
  },
1493
1862
  "use-most-recent": {
1494
- "name": "use-most-recent",
1495
- "type": "boolean",
1496
1863
  "char": "r",
1864
+ "name": "use-most-recent",
1497
1865
  "summary": "Use the job ID of the most recent incomplete scratch org.",
1498
1866
  "allowNo": false,
1499
- "deprecateAliases": true
1867
+ "type": "boolean"
1500
1868
  }
1501
1869
  },
1502
- "args": {}
1870
+ "hasDynamicHelp": false,
1871
+ "hiddenAliases": [],
1872
+ "id": "org:resume:scratch",
1873
+ "pluginAlias": "@salesforce/plugin-org",
1874
+ "pluginName": "@salesforce/plugin-org",
1875
+ "pluginType": "core",
1876
+ "strict": true,
1877
+ "summary": "Resume the creation of an incomplete scratch org.",
1878
+ "enableJsonFlag": true,
1879
+ "SF_ENV": "SF_ENV",
1880
+ "isESM": true,
1881
+ "relativePath": [
1882
+ "lib",
1883
+ "commands",
1884
+ "org",
1885
+ "resume",
1886
+ "scratch.js"
1887
+ ],
1888
+ "aliasPermutations": [
1889
+ "env:resume:scratch",
1890
+ "resume:env:scratch",
1891
+ "resume:scratch:env",
1892
+ "env:scratch:resume",
1893
+ "scratch:env:resume",
1894
+ "scratch:resume:env"
1895
+ ],
1896
+ "permutations": [
1897
+ "org:resume:scratch",
1898
+ "resume:org:scratch",
1899
+ "resume:scratch:org",
1900
+ "org:scratch:resume",
1901
+ "scratch:org:resume",
1902
+ "scratch:resume:org"
1903
+ ]
1503
1904
  }
1504
- }
1905
+ },
1906
+ "version": "3.0.1"
1505
1907
  }