@salesforce/cli 2.86.5 → 2.86.7
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/LICENSE.txt +200 -6
- package/README.md +53 -27
- package/dist/hooks/preparse.js +2 -2
- package/npm-shrinkwrap.json +918 -588
- package/oclif.lock +658 -435
- package/oclif.manifest.json +1369 -973
- package/package.json +10 -8
package/oclif.manifest.json
CHANGED
|
@@ -298,18 +298,17 @@
|
|
|
298
298
|
"run:code-analyzer"
|
|
299
299
|
]
|
|
300
300
|
},
|
|
301
|
-
"
|
|
301
|
+
"community:create": {
|
|
302
302
|
"aliases": [
|
|
303
|
-
"force:
|
|
304
|
-
"cmdt:field:create"
|
|
303
|
+
"force:community:create"
|
|
305
304
|
],
|
|
306
305
|
"args": {},
|
|
307
306
|
"deprecateAliases": true,
|
|
308
|
-
"description": "
|
|
307
|
+
"description": "Run the \"community list template\" command to see the templates available in your org. See 'Which Experience Cloud Template Should I Use?' in Salesforce Help for more information about the different template types available. (https://help.salesforce.com/s/articleView?id=sf.siteforce_commtemp_intro.htm&type=5)\n\nWhen you create 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 or AUTHENTICATED_WITH_PUBLIC_ACCESS_ENABLED. Name and values are case-sensitive. See 'DigitalExperienceBundle' in the Metadata API Developer Guide for more information. (https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_digitalexperiencebundle.htm)\n\nThe site creation process is an async job that generates a jobId. To check the site creation status, query the BackgroundOperation object and enter the jobId as the Id. See ‘BackgroundOperation’ in the Object Reference for the Salesforce Platform for more information. (https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_backgroundoperation.htm)\n\nIf the job doesn’t complete within 10 minutes, it times out. You receive an error message and must restart the site creation process. Completed jobs expire after 24 hours and are removed from the database.\n\nWhen you run this command, it creates the site in preview status, which means that the site 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, to activate the site and make it live, update the status field of the Network type in Metadata API. (https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_network.htm) Alternatively, in Experience Workspaces, go to Administration | Settings, and click Activate.\n\nFor Experience Builder sites, activating the site sends a welcome email to site members.",
|
|
309
308
|
"examples": [
|
|
310
|
-
"
|
|
311
|
-
"
|
|
312
|
-
"
|
|
309
|
+
"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'",
|
|
310
|
+
"Create a site using 'Partner Central' template:\n<%= config.bin %> <%= command.id %> --name partnercentral --template-name 'Partner Central' --url-path-prefix partners",
|
|
311
|
+
"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"
|
|
313
312
|
],
|
|
314
313
|
"flags": {
|
|
315
314
|
"json": {
|
|
@@ -327,176 +326,127 @@
|
|
|
327
326
|
"multiple": false,
|
|
328
327
|
"type": "option"
|
|
329
328
|
},
|
|
330
|
-
"loglevel": {
|
|
331
|
-
"deprecated": {
|
|
332
|
-
"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."
|
|
333
|
-
},
|
|
334
|
-
"hidden": true,
|
|
335
|
-
"name": "loglevel",
|
|
336
|
-
"hasDynamicHelp": false,
|
|
337
|
-
"multiple": false,
|
|
338
|
-
"type": "option"
|
|
339
|
-
},
|
|
340
329
|
"name": {
|
|
341
|
-
"aliases": [
|
|
342
|
-
"fieldname"
|
|
343
|
-
],
|
|
344
330
|
"char": "n",
|
|
345
331
|
"name": "name",
|
|
346
332
|
"required": true,
|
|
347
|
-
"summary": "
|
|
333
|
+
"summary": "Name of the site to create.",
|
|
348
334
|
"hasDynamicHelp": false,
|
|
349
335
|
"multiple": false,
|
|
350
336
|
"type": "option"
|
|
351
337
|
},
|
|
352
|
-
"
|
|
338
|
+
"template-name": {
|
|
353
339
|
"aliases": [
|
|
354
|
-
"
|
|
340
|
+
"templatename"
|
|
355
341
|
],
|
|
356
|
-
"char": "
|
|
357
|
-
"
|
|
358
|
-
"
|
|
342
|
+
"char": "t",
|
|
343
|
+
"deprecateAliases": true,
|
|
344
|
+
"description": "An example of a template is Customer Service. Run the \"community template list\" command to see which templates are available in your org.",
|
|
345
|
+
"name": "template-name",
|
|
359
346
|
"required": true,
|
|
360
|
-
"summary": "
|
|
347
|
+
"summary": "Template to use to create a site.",
|
|
361
348
|
"hasDynamicHelp": false,
|
|
362
349
|
"multiple": false,
|
|
363
|
-
"options": [
|
|
364
|
-
"Checkbox",
|
|
365
|
-
"Date",
|
|
366
|
-
"DateTime",
|
|
367
|
-
"Email",
|
|
368
|
-
"Number",
|
|
369
|
-
"Percent",
|
|
370
|
-
"Phone",
|
|
371
|
-
"Picklist",
|
|
372
|
-
"Text",
|
|
373
|
-
"TextArea",
|
|
374
|
-
"LongTextArea",
|
|
375
|
-
"Url"
|
|
376
|
-
],
|
|
377
350
|
"type": "option"
|
|
378
351
|
},
|
|
379
|
-
"
|
|
352
|
+
"url-path-prefix": {
|
|
380
353
|
"aliases": [
|
|
381
|
-
"
|
|
354
|
+
"urlpathprefix"
|
|
382
355
|
],
|
|
383
356
|
"char": "p",
|
|
384
|
-
"
|
|
385
|
-
"
|
|
386
|
-
"
|
|
357
|
+
"deprecateAliases": true,
|
|
358
|
+
"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.",
|
|
359
|
+
"name": "url-path-prefix",
|
|
360
|
+
"summary": "URL to append to the domain created when Digital Experiences was enabled for this org.",
|
|
361
|
+
"default": "",
|
|
387
362
|
"hasDynamicHelp": false,
|
|
388
|
-
"multiple":
|
|
363
|
+
"multiple": false,
|
|
389
364
|
"type": "option"
|
|
390
365
|
},
|
|
391
|
-
"
|
|
366
|
+
"description": {
|
|
367
|
+
"char": "d",
|
|
368
|
+
"description": "The description displays in Digital Experiences - All Sites in Setup and helps with site identification.",
|
|
369
|
+
"name": "description",
|
|
370
|
+
"summary": "Description of the site.",
|
|
371
|
+
"hasDynamicHelp": false,
|
|
372
|
+
"multiple": false,
|
|
373
|
+
"type": "option"
|
|
374
|
+
},
|
|
375
|
+
"target-org": {
|
|
392
376
|
"aliases": [
|
|
393
|
-
"
|
|
377
|
+
"targetusername",
|
|
378
|
+
"u"
|
|
394
379
|
],
|
|
395
|
-
"char": "
|
|
396
|
-
"
|
|
397
|
-
"name": "
|
|
398
|
-
"
|
|
399
|
-
"
|
|
400
|
-
"
|
|
380
|
+
"char": "o",
|
|
381
|
+
"deprecateAliases": true,
|
|
382
|
+
"name": "target-org",
|
|
383
|
+
"noCacheDefault": true,
|
|
384
|
+
"required": true,
|
|
385
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
386
|
+
"hasDynamicHelp": true,
|
|
401
387
|
"multiple": false,
|
|
402
388
|
"type": "option"
|
|
403
389
|
},
|
|
404
|
-
"
|
|
405
|
-
"
|
|
406
|
-
|
|
407
|
-
|
|
390
|
+
"loglevel": {
|
|
391
|
+
"deprecated": {
|
|
392
|
+
"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."
|
|
393
|
+
},
|
|
394
|
+
"hidden": true,
|
|
395
|
+
"name": "loglevel",
|
|
408
396
|
"hasDynamicHelp": false,
|
|
409
397
|
"multiple": false,
|
|
410
398
|
"type": "option"
|
|
411
399
|
},
|
|
412
|
-
"
|
|
400
|
+
"api-version": {
|
|
413
401
|
"aliases": [
|
|
414
|
-
"
|
|
415
|
-
"outputdirectory"
|
|
402
|
+
"apiversion"
|
|
416
403
|
],
|
|
417
|
-
"
|
|
418
|
-
"description": "
|
|
419
|
-
"name": "
|
|
420
|
-
"summary": "Directory to store newly-created field definition files.",
|
|
421
|
-
"default": "",
|
|
404
|
+
"deprecateAliases": true,
|
|
405
|
+
"description": "Override the api version used for api requests made by this command",
|
|
406
|
+
"name": "api-version",
|
|
422
407
|
"hasDynamicHelp": false,
|
|
423
408
|
"multiple": false,
|
|
424
409
|
"type": "option"
|
|
425
410
|
}
|
|
426
411
|
},
|
|
427
|
-
"hasDynamicHelp":
|
|
412
|
+
"hasDynamicHelp": true,
|
|
428
413
|
"hiddenAliases": [],
|
|
429
|
-
"id": "
|
|
430
|
-
"pluginAlias": "@salesforce/plugin-
|
|
431
|
-
"pluginName": "@salesforce/plugin-
|
|
414
|
+
"id": "community:create",
|
|
415
|
+
"pluginAlias": "@salesforce/plugin-community",
|
|
416
|
+
"pluginName": "@salesforce/plugin-community",
|
|
432
417
|
"pluginType": "jit",
|
|
433
|
-
"strict":
|
|
434
|
-
"summary": "
|
|
418
|
+
"strict": false,
|
|
419
|
+
"summary": "Create an Experience Cloud site using a template.",
|
|
435
420
|
"enableJsonFlag": true,
|
|
436
|
-
"requiresProject": true,
|
|
437
421
|
"isESM": true,
|
|
438
422
|
"relativePath": [
|
|
439
423
|
"lib",
|
|
440
424
|
"commands",
|
|
441
|
-
"
|
|
442
|
-
"
|
|
443
|
-
"field.js"
|
|
425
|
+
"community",
|
|
426
|
+
"create.js"
|
|
444
427
|
],
|
|
445
428
|
"aliasPermutations": [
|
|
446
|
-
"force:
|
|
447
|
-
"
|
|
448
|
-
"
|
|
449
|
-
"
|
|
450
|
-
"force:
|
|
451
|
-
"
|
|
452
|
-
"field:cmdt:force:create",
|
|
453
|
-
"field:cmdt:create:force",
|
|
454
|
-
"force:field:create:cmdt",
|
|
455
|
-
"field:force:create:cmdt",
|
|
456
|
-
"field:create:force:cmdt",
|
|
457
|
-
"field:create:cmdt:force",
|
|
458
|
-
"force:cmdt:create:field",
|
|
459
|
-
"cmdt:force:create:field",
|
|
460
|
-
"cmdt:create:force:field",
|
|
461
|
-
"cmdt:create:field:force",
|
|
462
|
-
"force:create:cmdt:field",
|
|
463
|
-
"create:force:cmdt:field",
|
|
464
|
-
"create:cmdt:force:field",
|
|
465
|
-
"create:cmdt:field:force",
|
|
466
|
-
"force:create:field:cmdt",
|
|
467
|
-
"create:force:field:cmdt",
|
|
468
|
-
"create:field:force:cmdt",
|
|
469
|
-
"create:field:cmdt:force",
|
|
470
|
-
"cmdt:field:create",
|
|
471
|
-
"field:cmdt:create",
|
|
472
|
-
"field:create:cmdt",
|
|
473
|
-
"cmdt:create:field",
|
|
474
|
-
"create:cmdt:field",
|
|
475
|
-
"create:field:cmdt"
|
|
429
|
+
"force:community:create",
|
|
430
|
+
"community:force:create",
|
|
431
|
+
"community:create:force",
|
|
432
|
+
"force:create:community",
|
|
433
|
+
"create:force:community",
|
|
434
|
+
"create:community:force"
|
|
476
435
|
],
|
|
477
436
|
"permutations": [
|
|
478
|
-
"
|
|
479
|
-
"
|
|
480
|
-
"generate:field:cmdt",
|
|
481
|
-
"cmdt:field:generate",
|
|
482
|
-
"field:cmdt:generate",
|
|
483
|
-
"field:generate:cmdt"
|
|
437
|
+
"community:create",
|
|
438
|
+
"create:community"
|
|
484
439
|
]
|
|
485
440
|
},
|
|
486
|
-
"
|
|
441
|
+
"community:publish": {
|
|
487
442
|
"aliases": [
|
|
488
|
-
"force:
|
|
443
|
+
"force:community:publish"
|
|
489
444
|
],
|
|
490
445
|
"args": {},
|
|
491
446
|
"deprecateAliases": true,
|
|
492
|
-
"description": "
|
|
447
|
+
"description": "Each time you publish a site, 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\nIn addition to publishing, you must activate a site to send a welcome email to all site members. Activation is also required to set up SEO for Experience Builder sites. To activate a site, update the status field of the Network type in Metadata API. (https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_network.htm) Alternatively, in Experience Workspaces, go to Administration | Settings, and click Activate.\n\nAn email notification informs you when your changes are live on the published site. The site publish process is an async job that generates a jobId. To check the site publish status manually, query the BackgroundOperation object and enter the jobId as the Id. See ‘BackgroundOperation’ in the Object Reference for the Salesforce Platform for more information. (https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_backgroundoperation.htm)\n\nIf the job doesn’t complete within 15 minutes, it times out. You receive an error message and must restart the site publish process. Completed jobs expire after 24 hours and are removed from the database.",
|
|
493
448
|
"examples": [
|
|
494
|
-
"
|
|
495
|
-
"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",
|
|
496
|
-
"Generate a protected custom metadata type from a custom object:\n<%= config.bin %> <%= command.id %> --dev-name MyCMDT --sobject MySourceObject__c --visibility Protected",
|
|
497
|
-
"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",
|
|
498
|
-
"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",
|
|
499
|
-
"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"
|
|
449
|
+
"Publish the Experience Builder site with name \"My Customer Site':\n<%= config.bin %> <%= command.id %> --name 'My Customer Site'"
|
|
500
450
|
],
|
|
501
451
|
"flags": {
|
|
502
452
|
"json": {
|
|
@@ -514,6 +464,15 @@
|
|
|
514
464
|
"multiple": false,
|
|
515
465
|
"type": "option"
|
|
516
466
|
},
|
|
467
|
+
"name": {
|
|
468
|
+
"char": "n",
|
|
469
|
+
"name": "name",
|
|
470
|
+
"required": true,
|
|
471
|
+
"summary": "Name of the Experience Builder site to publish.",
|
|
472
|
+
"hasDynamicHelp": false,
|
|
473
|
+
"multiple": false,
|
|
474
|
+
"type": "option"
|
|
475
|
+
},
|
|
517
476
|
"target-org": {
|
|
518
477
|
"aliases": [
|
|
519
478
|
"targetusername",
|
|
@@ -549,96 +508,95 @@
|
|
|
549
508
|
"hasDynamicHelp": false,
|
|
550
509
|
"multiple": false,
|
|
551
510
|
"type": "option"
|
|
511
|
+
}
|
|
512
|
+
},
|
|
513
|
+
"hasDynamicHelp": true,
|
|
514
|
+
"hiddenAliases": [],
|
|
515
|
+
"id": "community:publish",
|
|
516
|
+
"pluginAlias": "@salesforce/plugin-community",
|
|
517
|
+
"pluginName": "@salesforce/plugin-community",
|
|
518
|
+
"pluginType": "jit",
|
|
519
|
+
"strict": true,
|
|
520
|
+
"summary": "Publish an Experience Builder site to make it live.",
|
|
521
|
+
"enableJsonFlag": true,
|
|
522
|
+
"isESM": true,
|
|
523
|
+
"relativePath": [
|
|
524
|
+
"lib",
|
|
525
|
+
"commands",
|
|
526
|
+
"community",
|
|
527
|
+
"publish.js"
|
|
528
|
+
],
|
|
529
|
+
"aliasPermutations": [
|
|
530
|
+
"force:community:publish",
|
|
531
|
+
"community:force:publish",
|
|
532
|
+
"community:publish:force",
|
|
533
|
+
"force:publish:community",
|
|
534
|
+
"publish:force:community",
|
|
535
|
+
"publish:community:force"
|
|
536
|
+
],
|
|
537
|
+
"permutations": [
|
|
538
|
+
"community:publish",
|
|
539
|
+
"publish:community"
|
|
540
|
+
]
|
|
541
|
+
},
|
|
542
|
+
"community:list:template": {
|
|
543
|
+
"aliases": [
|
|
544
|
+
"force:community:template:list"
|
|
545
|
+
],
|
|
546
|
+
"args": {},
|
|
547
|
+
"deprecateAliases": true,
|
|
548
|
+
"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.",
|
|
549
|
+
"examples": [
|
|
550
|
+
"Retrieve the template list from an org with alias my-scratch-org:\n<%= config.bin %> <%= command.id %> --target-org my-scratch-org"
|
|
551
|
+
],
|
|
552
|
+
"flags": {
|
|
553
|
+
"json": {
|
|
554
|
+
"description": "Format output as json.",
|
|
555
|
+
"helpGroup": "GLOBAL",
|
|
556
|
+
"name": "json",
|
|
557
|
+
"allowNo": false,
|
|
558
|
+
"type": "boolean"
|
|
552
559
|
},
|
|
553
|
-
"
|
|
554
|
-
"
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
"char": "n",
|
|
558
|
-
"name": "dev-name",
|
|
559
|
-
"required": true,
|
|
560
|
-
"summary": "Name of the custom metadata type.",
|
|
561
|
-
"hasDynamicHelp": false,
|
|
562
|
-
"multiple": false,
|
|
563
|
-
"type": "option"
|
|
564
|
-
},
|
|
565
|
-
"label": {
|
|
566
|
-
"char": "l",
|
|
567
|
-
"name": "label",
|
|
568
|
-
"summary": "Label for the custom metadata type.",
|
|
569
|
-
"hasDynamicHelp": false,
|
|
570
|
-
"multiple": false,
|
|
571
|
-
"type": "option"
|
|
572
|
-
},
|
|
573
|
-
"plural-label": {
|
|
574
|
-
"aliases": [
|
|
575
|
-
"plurallabel"
|
|
576
|
-
],
|
|
577
|
-
"char": "p",
|
|
578
|
-
"name": "plural-label",
|
|
579
|
-
"summary": "Plural version of the label value; if blank, uses label.",
|
|
580
|
-
"hasDynamicHelp": false,
|
|
581
|
-
"multiple": false,
|
|
582
|
-
"type": "option"
|
|
583
|
-
},
|
|
584
|
-
"visibility": {
|
|
585
|
-
"char": "v",
|
|
586
|
-
"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.",
|
|
587
|
-
"name": "visibility",
|
|
588
|
-
"summary": "Who can see the custom metadata type.",
|
|
589
|
-
"default": "Public",
|
|
560
|
+
"flags-dir": {
|
|
561
|
+
"helpGroup": "GLOBAL",
|
|
562
|
+
"name": "flags-dir",
|
|
563
|
+
"summary": "Import flag values from a directory.",
|
|
590
564
|
"hasDynamicHelp": false,
|
|
591
565
|
"multiple": false,
|
|
592
|
-
"options": [
|
|
593
|
-
"PackageProtected",
|
|
594
|
-
"Protected",
|
|
595
|
-
"Public"
|
|
596
|
-
],
|
|
597
566
|
"type": "option"
|
|
598
567
|
},
|
|
599
|
-
"
|
|
568
|
+
"target-org": {
|
|
600
569
|
"aliases": [
|
|
601
|
-
"
|
|
570
|
+
"targetusername",
|
|
571
|
+
"u"
|
|
602
572
|
],
|
|
603
|
-
"char": "
|
|
604
|
-
"
|
|
573
|
+
"char": "o",
|
|
574
|
+
"deprecateAliases": true,
|
|
575
|
+
"name": "target-org",
|
|
576
|
+
"noCacheDefault": true,
|
|
605
577
|
"required": true,
|
|
606
|
-
"summary": "
|
|
607
|
-
"hasDynamicHelp":
|
|
578
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
579
|
+
"hasDynamicHelp": true,
|
|
608
580
|
"multiple": false,
|
|
609
581
|
"type": "option"
|
|
610
582
|
},
|
|
611
|
-
"
|
|
612
|
-
"aliases": [
|
|
613
|
-
"ignoreunsupported"
|
|
614
|
-
],
|
|
615
|
-
"char": "i",
|
|
616
|
-
"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.",
|
|
617
|
-
"name": "ignore-unsupported",
|
|
618
|
-
"summary": "Ignore unsupported field types.",
|
|
619
|
-
"allowNo": false,
|
|
620
|
-
"type": "boolean"
|
|
621
|
-
},
|
|
622
|
-
"type-output-directory": {
|
|
583
|
+
"api-version": {
|
|
623
584
|
"aliases": [
|
|
624
|
-
"
|
|
585
|
+
"apiversion"
|
|
625
586
|
],
|
|
626
|
-
"
|
|
627
|
-
"
|
|
628
|
-
"
|
|
629
|
-
"default": "force-app/main/default/objects",
|
|
587
|
+
"deprecateAliases": true,
|
|
588
|
+
"description": "Override the api version used for api requests made by this command",
|
|
589
|
+
"name": "api-version",
|
|
630
590
|
"hasDynamicHelp": false,
|
|
631
591
|
"multiple": false,
|
|
632
592
|
"type": "option"
|
|
633
593
|
},
|
|
634
|
-
"
|
|
635
|
-
"
|
|
636
|
-
"
|
|
637
|
-
|
|
638
|
-
"
|
|
639
|
-
"name": "
|
|
640
|
-
"summary": "Directory to store newly-created custom metadata record files.",
|
|
641
|
-
"default": "force-app/main/default/customMetadata",
|
|
594
|
+
"loglevel": {
|
|
595
|
+
"deprecated": {
|
|
596
|
+
"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."
|
|
597
|
+
},
|
|
598
|
+
"hidden": true,
|
|
599
|
+
"name": "loglevel",
|
|
642
600
|
"hasDynamicHelp": false,
|
|
643
601
|
"multiple": false,
|
|
644
602
|
"type": "option"
|
|
@@ -646,50 +604,68 @@
|
|
|
646
604
|
},
|
|
647
605
|
"hasDynamicHelp": true,
|
|
648
606
|
"hiddenAliases": [],
|
|
649
|
-
"id": "
|
|
650
|
-
"pluginAlias": "@salesforce/plugin-
|
|
651
|
-
"pluginName": "@salesforce/plugin-
|
|
607
|
+
"id": "community:list:template",
|
|
608
|
+
"pluginAlias": "@salesforce/plugin-community",
|
|
609
|
+
"pluginName": "@salesforce/plugin-community",
|
|
652
610
|
"pluginType": "jit",
|
|
653
611
|
"strict": true,
|
|
654
|
-
"summary": "
|
|
612
|
+
"summary": "Retrieve the list of templates available in your org.",
|
|
655
613
|
"enableJsonFlag": true,
|
|
656
|
-
"requiresProject": true,
|
|
657
614
|
"isESM": true,
|
|
658
615
|
"relativePath": [
|
|
659
616
|
"lib",
|
|
660
617
|
"commands",
|
|
661
|
-
"
|
|
662
|
-
"
|
|
663
|
-
"
|
|
618
|
+
"community",
|
|
619
|
+
"list",
|
|
620
|
+
"template.js"
|
|
664
621
|
],
|
|
665
622
|
"aliasPermutations": [
|
|
666
|
-
"force:
|
|
667
|
-
"
|
|
668
|
-
"
|
|
669
|
-
"
|
|
670
|
-
"
|
|
671
|
-
"
|
|
623
|
+
"force:community:template:list",
|
|
624
|
+
"community:force:template:list",
|
|
625
|
+
"community:template:force:list",
|
|
626
|
+
"community:template:list:force",
|
|
627
|
+
"force:template:community:list",
|
|
628
|
+
"template:force:community:list",
|
|
629
|
+
"template:community:force:list",
|
|
630
|
+
"template:community:list:force",
|
|
631
|
+
"force:template:list:community",
|
|
632
|
+
"template:force:list:community",
|
|
633
|
+
"template:list:force:community",
|
|
634
|
+
"template:list:community:force",
|
|
635
|
+
"force:community:list:template",
|
|
636
|
+
"community:force:list:template",
|
|
637
|
+
"community:list:force:template",
|
|
638
|
+
"community:list:template:force",
|
|
639
|
+
"force:list:community:template",
|
|
640
|
+
"list:force:community:template",
|
|
641
|
+
"list:community:force:template",
|
|
642
|
+
"list:community:template:force",
|
|
643
|
+
"force:list:template:community",
|
|
644
|
+
"list:force:template:community",
|
|
645
|
+
"list:template:force:community",
|
|
646
|
+
"list:template:community:force"
|
|
672
647
|
],
|
|
673
648
|
"permutations": [
|
|
674
|
-
"
|
|
675
|
-
"
|
|
676
|
-
"
|
|
677
|
-
"
|
|
678
|
-
"
|
|
679
|
-
"
|
|
649
|
+
"community:list:template",
|
|
650
|
+
"list:community:template",
|
|
651
|
+
"list:template:community",
|
|
652
|
+
"community:template:list",
|
|
653
|
+
"template:community:list",
|
|
654
|
+
"template:list:community"
|
|
680
655
|
]
|
|
681
656
|
},
|
|
682
|
-
"cmdt:generate:
|
|
657
|
+
"cmdt:generate:field": {
|
|
683
658
|
"aliases": [
|
|
684
|
-
"force:cmdt:create",
|
|
685
|
-
"cmdt:create"
|
|
659
|
+
"force:cmdt:field:create",
|
|
660
|
+
"cmdt:field:create"
|
|
686
661
|
],
|
|
687
662
|
"args": {},
|
|
688
663
|
"deprecateAliases": true,
|
|
689
|
-
"description": "
|
|
664
|
+
"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.",
|
|
690
665
|
"examples": [
|
|
691
|
-
"Generate a
|
|
692
|
-
"Generate a
|
|
666
|
+
"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",
|
|
667
|
+
"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",
|
|
668
|
+
"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"
|
|
693
669
|
],
|
|
694
670
|
"flags": {
|
|
695
671
|
"json": {
|
|
@@ -717,51 +693,76 @@
|
|
|
717
693
|
"multiple": false,
|
|
718
694
|
"type": "option"
|
|
719
695
|
},
|
|
720
|
-
"
|
|
696
|
+
"name": {
|
|
721
697
|
"aliases": [
|
|
722
|
-
"
|
|
698
|
+
"fieldname"
|
|
723
699
|
],
|
|
724
700
|
"char": "n",
|
|
725
|
-
"
|
|
726
|
-
"name": "type-name",
|
|
701
|
+
"name": "name",
|
|
727
702
|
"required": true,
|
|
728
|
-
"summary": "Unique
|
|
703
|
+
"summary": "Unique name for the field.",
|
|
729
704
|
"hasDynamicHelp": false,
|
|
730
705
|
"multiple": false,
|
|
731
706
|
"type": "option"
|
|
732
707
|
},
|
|
733
|
-
"
|
|
734
|
-
"
|
|
735
|
-
|
|
736
|
-
|
|
708
|
+
"type": {
|
|
709
|
+
"aliases": [
|
|
710
|
+
"fieldtype"
|
|
711
|
+
],
|
|
712
|
+
"char": "f",
|
|
713
|
+
"description": "You can't use this command to create a custom metadata type field of type \"Metadata Relationship\". Use the Salesforce Setup UI instead.",
|
|
714
|
+
"name": "type",
|
|
715
|
+
"required": true,
|
|
716
|
+
"summary": "Type of the field.",
|
|
737
717
|
"hasDynamicHelp": false,
|
|
738
718
|
"multiple": false,
|
|
719
|
+
"options": [
|
|
720
|
+
"Checkbox",
|
|
721
|
+
"Date",
|
|
722
|
+
"DateTime",
|
|
723
|
+
"Email",
|
|
724
|
+
"Number",
|
|
725
|
+
"Percent",
|
|
726
|
+
"Phone",
|
|
727
|
+
"Picklist",
|
|
728
|
+
"Text",
|
|
729
|
+
"TextArea",
|
|
730
|
+
"LongTextArea",
|
|
731
|
+
"Url"
|
|
732
|
+
],
|
|
739
733
|
"type": "option"
|
|
740
734
|
},
|
|
741
|
-
"
|
|
735
|
+
"picklist-values": {
|
|
742
736
|
"aliases": [
|
|
743
|
-
"
|
|
737
|
+
"picklistvalues"
|
|
744
738
|
],
|
|
745
739
|
"char": "p",
|
|
746
|
-
"name": "
|
|
747
|
-
"summary": "
|
|
740
|
+
"name": "picklist-values",
|
|
741
|
+
"summary": "Picklist values; required for picklist fields.",
|
|
742
|
+
"delimiter": ",",
|
|
743
|
+
"hasDynamicHelp": false,
|
|
744
|
+
"multiple": true,
|
|
745
|
+
"type": "option"
|
|
746
|
+
},
|
|
747
|
+
"decimal-places": {
|
|
748
|
+
"aliases": [
|
|
749
|
+
"decimalplaces"
|
|
750
|
+
],
|
|
751
|
+
"char": "s",
|
|
752
|
+
"description": "The value must be greater than or equal to zero. Default value is 0.",
|
|
753
|
+
"name": "decimal-places",
|
|
754
|
+
"summary": "Number of decimal places to use for number or percent fields.",
|
|
755
|
+
"default": 0,
|
|
748
756
|
"hasDynamicHelp": false,
|
|
749
757
|
"multiple": false,
|
|
750
758
|
"type": "option"
|
|
751
759
|
},
|
|
752
|
-
"
|
|
753
|
-
"char": "
|
|
754
|
-
"
|
|
755
|
-
"
|
|
756
|
-
"summary": "Who can see the custom metadata type.",
|
|
757
|
-
"default": "Public",
|
|
760
|
+
"label": {
|
|
761
|
+
"char": "l",
|
|
762
|
+
"name": "label",
|
|
763
|
+
"summary": "Label for the field.",
|
|
758
764
|
"hasDynamicHelp": false,
|
|
759
765
|
"multiple": false,
|
|
760
|
-
"options": [
|
|
761
|
-
"PackageProtected",
|
|
762
|
-
"Protected",
|
|
763
|
-
"Public"
|
|
764
|
-
],
|
|
765
766
|
"type": "option"
|
|
766
767
|
},
|
|
767
768
|
"output-directory": {
|
|
@@ -770,9 +771,9 @@
|
|
|
770
771
|
"outputdirectory"
|
|
771
772
|
],
|
|
772
773
|
"char": "d",
|
|
773
|
-
"description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
|
|
774
|
+
"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.",
|
|
774
775
|
"name": "output-directory",
|
|
775
|
-
"summary": "Directory to store
|
|
776
|
+
"summary": "Directory to store newly-created field definition files.",
|
|
776
777
|
"default": "",
|
|
777
778
|
"hasDynamicHelp": false,
|
|
778
779
|
"multiple": false,
|
|
@@ -781,12 +782,12 @@
|
|
|
781
782
|
},
|
|
782
783
|
"hasDynamicHelp": false,
|
|
783
784
|
"hiddenAliases": [],
|
|
784
|
-
"id": "cmdt:generate:
|
|
785
|
+
"id": "cmdt:generate:field",
|
|
785
786
|
"pluginAlias": "@salesforce/plugin-custom-metadata",
|
|
786
787
|
"pluginName": "@salesforce/plugin-custom-metadata",
|
|
787
788
|
"pluginType": "jit",
|
|
788
789
|
"strict": true,
|
|
789
|
-
"summary": "Generate a
|
|
790
|
+
"summary": "Generate a field for a custom metadata type based on the provided field type.",
|
|
790
791
|
"enableJsonFlag": true,
|
|
791
792
|
"requiresProject": true,
|
|
792
793
|
"isESM": true,
|
|
@@ -795,38 +796,63 @@
|
|
|
795
796
|
"commands",
|
|
796
797
|
"cmdt",
|
|
797
798
|
"generate",
|
|
798
|
-
"
|
|
799
|
+
"field.js"
|
|
799
800
|
],
|
|
800
801
|
"aliasPermutations": [
|
|
801
|
-
"force:cmdt:create",
|
|
802
|
-
"cmdt:force:create",
|
|
803
|
-
"cmdt:
|
|
804
|
-
"
|
|
805
|
-
"
|
|
806
|
-
"
|
|
807
|
-
"cmdt:create",
|
|
808
|
-
"create:
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
"
|
|
812
|
-
"
|
|
813
|
-
"
|
|
814
|
-
"cmdt:
|
|
815
|
-
"
|
|
816
|
-
"
|
|
802
|
+
"force:cmdt:field:create",
|
|
803
|
+
"cmdt:force:field:create",
|
|
804
|
+
"cmdt:field:force:create",
|
|
805
|
+
"cmdt:field:create:force",
|
|
806
|
+
"force:field:cmdt:create",
|
|
807
|
+
"field:force:cmdt:create",
|
|
808
|
+
"field:cmdt:force:create",
|
|
809
|
+
"field:cmdt:create:force",
|
|
810
|
+
"force:field:create:cmdt",
|
|
811
|
+
"field:force:create:cmdt",
|
|
812
|
+
"field:create:force:cmdt",
|
|
813
|
+
"field:create:cmdt:force",
|
|
814
|
+
"force:cmdt:create:field",
|
|
815
|
+
"cmdt:force:create:field",
|
|
816
|
+
"cmdt:create:force:field",
|
|
817
|
+
"cmdt:create:field:force",
|
|
818
|
+
"force:create:cmdt:field",
|
|
819
|
+
"create:force:cmdt:field",
|
|
820
|
+
"create:cmdt:force:field",
|
|
821
|
+
"create:cmdt:field:force",
|
|
822
|
+
"force:create:field:cmdt",
|
|
823
|
+
"create:force:field:cmdt",
|
|
824
|
+
"create:field:force:cmdt",
|
|
825
|
+
"create:field:cmdt:force",
|
|
826
|
+
"cmdt:field:create",
|
|
827
|
+
"field:cmdt:create",
|
|
828
|
+
"field:create:cmdt",
|
|
829
|
+
"cmdt:create:field",
|
|
830
|
+
"create:cmdt:field",
|
|
831
|
+
"create:field:cmdt"
|
|
832
|
+
],
|
|
833
|
+
"permutations": [
|
|
834
|
+
"cmdt:generate:field",
|
|
835
|
+
"generate:cmdt:field",
|
|
836
|
+
"generate:field:cmdt",
|
|
837
|
+
"cmdt:field:generate",
|
|
838
|
+
"field:cmdt:generate",
|
|
839
|
+
"field:generate:cmdt"
|
|
817
840
|
]
|
|
818
841
|
},
|
|
819
|
-
"cmdt:generate:
|
|
842
|
+
"cmdt:generate:fromorg": {
|
|
820
843
|
"aliases": [
|
|
821
|
-
"force:cmdt:
|
|
822
|
-
"cmdt:record:create"
|
|
844
|
+
"force:cmdt:generate"
|
|
823
845
|
],
|
|
824
846
|
"args": {},
|
|
825
847
|
"deprecateAliases": true,
|
|
826
|
-
"description": "
|
|
848
|
+
"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.",
|
|
827
849
|
"examples": [
|
|
828
|
-
"
|
|
829
|
-
"
|
|
850
|
+
"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",
|
|
851
|
+
"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",
|
|
852
|
+
"Generate a protected custom metadata type from a custom object:\n<%= config.bin %> <%= command.id %> --dev-name MyCMDT --sobject MySourceObject__c --visibility Protected",
|
|
853
|
+
"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",
|
|
854
|
+
"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",
|
|
855
|
+
"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"
|
|
830
856
|
],
|
|
831
857
|
"flags": {
|
|
832
858
|
"json": {
|
|
@@ -844,6 +870,32 @@
|
|
|
844
870
|
"multiple": false,
|
|
845
871
|
"type": "option"
|
|
846
872
|
},
|
|
873
|
+
"target-org": {
|
|
874
|
+
"aliases": [
|
|
875
|
+
"targetusername",
|
|
876
|
+
"u"
|
|
877
|
+
],
|
|
878
|
+
"char": "o",
|
|
879
|
+
"deprecateAliases": true,
|
|
880
|
+
"name": "target-org",
|
|
881
|
+
"noCacheDefault": true,
|
|
882
|
+
"required": true,
|
|
883
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
884
|
+
"hasDynamicHelp": true,
|
|
885
|
+
"multiple": false,
|
|
886
|
+
"type": "option"
|
|
887
|
+
},
|
|
888
|
+
"api-version": {
|
|
889
|
+
"aliases": [
|
|
890
|
+
"apiversion"
|
|
891
|
+
],
|
|
892
|
+
"deprecateAliases": true,
|
|
893
|
+
"description": "Override the api version used for api requests made by this command",
|
|
894
|
+
"name": "api-version",
|
|
895
|
+
"hasDynamicHelp": false,
|
|
896
|
+
"multiple": false,
|
|
897
|
+
"type": "option"
|
|
898
|
+
},
|
|
847
899
|
"loglevel": {
|
|
848
900
|
"deprecated": {
|
|
849
901
|
"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."
|
|
@@ -854,26 +906,14 @@
|
|
|
854
906
|
"multiple": false,
|
|
855
907
|
"type": "option"
|
|
856
908
|
},
|
|
857
|
-
"
|
|
858
|
-
"aliases": [
|
|
859
|
-
"typename"
|
|
860
|
-
],
|
|
861
|
-
"char": "t",
|
|
862
|
-
"name": "type-name",
|
|
863
|
-
"required": true,
|
|
864
|
-
"summary": "API name of the custom metadata type to create a record for; must end in \"__mdt\".",
|
|
865
|
-
"hasDynamicHelp": false,
|
|
866
|
-
"multiple": false,
|
|
867
|
-
"type": "option"
|
|
868
|
-
},
|
|
869
|
-
"record-name": {
|
|
909
|
+
"dev-name": {
|
|
870
910
|
"aliases": [
|
|
871
|
-
"
|
|
911
|
+
"devname"
|
|
872
912
|
],
|
|
873
913
|
"char": "n",
|
|
874
|
-
"name": "
|
|
914
|
+
"name": "dev-name",
|
|
875
915
|
"required": true,
|
|
876
|
-
"summary": "Name of the
|
|
916
|
+
"summary": "Name of the custom metadata type.",
|
|
877
917
|
"hasDynamicHelp": false,
|
|
878
918
|
"multiple": false,
|
|
879
919
|
"type": "option"
|
|
@@ -881,45 +921,78 @@
|
|
|
881
921
|
"label": {
|
|
882
922
|
"char": "l",
|
|
883
923
|
"name": "label",
|
|
884
|
-
"summary": "Label for the
|
|
924
|
+
"summary": "Label for the custom metadata type.",
|
|
885
925
|
"hasDynamicHelp": false,
|
|
886
926
|
"multiple": false,
|
|
887
927
|
"type": "option"
|
|
888
928
|
},
|
|
889
|
-
"
|
|
929
|
+
"plural-label": {
|
|
930
|
+
"aliases": [
|
|
931
|
+
"plurallabel"
|
|
932
|
+
],
|
|
890
933
|
"char": "p",
|
|
891
|
-
"
|
|
892
|
-
"
|
|
893
|
-
"
|
|
894
|
-
"
|
|
934
|
+
"name": "plural-label",
|
|
935
|
+
"summary": "Plural version of the label value; if blank, uses label.",
|
|
936
|
+
"hasDynamicHelp": false,
|
|
937
|
+
"multiple": false,
|
|
938
|
+
"type": "option"
|
|
939
|
+
},
|
|
940
|
+
"visibility": {
|
|
941
|
+
"char": "v",
|
|
942
|
+
"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.",
|
|
943
|
+
"name": "visibility",
|
|
944
|
+
"summary": "Who can see the custom metadata type.",
|
|
945
|
+
"default": "Public",
|
|
895
946
|
"hasDynamicHelp": false,
|
|
896
947
|
"multiple": false,
|
|
897
948
|
"options": [
|
|
898
|
-
"
|
|
899
|
-
"
|
|
949
|
+
"PackageProtected",
|
|
950
|
+
"Protected",
|
|
951
|
+
"Public"
|
|
900
952
|
],
|
|
901
953
|
"type": "option"
|
|
902
954
|
},
|
|
903
|
-
"
|
|
955
|
+
"sobject": {
|
|
904
956
|
"aliases": [
|
|
905
|
-
"
|
|
906
|
-
|
|
957
|
+
"sobjectname"
|
|
958
|
+
],
|
|
959
|
+
"char": "s",
|
|
960
|
+
"name": "sobject",
|
|
961
|
+
"required": true,
|
|
962
|
+
"summary": "API name of the source Salesforce object used to generate the custom metadata type.",
|
|
963
|
+
"hasDynamicHelp": false,
|
|
964
|
+
"multiple": false,
|
|
965
|
+
"type": "option"
|
|
966
|
+
},
|
|
967
|
+
"ignore-unsupported": {
|
|
968
|
+
"aliases": [
|
|
969
|
+
"ignoreunsupported"
|
|
907
970
|
],
|
|
908
971
|
"char": "i",
|
|
909
|
-
"
|
|
910
|
-
"
|
|
972
|
+
"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.",
|
|
973
|
+
"name": "ignore-unsupported",
|
|
974
|
+
"summary": "Ignore unsupported field types.",
|
|
975
|
+
"allowNo": false,
|
|
976
|
+
"type": "boolean"
|
|
977
|
+
},
|
|
978
|
+
"type-output-directory": {
|
|
979
|
+
"aliases": [
|
|
980
|
+
"typeoutputdir"
|
|
981
|
+
],
|
|
982
|
+
"char": "d",
|
|
983
|
+
"name": "type-output-directory",
|
|
984
|
+
"summary": "Directory to store newly-created custom metadata type files.",
|
|
911
985
|
"default": "force-app/main/default/objects",
|
|
912
986
|
"hasDynamicHelp": false,
|
|
913
987
|
"multiple": false,
|
|
914
988
|
"type": "option"
|
|
915
989
|
},
|
|
916
|
-
"output-
|
|
990
|
+
"records-output-dir": {
|
|
917
991
|
"aliases": [
|
|
918
|
-
"
|
|
919
|
-
"outputdirectory"
|
|
992
|
+
"recordsoutputdir"
|
|
920
993
|
],
|
|
921
|
-
"char": "
|
|
922
|
-
"name": "output-
|
|
994
|
+
"char": "r",
|
|
995
|
+
"name": "records-output-dir",
|
|
923
996
|
"summary": "Directory to store newly-created custom metadata record files.",
|
|
924
997
|
"default": "force-app/main/default/customMetadata",
|
|
925
998
|
"hasDynamicHelp": false,
|
|
@@ -927,14 +1000,14 @@
|
|
|
927
1000
|
"type": "option"
|
|
928
1001
|
}
|
|
929
1002
|
},
|
|
930
|
-
"hasDynamicHelp":
|
|
1003
|
+
"hasDynamicHelp": true,
|
|
931
1004
|
"hiddenAliases": [],
|
|
932
|
-
"id": "cmdt:generate:
|
|
1005
|
+
"id": "cmdt:generate:fromorg",
|
|
933
1006
|
"pluginAlias": "@salesforce/plugin-custom-metadata",
|
|
934
1007
|
"pluginName": "@salesforce/plugin-custom-metadata",
|
|
935
1008
|
"pluginType": "jit",
|
|
936
|
-
"strict":
|
|
937
|
-
"summary": "Generate a
|
|
1009
|
+
"strict": true,
|
|
1010
|
+
"summary": "Generate a custom metadata type and all its records from a Salesforce object.",
|
|
938
1011
|
"enableJsonFlag": true,
|
|
939
1012
|
"requiresProject": true,
|
|
940
1013
|
"isESM": true,
|
|
@@ -943,60 +1016,36 @@
|
|
|
943
1016
|
"commands",
|
|
944
1017
|
"cmdt",
|
|
945
1018
|
"generate",
|
|
946
|
-
"
|
|
1019
|
+
"fromorg.js"
|
|
947
1020
|
],
|
|
948
1021
|
"aliasPermutations": [
|
|
949
|
-
"force:cmdt:
|
|
950
|
-
"cmdt:force:
|
|
951
|
-
"cmdt:
|
|
952
|
-
"
|
|
953
|
-
"force:
|
|
954
|
-
"
|
|
955
|
-
"record:cmdt:force:create",
|
|
956
|
-
"record:cmdt:create:force",
|
|
957
|
-
"force:record:create:cmdt",
|
|
958
|
-
"record:force:create:cmdt",
|
|
959
|
-
"record:create:force:cmdt",
|
|
960
|
-
"record:create:cmdt:force",
|
|
961
|
-
"force:cmdt:create:record",
|
|
962
|
-
"cmdt:force:create:record",
|
|
963
|
-
"cmdt:create:force:record",
|
|
964
|
-
"cmdt:create:record:force",
|
|
965
|
-
"force:create:cmdt:record",
|
|
966
|
-
"create:force:cmdt:record",
|
|
967
|
-
"create:cmdt:force:record",
|
|
968
|
-
"create:cmdt:record:force",
|
|
969
|
-
"force:create:record:cmdt",
|
|
970
|
-
"create:force:record:cmdt",
|
|
971
|
-
"create:record:force:cmdt",
|
|
972
|
-
"create:record:cmdt:force",
|
|
973
|
-
"cmdt:record:create",
|
|
974
|
-
"record:cmdt:create",
|
|
975
|
-
"record:create:cmdt",
|
|
976
|
-
"cmdt:create:record",
|
|
977
|
-
"create:cmdt:record",
|
|
978
|
-
"create:record:cmdt"
|
|
1022
|
+
"force:cmdt:generate",
|
|
1023
|
+
"cmdt:force:generate",
|
|
1024
|
+
"cmdt:generate:force",
|
|
1025
|
+
"force:generate:cmdt",
|
|
1026
|
+
"generate:force:cmdt",
|
|
1027
|
+
"generate:cmdt:force"
|
|
979
1028
|
],
|
|
980
1029
|
"permutations": [
|
|
981
|
-
"cmdt:generate:
|
|
982
|
-
"generate:cmdt:
|
|
983
|
-
"generate:
|
|
984
|
-
"cmdt:
|
|
985
|
-
"
|
|
986
|
-
"
|
|
1030
|
+
"cmdt:generate:fromorg",
|
|
1031
|
+
"generate:cmdt:fromorg",
|
|
1032
|
+
"generate:fromorg:cmdt",
|
|
1033
|
+
"cmdt:fromorg:generate",
|
|
1034
|
+
"fromorg:cmdt:generate",
|
|
1035
|
+
"fromorg:generate:cmdt"
|
|
987
1036
|
]
|
|
988
1037
|
},
|
|
989
|
-
"cmdt:generate:
|
|
1038
|
+
"cmdt:generate:object": {
|
|
990
1039
|
"aliases": [
|
|
991
|
-
"force:cmdt:
|
|
992
|
-
"cmdt:
|
|
1040
|
+
"force:cmdt:create",
|
|
1041
|
+
"cmdt:create"
|
|
993
1042
|
],
|
|
994
1043
|
"args": {},
|
|
995
1044
|
"deprecateAliases": true,
|
|
996
|
-
"description": "
|
|
1045
|
+
"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\".",
|
|
997
1046
|
"examples": [
|
|
998
|
-
"Generate
|
|
999
|
-
"Generate
|
|
1047
|
+
"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",
|
|
1048
|
+
"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"
|
|
1000
1049
|
],
|
|
1001
1050
|
"flags": {
|
|
1002
1051
|
"json": {
|
|
@@ -1024,42 +1073,51 @@
|
|
|
1024
1073
|
"multiple": false,
|
|
1025
1074
|
"type": "option"
|
|
1026
1075
|
},
|
|
1027
|
-
"
|
|
1076
|
+
"type-name": {
|
|
1028
1077
|
"aliases": [
|
|
1029
|
-
"
|
|
1078
|
+
"typename"
|
|
1030
1079
|
],
|
|
1031
|
-
"char": "
|
|
1032
|
-
"
|
|
1080
|
+
"char": "n",
|
|
1081
|
+
"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.",
|
|
1082
|
+
"name": "type-name",
|
|
1033
1083
|
"required": true,
|
|
1034
|
-
"summary": "
|
|
1084
|
+
"summary": "Unique object name for the custom metadata type.",
|
|
1035
1085
|
"hasDynamicHelp": false,
|
|
1036
1086
|
"multiple": false,
|
|
1037
1087
|
"type": "option"
|
|
1038
1088
|
},
|
|
1039
|
-
"
|
|
1040
|
-
"
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
"char": "t",
|
|
1044
|
-
"description": "The '__mdt' suffix is appended to the end of the name if it's omitted.",
|
|
1045
|
-
"name": "type-name",
|
|
1046
|
-
"required": true,
|
|
1047
|
-
"summary": "API name of the custom metadata type to create a record for.",
|
|
1089
|
+
"label": {
|
|
1090
|
+
"char": "l",
|
|
1091
|
+
"name": "label",
|
|
1092
|
+
"summary": "Label for the custom metadata type.",
|
|
1048
1093
|
"hasDynamicHelp": false,
|
|
1049
1094
|
"multiple": false,
|
|
1050
1095
|
"type": "option"
|
|
1051
1096
|
},
|
|
1052
|
-
"
|
|
1097
|
+
"plural-label": {
|
|
1053
1098
|
"aliases": [
|
|
1054
|
-
"
|
|
1055
|
-
"inputdirectory"
|
|
1099
|
+
"plurallabel"
|
|
1056
1100
|
],
|
|
1057
|
-
"char": "
|
|
1058
|
-
"name": "
|
|
1059
|
-
"summary": "
|
|
1060
|
-
"
|
|
1101
|
+
"char": "p",
|
|
1102
|
+
"name": "plural-label",
|
|
1103
|
+
"summary": "Plural version of the label value; if blank, uses label.",
|
|
1104
|
+
"hasDynamicHelp": false,
|
|
1105
|
+
"multiple": false,
|
|
1106
|
+
"type": "option"
|
|
1107
|
+
},
|
|
1108
|
+
"visibility": {
|
|
1109
|
+
"char": "v",
|
|
1110
|
+
"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.",
|
|
1111
|
+
"name": "visibility",
|
|
1112
|
+
"summary": "Who can see the custom metadata type.",
|
|
1113
|
+
"default": "Public",
|
|
1061
1114
|
"hasDynamicHelp": false,
|
|
1062
1115
|
"multiple": false,
|
|
1116
|
+
"options": [
|
|
1117
|
+
"PackageProtected",
|
|
1118
|
+
"Protected",
|
|
1119
|
+
"Public"
|
|
1120
|
+
],
|
|
1063
1121
|
"type": "option"
|
|
1064
1122
|
},
|
|
1065
1123
|
"output-directory": {
|
|
@@ -1068,21 +1126,10 @@
|
|
|
1068
1126
|
"outputdirectory"
|
|
1069
1127
|
],
|
|
1070
1128
|
"char": "d",
|
|
1129
|
+
"description": "The location can be an absolute path or relative to the current working directory. The default is the current directory.",
|
|
1071
1130
|
"name": "output-directory",
|
|
1072
|
-
"summary": "Directory to store newly-created custom metadata
|
|
1073
|
-
"default": "
|
|
1074
|
-
"hasDynamicHelp": false,
|
|
1075
|
-
"multiple": false,
|
|
1076
|
-
"type": "option"
|
|
1077
|
-
},
|
|
1078
|
-
"name-column": {
|
|
1079
|
-
"aliases": [
|
|
1080
|
-
"namecolumn"
|
|
1081
|
-
],
|
|
1082
|
-
"char": "n",
|
|
1083
|
-
"name": "name-column",
|
|
1084
|
-
"summary": "Column used to determine the name of the record.",
|
|
1085
|
-
"default": "Name",
|
|
1131
|
+
"summary": "Directory to store the newly-created custom metadata type files",
|
|
1132
|
+
"default": "",
|
|
1086
1133
|
"hasDynamicHelp": false,
|
|
1087
1134
|
"multiple": false,
|
|
1088
1135
|
"type": "option"
|
|
@@ -1090,12 +1137,12 @@
|
|
|
1090
1137
|
},
|
|
1091
1138
|
"hasDynamicHelp": false,
|
|
1092
1139
|
"hiddenAliases": [],
|
|
1093
|
-
"id": "cmdt:generate:
|
|
1140
|
+
"id": "cmdt:generate:object",
|
|
1094
1141
|
"pluginAlias": "@salesforce/plugin-custom-metadata",
|
|
1095
1142
|
"pluginName": "@salesforce/plugin-custom-metadata",
|
|
1096
1143
|
"pluginType": "jit",
|
|
1097
1144
|
"strict": true,
|
|
1098
|
-
"summary": "Generate new custom metadata type
|
|
1145
|
+
"summary": "Generate a new custom metadata type in the current project.",
|
|
1099
1146
|
"enableJsonFlag": true,
|
|
1100
1147
|
"requiresProject": true,
|
|
1101
1148
|
"isESM": true,
|
|
@@ -1104,60 +1151,38 @@
|
|
|
1104
1151
|
"commands",
|
|
1105
1152
|
"cmdt",
|
|
1106
1153
|
"generate",
|
|
1107
|
-
"
|
|
1154
|
+
"object.js"
|
|
1108
1155
|
],
|
|
1109
1156
|
"aliasPermutations": [
|
|
1110
|
-
"force:cmdt:
|
|
1111
|
-
"cmdt:force:
|
|
1112
|
-
"cmdt:
|
|
1113
|
-
"
|
|
1114
|
-
"force:
|
|
1115
|
-
"
|
|
1116
|
-
"
|
|
1117
|
-
"
|
|
1118
|
-
"force:record:insert:cmdt",
|
|
1119
|
-
"record:force:insert:cmdt",
|
|
1120
|
-
"record:insert:force:cmdt",
|
|
1121
|
-
"record:insert:cmdt:force",
|
|
1122
|
-
"force:cmdt:insert:record",
|
|
1123
|
-
"cmdt:force:insert:record",
|
|
1124
|
-
"cmdt:insert:force:record",
|
|
1125
|
-
"cmdt:insert:record:force",
|
|
1126
|
-
"force:insert:cmdt:record",
|
|
1127
|
-
"insert:force:cmdt:record",
|
|
1128
|
-
"insert:cmdt:force:record",
|
|
1129
|
-
"insert:cmdt:record:force",
|
|
1130
|
-
"force:insert:record:cmdt",
|
|
1131
|
-
"insert:force:record:cmdt",
|
|
1132
|
-
"insert:record:force:cmdt",
|
|
1133
|
-
"insert:record:cmdt:force",
|
|
1134
|
-
"cmdt:record:insert",
|
|
1135
|
-
"record:cmdt:insert",
|
|
1136
|
-
"record:insert:cmdt",
|
|
1137
|
-
"cmdt:insert:record",
|
|
1138
|
-
"insert:cmdt:record",
|
|
1139
|
-
"insert:record:cmdt"
|
|
1157
|
+
"force:cmdt:create",
|
|
1158
|
+
"cmdt:force:create",
|
|
1159
|
+
"cmdt:create:force",
|
|
1160
|
+
"force:create:cmdt",
|
|
1161
|
+
"create:force:cmdt",
|
|
1162
|
+
"create:cmdt:force",
|
|
1163
|
+
"cmdt:create",
|
|
1164
|
+
"create:cmdt"
|
|
1140
1165
|
],
|
|
1141
1166
|
"permutations": [
|
|
1142
|
-
"cmdt:generate:
|
|
1143
|
-
"generate:cmdt:
|
|
1144
|
-
"generate:
|
|
1145
|
-
"cmdt:
|
|
1146
|
-
"
|
|
1147
|
-
"
|
|
1167
|
+
"cmdt:generate:object",
|
|
1168
|
+
"generate:cmdt:object",
|
|
1169
|
+
"generate:object:cmdt",
|
|
1170
|
+
"cmdt:object:generate",
|
|
1171
|
+
"object:cmdt:generate",
|
|
1172
|
+
"object:generate:cmdt"
|
|
1148
1173
|
]
|
|
1149
1174
|
},
|
|
1150
|
-
"
|
|
1175
|
+
"cmdt:generate:record": {
|
|
1151
1176
|
"aliases": [
|
|
1152
|
-
"force:
|
|
1177
|
+
"force:cmdt:record:create",
|
|
1178
|
+
"cmdt:record:create"
|
|
1153
1179
|
],
|
|
1154
1180
|
"args": {},
|
|
1155
1181
|
"deprecateAliases": true,
|
|
1156
|
-
"description": "
|
|
1182
|
+
"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.",
|
|
1157
1183
|
"examples": [
|
|
1158
|
-
"Create
|
|
1159
|
-
"Create a
|
|
1160
|
-
"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"
|
|
1184
|
+
"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",
|
|
1185
|
+
"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"
|
|
1161
1186
|
],
|
|
1162
1187
|
"flags": {
|
|
1163
1188
|
"json": {
|
|
@@ -1175,129 +1200,161 @@
|
|
|
1175
1200
|
"multiple": false,
|
|
1176
1201
|
"type": "option"
|
|
1177
1202
|
},
|
|
1178
|
-
"
|
|
1179
|
-
"
|
|
1180
|
-
|
|
1181
|
-
|
|
1182
|
-
"
|
|
1203
|
+
"loglevel": {
|
|
1204
|
+
"deprecated": {
|
|
1205
|
+
"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."
|
|
1206
|
+
},
|
|
1207
|
+
"hidden": true,
|
|
1208
|
+
"name": "loglevel",
|
|
1183
1209
|
"hasDynamicHelp": false,
|
|
1184
1210
|
"multiple": false,
|
|
1185
1211
|
"type": "option"
|
|
1186
1212
|
},
|
|
1187
|
-
"
|
|
1213
|
+
"type-name": {
|
|
1188
1214
|
"aliases": [
|
|
1189
|
-
"
|
|
1215
|
+
"typename"
|
|
1190
1216
|
],
|
|
1191
1217
|
"char": "t",
|
|
1192
|
-
"
|
|
1193
|
-
"description": "An example of a template is Customer Service. Run the \"community template list\" command to see which templates are available in your org.",
|
|
1194
|
-
"name": "template-name",
|
|
1218
|
+
"name": "type-name",
|
|
1195
1219
|
"required": true,
|
|
1196
|
-
"summary": "
|
|
1220
|
+
"summary": "API name of the custom metadata type to create a record for; must end in \"__mdt\".",
|
|
1197
1221
|
"hasDynamicHelp": false,
|
|
1198
1222
|
"multiple": false,
|
|
1199
1223
|
"type": "option"
|
|
1200
1224
|
},
|
|
1201
|
-
"
|
|
1225
|
+
"record-name": {
|
|
1202
1226
|
"aliases": [
|
|
1203
|
-
"
|
|
1227
|
+
"recordname"
|
|
1204
1228
|
],
|
|
1205
|
-
"char": "
|
|
1206
|
-
"
|
|
1207
|
-
"
|
|
1208
|
-
"
|
|
1209
|
-
"summary": "URL to append to the domain created when Digital Experiences was enabled for this org.",
|
|
1210
|
-
"default": "",
|
|
1229
|
+
"char": "n",
|
|
1230
|
+
"name": "record-name",
|
|
1231
|
+
"required": true,
|
|
1232
|
+
"summary": "Name of the new record.",
|
|
1211
1233
|
"hasDynamicHelp": false,
|
|
1212
1234
|
"multiple": false,
|
|
1213
1235
|
"type": "option"
|
|
1214
1236
|
},
|
|
1215
|
-
"
|
|
1216
|
-
"char": "
|
|
1217
|
-
"
|
|
1218
|
-
"
|
|
1219
|
-
"summary": "Description of the site.",
|
|
1237
|
+
"label": {
|
|
1238
|
+
"char": "l",
|
|
1239
|
+
"name": "label",
|
|
1240
|
+
"summary": "Label for the new record.",
|
|
1220
1241
|
"hasDynamicHelp": false,
|
|
1221
1242
|
"multiple": false,
|
|
1222
1243
|
"type": "option"
|
|
1223
1244
|
},
|
|
1224
|
-
"
|
|
1225
|
-
"
|
|
1226
|
-
|
|
1227
|
-
|
|
1228
|
-
|
|
1229
|
-
"
|
|
1230
|
-
"
|
|
1231
|
-
"name": "target-org",
|
|
1232
|
-
"noCacheDefault": true,
|
|
1233
|
-
"required": true,
|
|
1234
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1235
|
-
"hasDynamicHelp": true,
|
|
1245
|
+
"protected": {
|
|
1246
|
+
"char": "p",
|
|
1247
|
+
"description": "Protected records can only be accessed by code in the same managed package namespace.",
|
|
1248
|
+
"name": "protected",
|
|
1249
|
+
"summary": "Protect the record when it's in a managed package.",
|
|
1250
|
+
"default": "false",
|
|
1251
|
+
"hasDynamicHelp": false,
|
|
1236
1252
|
"multiple": false,
|
|
1253
|
+
"options": [
|
|
1254
|
+
"true",
|
|
1255
|
+
"false"
|
|
1256
|
+
],
|
|
1237
1257
|
"type": "option"
|
|
1238
1258
|
},
|
|
1239
|
-
"
|
|
1240
|
-
"
|
|
1241
|
-
"
|
|
1242
|
-
|
|
1243
|
-
|
|
1244
|
-
"
|
|
1259
|
+
"input-directory": {
|
|
1260
|
+
"aliases": [
|
|
1261
|
+
"inputdir",
|
|
1262
|
+
"inputdirectory"
|
|
1263
|
+
],
|
|
1264
|
+
"char": "i",
|
|
1265
|
+
"name": "input-directory",
|
|
1266
|
+
"summary": "Directory from which to get the custom metadata type definition from.",
|
|
1267
|
+
"default": "force-app/main/default/objects",
|
|
1245
1268
|
"hasDynamicHelp": false,
|
|
1246
1269
|
"multiple": false,
|
|
1247
1270
|
"type": "option"
|
|
1248
1271
|
},
|
|
1249
|
-
"
|
|
1272
|
+
"output-directory": {
|
|
1250
1273
|
"aliases": [
|
|
1251
|
-
"
|
|
1274
|
+
"outputdir",
|
|
1275
|
+
"outputdirectory"
|
|
1252
1276
|
],
|
|
1253
|
-
"
|
|
1254
|
-
"
|
|
1255
|
-
"
|
|
1277
|
+
"char": "d",
|
|
1278
|
+
"name": "output-directory",
|
|
1279
|
+
"summary": "Directory to store newly-created custom metadata record files.",
|
|
1280
|
+
"default": "force-app/main/default/customMetadata",
|
|
1256
1281
|
"hasDynamicHelp": false,
|
|
1257
1282
|
"multiple": false,
|
|
1258
1283
|
"type": "option"
|
|
1259
1284
|
}
|
|
1260
1285
|
},
|
|
1261
|
-
"hasDynamicHelp":
|
|
1286
|
+
"hasDynamicHelp": false,
|
|
1262
1287
|
"hiddenAliases": [],
|
|
1263
|
-
"id": "
|
|
1264
|
-
"pluginAlias": "@salesforce/plugin-
|
|
1265
|
-
"pluginName": "@salesforce/plugin-
|
|
1288
|
+
"id": "cmdt:generate:record",
|
|
1289
|
+
"pluginAlias": "@salesforce/plugin-custom-metadata",
|
|
1290
|
+
"pluginName": "@salesforce/plugin-custom-metadata",
|
|
1266
1291
|
"pluginType": "jit",
|
|
1267
1292
|
"strict": false,
|
|
1268
|
-
"summary": "
|
|
1293
|
+
"summary": "Generate a new record for a given custom metadata type in the current project.",
|
|
1269
1294
|
"enableJsonFlag": true,
|
|
1295
|
+
"requiresProject": true,
|
|
1270
1296
|
"isESM": true,
|
|
1271
1297
|
"relativePath": [
|
|
1272
1298
|
"lib",
|
|
1273
1299
|
"commands",
|
|
1274
|
-
"
|
|
1275
|
-
"
|
|
1300
|
+
"cmdt",
|
|
1301
|
+
"generate",
|
|
1302
|
+
"record.js"
|
|
1276
1303
|
],
|
|
1277
1304
|
"aliasPermutations": [
|
|
1278
|
-
"force:
|
|
1279
|
-
"
|
|
1280
|
-
"
|
|
1281
|
-
"
|
|
1282
|
-
"
|
|
1283
|
-
"
|
|
1284
|
-
|
|
1285
|
-
|
|
1286
|
-
"
|
|
1287
|
-
"create:
|
|
1288
|
-
|
|
1289
|
-
|
|
1290
|
-
|
|
1291
|
-
|
|
1292
|
-
"force:
|
|
1293
|
-
|
|
1294
|
-
|
|
1295
|
-
|
|
1296
|
-
|
|
1297
|
-
|
|
1298
|
-
"
|
|
1299
|
-
|
|
1300
|
-
|
|
1305
|
+
"force:cmdt:record:create",
|
|
1306
|
+
"cmdt:force:record:create",
|
|
1307
|
+
"cmdt:record:force:create",
|
|
1308
|
+
"cmdt:record:create:force",
|
|
1309
|
+
"force:record:cmdt:create",
|
|
1310
|
+
"record:force:cmdt:create",
|
|
1311
|
+
"record:cmdt:force:create",
|
|
1312
|
+
"record:cmdt:create:force",
|
|
1313
|
+
"force:record:create:cmdt",
|
|
1314
|
+
"record:force:create:cmdt",
|
|
1315
|
+
"record:create:force:cmdt",
|
|
1316
|
+
"record:create:cmdt:force",
|
|
1317
|
+
"force:cmdt:create:record",
|
|
1318
|
+
"cmdt:force:create:record",
|
|
1319
|
+
"cmdt:create:force:record",
|
|
1320
|
+
"cmdt:create:record:force",
|
|
1321
|
+
"force:create:cmdt:record",
|
|
1322
|
+
"create:force:cmdt:record",
|
|
1323
|
+
"create:cmdt:force:record",
|
|
1324
|
+
"create:cmdt:record:force",
|
|
1325
|
+
"force:create:record:cmdt",
|
|
1326
|
+
"create:force:record:cmdt",
|
|
1327
|
+
"create:record:force:cmdt",
|
|
1328
|
+
"create:record:cmdt:force",
|
|
1329
|
+
"cmdt:record:create",
|
|
1330
|
+
"record:cmdt:create",
|
|
1331
|
+
"record:create:cmdt",
|
|
1332
|
+
"cmdt:create:record",
|
|
1333
|
+
"create:cmdt:record",
|
|
1334
|
+
"create:record:cmdt"
|
|
1335
|
+
],
|
|
1336
|
+
"permutations": [
|
|
1337
|
+
"cmdt:generate:record",
|
|
1338
|
+
"generate:cmdt:record",
|
|
1339
|
+
"generate:record:cmdt",
|
|
1340
|
+
"cmdt:record:generate",
|
|
1341
|
+
"record:cmdt:generate",
|
|
1342
|
+
"record:generate:cmdt"
|
|
1343
|
+
]
|
|
1344
|
+
},
|
|
1345
|
+
"cmdt:generate:records": {
|
|
1346
|
+
"aliases": [
|
|
1347
|
+
"force:cmdt:record:insert",
|
|
1348
|
+
"cmdt:record:insert"
|
|
1349
|
+
],
|
|
1350
|
+
"args": {},
|
|
1351
|
+
"deprecateAliases": true,
|
|
1352
|
+
"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.",
|
|
1353
|
+
"examples": [
|
|
1354
|
+
"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",
|
|
1355
|
+
"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\""
|
|
1356
|
+
],
|
|
1357
|
+
"flags": {
|
|
1301
1358
|
"json": {
|
|
1302
1359
|
"description": "Format output as json.",
|
|
1303
1360
|
"helpGroup": "GLOBAL",
|
|
@@ -1313,90 +1370,145 @@
|
|
|
1313
1370
|
"multiple": false,
|
|
1314
1371
|
"type": "option"
|
|
1315
1372
|
},
|
|
1316
|
-
"
|
|
1317
|
-
"
|
|
1318
|
-
|
|
1373
|
+
"loglevel": {
|
|
1374
|
+
"deprecated": {
|
|
1375
|
+
"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."
|
|
1376
|
+
},
|
|
1377
|
+
"hidden": true,
|
|
1378
|
+
"name": "loglevel",
|
|
1379
|
+
"hasDynamicHelp": false,
|
|
1380
|
+
"multiple": false,
|
|
1381
|
+
"type": "option"
|
|
1382
|
+
},
|
|
1383
|
+
"csv": {
|
|
1384
|
+
"aliases": [
|
|
1385
|
+
"filepath"
|
|
1386
|
+
],
|
|
1387
|
+
"char": "f",
|
|
1388
|
+
"name": "csv",
|
|
1319
1389
|
"required": true,
|
|
1320
|
-
"summary": "
|
|
1390
|
+
"summary": "Pathname of the CSV file.",
|
|
1321
1391
|
"hasDynamicHelp": false,
|
|
1322
1392
|
"multiple": false,
|
|
1323
1393
|
"type": "option"
|
|
1324
1394
|
},
|
|
1325
|
-
"
|
|
1395
|
+
"type-name": {
|
|
1326
1396
|
"aliases": [
|
|
1327
|
-
"
|
|
1328
|
-
"u"
|
|
1397
|
+
"typename"
|
|
1329
1398
|
],
|
|
1330
|
-
"char": "
|
|
1331
|
-
"
|
|
1332
|
-
"name": "
|
|
1333
|
-
"noCacheDefault": true,
|
|
1399
|
+
"char": "t",
|
|
1400
|
+
"description": "The '__mdt' suffix is appended to the end of the name if it's omitted.",
|
|
1401
|
+
"name": "type-name",
|
|
1334
1402
|
"required": true,
|
|
1335
|
-
"summary": "
|
|
1336
|
-
"hasDynamicHelp":
|
|
1403
|
+
"summary": "API name of the custom metadata type to create a record for.",
|
|
1404
|
+
"hasDynamicHelp": false,
|
|
1337
1405
|
"multiple": false,
|
|
1338
1406
|
"type": "option"
|
|
1339
1407
|
},
|
|
1340
|
-
"
|
|
1408
|
+
"input-directory": {
|
|
1341
1409
|
"aliases": [
|
|
1342
|
-
"
|
|
1410
|
+
"inputdir",
|
|
1411
|
+
"inputdirectory"
|
|
1343
1412
|
],
|
|
1344
|
-
"
|
|
1345
|
-
"
|
|
1346
|
-
"
|
|
1413
|
+
"char": "i",
|
|
1414
|
+
"name": "input-directory",
|
|
1415
|
+
"summary": "Directory from which to get the custom metadata type definition from.",
|
|
1416
|
+
"default": "force-app/main/default/objects",
|
|
1347
1417
|
"hasDynamicHelp": false,
|
|
1348
1418
|
"multiple": false,
|
|
1349
1419
|
"type": "option"
|
|
1350
1420
|
},
|
|
1351
|
-
"
|
|
1352
|
-
"
|
|
1353
|
-
"
|
|
1354
|
-
|
|
1355
|
-
|
|
1356
|
-
"
|
|
1421
|
+
"output-directory": {
|
|
1422
|
+
"aliases": [
|
|
1423
|
+
"outputdir",
|
|
1424
|
+
"outputdirectory"
|
|
1425
|
+
],
|
|
1426
|
+
"char": "d",
|
|
1427
|
+
"name": "output-directory",
|
|
1428
|
+
"summary": "Directory to store newly-created custom metadata record files.",
|
|
1429
|
+
"default": "force-app/main/default/customMetadata",
|
|
1430
|
+
"hasDynamicHelp": false,
|
|
1431
|
+
"multiple": false,
|
|
1432
|
+
"type": "option"
|
|
1433
|
+
},
|
|
1434
|
+
"name-column": {
|
|
1435
|
+
"aliases": [
|
|
1436
|
+
"namecolumn"
|
|
1437
|
+
],
|
|
1438
|
+
"char": "n",
|
|
1439
|
+
"name": "name-column",
|
|
1440
|
+
"summary": "Column used to determine the name of the record.",
|
|
1441
|
+
"default": "Name",
|
|
1357
1442
|
"hasDynamicHelp": false,
|
|
1358
1443
|
"multiple": false,
|
|
1359
1444
|
"type": "option"
|
|
1360
1445
|
}
|
|
1361
1446
|
},
|
|
1362
|
-
"hasDynamicHelp":
|
|
1447
|
+
"hasDynamicHelp": false,
|
|
1363
1448
|
"hiddenAliases": [],
|
|
1364
|
-
"id": "
|
|
1365
|
-
"pluginAlias": "@salesforce/plugin-
|
|
1366
|
-
"pluginName": "@salesforce/plugin-
|
|
1449
|
+
"id": "cmdt:generate:records",
|
|
1450
|
+
"pluginAlias": "@salesforce/plugin-custom-metadata",
|
|
1451
|
+
"pluginName": "@salesforce/plugin-custom-metadata",
|
|
1367
1452
|
"pluginType": "jit",
|
|
1368
1453
|
"strict": true,
|
|
1369
|
-
"summary": "
|
|
1454
|
+
"summary": "Generate new custom metadata type records from a CSV file.",
|
|
1370
1455
|
"enableJsonFlag": true,
|
|
1456
|
+
"requiresProject": true,
|
|
1371
1457
|
"isESM": true,
|
|
1372
1458
|
"relativePath": [
|
|
1373
1459
|
"lib",
|
|
1374
1460
|
"commands",
|
|
1375
|
-
"
|
|
1376
|
-
"
|
|
1461
|
+
"cmdt",
|
|
1462
|
+
"generate",
|
|
1463
|
+
"records.js"
|
|
1377
1464
|
],
|
|
1378
1465
|
"aliasPermutations": [
|
|
1379
|
-
"force:
|
|
1380
|
-
"
|
|
1381
|
-
"
|
|
1382
|
-
"
|
|
1383
|
-
"
|
|
1384
|
-
"
|
|
1466
|
+
"force:cmdt:record:insert",
|
|
1467
|
+
"cmdt:force:record:insert",
|
|
1468
|
+
"cmdt:record:force:insert",
|
|
1469
|
+
"cmdt:record:insert:force",
|
|
1470
|
+
"force:record:cmdt:insert",
|
|
1471
|
+
"record:force:cmdt:insert",
|
|
1472
|
+
"record:cmdt:force:insert",
|
|
1473
|
+
"record:cmdt:insert:force",
|
|
1474
|
+
"force:record:insert:cmdt",
|
|
1475
|
+
"record:force:insert:cmdt",
|
|
1476
|
+
"record:insert:force:cmdt",
|
|
1477
|
+
"record:insert:cmdt:force",
|
|
1478
|
+
"force:cmdt:insert:record",
|
|
1479
|
+
"cmdt:force:insert:record",
|
|
1480
|
+
"cmdt:insert:force:record",
|
|
1481
|
+
"cmdt:insert:record:force",
|
|
1482
|
+
"force:insert:cmdt:record",
|
|
1483
|
+
"insert:force:cmdt:record",
|
|
1484
|
+
"insert:cmdt:force:record",
|
|
1485
|
+
"insert:cmdt:record:force",
|
|
1486
|
+
"force:insert:record:cmdt",
|
|
1487
|
+
"insert:force:record:cmdt",
|
|
1488
|
+
"insert:record:force:cmdt",
|
|
1489
|
+
"insert:record:cmdt:force",
|
|
1490
|
+
"cmdt:record:insert",
|
|
1491
|
+
"record:cmdt:insert",
|
|
1492
|
+
"record:insert:cmdt",
|
|
1493
|
+
"cmdt:insert:record",
|
|
1494
|
+
"insert:cmdt:record",
|
|
1495
|
+
"insert:record:cmdt"
|
|
1385
1496
|
],
|
|
1386
1497
|
"permutations": [
|
|
1387
|
-
"
|
|
1388
|
-
"
|
|
1498
|
+
"cmdt:generate:records",
|
|
1499
|
+
"generate:cmdt:records",
|
|
1500
|
+
"generate:records:cmdt",
|
|
1501
|
+
"cmdt:records:generate",
|
|
1502
|
+
"records:cmdt:generate",
|
|
1503
|
+
"records:generate:cmdt"
|
|
1389
1504
|
]
|
|
1390
1505
|
},
|
|
1391
|
-
"
|
|
1392
|
-
"aliases": [
|
|
1393
|
-
"force:community:template:list"
|
|
1394
|
-
],
|
|
1506
|
+
"dev:audit:messages": {
|
|
1507
|
+
"aliases": [],
|
|
1395
1508
|
"args": {},
|
|
1396
|
-
"deprecateAliases": true,
|
|
1397
|
-
"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.",
|
|
1398
1509
|
"examples": [
|
|
1399
|
-
"
|
|
1510
|
+
"Audit messages using default directories:\n<%= config.bin %> <%= command.id %>",
|
|
1511
|
+
"Audit messages in the \"messages\" directory in the current working directory; the plugin's source directory is in \"src\":\n<%= config.bin %> <%= command.id %> --messages-dir ./messages --source-dir ./src"
|
|
1400
1512
|
],
|
|
1401
1513
|
"flags": {
|
|
1402
1514
|
"json": {
|
|
@@ -1414,165 +1526,53 @@
|
|
|
1414
1526
|
"multiple": false,
|
|
1415
1527
|
"type": "option"
|
|
1416
1528
|
},
|
|
1417
|
-
"
|
|
1529
|
+
"project-dir": {
|
|
1418
1530
|
"aliases": [
|
|
1419
|
-
"
|
|
1420
|
-
"u"
|
|
1531
|
+
"projectdir"
|
|
1421
1532
|
],
|
|
1422
|
-
"char": "
|
|
1423
|
-
"
|
|
1424
|
-
"
|
|
1425
|
-
"
|
|
1426
|
-
"
|
|
1427
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1428
|
-
"hasDynamicHelp": true,
|
|
1533
|
+
"char": "p",
|
|
1534
|
+
"name": "project-dir",
|
|
1535
|
+
"summary": "Location of the project where messages are to be audited.",
|
|
1536
|
+
"default": ".",
|
|
1537
|
+
"hasDynamicHelp": false,
|
|
1429
1538
|
"multiple": false,
|
|
1430
1539
|
"type": "option"
|
|
1431
1540
|
},
|
|
1432
|
-
"
|
|
1541
|
+
"messages-dir": {
|
|
1433
1542
|
"aliases": [
|
|
1434
|
-
"
|
|
1543
|
+
"messagesdir"
|
|
1435
1544
|
],
|
|
1436
|
-
"
|
|
1437
|
-
"description": "
|
|
1438
|
-
"name": "
|
|
1545
|
+
"char": "m",
|
|
1546
|
+
"description": "The default is the \"messages\" directory in the current working directory.",
|
|
1547
|
+
"name": "messages-dir",
|
|
1548
|
+
"summary": "Directory that contains the plugin's message files.",
|
|
1549
|
+
"default": "messages",
|
|
1439
1550
|
"hasDynamicHelp": false,
|
|
1440
1551
|
"multiple": false,
|
|
1441
1552
|
"type": "option"
|
|
1442
1553
|
},
|
|
1443
|
-
"
|
|
1444
|
-
"
|
|
1445
|
-
"
|
|
1446
|
-
|
|
1447
|
-
"
|
|
1448
|
-
"
|
|
1554
|
+
"source-dir": {
|
|
1555
|
+
"aliases": [
|
|
1556
|
+
"sourcedir"
|
|
1557
|
+
],
|
|
1558
|
+
"char": "s",
|
|
1559
|
+
"description": "The default is the \"src\" directory in the current working directory.",
|
|
1560
|
+
"name": "source-dir",
|
|
1561
|
+
"summary": "Directory that contains the plugin's source code.",
|
|
1562
|
+
"default": "src",
|
|
1449
1563
|
"hasDynamicHelp": false,
|
|
1450
1564
|
"multiple": false,
|
|
1451
1565
|
"type": "option"
|
|
1452
1566
|
}
|
|
1453
1567
|
},
|
|
1454
|
-
"hasDynamicHelp":
|
|
1568
|
+
"hasDynamicHelp": false,
|
|
1455
1569
|
"hiddenAliases": [],
|
|
1456
|
-
"id": "
|
|
1457
|
-
"pluginAlias": "@salesforce/plugin-
|
|
1458
|
-
"pluginName": "@salesforce/plugin-
|
|
1570
|
+
"id": "dev:audit:messages",
|
|
1571
|
+
"pluginAlias": "@salesforce/plugin-dev",
|
|
1572
|
+
"pluginName": "@salesforce/plugin-dev",
|
|
1459
1573
|
"pluginType": "jit",
|
|
1460
1574
|
"strict": true,
|
|
1461
|
-
"summary": "
|
|
1462
|
-
"enableJsonFlag": true,
|
|
1463
|
-
"isESM": true,
|
|
1464
|
-
"relativePath": [
|
|
1465
|
-
"lib",
|
|
1466
|
-
"commands",
|
|
1467
|
-
"community",
|
|
1468
|
-
"list",
|
|
1469
|
-
"template.js"
|
|
1470
|
-
],
|
|
1471
|
-
"aliasPermutations": [
|
|
1472
|
-
"force:community:template:list",
|
|
1473
|
-
"community:force:template:list",
|
|
1474
|
-
"community:template:force:list",
|
|
1475
|
-
"community:template:list:force",
|
|
1476
|
-
"force:template:community:list",
|
|
1477
|
-
"template:force:community:list",
|
|
1478
|
-
"template:community:force:list",
|
|
1479
|
-
"template:community:list:force",
|
|
1480
|
-
"force:template:list:community",
|
|
1481
|
-
"template:force:list:community",
|
|
1482
|
-
"template:list:force:community",
|
|
1483
|
-
"template:list:community:force",
|
|
1484
|
-
"force:community:list:template",
|
|
1485
|
-
"community:force:list:template",
|
|
1486
|
-
"community:list:force:template",
|
|
1487
|
-
"community:list:template:force",
|
|
1488
|
-
"force:list:community:template",
|
|
1489
|
-
"list:force:community:template",
|
|
1490
|
-
"list:community:force:template",
|
|
1491
|
-
"list:community:template:force",
|
|
1492
|
-
"force:list:template:community",
|
|
1493
|
-
"list:force:template:community",
|
|
1494
|
-
"list:template:force:community",
|
|
1495
|
-
"list:template:community:force"
|
|
1496
|
-
],
|
|
1497
|
-
"permutations": [
|
|
1498
|
-
"community:list:template",
|
|
1499
|
-
"list:community:template",
|
|
1500
|
-
"list:template:community",
|
|
1501
|
-
"community:template:list",
|
|
1502
|
-
"template:community:list",
|
|
1503
|
-
"template:list:community"
|
|
1504
|
-
]
|
|
1505
|
-
},
|
|
1506
|
-
"dev:audit:messages": {
|
|
1507
|
-
"aliases": [],
|
|
1508
|
-
"args": {},
|
|
1509
|
-
"examples": [
|
|
1510
|
-
"Audit messages using default directories:\n<%= config.bin %> <%= command.id %>",
|
|
1511
|
-
"Audit messages in the \"messages\" directory in the current working directory; the plugin's source directory is in \"src\":\n<%= config.bin %> <%= command.id %> --messages-dir ./messages --source-dir ./src"
|
|
1512
|
-
],
|
|
1513
|
-
"flags": {
|
|
1514
|
-
"json": {
|
|
1515
|
-
"description": "Format output as json.",
|
|
1516
|
-
"helpGroup": "GLOBAL",
|
|
1517
|
-
"name": "json",
|
|
1518
|
-
"allowNo": false,
|
|
1519
|
-
"type": "boolean"
|
|
1520
|
-
},
|
|
1521
|
-
"flags-dir": {
|
|
1522
|
-
"helpGroup": "GLOBAL",
|
|
1523
|
-
"name": "flags-dir",
|
|
1524
|
-
"summary": "Import flag values from a directory.",
|
|
1525
|
-
"hasDynamicHelp": false,
|
|
1526
|
-
"multiple": false,
|
|
1527
|
-
"type": "option"
|
|
1528
|
-
},
|
|
1529
|
-
"project-dir": {
|
|
1530
|
-
"aliases": [
|
|
1531
|
-
"projectdir"
|
|
1532
|
-
],
|
|
1533
|
-
"char": "p",
|
|
1534
|
-
"name": "project-dir",
|
|
1535
|
-
"summary": "Location of the project where messages are to be audited.",
|
|
1536
|
-
"default": ".",
|
|
1537
|
-
"hasDynamicHelp": false,
|
|
1538
|
-
"multiple": false,
|
|
1539
|
-
"type": "option"
|
|
1540
|
-
},
|
|
1541
|
-
"messages-dir": {
|
|
1542
|
-
"aliases": [
|
|
1543
|
-
"messagesdir"
|
|
1544
|
-
],
|
|
1545
|
-
"char": "m",
|
|
1546
|
-
"description": "The default is the \"messages\" directory in the current working directory.",
|
|
1547
|
-
"name": "messages-dir",
|
|
1548
|
-
"summary": "Directory that contains the plugin's message files.",
|
|
1549
|
-
"default": "messages",
|
|
1550
|
-
"hasDynamicHelp": false,
|
|
1551
|
-
"multiple": false,
|
|
1552
|
-
"type": "option"
|
|
1553
|
-
},
|
|
1554
|
-
"source-dir": {
|
|
1555
|
-
"aliases": [
|
|
1556
|
-
"sourcedir"
|
|
1557
|
-
],
|
|
1558
|
-
"char": "s",
|
|
1559
|
-
"description": "The default is the \"src\" directory in the current working directory.",
|
|
1560
|
-
"name": "source-dir",
|
|
1561
|
-
"summary": "Directory that contains the plugin's source code.",
|
|
1562
|
-
"default": "src",
|
|
1563
|
-
"hasDynamicHelp": false,
|
|
1564
|
-
"multiple": false,
|
|
1565
|
-
"type": "option"
|
|
1566
|
-
}
|
|
1567
|
-
},
|
|
1568
|
-
"hasDynamicHelp": false,
|
|
1569
|
-
"hiddenAliases": [],
|
|
1570
|
-
"id": "dev:audit:messages",
|
|
1571
|
-
"pluginAlias": "@salesforce/plugin-dev",
|
|
1572
|
-
"pluginName": "@salesforce/plugin-dev",
|
|
1573
|
-
"pluginType": "jit",
|
|
1574
|
-
"strict": true,
|
|
1575
|
-
"summary": "Audit messages in a plugin's messages directory to locate unused messages and missing messages that have references in source code.",
|
|
1575
|
+
"summary": "Audit messages in a plugin's messages directory to locate unused messages and missing messages that have references in source code.",
|
|
1576
1576
|
"enableJsonFlag": true,
|
|
1577
1577
|
"isESM": true,
|
|
1578
1578
|
"relativePath": [
|
|
@@ -2154,14 +2154,324 @@
|
|
|
2154
2154
|
"exclusive": [
|
|
2155
2155
|
"verbose"
|
|
2156
2156
|
],
|
|
2157
|
-
"name": "concise",
|
|
2158
|
-
"summary": "Show concise output of the command result.",
|
|
2159
|
-
"allowNo": false,
|
|
2160
|
-
"type": "boolean"
|
|
2157
|
+
"name": "concise",
|
|
2158
|
+
"summary": "Show concise output of the command result.",
|
|
2159
|
+
"allowNo": false,
|
|
2160
|
+
"type": "boolean"
|
|
2161
|
+
},
|
|
2162
|
+
"verbose": {
|
|
2163
|
+
"name": "verbose",
|
|
2164
|
+
"summary": "Show verbose output of the command result.",
|
|
2165
|
+
"allowNo": false,
|
|
2166
|
+
"type": "boolean"
|
|
2167
|
+
},
|
|
2168
|
+
"wait": {
|
|
2169
|
+
"char": "w",
|
|
2170
|
+
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To check the status of the operation, run \"sf project deploy pipeline report\".",
|
|
2171
|
+
"exclusive": [
|
|
2172
|
+
"async"
|
|
2173
|
+
],
|
|
2174
|
+
"name": "wait",
|
|
2175
|
+
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
2176
|
+
"default": "33 minutes",
|
|
2177
|
+
"hasDynamicHelp": true,
|
|
2178
|
+
"helpValue": "<minutes>",
|
|
2179
|
+
"multiple": false,
|
|
2180
|
+
"type": "option"
|
|
2181
|
+
},
|
|
2182
|
+
"devops-center-username": {
|
|
2183
|
+
"char": "c",
|
|
2184
|
+
"name": "devops-center-username",
|
|
2185
|
+
"required": true,
|
|
2186
|
+
"summary": "Username or alias of the DevOps Center org.",
|
|
2187
|
+
"hasDynamicHelp": true,
|
|
2188
|
+
"multiple": false,
|
|
2189
|
+
"type": "option"
|
|
2190
|
+
},
|
|
2191
|
+
"job-id": {
|
|
2192
|
+
"char": "i",
|
|
2193
|
+
"description": "The job ID is valid for 10 days from when you started the validation.",
|
|
2194
|
+
"name": "job-id",
|
|
2195
|
+
"summary": "Job ID of the validated deployment to quick deploy.",
|
|
2196
|
+
"hasDynamicHelp": false,
|
|
2197
|
+
"multiple": false,
|
|
2198
|
+
"type": "option"
|
|
2199
|
+
},
|
|
2200
|
+
"use-most-recent": {
|
|
2201
|
+
"char": "r",
|
|
2202
|
+
"description": "For performance reasons, this flag uses only job IDs that were validated in the past 3 days or less. If your most recent deployment validation was more than 3 days ago, this flag won't find the job ID.",
|
|
2203
|
+
"name": "use-most-recent",
|
|
2204
|
+
"summary": "Use the job ID of the most recently validated deployment.",
|
|
2205
|
+
"allowNo": false,
|
|
2206
|
+
"type": "boolean"
|
|
2207
|
+
}
|
|
2208
|
+
},
|
|
2209
|
+
"hasDynamicHelp": true,
|
|
2210
|
+
"hiddenAliases": [],
|
|
2211
|
+
"id": "project:deploy:pipeline:quick",
|
|
2212
|
+
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
2213
|
+
"pluginName": "@salesforce/plugin-devops-center",
|
|
2214
|
+
"pluginType": "jit",
|
|
2215
|
+
"state": "beta",
|
|
2216
|
+
"strict": true,
|
|
2217
|
+
"summary": "Quickly deploy a validated deployment to an org.",
|
|
2218
|
+
"enableJsonFlag": true,
|
|
2219
|
+
"SF_ENV": "SF_ENV",
|
|
2220
|
+
"isESM": false,
|
|
2221
|
+
"relativePath": [
|
|
2222
|
+
"lib",
|
|
2223
|
+
"commands",
|
|
2224
|
+
"project",
|
|
2225
|
+
"deploy",
|
|
2226
|
+
"pipeline",
|
|
2227
|
+
"quick.js"
|
|
2228
|
+
]
|
|
2229
|
+
},
|
|
2230
|
+
"project:deploy:pipeline:report": {
|
|
2231
|
+
"aliases": [],
|
|
2232
|
+
"args": {},
|
|
2233
|
+
"description": "The first time you run any \"project deploy pipeline\" command, be sure to authorize the org in which DevOps Center is installed. The easiest way to authorize an org is with the \"org login web\" command.\n\nRun this command by either indicating a job ID or specifying the —use-most-recent flag to use the job ID of the most recent deploy operation.",
|
|
2234
|
+
"examples": [
|
|
2235
|
+
"Check the status using a job ID:\n<%= config.bin %> <%= command.id %> --devops-center-username MyStagingSandbox --job-id 0Af0x000017yLUFCA2",
|
|
2236
|
+
"Check the status of the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --devops-center-username MyStagingSandbox --use-most-recent"
|
|
2237
|
+
],
|
|
2238
|
+
"flags": {
|
|
2239
|
+
"json": {
|
|
2240
|
+
"description": "Format output as json.",
|
|
2241
|
+
"helpGroup": "GLOBAL",
|
|
2242
|
+
"name": "json",
|
|
2243
|
+
"allowNo": false,
|
|
2244
|
+
"type": "boolean"
|
|
2245
|
+
},
|
|
2246
|
+
"devops-center-username": {
|
|
2247
|
+
"char": "c",
|
|
2248
|
+
"name": "devops-center-username",
|
|
2249
|
+
"required": true,
|
|
2250
|
+
"summary": "Username or alias of the DevOps Center org.",
|
|
2251
|
+
"hasDynamicHelp": true,
|
|
2252
|
+
"multiple": false,
|
|
2253
|
+
"type": "option"
|
|
2254
|
+
},
|
|
2255
|
+
"job-id": {
|
|
2256
|
+
"char": "i",
|
|
2257
|
+
"description": "The job ID is valid for 10 days from when you started the deploy operation.",
|
|
2258
|
+
"name": "job-id",
|
|
2259
|
+
"summary": "Job ID of the pipeline deployment to check the status of.",
|
|
2260
|
+
"hasDynamicHelp": false,
|
|
2261
|
+
"multiple": false,
|
|
2262
|
+
"type": "option"
|
|
2263
|
+
},
|
|
2264
|
+
"use-most-recent": {
|
|
2265
|
+
"char": "r",
|
|
2266
|
+
"description": "For performance reasons, this flag uses job IDs for deploy operations that started in the past 3 days or fewer. If your most recent operation was longer than 3 days ago, this flag won't find the job ID.",
|
|
2267
|
+
"name": "use-most-recent",
|
|
2268
|
+
"summary": "Use the job ID of the most recent deploy operation.",
|
|
2269
|
+
"allowNo": false,
|
|
2270
|
+
"type": "boolean"
|
|
2271
|
+
}
|
|
2272
|
+
},
|
|
2273
|
+
"hasDynamicHelp": true,
|
|
2274
|
+
"hiddenAliases": [],
|
|
2275
|
+
"id": "project:deploy:pipeline:report",
|
|
2276
|
+
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
2277
|
+
"pluginName": "@salesforce/plugin-devops-center",
|
|
2278
|
+
"pluginType": "jit",
|
|
2279
|
+
"state": "beta",
|
|
2280
|
+
"strict": true,
|
|
2281
|
+
"summary": "Check the status of a pipeline deploy operation.",
|
|
2282
|
+
"enableJsonFlag": true,
|
|
2283
|
+
"SF_ENV": "SF_ENV",
|
|
2284
|
+
"isESM": false,
|
|
2285
|
+
"relativePath": [
|
|
2286
|
+
"lib",
|
|
2287
|
+
"commands",
|
|
2288
|
+
"project",
|
|
2289
|
+
"deploy",
|
|
2290
|
+
"pipeline",
|
|
2291
|
+
"report.js"
|
|
2292
|
+
]
|
|
2293
|
+
},
|
|
2294
|
+
"project:deploy:pipeline:resume": {
|
|
2295
|
+
"aliases": [],
|
|
2296
|
+
"args": {},
|
|
2297
|
+
"description": "The first time you run any \"project deploy pipeline\" command, be sure to authorize the org in which DevOps Center is installed. The easiest way to authorize an org is with the \"org login web\" command. \n\nUse this command to resume watching a pipeline deploy operation if the original command times out or you specified the --async flag.\n\nRun this command by either indicating a job ID or specifying the --use-most-recent flag to use the job ID of the most recent deploy operation.",
|
|
2298
|
+
"examples": [
|
|
2299
|
+
"Resume watching a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
|
|
2300
|
+
"Resume watching the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
|
|
2301
|
+
],
|
|
2302
|
+
"flags": {
|
|
2303
|
+
"json": {
|
|
2304
|
+
"description": "Format output as json.",
|
|
2305
|
+
"helpGroup": "GLOBAL",
|
|
2306
|
+
"name": "json",
|
|
2307
|
+
"allowNo": false,
|
|
2308
|
+
"type": "boolean"
|
|
2309
|
+
},
|
|
2310
|
+
"devops-center-username": {
|
|
2311
|
+
"char": "c",
|
|
2312
|
+
"name": "devops-center-username",
|
|
2313
|
+
"required": true,
|
|
2314
|
+
"summary": "Username or alias of the DevOps Center org.",
|
|
2315
|
+
"hasDynamicHelp": true,
|
|
2316
|
+
"multiple": false,
|
|
2317
|
+
"type": "option"
|
|
2318
|
+
},
|
|
2319
|
+
"job-id": {
|
|
2320
|
+
"char": "i",
|
|
2321
|
+
"description": "These commands return a job ID if they time out or you specified the --async flag:\n\n- sf project deploy pipeline start\n- sf project deploy pipeline validate\n- sf project deploy pipeline quick\n\nThe job ID is valid for 10 days from when you started the deploy operation.",
|
|
2322
|
+
"name": "job-id",
|
|
2323
|
+
"summary": "Job ID of the pipeline deploy operation you want to resume.",
|
|
2324
|
+
"hasDynamicHelp": false,
|
|
2325
|
+
"multiple": false,
|
|
2326
|
+
"type": "option"
|
|
2327
|
+
},
|
|
2328
|
+
"use-most-recent": {
|
|
2329
|
+
"char": "r",
|
|
2330
|
+
"description": "For performance reasons, this flag uses job IDs for operations that started in the past 3 days or fewer. If your most recent operation was longer than 3 days ago, this flag won't find a job ID.",
|
|
2331
|
+
"name": "use-most-recent",
|
|
2332
|
+
"summary": "Use the job ID of the most recent deploy operation.",
|
|
2333
|
+
"allowNo": false,
|
|
2334
|
+
"type": "boolean"
|
|
2335
|
+
},
|
|
2336
|
+
"concise": {
|
|
2337
|
+
"exclusive": [
|
|
2338
|
+
"verbose"
|
|
2339
|
+
],
|
|
2340
|
+
"name": "concise",
|
|
2341
|
+
"summary": "Show concise output of the command result.",
|
|
2342
|
+
"allowNo": false,
|
|
2343
|
+
"type": "boolean"
|
|
2344
|
+
},
|
|
2345
|
+
"verbose": {
|
|
2346
|
+
"name": "verbose",
|
|
2347
|
+
"summary": "Show verbose output of the command result.",
|
|
2348
|
+
"allowNo": false,
|
|
2349
|
+
"type": "boolean"
|
|
2350
|
+
},
|
|
2351
|
+
"wait": {
|
|
2352
|
+
"char": "w",
|
|
2353
|
+
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To check the status of the operation, run \"sf project deploy pipeline report\".",
|
|
2354
|
+
"exclusive": [
|
|
2355
|
+
"async"
|
|
2356
|
+
],
|
|
2357
|
+
"name": "wait",
|
|
2358
|
+
"summary": "Number of minutes to wait for command to complete and display results.",
|
|
2359
|
+
"default": "33 minutes",
|
|
2360
|
+
"hasDynamicHelp": true,
|
|
2361
|
+
"helpValue": "<minutes>",
|
|
2362
|
+
"multiple": false,
|
|
2363
|
+
"type": "option"
|
|
2364
|
+
}
|
|
2365
|
+
},
|
|
2366
|
+
"hasDynamicHelp": true,
|
|
2367
|
+
"hiddenAliases": [],
|
|
2368
|
+
"id": "project:deploy:pipeline:resume",
|
|
2369
|
+
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
2370
|
+
"pluginName": "@salesforce/plugin-devops-center",
|
|
2371
|
+
"pluginType": "jit",
|
|
2372
|
+
"state": "beta",
|
|
2373
|
+
"strict": true,
|
|
2374
|
+
"summary": "Resume watching a pipeline deploy operation.",
|
|
2375
|
+
"enableJsonFlag": true,
|
|
2376
|
+
"SF_ENV": "SF_ENV",
|
|
2377
|
+
"isESM": false,
|
|
2378
|
+
"relativePath": [
|
|
2379
|
+
"lib",
|
|
2380
|
+
"commands",
|
|
2381
|
+
"project",
|
|
2382
|
+
"deploy",
|
|
2383
|
+
"pipeline",
|
|
2384
|
+
"resume.js"
|
|
2385
|
+
]
|
|
2386
|
+
},
|
|
2387
|
+
"project:deploy:pipeline:start": {
|
|
2388
|
+
"aliases": [],
|
|
2389
|
+
"args": {},
|
|
2390
|
+
"description": "The first time you run any \"project deploy pipeline\" command, be sure to authorize the org in which DevOps Center is installed. The easiest way to authorize an org is with the \"org login web\" command.\n\nBefore you run this command, changes in the pipeline stage's branch must be merged in the source control repository.",
|
|
2391
|
+
"examples": [
|
|
2392
|
+
"Deploy changes in the Staging branch to the Staging environment (sandbox), if the previous stage is the bundling stage:\n<%= config.bin %> <%= command.id %> --devops-center-project-name “Recruiting App” --branch-name staging --devops-center-username MyStagingSandbox --bundle-version-name 1.0",
|
|
2393
|
+
"Deploy all changes in the main branch to the release environment:\n<%= config.bin %> <%= command.id %> --devops-center-project-name “Recruiting App” --branch-name main --devops-center-username MyReleaseOrg --deploy-all"
|
|
2394
|
+
],
|
|
2395
|
+
"flags": {
|
|
2396
|
+
"json": {
|
|
2397
|
+
"description": "Format output as json.",
|
|
2398
|
+
"helpGroup": "GLOBAL",
|
|
2399
|
+
"name": "json",
|
|
2400
|
+
"allowNo": false,
|
|
2401
|
+
"type": "boolean"
|
|
2402
|
+
},
|
|
2403
|
+
"branch-name": {
|
|
2404
|
+
"char": "b",
|
|
2405
|
+
"name": "branch-name",
|
|
2406
|
+
"required": true,
|
|
2407
|
+
"summary": "Name of the branch in the source control repository that corresponds to the pipeline stage that you want to deploy the changes to.",
|
|
2408
|
+
"hasDynamicHelp": false,
|
|
2409
|
+
"multiple": false,
|
|
2410
|
+
"type": "option"
|
|
2411
|
+
},
|
|
2412
|
+
"bundle-version-name": {
|
|
2413
|
+
"char": "v",
|
|
2414
|
+
"description": "You must indicate the bundle version if deploying to the environment that corresponds to the first stage after the bundling stage.",
|
|
2415
|
+
"name": "bundle-version-name",
|
|
2416
|
+
"summary": "Version name of the bundle.",
|
|
2417
|
+
"hasDynamicHelp": false,
|
|
2418
|
+
"multiple": false,
|
|
2419
|
+
"type": "option"
|
|
2420
|
+
},
|
|
2421
|
+
"deploy-all": {
|
|
2422
|
+
"char": "a",
|
|
2423
|
+
"description": "If you don’t specify this flag, only changes in the stage’s branch are deployed.",
|
|
2424
|
+
"name": "deploy-all",
|
|
2425
|
+
"summary": "Deploy all metadata in the branch to the stage's org.",
|
|
2426
|
+
"allowNo": false,
|
|
2427
|
+
"type": "boolean"
|
|
2428
|
+
},
|
|
2429
|
+
"devops-center-project-name": {
|
|
2430
|
+
"char": "p",
|
|
2431
|
+
"name": "devops-center-project-name",
|
|
2432
|
+
"required": true,
|
|
2433
|
+
"summary": "Name of the DevOps Center project.",
|
|
2434
|
+
"hasDynamicHelp": false,
|
|
2435
|
+
"multiple": false,
|
|
2436
|
+
"type": "option"
|
|
2437
|
+
},
|
|
2438
|
+
"devops-center-username": {
|
|
2439
|
+
"char": "c",
|
|
2440
|
+
"name": "devops-center-username",
|
|
2441
|
+
"required": true,
|
|
2442
|
+
"summary": "Username or alias of the DevOps Center org.",
|
|
2443
|
+
"hasDynamicHelp": true,
|
|
2444
|
+
"multiple": false,
|
|
2445
|
+
"type": "option"
|
|
2446
|
+
},
|
|
2447
|
+
"tests": {
|
|
2448
|
+
"char": "t",
|
|
2449
|
+
"description": "Separate multiple test names with commas. Enclose the entire flag value in double quotes if a test name contains spaces.",
|
|
2450
|
+
"name": "tests",
|
|
2451
|
+
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
2452
|
+
"hasDynamicHelp": false,
|
|
2453
|
+
"multiple": true,
|
|
2454
|
+
"type": "option"
|
|
2455
|
+
},
|
|
2456
|
+
"test-level": {
|
|
2457
|
+
"char": "l",
|
|
2458
|
+
"description": "Valid values are:\n\n- NoTestRun — No tests are run. This test level applies only to deployments to development environments, such as sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.\n\n- RunSpecifiedTests — Runs only the tests that you specify with the --tests flag. Code coverage requirements differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and trigger individually and is different than the overall coverage percentage.\n\n- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default for production deployments that include Apex classes or triggers.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.\n\nIf you don’t specify a test level, the default behavior depends on the contents of your deployment package. For more information, see the section \"Running Tests in a Deployment\" in the \"Metadata API Developer Guide\". (https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm)",
|
|
2459
|
+
"name": "test-level",
|
|
2460
|
+
"summary": "Deployment Apex testing level.",
|
|
2461
|
+
"hasDynamicHelp": false,
|
|
2462
|
+
"multiple": false,
|
|
2463
|
+
"options": [
|
|
2464
|
+
"NoTestRun",
|
|
2465
|
+
"RunSpecifiedTests",
|
|
2466
|
+
"RunLocalTests",
|
|
2467
|
+
"RunAllTestsInOrg"
|
|
2468
|
+
],
|
|
2469
|
+
"type": "option"
|
|
2161
2470
|
},
|
|
2162
|
-
"
|
|
2163
|
-
"
|
|
2164
|
-
"
|
|
2471
|
+
"async": {
|
|
2472
|
+
"description": "The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume the deployment, run \"sf project deploy pipeline resume\". To check the status of the deployment, run \"sf project deploy pipeline report\".",
|
|
2473
|
+
"name": "async",
|
|
2474
|
+
"summary": "Run the command asynchronously.",
|
|
2165
2475
|
"allowNo": false,
|
|
2166
2476
|
"type": "boolean"
|
|
2167
2477
|
},
|
|
@@ -2179,42 +2489,31 @@
|
|
|
2179
2489
|
"multiple": false,
|
|
2180
2490
|
"type": "option"
|
|
2181
2491
|
},
|
|
2182
|
-
"
|
|
2183
|
-
"
|
|
2184
|
-
"
|
|
2185
|
-
"
|
|
2186
|
-
"
|
|
2187
|
-
"hasDynamicHelp": true,
|
|
2188
|
-
"multiple": false,
|
|
2189
|
-
"type": "option"
|
|
2190
|
-
},
|
|
2191
|
-
"job-id": {
|
|
2192
|
-
"char": "i",
|
|
2193
|
-
"description": "The job ID is valid for 10 days from when you started the validation.",
|
|
2194
|
-
"name": "job-id",
|
|
2195
|
-
"summary": "Job ID of the validated deployment to quick deploy.",
|
|
2196
|
-
"hasDynamicHelp": false,
|
|
2197
|
-
"multiple": false,
|
|
2198
|
-
"type": "option"
|
|
2492
|
+
"verbose": {
|
|
2493
|
+
"name": "verbose",
|
|
2494
|
+
"summary": "Show verbose output of the command result.",
|
|
2495
|
+
"allowNo": false,
|
|
2496
|
+
"type": "boolean"
|
|
2199
2497
|
},
|
|
2200
|
-
"
|
|
2201
|
-
"
|
|
2202
|
-
|
|
2203
|
-
|
|
2204
|
-
"
|
|
2498
|
+
"concise": {
|
|
2499
|
+
"exclusive": [
|
|
2500
|
+
"verbose"
|
|
2501
|
+
],
|
|
2502
|
+
"name": "concise",
|
|
2503
|
+
"summary": "Show concise output of the command result.",
|
|
2205
2504
|
"allowNo": false,
|
|
2206
2505
|
"type": "boolean"
|
|
2207
2506
|
}
|
|
2208
2507
|
},
|
|
2209
2508
|
"hasDynamicHelp": true,
|
|
2210
2509
|
"hiddenAliases": [],
|
|
2211
|
-
"id": "project:deploy:pipeline:
|
|
2510
|
+
"id": "project:deploy:pipeline:start",
|
|
2212
2511
|
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
2213
2512
|
"pluginName": "@salesforce/plugin-devops-center",
|
|
2214
2513
|
"pluginType": "jit",
|
|
2215
2514
|
"state": "beta",
|
|
2216
2515
|
"strict": true,
|
|
2217
|
-
"summary": "
|
|
2516
|
+
"summary": "Deploy changes from a branch to the pipeline stage’s org.",
|
|
2218
2517
|
"enableJsonFlag": true,
|
|
2219
2518
|
"SF_ENV": "SF_ENV",
|
|
2220
2519
|
"isESM": false,
|
|
@@ -2224,16 +2523,16 @@
|
|
|
2224
2523
|
"project",
|
|
2225
2524
|
"deploy",
|
|
2226
2525
|
"pipeline",
|
|
2227
|
-
"
|
|
2526
|
+
"start.js"
|
|
2228
2527
|
]
|
|
2229
2528
|
},
|
|
2230
|
-
"project:deploy:pipeline:
|
|
2529
|
+
"project:deploy:pipeline:validate": {
|
|
2231
2530
|
"aliases": [],
|
|
2232
2531
|
"args": {},
|
|
2233
|
-
"description": "The first time you run any \"project deploy pipeline\" command, be sure to authorize the org in which DevOps Center is installed. The easiest way to authorize an org is with the \"org login web\" command.\n\
|
|
2532
|
+
"description": "The first time you run any \"project deploy pipeline\" command, be sure to authorize the org in which DevOps Center is installed. The easiest way to authorize an org is with the \"org login web\" command.\n\nA validation runs Apex tests to verify whether a deployment will succeed without actually deploying the metadata to your environment, so you can then quickly deploy the changes later without re-running the tests.",
|
|
2234
2533
|
"examples": [
|
|
2235
|
-
"
|
|
2236
|
-
"
|
|
2534
|
+
"Perform a validate-only deployment from the Staging branch to the Staging environment (sandbox):\n<%= config.bin %> <%= command.id %> --devops-center-project-name “Recruiting App” --branch-name staging --devops-center-username MyStagingSandbox",
|
|
2535
|
+
"Perform a validate-only deployment of all changes from the main branch to the release environment:\n<%= config.bin %> <%= command.id %> --devops-center-project-name “Recruiting App” --branch-name main --devops-center-username MyReleaseOrg --deploy-all"
|
|
2237
2536
|
],
|
|
2238
2537
|
"flags": {
|
|
2239
2538
|
"json": {
|
|
@@ -2243,70 +2542,41 @@
|
|
|
2243
2542
|
"allowNo": false,
|
|
2244
2543
|
"type": "boolean"
|
|
2245
2544
|
},
|
|
2246
|
-
"
|
|
2247
|
-
"char": "
|
|
2248
|
-
"name": "
|
|
2545
|
+
"branch-name": {
|
|
2546
|
+
"char": "b",
|
|
2547
|
+
"name": "branch-name",
|
|
2249
2548
|
"required": true,
|
|
2250
|
-
"summary": "
|
|
2251
|
-
"hasDynamicHelp":
|
|
2549
|
+
"summary": "Name of the branch in the source control repository that corresponds to the pipeline stage that you want to deploy the changes to.",
|
|
2550
|
+
"hasDynamicHelp": false,
|
|
2252
2551
|
"multiple": false,
|
|
2253
2552
|
"type": "option"
|
|
2254
2553
|
},
|
|
2255
|
-
"
|
|
2256
|
-
"char": "
|
|
2257
|
-
"description": "
|
|
2258
|
-
"name": "
|
|
2259
|
-
"summary": "
|
|
2554
|
+
"bundle-version-name": {
|
|
2555
|
+
"char": "v",
|
|
2556
|
+
"description": "You must indicate the bundle version if deploying to the environment that corresponds to the first stage after the bundling stage.",
|
|
2557
|
+
"name": "bundle-version-name",
|
|
2558
|
+
"summary": "Version name of the bundle.",
|
|
2260
2559
|
"hasDynamicHelp": false,
|
|
2261
2560
|
"multiple": false,
|
|
2262
2561
|
"type": "option"
|
|
2263
2562
|
},
|
|
2264
|
-
"
|
|
2265
|
-
"char": "
|
|
2266
|
-
"description": "
|
|
2267
|
-
"name": "
|
|
2268
|
-
"summary": "
|
|
2269
|
-
"allowNo": false,
|
|
2270
|
-
"type": "boolean"
|
|
2271
|
-
}
|
|
2272
|
-
},
|
|
2273
|
-
"hasDynamicHelp": true,
|
|
2274
|
-
"hiddenAliases": [],
|
|
2275
|
-
"id": "project:deploy:pipeline:report",
|
|
2276
|
-
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
2277
|
-
"pluginName": "@salesforce/plugin-devops-center",
|
|
2278
|
-
"pluginType": "jit",
|
|
2279
|
-
"state": "beta",
|
|
2280
|
-
"strict": true,
|
|
2281
|
-
"summary": "Check the status of a pipeline deploy operation.",
|
|
2282
|
-
"enableJsonFlag": true,
|
|
2283
|
-
"SF_ENV": "SF_ENV",
|
|
2284
|
-
"isESM": false,
|
|
2285
|
-
"relativePath": [
|
|
2286
|
-
"lib",
|
|
2287
|
-
"commands",
|
|
2288
|
-
"project",
|
|
2289
|
-
"deploy",
|
|
2290
|
-
"pipeline",
|
|
2291
|
-
"report.js"
|
|
2292
|
-
]
|
|
2293
|
-
},
|
|
2294
|
-
"project:deploy:pipeline:resume": {
|
|
2295
|
-
"aliases": [],
|
|
2296
|
-
"args": {},
|
|
2297
|
-
"description": "The first time you run any \"project deploy pipeline\" command, be sure to authorize the org in which DevOps Center is installed. The easiest way to authorize an org is with the \"org login web\" command. \n\nUse this command to resume watching a pipeline deploy operation if the original command times out or you specified the --async flag.\n\nRun this command by either indicating a job ID or specifying the --use-most-recent flag to use the job ID of the most recent deploy operation.",
|
|
2298
|
-
"examples": [
|
|
2299
|
-
"Resume watching a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
|
|
2300
|
-
"Resume watching the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
|
|
2301
|
-
],
|
|
2302
|
-
"flags": {
|
|
2303
|
-
"json": {
|
|
2304
|
-
"description": "Format output as json.",
|
|
2305
|
-
"helpGroup": "GLOBAL",
|
|
2306
|
-
"name": "json",
|
|
2563
|
+
"deploy-all": {
|
|
2564
|
+
"char": "a",
|
|
2565
|
+
"description": "If you don’t specify this flag, only changes in the stage’s branch are deployed.",
|
|
2566
|
+
"name": "deploy-all",
|
|
2567
|
+
"summary": "Deploy all metadata in the branch to the stage's org.",
|
|
2307
2568
|
"allowNo": false,
|
|
2308
2569
|
"type": "boolean"
|
|
2309
2570
|
},
|
|
2571
|
+
"devops-center-project-name": {
|
|
2572
|
+
"char": "p",
|
|
2573
|
+
"name": "devops-center-project-name",
|
|
2574
|
+
"required": true,
|
|
2575
|
+
"summary": "Name of the DevOps Center project.",
|
|
2576
|
+
"hasDynamicHelp": false,
|
|
2577
|
+
"multiple": false,
|
|
2578
|
+
"type": "option"
|
|
2579
|
+
},
|
|
2310
2580
|
"devops-center-username": {
|
|
2311
2581
|
"char": "c",
|
|
2312
2582
|
"name": "devops-center-username",
|
|
@@ -2316,35 +2586,34 @@
|
|
|
2316
2586
|
"multiple": false,
|
|
2317
2587
|
"type": "option"
|
|
2318
2588
|
},
|
|
2319
|
-
"
|
|
2320
|
-
"char": "
|
|
2321
|
-
"description": "
|
|
2322
|
-
"name": "
|
|
2323
|
-
"summary": "
|
|
2589
|
+
"tests": {
|
|
2590
|
+
"char": "t",
|
|
2591
|
+
"description": "Separate multiple test names with commas. Enclose the entire flag value in double quotes if a test name contains spaces.",
|
|
2592
|
+
"name": "tests",
|
|
2593
|
+
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
2324
2594
|
"hasDynamicHelp": false,
|
|
2325
|
-
"multiple":
|
|
2595
|
+
"multiple": true,
|
|
2326
2596
|
"type": "option"
|
|
2327
2597
|
},
|
|
2328
|
-
"
|
|
2329
|
-
"char": "
|
|
2330
|
-
"description": "
|
|
2331
|
-
"name": "
|
|
2332
|
-
"summary": "
|
|
2333
|
-
"
|
|
2334
|
-
"
|
|
2335
|
-
|
|
2336
|
-
|
|
2337
|
-
|
|
2338
|
-
"
|
|
2598
|
+
"test-level": {
|
|
2599
|
+
"char": "l",
|
|
2600
|
+
"description": "Valid values are:\n\n- NoTestRun — No tests are run. This test level applies only to deployments to development environments, such as sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.\n\n- RunSpecifiedTests — Runs only the tests that you specify with the --tests flag. Code coverage requirements differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and trigger individually and is different than the overall coverage percentage.\n\n- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default for production deployments that include Apex classes or triggers.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.\n\nIf you don’t specify a test level, the default behavior depends on the contents of your deployment package. For more information, see the section \"Running Tests in a Deployment\" in the \"Metadata API Developer Guide\". (https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm)",
|
|
2601
|
+
"name": "test-level",
|
|
2602
|
+
"summary": "Deployment Apex testing level.",
|
|
2603
|
+
"hasDynamicHelp": false,
|
|
2604
|
+
"multiple": false,
|
|
2605
|
+
"options": [
|
|
2606
|
+
"NoTestRun",
|
|
2607
|
+
"RunSpecifiedTests",
|
|
2608
|
+
"RunLocalTests",
|
|
2609
|
+
"RunAllTestsInOrg"
|
|
2339
2610
|
],
|
|
2340
|
-
"
|
|
2341
|
-
"summary": "Show concise output of the command result.",
|
|
2342
|
-
"allowNo": false,
|
|
2343
|
-
"type": "boolean"
|
|
2611
|
+
"type": "option"
|
|
2344
2612
|
},
|
|
2345
|
-
"
|
|
2346
|
-
"
|
|
2347
|
-
"
|
|
2613
|
+
"async": {
|
|
2614
|
+
"description": "The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume the deployment, run \"sf project deploy pipeline resume\". To check the status of the deployment, run \"sf project deploy pipeline report\".",
|
|
2615
|
+
"name": "async",
|
|
2616
|
+
"summary": "Run the command asynchronously.",
|
|
2348
2617
|
"allowNo": false,
|
|
2349
2618
|
"type": "boolean"
|
|
2350
2619
|
},
|
|
@@ -2361,17 +2630,32 @@
|
|
|
2361
2630
|
"helpValue": "<minutes>",
|
|
2362
2631
|
"multiple": false,
|
|
2363
2632
|
"type": "option"
|
|
2633
|
+
},
|
|
2634
|
+
"verbose": {
|
|
2635
|
+
"name": "verbose",
|
|
2636
|
+
"summary": "Show verbose output of the command result.",
|
|
2637
|
+
"allowNo": false,
|
|
2638
|
+
"type": "boolean"
|
|
2639
|
+
},
|
|
2640
|
+
"concise": {
|
|
2641
|
+
"exclusive": [
|
|
2642
|
+
"verbose"
|
|
2643
|
+
],
|
|
2644
|
+
"name": "concise",
|
|
2645
|
+
"summary": "Show concise output of the command result.",
|
|
2646
|
+
"allowNo": false,
|
|
2647
|
+
"type": "boolean"
|
|
2364
2648
|
}
|
|
2365
2649
|
},
|
|
2366
2650
|
"hasDynamicHelp": true,
|
|
2367
2651
|
"hiddenAliases": [],
|
|
2368
|
-
"id": "project:deploy:pipeline:
|
|
2652
|
+
"id": "project:deploy:pipeline:validate",
|
|
2369
2653
|
"pluginAlias": "@salesforce/plugin-devops-center",
|
|
2370
2654
|
"pluginName": "@salesforce/plugin-devops-center",
|
|
2371
2655
|
"pluginType": "jit",
|
|
2372
2656
|
"state": "beta",
|
|
2373
2657
|
"strict": true,
|
|
2374
|
-
"summary": "
|
|
2658
|
+
"summary": "Perform a validate-only deployment from a branch to the pipeline stage’s org.",
|
|
2375
2659
|
"enableJsonFlag": true,
|
|
2376
2660
|
"SF_ENV": "SF_ENV",
|
|
2377
2661
|
"isESM": false,
|
|
@@ -2381,16 +2665,18 @@
|
|
|
2381
2665
|
"project",
|
|
2382
2666
|
"deploy",
|
|
2383
2667
|
"pipeline",
|
|
2384
|
-
"
|
|
2668
|
+
"validate.js"
|
|
2385
2669
|
]
|
|
2386
2670
|
},
|
|
2387
|
-
"
|
|
2671
|
+
"flow:get:log": {
|
|
2388
2672
|
"aliases": [],
|
|
2389
2673
|
"args": {},
|
|
2390
|
-
"description": "
|
|
2674
|
+
"description": "Provide a flow test run ID to display test results for an enqueued or completed asynchronous test run. The test run ID is displayed after running the \"sf flow run test\" command.\n\nTo see code coverage results, use the --code-coverage flag with --result-format. The output displays a high-level summary of the test run and the code coverage values for flow tests in your org. If you specify human-readable result format, use the --detailed-coverage flag to see detailed coverage results for each test method run.",
|
|
2391
2675
|
"examples": [
|
|
2392
|
-
"
|
|
2393
|
-
"
|
|
2676
|
+
"Display flow test results for your default org using a test run ID:\n<%= config.bin %> <%= command.id %> --test-run-id <test run id>",
|
|
2677
|
+
"Similar to previous example, but output the result in JUnit format:\n<%= config.bin %> <%= command.id %> --test-run-id <test run id> --result-format junit",
|
|
2678
|
+
"Also retrieve code coverage results and output in JSON format:\n<%= config.bin %> <%= command.id %> --test-run-id <test run id> --code-coverage --json",
|
|
2679
|
+
"Specify a directory in which to save the test results from the org with the “me@my.org” username (rather than your default org):\n<%= config.bin %> <%= command.id %> --test-run-id <test run id> --code-coverage --output-dir <path to outputdir> --target-org me@my.org'"
|
|
2394
2680
|
],
|
|
2395
2681
|
"flags": {
|
|
2396
2682
|
"json": {
|
|
@@ -2400,139 +2686,220 @@
|
|
|
2400
2686
|
"allowNo": false,
|
|
2401
2687
|
"type": "boolean"
|
|
2402
2688
|
},
|
|
2403
|
-
"
|
|
2404
|
-
"
|
|
2405
|
-
"name": "
|
|
2689
|
+
"flags-dir": {
|
|
2690
|
+
"helpGroup": "GLOBAL",
|
|
2691
|
+
"name": "flags-dir",
|
|
2692
|
+
"summary": "Import flag values from a directory.",
|
|
2693
|
+
"hasDynamicHelp": false,
|
|
2694
|
+
"multiple": false,
|
|
2695
|
+
"type": "option"
|
|
2696
|
+
},
|
|
2697
|
+
"target-org": {
|
|
2698
|
+
"char": "o",
|
|
2699
|
+
"name": "target-org",
|
|
2700
|
+
"noCacheDefault": true,
|
|
2406
2701
|
"required": true,
|
|
2407
|
-
"summary": "
|
|
2702
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2703
|
+
"hasDynamicHelp": true,
|
|
2704
|
+
"multiple": false,
|
|
2705
|
+
"type": "option"
|
|
2706
|
+
},
|
|
2707
|
+
"api-version": {
|
|
2708
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2709
|
+
"name": "api-version",
|
|
2408
2710
|
"hasDynamicHelp": false,
|
|
2409
2711
|
"multiple": false,
|
|
2410
2712
|
"type": "option"
|
|
2411
2713
|
},
|
|
2412
|
-
"
|
|
2413
|
-
"char": "
|
|
2414
|
-
"
|
|
2415
|
-
"
|
|
2416
|
-
"summary": "Version name of the bundle.",
|
|
2714
|
+
"log-id": {
|
|
2715
|
+
"char": "i",
|
|
2716
|
+
"name": "log-id",
|
|
2717
|
+
"summary": "ID of the specific log to display.",
|
|
2417
2718
|
"hasDynamicHelp": false,
|
|
2418
2719
|
"multiple": false,
|
|
2419
2720
|
"type": "option"
|
|
2420
2721
|
},
|
|
2421
|
-
"
|
|
2422
|
-
"char": "
|
|
2423
|
-
"
|
|
2424
|
-
"
|
|
2425
|
-
"
|
|
2722
|
+
"number": {
|
|
2723
|
+
"char": "n",
|
|
2724
|
+
"name": "number",
|
|
2725
|
+
"summary": "Number of the most recent logs to display.",
|
|
2726
|
+
"hasDynamicHelp": false,
|
|
2727
|
+
"multiple": false,
|
|
2728
|
+
"type": "option"
|
|
2729
|
+
},
|
|
2730
|
+
"output-dir": {
|
|
2731
|
+
"char": "d",
|
|
2732
|
+
"name": "output-dir",
|
|
2733
|
+
"summary": "Directory in which to store test result files.",
|
|
2734
|
+
"hasDynamicHelp": false,
|
|
2735
|
+
"multiple": false,
|
|
2736
|
+
"type": "option"
|
|
2737
|
+
}
|
|
2738
|
+
},
|
|
2739
|
+
"hasDynamicHelp": true,
|
|
2740
|
+
"hidden": true,
|
|
2741
|
+
"hiddenAliases": [],
|
|
2742
|
+
"id": "flow:get:log",
|
|
2743
|
+
"pluginAlias": "@salesforce/plugin-flow",
|
|
2744
|
+
"pluginName": "@salesforce/plugin-flow",
|
|
2745
|
+
"pluginType": "jit",
|
|
2746
|
+
"state": "preview",
|
|
2747
|
+
"strict": true,
|
|
2748
|
+
"summary": "Display test results for a specific asynchronous test run.",
|
|
2749
|
+
"enableJsonFlag": true,
|
|
2750
|
+
"isESM": true,
|
|
2751
|
+
"relativePath": [
|
|
2752
|
+
"lib",
|
|
2753
|
+
"commands",
|
|
2754
|
+
"flow",
|
|
2755
|
+
"get",
|
|
2756
|
+
"log.js"
|
|
2757
|
+
],
|
|
2758
|
+
"aliasPermutations": [],
|
|
2759
|
+
"permutations": [
|
|
2760
|
+
"flow:get:log",
|
|
2761
|
+
"get:flow:log",
|
|
2762
|
+
"get:log:flow",
|
|
2763
|
+
"flow:log:get",
|
|
2764
|
+
"log:flow:get",
|
|
2765
|
+
"log:get:flow"
|
|
2766
|
+
]
|
|
2767
|
+
},
|
|
2768
|
+
"flow:get:test": {
|
|
2769
|
+
"aliases": [],
|
|
2770
|
+
"args": {},
|
|
2771
|
+
"description": "Provide a flow test run ID to display test results for an enqueued or completed asynchronous test run. The test run ID is displayed after running the \"sf flow run test\" command.\n\nTo see code coverage results, use the --code-coverage flag with --result-format. The output displays a high-level summary of the test run and the code coverage values for flow tests in your org. If you specify human-readable result format, use the --detailed-coverage flag to see detailed coverage results for each test method run.",
|
|
2772
|
+
"examples": [
|
|
2773
|
+
"Display flow test results for your default org using a test run ID:\n<%= config.bin %> <%= command.id %> --test-run-id <test run id>",
|
|
2774
|
+
"Similar to previous example, but output the result in JUnit format:\n<%= config.bin %> <%= command.id %> --test-run-id <test run id> --result-format junit",
|
|
2775
|
+
"Also retrieve code coverage results and output in JSON format:\n<%= config.bin %> <%= command.id %> --test-run-id <test run id> --code-coverage --json",
|
|
2776
|
+
"Specify a directory in which to save the test results from the org with the “me@my.org” username (rather than your default org):\n<%= config.bin %> <%= command.id %> --test-run-id <test run id> --code-coverage --output-dir <path to outputdir> --target-org me@my.org'"
|
|
2777
|
+
],
|
|
2778
|
+
"flags": {
|
|
2779
|
+
"json": {
|
|
2780
|
+
"description": "Format output as json.",
|
|
2781
|
+
"helpGroup": "GLOBAL",
|
|
2782
|
+
"name": "json",
|
|
2426
2783
|
"allowNo": false,
|
|
2427
2784
|
"type": "boolean"
|
|
2428
2785
|
},
|
|
2429
|
-
"
|
|
2430
|
-
"
|
|
2431
|
-
"name": "
|
|
2432
|
-
"
|
|
2433
|
-
"summary": "Name of the DevOps Center project.",
|
|
2786
|
+
"flags-dir": {
|
|
2787
|
+
"helpGroup": "GLOBAL",
|
|
2788
|
+
"name": "flags-dir",
|
|
2789
|
+
"summary": "Import flag values from a directory.",
|
|
2434
2790
|
"hasDynamicHelp": false,
|
|
2435
2791
|
"multiple": false,
|
|
2436
2792
|
"type": "option"
|
|
2437
2793
|
},
|
|
2438
|
-
"
|
|
2439
|
-
"char": "
|
|
2440
|
-
"name": "
|
|
2794
|
+
"target-org": {
|
|
2795
|
+
"char": "o",
|
|
2796
|
+
"name": "target-org",
|
|
2797
|
+
"noCacheDefault": true,
|
|
2441
2798
|
"required": true,
|
|
2442
|
-
"summary": "Username or alias of the
|
|
2799
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2443
2800
|
"hasDynamicHelp": true,
|
|
2444
2801
|
"multiple": false,
|
|
2445
2802
|
"type": "option"
|
|
2446
2803
|
},
|
|
2447
|
-
"
|
|
2448
|
-
"
|
|
2449
|
-
"
|
|
2450
|
-
"name": "tests",
|
|
2451
|
-
"summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
|
|
2804
|
+
"api-version": {
|
|
2805
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2806
|
+
"name": "api-version",
|
|
2452
2807
|
"hasDynamicHelp": false,
|
|
2453
|
-
"multiple":
|
|
2808
|
+
"multiple": false,
|
|
2454
2809
|
"type": "option"
|
|
2455
2810
|
},
|
|
2456
|
-
"test-
|
|
2457
|
-
"char": "
|
|
2458
|
-
"
|
|
2459
|
-
"
|
|
2460
|
-
"summary": "
|
|
2811
|
+
"test-run-id": {
|
|
2812
|
+
"char": "i",
|
|
2813
|
+
"name": "test-run-id",
|
|
2814
|
+
"required": true,
|
|
2815
|
+
"summary": "ID of the test run.",
|
|
2461
2816
|
"hasDynamicHelp": false,
|
|
2462
2817
|
"multiple": false,
|
|
2463
|
-
"options": [
|
|
2464
|
-
"NoTestRun",
|
|
2465
|
-
"RunSpecifiedTests",
|
|
2466
|
-
"RunLocalTests",
|
|
2467
|
-
"RunAllTestsInOrg"
|
|
2468
|
-
],
|
|
2469
2818
|
"type": "option"
|
|
2470
2819
|
},
|
|
2471
|
-
"
|
|
2472
|
-
"
|
|
2473
|
-
"name": "
|
|
2474
|
-
"summary": "
|
|
2820
|
+
"code-coverage": {
|
|
2821
|
+
"char": "c",
|
|
2822
|
+
"name": "code-coverage",
|
|
2823
|
+
"summary": "Retrieve code coverage results.",
|
|
2475
2824
|
"allowNo": false,
|
|
2476
2825
|
"type": "boolean"
|
|
2477
2826
|
},
|
|
2478
|
-
"
|
|
2479
|
-
"
|
|
2480
|
-
|
|
2481
|
-
"exclusive": [
|
|
2482
|
-
"async"
|
|
2827
|
+
"detailed-coverage": {
|
|
2828
|
+
"dependsOn": [
|
|
2829
|
+
"code-coverage"
|
|
2483
2830
|
],
|
|
2484
|
-
"name": "
|
|
2485
|
-
"summary": "
|
|
2486
|
-
"
|
|
2487
|
-
"
|
|
2488
|
-
|
|
2831
|
+
"name": "detailed-coverage",
|
|
2832
|
+
"summary": "Not available for flow tests.",
|
|
2833
|
+
"allowNo": false,
|
|
2834
|
+
"type": "boolean"
|
|
2835
|
+
},
|
|
2836
|
+
"output-dir": {
|
|
2837
|
+
"char": "d",
|
|
2838
|
+
"name": "output-dir",
|
|
2839
|
+
"summary": "Directory in which to store test result files.",
|
|
2840
|
+
"hasDynamicHelp": false,
|
|
2489
2841
|
"multiple": false,
|
|
2490
2842
|
"type": "option"
|
|
2491
2843
|
},
|
|
2492
|
-
"
|
|
2493
|
-
"
|
|
2494
|
-
"
|
|
2495
|
-
"
|
|
2496
|
-
"
|
|
2844
|
+
"result-format": {
|
|
2845
|
+
"char": "r",
|
|
2846
|
+
"name": "result-format",
|
|
2847
|
+
"summary": "Format of the test results.",
|
|
2848
|
+
"default": "human",
|
|
2849
|
+
"hasDynamicHelp": false,
|
|
2850
|
+
"multiple": false,
|
|
2851
|
+
"options": [
|
|
2852
|
+
"human",
|
|
2853
|
+
"tap",
|
|
2854
|
+
"junit",
|
|
2855
|
+
"json"
|
|
2856
|
+
],
|
|
2857
|
+
"type": "option"
|
|
2497
2858
|
},
|
|
2498
2859
|
"concise": {
|
|
2499
|
-
"exclusive": [
|
|
2500
|
-
"verbose"
|
|
2501
|
-
],
|
|
2502
2860
|
"name": "concise",
|
|
2503
|
-
"summary": "
|
|
2861
|
+
"summary": "Display only failed test results; works with human-readable output only.",
|
|
2504
2862
|
"allowNo": false,
|
|
2505
2863
|
"type": "boolean"
|
|
2506
2864
|
}
|
|
2507
2865
|
},
|
|
2508
2866
|
"hasDynamicHelp": true,
|
|
2509
2867
|
"hiddenAliases": [],
|
|
2510
|
-
"id": "
|
|
2511
|
-
"pluginAlias": "@salesforce/plugin-
|
|
2512
|
-
"pluginName": "@salesforce/plugin-
|
|
2868
|
+
"id": "flow:get:test",
|
|
2869
|
+
"pluginAlias": "@salesforce/plugin-flow",
|
|
2870
|
+
"pluginName": "@salesforce/plugin-flow",
|
|
2513
2871
|
"pluginType": "jit",
|
|
2514
|
-
"state": "beta",
|
|
2515
2872
|
"strict": true,
|
|
2516
|
-
"summary": "
|
|
2873
|
+
"summary": "Display test results for a specific asynchronous test run.",
|
|
2517
2874
|
"enableJsonFlag": true,
|
|
2518
|
-
"
|
|
2519
|
-
"isESM": false,
|
|
2875
|
+
"isESM": true,
|
|
2520
2876
|
"relativePath": [
|
|
2521
2877
|
"lib",
|
|
2522
2878
|
"commands",
|
|
2523
|
-
"
|
|
2524
|
-
"
|
|
2525
|
-
"
|
|
2526
|
-
|
|
2879
|
+
"flow",
|
|
2880
|
+
"get",
|
|
2881
|
+
"test.js"
|
|
2882
|
+
],
|
|
2883
|
+
"aliasPermutations": [],
|
|
2884
|
+
"permutations": [
|
|
2885
|
+
"flow:get:test",
|
|
2886
|
+
"get:flow:test",
|
|
2887
|
+
"get:test:flow",
|
|
2888
|
+
"flow:test:get",
|
|
2889
|
+
"test:flow:get",
|
|
2890
|
+
"test:get:flow"
|
|
2527
2891
|
]
|
|
2528
2892
|
},
|
|
2529
|
-
"
|
|
2893
|
+
"flow:run:test": {
|
|
2530
2894
|
"aliases": [],
|
|
2531
2895
|
"args": {},
|
|
2532
|
-
"description": "The
|
|
2896
|
+
"description": "Specify which tests to run by using the --class-names flag followed by the names of the flows you want to test. For example, if you save a flow with the name Flow1, then use: --class-names Flow1.\n\nTo see code coverage results, use the --code-coverage flag with --result-format. The output displays a high-level summary of the test run and the code coverage values for classes in your org. If you specify human-readable result format, use the --detailed-coverage flag to see detailed coverage results for each test method run.\n\nBy default, \"flow run test\" runs asynchronously and immediately returns a test run ID. If you use the -–synchronous flag, you can use the --wait flag to specify the number of minutes to wait; if the tests finish in that timeframe, the command displays the results. If the tests haven't finished by the end of the wait time, the command displays a test run ID. Use the \"flow get test --test-run-id\" command to get the results.\n\nYou must have the \"View All Data\" org system permission to use this command. The permission is disabled by default and can be enabled only by a system administrator.",
|
|
2533
2897
|
"examples": [
|
|
2534
|
-
"
|
|
2535
|
-
"
|
|
2898
|
+
"Run all local tests in your default org:\n<%= config.bin %> <%= command.id %> --test-level RunLocalTests",
|
|
2899
|
+
"Run all the Flow1 and Flow2 flow tests in the org with alias “scratchOrg”:\n<%= config.bin %> <%= command.id %> --target-org scratchOrg --class-names Flow1 --class-names Flow2",
|
|
2900
|
+
"Run specific Flow1 and Flow2 flow tests in your default org:\n<%= config.bin %> <%= command.id %> --tests Flow1.Test1 --tests Flow2.Test2 --test-level RunSpecifiedTests",
|
|
2901
|
+
"Run all tests synchronously in your default org; the command waits to display the test results until all tests finish:\n<%= config.bin %> <%= command.id %> –synchronous",
|
|
2902
|
+
"Run all local tests in the org with the username “me@my.org”; save the output to the specified directory:\n<%= config.bin %> <%= command.id %> --test-level RunLocalTests --output-dir /Users/susan/temp/cliOutput --target-org me@my.org"
|
|
2536
2903
|
],
|
|
2537
2904
|
"flags": {
|
|
2538
2905
|
"json": {
|
|
@@ -2542,130 +2909,159 @@
|
|
|
2542
2909
|
"allowNo": false,
|
|
2543
2910
|
"type": "boolean"
|
|
2544
2911
|
},
|
|
2545
|
-
"
|
|
2546
|
-
"
|
|
2547
|
-
"name": "
|
|
2912
|
+
"flags-dir": {
|
|
2913
|
+
"helpGroup": "GLOBAL",
|
|
2914
|
+
"name": "flags-dir",
|
|
2915
|
+
"summary": "Import flag values from a directory.",
|
|
2916
|
+
"hasDynamicHelp": false,
|
|
2917
|
+
"multiple": false,
|
|
2918
|
+
"type": "option"
|
|
2919
|
+
},
|
|
2920
|
+
"target-org": {
|
|
2921
|
+
"char": "o",
|
|
2922
|
+
"name": "target-org",
|
|
2923
|
+
"noCacheDefault": true,
|
|
2548
2924
|
"required": true,
|
|
2549
|
-
"summary": "
|
|
2925
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
2926
|
+
"hasDynamicHelp": true,
|
|
2927
|
+
"multiple": false,
|
|
2928
|
+
"type": "option"
|
|
2929
|
+
},
|
|
2930
|
+
"api-version": {
|
|
2931
|
+
"description": "Override the api version used for api requests made by this command",
|
|
2932
|
+
"name": "api-version",
|
|
2550
2933
|
"hasDynamicHelp": false,
|
|
2551
2934
|
"multiple": false,
|
|
2552
2935
|
"type": "option"
|
|
2553
2936
|
},
|
|
2554
|
-
"
|
|
2555
|
-
"char": "
|
|
2556
|
-
"
|
|
2557
|
-
"
|
|
2558
|
-
"
|
|
2937
|
+
"result-format": {
|
|
2938
|
+
"char": "r",
|
|
2939
|
+
"name": "result-format",
|
|
2940
|
+
"summary": "Format of the test results.",
|
|
2941
|
+
"default": "human",
|
|
2559
2942
|
"hasDynamicHelp": false,
|
|
2560
2943
|
"multiple": false,
|
|
2944
|
+
"options": [
|
|
2945
|
+
"human",
|
|
2946
|
+
"tap",
|
|
2947
|
+
"junit",
|
|
2948
|
+
"json"
|
|
2949
|
+
],
|
|
2561
2950
|
"type": "option"
|
|
2562
2951
|
},
|
|
2563
|
-
"
|
|
2564
|
-
"
|
|
2565
|
-
"
|
|
2566
|
-
"name": "deploy-all",
|
|
2567
|
-
"summary": "Deploy all metadata in the branch to the stage's org.",
|
|
2952
|
+
"concise": {
|
|
2953
|
+
"name": "concise",
|
|
2954
|
+
"summary": "Display only failed test results; works with human-readable output only.",
|
|
2568
2955
|
"allowNo": false,
|
|
2569
2956
|
"type": "boolean"
|
|
2570
2957
|
},
|
|
2571
|
-
"
|
|
2572
|
-
"char": "
|
|
2573
|
-
"name": "
|
|
2574
|
-
"
|
|
2575
|
-
"summary": "Name of the DevOps Center project.",
|
|
2958
|
+
"output-dir": {
|
|
2959
|
+
"char": "d",
|
|
2960
|
+
"name": "output-dir",
|
|
2961
|
+
"summary": "Directory in which to store test result files.",
|
|
2576
2962
|
"hasDynamicHelp": false,
|
|
2577
2963
|
"multiple": false,
|
|
2578
2964
|
"type": "option"
|
|
2579
2965
|
},
|
|
2580
|
-
"
|
|
2966
|
+
"code-coverage": {
|
|
2581
2967
|
"char": "c",
|
|
2582
|
-
"name": "
|
|
2583
|
-
"
|
|
2584
|
-
"
|
|
2585
|
-
"
|
|
2586
|
-
"multiple": false,
|
|
2587
|
-
"type": "option"
|
|
2968
|
+
"name": "code-coverage",
|
|
2969
|
+
"summary": "Retrieve code coverage results.",
|
|
2970
|
+
"allowNo": false,
|
|
2971
|
+
"type": "boolean"
|
|
2588
2972
|
},
|
|
2589
|
-
"
|
|
2590
|
-
"char": "
|
|
2591
|
-
"
|
|
2592
|
-
"
|
|
2593
|
-
"
|
|
2594
|
-
"
|
|
2595
|
-
"multiple": true,
|
|
2596
|
-
"type": "option"
|
|
2973
|
+
"synchronous": {
|
|
2974
|
+
"char": "y",
|
|
2975
|
+
"name": "synchronous",
|
|
2976
|
+
"summary": "Run flow tests for one flow synchronously; if not specified, tests are run asynchronously.",
|
|
2977
|
+
"allowNo": false,
|
|
2978
|
+
"type": "boolean"
|
|
2597
2979
|
},
|
|
2598
2980
|
"test-level": {
|
|
2599
2981
|
"char": "l",
|
|
2600
|
-
"description": "
|
|
2982
|
+
"description": "Here's what the levels mean:\n\n- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages.\n- RunAllTestsInOrg — All tests are run. The tests include all tests in your org, including tests of managed packages.\n- RunSpecifiedTests - Only the tests that you specify with the --tests flag are run.",
|
|
2601
2983
|
"name": "test-level",
|
|
2602
|
-
"summary": "
|
|
2984
|
+
"summary": "Level of tests to run; default is RunLocalTests.",
|
|
2603
2985
|
"hasDynamicHelp": false,
|
|
2604
2986
|
"multiple": false,
|
|
2605
2987
|
"options": [
|
|
2606
|
-
"NoTestRun",
|
|
2607
|
-
"RunSpecifiedTests",
|
|
2608
2988
|
"RunLocalTests",
|
|
2609
|
-
"RunAllTestsInOrg"
|
|
2989
|
+
"RunAllTestsInOrg",
|
|
2990
|
+
"RunSpecifiedTests"
|
|
2610
2991
|
],
|
|
2611
2992
|
"type": "option"
|
|
2612
2993
|
},
|
|
2613
|
-
"
|
|
2614
|
-
"
|
|
2615
|
-
|
|
2616
|
-
|
|
2617
|
-
"
|
|
2618
|
-
"
|
|
2619
|
-
},
|
|
2620
|
-
"wait": {
|
|
2621
|
-
"char": "w",
|
|
2622
|
-
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To check the status of the operation, run \"sf project deploy pipeline report\".",
|
|
2994
|
+
"class-names": {
|
|
2995
|
+
"aliases": [
|
|
2996
|
+
"classnames"
|
|
2997
|
+
],
|
|
2998
|
+
"char": "n",
|
|
2999
|
+
"description": "Default is all flow tests. If you select --class-names, you can't specify --tests.",
|
|
2623
3000
|
"exclusive": [
|
|
2624
|
-
"
|
|
3001
|
+
"suite-names",
|
|
3002
|
+
"tests"
|
|
2625
3003
|
],
|
|
2626
|
-
"name": "
|
|
2627
|
-
"summary": "
|
|
2628
|
-
"
|
|
2629
|
-
"
|
|
2630
|
-
"helpValue": "<minutes>",
|
|
2631
|
-
"multiple": false,
|
|
3004
|
+
"name": "class-names",
|
|
3005
|
+
"summary": "Flow names that contain flow tests to run.",
|
|
3006
|
+
"hasDynamicHelp": false,
|
|
3007
|
+
"multiple": true,
|
|
2632
3008
|
"type": "option"
|
|
2633
3009
|
},
|
|
2634
|
-
"
|
|
2635
|
-
"
|
|
2636
|
-
|
|
2637
|
-
|
|
2638
|
-
"
|
|
3010
|
+
"suite-names": {
|
|
3011
|
+
"aliases": [
|
|
3012
|
+
"suitenames"
|
|
3013
|
+
],
|
|
3014
|
+
"char": "s",
|
|
3015
|
+
"description": "Not available for flow tests.",
|
|
3016
|
+
"exclusive": [
|
|
3017
|
+
"class-names",
|
|
3018
|
+
"tests"
|
|
3019
|
+
],
|
|
3020
|
+
"name": "suite-names",
|
|
3021
|
+
"summary": "Not available for flow tests.",
|
|
3022
|
+
"hasDynamicHelp": false,
|
|
3023
|
+
"multiple": true,
|
|
3024
|
+
"type": "option"
|
|
2639
3025
|
},
|
|
2640
|
-
"
|
|
3026
|
+
"tests": {
|
|
3027
|
+
"char": "t",
|
|
3028
|
+
"description": "Default is all flow tests. If you specify --tests, you can't specify --class-names.",
|
|
2641
3029
|
"exclusive": [
|
|
2642
|
-
"
|
|
3030
|
+
"class-names",
|
|
3031
|
+
"suite-names"
|
|
2643
3032
|
],
|
|
2644
|
-
"name": "
|
|
2645
|
-
"summary": "
|
|
2646
|
-
"
|
|
2647
|
-
"
|
|
3033
|
+
"name": "tests",
|
|
3034
|
+
"summary": "Flow test names to run.",
|
|
3035
|
+
"hasDynamicHelp": false,
|
|
3036
|
+
"multiple": true,
|
|
3037
|
+
"type": "option"
|
|
2648
3038
|
}
|
|
2649
3039
|
},
|
|
2650
3040
|
"hasDynamicHelp": true,
|
|
2651
3041
|
"hiddenAliases": [],
|
|
2652
|
-
"id": "
|
|
2653
|
-
"pluginAlias": "@salesforce/plugin-
|
|
2654
|
-
"pluginName": "@salesforce/plugin-
|
|
3042
|
+
"id": "flow:run:test",
|
|
3043
|
+
"pluginAlias": "@salesforce/plugin-flow",
|
|
3044
|
+
"pluginName": "@salesforce/plugin-flow",
|
|
2655
3045
|
"pluginType": "jit",
|
|
2656
|
-
"state": "beta",
|
|
2657
3046
|
"strict": true,
|
|
2658
|
-
"summary": "
|
|
3047
|
+
"summary": "Invoke flow tests in an org.",
|
|
2659
3048
|
"enableJsonFlag": true,
|
|
2660
|
-
"
|
|
2661
|
-
"isESM": false,
|
|
3049
|
+
"isESM": true,
|
|
2662
3050
|
"relativePath": [
|
|
2663
3051
|
"lib",
|
|
2664
3052
|
"commands",
|
|
2665
|
-
"
|
|
2666
|
-
"
|
|
2667
|
-
"
|
|
2668
|
-
|
|
3053
|
+
"flow",
|
|
3054
|
+
"run",
|
|
3055
|
+
"test.js"
|
|
3056
|
+
],
|
|
3057
|
+
"aliasPermutations": [],
|
|
3058
|
+
"permutations": [
|
|
3059
|
+
"flow:run:test",
|
|
3060
|
+
"run:flow:test",
|
|
3061
|
+
"run:test:flow",
|
|
3062
|
+
"flow:test:run",
|
|
3063
|
+
"test:flow:run",
|
|
3064
|
+
"test:run:flow"
|
|
2669
3065
|
]
|
|
2670
3066
|
},
|
|
2671
3067
|
"org:create:shape": {
|
|
@@ -4411,5 +4807,5 @@
|
|
|
4411
4807
|
]
|
|
4412
4808
|
}
|
|
4413
4809
|
},
|
|
4414
|
-
"version": "2.86.
|
|
4810
|
+
"version": "2.86.7"
|
|
4415
4811
|
}
|