@salesforce/cli 1.65.0 → 1.66.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.
- package/npm-shrinkwrap.json +2305 -1848
- package/oclif.manifest.json +3724 -2
- package/package.json +40 -42
package/oclif.manifest.json
CHANGED
|
@@ -1,4 +1,3726 @@
|
|
|
1
1
|
{
|
|
2
|
-
"version": "1.
|
|
3
|
-
"commands": {
|
|
2
|
+
"version": "1.66.1",
|
|
3
|
+
"commands": {
|
|
4
|
+
"cmdt:generate:field": {
|
|
5
|
+
"id": "cmdt:generate:field",
|
|
6
|
+
"summary": "Generate a field for a custom metadata type based on the provided field type.",
|
|
7
|
+
"description": "Similar to a custom object, a custom metadata type has a list of custom fields that represent aspects of the metadata.\n\nThis command creates a metadata file that describes the new custom metadata type field. By default, the file is created in a \"fields\" directory in the current directory. Use the --output-directory to generate the file in the directory that contains the custom metadata type metdata files, such as \"force-app/main/default/objects/MyCmdt__mdt\" for the custom metadata type called MyCmdt.",
|
|
8
|
+
"strict": true,
|
|
9
|
+
"pluginName": "@salesforce/plugin-custom-metadata",
|
|
10
|
+
"pluginAlias": "@salesforce/plugin-custom-metadata",
|
|
11
|
+
"pluginType": "jit",
|
|
12
|
+
"aliases": [
|
|
13
|
+
"force:cmdt:field:create",
|
|
14
|
+
"cmdt:field:create"
|
|
15
|
+
],
|
|
16
|
+
"examples": [
|
|
17
|
+
"Generate a metadata file for a custom checkbox field and add the file to the MyCmdt__mdt/fields directory:\n<%= config.bin %> <%= command.id %> --name MyCheckboxField --type Checkbox --output-directory force-app/main/default/objects/MyCmdt__mdt",
|
|
18
|
+
"Generate a metadata file for a custom picklist field and add a few values:\n<%= config.bin %> <%= command.id %> --name MyPicklistField --type Picklist --picklist-values A --picklist-values B --picklist-values C --output-directory force-app/main/default/objects/MyCmdt__mdt",
|
|
19
|
+
"Generate a metadata file for a custom number field and specify 2 decimal places:\n<%= config.bin %> <%= command.id %> --name MyNumberField --type Number --decimal-places 2 --output-directory force-app/main/default/objects/MyCmdt__mdt"
|
|
20
|
+
],
|
|
21
|
+
"flags": {
|
|
22
|
+
"json": {
|
|
23
|
+
"name": "json",
|
|
24
|
+
"type": "boolean",
|
|
25
|
+
"description": "Format output as json.",
|
|
26
|
+
"helpGroup": "GLOBAL",
|
|
27
|
+
"allowNo": false
|
|
28
|
+
},
|
|
29
|
+
"loglevel": {
|
|
30
|
+
"name": "loglevel",
|
|
31
|
+
"type": "option",
|
|
32
|
+
"hidden": true,
|
|
33
|
+
"multiple": false,
|
|
34
|
+
"deprecated": {
|
|
35
|
+
"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."
|
|
36
|
+
}
|
|
37
|
+
},
|
|
38
|
+
"name": {
|
|
39
|
+
"name": "name",
|
|
40
|
+
"type": "option",
|
|
41
|
+
"char": "n",
|
|
42
|
+
"summary": "Unique name for the field.",
|
|
43
|
+
"required": true,
|
|
44
|
+
"multiple": false,
|
|
45
|
+
"aliases": [
|
|
46
|
+
"fieldname"
|
|
47
|
+
]
|
|
48
|
+
},
|
|
49
|
+
"type": {
|
|
50
|
+
"name": "type",
|
|
51
|
+
"type": "option",
|
|
52
|
+
"char": "f",
|
|
53
|
+
"summary": "Type of the field.",
|
|
54
|
+
"description": "You can't use this command to create a custom metadata type field of type \"Metadata Relationship\". Use the Salesforce Setup UI instead.",
|
|
55
|
+
"required": true,
|
|
56
|
+
"multiple": false,
|
|
57
|
+
"options": [
|
|
58
|
+
"Checkbox",
|
|
59
|
+
"Date",
|
|
60
|
+
"DateTime",
|
|
61
|
+
"Email",
|
|
62
|
+
"Number",
|
|
63
|
+
"Percent",
|
|
64
|
+
"Phone",
|
|
65
|
+
"Picklist",
|
|
66
|
+
"Text",
|
|
67
|
+
"TextArea",
|
|
68
|
+
"LongTextArea",
|
|
69
|
+
"Url"
|
|
70
|
+
],
|
|
71
|
+
"aliases": [
|
|
72
|
+
"fieldtype"
|
|
73
|
+
]
|
|
74
|
+
},
|
|
75
|
+
"picklist-values": {
|
|
76
|
+
"name": "picklist-values",
|
|
77
|
+
"type": "option",
|
|
78
|
+
"char": "p",
|
|
79
|
+
"summary": "Picklist values; required for picklist fields.",
|
|
80
|
+
"multiple": true,
|
|
81
|
+
"aliases": [
|
|
82
|
+
"picklistvalues"
|
|
83
|
+
],
|
|
84
|
+
"delimiter": ","
|
|
85
|
+
},
|
|
86
|
+
"decimal-places": {
|
|
87
|
+
"name": "decimal-places",
|
|
88
|
+
"type": "option",
|
|
89
|
+
"char": "s",
|
|
90
|
+
"summary": "Number of decimal places to use for number or percent fields.",
|
|
91
|
+
"description": "The value must be greater than or equal to zero. Default value is 0.",
|
|
92
|
+
"multiple": false,
|
|
93
|
+
"default": 0,
|
|
94
|
+
"aliases": [
|
|
95
|
+
"decimalplaces"
|
|
96
|
+
]
|
|
97
|
+
},
|
|
98
|
+
"label": {
|
|
99
|
+
"name": "label",
|
|
100
|
+
"type": "option",
|
|
101
|
+
"char": "l",
|
|
102
|
+
"summary": "Label for the field.",
|
|
103
|
+
"multiple": false
|
|
104
|
+
},
|
|
105
|
+
"output-directory": {
|
|
106
|
+
"name": "output-directory",
|
|
107
|
+
"type": "option",
|
|
108
|
+
"char": "d",
|
|
109
|
+
"summary": "Directory to store newly-created field definition files.",
|
|
110
|
+
"description": "New files are automatically created in the \"fields\" directory. The location can be an absolute path or relative to the current working directory. The default is the current directory.",
|
|
111
|
+
"multiple": false,
|
|
112
|
+
"default": "",
|
|
113
|
+
"aliases": [
|
|
114
|
+
"outputdir",
|
|
115
|
+
"outputdirectory"
|
|
116
|
+
]
|
|
117
|
+
}
|
|
118
|
+
},
|
|
119
|
+
"args": {},
|
|
120
|
+
"requiresProject": true
|
|
121
|
+
},
|
|
122
|
+
"cmdt:generate:fromorg": {
|
|
123
|
+
"id": "cmdt:generate:fromorg",
|
|
124
|
+
"summary": "Generate a custom metadata type and all its records from a Salesforce object.",
|
|
125
|
+
"description": "Use this command to migrate existing custom objects or custom settings in an org to custom metadata types. If a field of the Salesforce object is of an unsupported type, the field type is automatically converted to text. Run \"<%= config.bin %> cmdt generate field --help\" to see the list of supported cmdt field types, listed in the --type flag summary. Use the --ignore-unsupported to ignore these fields.\n\nThis command creates the metadata files that describe the new custom metadata type and its fields in the \"force-app/main/default/objects/TypeName__mdt\" directory by default, where \"TypeName\" is the value of the required --dev-name flag. Use --type-output-directory to create them in a different directory.",
|
|
126
|
+
"strict": true,
|
|
127
|
+
"pluginName": "@salesforce/plugin-custom-metadata",
|
|
128
|
+
"pluginAlias": "@salesforce/plugin-custom-metadata",
|
|
129
|
+
"pluginType": "jit",
|
|
130
|
+
"aliases": [
|
|
131
|
+
"force:cmdt:generate"
|
|
132
|
+
],
|
|
133
|
+
"examples": [
|
|
134
|
+
"Generate a custom metadata type from a custom object called MySourceObject__c in your default org:\n<%= config.bin %> <%= command.id %> --dev-name MyCMDT --sobject MySourceObject__c",
|
|
135
|
+
"Generate a custom metadata type from a custom object in an org with alias my-scratch-org; ignore unsupported field types instead of converting them to text:\n<%= config.bin %> <%= command.id %> --dev-name MyCMDT --sobject MySourceObject__c --ignore-unsupported --target-org my-scratch-org",
|
|
136
|
+
"Generate a protected custom metadata type from a custom object:\n<%= config.bin %> <%= command.id %> --dev-name MyCMDT --sobject MySourceObject__c --visibility Protected",
|
|
137
|
+
"Generate a protected custom metadata type from a custom setting with a specific singular and plural label:\n<%= config.bin %> <%= command.id %> --dev-name MyCMDT --label \"My CMDT\" --plural-label \"My CMDTs\" --sobject MySourceSetting__c --visibility Protected",
|
|
138
|
+
"Generate a custom metadata type and put the resulting metadata files in the specified directory:\n<%= config.bin %> <%= command.id %> --dev-name MyCMDT --sobject MySourceObject__c --type-output-directory path/to/my/cmdt/directory",
|
|
139
|
+
"Generate a custom metadata type and put the resulting record metadata file(s) in the specified directory:\n<%= config.bin %> <%= command.id %> --dev-name MyCMDT --sobject MySourceObject__c --records-output-dir path/to/my/cmdt/record/directory"
|
|
140
|
+
],
|
|
141
|
+
"flags": {
|
|
142
|
+
"json": {
|
|
143
|
+
"name": "json",
|
|
144
|
+
"type": "boolean",
|
|
145
|
+
"description": "Format output as json.",
|
|
146
|
+
"helpGroup": "GLOBAL",
|
|
147
|
+
"allowNo": false
|
|
148
|
+
},
|
|
149
|
+
"target-org": {
|
|
150
|
+
"name": "target-org",
|
|
151
|
+
"type": "option",
|
|
152
|
+
"char": "o",
|
|
153
|
+
"summary": "Username or alias of the target org.",
|
|
154
|
+
"required": true,
|
|
155
|
+
"multiple": false,
|
|
156
|
+
"aliases": [
|
|
157
|
+
"targetusername",
|
|
158
|
+
"u"
|
|
159
|
+
]
|
|
160
|
+
},
|
|
161
|
+
"api-version": {
|
|
162
|
+
"name": "api-version",
|
|
163
|
+
"type": "option",
|
|
164
|
+
"description": "Override the api version used for api requests made by this command",
|
|
165
|
+
"multiple": false,
|
|
166
|
+
"aliases": [
|
|
167
|
+
"apiversion"
|
|
168
|
+
]
|
|
169
|
+
},
|
|
170
|
+
"loglevel": {
|
|
171
|
+
"name": "loglevel",
|
|
172
|
+
"type": "option",
|
|
173
|
+
"hidden": true,
|
|
174
|
+
"multiple": false,
|
|
175
|
+
"deprecated": {
|
|
176
|
+
"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."
|
|
177
|
+
}
|
|
178
|
+
},
|
|
179
|
+
"dev-name": {
|
|
180
|
+
"name": "dev-name",
|
|
181
|
+
"type": "option",
|
|
182
|
+
"char": "n",
|
|
183
|
+
"summary": "Name of the custom metadata type.",
|
|
184
|
+
"required": true,
|
|
185
|
+
"multiple": false,
|
|
186
|
+
"aliases": [
|
|
187
|
+
"devname"
|
|
188
|
+
]
|
|
189
|
+
},
|
|
190
|
+
"label": {
|
|
191
|
+
"name": "label",
|
|
192
|
+
"type": "option",
|
|
193
|
+
"char": "l",
|
|
194
|
+
"summary": "Label for the custom metadata type.",
|
|
195
|
+
"multiple": false
|
|
196
|
+
},
|
|
197
|
+
"plural-label": {
|
|
198
|
+
"name": "plural-label",
|
|
199
|
+
"type": "option",
|
|
200
|
+
"char": "p",
|
|
201
|
+
"summary": "Plural version of the label value; if blank, uses label.",
|
|
202
|
+
"multiple": false,
|
|
203
|
+
"aliases": [
|
|
204
|
+
"plurallabel"
|
|
205
|
+
]
|
|
206
|
+
},
|
|
207
|
+
"visibility": {
|
|
208
|
+
"name": "visibility",
|
|
209
|
+
"type": "option",
|
|
210
|
+
"char": "v",
|
|
211
|
+
"summary": "Who can see the custom metadata type.",
|
|
212
|
+
"description": "For more information on what each option means, see this topic in Salesforce Help: https://help.salesforce.com/s/articleView?id=sf.custommetadatatypes_ui_create.htm&type=5.",
|
|
213
|
+
"multiple": false,
|
|
214
|
+
"options": [
|
|
215
|
+
"PackageProtected",
|
|
216
|
+
"Protected",
|
|
217
|
+
"Public"
|
|
218
|
+
],
|
|
219
|
+
"default": "Public"
|
|
220
|
+
},
|
|
221
|
+
"sobject": {
|
|
222
|
+
"name": "sobject",
|
|
223
|
+
"type": "option",
|
|
224
|
+
"char": "s",
|
|
225
|
+
"summary": "API name of the source Salesforce object used to generate the custom metadata type.",
|
|
226
|
+
"required": true,
|
|
227
|
+
"multiple": false,
|
|
228
|
+
"aliases": [
|
|
229
|
+
"sobjectname"
|
|
230
|
+
]
|
|
231
|
+
},
|
|
232
|
+
"ignore-unsupported": {
|
|
233
|
+
"name": "ignore-unsupported",
|
|
234
|
+
"type": "boolean",
|
|
235
|
+
"char": "i",
|
|
236
|
+
"summary": "Ignore unsupported field types.",
|
|
237
|
+
"description": "In this context, \"ignore\" means that the fields aren't created. The default behavior is to create fields of type text and convert the field values to text.",
|
|
238
|
+
"allowNo": false,
|
|
239
|
+
"aliases": [
|
|
240
|
+
"ignoreunsupported"
|
|
241
|
+
]
|
|
242
|
+
},
|
|
243
|
+
"type-output-directory": {
|
|
244
|
+
"name": "type-output-directory",
|
|
245
|
+
"type": "option",
|
|
246
|
+
"char": "d",
|
|
247
|
+
"summary": "Directory to store newly-created custom metadata type files.",
|
|
248
|
+
"multiple": false,
|
|
249
|
+
"default": "force-app/main/default/objects",
|
|
250
|
+
"aliases": [
|
|
251
|
+
"typeoutputdir"
|
|
252
|
+
]
|
|
253
|
+
},
|
|
254
|
+
"records-output-dir": {
|
|
255
|
+
"name": "records-output-dir",
|
|
256
|
+
"type": "option",
|
|
257
|
+
"char": "r",
|
|
258
|
+
"summary": "Directory to store newly-created custom metadata record files.",
|
|
259
|
+
"multiple": false,
|
|
260
|
+
"default": "force-app/main/default/customMetadata",
|
|
261
|
+
"aliases": [
|
|
262
|
+
"recordsoutputdir"
|
|
263
|
+
]
|
|
264
|
+
}
|
|
265
|
+
},
|
|
266
|
+
"args": {},
|
|
267
|
+
"requiresProject": true,
|
|
268
|
+
"hasDynamicHelp": true
|
|
269
|
+
},
|
|
270
|
+
"cmdt:generate:object": {
|
|
271
|
+
"id": "cmdt:generate:object",
|
|
272
|
+
"summary": "Generate a new custom metadata type in the current project.",
|
|
273
|
+
"description": "This command creates a metadata file that describes the new custom metadata type. By default, the file is created in the MyCustomType__mdt directory in the current directory, where MyCustomType is the value of the required --type-name flag. Use the --output-directory to generate the file in a package directory with other custom metadata types, such as \"force-app/main/default/objects\".",
|
|
274
|
+
"strict": true,
|
|
275
|
+
"pluginName": "@salesforce/plugin-custom-metadata",
|
|
276
|
+
"pluginAlias": "@salesforce/plugin-custom-metadata",
|
|
277
|
+
"pluginType": "jit",
|
|
278
|
+
"aliases": [
|
|
279
|
+
"force:cmdt:create",
|
|
280
|
+
"cmdt:create"
|
|
281
|
+
],
|
|
282
|
+
"examples": [
|
|
283
|
+
"Generate a custom metadata type with developer name 'MyCustomType'; this name is also used as the label:\n<%= config.bin %> <%= command.id %> --type-name MyCustomType",
|
|
284
|
+
"Generate a protected custom metadata type with a specific label:\n<%= config.bin %> <%= command.id %> --type-name MyCustomType --label \"Custom Type\" --plural-label \"Custom Types\" --visibility Protected"
|
|
285
|
+
],
|
|
286
|
+
"flags": {
|
|
287
|
+
"json": {
|
|
288
|
+
"name": "json",
|
|
289
|
+
"type": "boolean",
|
|
290
|
+
"description": "Format output as json.",
|
|
291
|
+
"helpGroup": "GLOBAL",
|
|
292
|
+
"allowNo": false
|
|
293
|
+
},
|
|
294
|
+
"loglevel": {
|
|
295
|
+
"name": "loglevel",
|
|
296
|
+
"type": "option",
|
|
297
|
+
"hidden": true,
|
|
298
|
+
"multiple": false,
|
|
299
|
+
"deprecated": {
|
|
300
|
+
"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."
|
|
301
|
+
}
|
|
302
|
+
},
|
|
303
|
+
"type-name": {
|
|
304
|
+
"name": "type-name",
|
|
305
|
+
"type": "option",
|
|
306
|
+
"char": "n",
|
|
307
|
+
"summary": "Unique object name for the custom metadata type.",
|
|
308
|
+
"description": "The name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.",
|
|
309
|
+
"required": true,
|
|
310
|
+
"multiple": false,
|
|
311
|
+
"aliases": [
|
|
312
|
+
"typename"
|
|
313
|
+
]
|
|
314
|
+
},
|
|
315
|
+
"label": {
|
|
316
|
+
"name": "label",
|
|
317
|
+
"type": "option",
|
|
318
|
+
"char": "l",
|
|
319
|
+
"summary": "Label for the custom metadata type.",
|
|
320
|
+
"multiple": false
|
|
321
|
+
},
|
|
322
|
+
"plural-label": {
|
|
323
|
+
"name": "plural-label",
|
|
324
|
+
"type": "option",
|
|
325
|
+
"char": "p",
|
|
326
|
+
"summary": "Plural version of the label value; if blank, uses label.",
|
|
327
|
+
"multiple": false,
|
|
328
|
+
"aliases": [
|
|
329
|
+
"plurallabel"
|
|
330
|
+
]
|
|
331
|
+
},
|
|
332
|
+
"visibility": {
|
|
333
|
+
"name": "visibility",
|
|
334
|
+
"type": "option",
|
|
335
|
+
"char": "v",
|
|
336
|
+
"summary": "Who can see the custom metadata type.",
|
|
337
|
+
"description": "For more information on what each option means, see this topic in Salesforce Help: https://help.salesforce.com/s/articleView?id=sf.custommetadatatypes_ui_create.htm&type=5.",
|
|
338
|
+
"multiple": false,
|
|
339
|
+
"options": [
|
|
340
|
+
"PackageProtected",
|
|
341
|
+
"Protected",
|
|
342
|
+
"Public"
|
|
343
|
+
],
|
|
344
|
+
"default": "Public"
|
|
345
|
+
},
|
|
346
|
+
"output-directory": {
|
|
347
|
+
"name": "output-directory",
|
|
348
|
+
"type": "option",
|
|
349
|
+
"char": "d",
|
|
350
|
+
"summary": "Directory to store the newly-created custom metadata type files",
|
|
351
|
+
"description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
|
|
352
|
+
"multiple": false,
|
|
353
|
+
"default": "",
|
|
354
|
+
"aliases": [
|
|
355
|
+
"outputdir",
|
|
356
|
+
"outputdirectory"
|
|
357
|
+
]
|
|
358
|
+
}
|
|
359
|
+
},
|
|
360
|
+
"args": {},
|
|
361
|
+
"requiresProject": true
|
|
362
|
+
},
|
|
363
|
+
"cmdt:generate:record": {
|
|
364
|
+
"id": "cmdt:generate:record",
|
|
365
|
+
"summary": "Generate a new record for a given custom metadata type in the current project.",
|
|
366
|
+
"description": "The custom metadata type must already exist in your project. You must specify a name for the new record. Use name=value pairs to specify the values for the fields, such as MyTextField=\"some text here\" or MyNumberField=32.",
|
|
367
|
+
"strict": false,
|
|
368
|
+
"pluginName": "@salesforce/plugin-custom-metadata",
|
|
369
|
+
"pluginAlias": "@salesforce/plugin-custom-metadata",
|
|
370
|
+
"pluginType": "jit",
|
|
371
|
+
"aliases": [
|
|
372
|
+
"force:cmdt:record:create",
|
|
373
|
+
"cmdt:record:create"
|
|
374
|
+
],
|
|
375
|
+
"examples": [
|
|
376
|
+
"Create a record metadata file for custom metadata type 'MyCMT' with specified values for two custom fields:\n<%= config.bin %> <%= command.id %> --type-name MyCMT__mdt --record-name MyRecord My_Custom_Field_1=Foo My_Custom_Field_2=Bar",
|
|
377
|
+
"Create a protected record metadata file for custom metadata type 'MyCMT' with a specific label and values specified for two custom fields:\n<%= config.bin %> <%= command.id %> --type-name MyCMT__mdt --record-name MyRecord --label \"My Record\" --protected true My_Custom_Field_1=Foo My_Custom_Field_2=Bar"
|
|
378
|
+
],
|
|
379
|
+
"flags": {
|
|
380
|
+
"json": {
|
|
381
|
+
"name": "json",
|
|
382
|
+
"type": "boolean",
|
|
383
|
+
"description": "Format output as json.",
|
|
384
|
+
"helpGroup": "GLOBAL",
|
|
385
|
+
"allowNo": false
|
|
386
|
+
},
|
|
387
|
+
"loglevel": {
|
|
388
|
+
"name": "loglevel",
|
|
389
|
+
"type": "option",
|
|
390
|
+
"hidden": true,
|
|
391
|
+
"multiple": false,
|
|
392
|
+
"deprecated": {
|
|
393
|
+
"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."
|
|
394
|
+
}
|
|
395
|
+
},
|
|
396
|
+
"type-name": {
|
|
397
|
+
"name": "type-name",
|
|
398
|
+
"type": "option",
|
|
399
|
+
"char": "t",
|
|
400
|
+
"summary": "API name of the custom metadata type to create a record for; must end in \"__mdt\".",
|
|
401
|
+
"required": true,
|
|
402
|
+
"multiple": false,
|
|
403
|
+
"aliases": [
|
|
404
|
+
"typename"
|
|
405
|
+
]
|
|
406
|
+
},
|
|
407
|
+
"record-name": {
|
|
408
|
+
"name": "record-name",
|
|
409
|
+
"type": "option",
|
|
410
|
+
"char": "n",
|
|
411
|
+
"summary": "Name of the new record.",
|
|
412
|
+
"required": true,
|
|
413
|
+
"multiple": false,
|
|
414
|
+
"aliases": [
|
|
415
|
+
"recordname"
|
|
416
|
+
]
|
|
417
|
+
},
|
|
418
|
+
"label": {
|
|
419
|
+
"name": "label",
|
|
420
|
+
"type": "option",
|
|
421
|
+
"char": "l",
|
|
422
|
+
"summary": "Label for the new record.",
|
|
423
|
+
"multiple": false
|
|
424
|
+
},
|
|
425
|
+
"protected": {
|
|
426
|
+
"name": "protected",
|
|
427
|
+
"type": "option",
|
|
428
|
+
"char": "p",
|
|
429
|
+
"summary": "Protect the record when it's in a managed package.",
|
|
430
|
+
"description": "Protected records can only be accessed by code in the same managed package namespace.",
|
|
431
|
+
"multiple": false,
|
|
432
|
+
"options": [
|
|
433
|
+
"true",
|
|
434
|
+
"false"
|
|
435
|
+
],
|
|
436
|
+
"default": "false"
|
|
437
|
+
},
|
|
438
|
+
"input-directory": {
|
|
439
|
+
"name": "input-directory",
|
|
440
|
+
"type": "option",
|
|
441
|
+
"char": "i",
|
|
442
|
+
"summary": "Directory from which to get the custom metadata type definition from.",
|
|
443
|
+
"multiple": false,
|
|
444
|
+
"default": "force-app/main/default/objects",
|
|
445
|
+
"aliases": [
|
|
446
|
+
"inputdir",
|
|
447
|
+
"inputdirectory"
|
|
448
|
+
]
|
|
449
|
+
},
|
|
450
|
+
"output-directory": {
|
|
451
|
+
"name": "output-directory",
|
|
452
|
+
"type": "option",
|
|
453
|
+
"char": "d",
|
|
454
|
+
"summary": "Directory to store newly-created custom metadata record files.",
|
|
455
|
+
"multiple": false,
|
|
456
|
+
"default": "force-app/main/default/customMetadata",
|
|
457
|
+
"aliases": [
|
|
458
|
+
"outputdir",
|
|
459
|
+
"outputdirectory"
|
|
460
|
+
]
|
|
461
|
+
}
|
|
462
|
+
},
|
|
463
|
+
"args": {},
|
|
464
|
+
"requiresProject": true
|
|
465
|
+
},
|
|
466
|
+
"cmdt:generate:records": {
|
|
467
|
+
"id": "cmdt:generate:records",
|
|
468
|
+
"summary": "Generate new custom metadata type records from a CSV file.",
|
|
469
|
+
"description": "The custom metadata type must already exist in your project. By default, the Name column is used to determine the record name; use the --name-column flag to specify a different column.",
|
|
470
|
+
"strict": true,
|
|
471
|
+
"pluginName": "@salesforce/plugin-custom-metadata",
|
|
472
|
+
"pluginAlias": "@salesforce/plugin-custom-metadata",
|
|
473
|
+
"pluginType": "jit",
|
|
474
|
+
"aliases": [
|
|
475
|
+
"force:cmdt:record:insert",
|
|
476
|
+
"cmdt:record:insert"
|
|
477
|
+
],
|
|
478
|
+
"examples": [
|
|
479
|
+
"Generate record metadata files from values in a CSV file for the custom metadata type MyCmdt. Use 'Name' as the column that specifies the record name:\n<%= config.bin %> <%= command.id %> --csv path/to/my.csv --type-name MyCmdt",
|
|
480
|
+
"Generate record metadata files from a CSV file in the directory different from the default, and use 'PrimaryKey' as the column that specifies the record name:\n<%= config.bin %> <%= command.id %> --csv path/to/my.csv --type-name MyCmdt --input-directory path/to/my/cmdt/directory --name-column \"PrimaryKey\""
|
|
481
|
+
],
|
|
482
|
+
"flags": {
|
|
483
|
+
"json": {
|
|
484
|
+
"name": "json",
|
|
485
|
+
"type": "boolean",
|
|
486
|
+
"description": "Format output as json.",
|
|
487
|
+
"helpGroup": "GLOBAL",
|
|
488
|
+
"allowNo": false
|
|
489
|
+
},
|
|
490
|
+
"loglevel": {
|
|
491
|
+
"name": "loglevel",
|
|
492
|
+
"type": "option",
|
|
493
|
+
"hidden": true,
|
|
494
|
+
"multiple": false,
|
|
495
|
+
"deprecated": {
|
|
496
|
+
"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."
|
|
497
|
+
}
|
|
498
|
+
},
|
|
499
|
+
"csv": {
|
|
500
|
+
"name": "csv",
|
|
501
|
+
"type": "option",
|
|
502
|
+
"char": "f",
|
|
503
|
+
"summary": "Pathname of the CSV file.",
|
|
504
|
+
"required": true,
|
|
505
|
+
"multiple": false,
|
|
506
|
+
"aliases": [
|
|
507
|
+
"filepath"
|
|
508
|
+
]
|
|
509
|
+
},
|
|
510
|
+
"type-name": {
|
|
511
|
+
"name": "type-name",
|
|
512
|
+
"type": "option",
|
|
513
|
+
"char": "t",
|
|
514
|
+
"summary": "API name of the custom metadata type to create a record for.",
|
|
515
|
+
"description": "The '__mdt' suffix is appended to the end of the name if it's omitted.",
|
|
516
|
+
"required": true,
|
|
517
|
+
"multiple": false,
|
|
518
|
+
"aliases": [
|
|
519
|
+
"typename"
|
|
520
|
+
]
|
|
521
|
+
},
|
|
522
|
+
"input-directory": {
|
|
523
|
+
"name": "input-directory",
|
|
524
|
+
"type": "option",
|
|
525
|
+
"char": "i",
|
|
526
|
+
"summary": "Directory from which to get the custom metadata type definition from.",
|
|
527
|
+
"multiple": false,
|
|
528
|
+
"default": "force-app/main/default/objects",
|
|
529
|
+
"aliases": [
|
|
530
|
+
"inputdir",
|
|
531
|
+
"inputdirectory"
|
|
532
|
+
]
|
|
533
|
+
},
|
|
534
|
+
"output-directory": {
|
|
535
|
+
"name": "output-directory",
|
|
536
|
+
"type": "option",
|
|
537
|
+
"char": "d",
|
|
538
|
+
"summary": "Directory to store newly-created custom metadata record files.",
|
|
539
|
+
"multiple": false,
|
|
540
|
+
"default": "force-app/main/default/customMetadata",
|
|
541
|
+
"aliases": [
|
|
542
|
+
"outputdir",
|
|
543
|
+
"outputdirectory"
|
|
544
|
+
]
|
|
545
|
+
},
|
|
546
|
+
"name-column": {
|
|
547
|
+
"name": "name-column",
|
|
548
|
+
"type": "option",
|
|
549
|
+
"char": "n",
|
|
550
|
+
"summary": "Column used to determine the name of the record.",
|
|
551
|
+
"multiple": false,
|
|
552
|
+
"default": "Name",
|
|
553
|
+
"aliases": [
|
|
554
|
+
"namecolumn"
|
|
555
|
+
]
|
|
556
|
+
}
|
|
557
|
+
},
|
|
558
|
+
"args": {},
|
|
559
|
+
"requiresProject": true
|
|
560
|
+
},
|
|
561
|
+
"community:create": {
|
|
562
|
+
"id": "community:create",
|
|
563
|
+
"summary": "Create an Experience Cloud site using a template.",
|
|
564
|
+
"description": "See 'Which Experience Cloud Template Should I Use?' (https://help.salesforce.com/s/articleView?id=sf.siteforce_commtemp_intro.htm&type=5) in Salesforce Help for more information about the different template\ntypes available for Experience Cloud.\n\nWhen creating a site with the Build Your Own (LWR) template, you must also specify the AuthenticationType value using the format templateParams.AuthenticationType=value, where value is AUTHENTICATED, UNAUTHENTICATED, or AUTHENTICATED_WITH_PUBLIC_ACCESS. Name and values are case-sensitive. See 'ExperienceBundle' in the Metadata API Developer Guide for more information. (https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_experiencebundle.htm)\n\nWhen you execute this command, it creates the site in preview status, which means that it isn't yet live. After you finish building your site, you can make it live.\n\nIf you have an Experience Builder site, publish the site using the \"community publish\" command to make it live.\n\nIf you have a Salesforce Tabs + Visualforce site, activate the site to make it live by updating the status field of the Network type in the Metadata API. Alternatively, in Experience Workspaces, go to Administration | Settings, and click Activate.\n\nFor Experience Builder sites, activating the site just sends out a welcome email to site members.",
|
|
565
|
+
"strict": false,
|
|
566
|
+
"pluginName": "@salesforce/plugin-community",
|
|
567
|
+
"pluginAlias": "@salesforce/plugin-community",
|
|
568
|
+
"pluginType": "jit",
|
|
569
|
+
"aliases": [
|
|
570
|
+
"force:community:create"
|
|
571
|
+
],
|
|
572
|
+
"examples": [
|
|
573
|
+
"Create an Experience Cloud site using template 'Customer Service' and URL path prefix 'customers':\n<%= config.bin %> <%= command.id %> --name 'My Customer Site' --template-name 'Customer Service' --url-path-prefix customers --description 'My customer site'",
|
|
574
|
+
"Create a site using 'Partner Central' template:\n<%= config.bin %> <%= command.id %> --name partnercentral --template-name 'Partner Central' --url-path-prefix partners",
|
|
575
|
+
"Create a site using the 'Build Your Own (LWR)' template with authentication type of UNAUTHENTICATED:\n<%= config.bin %> <%= command.id %> --name lwrsite --template-name 'Build Your Own (LWR)' --url-path-prefix lwrsite templateParams.AuthenticationType=UNAUTHENTICATED"
|
|
576
|
+
],
|
|
577
|
+
"flags": {
|
|
578
|
+
"json": {
|
|
579
|
+
"name": "json",
|
|
580
|
+
"type": "boolean",
|
|
581
|
+
"description": "Format output as json.",
|
|
582
|
+
"helpGroup": "GLOBAL",
|
|
583
|
+
"allowNo": false
|
|
584
|
+
},
|
|
585
|
+
"name": {
|
|
586
|
+
"name": "name",
|
|
587
|
+
"type": "option",
|
|
588
|
+
"char": "n",
|
|
589
|
+
"summary": "Name of the site to create.",
|
|
590
|
+
"required": true,
|
|
591
|
+
"multiple": false
|
|
592
|
+
},
|
|
593
|
+
"template-name": {
|
|
594
|
+
"name": "template-name",
|
|
595
|
+
"type": "option",
|
|
596
|
+
"char": "t",
|
|
597
|
+
"summary": "Template to use to create a site.",
|
|
598
|
+
"description": "An example of a template is Customer Service. Run the \"community template list\" command to see which templates are available in your org.",
|
|
599
|
+
"required": true,
|
|
600
|
+
"multiple": false,
|
|
601
|
+
"aliases": [
|
|
602
|
+
"templatename"
|
|
603
|
+
]
|
|
604
|
+
},
|
|
605
|
+
"url-path-prefix": {
|
|
606
|
+
"name": "url-path-prefix",
|
|
607
|
+
"type": "option",
|
|
608
|
+
"char": "p",
|
|
609
|
+
"summary": "URL to append to the domain created when Digital Experiences was enabled for this org.",
|
|
610
|
+
"description": "For example, if your domain name is https://MyDomainName.my.site.com and you create a customer site, enter 'customers' to create the unique URL https://MyDomainName.my.site.com/customers.",
|
|
611
|
+
"required": true,
|
|
612
|
+
"multiple": false,
|
|
613
|
+
"aliases": [
|
|
614
|
+
"urlpathprefix"
|
|
615
|
+
]
|
|
616
|
+
},
|
|
617
|
+
"description": {
|
|
618
|
+
"name": "description",
|
|
619
|
+
"type": "option",
|
|
620
|
+
"char": "d",
|
|
621
|
+
"summary": "Description of the site.",
|
|
622
|
+
"description": "The description displays in Digital Experiences - All Sites in Setup and helps with site identification.",
|
|
623
|
+
"multiple": false
|
|
624
|
+
},
|
|
625
|
+
"target-org": {
|
|
626
|
+
"name": "target-org",
|
|
627
|
+
"type": "option",
|
|
628
|
+
"char": "o",
|
|
629
|
+
"summary": "Username or alias of the target org.",
|
|
630
|
+
"required": true,
|
|
631
|
+
"multiple": false,
|
|
632
|
+
"aliases": [
|
|
633
|
+
"targetusername",
|
|
634
|
+
"u"
|
|
635
|
+
]
|
|
636
|
+
},
|
|
637
|
+
"loglevel": {
|
|
638
|
+
"name": "loglevel",
|
|
639
|
+
"type": "option",
|
|
640
|
+
"hidden": true,
|
|
641
|
+
"multiple": false,
|
|
642
|
+
"deprecated": {
|
|
643
|
+
"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."
|
|
644
|
+
}
|
|
645
|
+
},
|
|
646
|
+
"api-version": {
|
|
647
|
+
"name": "api-version",
|
|
648
|
+
"type": "option",
|
|
649
|
+
"description": "Override the api version used for api requests made by this command",
|
|
650
|
+
"multiple": false,
|
|
651
|
+
"aliases": [
|
|
652
|
+
"apiversion"
|
|
653
|
+
]
|
|
654
|
+
}
|
|
655
|
+
},
|
|
656
|
+
"args": {},
|
|
657
|
+
"validationPatterns": [
|
|
658
|
+
"name",
|
|
659
|
+
"urlPathPrefix",
|
|
660
|
+
"templateName",
|
|
661
|
+
"description",
|
|
662
|
+
"templateParams(\\.\\w+)+"
|
|
663
|
+
],
|
|
664
|
+
"hasDynamicHelp": true
|
|
665
|
+
},
|
|
666
|
+
"community:publish": {
|
|
667
|
+
"id": "community:publish",
|
|
668
|
+
"summary": "Publish an Experience Builder site to make it live.",
|
|
669
|
+
"description": "Each time you publish it, you update the live site with the most recent updates. When you publish an Experience Builder site for the first time, you make the site's URL live and enable login access for site members.\n\nAdditionally, to send a welcome email to all site members, you must activate the site. (Activation is also required to successfully set up SEO for Experience Builder sites.) To activate a site, update the status field of the Network type in the Metadata API. Alternatively, in Experience Workspaces, go to Administration | Settings, and click Activate.\n\nSubsequently, each time you publish the site, you update the live site with all changes made to the site since it was last published.\n\nAn email notification informs you when your changes are live.",
|
|
670
|
+
"strict": true,
|
|
671
|
+
"pluginName": "@salesforce/plugin-community",
|
|
672
|
+
"pluginAlias": "@salesforce/plugin-community",
|
|
673
|
+
"pluginType": "jit",
|
|
674
|
+
"aliases": [
|
|
675
|
+
"force:community:publish"
|
|
676
|
+
],
|
|
677
|
+
"examples": [
|
|
678
|
+
"Publish the Experience Builder site with name \"My Customer Site':\n<%= config.bin %> <%= command.id %> --name 'My Customer Site'"
|
|
679
|
+
],
|
|
680
|
+
"flags": {
|
|
681
|
+
"json": {
|
|
682
|
+
"name": "json",
|
|
683
|
+
"type": "boolean",
|
|
684
|
+
"description": "Format output as json.",
|
|
685
|
+
"helpGroup": "GLOBAL",
|
|
686
|
+
"allowNo": false
|
|
687
|
+
},
|
|
688
|
+
"name": {
|
|
689
|
+
"name": "name",
|
|
690
|
+
"type": "option",
|
|
691
|
+
"char": "n",
|
|
692
|
+
"summary": "Name of the Experience Builder site to publish.",
|
|
693
|
+
"required": true,
|
|
694
|
+
"multiple": false
|
|
695
|
+
},
|
|
696
|
+
"target-org": {
|
|
697
|
+
"name": "target-org",
|
|
698
|
+
"type": "option",
|
|
699
|
+
"char": "o",
|
|
700
|
+
"summary": "Username or alias of the target org.",
|
|
701
|
+
"required": true,
|
|
702
|
+
"multiple": false,
|
|
703
|
+
"aliases": [
|
|
704
|
+
"targetusername",
|
|
705
|
+
"u"
|
|
706
|
+
]
|
|
707
|
+
},
|
|
708
|
+
"api-version": {
|
|
709
|
+
"name": "api-version",
|
|
710
|
+
"type": "option",
|
|
711
|
+
"description": "Override the api version used for api requests made by this command",
|
|
712
|
+
"multiple": false,
|
|
713
|
+
"aliases": [
|
|
714
|
+
"apiversion"
|
|
715
|
+
]
|
|
716
|
+
},
|
|
717
|
+
"loglevel": {
|
|
718
|
+
"name": "loglevel",
|
|
719
|
+
"type": "option",
|
|
720
|
+
"hidden": true,
|
|
721
|
+
"multiple": false,
|
|
722
|
+
"deprecated": {
|
|
723
|
+
"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."
|
|
724
|
+
}
|
|
725
|
+
}
|
|
726
|
+
},
|
|
727
|
+
"args": {},
|
|
728
|
+
"hasDynamicHelp": true
|
|
729
|
+
},
|
|
730
|
+
"community:list:template": {
|
|
731
|
+
"id": "community:list:template",
|
|
732
|
+
"summary": "Retrieve the list of templates available in your org.",
|
|
733
|
+
"description": "See 'Which Experience Cloud Template Should I Use?' (https://help.salesforce.com/s/articleView?id=sf.siteforce_commtemp_intro.htm&type=5) in Salesforce Help for more information about the different template types available for Experience Cloud.",
|
|
734
|
+
"strict": true,
|
|
735
|
+
"pluginName": "@salesforce/plugin-community",
|
|
736
|
+
"pluginAlias": "@salesforce/plugin-community",
|
|
737
|
+
"pluginType": "jit",
|
|
738
|
+
"aliases": [
|
|
739
|
+
"force:community:template:list"
|
|
740
|
+
],
|
|
741
|
+
"examples": [
|
|
742
|
+
"Retrieve the template list from an org with alias my-scratch-org:\n<%= config.bin %> <%= command.id %> --target-org my-scratch-org"
|
|
743
|
+
],
|
|
744
|
+
"flags": {
|
|
745
|
+
"json": {
|
|
746
|
+
"name": "json",
|
|
747
|
+
"type": "boolean",
|
|
748
|
+
"description": "Format output as json.",
|
|
749
|
+
"helpGroup": "GLOBAL",
|
|
750
|
+
"allowNo": false
|
|
751
|
+
},
|
|
752
|
+
"target-org": {
|
|
753
|
+
"name": "target-org",
|
|
754
|
+
"type": "option",
|
|
755
|
+
"char": "o",
|
|
756
|
+
"summary": "Username or alias of the target org.",
|
|
757
|
+
"required": true,
|
|
758
|
+
"multiple": false,
|
|
759
|
+
"aliases": [
|
|
760
|
+
"targetusername",
|
|
761
|
+
"u"
|
|
762
|
+
]
|
|
763
|
+
},
|
|
764
|
+
"api-version": {
|
|
765
|
+
"name": "api-version",
|
|
766
|
+
"type": "option",
|
|
767
|
+
"description": "Override the api version used for api requests made by this command",
|
|
768
|
+
"multiple": false,
|
|
769
|
+
"aliases": [
|
|
770
|
+
"apiversion"
|
|
771
|
+
]
|
|
772
|
+
},
|
|
773
|
+
"loglevel": {
|
|
774
|
+
"name": "loglevel",
|
|
775
|
+
"type": "option",
|
|
776
|
+
"hidden": true,
|
|
777
|
+
"multiple": false,
|
|
778
|
+
"deprecated": {
|
|
779
|
+
"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."
|
|
780
|
+
}
|
|
781
|
+
}
|
|
782
|
+
},
|
|
783
|
+
"args": {},
|
|
784
|
+
"hasDynamicHelp": true
|
|
785
|
+
},
|
|
786
|
+
"package:convert": {
|
|
787
|
+
"id": "package:convert",
|
|
788
|
+
"summary": "Create a second-generation package version from a first-generation package.",
|
|
789
|
+
"description": "The package convert creates a new package in the Dev Hub if one does not already exist for the specified first-generation package.\n\nIt then creates a new package version in the Dev Hub with contents based on the specified first-generation package.\n\nThe latest released non-patch package version from the specified first-generation package will be converted.\n\nTo retrieve details about a package version create request, including status and package version ID (04t), run \"<%= config.bin %> package version create report -i 08c...\".\n\nWe recommend specifying the --installation-key to protect the contents of your package and to prevent unauthorized installation of your package.\n\nTo list package version creation requests in the org, run \"<%= config.bin %> package version create list\".",
|
|
790
|
+
"strict": true,
|
|
791
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
792
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
793
|
+
"pluginType": "jit",
|
|
794
|
+
"hidden": true,
|
|
795
|
+
"aliases": [
|
|
796
|
+
"force:package:beta:convert",
|
|
797
|
+
"force:package:convert"
|
|
798
|
+
],
|
|
799
|
+
"examples": [
|
|
800
|
+
"Create a second-generation package version from the first-generation package with the specified ID and give it the installation key \"password123\"; uses your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --package 033... --installation-key password123",
|
|
801
|
+
"Similar to previous example, but uses the specified Dev Hub org:\n<%= config.bin %> <%= command.id %> --package 033... --installation-key password123 --target-hub-org devhuborg@example.com"
|
|
802
|
+
],
|
|
803
|
+
"deprecateAliases": true,
|
|
804
|
+
"flags": {
|
|
805
|
+
"json": {
|
|
806
|
+
"name": "json",
|
|
807
|
+
"type": "boolean",
|
|
808
|
+
"description": "Format output as json.",
|
|
809
|
+
"helpGroup": "GLOBAL",
|
|
810
|
+
"allowNo": false,
|
|
811
|
+
"deprecateAliases": true
|
|
812
|
+
},
|
|
813
|
+
"loglevel": {
|
|
814
|
+
"name": "loglevel",
|
|
815
|
+
"type": "option",
|
|
816
|
+
"hidden": true,
|
|
817
|
+
"multiple": false,
|
|
818
|
+
"deprecated": {
|
|
819
|
+
"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."
|
|
820
|
+
},
|
|
821
|
+
"deprecateAliases": true
|
|
822
|
+
},
|
|
823
|
+
"target-hub-org": {
|
|
824
|
+
"name": "target-hub-org",
|
|
825
|
+
"type": "option",
|
|
826
|
+
"char": "v",
|
|
827
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
828
|
+
"required": true,
|
|
829
|
+
"multiple": false,
|
|
830
|
+
"deprecateAliases": true,
|
|
831
|
+
"aliases": [
|
|
832
|
+
"targetdevhubusername"
|
|
833
|
+
]
|
|
834
|
+
},
|
|
835
|
+
"api-version": {
|
|
836
|
+
"name": "api-version",
|
|
837
|
+
"type": "option",
|
|
838
|
+
"description": "Override the api version used for api requests made by this command",
|
|
839
|
+
"multiple": false,
|
|
840
|
+
"deprecateAliases": true,
|
|
841
|
+
"aliases": [
|
|
842
|
+
"apiversion"
|
|
843
|
+
]
|
|
844
|
+
},
|
|
845
|
+
"package": {
|
|
846
|
+
"name": "package",
|
|
847
|
+
"type": "option",
|
|
848
|
+
"char": "p",
|
|
849
|
+
"summary": "ID (starts with 033) of the first-generation package to convert.",
|
|
850
|
+
"required": true,
|
|
851
|
+
"multiple": false,
|
|
852
|
+
"deprecateAliases": true
|
|
853
|
+
},
|
|
854
|
+
"installation-key": {
|
|
855
|
+
"name": "installation-key",
|
|
856
|
+
"type": "option",
|
|
857
|
+
"char": "k",
|
|
858
|
+
"summary": "Installation key for key-protected package.",
|
|
859
|
+
"description": "Either an --installation-key value or the --installation-key-bypass flag is required.",
|
|
860
|
+
"multiple": false,
|
|
861
|
+
"deprecateAliases": true,
|
|
862
|
+
"aliases": [
|
|
863
|
+
"installationkey"
|
|
864
|
+
]
|
|
865
|
+
},
|
|
866
|
+
"definition-file": {
|
|
867
|
+
"name": "definition-file",
|
|
868
|
+
"type": "option",
|
|
869
|
+
"char": "f",
|
|
870
|
+
"summary": "Path to a definition file that contains features and org preferences that the metadata of the package version depends on.",
|
|
871
|
+
"description": "This definition file is similar to the scratch org definition file.",
|
|
872
|
+
"hidden": true,
|
|
873
|
+
"multiple": false,
|
|
874
|
+
"deprecateAliases": true,
|
|
875
|
+
"aliases": [
|
|
876
|
+
"definitionfile"
|
|
877
|
+
]
|
|
878
|
+
},
|
|
879
|
+
"installation-key-bypass": {
|
|
880
|
+
"name": "installation-key-bypass",
|
|
881
|
+
"type": "boolean",
|
|
882
|
+
"char": "x",
|
|
883
|
+
"summary": "Bypass the installation key requirement.",
|
|
884
|
+
"description": "If you bypass this requirement, anyone can install your package. Either an --installation-key value or the --installation-key-bypass flag is required.",
|
|
885
|
+
"allowNo": false,
|
|
886
|
+
"deprecateAliases": true,
|
|
887
|
+
"aliases": [
|
|
888
|
+
"installationkeybypass"
|
|
889
|
+
]
|
|
890
|
+
},
|
|
891
|
+
"wait": {
|
|
892
|
+
"name": "wait",
|
|
893
|
+
"type": "option",
|
|
894
|
+
"char": "w",
|
|
895
|
+
"summary": "Minutes to wait for the package version to be created.",
|
|
896
|
+
"multiple": false,
|
|
897
|
+
"default": {
|
|
898
|
+
"quantity": 0,
|
|
899
|
+
"unit": 0
|
|
900
|
+
},
|
|
901
|
+
"deprecateAliases": true
|
|
902
|
+
},
|
|
903
|
+
"build-instance": {
|
|
904
|
+
"name": "build-instance",
|
|
905
|
+
"type": "option",
|
|
906
|
+
"char": "s",
|
|
907
|
+
"summary": "Instance where the conversion package version will be created, such as NA50.",
|
|
908
|
+
"hidden": true,
|
|
909
|
+
"multiple": false,
|
|
910
|
+
"deprecateAliases": true,
|
|
911
|
+
"aliases": [
|
|
912
|
+
"buildinstance"
|
|
913
|
+
]
|
|
914
|
+
},
|
|
915
|
+
"seed-metadata": {
|
|
916
|
+
"name": "seed-metadata",
|
|
917
|
+
"type": "option",
|
|
918
|
+
"char": "m",
|
|
919
|
+
"summary": "Directory containing metadata to be deployed prior to conversion.",
|
|
920
|
+
"description": "The directory containing metadata that will be deployed on the build org prior to attempting conversion.",
|
|
921
|
+
"multiple": false,
|
|
922
|
+
"deprecateAliases": true
|
|
923
|
+
}
|
|
924
|
+
},
|
|
925
|
+
"args": {},
|
|
926
|
+
"hasDynamicHelp": true
|
|
927
|
+
},
|
|
928
|
+
"package:create": {
|
|
929
|
+
"id": "package:create",
|
|
930
|
+
"summary": "Create a package.",
|
|
931
|
+
"description": "First, use this command to create a package. Then create a package version.\n\nIf you don’t have a namespace defined in your sfdx-project.json file, use --no-namespace.\n\nYour --name value must be unique within your namespace.\n\nRun '<%= config.bin %> package list to list all packages in the Dev Hub org.",
|
|
932
|
+
"strict": true,
|
|
933
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
934
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
935
|
+
"pluginType": "jit",
|
|
936
|
+
"aliases": [
|
|
937
|
+
"force:package:beta:create",
|
|
938
|
+
"force:package:create"
|
|
939
|
+
],
|
|
940
|
+
"examples": [
|
|
941
|
+
"Create an unlocked package from the files in the \"force-app\" directory; uses your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --name MyUnlockedPackage --package-type Unlocked --path force-app",
|
|
942
|
+
"Create a managed packaged from the \"force-app\" directory files, give the package a description, and use the specified Dev Hub org:\n<%= config.bin %> <%= command.id %> --name MyManagedPackage --description \"Your Package Descripton\" --package-type Managed --path force-app --target-hub-org devhub@example.com"
|
|
943
|
+
],
|
|
944
|
+
"deprecateAliases": true,
|
|
945
|
+
"flags": {
|
|
946
|
+
"json": {
|
|
947
|
+
"name": "json",
|
|
948
|
+
"type": "boolean",
|
|
949
|
+
"description": "Format output as json.",
|
|
950
|
+
"helpGroup": "GLOBAL",
|
|
951
|
+
"allowNo": false,
|
|
952
|
+
"deprecateAliases": true
|
|
953
|
+
},
|
|
954
|
+
"loglevel": {
|
|
955
|
+
"name": "loglevel",
|
|
956
|
+
"type": "option",
|
|
957
|
+
"hidden": true,
|
|
958
|
+
"multiple": false,
|
|
959
|
+
"deprecated": {
|
|
960
|
+
"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."
|
|
961
|
+
},
|
|
962
|
+
"deprecateAliases": true
|
|
963
|
+
},
|
|
964
|
+
"target-hub-org": {
|
|
965
|
+
"name": "target-hub-org",
|
|
966
|
+
"type": "option",
|
|
967
|
+
"char": "v",
|
|
968
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
969
|
+
"required": true,
|
|
970
|
+
"multiple": false,
|
|
971
|
+
"deprecateAliases": true,
|
|
972
|
+
"aliases": [
|
|
973
|
+
"targetdevhubusername"
|
|
974
|
+
]
|
|
975
|
+
},
|
|
976
|
+
"api-version": {
|
|
977
|
+
"name": "api-version",
|
|
978
|
+
"type": "option",
|
|
979
|
+
"description": "Override the api version used for api requests made by this command",
|
|
980
|
+
"multiple": false,
|
|
981
|
+
"deprecateAliases": true,
|
|
982
|
+
"aliases": [
|
|
983
|
+
"apiversion"
|
|
984
|
+
]
|
|
985
|
+
},
|
|
986
|
+
"name": {
|
|
987
|
+
"name": "name",
|
|
988
|
+
"type": "option",
|
|
989
|
+
"char": "n",
|
|
990
|
+
"summary": "Name of the package to create.",
|
|
991
|
+
"required": true,
|
|
992
|
+
"multiple": false,
|
|
993
|
+
"deprecateAliases": true
|
|
994
|
+
},
|
|
995
|
+
"package-type": {
|
|
996
|
+
"name": "package-type",
|
|
997
|
+
"type": "option",
|
|
998
|
+
"char": "t",
|
|
999
|
+
"summary": "Type of package.",
|
|
1000
|
+
"description": "The options for package type are Managed and Unlocked (Managed=DeveloperManagedSubscriberManaged, Unlocked=DeveloperControlledSubscriberEditable). These options determine upgrade and editability rules.",
|
|
1001
|
+
"required": true,
|
|
1002
|
+
"multiple": false,
|
|
1003
|
+
"options": [
|
|
1004
|
+
"Managed",
|
|
1005
|
+
"Unlocked"
|
|
1006
|
+
],
|
|
1007
|
+
"deprecateAliases": true,
|
|
1008
|
+
"aliases": [
|
|
1009
|
+
"packagetype"
|
|
1010
|
+
]
|
|
1011
|
+
},
|
|
1012
|
+
"description": {
|
|
1013
|
+
"name": "description",
|
|
1014
|
+
"type": "option",
|
|
1015
|
+
"char": "d",
|
|
1016
|
+
"summary": "Description of the package.",
|
|
1017
|
+
"multiple": false,
|
|
1018
|
+
"deprecateAliases": true
|
|
1019
|
+
},
|
|
1020
|
+
"no-namespace": {
|
|
1021
|
+
"name": "no-namespace",
|
|
1022
|
+
"type": "boolean",
|
|
1023
|
+
"char": "e",
|
|
1024
|
+
"summary": "Create the package with no namespace; available only for unlocked packages.",
|
|
1025
|
+
"description": "This flag is useful when you’re migrating an existing org to packages. But use a namespaced package for new metadata.",
|
|
1026
|
+
"allowNo": false,
|
|
1027
|
+
"deprecateAliases": true,
|
|
1028
|
+
"aliases": [
|
|
1029
|
+
"nonamespace"
|
|
1030
|
+
]
|
|
1031
|
+
},
|
|
1032
|
+
"path": {
|
|
1033
|
+
"name": "path",
|
|
1034
|
+
"type": "option",
|
|
1035
|
+
"char": "r",
|
|
1036
|
+
"summary": "Path to directory that contains the contents of the package.",
|
|
1037
|
+
"required": true,
|
|
1038
|
+
"multiple": false,
|
|
1039
|
+
"deprecateAliases": true
|
|
1040
|
+
},
|
|
1041
|
+
"org-dependent": {
|
|
1042
|
+
"name": "org-dependent",
|
|
1043
|
+
"type": "boolean",
|
|
1044
|
+
"summary": "Depends on unpackaged metadata in the installation org; applies to unlocked packages only.",
|
|
1045
|
+
"description": "Use Source Tracking in Sandboxes to develop your org-dependent unlocked package. For more information, see \"Create Org-Dependent Unlocked Packages\" in the Salesforce DX Developer Guide.",
|
|
1046
|
+
"allowNo": false,
|
|
1047
|
+
"deprecateAliases": true,
|
|
1048
|
+
"aliases": [
|
|
1049
|
+
"orgdependent"
|
|
1050
|
+
]
|
|
1051
|
+
},
|
|
1052
|
+
"error-notification-username": {
|
|
1053
|
+
"name": "error-notification-username",
|
|
1054
|
+
"type": "option",
|
|
1055
|
+
"char": "o",
|
|
1056
|
+
"summary": "Active Dev Hub user designated to receive email notifications for package errors.",
|
|
1057
|
+
"description": "Email notifications include information about unhandled Apex exceptions, and install, upgrade, or uninstall failures associated with your package.",
|
|
1058
|
+
"multiple": false,
|
|
1059
|
+
"deprecateAliases": true,
|
|
1060
|
+
"aliases": [
|
|
1061
|
+
"errornotificationusername"
|
|
1062
|
+
]
|
|
1063
|
+
}
|
|
1064
|
+
},
|
|
1065
|
+
"args": {},
|
|
1066
|
+
"requiresProject": true,
|
|
1067
|
+
"hasDynamicHelp": true
|
|
1068
|
+
},
|
|
1069
|
+
"package:delete": {
|
|
1070
|
+
"id": "package:delete",
|
|
1071
|
+
"summary": "Delete a package.",
|
|
1072
|
+
"description": "Specify the ID or alias of the package you want to delete.\n\nDelete unlocked and second-generation managed packages. Before you delete a package, first delete all associated package versions.",
|
|
1073
|
+
"strict": true,
|
|
1074
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
1075
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
1076
|
+
"pluginType": "jit",
|
|
1077
|
+
"aliases": [
|
|
1078
|
+
"force:package:beta:delete",
|
|
1079
|
+
"force:package:delete"
|
|
1080
|
+
],
|
|
1081
|
+
"examples": [
|
|
1082
|
+
"Delete a package using its alias from your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --package \"Your Package Alias\"",
|
|
1083
|
+
"Delete a package using its ID from the specified Dev Hub org:\n<%= config.bin %> <%= command.id %> --package 0Ho... --target-hub-org devhub@example.com"
|
|
1084
|
+
],
|
|
1085
|
+
"deprecateAliases": true,
|
|
1086
|
+
"flags": {
|
|
1087
|
+
"json": {
|
|
1088
|
+
"name": "json",
|
|
1089
|
+
"type": "boolean",
|
|
1090
|
+
"description": "Format output as json.",
|
|
1091
|
+
"helpGroup": "GLOBAL",
|
|
1092
|
+
"allowNo": false,
|
|
1093
|
+
"deprecateAliases": true
|
|
1094
|
+
},
|
|
1095
|
+
"loglevel": {
|
|
1096
|
+
"name": "loglevel",
|
|
1097
|
+
"type": "option",
|
|
1098
|
+
"hidden": true,
|
|
1099
|
+
"multiple": false,
|
|
1100
|
+
"deprecated": {
|
|
1101
|
+
"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."
|
|
1102
|
+
},
|
|
1103
|
+
"deprecateAliases": true
|
|
1104
|
+
},
|
|
1105
|
+
"target-hub-org": {
|
|
1106
|
+
"name": "target-hub-org",
|
|
1107
|
+
"type": "option",
|
|
1108
|
+
"char": "v",
|
|
1109
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
1110
|
+
"required": true,
|
|
1111
|
+
"multiple": false,
|
|
1112
|
+
"deprecateAliases": true,
|
|
1113
|
+
"aliases": [
|
|
1114
|
+
"targetdevhubusername"
|
|
1115
|
+
]
|
|
1116
|
+
},
|
|
1117
|
+
"api-version": {
|
|
1118
|
+
"name": "api-version",
|
|
1119
|
+
"type": "option",
|
|
1120
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1121
|
+
"multiple": false,
|
|
1122
|
+
"deprecateAliases": true,
|
|
1123
|
+
"aliases": [
|
|
1124
|
+
"apiversion"
|
|
1125
|
+
]
|
|
1126
|
+
},
|
|
1127
|
+
"no-prompt": {
|
|
1128
|
+
"name": "no-prompt",
|
|
1129
|
+
"type": "boolean",
|
|
1130
|
+
"char": "n",
|
|
1131
|
+
"summary": "Don’t prompt before deleting the package.",
|
|
1132
|
+
"allowNo": false,
|
|
1133
|
+
"deprecateAliases": true,
|
|
1134
|
+
"aliases": [
|
|
1135
|
+
"noprompt"
|
|
1136
|
+
]
|
|
1137
|
+
},
|
|
1138
|
+
"package": {
|
|
1139
|
+
"name": "package",
|
|
1140
|
+
"type": "option",
|
|
1141
|
+
"char": "p",
|
|
1142
|
+
"summary": "ID (starts with 0Ho) or alias of the package to delete.",
|
|
1143
|
+
"required": true,
|
|
1144
|
+
"multiple": false,
|
|
1145
|
+
"deprecateAliases": true
|
|
1146
|
+
},
|
|
1147
|
+
"undelete": {
|
|
1148
|
+
"name": "undelete",
|
|
1149
|
+
"type": "boolean",
|
|
1150
|
+
"summary": "Undelete a deleted package.",
|
|
1151
|
+
"hidden": true,
|
|
1152
|
+
"allowNo": false,
|
|
1153
|
+
"deprecateAliases": true
|
|
1154
|
+
}
|
|
1155
|
+
},
|
|
1156
|
+
"args": {},
|
|
1157
|
+
"requiresProject": true,
|
|
1158
|
+
"hasDynamicHelp": true
|
|
1159
|
+
},
|
|
1160
|
+
"package:install": {
|
|
1161
|
+
"id": "package:install",
|
|
1162
|
+
"summary": "Install a version of a package in the target org.",
|
|
1163
|
+
"description": "To install a package, specify a specific version of the package using the 04t package ID. The package and the version you specified installs in your default target org unless you supply the username for a different target org.\n\nFor package upgrades, to specify options for component deprecation or deletion of removed components, include an --upgrade-type value. To delete components that can be safely deleted and deprecate the others, specify --upgrade-type Mixed (the default). To deprecate all removed components, specify --upgrade-type DeprecateOnly. To delete all removed components, except for custom objects and custom fields, that don't have dependencies, specify --upgrade-type Delete. (Note: This option can result in the loss of data that is associated with the deleted components.) The default is Mixed.",
|
|
1164
|
+
"strict": true,
|
|
1165
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
1166
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
1167
|
+
"pluginType": "jit",
|
|
1168
|
+
"aliases": [
|
|
1169
|
+
"force:package:beta:install",
|
|
1170
|
+
"force:package:install"
|
|
1171
|
+
],
|
|
1172
|
+
"examples": [
|
|
1173
|
+
"Install a package version with the specified ID in the org with username \"me@example.com\":\n<%= config.bin %> <%= command.id %> --package 04t... --target-org me@example.com",
|
|
1174
|
+
"Install a package version with the specified alias into your default org:\n<%= config.bin %> <%= command.id %> --package awesome_package_alias",
|
|
1175
|
+
"Install a package version with an alias that includes spaces into your default org:\n<%= config.bin %> <%= command.id %> --package \"Awesome Package Alias\"",
|
|
1176
|
+
"Install an unlocked package version with the specified ID and deprecate all removed components:\n<%= config.bin %> <%= command.id %> --package 04t... --upgrade-type DeprecateOnly"
|
|
1177
|
+
],
|
|
1178
|
+
"deprecateAliases": true,
|
|
1179
|
+
"flags": {
|
|
1180
|
+
"json": {
|
|
1181
|
+
"name": "json",
|
|
1182
|
+
"type": "boolean",
|
|
1183
|
+
"description": "Format output as json.",
|
|
1184
|
+
"helpGroup": "GLOBAL",
|
|
1185
|
+
"allowNo": false,
|
|
1186
|
+
"deprecateAliases": true
|
|
1187
|
+
},
|
|
1188
|
+
"loglevel": {
|
|
1189
|
+
"name": "loglevel",
|
|
1190
|
+
"type": "option",
|
|
1191
|
+
"hidden": true,
|
|
1192
|
+
"multiple": false,
|
|
1193
|
+
"deprecated": {
|
|
1194
|
+
"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."
|
|
1195
|
+
},
|
|
1196
|
+
"deprecateAliases": true
|
|
1197
|
+
},
|
|
1198
|
+
"target-org": {
|
|
1199
|
+
"name": "target-org",
|
|
1200
|
+
"type": "option",
|
|
1201
|
+
"char": "o",
|
|
1202
|
+
"summary": "Username or alias of the target org.",
|
|
1203
|
+
"required": true,
|
|
1204
|
+
"multiple": false,
|
|
1205
|
+
"deprecateAliases": true,
|
|
1206
|
+
"aliases": [
|
|
1207
|
+
"targetusername",
|
|
1208
|
+
"u"
|
|
1209
|
+
]
|
|
1210
|
+
},
|
|
1211
|
+
"api-version": {
|
|
1212
|
+
"name": "api-version",
|
|
1213
|
+
"type": "option",
|
|
1214
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1215
|
+
"multiple": false,
|
|
1216
|
+
"deprecateAliases": true,
|
|
1217
|
+
"aliases": [
|
|
1218
|
+
"apiversion"
|
|
1219
|
+
]
|
|
1220
|
+
},
|
|
1221
|
+
"wait": {
|
|
1222
|
+
"name": "wait",
|
|
1223
|
+
"type": "option",
|
|
1224
|
+
"char": "w",
|
|
1225
|
+
"summary": "Number of minutes to wait for installation status.",
|
|
1226
|
+
"multiple": false,
|
|
1227
|
+
"default": {
|
|
1228
|
+
"quantity": 0,
|
|
1229
|
+
"unit": 0
|
|
1230
|
+
},
|
|
1231
|
+
"deprecateAliases": true
|
|
1232
|
+
},
|
|
1233
|
+
"installation-key": {
|
|
1234
|
+
"name": "installation-key",
|
|
1235
|
+
"type": "option",
|
|
1236
|
+
"char": "k",
|
|
1237
|
+
"summary": "Installation key for key-protected package (default: null).",
|
|
1238
|
+
"multiple": false,
|
|
1239
|
+
"deprecateAliases": true,
|
|
1240
|
+
"aliases": [
|
|
1241
|
+
"installationkey"
|
|
1242
|
+
]
|
|
1243
|
+
},
|
|
1244
|
+
"publish-wait": {
|
|
1245
|
+
"name": "publish-wait",
|
|
1246
|
+
"type": "option",
|
|
1247
|
+
"char": "b",
|
|
1248
|
+
"summary": "Maximum number of minutes to wait for the Subscriber Package Version ID to become available in the target org before canceling the install request.",
|
|
1249
|
+
"multiple": false,
|
|
1250
|
+
"default": {
|
|
1251
|
+
"quantity": 0,
|
|
1252
|
+
"unit": 0
|
|
1253
|
+
},
|
|
1254
|
+
"deprecateAliases": true,
|
|
1255
|
+
"aliases": [
|
|
1256
|
+
"publishwait"
|
|
1257
|
+
]
|
|
1258
|
+
},
|
|
1259
|
+
"no-prompt": {
|
|
1260
|
+
"name": "no-prompt",
|
|
1261
|
+
"type": "boolean",
|
|
1262
|
+
"char": "r",
|
|
1263
|
+
"summary": "Don't prompt for confirmation.",
|
|
1264
|
+
"description": "Allows the following without an explicit confirmation response: 1) Remote Site Settings and Content Security Policy websites to send or receive data, and 2) --upgrade-type Delete to proceed.",
|
|
1265
|
+
"allowNo": false,
|
|
1266
|
+
"deprecateAliases": true,
|
|
1267
|
+
"aliases": [
|
|
1268
|
+
"noprompt"
|
|
1269
|
+
]
|
|
1270
|
+
},
|
|
1271
|
+
"package": {
|
|
1272
|
+
"name": "package",
|
|
1273
|
+
"type": "option",
|
|
1274
|
+
"char": "p",
|
|
1275
|
+
"summary": "ID (starts with 04t) or alias of the package version to install.",
|
|
1276
|
+
"required": true,
|
|
1277
|
+
"multiple": false,
|
|
1278
|
+
"deprecateAliases": true
|
|
1279
|
+
},
|
|
1280
|
+
"apex-compile": {
|
|
1281
|
+
"name": "apex-compile",
|
|
1282
|
+
"type": "option",
|
|
1283
|
+
"char": "a",
|
|
1284
|
+
"summary": "Compile all Apex in the org and package, or only Apex in the package; unlocked packages only.",
|
|
1285
|
+
"description": "Applies to unlocked packages only. Specifies whether to compile all Apex in the org and package, or only the Apex in the package.\n\nFor package installs into production orgs, or any org that has Apex Compile on Deploy enabled, the platform compiles all Apex in the org after the package install or upgrade operation completes.\n\nThis approach assures that package installs and upgrades don’t impact the performance of an org, and is done even if --apex-compile package is specified.",
|
|
1286
|
+
"multiple": false,
|
|
1287
|
+
"options": [
|
|
1288
|
+
"all",
|
|
1289
|
+
"package"
|
|
1290
|
+
],
|
|
1291
|
+
"default": "all",
|
|
1292
|
+
"deprecateAliases": true,
|
|
1293
|
+
"aliases": [
|
|
1294
|
+
"apexcompile"
|
|
1295
|
+
]
|
|
1296
|
+
},
|
|
1297
|
+
"security-type": {
|
|
1298
|
+
"name": "security-type",
|
|
1299
|
+
"type": "option",
|
|
1300
|
+
"char": "s",
|
|
1301
|
+
"summary": "Security access type for the installed package. (deprecation notice: The default --security-type value will change from AllUsers to AdminsOnly in v47.0 or later.)",
|
|
1302
|
+
"multiple": false,
|
|
1303
|
+
"options": [
|
|
1304
|
+
"AllUsers",
|
|
1305
|
+
"AdminsOnly"
|
|
1306
|
+
],
|
|
1307
|
+
"default": "AdminsOnly",
|
|
1308
|
+
"deprecateAliases": true,
|
|
1309
|
+
"aliases": [
|
|
1310
|
+
"securitytype"
|
|
1311
|
+
]
|
|
1312
|
+
},
|
|
1313
|
+
"upgrade-type": {
|
|
1314
|
+
"name": "upgrade-type",
|
|
1315
|
+
"type": "option",
|
|
1316
|
+
"char": "t",
|
|
1317
|
+
"summary": "Upgrade type for the package installation; available only for unlocked packages.",
|
|
1318
|
+
"description": "For package upgrades, specifies whether to mark all removed components as deprecated (DeprecateOnly), to delete removed components that can be safely deleted and deprecate the others (Mixed), or to delete all removed components, except for custom objects and custom fields, that don't have dependencies (Delete). The default is Mixed. Can specify DeprecateOnly or Delete only for unlocked package upgrades.",
|
|
1319
|
+
"multiple": false,
|
|
1320
|
+
"options": [
|
|
1321
|
+
"DeprecateOnly",
|
|
1322
|
+
"Mixed",
|
|
1323
|
+
"Delete"
|
|
1324
|
+
],
|
|
1325
|
+
"default": "Mixed",
|
|
1326
|
+
"deprecateAliases": true,
|
|
1327
|
+
"aliases": [
|
|
1328
|
+
"upgradetype"
|
|
1329
|
+
]
|
|
1330
|
+
}
|
|
1331
|
+
},
|
|
1332
|
+
"args": {},
|
|
1333
|
+
"hasDynamicHelp": true
|
|
1334
|
+
},
|
|
1335
|
+
"package:list": {
|
|
1336
|
+
"id": "package:list",
|
|
1337
|
+
"summary": "List all packages in the Dev Hub org.",
|
|
1338
|
+
"description": "Description",
|
|
1339
|
+
"strict": true,
|
|
1340
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
1341
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
1342
|
+
"pluginType": "jit",
|
|
1343
|
+
"aliases": [
|
|
1344
|
+
"force:package:beta:list",
|
|
1345
|
+
"force:package:list"
|
|
1346
|
+
],
|
|
1347
|
+
"examples": [
|
|
1348
|
+
"List all packages in the specified Dev Hub org:\n<%= config.bin %> <%= command.id %> --target-hub-org devhub@example.com",
|
|
1349
|
+
"List all packages details in the specified Dev Hub org, and show extended details about each package:\n<%= config.bin %> <%= command.id %> --target-hub-org devhub@example.com --verbose"
|
|
1350
|
+
],
|
|
1351
|
+
"deprecateAliases": true,
|
|
1352
|
+
"flags": {
|
|
1353
|
+
"json": {
|
|
1354
|
+
"name": "json",
|
|
1355
|
+
"type": "boolean",
|
|
1356
|
+
"description": "Format output as json.",
|
|
1357
|
+
"helpGroup": "GLOBAL",
|
|
1358
|
+
"allowNo": false,
|
|
1359
|
+
"deprecateAliases": true
|
|
1360
|
+
},
|
|
1361
|
+
"loglevel": {
|
|
1362
|
+
"name": "loglevel",
|
|
1363
|
+
"type": "option",
|
|
1364
|
+
"hidden": true,
|
|
1365
|
+
"multiple": false,
|
|
1366
|
+
"deprecated": {
|
|
1367
|
+
"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."
|
|
1368
|
+
},
|
|
1369
|
+
"deprecateAliases": true
|
|
1370
|
+
},
|
|
1371
|
+
"target-hub-org": {
|
|
1372
|
+
"name": "target-hub-org",
|
|
1373
|
+
"type": "option",
|
|
1374
|
+
"char": "v",
|
|
1375
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
1376
|
+
"required": true,
|
|
1377
|
+
"multiple": false,
|
|
1378
|
+
"deprecateAliases": true,
|
|
1379
|
+
"aliases": [
|
|
1380
|
+
"targetdevhubusername"
|
|
1381
|
+
]
|
|
1382
|
+
},
|
|
1383
|
+
"api-version": {
|
|
1384
|
+
"name": "api-version",
|
|
1385
|
+
"type": "option",
|
|
1386
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1387
|
+
"multiple": false,
|
|
1388
|
+
"deprecateAliases": true,
|
|
1389
|
+
"aliases": [
|
|
1390
|
+
"apiversion"
|
|
1391
|
+
]
|
|
1392
|
+
},
|
|
1393
|
+
"verbose": {
|
|
1394
|
+
"name": "verbose",
|
|
1395
|
+
"type": "boolean",
|
|
1396
|
+
"summary": "Display extended package detail.",
|
|
1397
|
+
"allowNo": false,
|
|
1398
|
+
"deprecateAliases": true
|
|
1399
|
+
}
|
|
1400
|
+
},
|
|
1401
|
+
"args": {},
|
|
1402
|
+
"requiresProject": true,
|
|
1403
|
+
"hasDynamicHelp": true
|
|
1404
|
+
},
|
|
1405
|
+
"package:uninstall": {
|
|
1406
|
+
"id": "package:uninstall",
|
|
1407
|
+
"summary": "Uninstall a second-generation package from the target org.",
|
|
1408
|
+
"description": "Specify the package ID for a second-generation package.\n\nTo list the org’s installed packages, run \"<%= config.bin %> package installed list\".\n\nTo uninstall a first-generation package, from Setup, enter Installed Packages in the Quick Find box, then select Installed Packages.",
|
|
1409
|
+
"strict": true,
|
|
1410
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
1411
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
1412
|
+
"pluginType": "jit",
|
|
1413
|
+
"aliases": [
|
|
1414
|
+
"force:package:beta:uninstall",
|
|
1415
|
+
"force:package:uninstall"
|
|
1416
|
+
],
|
|
1417
|
+
"examples": [
|
|
1418
|
+
"Uninstall a package with specified ID from an org with username me@example.com:\n<%= config.bin %> <%= command.id %> --package 04t... --target-org me@example.com",
|
|
1419
|
+
"Uninstall a package with the specified alias from your default org:\n<%= config.bin %> <%= command.id %> --package undesirable_package_alias",
|
|
1420
|
+
"Uninstall a package with an alias that contains spaces from your default org:\n<%= config.bin %> <%= command.id %> --package \"Undesirable Package Alias\""
|
|
1421
|
+
],
|
|
1422
|
+
"deprecateAliases": true,
|
|
1423
|
+
"flags": {
|
|
1424
|
+
"json": {
|
|
1425
|
+
"name": "json",
|
|
1426
|
+
"type": "boolean",
|
|
1427
|
+
"description": "Format output as json.",
|
|
1428
|
+
"helpGroup": "GLOBAL",
|
|
1429
|
+
"allowNo": false,
|
|
1430
|
+
"deprecateAliases": true
|
|
1431
|
+
},
|
|
1432
|
+
"loglevel": {
|
|
1433
|
+
"name": "loglevel",
|
|
1434
|
+
"type": "option",
|
|
1435
|
+
"hidden": true,
|
|
1436
|
+
"multiple": false,
|
|
1437
|
+
"deprecated": {
|
|
1438
|
+
"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."
|
|
1439
|
+
},
|
|
1440
|
+
"deprecateAliases": true
|
|
1441
|
+
},
|
|
1442
|
+
"target-org": {
|
|
1443
|
+
"name": "target-org",
|
|
1444
|
+
"type": "option",
|
|
1445
|
+
"char": "o",
|
|
1446
|
+
"summary": "Username or alias of the target org.",
|
|
1447
|
+
"required": true,
|
|
1448
|
+
"multiple": false,
|
|
1449
|
+
"deprecateAliases": true,
|
|
1450
|
+
"aliases": [
|
|
1451
|
+
"targetusername",
|
|
1452
|
+
"u"
|
|
1453
|
+
]
|
|
1454
|
+
},
|
|
1455
|
+
"api-version": {
|
|
1456
|
+
"name": "api-version",
|
|
1457
|
+
"type": "option",
|
|
1458
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1459
|
+
"multiple": false,
|
|
1460
|
+
"deprecateAliases": true,
|
|
1461
|
+
"aliases": [
|
|
1462
|
+
"apiversion"
|
|
1463
|
+
]
|
|
1464
|
+
},
|
|
1465
|
+
"wait": {
|
|
1466
|
+
"name": "wait",
|
|
1467
|
+
"type": "option",
|
|
1468
|
+
"char": "w",
|
|
1469
|
+
"summary": "Number of minutes to wait for uninstall status.",
|
|
1470
|
+
"multiple": false,
|
|
1471
|
+
"default": {
|
|
1472
|
+
"quantity": 0,
|
|
1473
|
+
"unit": 0
|
|
1474
|
+
},
|
|
1475
|
+
"deprecateAliases": true
|
|
1476
|
+
},
|
|
1477
|
+
"package": {
|
|
1478
|
+
"name": "package",
|
|
1479
|
+
"type": "option",
|
|
1480
|
+
"char": "p",
|
|
1481
|
+
"summary": "ID (starts with 04t) or alias of the package version to uninstall.",
|
|
1482
|
+
"required": true,
|
|
1483
|
+
"multiple": false,
|
|
1484
|
+
"deprecateAliases": true
|
|
1485
|
+
}
|
|
1486
|
+
},
|
|
1487
|
+
"args": {},
|
|
1488
|
+
"hasDynamicHelp": true
|
|
1489
|
+
},
|
|
1490
|
+
"package:update": {
|
|
1491
|
+
"id": "package:update",
|
|
1492
|
+
"summary": "Update package details.",
|
|
1493
|
+
"description": "Specify a new value for each option you want to update.\n\nRun \"<%= config.bin %> package list\" to list all packages in the Dev Hub org.",
|
|
1494
|
+
"strict": true,
|
|
1495
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
1496
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
1497
|
+
"pluginType": "jit",
|
|
1498
|
+
"aliases": [
|
|
1499
|
+
"force:package:beta:update",
|
|
1500
|
+
"force:package:update"
|
|
1501
|
+
],
|
|
1502
|
+
"examples": [
|
|
1503
|
+
"Update the name of the package with the specified alias; uses your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --package \"Your Package Alias\" --name \"New Package Name\"",
|
|
1504
|
+
"Update the description of the package with the specified ID; uses the specified Dev Hub org:\n<%= config.bin %> <%= command.id %> --package 0Ho... --description \"New Package Description\" --target-hub-org devhub@example.com"
|
|
1505
|
+
],
|
|
1506
|
+
"deprecateAliases": true,
|
|
1507
|
+
"flags": {
|
|
1508
|
+
"json": {
|
|
1509
|
+
"name": "json",
|
|
1510
|
+
"type": "boolean",
|
|
1511
|
+
"description": "Format output as json.",
|
|
1512
|
+
"helpGroup": "GLOBAL",
|
|
1513
|
+
"allowNo": false,
|
|
1514
|
+
"deprecateAliases": true
|
|
1515
|
+
},
|
|
1516
|
+
"loglevel": {
|
|
1517
|
+
"name": "loglevel",
|
|
1518
|
+
"type": "option",
|
|
1519
|
+
"hidden": true,
|
|
1520
|
+
"multiple": false,
|
|
1521
|
+
"deprecated": {
|
|
1522
|
+
"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."
|
|
1523
|
+
},
|
|
1524
|
+
"deprecateAliases": true
|
|
1525
|
+
},
|
|
1526
|
+
"target-hub-org": {
|
|
1527
|
+
"name": "target-hub-org",
|
|
1528
|
+
"type": "option",
|
|
1529
|
+
"char": "v",
|
|
1530
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
1531
|
+
"required": true,
|
|
1532
|
+
"multiple": false,
|
|
1533
|
+
"deprecateAliases": true,
|
|
1534
|
+
"aliases": [
|
|
1535
|
+
"targetdevhubusername"
|
|
1536
|
+
]
|
|
1537
|
+
},
|
|
1538
|
+
"api-version": {
|
|
1539
|
+
"name": "api-version",
|
|
1540
|
+
"type": "option",
|
|
1541
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1542
|
+
"multiple": false,
|
|
1543
|
+
"deprecateAliases": true,
|
|
1544
|
+
"aliases": [
|
|
1545
|
+
"apiversion"
|
|
1546
|
+
]
|
|
1547
|
+
},
|
|
1548
|
+
"package": {
|
|
1549
|
+
"name": "package",
|
|
1550
|
+
"type": "option",
|
|
1551
|
+
"char": "p",
|
|
1552
|
+
"summary": "ID (starts with 0Ho) or alias of the package to update.",
|
|
1553
|
+
"required": true,
|
|
1554
|
+
"multiple": false,
|
|
1555
|
+
"deprecateAliases": true
|
|
1556
|
+
},
|
|
1557
|
+
"name": {
|
|
1558
|
+
"name": "name",
|
|
1559
|
+
"type": "option",
|
|
1560
|
+
"char": "n",
|
|
1561
|
+
"summary": "New name of the package.",
|
|
1562
|
+
"multiple": false,
|
|
1563
|
+
"deprecateAliases": true
|
|
1564
|
+
},
|
|
1565
|
+
"description": {
|
|
1566
|
+
"name": "description",
|
|
1567
|
+
"type": "option",
|
|
1568
|
+
"char": "d",
|
|
1569
|
+
"summary": "New description of the package.",
|
|
1570
|
+
"multiple": false,
|
|
1571
|
+
"deprecateAliases": true
|
|
1572
|
+
},
|
|
1573
|
+
"error-notification-username": {
|
|
1574
|
+
"name": "error-notification-username",
|
|
1575
|
+
"type": "option",
|
|
1576
|
+
"char": "o",
|
|
1577
|
+
"summary": "Active Dev Hub user designated to receive email notifications for package errors.",
|
|
1578
|
+
"description": "Email notifications include information about unhandled Apex exceptions, and install, upgrade, or uninstall failures associated with your package.",
|
|
1579
|
+
"multiple": false,
|
|
1580
|
+
"deprecateAliases": true,
|
|
1581
|
+
"aliases": [
|
|
1582
|
+
"errornotificationusername"
|
|
1583
|
+
]
|
|
1584
|
+
}
|
|
1585
|
+
},
|
|
1586
|
+
"args": {},
|
|
1587
|
+
"requiresProject": true,
|
|
1588
|
+
"hasDynamicHelp": true
|
|
1589
|
+
},
|
|
1590
|
+
"package:install:report": {
|
|
1591
|
+
"id": "package:install:report",
|
|
1592
|
+
"summary": "Retrieve the status of a package installation request.",
|
|
1593
|
+
"strict": true,
|
|
1594
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
1595
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
1596
|
+
"pluginType": "jit",
|
|
1597
|
+
"aliases": [
|
|
1598
|
+
"force:package:beta:install:report",
|
|
1599
|
+
"force:package:install:report"
|
|
1600
|
+
],
|
|
1601
|
+
"examples": [
|
|
1602
|
+
"Retrieve the status of a package installation request with the specified ID on your default org:\n<%= config.bin %> <%= command.id %> --request-id 0Hf...",
|
|
1603
|
+
"Similar to previous example, except use the org with username me@example.com:\n<%= config.bin %> <%= command.id %> --request-id 0Hf... --target-org me@example.com"
|
|
1604
|
+
],
|
|
1605
|
+
"deprecateAliases": true,
|
|
1606
|
+
"flags": {
|
|
1607
|
+
"json": {
|
|
1608
|
+
"name": "json",
|
|
1609
|
+
"type": "boolean",
|
|
1610
|
+
"description": "Format output as json.",
|
|
1611
|
+
"helpGroup": "GLOBAL",
|
|
1612
|
+
"allowNo": false,
|
|
1613
|
+
"deprecateAliases": true
|
|
1614
|
+
},
|
|
1615
|
+
"target-org": {
|
|
1616
|
+
"name": "target-org",
|
|
1617
|
+
"type": "option",
|
|
1618
|
+
"char": "o",
|
|
1619
|
+
"summary": "Username or alias of the target org.",
|
|
1620
|
+
"required": true,
|
|
1621
|
+
"multiple": false,
|
|
1622
|
+
"deprecateAliases": true,
|
|
1623
|
+
"aliases": [
|
|
1624
|
+
"targetusername",
|
|
1625
|
+
"u"
|
|
1626
|
+
]
|
|
1627
|
+
},
|
|
1628
|
+
"api-version": {
|
|
1629
|
+
"name": "api-version",
|
|
1630
|
+
"type": "option",
|
|
1631
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1632
|
+
"multiple": false,
|
|
1633
|
+
"deprecateAliases": true,
|
|
1634
|
+
"aliases": [
|
|
1635
|
+
"apiversion"
|
|
1636
|
+
]
|
|
1637
|
+
},
|
|
1638
|
+
"loglevel": {
|
|
1639
|
+
"name": "loglevel",
|
|
1640
|
+
"type": "option",
|
|
1641
|
+
"hidden": true,
|
|
1642
|
+
"multiple": false,
|
|
1643
|
+
"deprecated": {
|
|
1644
|
+
"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."
|
|
1645
|
+
},
|
|
1646
|
+
"deprecateAliases": true
|
|
1647
|
+
},
|
|
1648
|
+
"request-id": {
|
|
1649
|
+
"name": "request-id",
|
|
1650
|
+
"type": "option",
|
|
1651
|
+
"char": "i",
|
|
1652
|
+
"summary": "ID of the package install request you want to check; starts with 0Hf.",
|
|
1653
|
+
"required": true,
|
|
1654
|
+
"multiple": false,
|
|
1655
|
+
"deprecateAliases": true,
|
|
1656
|
+
"aliases": [
|
|
1657
|
+
"requestid"
|
|
1658
|
+
]
|
|
1659
|
+
}
|
|
1660
|
+
},
|
|
1661
|
+
"args": {},
|
|
1662
|
+
"hasDynamicHelp": true
|
|
1663
|
+
},
|
|
1664
|
+
"package:installed:list": {
|
|
1665
|
+
"id": "package:installed:list",
|
|
1666
|
+
"summary": "List the org’s installed packages.",
|
|
1667
|
+
"strict": true,
|
|
1668
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
1669
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
1670
|
+
"pluginType": "jit",
|
|
1671
|
+
"aliases": [
|
|
1672
|
+
"force:package:beta:installed:list",
|
|
1673
|
+
"force:package:installed:list"
|
|
1674
|
+
],
|
|
1675
|
+
"examples": [
|
|
1676
|
+
"List the installed packages in your default org:\n<%= config.bin %> <%= command.id %>",
|
|
1677
|
+
"List the installed packages in the org with username me@example.com:\n<%= config.bin %> <%= command.id %> --target-org me@example.com"
|
|
1678
|
+
],
|
|
1679
|
+
"deprecateAliases": true,
|
|
1680
|
+
"flags": {
|
|
1681
|
+
"json": {
|
|
1682
|
+
"name": "json",
|
|
1683
|
+
"type": "boolean",
|
|
1684
|
+
"description": "Format output as json.",
|
|
1685
|
+
"helpGroup": "GLOBAL",
|
|
1686
|
+
"allowNo": false,
|
|
1687
|
+
"deprecateAliases": true
|
|
1688
|
+
},
|
|
1689
|
+
"loglevel": {
|
|
1690
|
+
"name": "loglevel",
|
|
1691
|
+
"type": "option",
|
|
1692
|
+
"hidden": true,
|
|
1693
|
+
"multiple": false,
|
|
1694
|
+
"deprecated": {
|
|
1695
|
+
"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."
|
|
1696
|
+
},
|
|
1697
|
+
"deprecateAliases": true
|
|
1698
|
+
},
|
|
1699
|
+
"target-org": {
|
|
1700
|
+
"name": "target-org",
|
|
1701
|
+
"type": "option",
|
|
1702
|
+
"char": "o",
|
|
1703
|
+
"summary": "Username or alias of the target org.",
|
|
1704
|
+
"required": true,
|
|
1705
|
+
"multiple": false,
|
|
1706
|
+
"deprecateAliases": true,
|
|
1707
|
+
"aliases": [
|
|
1708
|
+
"targetusername",
|
|
1709
|
+
"u"
|
|
1710
|
+
]
|
|
1711
|
+
},
|
|
1712
|
+
"api-version": {
|
|
1713
|
+
"name": "api-version",
|
|
1714
|
+
"type": "option",
|
|
1715
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1716
|
+
"multiple": false,
|
|
1717
|
+
"deprecateAliases": true,
|
|
1718
|
+
"aliases": [
|
|
1719
|
+
"apiversion"
|
|
1720
|
+
]
|
|
1721
|
+
}
|
|
1722
|
+
},
|
|
1723
|
+
"args": {},
|
|
1724
|
+
"requiresProject": true,
|
|
1725
|
+
"hasDynamicHelp": true
|
|
1726
|
+
},
|
|
1727
|
+
"package:uninstall:report": {
|
|
1728
|
+
"id": "package:uninstall:report",
|
|
1729
|
+
"summary": "Retrieve the status of a package uninstall request.",
|
|
1730
|
+
"strict": true,
|
|
1731
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
1732
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
1733
|
+
"pluginType": "jit",
|
|
1734
|
+
"aliases": [
|
|
1735
|
+
"force:package:beta:uninstall:report",
|
|
1736
|
+
"force:package:uninstall:report"
|
|
1737
|
+
],
|
|
1738
|
+
"examples": [
|
|
1739
|
+
"Retrieve the status of a package uninstall in your default org using the specified request ID:\n<%= config.bin %> <%= command.id %> --request-id 06y...",
|
|
1740
|
+
"Similar to previous example, but use the org with username me@example.com:\n<%= config.bin %> <%= command.id %> --request-id 06y... --target-org me@example.com"
|
|
1741
|
+
],
|
|
1742
|
+
"deprecateAliases": true,
|
|
1743
|
+
"flags": {
|
|
1744
|
+
"json": {
|
|
1745
|
+
"name": "json",
|
|
1746
|
+
"type": "boolean",
|
|
1747
|
+
"description": "Format output as json.",
|
|
1748
|
+
"helpGroup": "GLOBAL",
|
|
1749
|
+
"allowNo": false,
|
|
1750
|
+
"deprecateAliases": true
|
|
1751
|
+
},
|
|
1752
|
+
"loglevel": {
|
|
1753
|
+
"name": "loglevel",
|
|
1754
|
+
"type": "option",
|
|
1755
|
+
"hidden": true,
|
|
1756
|
+
"multiple": false,
|
|
1757
|
+
"deprecated": {
|
|
1758
|
+
"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."
|
|
1759
|
+
},
|
|
1760
|
+
"deprecateAliases": true
|
|
1761
|
+
},
|
|
1762
|
+
"target-org": {
|
|
1763
|
+
"name": "target-org",
|
|
1764
|
+
"type": "option",
|
|
1765
|
+
"char": "o",
|
|
1766
|
+
"summary": "Username or alias of the target org.",
|
|
1767
|
+
"required": true,
|
|
1768
|
+
"multiple": false,
|
|
1769
|
+
"deprecateAliases": true,
|
|
1770
|
+
"aliases": [
|
|
1771
|
+
"targetusername",
|
|
1772
|
+
"u"
|
|
1773
|
+
]
|
|
1774
|
+
},
|
|
1775
|
+
"api-version": {
|
|
1776
|
+
"name": "api-version",
|
|
1777
|
+
"type": "option",
|
|
1778
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1779
|
+
"multiple": false,
|
|
1780
|
+
"deprecateAliases": true,
|
|
1781
|
+
"aliases": [
|
|
1782
|
+
"apiversion"
|
|
1783
|
+
]
|
|
1784
|
+
},
|
|
1785
|
+
"request-id": {
|
|
1786
|
+
"name": "request-id",
|
|
1787
|
+
"type": "option",
|
|
1788
|
+
"char": "i",
|
|
1789
|
+
"summary": "ID of the package uninstall request you want to check; starts with 06y.",
|
|
1790
|
+
"required": true,
|
|
1791
|
+
"multiple": false,
|
|
1792
|
+
"deprecateAliases": true,
|
|
1793
|
+
"aliases": [
|
|
1794
|
+
"requestid"
|
|
1795
|
+
]
|
|
1796
|
+
}
|
|
1797
|
+
},
|
|
1798
|
+
"args": {},
|
|
1799
|
+
"hasDynamicHelp": true
|
|
1800
|
+
},
|
|
1801
|
+
"package:version:create": {
|
|
1802
|
+
"id": "package:version:create",
|
|
1803
|
+
"summary": "Create a package version in the Dev Hub org.",
|
|
1804
|
+
"description": "The package version is based on the package contents in the specified directory.\n\nTo retrieve details about a package version create request, including status and package version ID (04t), run \"<%= config.bin %> package version create report -i 08c...\".\n\nWe recommend that you specify the --installation-key parameter to protect the contents of your package and to prevent unauthorized installation of your package.\n\nTo list package version creation requests in the org, run \"<%= config.bin %> package version create list\".\nTo promote a package version to released, you must use the --code-coverage parameter. The package must also meet the code coverage requirements. This requirement applies to both managed and unlocked packages.\n\nWe don’t calculate code coverage for org-dependent unlocked packages, or for package versions that specify --skip-validation.",
|
|
1805
|
+
"strict": true,
|
|
1806
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
1807
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
1808
|
+
"pluginType": "jit",
|
|
1809
|
+
"aliases": [
|
|
1810
|
+
"force:package:beta:version:create",
|
|
1811
|
+
"force:package:version:create"
|
|
1812
|
+
],
|
|
1813
|
+
"examples": [
|
|
1814
|
+
"Create a package version from the contents of the \"common\" directory and give it an installation key of \"password123\"; uses your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --path common --installation-key password123",
|
|
1815
|
+
"Create a package version from a package with the specified alias; uses the Dev Hub org with username devhub@example.com:\n<%= config.bin %> <%= command.id %> --package \"Your Package Alias\" --installation-key password123 --target-hub-org devhub@example.com",
|
|
1816
|
+
"Create a package version from a package with the specified ID:\n<%= config.bin %> <%= command.id %> --package 0Ho... --installation-key password123",
|
|
1817
|
+
"Create a package version and skip the validation step:\n<%= config.bin %> <%= command.id %> --path common --installation-key password123 --skip-validation"
|
|
1818
|
+
],
|
|
1819
|
+
"deprecateAliases": true,
|
|
1820
|
+
"flags": {
|
|
1821
|
+
"json": {
|
|
1822
|
+
"name": "json",
|
|
1823
|
+
"type": "boolean",
|
|
1824
|
+
"description": "Format output as json.",
|
|
1825
|
+
"helpGroup": "GLOBAL",
|
|
1826
|
+
"allowNo": false,
|
|
1827
|
+
"deprecateAliases": true
|
|
1828
|
+
},
|
|
1829
|
+
"loglevel": {
|
|
1830
|
+
"name": "loglevel",
|
|
1831
|
+
"type": "option",
|
|
1832
|
+
"hidden": true,
|
|
1833
|
+
"multiple": false,
|
|
1834
|
+
"deprecated": {
|
|
1835
|
+
"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."
|
|
1836
|
+
},
|
|
1837
|
+
"deprecateAliases": true
|
|
1838
|
+
},
|
|
1839
|
+
"target-hub-org": {
|
|
1840
|
+
"name": "target-hub-org",
|
|
1841
|
+
"type": "option",
|
|
1842
|
+
"char": "v",
|
|
1843
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
1844
|
+
"required": true,
|
|
1845
|
+
"multiple": false,
|
|
1846
|
+
"deprecateAliases": true,
|
|
1847
|
+
"aliases": [
|
|
1848
|
+
"targetdevhubusername"
|
|
1849
|
+
]
|
|
1850
|
+
},
|
|
1851
|
+
"api-version": {
|
|
1852
|
+
"name": "api-version",
|
|
1853
|
+
"type": "option",
|
|
1854
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1855
|
+
"multiple": false,
|
|
1856
|
+
"deprecateAliases": true,
|
|
1857
|
+
"aliases": [
|
|
1858
|
+
"apiversion"
|
|
1859
|
+
]
|
|
1860
|
+
},
|
|
1861
|
+
"branch": {
|
|
1862
|
+
"name": "branch",
|
|
1863
|
+
"type": "option",
|
|
1864
|
+
"char": "b",
|
|
1865
|
+
"summary": "Name of the branch in your source control system that the package version is based on.",
|
|
1866
|
+
"multiple": false,
|
|
1867
|
+
"deprecateAliases": true
|
|
1868
|
+
},
|
|
1869
|
+
"build-instance": {
|
|
1870
|
+
"name": "build-instance",
|
|
1871
|
+
"type": "option",
|
|
1872
|
+
"char": "s",
|
|
1873
|
+
"summary": "Instance where the package version will be created, such as NA50.",
|
|
1874
|
+
"hidden": true,
|
|
1875
|
+
"multiple": false,
|
|
1876
|
+
"deprecateAliases": true,
|
|
1877
|
+
"aliases": [
|
|
1878
|
+
"buildinstance"
|
|
1879
|
+
]
|
|
1880
|
+
},
|
|
1881
|
+
"code-coverage": {
|
|
1882
|
+
"name": "code-coverage",
|
|
1883
|
+
"type": "boolean",
|
|
1884
|
+
"char": "c",
|
|
1885
|
+
"summary": "Calculate and store the code coverage percentage by running the packaged Apex tests included in this package version.",
|
|
1886
|
+
"description": "Before you can promote and release a managed or unlocked package version, the Apex code must meet a minimum 75% code coverage requirement. We don’t calculate code coverage for org-dependent unlocked packages or for package versions that specify --skip-validation.",
|
|
1887
|
+
"allowNo": false,
|
|
1888
|
+
"exclusive": [
|
|
1889
|
+
"skip-validation"
|
|
1890
|
+
],
|
|
1891
|
+
"deprecateAliases": true,
|
|
1892
|
+
"aliases": [
|
|
1893
|
+
"codecoverage"
|
|
1894
|
+
]
|
|
1895
|
+
},
|
|
1896
|
+
"definition-file": {
|
|
1897
|
+
"name": "definition-file",
|
|
1898
|
+
"type": "option",
|
|
1899
|
+
"char": "f",
|
|
1900
|
+
"summary": "Path to a definition file similar to scratch org definition file that contains the list of features and org preferences that the metadata of the package version depends on.",
|
|
1901
|
+
"multiple": false,
|
|
1902
|
+
"deprecateAliases": true,
|
|
1903
|
+
"aliases": [
|
|
1904
|
+
"definitionfile"
|
|
1905
|
+
]
|
|
1906
|
+
},
|
|
1907
|
+
"installation-key": {
|
|
1908
|
+
"name": "installation-key",
|
|
1909
|
+
"type": "option",
|
|
1910
|
+
"char": "k",
|
|
1911
|
+
"summary": "Installation key for key-protected package. (either --installation-key or --installation-key-bypass is required)",
|
|
1912
|
+
"multiple": false,
|
|
1913
|
+
"deprecateAliases": true,
|
|
1914
|
+
"aliases": [
|
|
1915
|
+
"installationkey"
|
|
1916
|
+
]
|
|
1917
|
+
},
|
|
1918
|
+
"installation-key-bypass": {
|
|
1919
|
+
"name": "installation-key-bypass",
|
|
1920
|
+
"type": "boolean",
|
|
1921
|
+
"char": "x",
|
|
1922
|
+
"summary": "Bypass the installation key requirement. (either --installation-key or --installation-key-bypass is required)",
|
|
1923
|
+
"description": "If you bypass this requirement, anyone can install your package.",
|
|
1924
|
+
"allowNo": false,
|
|
1925
|
+
"deprecateAliases": true,
|
|
1926
|
+
"aliases": [
|
|
1927
|
+
"installationkeybypass"
|
|
1928
|
+
]
|
|
1929
|
+
},
|
|
1930
|
+
"package": {
|
|
1931
|
+
"name": "package",
|
|
1932
|
+
"type": "option",
|
|
1933
|
+
"char": "p",
|
|
1934
|
+
"summary": "ID (starts with 0Ho) or alias of the package to create a version of.",
|
|
1935
|
+
"multiple": false,
|
|
1936
|
+
"deprecateAliases": true
|
|
1937
|
+
},
|
|
1938
|
+
"path": {
|
|
1939
|
+
"name": "path",
|
|
1940
|
+
"type": "option",
|
|
1941
|
+
"char": "d",
|
|
1942
|
+
"summary": "Path to the directory that contains the contents of the package.",
|
|
1943
|
+
"multiple": false,
|
|
1944
|
+
"deprecateAliases": true
|
|
1945
|
+
},
|
|
1946
|
+
"post-install-script": {
|
|
1947
|
+
"name": "post-install-script",
|
|
1948
|
+
"type": "option",
|
|
1949
|
+
"summary": "Name of the post-install script; applies to managed packages only.",
|
|
1950
|
+
"description": "The post-install script is an Apex class within this package that is run in the installing org after installations or upgrades of this package version.",
|
|
1951
|
+
"multiple": false,
|
|
1952
|
+
"deprecateAliases": true,
|
|
1953
|
+
"aliases": [
|
|
1954
|
+
"postinstallscript"
|
|
1955
|
+
]
|
|
1956
|
+
},
|
|
1957
|
+
"post-install-url": {
|
|
1958
|
+
"name": "post-install-url",
|
|
1959
|
+
"type": "option",
|
|
1960
|
+
"summary": "Post-install instructions URL.",
|
|
1961
|
+
"description": "The contents of the post-installation instructions URL are displayed in the UI after installation of the package version.",
|
|
1962
|
+
"multiple": false,
|
|
1963
|
+
"deprecateAliases": true,
|
|
1964
|
+
"aliases": [
|
|
1965
|
+
"postinstallurl"
|
|
1966
|
+
]
|
|
1967
|
+
},
|
|
1968
|
+
"preserve": {
|
|
1969
|
+
"name": "preserve",
|
|
1970
|
+
"type": "boolean",
|
|
1971
|
+
"char": "r",
|
|
1972
|
+
"summary": "Preserve temp files that would otherwise be deleted.",
|
|
1973
|
+
"hidden": true,
|
|
1974
|
+
"allowNo": false,
|
|
1975
|
+
"deprecateAliases": true
|
|
1976
|
+
},
|
|
1977
|
+
"releasenotes-url": {
|
|
1978
|
+
"name": "releasenotes-url",
|
|
1979
|
+
"type": "option",
|
|
1980
|
+
"summary": "Release notes URL.",
|
|
1981
|
+
"description": "This link is displayed in the package installation UI to provide release notes for this package version to subscribers.",
|
|
1982
|
+
"multiple": false,
|
|
1983
|
+
"deprecateAliases": true,
|
|
1984
|
+
"aliases": [
|
|
1985
|
+
"releasenotesurl"
|
|
1986
|
+
]
|
|
1987
|
+
},
|
|
1988
|
+
"skip-ancestor-check": {
|
|
1989
|
+
"name": "skip-ancestor-check",
|
|
1990
|
+
"type": "boolean",
|
|
1991
|
+
"summary": "Overrides ancestry requirements, which allows you to specify a package ancestor that isn’t the highest released package version.",
|
|
1992
|
+
"allowNo": false,
|
|
1993
|
+
"deprecateAliases": true,
|
|
1994
|
+
"aliases": [
|
|
1995
|
+
"skipancestorcheck"
|
|
1996
|
+
]
|
|
1997
|
+
},
|
|
1998
|
+
"skip-validation": {
|
|
1999
|
+
"name": "skip-validation",
|
|
2000
|
+
"type": "boolean",
|
|
2001
|
+
"summary": "Skip validation during package version creation; you can’t promote unvalidated package versions.",
|
|
2002
|
+
"description": "Skips validation of dependencies, package ancestors, and metadata during package version creation. Skipping validation reduces the time it takes to create a new package version, but you can promote only validated package versions. Skipping validation can suppress important errors that can surface at a later stage. You can specify skip validation or code coverage, but not both. Code coverage is calculated during validation.",
|
|
2003
|
+
"allowNo": false,
|
|
2004
|
+
"exclusive": [
|
|
2005
|
+
"code-coverage"
|
|
2006
|
+
],
|
|
2007
|
+
"deprecateAliases": true,
|
|
2008
|
+
"aliases": [
|
|
2009
|
+
"skipvalidation"
|
|
2010
|
+
]
|
|
2011
|
+
},
|
|
2012
|
+
"tag": {
|
|
2013
|
+
"name": "tag",
|
|
2014
|
+
"type": "option",
|
|
2015
|
+
"char": "t",
|
|
2016
|
+
"summary": "Package version’s tag.",
|
|
2017
|
+
"multiple": false,
|
|
2018
|
+
"deprecateAliases": true
|
|
2019
|
+
},
|
|
2020
|
+
"uninstall-script": {
|
|
2021
|
+
"name": "uninstall-script",
|
|
2022
|
+
"type": "option",
|
|
2023
|
+
"summary": "Uninstall script name; applies to managed packages only.",
|
|
2024
|
+
"description": "The uninstall script is an Apex class within this package that is run in the installing org after uninstallations of this package.",
|
|
2025
|
+
"multiple": false,
|
|
2026
|
+
"deprecateAliases": true,
|
|
2027
|
+
"aliases": [
|
|
2028
|
+
"uninstallscript"
|
|
2029
|
+
]
|
|
2030
|
+
},
|
|
2031
|
+
"validate-schema": {
|
|
2032
|
+
"name": "validate-schema",
|
|
2033
|
+
"type": "boolean",
|
|
2034
|
+
"char": "j",
|
|
2035
|
+
"summary": "Validate the sfdx-project.json file against the JSON schema.",
|
|
2036
|
+
"hidden": true,
|
|
2037
|
+
"allowNo": false,
|
|
2038
|
+
"deprecateAliases": true,
|
|
2039
|
+
"aliases": [
|
|
2040
|
+
"validateschema"
|
|
2041
|
+
]
|
|
2042
|
+
},
|
|
2043
|
+
"version-description": {
|
|
2044
|
+
"name": "version-description",
|
|
2045
|
+
"type": "option",
|
|
2046
|
+
"char": "e",
|
|
2047
|
+
"summary": "Description of the package version to be created; overrides the sfdx-project.json value.",
|
|
2048
|
+
"multiple": false,
|
|
2049
|
+
"deprecateAliases": true,
|
|
2050
|
+
"aliases": [
|
|
2051
|
+
"versiondescription"
|
|
2052
|
+
]
|
|
2053
|
+
},
|
|
2054
|
+
"version-name": {
|
|
2055
|
+
"name": "version-name",
|
|
2056
|
+
"type": "option",
|
|
2057
|
+
"char": "a",
|
|
2058
|
+
"summary": "Name of the package version to be created; overrides the sfdx-project.json value.",
|
|
2059
|
+
"multiple": false,
|
|
2060
|
+
"deprecateAliases": true,
|
|
2061
|
+
"aliases": [
|
|
2062
|
+
"versionname"
|
|
2063
|
+
]
|
|
2064
|
+
},
|
|
2065
|
+
"version-number": {
|
|
2066
|
+
"name": "version-number",
|
|
2067
|
+
"type": "option",
|
|
2068
|
+
"char": "n",
|
|
2069
|
+
"summary": "Version number of the package version to be created; overrides the sfdx-project.json value.",
|
|
2070
|
+
"multiple": false,
|
|
2071
|
+
"deprecateAliases": true,
|
|
2072
|
+
"aliases": [
|
|
2073
|
+
"versionnumber"
|
|
2074
|
+
]
|
|
2075
|
+
},
|
|
2076
|
+
"wait": {
|
|
2077
|
+
"name": "wait",
|
|
2078
|
+
"type": "option",
|
|
2079
|
+
"char": "w",
|
|
2080
|
+
"summary": "Number of minutes to wait for the package version to be created.",
|
|
2081
|
+
"multiple": false,
|
|
2082
|
+
"default": {
|
|
2083
|
+
"quantity": 0,
|
|
2084
|
+
"unit": 0
|
|
2085
|
+
},
|
|
2086
|
+
"deprecateAliases": true
|
|
2087
|
+
},
|
|
2088
|
+
"language": {
|
|
2089
|
+
"name": "language",
|
|
2090
|
+
"type": "option",
|
|
2091
|
+
"summary": "Language for the package.",
|
|
2092
|
+
"description": "Specify the language using a language code listed under \"Supported Languages\" in Salesforce Help. If no language is specified, the language defaults to the language of the Dev Hub user who created the package.",
|
|
2093
|
+
"multiple": false,
|
|
2094
|
+
"deprecateAliases": true
|
|
2095
|
+
},
|
|
2096
|
+
"verbose": {
|
|
2097
|
+
"name": "verbose",
|
|
2098
|
+
"type": "boolean",
|
|
2099
|
+
"summary": "Display verbose command output.",
|
|
2100
|
+
"description": "Display verbose command output. When polling for the status of the creation, this will output status and timeout data on a separate line for each poll request, which is useful in CI systems where timeouts can occur with long periods of no output from commands.",
|
|
2101
|
+
"allowNo": false,
|
|
2102
|
+
"deprecateAliases": true
|
|
2103
|
+
}
|
|
2104
|
+
},
|
|
2105
|
+
"args": {},
|
|
2106
|
+
"requiresProject": true,
|
|
2107
|
+
"hasDynamicHelp": true
|
|
2108
|
+
},
|
|
2109
|
+
"package:version:delete": {
|
|
2110
|
+
"id": "package:version:delete",
|
|
2111
|
+
"summary": "Delete a package version.",
|
|
2112
|
+
"description": "Specify the ID or alias of the package version you want to delete.",
|
|
2113
|
+
"strict": true,
|
|
2114
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
2115
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
2116
|
+
"pluginType": "jit",
|
|
2117
|
+
"aliases": [
|
|
2118
|
+
"force:package:beta:version:delete",
|
|
2119
|
+
"force:package:version:delete"
|
|
2120
|
+
],
|
|
2121
|
+
"examples": [
|
|
2122
|
+
"Delete a package version with the specified alias using your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --package \"Your Package Alias\"",
|
|
2123
|
+
"Delete a package version with the specified ID using the Dev Hub org with username \"devhub@example.com\":\n<%= config.bin %> <%= command.id %> --package 04t... --target-org devhub@example.com"
|
|
2124
|
+
],
|
|
2125
|
+
"deprecateAliases": true,
|
|
2126
|
+
"flags": {
|
|
2127
|
+
"json": {
|
|
2128
|
+
"name": "json",
|
|
2129
|
+
"type": "boolean",
|
|
2130
|
+
"description": "Format output as json.",
|
|
2131
|
+
"helpGroup": "GLOBAL",
|
|
2132
|
+
"allowNo": false,
|
|
2133
|
+
"deprecateAliases": true
|
|
2134
|
+
},
|
|
2135
|
+
"loglevel": {
|
|
2136
|
+
"name": "loglevel",
|
|
2137
|
+
"type": "option",
|
|
2138
|
+
"hidden": true,
|
|
2139
|
+
"multiple": false,
|
|
2140
|
+
"deprecated": {
|
|
2141
|
+
"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."
|
|
2142
|
+
},
|
|
2143
|
+
"deprecateAliases": true
|
|
2144
|
+
},
|
|
2145
|
+
"target-hub-org": {
|
|
2146
|
+
"name": "target-hub-org",
|
|
2147
|
+
"type": "option",
|
|
2148
|
+
"char": "v",
|
|
2149
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
2150
|
+
"required": true,
|
|
2151
|
+
"multiple": false,
|
|
2152
|
+
"deprecateAliases": true,
|
|
2153
|
+
"aliases": [
|
|
2154
|
+
"targetdevhubusername"
|
|
2155
|
+
]
|
|
2156
|
+
},
|
|
2157
|
+
"api-version": {
|
|
2158
|
+
"name": "api-version",
|
|
2159
|
+
"type": "option",
|
|
2160
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2161
|
+
"multiple": false,
|
|
2162
|
+
"deprecateAliases": true,
|
|
2163
|
+
"aliases": [
|
|
2164
|
+
"apiversion"
|
|
2165
|
+
]
|
|
2166
|
+
},
|
|
2167
|
+
"no-prompt": {
|
|
2168
|
+
"name": "no-prompt",
|
|
2169
|
+
"type": "boolean",
|
|
2170
|
+
"char": "n",
|
|
2171
|
+
"summary": "Don’t prompt before deleting the package version.",
|
|
2172
|
+
"allowNo": false,
|
|
2173
|
+
"deprecateAliases": true,
|
|
2174
|
+
"aliases": [
|
|
2175
|
+
"noprompt"
|
|
2176
|
+
]
|
|
2177
|
+
},
|
|
2178
|
+
"package": {
|
|
2179
|
+
"name": "package",
|
|
2180
|
+
"type": "option",
|
|
2181
|
+
"char": "p",
|
|
2182
|
+
"summary": "ID (starts with 04t) or alias of the package version to delete.",
|
|
2183
|
+
"required": true,
|
|
2184
|
+
"multiple": false,
|
|
2185
|
+
"deprecateAliases": true
|
|
2186
|
+
},
|
|
2187
|
+
"undelete": {
|
|
2188
|
+
"name": "undelete",
|
|
2189
|
+
"type": "boolean",
|
|
2190
|
+
"summary": "Undelete a deleted package version.",
|
|
2191
|
+
"hidden": true,
|
|
2192
|
+
"allowNo": false,
|
|
2193
|
+
"deprecateAliases": true
|
|
2194
|
+
}
|
|
2195
|
+
},
|
|
2196
|
+
"args": {},
|
|
2197
|
+
"requiresProject": true,
|
|
2198
|
+
"hasDynamicHelp": true
|
|
2199
|
+
},
|
|
2200
|
+
"package:version:displayancestry": {
|
|
2201
|
+
"id": "package:version:displayancestry",
|
|
2202
|
+
"summary": "Display the ancestry tree for a 2GP managed package version.",
|
|
2203
|
+
"strict": true,
|
|
2204
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
2205
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
2206
|
+
"pluginType": "jit",
|
|
2207
|
+
"aliases": [
|
|
2208
|
+
"force:package:beta:version:displayancestry",
|
|
2209
|
+
"force:package:version:displayancestry"
|
|
2210
|
+
],
|
|
2211
|
+
"examples": [
|
|
2212
|
+
"Display the ancestry tree for a package version with the specified alias, using your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --package package_version_alias",
|
|
2213
|
+
"Similar to previous example, but display the output in DOT code:\n<%= config.bin %> <%= command.id %> --package package_version_alias --dot-code",
|
|
2214
|
+
"Display the ancestry tree for a package with the specified ID, using the Dev Hub org with username devhub@example.com:\n<%= config.bin %> <%= command.id %> --package OHo... --target-hub-org devhub@example.com",
|
|
2215
|
+
"Display the ancestry tree of a package version with the specified ID, using your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --package 04t..."
|
|
2216
|
+
],
|
|
2217
|
+
"deprecateAliases": true,
|
|
2218
|
+
"flags": {
|
|
2219
|
+
"json": {
|
|
2220
|
+
"name": "json",
|
|
2221
|
+
"type": "boolean",
|
|
2222
|
+
"description": "Format output as json.",
|
|
2223
|
+
"helpGroup": "GLOBAL",
|
|
2224
|
+
"allowNo": false,
|
|
2225
|
+
"deprecateAliases": true
|
|
2226
|
+
},
|
|
2227
|
+
"loglevel": {
|
|
2228
|
+
"name": "loglevel",
|
|
2229
|
+
"type": "option",
|
|
2230
|
+
"hidden": true,
|
|
2231
|
+
"multiple": false,
|
|
2232
|
+
"deprecated": {
|
|
2233
|
+
"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."
|
|
2234
|
+
},
|
|
2235
|
+
"deprecateAliases": true
|
|
2236
|
+
},
|
|
2237
|
+
"target-hub-org": {
|
|
2238
|
+
"name": "target-hub-org",
|
|
2239
|
+
"type": "option",
|
|
2240
|
+
"char": "v",
|
|
2241
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
2242
|
+
"required": true,
|
|
2243
|
+
"multiple": false,
|
|
2244
|
+
"deprecateAliases": true,
|
|
2245
|
+
"aliases": [
|
|
2246
|
+
"targetdevhubusername"
|
|
2247
|
+
]
|
|
2248
|
+
},
|
|
2249
|
+
"api-version": {
|
|
2250
|
+
"name": "api-version",
|
|
2251
|
+
"type": "option",
|
|
2252
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2253
|
+
"multiple": false,
|
|
2254
|
+
"deprecateAliases": true,
|
|
2255
|
+
"aliases": [
|
|
2256
|
+
"apiversion"
|
|
2257
|
+
]
|
|
2258
|
+
},
|
|
2259
|
+
"package": {
|
|
2260
|
+
"name": "package",
|
|
2261
|
+
"type": "option",
|
|
2262
|
+
"char": "p",
|
|
2263
|
+
"summary": "ID or alias of the package (starts with 0Ho) or package version (starts with 04t) to display ancestry for.",
|
|
2264
|
+
"description": "If you specify a package ID (starts with 0Ho) or alias, the ancestor tree for every package version associated with the package ID is displayed. If you specify a package version (starts with 04t) or alias, the ancestry tree of the specified package version is displayed.",
|
|
2265
|
+
"required": true,
|
|
2266
|
+
"multiple": false,
|
|
2267
|
+
"deprecateAliases": true
|
|
2268
|
+
},
|
|
2269
|
+
"dot-code": {
|
|
2270
|
+
"name": "dot-code",
|
|
2271
|
+
"type": "boolean",
|
|
2272
|
+
"summary": "Display the ancestry tree in DOT code.",
|
|
2273
|
+
"description": "You can use the DOT code output in graph visualization software to create tree visualizations.",
|
|
2274
|
+
"allowNo": false,
|
|
2275
|
+
"deprecateAliases": true,
|
|
2276
|
+
"aliases": [
|
|
2277
|
+
"dotcode"
|
|
2278
|
+
]
|
|
2279
|
+
},
|
|
2280
|
+
"verbose": {
|
|
2281
|
+
"name": "verbose",
|
|
2282
|
+
"type": "boolean",
|
|
2283
|
+
"summary": "Display both the package version ID (starts with 04t) and the version number (major.minor.patch.build) in the ancestry tree.",
|
|
2284
|
+
"allowNo": false,
|
|
2285
|
+
"deprecateAliases": true
|
|
2286
|
+
}
|
|
2287
|
+
},
|
|
2288
|
+
"args": {},
|
|
2289
|
+
"requiresProject": true,
|
|
2290
|
+
"hasDynamicHelp": true
|
|
2291
|
+
},
|
|
2292
|
+
"package:version:list": {
|
|
2293
|
+
"id": "package:version:list",
|
|
2294
|
+
"summary": "List all package versions in the Dev Hub org.",
|
|
2295
|
+
"description": "Description",
|
|
2296
|
+
"strict": true,
|
|
2297
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
2298
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
2299
|
+
"pluginType": "jit",
|
|
2300
|
+
"aliases": [
|
|
2301
|
+
"force:package:beta:version:list",
|
|
2302
|
+
"force:package:version:list"
|
|
2303
|
+
],
|
|
2304
|
+
"examples": [
|
|
2305
|
+
"List package versions in your default Dev Hub org that were created in the last 3 days; show only the released versions and order the list using the PatchVersion field. Display extended details about each package version:\n<%= config.bin %> <%= command.id %> --verbose --created-last-days 3 --released --order-by PatchVersion",
|
|
2306
|
+
"List the released package versions for the two specified packages that were modified today; use the Dev Hub org with username devhub@example.com:\n<%= config.bin %> <%= command.id %> --packages 0Ho000000000000,0Ho000000000001 --released --modified-last-days 0 --target-hub-org devhub@example.com",
|
|
2307
|
+
"List all released package versions in your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --released",
|
|
2308
|
+
"List package versions that were modified today in your default Dev Hub org; show limited details about each one:\n<%= config.bin %> <%= command.id %> --concise --modified-last-days 0",
|
|
2309
|
+
"List released package versions that were created in the last 3 days in your default Dev Hub org; show limited details:\n<%= config.bin %> <%= command.id %> --concise --created-last-days 3 --released",
|
|
2310
|
+
"List released package versions that were modified today for the two packages with specified aliases in your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --packages exp-mgr,exp-mgr-util --released --modified-last-days 0"
|
|
2311
|
+
],
|
|
2312
|
+
"deprecateAliases": true,
|
|
2313
|
+
"flags": {
|
|
2314
|
+
"json": {
|
|
2315
|
+
"name": "json",
|
|
2316
|
+
"type": "boolean",
|
|
2317
|
+
"description": "Format output as json.",
|
|
2318
|
+
"helpGroup": "GLOBAL",
|
|
2319
|
+
"allowNo": false,
|
|
2320
|
+
"deprecateAliases": true
|
|
2321
|
+
},
|
|
2322
|
+
"loglevel": {
|
|
2323
|
+
"name": "loglevel",
|
|
2324
|
+
"type": "option",
|
|
2325
|
+
"hidden": true,
|
|
2326
|
+
"multiple": false,
|
|
2327
|
+
"deprecated": {
|
|
2328
|
+
"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."
|
|
2329
|
+
},
|
|
2330
|
+
"deprecateAliases": true
|
|
2331
|
+
},
|
|
2332
|
+
"target-hub-org": {
|
|
2333
|
+
"name": "target-hub-org",
|
|
2334
|
+
"type": "option",
|
|
2335
|
+
"char": "v",
|
|
2336
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
2337
|
+
"required": true,
|
|
2338
|
+
"multiple": false,
|
|
2339
|
+
"deprecateAliases": true,
|
|
2340
|
+
"aliases": [
|
|
2341
|
+
"targetdevhubusername"
|
|
2342
|
+
]
|
|
2343
|
+
},
|
|
2344
|
+
"api-version": {
|
|
2345
|
+
"name": "api-version",
|
|
2346
|
+
"type": "option",
|
|
2347
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2348
|
+
"multiple": false,
|
|
2349
|
+
"deprecateAliases": true,
|
|
2350
|
+
"aliases": [
|
|
2351
|
+
"apiversion"
|
|
2352
|
+
]
|
|
2353
|
+
},
|
|
2354
|
+
"created-last-days": {
|
|
2355
|
+
"name": "created-last-days",
|
|
2356
|
+
"type": "option",
|
|
2357
|
+
"char": "c",
|
|
2358
|
+
"summary": "Number of days since the request was created, starting at 00:00:00 of first day to now. Use 0 for today.",
|
|
2359
|
+
"multiple": false,
|
|
2360
|
+
"deprecateAliases": true,
|
|
2361
|
+
"aliases": [
|
|
2362
|
+
"createdlastdays"
|
|
2363
|
+
]
|
|
2364
|
+
},
|
|
2365
|
+
"concise": {
|
|
2366
|
+
"name": "concise",
|
|
2367
|
+
"type": "boolean",
|
|
2368
|
+
"summary": "Display limited package version details.",
|
|
2369
|
+
"allowNo": false,
|
|
2370
|
+
"deprecateAliases": true
|
|
2371
|
+
},
|
|
2372
|
+
"modified-last-days": {
|
|
2373
|
+
"name": "modified-last-days",
|
|
2374
|
+
"type": "option",
|
|
2375
|
+
"char": "m",
|
|
2376
|
+
"summary": "Number of days since the items were modified, starting at 00:00:00 of first day to now. Use 0 for today.",
|
|
2377
|
+
"multiple": false,
|
|
2378
|
+
"deprecateAliases": true,
|
|
2379
|
+
"aliases": [
|
|
2380
|
+
"modifiedlastdays"
|
|
2381
|
+
]
|
|
2382
|
+
},
|
|
2383
|
+
"packages": {
|
|
2384
|
+
"name": "packages",
|
|
2385
|
+
"type": "option",
|
|
2386
|
+
"char": "p",
|
|
2387
|
+
"summary": "Comma-delimited list of packages (aliases or 0Ho IDs) to list.",
|
|
2388
|
+
"multiple": false,
|
|
2389
|
+
"deprecateAliases": true
|
|
2390
|
+
},
|
|
2391
|
+
"released": {
|
|
2392
|
+
"name": "released",
|
|
2393
|
+
"type": "boolean",
|
|
2394
|
+
"char": "r",
|
|
2395
|
+
"summary": "Display released versions only (IsReleased=true).",
|
|
2396
|
+
"allowNo": false,
|
|
2397
|
+
"deprecateAliases": true
|
|
2398
|
+
},
|
|
2399
|
+
"order-by": {
|
|
2400
|
+
"name": "order-by",
|
|
2401
|
+
"type": "option",
|
|
2402
|
+
"char": "o",
|
|
2403
|
+
"summary": "Package version fields used to order the list.",
|
|
2404
|
+
"multiple": false,
|
|
2405
|
+
"deprecateAliases": true,
|
|
2406
|
+
"aliases": [
|
|
2407
|
+
"orderby"
|
|
2408
|
+
]
|
|
2409
|
+
},
|
|
2410
|
+
"verbose": {
|
|
2411
|
+
"name": "verbose",
|
|
2412
|
+
"type": "boolean",
|
|
2413
|
+
"summary": "Display extended package version details.",
|
|
2414
|
+
"allowNo": false,
|
|
2415
|
+
"deprecateAliases": true
|
|
2416
|
+
}
|
|
2417
|
+
},
|
|
2418
|
+
"args": {},
|
|
2419
|
+
"hasDynamicHelp": true
|
|
2420
|
+
},
|
|
2421
|
+
"package:version:promote": {
|
|
2422
|
+
"id": "package:version:promote",
|
|
2423
|
+
"summary": "Promote a package version to released.",
|
|
2424
|
+
"description": "Supply the ID or alias of the package version you want to promote. Promotes the package version to released status.",
|
|
2425
|
+
"strict": true,
|
|
2426
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
2427
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
2428
|
+
"pluginType": "jit",
|
|
2429
|
+
"aliases": [
|
|
2430
|
+
"force:package:beta:version:promote",
|
|
2431
|
+
"force:package:version:promote"
|
|
2432
|
+
],
|
|
2433
|
+
"examples": [
|
|
2434
|
+
"Promote the package version with the specified ID to released; uses your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --package 04t...",
|
|
2435
|
+
"Promote the package version with the specified alias to released; uses the Dev Hub org with username devhub@example.com:\n<%= config.bin %> <%= command.id %> --package awesome_package_alias --target-hub-org devhub@example.com",
|
|
2436
|
+
"Promote the package version with an alias that has spaces to released:\n<%= config.bin %> <%= command.id %> --package \"Awesome Package Alias\""
|
|
2437
|
+
],
|
|
2438
|
+
"deprecateAliases": true,
|
|
2439
|
+
"flags": {
|
|
2440
|
+
"json": {
|
|
2441
|
+
"name": "json",
|
|
2442
|
+
"type": "boolean",
|
|
2443
|
+
"description": "Format output as json.",
|
|
2444
|
+
"helpGroup": "GLOBAL",
|
|
2445
|
+
"allowNo": false,
|
|
2446
|
+
"deprecateAliases": true
|
|
2447
|
+
},
|
|
2448
|
+
"loglevel": {
|
|
2449
|
+
"name": "loglevel",
|
|
2450
|
+
"type": "option",
|
|
2451
|
+
"hidden": true,
|
|
2452
|
+
"multiple": false,
|
|
2453
|
+
"deprecated": {
|
|
2454
|
+
"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."
|
|
2455
|
+
},
|
|
2456
|
+
"deprecateAliases": true
|
|
2457
|
+
},
|
|
2458
|
+
"target-hub-org": {
|
|
2459
|
+
"name": "target-hub-org",
|
|
2460
|
+
"type": "option",
|
|
2461
|
+
"char": "v",
|
|
2462
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
2463
|
+
"required": true,
|
|
2464
|
+
"multiple": false,
|
|
2465
|
+
"deprecateAliases": true,
|
|
2466
|
+
"aliases": [
|
|
2467
|
+
"targetdevhubusername"
|
|
2468
|
+
]
|
|
2469
|
+
},
|
|
2470
|
+
"api-version": {
|
|
2471
|
+
"name": "api-version",
|
|
2472
|
+
"type": "option",
|
|
2473
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2474
|
+
"multiple": false,
|
|
2475
|
+
"deprecateAliases": true,
|
|
2476
|
+
"aliases": [
|
|
2477
|
+
"apiversion"
|
|
2478
|
+
]
|
|
2479
|
+
},
|
|
2480
|
+
"package": {
|
|
2481
|
+
"name": "package",
|
|
2482
|
+
"type": "option",
|
|
2483
|
+
"char": "p",
|
|
2484
|
+
"summary": "ID (starts with 04t) or alias of the package version to promote.",
|
|
2485
|
+
"required": true,
|
|
2486
|
+
"multiple": false,
|
|
2487
|
+
"deprecateAliases": true
|
|
2488
|
+
},
|
|
2489
|
+
"no-prompt": {
|
|
2490
|
+
"name": "no-prompt",
|
|
2491
|
+
"type": "boolean",
|
|
2492
|
+
"char": "n",
|
|
2493
|
+
"summary": "Don't prompt to confirm setting the package version as released.",
|
|
2494
|
+
"allowNo": false,
|
|
2495
|
+
"deprecateAliases": true,
|
|
2496
|
+
"aliases": [
|
|
2497
|
+
"noprompt"
|
|
2498
|
+
]
|
|
2499
|
+
}
|
|
2500
|
+
},
|
|
2501
|
+
"args": {},
|
|
2502
|
+
"requiresProject": true,
|
|
2503
|
+
"hasDynamicHelp": true
|
|
2504
|
+
},
|
|
2505
|
+
"package:version:report": {
|
|
2506
|
+
"id": "package:version:report",
|
|
2507
|
+
"summary": "Retrieve details about a package version in the Dev Hub org.",
|
|
2508
|
+
"description": "To update package version values, run \"<%= config.bin %> package version update\".",
|
|
2509
|
+
"strict": true,
|
|
2510
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
2511
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
2512
|
+
"pluginType": "jit",
|
|
2513
|
+
"aliases": [
|
|
2514
|
+
"force:package:beta:version:report",
|
|
2515
|
+
"force:package:version:report"
|
|
2516
|
+
],
|
|
2517
|
+
"examples": [
|
|
2518
|
+
"Retrieve details about the package version with the specified ID from your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --package 04t...",
|
|
2519
|
+
"Retrieve details about the package version with the specified alias (that contains spaces) from the Dev Hub org with username devhub@example.com:\n<%= config.bin %> <%= command.id %> --package \"Your Package Alias\" --target-hub-org devhub@example.com"
|
|
2520
|
+
],
|
|
2521
|
+
"deprecateAliases": true,
|
|
2522
|
+
"flags": {
|
|
2523
|
+
"json": {
|
|
2524
|
+
"name": "json",
|
|
2525
|
+
"type": "boolean",
|
|
2526
|
+
"description": "Format output as json.",
|
|
2527
|
+
"helpGroup": "GLOBAL",
|
|
2528
|
+
"allowNo": false,
|
|
2529
|
+
"deprecateAliases": true
|
|
2530
|
+
},
|
|
2531
|
+
"loglevel": {
|
|
2532
|
+
"name": "loglevel",
|
|
2533
|
+
"type": "option",
|
|
2534
|
+
"hidden": true,
|
|
2535
|
+
"multiple": false,
|
|
2536
|
+
"deprecated": {
|
|
2537
|
+
"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."
|
|
2538
|
+
},
|
|
2539
|
+
"deprecateAliases": true
|
|
2540
|
+
},
|
|
2541
|
+
"target-hub-org": {
|
|
2542
|
+
"name": "target-hub-org",
|
|
2543
|
+
"type": "option",
|
|
2544
|
+
"char": "v",
|
|
2545
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
2546
|
+
"required": true,
|
|
2547
|
+
"multiple": false,
|
|
2548
|
+
"deprecateAliases": true,
|
|
2549
|
+
"aliases": [
|
|
2550
|
+
"targetdevhubusername"
|
|
2551
|
+
]
|
|
2552
|
+
},
|
|
2553
|
+
"api-version": {
|
|
2554
|
+
"name": "api-version",
|
|
2555
|
+
"type": "option",
|
|
2556
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2557
|
+
"multiple": false,
|
|
2558
|
+
"deprecateAliases": true,
|
|
2559
|
+
"aliases": [
|
|
2560
|
+
"apiversion"
|
|
2561
|
+
]
|
|
2562
|
+
},
|
|
2563
|
+
"package": {
|
|
2564
|
+
"name": "package",
|
|
2565
|
+
"type": "option",
|
|
2566
|
+
"char": "p",
|
|
2567
|
+
"summary": "ID (starts with 04t) or alias of the package to retrieve details for.",
|
|
2568
|
+
"required": true,
|
|
2569
|
+
"multiple": false,
|
|
2570
|
+
"deprecateAliases": true
|
|
2571
|
+
},
|
|
2572
|
+
"verbose": {
|
|
2573
|
+
"name": "verbose",
|
|
2574
|
+
"type": "boolean",
|
|
2575
|
+
"summary": "Display extended package version details.",
|
|
2576
|
+
"allowNo": false,
|
|
2577
|
+
"deprecateAliases": true
|
|
2578
|
+
}
|
|
2579
|
+
},
|
|
2580
|
+
"args": {},
|
|
2581
|
+
"requiresProject": true,
|
|
2582
|
+
"hasDynamicHelp": true
|
|
2583
|
+
},
|
|
2584
|
+
"package:version:update": {
|
|
2585
|
+
"id": "package:version:update",
|
|
2586
|
+
"summary": "Update a package version.",
|
|
2587
|
+
"description": "Specify a new value for each option you want to update.\n\nTo display details about a package version, run \"<%= config.bin %> package version display\".",
|
|
2588
|
+
"strict": true,
|
|
2589
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
2590
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
2591
|
+
"pluginType": "jit",
|
|
2592
|
+
"aliases": [
|
|
2593
|
+
"force:package:beta:version:update",
|
|
2594
|
+
"force:package:version:update"
|
|
2595
|
+
],
|
|
2596
|
+
"examples": [
|
|
2597
|
+
"Update the package version that has the specified alias (that contains spaces) with a new installation key \"password123\"; uses your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --package \"Your Package Alias\" --installation-key password123",
|
|
2598
|
+
"Update the package version that has the specified ID with a new branch and tag; use the Dev Hub org with username devhub@example.com:\n<%= config.bin %> <%= command.id %> --package 04t... --branch main --tag 'Release 1.0.7' --target-hub-org devhub@example.com",
|
|
2599
|
+
"Update the package version that has the specified ID with a new description:\n<%= config.bin %> <%= command.id %> --package 04t... --version-description \"New Package Version Description\""
|
|
2600
|
+
],
|
|
2601
|
+
"deprecateAliases": true,
|
|
2602
|
+
"flags": {
|
|
2603
|
+
"json": {
|
|
2604
|
+
"name": "json",
|
|
2605
|
+
"type": "boolean",
|
|
2606
|
+
"description": "Format output as json.",
|
|
2607
|
+
"helpGroup": "GLOBAL",
|
|
2608
|
+
"allowNo": false,
|
|
2609
|
+
"deprecateAliases": true
|
|
2610
|
+
},
|
|
2611
|
+
"loglevel": {
|
|
2612
|
+
"name": "loglevel",
|
|
2613
|
+
"type": "option",
|
|
2614
|
+
"hidden": true,
|
|
2615
|
+
"multiple": false,
|
|
2616
|
+
"deprecated": {
|
|
2617
|
+
"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."
|
|
2618
|
+
},
|
|
2619
|
+
"deprecateAliases": true
|
|
2620
|
+
},
|
|
2621
|
+
"target-hub-org": {
|
|
2622
|
+
"name": "target-hub-org",
|
|
2623
|
+
"type": "option",
|
|
2624
|
+
"char": "v",
|
|
2625
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
2626
|
+
"required": true,
|
|
2627
|
+
"multiple": false,
|
|
2628
|
+
"deprecateAliases": true,
|
|
2629
|
+
"aliases": [
|
|
2630
|
+
"targetdevhubusername"
|
|
2631
|
+
]
|
|
2632
|
+
},
|
|
2633
|
+
"api-version": {
|
|
2634
|
+
"name": "api-version",
|
|
2635
|
+
"type": "option",
|
|
2636
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2637
|
+
"multiple": false,
|
|
2638
|
+
"deprecateAliases": true,
|
|
2639
|
+
"aliases": [
|
|
2640
|
+
"apiversion"
|
|
2641
|
+
]
|
|
2642
|
+
},
|
|
2643
|
+
"package": {
|
|
2644
|
+
"name": "package",
|
|
2645
|
+
"type": "option",
|
|
2646
|
+
"char": "p",
|
|
2647
|
+
"summary": "ID (starts with 04t) or alias of the package to update a version of.",
|
|
2648
|
+
"required": true,
|
|
2649
|
+
"multiple": false,
|
|
2650
|
+
"deprecateAliases": true
|
|
2651
|
+
},
|
|
2652
|
+
"version-name": {
|
|
2653
|
+
"name": "version-name",
|
|
2654
|
+
"type": "option",
|
|
2655
|
+
"char": "a",
|
|
2656
|
+
"summary": "New package version name.",
|
|
2657
|
+
"multiple": false,
|
|
2658
|
+
"deprecateAliases": true,
|
|
2659
|
+
"aliases": [
|
|
2660
|
+
"versionname"
|
|
2661
|
+
]
|
|
2662
|
+
},
|
|
2663
|
+
"version-description": {
|
|
2664
|
+
"name": "version-description",
|
|
2665
|
+
"type": "option",
|
|
2666
|
+
"char": "e",
|
|
2667
|
+
"summary": "New package version description.",
|
|
2668
|
+
"multiple": false,
|
|
2669
|
+
"deprecateAliases": true,
|
|
2670
|
+
"aliases": [
|
|
2671
|
+
"versiondescription"
|
|
2672
|
+
]
|
|
2673
|
+
},
|
|
2674
|
+
"branch": {
|
|
2675
|
+
"name": "branch",
|
|
2676
|
+
"type": "option",
|
|
2677
|
+
"char": "b",
|
|
2678
|
+
"summary": "New package version branch.",
|
|
2679
|
+
"multiple": false,
|
|
2680
|
+
"deprecateAliases": true
|
|
2681
|
+
},
|
|
2682
|
+
"tag": {
|
|
2683
|
+
"name": "tag",
|
|
2684
|
+
"type": "option",
|
|
2685
|
+
"char": "t",
|
|
2686
|
+
"summary": "New package version tag.",
|
|
2687
|
+
"multiple": false,
|
|
2688
|
+
"deprecateAliases": true
|
|
2689
|
+
},
|
|
2690
|
+
"installation-key": {
|
|
2691
|
+
"name": "installation-key",
|
|
2692
|
+
"type": "option",
|
|
2693
|
+
"char": "k",
|
|
2694
|
+
"summary": "New installation key for key-protected package (default: null)",
|
|
2695
|
+
"multiple": false,
|
|
2696
|
+
"deprecateAliases": true,
|
|
2697
|
+
"aliases": [
|
|
2698
|
+
"installationkey"
|
|
2699
|
+
]
|
|
2700
|
+
}
|
|
2701
|
+
},
|
|
2702
|
+
"args": {},
|
|
2703
|
+
"requiresProject": true,
|
|
2704
|
+
"hasDynamicHelp": true
|
|
2705
|
+
},
|
|
2706
|
+
"package1:version:create": {
|
|
2707
|
+
"id": "package1:version:create",
|
|
2708
|
+
"summary": "Create a first-generation package version in the release org.",
|
|
2709
|
+
"description": "The package version is based on the contents of the specified metadata package. Omit --managed-released if you want to create an unmanaged package version.",
|
|
2710
|
+
"strict": true,
|
|
2711
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
2712
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
2713
|
+
"pluginType": "jit",
|
|
2714
|
+
"aliases": [
|
|
2715
|
+
"force:package1:beta:version:create",
|
|
2716
|
+
"force:package1:version:create"
|
|
2717
|
+
],
|
|
2718
|
+
"examples": [
|
|
2719
|
+
"Create a first-generation package version from the package with the specified ID and name the package version \"example\"; use your default org:\n<%= config.bin %> <%= command.id %> --package-id 033... --name example",
|
|
2720
|
+
"Same as previous example, but provide a description and wait for 30 minutes for the package version to be created; use the specified org:\n<%= config.bin %> <%= command.id %> --package-id 033... --name example --description \"example description\" --wait 30 --target-org myorg@example.com"
|
|
2721
|
+
],
|
|
2722
|
+
"deprecateAliases": true,
|
|
2723
|
+
"flags": {
|
|
2724
|
+
"json": {
|
|
2725
|
+
"name": "json",
|
|
2726
|
+
"type": "boolean",
|
|
2727
|
+
"description": "Format output as json.",
|
|
2728
|
+
"helpGroup": "GLOBAL",
|
|
2729
|
+
"allowNo": false,
|
|
2730
|
+
"deprecateAliases": true
|
|
2731
|
+
},
|
|
2732
|
+
"loglevel": {
|
|
2733
|
+
"name": "loglevel",
|
|
2734
|
+
"type": "option",
|
|
2735
|
+
"hidden": true,
|
|
2736
|
+
"multiple": false,
|
|
2737
|
+
"deprecated": {
|
|
2738
|
+
"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."
|
|
2739
|
+
},
|
|
2740
|
+
"deprecateAliases": true
|
|
2741
|
+
},
|
|
2742
|
+
"target-org": {
|
|
2743
|
+
"name": "target-org",
|
|
2744
|
+
"type": "option",
|
|
2745
|
+
"char": "o",
|
|
2746
|
+
"summary": "Username or alias of the target org.",
|
|
2747
|
+
"required": true,
|
|
2748
|
+
"multiple": false,
|
|
2749
|
+
"deprecateAliases": true,
|
|
2750
|
+
"aliases": [
|
|
2751
|
+
"targetusername",
|
|
2752
|
+
"u"
|
|
2753
|
+
]
|
|
2754
|
+
},
|
|
2755
|
+
"api-version": {
|
|
2756
|
+
"name": "api-version",
|
|
2757
|
+
"type": "option",
|
|
2758
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2759
|
+
"multiple": false,
|
|
2760
|
+
"deprecateAliases": true,
|
|
2761
|
+
"aliases": [
|
|
2762
|
+
"apiversion"
|
|
2763
|
+
]
|
|
2764
|
+
},
|
|
2765
|
+
"package-id": {
|
|
2766
|
+
"name": "package-id",
|
|
2767
|
+
"type": "option",
|
|
2768
|
+
"char": "i",
|
|
2769
|
+
"summary": "ID of the metadata package (starts with 033) of which you’re creating a new version.",
|
|
2770
|
+
"required": true,
|
|
2771
|
+
"multiple": false,
|
|
2772
|
+
"deprecateAliases": true,
|
|
2773
|
+
"aliases": [
|
|
2774
|
+
"packageid"
|
|
2775
|
+
]
|
|
2776
|
+
},
|
|
2777
|
+
"name": {
|
|
2778
|
+
"name": "name",
|
|
2779
|
+
"type": "option",
|
|
2780
|
+
"char": "n",
|
|
2781
|
+
"summary": "Package version name.",
|
|
2782
|
+
"required": true,
|
|
2783
|
+
"multiple": false,
|
|
2784
|
+
"deprecateAliases": true
|
|
2785
|
+
},
|
|
2786
|
+
"description": {
|
|
2787
|
+
"name": "description",
|
|
2788
|
+
"type": "option",
|
|
2789
|
+
"char": "d",
|
|
2790
|
+
"summary": "Package version description.",
|
|
2791
|
+
"multiple": false,
|
|
2792
|
+
"deprecateAliases": true
|
|
2793
|
+
},
|
|
2794
|
+
"version": {
|
|
2795
|
+
"name": "version",
|
|
2796
|
+
"type": "option",
|
|
2797
|
+
"char": "v",
|
|
2798
|
+
"summary": "Package version in major.minor format, for example, 3.2.",
|
|
2799
|
+
"multiple": false,
|
|
2800
|
+
"deprecateAliases": true
|
|
2801
|
+
},
|
|
2802
|
+
"managed-released": {
|
|
2803
|
+
"name": "managed-released",
|
|
2804
|
+
"type": "boolean",
|
|
2805
|
+
"char": "m",
|
|
2806
|
+
"summary": "Create a managed package version.",
|
|
2807
|
+
"description": "To create a beta version, don’t include this parameter.",
|
|
2808
|
+
"allowNo": false,
|
|
2809
|
+
"deprecateAliases": true,
|
|
2810
|
+
"aliases": [
|
|
2811
|
+
"managedrelease"
|
|
2812
|
+
]
|
|
2813
|
+
},
|
|
2814
|
+
"release-notes-url": {
|
|
2815
|
+
"name": "release-notes-url",
|
|
2816
|
+
"type": "option",
|
|
2817
|
+
"char": "r",
|
|
2818
|
+
"summary": "Release notes URL.",
|
|
2819
|
+
"description": "This link is displayed in the package installation UI to provide release notes for this package version to subscribers.",
|
|
2820
|
+
"multiple": false,
|
|
2821
|
+
"deprecateAliases": true,
|
|
2822
|
+
"aliases": [
|
|
2823
|
+
"releasenotesurl"
|
|
2824
|
+
]
|
|
2825
|
+
},
|
|
2826
|
+
"post-install-url": {
|
|
2827
|
+
"name": "post-install-url",
|
|
2828
|
+
"type": "option",
|
|
2829
|
+
"char": "p",
|
|
2830
|
+
"summary": "Post install URL.",
|
|
2831
|
+
"description": "The contents of the post-installation instructions URL are displayed in the UI after installation of the package version.",
|
|
2832
|
+
"multiple": false,
|
|
2833
|
+
"deprecateAliases": true,
|
|
2834
|
+
"aliases": [
|
|
2835
|
+
"postinstallurl"
|
|
2836
|
+
]
|
|
2837
|
+
},
|
|
2838
|
+
"installation-key": {
|
|
2839
|
+
"name": "installation-key",
|
|
2840
|
+
"type": "option",
|
|
2841
|
+
"char": "k",
|
|
2842
|
+
"summary": "Installation key for key-protected package (default: null).",
|
|
2843
|
+
"multiple": false,
|
|
2844
|
+
"deprecateAliases": true,
|
|
2845
|
+
"aliases": [
|
|
2846
|
+
"installationkey"
|
|
2847
|
+
]
|
|
2848
|
+
},
|
|
2849
|
+
"wait": {
|
|
2850
|
+
"name": "wait",
|
|
2851
|
+
"type": "option",
|
|
2852
|
+
"char": "w",
|
|
2853
|
+
"summary": "Minutes to wait for the package version to be created (default: 2 minutes).",
|
|
2854
|
+
"multiple": false,
|
|
2855
|
+
"deprecateAliases": true
|
|
2856
|
+
}
|
|
2857
|
+
},
|
|
2858
|
+
"args": {},
|
|
2859
|
+
"requiresProject": true,
|
|
2860
|
+
"hasDynamicHelp": true
|
|
2861
|
+
},
|
|
2862
|
+
"package1:version:display": {
|
|
2863
|
+
"id": "package1:version:display",
|
|
2864
|
+
"summary": "Display details about a first-generation package version.",
|
|
2865
|
+
"strict": true,
|
|
2866
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
2867
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
2868
|
+
"pluginType": "jit",
|
|
2869
|
+
"aliases": [
|
|
2870
|
+
"force:package1:beta:version:display",
|
|
2871
|
+
"force:package1:version:display"
|
|
2872
|
+
],
|
|
2873
|
+
"examples": [
|
|
2874
|
+
"Display details about the first-generation package version with the specified ID in your default org:\n<%= config.bin %> <%= command.id %> --package-version-id 04t...",
|
|
2875
|
+
"Same as previous example, but use the specified org:\n<%= config.bin %> <%= command.id %> --package-version-id 04t... --target-org myorg@example.com"
|
|
2876
|
+
],
|
|
2877
|
+
"deprecateAliases": true,
|
|
2878
|
+
"flags": {
|
|
2879
|
+
"json": {
|
|
2880
|
+
"name": "json",
|
|
2881
|
+
"type": "boolean",
|
|
2882
|
+
"description": "Format output as json.",
|
|
2883
|
+
"helpGroup": "GLOBAL",
|
|
2884
|
+
"allowNo": false,
|
|
2885
|
+
"deprecateAliases": true
|
|
2886
|
+
},
|
|
2887
|
+
"loglevel": {
|
|
2888
|
+
"name": "loglevel",
|
|
2889
|
+
"type": "option",
|
|
2890
|
+
"hidden": true,
|
|
2891
|
+
"multiple": false,
|
|
2892
|
+
"deprecated": {
|
|
2893
|
+
"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."
|
|
2894
|
+
},
|
|
2895
|
+
"deprecateAliases": true
|
|
2896
|
+
},
|
|
2897
|
+
"target-org": {
|
|
2898
|
+
"name": "target-org",
|
|
2899
|
+
"type": "option",
|
|
2900
|
+
"char": "o",
|
|
2901
|
+
"summary": "Username or alias of the target org.",
|
|
2902
|
+
"required": true,
|
|
2903
|
+
"multiple": false,
|
|
2904
|
+
"deprecateAliases": true,
|
|
2905
|
+
"aliases": [
|
|
2906
|
+
"targetusername",
|
|
2907
|
+
"u"
|
|
2908
|
+
]
|
|
2909
|
+
},
|
|
2910
|
+
"api-version": {
|
|
2911
|
+
"name": "api-version",
|
|
2912
|
+
"type": "option",
|
|
2913
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2914
|
+
"multiple": false,
|
|
2915
|
+
"deprecateAliases": true,
|
|
2916
|
+
"aliases": [
|
|
2917
|
+
"apiversion"
|
|
2918
|
+
]
|
|
2919
|
+
},
|
|
2920
|
+
"package-version-id": {
|
|
2921
|
+
"name": "package-version-id",
|
|
2922
|
+
"type": "option",
|
|
2923
|
+
"char": "i",
|
|
2924
|
+
"summary": "ID (starts with 04t) of the metadata package version whose details you want to display.",
|
|
2925
|
+
"required": true,
|
|
2926
|
+
"multiple": false,
|
|
2927
|
+
"deprecateAliases": true,
|
|
2928
|
+
"aliases": [
|
|
2929
|
+
"packageversionid"
|
|
2930
|
+
]
|
|
2931
|
+
}
|
|
2932
|
+
},
|
|
2933
|
+
"args": {},
|
|
2934
|
+
"hasDynamicHelp": true
|
|
2935
|
+
},
|
|
2936
|
+
"package1:version:list": {
|
|
2937
|
+
"id": "package1:version:list",
|
|
2938
|
+
"summary": "List package versions for the specified first-generation package or for the org.",
|
|
2939
|
+
"strict": true,
|
|
2940
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
2941
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
2942
|
+
"pluginType": "jit",
|
|
2943
|
+
"aliases": [
|
|
2944
|
+
"force:package1:beta:version:list",
|
|
2945
|
+
"force:package1:version:list"
|
|
2946
|
+
],
|
|
2947
|
+
"examples": [
|
|
2948
|
+
"List all first-generation package versions in your default org:\n<%= config.bin %> <%= command.id %>",
|
|
2949
|
+
"List package versions for the specified first-generation package in the specifief org:\n<%= config.bin %> <%= command.id %> --package-id 033... --target-org myorg@example.com"
|
|
2950
|
+
],
|
|
2951
|
+
"deprecateAliases": true,
|
|
2952
|
+
"flags": {
|
|
2953
|
+
"json": {
|
|
2954
|
+
"name": "json",
|
|
2955
|
+
"type": "boolean",
|
|
2956
|
+
"description": "Format output as json.",
|
|
2957
|
+
"helpGroup": "GLOBAL",
|
|
2958
|
+
"allowNo": false,
|
|
2959
|
+
"deprecateAliases": true
|
|
2960
|
+
},
|
|
2961
|
+
"loglevel": {
|
|
2962
|
+
"name": "loglevel",
|
|
2963
|
+
"type": "option",
|
|
2964
|
+
"hidden": true,
|
|
2965
|
+
"multiple": false,
|
|
2966
|
+
"deprecated": {
|
|
2967
|
+
"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."
|
|
2968
|
+
},
|
|
2969
|
+
"deprecateAliases": true
|
|
2970
|
+
},
|
|
2971
|
+
"target-org": {
|
|
2972
|
+
"name": "target-org",
|
|
2973
|
+
"type": "option",
|
|
2974
|
+
"char": "o",
|
|
2975
|
+
"summary": "Username or alias of the target org.",
|
|
2976
|
+
"required": true,
|
|
2977
|
+
"multiple": false,
|
|
2978
|
+
"deprecateAliases": true,
|
|
2979
|
+
"aliases": [
|
|
2980
|
+
"targetusername",
|
|
2981
|
+
"u"
|
|
2982
|
+
]
|
|
2983
|
+
},
|
|
2984
|
+
"api-version": {
|
|
2985
|
+
"name": "api-version",
|
|
2986
|
+
"type": "option",
|
|
2987
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2988
|
+
"multiple": false,
|
|
2989
|
+
"deprecateAliases": true,
|
|
2990
|
+
"aliases": [
|
|
2991
|
+
"apiversion"
|
|
2992
|
+
]
|
|
2993
|
+
},
|
|
2994
|
+
"package-id": {
|
|
2995
|
+
"name": "package-id",
|
|
2996
|
+
"type": "option",
|
|
2997
|
+
"char": "i",
|
|
2998
|
+
"summary": "Metadata package ID (starts with 033) whose package versions you want to list.",
|
|
2999
|
+
"description": "If not specified, shows all versions for all packages (managed and unmanaged) in the org.",
|
|
3000
|
+
"multiple": false,
|
|
3001
|
+
"deprecateAliases": true,
|
|
3002
|
+
"aliases": [
|
|
3003
|
+
"packageid"
|
|
3004
|
+
]
|
|
3005
|
+
}
|
|
3006
|
+
},
|
|
3007
|
+
"args": {},
|
|
3008
|
+
"hasDynamicHelp": true
|
|
3009
|
+
},
|
|
3010
|
+
"package:version:create:list": {
|
|
3011
|
+
"id": "package:version:create:list",
|
|
3012
|
+
"summary": "List package version creation requests.",
|
|
3013
|
+
"description": "Shows the details of each request to create a package version in the Dev Hub org.\n\nAll filter parameters are applied using the AND logical operator (not OR).\n\nTo get information about a specific request, run \"<%= config.bin %> package version create report\" and supply the request ID.",
|
|
3014
|
+
"strict": true,
|
|
3015
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
3016
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
3017
|
+
"pluginType": "jit",
|
|
3018
|
+
"aliases": [
|
|
3019
|
+
"force:package:beta:version:create:list",
|
|
3020
|
+
"force:package:version:create:list"
|
|
3021
|
+
],
|
|
3022
|
+
"examples": [
|
|
3023
|
+
"List all package version creation requests in your default Dev Hub org:\n<%= config.bin %> <%= command.id %>",
|
|
3024
|
+
"List package version creation requests from the last 3 days in the Dev Hub org with username devhub@example.com:\n<%= config.bin %> <%= command.id %> --created-last-days 3 --target-hub-org",
|
|
3025
|
+
"List package version creation requests with status Error:\n<%= config.bin %> <%= command.id %> --status Error",
|
|
3026
|
+
"List package version creation requests with status InProgress:\n<%= config.bin %> <%= command.id %> --status InProgress",
|
|
3027
|
+
"List package version creation requests with status Success that were created today:\n<%= config.bin %> <%= command.id %> --created-last-days 0 --status Success"
|
|
3028
|
+
],
|
|
3029
|
+
"deprecateAliases": true,
|
|
3030
|
+
"flags": {
|
|
3031
|
+
"json": {
|
|
3032
|
+
"name": "json",
|
|
3033
|
+
"type": "boolean",
|
|
3034
|
+
"description": "Format output as json.",
|
|
3035
|
+
"helpGroup": "GLOBAL",
|
|
3036
|
+
"allowNo": false,
|
|
3037
|
+
"deprecateAliases": true
|
|
3038
|
+
},
|
|
3039
|
+
"loglevel": {
|
|
3040
|
+
"name": "loglevel",
|
|
3041
|
+
"type": "option",
|
|
3042
|
+
"hidden": true,
|
|
3043
|
+
"multiple": false,
|
|
3044
|
+
"deprecated": {
|
|
3045
|
+
"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."
|
|
3046
|
+
},
|
|
3047
|
+
"deprecateAliases": true
|
|
3048
|
+
},
|
|
3049
|
+
"target-hub-org": {
|
|
3050
|
+
"name": "target-hub-org",
|
|
3051
|
+
"type": "option",
|
|
3052
|
+
"char": "v",
|
|
3053
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
3054
|
+
"required": true,
|
|
3055
|
+
"multiple": false,
|
|
3056
|
+
"deprecateAliases": true,
|
|
3057
|
+
"aliases": [
|
|
3058
|
+
"targetdevhubusername"
|
|
3059
|
+
]
|
|
3060
|
+
},
|
|
3061
|
+
"api-version": {
|
|
3062
|
+
"name": "api-version",
|
|
3063
|
+
"type": "option",
|
|
3064
|
+
"description": "Override the api version used for api requests made by this command",
|
|
3065
|
+
"multiple": false,
|
|
3066
|
+
"deprecateAliases": true,
|
|
3067
|
+
"aliases": [
|
|
3068
|
+
"apiversion"
|
|
3069
|
+
]
|
|
3070
|
+
},
|
|
3071
|
+
"created-last-days": {
|
|
3072
|
+
"name": "created-last-days",
|
|
3073
|
+
"type": "option",
|
|
3074
|
+
"char": "c",
|
|
3075
|
+
"summary": "Number of days since the request was created, starting at 00:00:00 of first day to now. Use 0 for today.",
|
|
3076
|
+
"multiple": false,
|
|
3077
|
+
"deprecateAliases": true,
|
|
3078
|
+
"aliases": [
|
|
3079
|
+
"createdlastdays"
|
|
3080
|
+
]
|
|
3081
|
+
},
|
|
3082
|
+
"status": {
|
|
3083
|
+
"name": "status",
|
|
3084
|
+
"type": "option",
|
|
3085
|
+
"char": "s",
|
|
3086
|
+
"summary": "Status of the version creation request, used to filter the list.",
|
|
3087
|
+
"multiple": false,
|
|
3088
|
+
"options": [
|
|
3089
|
+
"Queued",
|
|
3090
|
+
"InProgress",
|
|
3091
|
+
"Success",
|
|
3092
|
+
"Error"
|
|
3093
|
+
],
|
|
3094
|
+
"deprecateAliases": true
|
|
3095
|
+
}
|
|
3096
|
+
},
|
|
3097
|
+
"args": {},
|
|
3098
|
+
"hasDynamicHelp": true
|
|
3099
|
+
},
|
|
3100
|
+
"package:version:create:report": {
|
|
3101
|
+
"id": "package:version:create:report",
|
|
3102
|
+
"summary": "Retrieve details about a package version creation request.",
|
|
3103
|
+
"description": "Specify the request ID for which you want to view details. If applicable, the command displays errors related to the request.\n\nTo show all requests in the org, run \"<%= config.bin %> package version create list\".",
|
|
3104
|
+
"strict": true,
|
|
3105
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
3106
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
3107
|
+
"pluginType": "jit",
|
|
3108
|
+
"aliases": [
|
|
3109
|
+
"force:package:beta:version:create:report",
|
|
3110
|
+
"force:package:version:create:report"
|
|
3111
|
+
],
|
|
3112
|
+
"examples": [
|
|
3113
|
+
"Retrieve details about the package version creation request with the specified ID; uses your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --package-create-request-id 08c...",
|
|
3114
|
+
"Retrieve details about the specified package version creation request in the Dev Hub org with username devhub@example.com:\n<%= config.bin %> <%= command.id %> --package-create-request-id 08c... --target-hub-org devhub@example.com"
|
|
3115
|
+
],
|
|
3116
|
+
"deprecateAliases": true,
|
|
3117
|
+
"flags": {
|
|
3118
|
+
"json": {
|
|
3119
|
+
"name": "json",
|
|
3120
|
+
"type": "boolean",
|
|
3121
|
+
"description": "Format output as json.",
|
|
3122
|
+
"helpGroup": "GLOBAL",
|
|
3123
|
+
"allowNo": false,
|
|
3124
|
+
"deprecateAliases": true
|
|
3125
|
+
},
|
|
3126
|
+
"loglevel": {
|
|
3127
|
+
"name": "loglevel",
|
|
3128
|
+
"type": "option",
|
|
3129
|
+
"hidden": true,
|
|
3130
|
+
"multiple": false,
|
|
3131
|
+
"deprecated": {
|
|
3132
|
+
"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."
|
|
3133
|
+
},
|
|
3134
|
+
"deprecateAliases": true
|
|
3135
|
+
},
|
|
3136
|
+
"target-hub-org": {
|
|
3137
|
+
"name": "target-hub-org",
|
|
3138
|
+
"type": "option",
|
|
3139
|
+
"char": "v",
|
|
3140
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
3141
|
+
"required": true,
|
|
3142
|
+
"multiple": false,
|
|
3143
|
+
"deprecateAliases": true,
|
|
3144
|
+
"aliases": [
|
|
3145
|
+
"targetdevhubusername"
|
|
3146
|
+
]
|
|
3147
|
+
},
|
|
3148
|
+
"api-version": {
|
|
3149
|
+
"name": "api-version",
|
|
3150
|
+
"type": "option",
|
|
3151
|
+
"description": "Override the api version used for api requests made by this command",
|
|
3152
|
+
"multiple": false,
|
|
3153
|
+
"deprecateAliases": true,
|
|
3154
|
+
"aliases": [
|
|
3155
|
+
"apiversion"
|
|
3156
|
+
]
|
|
3157
|
+
},
|
|
3158
|
+
"package-create-request-id": {
|
|
3159
|
+
"name": "package-create-request-id",
|
|
3160
|
+
"type": "option",
|
|
3161
|
+
"char": "i",
|
|
3162
|
+
"summary": "ID (starts with 08c) of the package version creation request you want to display.",
|
|
3163
|
+
"required": true,
|
|
3164
|
+
"multiple": false,
|
|
3165
|
+
"deprecateAliases": true,
|
|
3166
|
+
"aliases": [
|
|
3167
|
+
"packagecreaterequestid"
|
|
3168
|
+
]
|
|
3169
|
+
}
|
|
3170
|
+
},
|
|
3171
|
+
"args": {},
|
|
3172
|
+
"hasDynamicHelp": true
|
|
3173
|
+
},
|
|
3174
|
+
"package1:version:create:get": {
|
|
3175
|
+
"id": "package1:version:create:get",
|
|
3176
|
+
"summary": "Retrieve the status of a package version creation request.",
|
|
3177
|
+
"strict": true,
|
|
3178
|
+
"pluginName": "@salesforce/plugin-packaging",
|
|
3179
|
+
"pluginAlias": "@salesforce/plugin-packaging",
|
|
3180
|
+
"pluginType": "jit",
|
|
3181
|
+
"aliases": [
|
|
3182
|
+
"force:package1:beta:version:create:get",
|
|
3183
|
+
"force:package1:version:create:get"
|
|
3184
|
+
],
|
|
3185
|
+
"examples": [
|
|
3186
|
+
"Get the status of the creation request for the package version with the specified ID in your default org:\n<%= config.bin %> <%= command.id %> --request-id 0HD...",
|
|
3187
|
+
"Same as previous example, but use the specified org:\n<%= config.bin %> <%= command.id %> --request-id 0HD... --target-org myorg@example.com"
|
|
3188
|
+
],
|
|
3189
|
+
"deprecateAliases": true,
|
|
3190
|
+
"flags": {
|
|
3191
|
+
"json": {
|
|
3192
|
+
"name": "json",
|
|
3193
|
+
"type": "boolean",
|
|
3194
|
+
"description": "Format output as json.",
|
|
3195
|
+
"helpGroup": "GLOBAL",
|
|
3196
|
+
"allowNo": false,
|
|
3197
|
+
"deprecateAliases": true
|
|
3198
|
+
},
|
|
3199
|
+
"loglevel": {
|
|
3200
|
+
"name": "loglevel",
|
|
3201
|
+
"type": "option",
|
|
3202
|
+
"hidden": true,
|
|
3203
|
+
"multiple": false,
|
|
3204
|
+
"deprecated": {
|
|
3205
|
+
"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."
|
|
3206
|
+
},
|
|
3207
|
+
"deprecateAliases": true
|
|
3208
|
+
},
|
|
3209
|
+
"target-org": {
|
|
3210
|
+
"name": "target-org",
|
|
3211
|
+
"type": "option",
|
|
3212
|
+
"char": "o",
|
|
3213
|
+
"summary": "Username or alias of the target org.",
|
|
3214
|
+
"required": true,
|
|
3215
|
+
"multiple": false,
|
|
3216
|
+
"deprecateAliases": true,
|
|
3217
|
+
"aliases": [
|
|
3218
|
+
"targetusername",
|
|
3219
|
+
"u"
|
|
3220
|
+
]
|
|
3221
|
+
},
|
|
3222
|
+
"api-version": {
|
|
3223
|
+
"name": "api-version",
|
|
3224
|
+
"type": "option",
|
|
3225
|
+
"description": "Override the api version used for api requests made by this command",
|
|
3226
|
+
"multiple": false,
|
|
3227
|
+
"deprecateAliases": true,
|
|
3228
|
+
"aliases": [
|
|
3229
|
+
"apiversion"
|
|
3230
|
+
]
|
|
3231
|
+
},
|
|
3232
|
+
"request-id": {
|
|
3233
|
+
"name": "request-id",
|
|
3234
|
+
"type": "option",
|
|
3235
|
+
"char": "i",
|
|
3236
|
+
"summary": "ID of the PackageUploadRequest (starts with 0HD).",
|
|
3237
|
+
"required": true,
|
|
3238
|
+
"multiple": false,
|
|
3239
|
+
"deprecateAliases": true,
|
|
3240
|
+
"aliases": [
|
|
3241
|
+
"requestid"
|
|
3242
|
+
]
|
|
3243
|
+
}
|
|
3244
|
+
},
|
|
3245
|
+
"args": {},
|
|
3246
|
+
"hasDynamicHelp": true
|
|
3247
|
+
},
|
|
3248
|
+
"org:create:shape": {
|
|
3249
|
+
"id": "org:create:shape",
|
|
3250
|
+
"summary": "Create a scratch org configuration (shape) based on the specified source org.",
|
|
3251
|
+
"description": "Scratch org shapes mimic the baseline setup (features, limits, edition, and Metadata API settings) of a source org without the extraneous data and metadata.\n\nRun \"<%= config.bin %> org list shape\" to view the available org shapes and their IDs.\n\nTo create a scratch org from an org shape, include the \"sourceOrg\" property in the scratch org definition file and set it to the org ID of the source org. Then create a scratch org with the \"<%= config.bin %> force:org:create\" command.",
|
|
3252
|
+
"strict": true,
|
|
3253
|
+
"pluginName": "@salesforce/plugin-signups",
|
|
3254
|
+
"pluginAlias": "@salesforce/plugin-signups",
|
|
3255
|
+
"pluginType": "jit",
|
|
3256
|
+
"aliases": [
|
|
3257
|
+
"force:org:shape:create"
|
|
3258
|
+
],
|
|
3259
|
+
"examples": [
|
|
3260
|
+
"Create an org shape for the source org with alias SourceOrg:\n<%= config.bin %> <%= command.id %> --target-org SourceOrg"
|
|
3261
|
+
],
|
|
3262
|
+
"deprecateAliases": true,
|
|
3263
|
+
"flags": {
|
|
3264
|
+
"json": {
|
|
3265
|
+
"name": "json",
|
|
3266
|
+
"type": "boolean",
|
|
3267
|
+
"description": "Format output as json.",
|
|
3268
|
+
"helpGroup": "GLOBAL",
|
|
3269
|
+
"allowNo": false,
|
|
3270
|
+
"deprecateAliases": true
|
|
3271
|
+
},
|
|
3272
|
+
"target-org": {
|
|
3273
|
+
"name": "target-org",
|
|
3274
|
+
"type": "option",
|
|
3275
|
+
"char": "o",
|
|
3276
|
+
"summary": "Username or alias of the target org.",
|
|
3277
|
+
"required": true,
|
|
3278
|
+
"multiple": false,
|
|
3279
|
+
"deprecateAliases": true,
|
|
3280
|
+
"aliases": [
|
|
3281
|
+
"targetusername",
|
|
3282
|
+
"u"
|
|
3283
|
+
]
|
|
3284
|
+
},
|
|
3285
|
+
"api-version": {
|
|
3286
|
+
"name": "api-version",
|
|
3287
|
+
"type": "option",
|
|
3288
|
+
"description": "Override the api version used for api requests made by this command",
|
|
3289
|
+
"multiple": false,
|
|
3290
|
+
"deprecateAliases": true,
|
|
3291
|
+
"aliases": [
|
|
3292
|
+
"apiversion"
|
|
3293
|
+
]
|
|
3294
|
+
},
|
|
3295
|
+
"loglevel": {
|
|
3296
|
+
"name": "loglevel",
|
|
3297
|
+
"type": "option",
|
|
3298
|
+
"hidden": true,
|
|
3299
|
+
"multiple": false,
|
|
3300
|
+
"deprecated": {
|
|
3301
|
+
"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."
|
|
3302
|
+
},
|
|
3303
|
+
"deprecateAliases": true
|
|
3304
|
+
}
|
|
3305
|
+
},
|
|
3306
|
+
"args": {},
|
|
3307
|
+
"hasDynamicHelp": true
|
|
3308
|
+
},
|
|
3309
|
+
"org:create:snapshot": {
|
|
3310
|
+
"id": "org:create:snapshot",
|
|
3311
|
+
"summary": "Create a snapshot of a scratch org.",
|
|
3312
|
+
"description": "A snapshot is a point-in-time copy of a scratch org. The copy is referenced by its unique name in a scratch org definition file.\n\nUse \"<%= config.bin %> org get snapshot\" to get details, including status, about a snapshot creation request.\n\nTo create a scratch org from a snapshot, include the \"snapshot\" option (instead of \"edition\") in the scratch org definition file and set it to the name of the snapshot. Then use \"<%= config.bin %> force:org:create\" to create the scratch org.",
|
|
3313
|
+
"strict": true,
|
|
3314
|
+
"pluginName": "@salesforce/plugin-signups",
|
|
3315
|
+
"pluginAlias": "@salesforce/plugin-signups",
|
|
3316
|
+
"pluginType": "jit",
|
|
3317
|
+
"aliases": [
|
|
3318
|
+
"force:org:snapshot:create"
|
|
3319
|
+
],
|
|
3320
|
+
"examples": [
|
|
3321
|
+
"Create a snapshot called \"Dependencies\" using the source scratch org ID and your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --source-org 00Dxx0000000000 --name Dependencies --description 'Contains PackageA v1.1.0'",
|
|
3322
|
+
"Create a snapshot called \"NightlyBranch\" using the source scratch org username and a Dev Hub org with alias NightlyDevHub:\n<%= config.bin %> <%= command.id %> --source-org myuser@myorg --name NightlyBranch --description 'Contains PkgA v2.1.0 and PkgB 3.3.0' --target-dev-hub NightlyDevHub"
|
|
3323
|
+
],
|
|
3324
|
+
"deprecateAliases": true,
|
|
3325
|
+
"flags": {
|
|
3326
|
+
"json": {
|
|
3327
|
+
"name": "json",
|
|
3328
|
+
"type": "boolean",
|
|
3329
|
+
"description": "Format output as json.",
|
|
3330
|
+
"helpGroup": "GLOBAL",
|
|
3331
|
+
"allowNo": false,
|
|
3332
|
+
"deprecateAliases": true
|
|
3333
|
+
},
|
|
3334
|
+
"target-dev-hub": {
|
|
3335
|
+
"name": "target-dev-hub",
|
|
3336
|
+
"type": "option",
|
|
3337
|
+
"char": "v",
|
|
3338
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
3339
|
+
"required": true,
|
|
3340
|
+
"multiple": false,
|
|
3341
|
+
"deprecateAliases": true,
|
|
3342
|
+
"aliases": [
|
|
3343
|
+
"targetdevhubusername"
|
|
3344
|
+
]
|
|
3345
|
+
},
|
|
3346
|
+
"api-version": {
|
|
3347
|
+
"name": "api-version",
|
|
3348
|
+
"type": "option",
|
|
3349
|
+
"description": "Override the api version used for api requests made by this command",
|
|
3350
|
+
"multiple": false,
|
|
3351
|
+
"deprecateAliases": true,
|
|
3352
|
+
"aliases": [
|
|
3353
|
+
"apiversion"
|
|
3354
|
+
]
|
|
3355
|
+
},
|
|
3356
|
+
"loglevel": {
|
|
3357
|
+
"name": "loglevel",
|
|
3358
|
+
"type": "option",
|
|
3359
|
+
"hidden": true,
|
|
3360
|
+
"multiple": false,
|
|
3361
|
+
"deprecated": {
|
|
3362
|
+
"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."
|
|
3363
|
+
},
|
|
3364
|
+
"deprecateAliases": true
|
|
3365
|
+
},
|
|
3366
|
+
"source-org": {
|
|
3367
|
+
"name": "source-org",
|
|
3368
|
+
"type": "option",
|
|
3369
|
+
"char": "o",
|
|
3370
|
+
"summary": "ID or locally authenticated username or alias of scratch org to snapshot.",
|
|
3371
|
+
"required": true,
|
|
3372
|
+
"multiple": false,
|
|
3373
|
+
"deprecateAliases": true,
|
|
3374
|
+
"aliases": [
|
|
3375
|
+
"sourceorg"
|
|
3376
|
+
]
|
|
3377
|
+
},
|
|
3378
|
+
"name": {
|
|
3379
|
+
"name": "name",
|
|
3380
|
+
"type": "option",
|
|
3381
|
+
"char": "n",
|
|
3382
|
+
"summary": "Unique name of snapshot.",
|
|
3383
|
+
"required": true,
|
|
3384
|
+
"multiple": false,
|
|
3385
|
+
"deprecateAliases": true,
|
|
3386
|
+
"aliases": [
|
|
3387
|
+
"snapshotname"
|
|
3388
|
+
]
|
|
3389
|
+
},
|
|
3390
|
+
"description": {
|
|
3391
|
+
"name": "description",
|
|
3392
|
+
"type": "option",
|
|
3393
|
+
"char": "d",
|
|
3394
|
+
"summary": "Description of snapshot.",
|
|
3395
|
+
"description": "Use this description to document the contents of the snapshot. We suggest that you include a reference point, such as a version control system tag or commit ID.",
|
|
3396
|
+
"multiple": false,
|
|
3397
|
+
"deprecateAliases": true
|
|
3398
|
+
}
|
|
3399
|
+
},
|
|
3400
|
+
"args": {},
|
|
3401
|
+
"hasDynamicHelp": true
|
|
3402
|
+
},
|
|
3403
|
+
"org:delete:shape": {
|
|
3404
|
+
"id": "org:delete:shape",
|
|
3405
|
+
"summary": "Delete all org shapes for a target org.",
|
|
3406
|
+
"description": "A source org can have only one active org shape. If you try to create an org shape for a source org that already has one, the previous shape is marked inactive and replaced by a new active shape. If you don’t want to create scratch orgs based on this shape, you can delete the org shape.",
|
|
3407
|
+
"strict": true,
|
|
3408
|
+
"pluginName": "@salesforce/plugin-signups",
|
|
3409
|
+
"pluginAlias": "@salesforce/plugin-signups",
|
|
3410
|
+
"pluginType": "jit",
|
|
3411
|
+
"aliases": [
|
|
3412
|
+
"force:org:shape:delete"
|
|
3413
|
+
],
|
|
3414
|
+
"examples": [
|
|
3415
|
+
"Delete all org shapes for the source org with alias SourceOrg:\n<%= config.bin %> <%= command.id %> --target-org SourceOrg",
|
|
3416
|
+
"Delete all org shapes without prompting:\n<%= config.bin %> <%= command.id %> --target-org SourceOrg --no-prompt"
|
|
3417
|
+
],
|
|
3418
|
+
"deprecateAliases": true,
|
|
3419
|
+
"flags": {
|
|
3420
|
+
"json": {
|
|
3421
|
+
"name": "json",
|
|
3422
|
+
"type": "boolean",
|
|
3423
|
+
"description": "Format output as json.",
|
|
3424
|
+
"helpGroup": "GLOBAL",
|
|
3425
|
+
"allowNo": false,
|
|
3426
|
+
"deprecateAliases": true
|
|
3427
|
+
},
|
|
3428
|
+
"target-org": {
|
|
3429
|
+
"name": "target-org",
|
|
3430
|
+
"type": "option",
|
|
3431
|
+
"char": "o",
|
|
3432
|
+
"summary": "Username or alias of the target org.",
|
|
3433
|
+
"required": true,
|
|
3434
|
+
"multiple": false,
|
|
3435
|
+
"deprecateAliases": true,
|
|
3436
|
+
"aliases": [
|
|
3437
|
+
"targetusername",
|
|
3438
|
+
"u"
|
|
3439
|
+
]
|
|
3440
|
+
},
|
|
3441
|
+
"api-version": {
|
|
3442
|
+
"name": "api-version",
|
|
3443
|
+
"type": "option",
|
|
3444
|
+
"description": "Override the api version used for api requests made by this command",
|
|
3445
|
+
"multiple": false,
|
|
3446
|
+
"deprecateAliases": true,
|
|
3447
|
+
"aliases": [
|
|
3448
|
+
"apiversion"
|
|
3449
|
+
]
|
|
3450
|
+
},
|
|
3451
|
+
"loglevel": {
|
|
3452
|
+
"name": "loglevel",
|
|
3453
|
+
"type": "option",
|
|
3454
|
+
"hidden": true,
|
|
3455
|
+
"multiple": false,
|
|
3456
|
+
"deprecated": {
|
|
3457
|
+
"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."
|
|
3458
|
+
},
|
|
3459
|
+
"deprecateAliases": true
|
|
3460
|
+
},
|
|
3461
|
+
"no-prompt": {
|
|
3462
|
+
"name": "no-prompt",
|
|
3463
|
+
"type": "boolean",
|
|
3464
|
+
"char": "p",
|
|
3465
|
+
"summary": "Don't prompt for confirmation.",
|
|
3466
|
+
"allowNo": false,
|
|
3467
|
+
"deprecateAliases": true,
|
|
3468
|
+
"aliases": [
|
|
3469
|
+
"noprompt"
|
|
3470
|
+
]
|
|
3471
|
+
}
|
|
3472
|
+
},
|
|
3473
|
+
"args": {},
|
|
3474
|
+
"hasDynamicHelp": true
|
|
3475
|
+
},
|
|
3476
|
+
"org:delete:snapshot": {
|
|
3477
|
+
"id": "org:delete:snapshot",
|
|
3478
|
+
"summary": "Delete a scratch org snapshot.",
|
|
3479
|
+
"description": "Dev Hub admins can delete any snapshot, while users can delete only their own unless a Dev Hub admin gives the user Modify All permissions.",
|
|
3480
|
+
"strict": true,
|
|
3481
|
+
"pluginName": "@salesforce/plugin-signups",
|
|
3482
|
+
"pluginAlias": "@salesforce/plugin-signups",
|
|
3483
|
+
"pluginType": "jit",
|
|
3484
|
+
"aliases": [
|
|
3485
|
+
"force:org:snapshot:delete"
|
|
3486
|
+
],
|
|
3487
|
+
"examples": [
|
|
3488
|
+
"Delete a snapshot from the default Dev Hub using the snapshot ID:\n<%= config.bin %> <%= command.id %> --snapshot 0Oo...",
|
|
3489
|
+
"Delete a snapshot from the specified Dev Hub using the snapshot name:\n<%= config.bin %> <%= command.id %> --snapshot BaseSnapshot --target-dev-hub SnapshotDevHub"
|
|
3490
|
+
],
|
|
3491
|
+
"deprecateAliases": true,
|
|
3492
|
+
"flags": {
|
|
3493
|
+
"json": {
|
|
3494
|
+
"name": "json",
|
|
3495
|
+
"type": "boolean",
|
|
3496
|
+
"description": "Format output as json.",
|
|
3497
|
+
"helpGroup": "GLOBAL",
|
|
3498
|
+
"allowNo": false,
|
|
3499
|
+
"deprecateAliases": true
|
|
3500
|
+
},
|
|
3501
|
+
"target-dev-hub": {
|
|
3502
|
+
"name": "target-dev-hub",
|
|
3503
|
+
"type": "option",
|
|
3504
|
+
"char": "v",
|
|
3505
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
3506
|
+
"required": true,
|
|
3507
|
+
"multiple": false,
|
|
3508
|
+
"deprecateAliases": true,
|
|
3509
|
+
"aliases": [
|
|
3510
|
+
"targetdevhubusername"
|
|
3511
|
+
]
|
|
3512
|
+
},
|
|
3513
|
+
"api-version": {
|
|
3514
|
+
"name": "api-version",
|
|
3515
|
+
"type": "option",
|
|
3516
|
+
"description": "Override the api version used for api requests made by this command",
|
|
3517
|
+
"multiple": false,
|
|
3518
|
+
"deprecateAliases": true,
|
|
3519
|
+
"aliases": [
|
|
3520
|
+
"apiversion"
|
|
3521
|
+
]
|
|
3522
|
+
},
|
|
3523
|
+
"loglevel": {
|
|
3524
|
+
"name": "loglevel",
|
|
3525
|
+
"type": "option",
|
|
3526
|
+
"hidden": true,
|
|
3527
|
+
"multiple": false,
|
|
3528
|
+
"deprecated": {
|
|
3529
|
+
"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."
|
|
3530
|
+
},
|
|
3531
|
+
"deprecateAliases": true
|
|
3532
|
+
},
|
|
3533
|
+
"snapshot": {
|
|
3534
|
+
"name": "snapshot",
|
|
3535
|
+
"type": "option",
|
|
3536
|
+
"char": "s",
|
|
3537
|
+
"summary": "Name or ID of snapshot to delete.",
|
|
3538
|
+
"description": "The IDs of scratch org snapshots start with 0Oo.",
|
|
3539
|
+
"required": true,
|
|
3540
|
+
"multiple": false,
|
|
3541
|
+
"deprecateAliases": true
|
|
3542
|
+
}
|
|
3543
|
+
},
|
|
3544
|
+
"args": {},
|
|
3545
|
+
"hasDynamicHelp": true
|
|
3546
|
+
},
|
|
3547
|
+
"org:get:snapshot": {
|
|
3548
|
+
"id": "org:get:snapshot",
|
|
3549
|
+
"summary": "Get details about a scratch org snapshot.",
|
|
3550
|
+
"description": "Snapshot creation can take a while. Use this command with the snapshot name or ID to check its creation status. After the status changes to Active, you can use the snapshot to create scratch orgs.\n\nTo create a snapshot, use the \"<%= config.bin %> org create snapshot\" command. To retrieve a list of all snapshots, use \"<%= config.bin %> org list snapshot\".",
|
|
3551
|
+
"strict": true,
|
|
3552
|
+
"pluginName": "@salesforce/plugin-signups",
|
|
3553
|
+
"pluginAlias": "@salesforce/plugin-signups",
|
|
3554
|
+
"pluginType": "jit",
|
|
3555
|
+
"aliases": [
|
|
3556
|
+
"force:org:snapshot:get"
|
|
3557
|
+
],
|
|
3558
|
+
"examples": [
|
|
3559
|
+
"Get snapshot details using its ID and the default Dev Hub org:\n<%= config.bin %> <%= command.id %> --snapshot 0Oo...",
|
|
3560
|
+
"Get snapshot details using its name from a Dev Hub org with alias SnapshotDevHub:\n<%= config.bin %> <%= command.id %> --snapshot Dependencies --target-dev-hub SnapshotDevHub"
|
|
3561
|
+
],
|
|
3562
|
+
"deprecateAliases": true,
|
|
3563
|
+
"flags": {
|
|
3564
|
+
"json": {
|
|
3565
|
+
"name": "json",
|
|
3566
|
+
"type": "boolean",
|
|
3567
|
+
"description": "Format output as json.",
|
|
3568
|
+
"helpGroup": "GLOBAL",
|
|
3569
|
+
"allowNo": false,
|
|
3570
|
+
"deprecateAliases": true
|
|
3571
|
+
},
|
|
3572
|
+
"target-dev-hub": {
|
|
3573
|
+
"name": "target-dev-hub",
|
|
3574
|
+
"type": "option",
|
|
3575
|
+
"char": "v",
|
|
3576
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
3577
|
+
"required": true,
|
|
3578
|
+
"multiple": false,
|
|
3579
|
+
"deprecateAliases": true,
|
|
3580
|
+
"aliases": [
|
|
3581
|
+
"targetdevhubusername"
|
|
3582
|
+
]
|
|
3583
|
+
},
|
|
3584
|
+
"api-version": {
|
|
3585
|
+
"name": "api-version",
|
|
3586
|
+
"type": "option",
|
|
3587
|
+
"description": "Override the api version used for api requests made by this command",
|
|
3588
|
+
"multiple": false,
|
|
3589
|
+
"deprecateAliases": true,
|
|
3590
|
+
"aliases": [
|
|
3591
|
+
"apiversion"
|
|
3592
|
+
]
|
|
3593
|
+
},
|
|
3594
|
+
"loglevel": {
|
|
3595
|
+
"name": "loglevel",
|
|
3596
|
+
"type": "option",
|
|
3597
|
+
"hidden": true,
|
|
3598
|
+
"multiple": false,
|
|
3599
|
+
"deprecated": {
|
|
3600
|
+
"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."
|
|
3601
|
+
},
|
|
3602
|
+
"deprecateAliases": true
|
|
3603
|
+
},
|
|
3604
|
+
"snapshot": {
|
|
3605
|
+
"name": "snapshot",
|
|
3606
|
+
"type": "option",
|
|
3607
|
+
"char": "s",
|
|
3608
|
+
"summary": "Name or ID of snapshot to retrieve.",
|
|
3609
|
+
"description": "The IDs of scratch org snapshots start with 0Oo.",
|
|
3610
|
+
"required": true,
|
|
3611
|
+
"multiple": false,
|
|
3612
|
+
"deprecateAliases": true
|
|
3613
|
+
}
|
|
3614
|
+
},
|
|
3615
|
+
"args": {},
|
|
3616
|
+
"hasDynamicHelp": true
|
|
3617
|
+
},
|
|
3618
|
+
"org:list:shape": {
|
|
3619
|
+
"id": "org:list:shape",
|
|
3620
|
+
"summary": "List all org shapes you’ve created.",
|
|
3621
|
+
"description": "The output includes the alias, username, and ID of the source org, the status of the org shape creation, and more. Use the org ID to update your scratch org configuration file so you can create a scratch org based on this org shape.",
|
|
3622
|
+
"strict": true,
|
|
3623
|
+
"pluginName": "@salesforce/plugin-signups",
|
|
3624
|
+
"pluginAlias": "@salesforce/plugin-signups",
|
|
3625
|
+
"pluginType": "jit",
|
|
3626
|
+
"aliases": [
|
|
3627
|
+
"force:org:shape:list"
|
|
3628
|
+
],
|
|
3629
|
+
"examples": [
|
|
3630
|
+
"List all org shapes you've created:\n<%= config.bin %> <%= command.id %>",
|
|
3631
|
+
"List all org shapes in JSON format and write the output to a file:\n<%= config.bin %> <%= command.id %> --json > tmp/MyOrgShapeList.json"
|
|
3632
|
+
],
|
|
3633
|
+
"deprecateAliases": true,
|
|
3634
|
+
"flags": {
|
|
3635
|
+
"json": {
|
|
3636
|
+
"name": "json",
|
|
3637
|
+
"type": "boolean",
|
|
3638
|
+
"description": "Format output as json.",
|
|
3639
|
+
"helpGroup": "GLOBAL",
|
|
3640
|
+
"allowNo": false,
|
|
3641
|
+
"deprecateAliases": true
|
|
3642
|
+
},
|
|
3643
|
+
"verbose": {
|
|
3644
|
+
"name": "verbose",
|
|
3645
|
+
"type": "boolean",
|
|
3646
|
+
"summary": "List more information about each org shape.",
|
|
3647
|
+
"hidden": true,
|
|
3648
|
+
"allowNo": false,
|
|
3649
|
+
"deprecateAliases": true
|
|
3650
|
+
},
|
|
3651
|
+
"loglevel": {
|
|
3652
|
+
"name": "loglevel",
|
|
3653
|
+
"type": "option",
|
|
3654
|
+
"hidden": true,
|
|
3655
|
+
"multiple": false,
|
|
3656
|
+
"deprecated": {
|
|
3657
|
+
"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."
|
|
3658
|
+
},
|
|
3659
|
+
"deprecateAliases": true
|
|
3660
|
+
}
|
|
3661
|
+
},
|
|
3662
|
+
"args": {}
|
|
3663
|
+
},
|
|
3664
|
+
"org:list:snapshot": {
|
|
3665
|
+
"id": "org:list:snapshot",
|
|
3666
|
+
"summary": "List scratch org snapshots.",
|
|
3667
|
+
"description": "You can view all the snapshots in a Dev Hub that you have access to. If you’re an admin, you can see all snapshots associated with the Dev Hub org. If you’re a user, you can see only your snapshots unless a Dev Hub admin gives you View All permissions.\n\nTo create a snapshot, use the \"<%= config.bin %> org create snapshot\" command. To get details about a snapshot request, use \"<%= config.bin %> org get snapshot\".",
|
|
3668
|
+
"strict": true,
|
|
3669
|
+
"pluginName": "@salesforce/plugin-signups",
|
|
3670
|
+
"pluginAlias": "@salesforce/plugin-signups",
|
|
3671
|
+
"pluginType": "jit",
|
|
3672
|
+
"aliases": [
|
|
3673
|
+
"force:org:snapshot:list"
|
|
3674
|
+
],
|
|
3675
|
+
"examples": [
|
|
3676
|
+
"List snapshots in the default Dev Hub:\n<%= config.bin %> <%= command.id %>",
|
|
3677
|
+
"List snapshots in the Dev Hub with alias SnapshotDevHub:\n<%= config.bin %> <%= command.id %> --target-dev-hub SnapshotDevHub"
|
|
3678
|
+
],
|
|
3679
|
+
"deprecateAliases": true,
|
|
3680
|
+
"flags": {
|
|
3681
|
+
"json": {
|
|
3682
|
+
"name": "json",
|
|
3683
|
+
"type": "boolean",
|
|
3684
|
+
"description": "Format output as json.",
|
|
3685
|
+
"helpGroup": "GLOBAL",
|
|
3686
|
+
"allowNo": false,
|
|
3687
|
+
"deprecateAliases": true
|
|
3688
|
+
},
|
|
3689
|
+
"target-dev-hub": {
|
|
3690
|
+
"name": "target-dev-hub",
|
|
3691
|
+
"type": "option",
|
|
3692
|
+
"char": "v",
|
|
3693
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
3694
|
+
"required": true,
|
|
3695
|
+
"multiple": false,
|
|
3696
|
+
"deprecateAliases": true,
|
|
3697
|
+
"aliases": [
|
|
3698
|
+
"targetdevhubusername"
|
|
3699
|
+
]
|
|
3700
|
+
},
|
|
3701
|
+
"api-version": {
|
|
3702
|
+
"name": "api-version",
|
|
3703
|
+
"type": "option",
|
|
3704
|
+
"description": "Override the api version used for api requests made by this command",
|
|
3705
|
+
"multiple": false,
|
|
3706
|
+
"deprecateAliases": true,
|
|
3707
|
+
"aliases": [
|
|
3708
|
+
"apiversion"
|
|
3709
|
+
]
|
|
3710
|
+
},
|
|
3711
|
+
"loglevel": {
|
|
3712
|
+
"name": "loglevel",
|
|
3713
|
+
"type": "option",
|
|
3714
|
+
"hidden": true,
|
|
3715
|
+
"multiple": false,
|
|
3716
|
+
"deprecated": {
|
|
3717
|
+
"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."
|
|
3718
|
+
},
|
|
3719
|
+
"deprecateAliases": true
|
|
3720
|
+
}
|
|
3721
|
+
},
|
|
3722
|
+
"args": {},
|
|
3723
|
+
"hasDynamicHelp": true
|
|
3724
|
+
}
|
|
3725
|
+
}
|
|
4
3726
|
}
|