@salesforce/plugin-org 5.2.40 → 5.2.42
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +15 -15
- package/lib/commands/org/display.js +1 -0
- package/lib/commands/org/display.js.map +1 -1
- package/oclif.manifest.json +553 -553
- package/package.json +6 -6
package/oclif.manifest.json
CHANGED
|
@@ -385,6 +385,237 @@
|
|
|
385
385
|
"open:org"
|
|
386
386
|
]
|
|
387
387
|
},
|
|
388
|
+
"org:delete:sandbox": {
|
|
389
|
+
"aliases": [
|
|
390
|
+
"env:delete:sandbox"
|
|
391
|
+
],
|
|
392
|
+
"args": {},
|
|
393
|
+
"deprecateAliases": true,
|
|
394
|
+
"description": "Salesforce CLI marks the org for deletion in the production org that contains the sandbox licenses and then deletes all local references to the org from your computer.\nSpecify a sandbox with either the username you used when you logged into it, or the alias you gave the sandbox when you created it. Run \"<%= config.bin %> org list\" to view all your orgs, including sandboxes, and their aliases.\nBoth the sandbox and the associated production org must already be authenticated with the CLI to successfully delete the sandbox.",
|
|
395
|
+
"examples": [
|
|
396
|
+
"Delete a sandbox with alias my-sandbox:\n<%= config.bin %> <%= command.id %> --target-org my-sandbox",
|
|
397
|
+
"Specify a username instead of an alias:\n<%= config.bin %> <%= command.id %> --target-org myusername@example.com.qa",
|
|
398
|
+
"Delete the sandbox without prompting to confirm:\n<%= config.bin %> <%= command.id %> --target-org my-sandbox --no-prompt"
|
|
399
|
+
],
|
|
400
|
+
"flags": {
|
|
401
|
+
"json": {
|
|
402
|
+
"description": "Format output as json.",
|
|
403
|
+
"helpGroup": "GLOBAL",
|
|
404
|
+
"name": "json",
|
|
405
|
+
"allowNo": false,
|
|
406
|
+
"type": "boolean"
|
|
407
|
+
},
|
|
408
|
+
"flags-dir": {
|
|
409
|
+
"helpGroup": "GLOBAL",
|
|
410
|
+
"name": "flags-dir",
|
|
411
|
+
"summary": "Import flag values from a directory.",
|
|
412
|
+
"hasDynamicHelp": false,
|
|
413
|
+
"multiple": false,
|
|
414
|
+
"type": "option"
|
|
415
|
+
},
|
|
416
|
+
"target-org": {
|
|
417
|
+
"aliases": [
|
|
418
|
+
"targetusername",
|
|
419
|
+
"u"
|
|
420
|
+
],
|
|
421
|
+
"char": "o",
|
|
422
|
+
"deprecateAliases": true,
|
|
423
|
+
"name": "target-org",
|
|
424
|
+
"required": true,
|
|
425
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
426
|
+
"hasDynamicHelp": true,
|
|
427
|
+
"multiple": false,
|
|
428
|
+
"type": "option"
|
|
429
|
+
},
|
|
430
|
+
"no-prompt": {
|
|
431
|
+
"char": "p",
|
|
432
|
+
"name": "no-prompt",
|
|
433
|
+
"summary": "Don't prompt the user to confirm the deletion.",
|
|
434
|
+
"allowNo": false,
|
|
435
|
+
"type": "boolean"
|
|
436
|
+
}
|
|
437
|
+
},
|
|
438
|
+
"hasDynamicHelp": true,
|
|
439
|
+
"hiddenAliases": [],
|
|
440
|
+
"id": "org:delete:sandbox",
|
|
441
|
+
"pluginAlias": "@salesforce/plugin-org",
|
|
442
|
+
"pluginName": "@salesforce/plugin-org",
|
|
443
|
+
"pluginType": "core",
|
|
444
|
+
"strict": true,
|
|
445
|
+
"summary": "Delete a sandbox.",
|
|
446
|
+
"enableJsonFlag": true,
|
|
447
|
+
"isESM": true,
|
|
448
|
+
"relativePath": [
|
|
449
|
+
"lib",
|
|
450
|
+
"commands",
|
|
451
|
+
"org",
|
|
452
|
+
"delete",
|
|
453
|
+
"sandbox.js"
|
|
454
|
+
],
|
|
455
|
+
"aliasPermutations": [
|
|
456
|
+
"env:delete:sandbox",
|
|
457
|
+
"delete:env:sandbox",
|
|
458
|
+
"delete:sandbox:env",
|
|
459
|
+
"env:sandbox:delete",
|
|
460
|
+
"sandbox:env:delete",
|
|
461
|
+
"sandbox:delete:env"
|
|
462
|
+
],
|
|
463
|
+
"permutations": [
|
|
464
|
+
"org:delete:sandbox",
|
|
465
|
+
"delete:org:sandbox",
|
|
466
|
+
"delete:sandbox:org",
|
|
467
|
+
"org:sandbox:delete",
|
|
468
|
+
"sandbox:org:delete",
|
|
469
|
+
"sandbox:delete:org"
|
|
470
|
+
]
|
|
471
|
+
},
|
|
472
|
+
"org:delete:scratch": {
|
|
473
|
+
"aliases": [
|
|
474
|
+
"env:delete:scratch"
|
|
475
|
+
],
|
|
476
|
+
"args": {},
|
|
477
|
+
"deprecateAliases": true,
|
|
478
|
+
"description": "Salesforce CLI marks the org for deletion in the Dev Hub org and then deletes all local references to the org from your computer.\nSpecify a scratch org with either the username or the alias you gave the scratch org when you created it. Run \"<%= config.bin %> org list\" to view all your orgs, including scratch orgs, and their aliases.",
|
|
479
|
+
"examples": [
|
|
480
|
+
"Delete a scratch org with alias my-scratch-org:\n<%= config.bin %> <%= command.id %> --target-org my-scratch-org",
|
|
481
|
+
"Specify a username instead of an alias:\n<%= config.bin %> <%= command.id %> --target-org test-123456-abcdefg@example.com",
|
|
482
|
+
"Delete the scratch org without prompting to confirm :\n<%= config.bin %> <%= command.id %> --target-org my-scratch-org --no-prompt"
|
|
483
|
+
],
|
|
484
|
+
"flags": {
|
|
485
|
+
"json": {
|
|
486
|
+
"description": "Format output as json.",
|
|
487
|
+
"helpGroup": "GLOBAL",
|
|
488
|
+
"name": "json",
|
|
489
|
+
"allowNo": false,
|
|
490
|
+
"type": "boolean"
|
|
491
|
+
},
|
|
492
|
+
"flags-dir": {
|
|
493
|
+
"helpGroup": "GLOBAL",
|
|
494
|
+
"name": "flags-dir",
|
|
495
|
+
"summary": "Import flag values from a directory.",
|
|
496
|
+
"hasDynamicHelp": false,
|
|
497
|
+
"multiple": false,
|
|
498
|
+
"type": "option"
|
|
499
|
+
},
|
|
500
|
+
"target-org": {
|
|
501
|
+
"aliases": [
|
|
502
|
+
"targetusername",
|
|
503
|
+
"u"
|
|
504
|
+
],
|
|
505
|
+
"char": "o",
|
|
506
|
+
"deprecateAliases": true,
|
|
507
|
+
"name": "target-org",
|
|
508
|
+
"required": true,
|
|
509
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
510
|
+
"hasDynamicHelp": true,
|
|
511
|
+
"multiple": false,
|
|
512
|
+
"type": "option"
|
|
513
|
+
},
|
|
514
|
+
"no-prompt": {
|
|
515
|
+
"char": "p",
|
|
516
|
+
"name": "no-prompt",
|
|
517
|
+
"summary": "Don't prompt the user to confirm the deletion.",
|
|
518
|
+
"allowNo": false,
|
|
519
|
+
"type": "boolean"
|
|
520
|
+
}
|
|
521
|
+
},
|
|
522
|
+
"hasDynamicHelp": true,
|
|
523
|
+
"hiddenAliases": [],
|
|
524
|
+
"id": "org:delete:scratch",
|
|
525
|
+
"pluginAlias": "@salesforce/plugin-org",
|
|
526
|
+
"pluginName": "@salesforce/plugin-org",
|
|
527
|
+
"pluginType": "core",
|
|
528
|
+
"strict": true,
|
|
529
|
+
"summary": "Delete a scratch org.",
|
|
530
|
+
"enableJsonFlag": true,
|
|
531
|
+
"isESM": true,
|
|
532
|
+
"relativePath": [
|
|
533
|
+
"lib",
|
|
534
|
+
"commands",
|
|
535
|
+
"org",
|
|
536
|
+
"delete",
|
|
537
|
+
"scratch.js"
|
|
538
|
+
],
|
|
539
|
+
"aliasPermutations": [
|
|
540
|
+
"env:delete:scratch",
|
|
541
|
+
"delete:env:scratch",
|
|
542
|
+
"delete:scratch:env",
|
|
543
|
+
"env:scratch:delete",
|
|
544
|
+
"scratch:env:delete",
|
|
545
|
+
"scratch:delete:env"
|
|
546
|
+
],
|
|
547
|
+
"permutations": [
|
|
548
|
+
"org:delete:scratch",
|
|
549
|
+
"delete:org:scratch",
|
|
550
|
+
"delete:scratch:org",
|
|
551
|
+
"org:scratch:delete",
|
|
552
|
+
"scratch:org:delete",
|
|
553
|
+
"scratch:delete:org"
|
|
554
|
+
]
|
|
555
|
+
},
|
|
556
|
+
"org:disable:tracking": {
|
|
557
|
+
"aliases": [],
|
|
558
|
+
"args": {},
|
|
559
|
+
"description": "Disabling source tracking has no direct effect on the org, it affects only your local environment. Specifically, Salesforce CLI stores the setting in the org's local configuration file so that no source tracking operations are executed when working with the org.",
|
|
560
|
+
"examples": [
|
|
561
|
+
"Disable source tracking for an org with alias \"myscratch\":\n<%= config.bin %> <%= command.id %> --target-org myscratch",
|
|
562
|
+
"Disable source tracking for an org using a username:\n<%= config.bin %> <%= command.id %> --target-org you@example.com",
|
|
563
|
+
"Disable source tracking for your default org:\n<%= config.bin %> <%= command.id %>"
|
|
564
|
+
],
|
|
565
|
+
"flags": {
|
|
566
|
+
"json": {
|
|
567
|
+
"description": "Format output as json.",
|
|
568
|
+
"helpGroup": "GLOBAL",
|
|
569
|
+
"name": "json",
|
|
570
|
+
"allowNo": false,
|
|
571
|
+
"type": "boolean"
|
|
572
|
+
},
|
|
573
|
+
"flags-dir": {
|
|
574
|
+
"helpGroup": "GLOBAL",
|
|
575
|
+
"name": "flags-dir",
|
|
576
|
+
"summary": "Import flag values from a directory.",
|
|
577
|
+
"hasDynamicHelp": false,
|
|
578
|
+
"multiple": false,
|
|
579
|
+
"type": "option"
|
|
580
|
+
},
|
|
581
|
+
"target-org": {
|
|
582
|
+
"char": "o",
|
|
583
|
+
"name": "target-org",
|
|
584
|
+
"noCacheDefault": true,
|
|
585
|
+
"required": true,
|
|
586
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
587
|
+
"hasDynamicHelp": true,
|
|
588
|
+
"multiple": false,
|
|
589
|
+
"type": "option"
|
|
590
|
+
}
|
|
591
|
+
},
|
|
592
|
+
"hasDynamicHelp": true,
|
|
593
|
+
"hiddenAliases": [],
|
|
594
|
+
"id": "org:disable:tracking",
|
|
595
|
+
"pluginAlias": "@salesforce/plugin-org",
|
|
596
|
+
"pluginName": "@salesforce/plugin-org",
|
|
597
|
+
"pluginType": "core",
|
|
598
|
+
"strict": true,
|
|
599
|
+
"summary": "Prevent Salesforce CLI from tracking changes in your source files between your project and an org.",
|
|
600
|
+
"enableJsonFlag": true,
|
|
601
|
+
"isESM": true,
|
|
602
|
+
"relativePath": [
|
|
603
|
+
"lib",
|
|
604
|
+
"commands",
|
|
605
|
+
"org",
|
|
606
|
+
"disable",
|
|
607
|
+
"tracking.js"
|
|
608
|
+
],
|
|
609
|
+
"aliasPermutations": [],
|
|
610
|
+
"permutations": [
|
|
611
|
+
"org:disable:tracking",
|
|
612
|
+
"disable:org:tracking",
|
|
613
|
+
"disable:tracking:org",
|
|
614
|
+
"org:tracking:disable",
|
|
615
|
+
"tracking:org:disable",
|
|
616
|
+
"tracking:disable:org"
|
|
617
|
+
]
|
|
618
|
+
},
|
|
388
619
|
"org:create:sandbox": {
|
|
389
620
|
"aliases": [
|
|
390
621
|
"env:create:sandbox"
|
|
@@ -825,17 +1056,14 @@
|
|
|
825
1056
|
"scratch:create:org"
|
|
826
1057
|
]
|
|
827
1058
|
},
|
|
828
|
-
"org:
|
|
829
|
-
"aliases": [
|
|
830
|
-
"env:delete:sandbox"
|
|
831
|
-
],
|
|
1059
|
+
"org:enable:tracking": {
|
|
1060
|
+
"aliases": [],
|
|
832
1061
|
"args": {},
|
|
833
|
-
"
|
|
834
|
-
"description": "Salesforce CLI marks the org for deletion in the production org that contains the sandbox licenses and then deletes all local references to the org from your computer.\nSpecify a sandbox with either the username you used when you logged into it, or the alias you gave the sandbox when you created it. Run \"<%= config.bin %> org list\" to view all your orgs, including sandboxes, and their aliases.\nBoth the sandbox and the associated production org must already be authenticated with the CLI to successfully delete the sandbox.",
|
|
1062
|
+
"description": "Enabling source tracking has no direct effect on the org, it affects only your local environment. Specifically, Salesforce CLI stores the setting in the org's local configuration file so that source tracking operations are executed when working with the org.\n\nThis command throws an error if the org doesn't support tracking. Examples of orgs that don't support source tracking include Developer Edition orgs, production orgs, Partial Copy sandboxes, and Full sandboxes.",
|
|
835
1063
|
"examples": [
|
|
836
|
-
"
|
|
837
|
-
"
|
|
838
|
-
"
|
|
1064
|
+
"Enable source tracking for an org with alias \"myscratch\":\n<%= config.bin %> <%= command.id %> --target-org myscratch",
|
|
1065
|
+
"Enable source tracking for an org using a username:\n<%= config.bin %> <%= command.id %> --target-org you@example.com",
|
|
1066
|
+
"Enable source tracking for your default org:\n<%= config.bin %> <%= command.id %>"
|
|
839
1067
|
],
|
|
840
1068
|
"flags": {
|
|
841
1069
|
"json": {
|
|
@@ -854,72 +1082,51 @@
|
|
|
854
1082
|
"type": "option"
|
|
855
1083
|
},
|
|
856
1084
|
"target-org": {
|
|
857
|
-
"aliases": [
|
|
858
|
-
"targetusername",
|
|
859
|
-
"u"
|
|
860
|
-
],
|
|
861
1085
|
"char": "o",
|
|
862
|
-
"deprecateAliases": true,
|
|
863
1086
|
"name": "target-org",
|
|
1087
|
+
"noCacheDefault": true,
|
|
864
1088
|
"required": true,
|
|
865
1089
|
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
866
1090
|
"hasDynamicHelp": true,
|
|
867
1091
|
"multiple": false,
|
|
868
1092
|
"type": "option"
|
|
869
|
-
},
|
|
870
|
-
"no-prompt": {
|
|
871
|
-
"char": "p",
|
|
872
|
-
"name": "no-prompt",
|
|
873
|
-
"summary": "Don't prompt the user to confirm the deletion.",
|
|
874
|
-
"allowNo": false,
|
|
875
|
-
"type": "boolean"
|
|
876
1093
|
}
|
|
877
1094
|
},
|
|
878
1095
|
"hasDynamicHelp": true,
|
|
879
1096
|
"hiddenAliases": [],
|
|
880
|
-
"id": "org:
|
|
1097
|
+
"id": "org:enable:tracking",
|
|
881
1098
|
"pluginAlias": "@salesforce/plugin-org",
|
|
882
1099
|
"pluginName": "@salesforce/plugin-org",
|
|
883
1100
|
"pluginType": "core",
|
|
884
1101
|
"strict": true,
|
|
885
|
-
"summary": "
|
|
1102
|
+
"summary": "Allow Salesforce CLI to track changes in your source files between your project and an org.",
|
|
886
1103
|
"enableJsonFlag": true,
|
|
887
1104
|
"isESM": true,
|
|
888
1105
|
"relativePath": [
|
|
889
1106
|
"lib",
|
|
890
1107
|
"commands",
|
|
891
1108
|
"org",
|
|
892
|
-
"
|
|
893
|
-
"
|
|
894
|
-
],
|
|
895
|
-
"aliasPermutations": [
|
|
896
|
-
"env:delete:sandbox",
|
|
897
|
-
"delete:env:sandbox",
|
|
898
|
-
"delete:sandbox:env",
|
|
899
|
-
"env:sandbox:delete",
|
|
900
|
-
"sandbox:env:delete",
|
|
901
|
-
"sandbox:delete:env"
|
|
1109
|
+
"enable",
|
|
1110
|
+
"tracking.js"
|
|
902
1111
|
],
|
|
1112
|
+
"aliasPermutations": [],
|
|
903
1113
|
"permutations": [
|
|
904
|
-
"org:
|
|
905
|
-
"
|
|
906
|
-
"
|
|
907
|
-
"org:
|
|
908
|
-
"
|
|
909
|
-
"
|
|
1114
|
+
"org:enable:tracking",
|
|
1115
|
+
"enable:org:tracking",
|
|
1116
|
+
"enable:tracking:org",
|
|
1117
|
+
"org:tracking:enable",
|
|
1118
|
+
"tracking:org:enable",
|
|
1119
|
+
"tracking:enable:org"
|
|
910
1120
|
]
|
|
911
1121
|
},
|
|
912
|
-
"org:
|
|
913
|
-
"aliases": [
|
|
914
|
-
"env:delete:scratch"
|
|
915
|
-
],
|
|
1122
|
+
"org:open:agent": {
|
|
1123
|
+
"aliases": [],
|
|
916
1124
|
"args": {},
|
|
917
|
-
"
|
|
918
|
-
"description": "Salesforce CLI marks the org for deletion in the Dev Hub org and then deletes all local references to the org from your computer.\nSpecify a scratch org with either the username or the alias you gave the scratch org when you created it. Run \"<%= config.bin %> org list\" to view all your orgs, including scratch orgs, and their aliases.",
|
|
1125
|
+
"description": "Use the --name flag to open an agent using its API name in the Agent Builder UI of your org. To find the agent's API name, go to Setup in your org and navigate to the agent's details page.\n\nTo generate the URL but not launch it in your browser, specify --url-only.\n\nTo open Agent Builder in a specific browser, use the --browser flag. Supported browsers are \"chrome\", \"edge\", and \"firefox\". If you don't specify --browser, the org opens in your default browser.",
|
|
919
1126
|
"examples": [
|
|
920
|
-
"
|
|
921
|
-
"
|
|
922
|
-
"
|
|
1127
|
+
"Open the agent with API name Coral_Cloud_Agent in your default org using your default browser:\n$ <%= config.bin %> <%= command.id %> --name Coral_Cloud_Agent",
|
|
1128
|
+
"Open the agent in an incognito window of your default browser:\n$ <%= config.bin %> <%= command.id %> --private --name Coral_Cloud_Agent:",
|
|
1129
|
+
"Open the agent in an org with alias MyTestOrg1 using the Firefox browser:\n$ <%= config.bin %> <%= command.id %> --target-org MyTestOrg1 --browser firefox --name Coral_Cloud_Agent"
|
|
923
1130
|
],
|
|
924
1131
|
"flags": {
|
|
925
1132
|
"json": {
|
|
@@ -938,69 +1145,106 @@
|
|
|
938
1145
|
"type": "option"
|
|
939
1146
|
},
|
|
940
1147
|
"target-org": {
|
|
941
|
-
"aliases": [
|
|
942
|
-
"targetusername",
|
|
943
|
-
"u"
|
|
944
|
-
],
|
|
945
1148
|
"char": "o",
|
|
946
|
-
"deprecateAliases": true,
|
|
947
1149
|
"name": "target-org",
|
|
1150
|
+
"noCacheDefault": true,
|
|
948
1151
|
"required": true,
|
|
949
1152
|
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
950
1153
|
"hasDynamicHelp": true,
|
|
951
1154
|
"multiple": false,
|
|
952
1155
|
"type": "option"
|
|
953
1156
|
},
|
|
954
|
-
"
|
|
955
|
-
"
|
|
956
|
-
"name": "
|
|
957
|
-
"
|
|
1157
|
+
"api-version": {
|
|
1158
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1159
|
+
"name": "api-version",
|
|
1160
|
+
"hasDynamicHelp": false,
|
|
1161
|
+
"multiple": false,
|
|
1162
|
+
"type": "option"
|
|
1163
|
+
},
|
|
1164
|
+
"name": {
|
|
1165
|
+
"char": "n",
|
|
1166
|
+
"name": "name",
|
|
1167
|
+
"required": true,
|
|
1168
|
+
"summary": "API name, also known as developer name, of the agent you want to open in the org's Agent Builder UI.",
|
|
1169
|
+
"hasDynamicHelp": false,
|
|
1170
|
+
"multiple": false,
|
|
1171
|
+
"type": "option"
|
|
1172
|
+
},
|
|
1173
|
+
"private": {
|
|
1174
|
+
"exclusive": [
|
|
1175
|
+
"url-only",
|
|
1176
|
+
"browser"
|
|
1177
|
+
],
|
|
1178
|
+
"name": "private",
|
|
1179
|
+
"summary": "Open the org in the default browser using private (incognito) mode.",
|
|
1180
|
+
"allowNo": false,
|
|
1181
|
+
"type": "boolean"
|
|
1182
|
+
},
|
|
1183
|
+
"browser": {
|
|
1184
|
+
"char": "b",
|
|
1185
|
+
"exclusive": [
|
|
1186
|
+
"url-only",
|
|
1187
|
+
"private"
|
|
1188
|
+
],
|
|
1189
|
+
"name": "browser",
|
|
1190
|
+
"summary": "Browser where the org opens.",
|
|
1191
|
+
"hasDynamicHelp": false,
|
|
1192
|
+
"multiple": false,
|
|
1193
|
+
"options": [
|
|
1194
|
+
"chrome",
|
|
1195
|
+
"edge",
|
|
1196
|
+
"firefox"
|
|
1197
|
+
],
|
|
1198
|
+
"type": "option"
|
|
1199
|
+
},
|
|
1200
|
+
"url-only": {
|
|
1201
|
+
"aliases": [
|
|
1202
|
+
"urlonly"
|
|
1203
|
+
],
|
|
1204
|
+
"char": "r",
|
|
1205
|
+
"deprecateAliases": true,
|
|
1206
|
+
"name": "url-only",
|
|
1207
|
+
"summary": "Display navigation URL, but don’t launch browser.",
|
|
958
1208
|
"allowNo": false,
|
|
959
1209
|
"type": "boolean"
|
|
960
1210
|
}
|
|
961
1211
|
},
|
|
962
1212
|
"hasDynamicHelp": true,
|
|
963
1213
|
"hiddenAliases": [],
|
|
964
|
-
"id": "org:
|
|
1214
|
+
"id": "org:open:agent",
|
|
965
1215
|
"pluginAlias": "@salesforce/plugin-org",
|
|
966
1216
|
"pluginName": "@salesforce/plugin-org",
|
|
967
1217
|
"pluginType": "core",
|
|
1218
|
+
"state": "beta",
|
|
968
1219
|
"strict": true,
|
|
969
|
-
"summary": "
|
|
1220
|
+
"summary": "Open an agent in your org's Agent Builder UI in a browser.",
|
|
970
1221
|
"enableJsonFlag": true,
|
|
971
1222
|
"isESM": true,
|
|
972
1223
|
"relativePath": [
|
|
973
1224
|
"lib",
|
|
974
1225
|
"commands",
|
|
975
1226
|
"org",
|
|
976
|
-
"
|
|
977
|
-
"
|
|
978
|
-
],
|
|
979
|
-
"aliasPermutations": [
|
|
980
|
-
"env:delete:scratch",
|
|
981
|
-
"delete:env:scratch",
|
|
982
|
-
"delete:scratch:env",
|
|
983
|
-
"env:scratch:delete",
|
|
984
|
-
"scratch:env:delete",
|
|
985
|
-
"scratch:delete:env"
|
|
1227
|
+
"open",
|
|
1228
|
+
"agent.js"
|
|
986
1229
|
],
|
|
1230
|
+
"aliasPermutations": [],
|
|
987
1231
|
"permutations": [
|
|
988
|
-
"org:
|
|
989
|
-
"
|
|
990
|
-
"
|
|
991
|
-
"org:
|
|
992
|
-
"
|
|
993
|
-
"
|
|
1232
|
+
"org:open:agent",
|
|
1233
|
+
"open:org:agent",
|
|
1234
|
+
"open:agent:org",
|
|
1235
|
+
"org:agent:open",
|
|
1236
|
+
"agent:org:open",
|
|
1237
|
+
"agent:open:org"
|
|
994
1238
|
]
|
|
995
1239
|
},
|
|
996
|
-
"org:
|
|
1240
|
+
"org:refresh:sandbox": {
|
|
997
1241
|
"aliases": [],
|
|
998
1242
|
"args": {},
|
|
999
|
-
"description": "
|
|
1243
|
+
"description": "Refreshing a sandbox copies the metadata, and optionally data, from your source org to the refreshed sandbox org. You can optionally specify a definition file if you want to change the configuration of the refreshed sandbox, such as its license type or template ID.\n\nYou're not allowed to change the sandbox name when you refresh it with this command. If you want to change the sandbox name, first delete it with the \"org delete sandbox\" command. And then recreate it with the \"org create sandbox\" command and give it a new name.",
|
|
1000
1244
|
"examples": [
|
|
1001
|
-
"
|
|
1002
|
-
"
|
|
1003
|
-
"
|
|
1245
|
+
"Refresh the sandbox named \"devSbx1\". The production org that contains the sandbox license has the alias \"prodOrg\".\n<%= config.bin %> <%= command.id %> --name devSbx1 --target-org prodOrg",
|
|
1246
|
+
"Refresh the sandbox named \"devSbx2\", and override the configuration of the refreshed sandbox with the properties in the specified defintion file. The default target org is the production org, so you don't need to specify the `--target-org` flag in this case.\n<%= config.bin %> <%= command.id %> --name devSbx2 --definition-file devSbx2-config.json",
|
|
1247
|
+
"Refresh the sandbox using the name defined in the definition file. The production org that contains the sandbox license has the alias \"prodOrg\".\n<%= config.bin %> <%= command.id %> --definition-file devSbx3-config.json --target-org prodOrg"
|
|
1004
1248
|
],
|
|
1005
1249
|
"flags": {
|
|
1006
1250
|
"json": {
|
|
@@ -1018,52 +1262,120 @@
|
|
|
1018
1262
|
"multiple": false,
|
|
1019
1263
|
"type": "option"
|
|
1020
1264
|
},
|
|
1265
|
+
"no-auto-activate": {
|
|
1266
|
+
"description": "By default, a sandbox auto-activates after a refresh. Use this flag to control sandbox activation manually.",
|
|
1267
|
+
"name": "no-auto-activate",
|
|
1268
|
+
"summary": "Disable auto-activation of the sandbox after a successful refresh.",
|
|
1269
|
+
"allowNo": false,
|
|
1270
|
+
"type": "boolean"
|
|
1271
|
+
},
|
|
1272
|
+
"wait": {
|
|
1273
|
+
"char": "w",
|
|
1274
|
+
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal to you and displays the \"<%= config.bin %> org resume sandbox\" command for you run to check the status of the refresh. The displayed command includes the job ID for the running sandbox refresh.",
|
|
1275
|
+
"exclusive": [
|
|
1276
|
+
"async"
|
|
1277
|
+
],
|
|
1278
|
+
"name": "wait",
|
|
1279
|
+
"summary": "Number of minutes to poll for sandbox refresh status.",
|
|
1280
|
+
"hasDynamicHelp": true,
|
|
1281
|
+
"helpValue": "<minutes>",
|
|
1282
|
+
"multiple": false,
|
|
1283
|
+
"type": "option"
|
|
1284
|
+
},
|
|
1285
|
+
"poll-interval": {
|
|
1286
|
+
"char": "i",
|
|
1287
|
+
"exclusive": [
|
|
1288
|
+
"async"
|
|
1289
|
+
],
|
|
1290
|
+
"name": "poll-interval",
|
|
1291
|
+
"summary": "Number of seconds to wait between status polling requests.",
|
|
1292
|
+
"hasDynamicHelp": true,
|
|
1293
|
+
"helpValue": "<seconds>",
|
|
1294
|
+
"multiple": false,
|
|
1295
|
+
"type": "option"
|
|
1296
|
+
},
|
|
1297
|
+
"async": {
|
|
1298
|
+
"description": "The command immediately displays the job ID and returns control of the terminal to you. This way, you can continue to use the CLI. To check the status of the sandbox refresh, run \"<%= config.bin %> org resume sandbox\".",
|
|
1299
|
+
"exclusive": [
|
|
1300
|
+
"wait",
|
|
1301
|
+
"poll-interval"
|
|
1302
|
+
],
|
|
1303
|
+
"name": "async",
|
|
1304
|
+
"summary": "Request the sandbox refresh, but don't wait for it to complete.",
|
|
1305
|
+
"allowNo": false,
|
|
1306
|
+
"type": "boolean"
|
|
1307
|
+
},
|
|
1308
|
+
"name": {
|
|
1309
|
+
"char": "n",
|
|
1310
|
+
"name": "name",
|
|
1311
|
+
"summary": "Name of the existing sandbox org in your production org that you want to refresh.",
|
|
1312
|
+
"hasDynamicHelp": false,
|
|
1313
|
+
"multiple": false,
|
|
1314
|
+
"type": "option"
|
|
1315
|
+
},
|
|
1316
|
+
"definition-file": {
|
|
1317
|
+
"char": "f",
|
|
1318
|
+
"description": "The sandbox definition file is a blueprint for the sandbox; use the file to change the sandbox configuration during a refresh. If you don't want to change the sandbox configuration when you refresh it, then simply use the --name flag to specify the sandbox and don't use this flag. See <https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_sandbox_definition.htm> for all the options you can specify in the definition file.",
|
|
1319
|
+
"name": "definition-file",
|
|
1320
|
+
"summary": "Path to a sandbox definition file for overriding its configuration when you refresh it.",
|
|
1321
|
+
"hasDynamicHelp": false,
|
|
1322
|
+
"multiple": false,
|
|
1323
|
+
"type": "option"
|
|
1324
|
+
},
|
|
1021
1325
|
"target-org": {
|
|
1022
1326
|
"char": "o",
|
|
1023
1327
|
"name": "target-org",
|
|
1024
1328
|
"noCacheDefault": true,
|
|
1025
1329
|
"required": true,
|
|
1026
|
-
"summary": "Username or alias of the
|
|
1330
|
+
"summary": "Username or alias of the production org that contains the sandbox license.",
|
|
1027
1331
|
"hasDynamicHelp": true,
|
|
1028
1332
|
"multiple": false,
|
|
1029
1333
|
"type": "option"
|
|
1334
|
+
},
|
|
1335
|
+
"no-prompt": {
|
|
1336
|
+
"name": "no-prompt",
|
|
1337
|
+
"summary": "Don't prompt for confirmation about the sandbox refresh.",
|
|
1338
|
+
"allowNo": false,
|
|
1339
|
+
"type": "boolean"
|
|
1030
1340
|
}
|
|
1031
1341
|
},
|
|
1032
1342
|
"hasDynamicHelp": true,
|
|
1033
1343
|
"hiddenAliases": [],
|
|
1034
|
-
"id": "org:
|
|
1344
|
+
"id": "org:refresh:sandbox",
|
|
1035
1345
|
"pluginAlias": "@salesforce/plugin-org",
|
|
1036
1346
|
"pluginName": "@salesforce/plugin-org",
|
|
1037
1347
|
"pluginType": "core",
|
|
1038
1348
|
"strict": true,
|
|
1039
|
-
"summary": "
|
|
1040
|
-
"enableJsonFlag": true,
|
|
1349
|
+
"summary": "Refresh a sandbox org using the sandbox name.",
|
|
1041
1350
|
"isESM": true,
|
|
1042
1351
|
"relativePath": [
|
|
1043
1352
|
"lib",
|
|
1044
1353
|
"commands",
|
|
1045
1354
|
"org",
|
|
1046
|
-
"
|
|
1047
|
-
"
|
|
1355
|
+
"refresh",
|
|
1356
|
+
"sandbox.js"
|
|
1048
1357
|
],
|
|
1049
1358
|
"aliasPermutations": [],
|
|
1050
1359
|
"permutations": [
|
|
1051
|
-
"org:
|
|
1052
|
-
"
|
|
1053
|
-
"
|
|
1054
|
-
"org:
|
|
1055
|
-
"
|
|
1056
|
-
"
|
|
1360
|
+
"org:refresh:sandbox",
|
|
1361
|
+
"refresh:org:sandbox",
|
|
1362
|
+
"refresh:sandbox:org",
|
|
1363
|
+
"org:sandbox:refresh",
|
|
1364
|
+
"sandbox:org:refresh",
|
|
1365
|
+
"sandbox:refresh:org"
|
|
1057
1366
|
]
|
|
1058
1367
|
},
|
|
1059
|
-
"org:
|
|
1060
|
-
"aliases": [
|
|
1368
|
+
"org:resume:sandbox": {
|
|
1369
|
+
"aliases": [
|
|
1370
|
+
"env:resume:sandbox"
|
|
1371
|
+
],
|
|
1061
1372
|
"args": {},
|
|
1062
|
-
"
|
|
1373
|
+
"deprecateAliases": true,
|
|
1374
|
+
"description": "Sandbox creation can take a long time. If the original \"<%= config.bin %> org create sandbox\" command either times out, or you specified the --async flag, the command displays a job ID. Use this job ID to check whether the sandbox creation is complete, and if it is, the command then logs into it.\n\nYou can also use the sandbox name to check the status or the --use-most-recent flag to use the job ID of the most recent sandbox creation.",
|
|
1063
1375
|
"examples": [
|
|
1064
|
-
"
|
|
1065
|
-
"
|
|
1066
|
-
"
|
|
1376
|
+
"Check the status of a sandbox creation using its name and specify a production org with alias \"prodOrg\":\n<%= config.bin %> <%= command.id %> --name mysandbox --target-org prodOrg",
|
|
1377
|
+
"Check the status using the job ID:\n<%= config.bin %> <%= command.id %> --job-id 0GRxxxxxxxx",
|
|
1378
|
+
"Check the status of the most recent sandbox create request:\n<%= config.bin %> <%= command.id %> --use-most-recent"
|
|
1067
1379
|
],
|
|
1068
1380
|
"flags": {
|
|
1069
1381
|
"json": {
|
|
@@ -1081,12 +1393,53 @@
|
|
|
1081
1393
|
"multiple": false,
|
|
1082
1394
|
"type": "option"
|
|
1083
1395
|
},
|
|
1084
|
-
"
|
|
1085
|
-
"char": "
|
|
1086
|
-
"
|
|
1087
|
-
"
|
|
1088
|
-
"
|
|
1089
|
-
"
|
|
1396
|
+
"wait": {
|
|
1397
|
+
"char": "w",
|
|
1398
|
+
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To resume checking the sandbox creation, rerun this command.",
|
|
1399
|
+
"name": "wait",
|
|
1400
|
+
"summary": "Number of minutes to wait for the sandbox org to be ready.",
|
|
1401
|
+
"default": "0 minutes",
|
|
1402
|
+
"hasDynamicHelp": true,
|
|
1403
|
+
"helpValue": "<minutes>",
|
|
1404
|
+
"multiple": false,
|
|
1405
|
+
"type": "option"
|
|
1406
|
+
},
|
|
1407
|
+
"name": {
|
|
1408
|
+
"char": "n",
|
|
1409
|
+
"exclusive": [
|
|
1410
|
+
"job-id"
|
|
1411
|
+
],
|
|
1412
|
+
"name": "name",
|
|
1413
|
+
"summary": "Name of the sandbox org.",
|
|
1414
|
+
"hasDynamicHelp": false,
|
|
1415
|
+
"multiple": false,
|
|
1416
|
+
"type": "option"
|
|
1417
|
+
},
|
|
1418
|
+
"job-id": {
|
|
1419
|
+
"char": "i",
|
|
1420
|
+
"description": "The job ID is valid for 24 hours after you start the sandbox creation.",
|
|
1421
|
+
"exclusive": [
|
|
1422
|
+
"name"
|
|
1423
|
+
],
|
|
1424
|
+
"name": "job-id",
|
|
1425
|
+
"summary": "Job ID of the incomplete sandbox creation that you want to check the status of.",
|
|
1426
|
+
"hasDynamicHelp": false,
|
|
1427
|
+
"multiple": false,
|
|
1428
|
+
"type": "option"
|
|
1429
|
+
},
|
|
1430
|
+
"use-most-recent": {
|
|
1431
|
+
"char": "l",
|
|
1432
|
+
"name": "use-most-recent",
|
|
1433
|
+
"summary": "Use the most recent sandbox create request.",
|
|
1434
|
+
"allowNo": false,
|
|
1435
|
+
"type": "boolean"
|
|
1436
|
+
},
|
|
1437
|
+
"target-org": {
|
|
1438
|
+
"char": "o",
|
|
1439
|
+
"description": "When it creates the sandbox org, Salesforce copies the metadata, and optionally data, from your production org to the new sandbox org.",
|
|
1440
|
+
"name": "target-org",
|
|
1441
|
+
"noCacheDefault": true,
|
|
1442
|
+
"summary": "Username or alias of the production org that contains the sandbox license.",
|
|
1090
1443
|
"hasDynamicHelp": true,
|
|
1091
1444
|
"multiple": false,
|
|
1092
1445
|
"type": "option"
|
|
@@ -1094,29 +1447,113 @@
|
|
|
1094
1447
|
},
|
|
1095
1448
|
"hasDynamicHelp": true,
|
|
1096
1449
|
"hiddenAliases": [],
|
|
1097
|
-
"id": "org:
|
|
1450
|
+
"id": "org:resume:sandbox",
|
|
1098
1451
|
"pluginAlias": "@salesforce/plugin-org",
|
|
1099
1452
|
"pluginName": "@salesforce/plugin-org",
|
|
1100
1453
|
"pluginType": "core",
|
|
1101
1454
|
"strict": true,
|
|
1102
|
-
"summary": "
|
|
1455
|
+
"summary": "Check the status of a sandbox creation, and log in to it if it's ready.",
|
|
1456
|
+
"isESM": true,
|
|
1457
|
+
"relativePath": [
|
|
1458
|
+
"lib",
|
|
1459
|
+
"commands",
|
|
1460
|
+
"org",
|
|
1461
|
+
"resume",
|
|
1462
|
+
"sandbox.js"
|
|
1463
|
+
],
|
|
1464
|
+
"aliasPermutations": [
|
|
1465
|
+
"env:resume:sandbox",
|
|
1466
|
+
"resume:env:sandbox",
|
|
1467
|
+
"resume:sandbox:env",
|
|
1468
|
+
"env:sandbox:resume",
|
|
1469
|
+
"sandbox:env:resume",
|
|
1470
|
+
"sandbox:resume:env"
|
|
1471
|
+
],
|
|
1472
|
+
"permutations": [
|
|
1473
|
+
"org:resume:sandbox",
|
|
1474
|
+
"resume:org:sandbox",
|
|
1475
|
+
"resume:sandbox:org",
|
|
1476
|
+
"org:sandbox:resume",
|
|
1477
|
+
"sandbox:org:resume",
|
|
1478
|
+
"sandbox:resume:org"
|
|
1479
|
+
]
|
|
1480
|
+
},
|
|
1481
|
+
"org:resume:scratch": {
|
|
1482
|
+
"aliases": [
|
|
1483
|
+
"env:resume:scratch"
|
|
1484
|
+
],
|
|
1485
|
+
"args": {},
|
|
1486
|
+
"deprecateAliases": true,
|
|
1487
|
+
"description": "When the original \"<%= config.bin %> org create scratch\" command either times out or is run with the --async flag, it displays a job ID.\n\nRun this command by either passing it a job ID or using the --use-most-recent flag to specify the most recent incomplete scratch org.",
|
|
1488
|
+
"examples": [
|
|
1489
|
+
"Resume a scratch org create with a job ID:\n<%= config.bin %> <%= command.id %> --job-id 2SR3u0000008fBDGAY",
|
|
1490
|
+
"Resume your most recent incomplete scratch org:\n<%= config.bin %> <%= command.id %> --use-most-recent"
|
|
1491
|
+
],
|
|
1492
|
+
"flags": {
|
|
1493
|
+
"json": {
|
|
1494
|
+
"description": "Format output as json.",
|
|
1495
|
+
"helpGroup": "GLOBAL",
|
|
1496
|
+
"name": "json",
|
|
1497
|
+
"allowNo": false,
|
|
1498
|
+
"type": "boolean"
|
|
1499
|
+
},
|
|
1500
|
+
"flags-dir": {
|
|
1501
|
+
"helpGroup": "GLOBAL",
|
|
1502
|
+
"name": "flags-dir",
|
|
1503
|
+
"summary": "Import flag values from a directory.",
|
|
1504
|
+
"hasDynamicHelp": false,
|
|
1505
|
+
"multiple": false,
|
|
1506
|
+
"type": "option"
|
|
1507
|
+
},
|
|
1508
|
+
"job-id": {
|
|
1509
|
+
"char": "i",
|
|
1510
|
+
"description": "The job ID is the same as the record ID of the incomplete scratch org in the ScratchOrgInfo object of the Dev Hub.\n\nThe job ID is valid for 24 hours after you start the scratch org creation.",
|
|
1511
|
+
"name": "job-id",
|
|
1512
|
+
"summary": "Job ID of the incomplete scratch org create that you want to resume.",
|
|
1513
|
+
"hasDynamicHelp": false,
|
|
1514
|
+
"multiple": false,
|
|
1515
|
+
"type": "option"
|
|
1516
|
+
},
|
|
1517
|
+
"use-most-recent": {
|
|
1518
|
+
"char": "r",
|
|
1519
|
+
"name": "use-most-recent",
|
|
1520
|
+
"summary": "Use the job ID of the most recent incomplete scratch org.",
|
|
1521
|
+
"allowNo": false,
|
|
1522
|
+
"type": "boolean"
|
|
1523
|
+
}
|
|
1524
|
+
},
|
|
1525
|
+
"hasDynamicHelp": false,
|
|
1526
|
+
"hiddenAliases": [],
|
|
1527
|
+
"id": "org:resume:scratch",
|
|
1528
|
+
"pluginAlias": "@salesforce/plugin-org",
|
|
1529
|
+
"pluginName": "@salesforce/plugin-org",
|
|
1530
|
+
"pluginType": "core",
|
|
1531
|
+
"strict": true,
|
|
1532
|
+
"summary": "Resume the creation of an incomplete scratch org.",
|
|
1103
1533
|
"enableJsonFlag": true,
|
|
1104
1534
|
"isESM": true,
|
|
1105
1535
|
"relativePath": [
|
|
1106
1536
|
"lib",
|
|
1107
1537
|
"commands",
|
|
1108
1538
|
"org",
|
|
1109
|
-
"
|
|
1110
|
-
"
|
|
1539
|
+
"resume",
|
|
1540
|
+
"scratch.js"
|
|
1541
|
+
],
|
|
1542
|
+
"aliasPermutations": [
|
|
1543
|
+
"env:resume:scratch",
|
|
1544
|
+
"resume:env:scratch",
|
|
1545
|
+
"resume:scratch:env",
|
|
1546
|
+
"env:scratch:resume",
|
|
1547
|
+
"scratch:env:resume",
|
|
1548
|
+
"scratch:resume:env"
|
|
1111
1549
|
],
|
|
1112
|
-
"aliasPermutations": [],
|
|
1113
1550
|
"permutations": [
|
|
1114
|
-
"org:
|
|
1115
|
-
"
|
|
1116
|
-
"
|
|
1117
|
-
"org:
|
|
1118
|
-
"
|
|
1119
|
-
"
|
|
1551
|
+
"org:resume:scratch",
|
|
1552
|
+
"resume:org:scratch",
|
|
1553
|
+
"resume:scratch:org",
|
|
1554
|
+
"org:scratch:resume",
|
|
1555
|
+
"scratch:org:resume",
|
|
1556
|
+
"scratch:resume:org"
|
|
1120
1557
|
]
|
|
1121
1558
|
},
|
|
1122
1559
|
"org:list:metadata-types": {
|
|
@@ -1377,444 +1814,7 @@
|
|
|
1377
1814
|
"metadata:org:list",
|
|
1378
1815
|
"metadata:list:org"
|
|
1379
1816
|
]
|
|
1380
|
-
},
|
|
1381
|
-
"org:open:agent": {
|
|
1382
|
-
"aliases": [],
|
|
1383
|
-
"args": {},
|
|
1384
|
-
"description": "Use the --name flag to open an agent using its API name in the Agent Builder UI of your org. To find the agent's API name, go to Setup in your org and navigate to the agent's details page.\n\nTo generate the URL but not launch it in your browser, specify --url-only.\n\nTo open Agent Builder in a specific browser, use the --browser flag. Supported browsers are \"chrome\", \"edge\", and \"firefox\". If you don't specify --browser, the org opens in your default browser.",
|
|
1385
|
-
"examples": [
|
|
1386
|
-
"Open the agent with API name Coral_Cloud_Agent in your default org using your default browser:\n$ <%= config.bin %> <%= command.id %> --name Coral_Cloud_Agent",
|
|
1387
|
-
"Open the agent in an incognito window of your default browser:\n$ <%= config.bin %> <%= command.id %> --private --name Coral_Cloud_Agent:",
|
|
1388
|
-
"Open the agent in an org with alias MyTestOrg1 using the Firefox browser:\n$ <%= config.bin %> <%= command.id %> --target-org MyTestOrg1 --browser firefox --name Coral_Cloud_Agent"
|
|
1389
|
-
],
|
|
1390
|
-
"flags": {
|
|
1391
|
-
"json": {
|
|
1392
|
-
"description": "Format output as json.",
|
|
1393
|
-
"helpGroup": "GLOBAL",
|
|
1394
|
-
"name": "json",
|
|
1395
|
-
"allowNo": false,
|
|
1396
|
-
"type": "boolean"
|
|
1397
|
-
},
|
|
1398
|
-
"flags-dir": {
|
|
1399
|
-
"helpGroup": "GLOBAL",
|
|
1400
|
-
"name": "flags-dir",
|
|
1401
|
-
"summary": "Import flag values from a directory.",
|
|
1402
|
-
"hasDynamicHelp": false,
|
|
1403
|
-
"multiple": false,
|
|
1404
|
-
"type": "option"
|
|
1405
|
-
},
|
|
1406
|
-
"target-org": {
|
|
1407
|
-
"char": "o",
|
|
1408
|
-
"name": "target-org",
|
|
1409
|
-
"noCacheDefault": true,
|
|
1410
|
-
"required": true,
|
|
1411
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1412
|
-
"hasDynamicHelp": true,
|
|
1413
|
-
"multiple": false,
|
|
1414
|
-
"type": "option"
|
|
1415
|
-
},
|
|
1416
|
-
"api-version": {
|
|
1417
|
-
"description": "Override the api version used for api requests made by this command",
|
|
1418
|
-
"name": "api-version",
|
|
1419
|
-
"hasDynamicHelp": false,
|
|
1420
|
-
"multiple": false,
|
|
1421
|
-
"type": "option"
|
|
1422
|
-
},
|
|
1423
|
-
"name": {
|
|
1424
|
-
"char": "n",
|
|
1425
|
-
"name": "name",
|
|
1426
|
-
"required": true,
|
|
1427
|
-
"summary": "API name, also known as developer name, of the agent you want to open in the org's Agent Builder UI.",
|
|
1428
|
-
"hasDynamicHelp": false,
|
|
1429
|
-
"multiple": false,
|
|
1430
|
-
"type": "option"
|
|
1431
|
-
},
|
|
1432
|
-
"private": {
|
|
1433
|
-
"exclusive": [
|
|
1434
|
-
"url-only",
|
|
1435
|
-
"browser"
|
|
1436
|
-
],
|
|
1437
|
-
"name": "private",
|
|
1438
|
-
"summary": "Open the org in the default browser using private (incognito) mode.",
|
|
1439
|
-
"allowNo": false,
|
|
1440
|
-
"type": "boolean"
|
|
1441
|
-
},
|
|
1442
|
-
"browser": {
|
|
1443
|
-
"char": "b",
|
|
1444
|
-
"exclusive": [
|
|
1445
|
-
"url-only",
|
|
1446
|
-
"private"
|
|
1447
|
-
],
|
|
1448
|
-
"name": "browser",
|
|
1449
|
-
"summary": "Browser where the org opens.",
|
|
1450
|
-
"hasDynamicHelp": false,
|
|
1451
|
-
"multiple": false,
|
|
1452
|
-
"options": [
|
|
1453
|
-
"chrome",
|
|
1454
|
-
"edge",
|
|
1455
|
-
"firefox"
|
|
1456
|
-
],
|
|
1457
|
-
"type": "option"
|
|
1458
|
-
},
|
|
1459
|
-
"url-only": {
|
|
1460
|
-
"aliases": [
|
|
1461
|
-
"urlonly"
|
|
1462
|
-
],
|
|
1463
|
-
"char": "r",
|
|
1464
|
-
"deprecateAliases": true,
|
|
1465
|
-
"name": "url-only",
|
|
1466
|
-
"summary": "Display navigation URL, but don’t launch browser.",
|
|
1467
|
-
"allowNo": false,
|
|
1468
|
-
"type": "boolean"
|
|
1469
|
-
}
|
|
1470
|
-
},
|
|
1471
|
-
"hasDynamicHelp": true,
|
|
1472
|
-
"hiddenAliases": [],
|
|
1473
|
-
"id": "org:open:agent",
|
|
1474
|
-
"pluginAlias": "@salesforce/plugin-org",
|
|
1475
|
-
"pluginName": "@salesforce/plugin-org",
|
|
1476
|
-
"pluginType": "core",
|
|
1477
|
-
"state": "beta",
|
|
1478
|
-
"strict": true,
|
|
1479
|
-
"summary": "Open an agent in your org's Agent Builder UI in a browser.",
|
|
1480
|
-
"enableJsonFlag": true,
|
|
1481
|
-
"isESM": true,
|
|
1482
|
-
"relativePath": [
|
|
1483
|
-
"lib",
|
|
1484
|
-
"commands",
|
|
1485
|
-
"org",
|
|
1486
|
-
"open",
|
|
1487
|
-
"agent.js"
|
|
1488
|
-
],
|
|
1489
|
-
"aliasPermutations": [],
|
|
1490
|
-
"permutations": [
|
|
1491
|
-
"org:open:agent",
|
|
1492
|
-
"open:org:agent",
|
|
1493
|
-
"open:agent:org",
|
|
1494
|
-
"org:agent:open",
|
|
1495
|
-
"agent:org:open",
|
|
1496
|
-
"agent:open:org"
|
|
1497
|
-
]
|
|
1498
|
-
},
|
|
1499
|
-
"org:refresh:sandbox": {
|
|
1500
|
-
"aliases": [],
|
|
1501
|
-
"args": {},
|
|
1502
|
-
"description": "Refreshing a sandbox copies the metadata, and optionally data, from your source org to the refreshed sandbox org. You can optionally specify a definition file if you want to change the configuration of the refreshed sandbox, such as its license type or template ID.\n\nYou're not allowed to change the sandbox name when you refresh it with this command. If you want to change the sandbox name, first delete it with the \"org delete sandbox\" command. And then recreate it with the \"org create sandbox\" command and give it a new name.",
|
|
1503
|
-
"examples": [
|
|
1504
|
-
"Refresh the sandbox named \"devSbx1\". The production org that contains the sandbox license has the alias \"prodOrg\".\n<%= config.bin %> <%= command.id %> --name devSbx1 --target-org prodOrg",
|
|
1505
|
-
"Refresh the sandbox named \"devSbx2\", and override the configuration of the refreshed sandbox with the properties in the specified defintion file. The default target org is the production org, so you don't need to specify the `--target-org` flag in this case.\n<%= config.bin %> <%= command.id %> --name devSbx2 --definition-file devSbx2-config.json",
|
|
1506
|
-
"Refresh the sandbox using the name defined in the definition file. The production org that contains the sandbox license has the alias \"prodOrg\".\n<%= config.bin %> <%= command.id %> --definition-file devSbx3-config.json --target-org prodOrg"
|
|
1507
|
-
],
|
|
1508
|
-
"flags": {
|
|
1509
|
-
"json": {
|
|
1510
|
-
"description": "Format output as json.",
|
|
1511
|
-
"helpGroup": "GLOBAL",
|
|
1512
|
-
"name": "json",
|
|
1513
|
-
"allowNo": false,
|
|
1514
|
-
"type": "boolean"
|
|
1515
|
-
},
|
|
1516
|
-
"flags-dir": {
|
|
1517
|
-
"helpGroup": "GLOBAL",
|
|
1518
|
-
"name": "flags-dir",
|
|
1519
|
-
"summary": "Import flag values from a directory.",
|
|
1520
|
-
"hasDynamicHelp": false,
|
|
1521
|
-
"multiple": false,
|
|
1522
|
-
"type": "option"
|
|
1523
|
-
},
|
|
1524
|
-
"no-auto-activate": {
|
|
1525
|
-
"description": "By default, a sandbox auto-activates after a refresh. Use this flag to control sandbox activation manually.",
|
|
1526
|
-
"name": "no-auto-activate",
|
|
1527
|
-
"summary": "Disable auto-activation of the sandbox after a successful refresh.",
|
|
1528
|
-
"allowNo": false,
|
|
1529
|
-
"type": "boolean"
|
|
1530
|
-
},
|
|
1531
|
-
"wait": {
|
|
1532
|
-
"char": "w",
|
|
1533
|
-
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal to you and displays the \"<%= config.bin %> org resume sandbox\" command for you run to check the status of the refresh. The displayed command includes the job ID for the running sandbox refresh.",
|
|
1534
|
-
"exclusive": [
|
|
1535
|
-
"async"
|
|
1536
|
-
],
|
|
1537
|
-
"name": "wait",
|
|
1538
|
-
"summary": "Number of minutes to poll for sandbox refresh status.",
|
|
1539
|
-
"hasDynamicHelp": true,
|
|
1540
|
-
"helpValue": "<minutes>",
|
|
1541
|
-
"multiple": false,
|
|
1542
|
-
"type": "option"
|
|
1543
|
-
},
|
|
1544
|
-
"poll-interval": {
|
|
1545
|
-
"char": "i",
|
|
1546
|
-
"exclusive": [
|
|
1547
|
-
"async"
|
|
1548
|
-
],
|
|
1549
|
-
"name": "poll-interval",
|
|
1550
|
-
"summary": "Number of seconds to wait between status polling requests.",
|
|
1551
|
-
"hasDynamicHelp": true,
|
|
1552
|
-
"helpValue": "<seconds>",
|
|
1553
|
-
"multiple": false,
|
|
1554
|
-
"type": "option"
|
|
1555
|
-
},
|
|
1556
|
-
"async": {
|
|
1557
|
-
"description": "The command immediately displays the job ID and returns control of the terminal to you. This way, you can continue to use the CLI. To check the status of the sandbox refresh, run \"<%= config.bin %> org resume sandbox\".",
|
|
1558
|
-
"exclusive": [
|
|
1559
|
-
"wait",
|
|
1560
|
-
"poll-interval"
|
|
1561
|
-
],
|
|
1562
|
-
"name": "async",
|
|
1563
|
-
"summary": "Request the sandbox refresh, but don't wait for it to complete.",
|
|
1564
|
-
"allowNo": false,
|
|
1565
|
-
"type": "boolean"
|
|
1566
|
-
},
|
|
1567
|
-
"name": {
|
|
1568
|
-
"char": "n",
|
|
1569
|
-
"name": "name",
|
|
1570
|
-
"summary": "Name of the existing sandbox org in your production org that you want to refresh.",
|
|
1571
|
-
"hasDynamicHelp": false,
|
|
1572
|
-
"multiple": false,
|
|
1573
|
-
"type": "option"
|
|
1574
|
-
},
|
|
1575
|
-
"definition-file": {
|
|
1576
|
-
"char": "f",
|
|
1577
|
-
"description": "The sandbox definition file is a blueprint for the sandbox; use the file to change the sandbox configuration during a refresh. If you don't want to change the sandbox configuration when you refresh it, then simply use the --name flag to specify the sandbox and don't use this flag. See <https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_sandbox_definition.htm> for all the options you can specify in the definition file.",
|
|
1578
|
-
"name": "definition-file",
|
|
1579
|
-
"summary": "Path to a sandbox definition file for overriding its configuration when you refresh it.",
|
|
1580
|
-
"hasDynamicHelp": false,
|
|
1581
|
-
"multiple": false,
|
|
1582
|
-
"type": "option"
|
|
1583
|
-
},
|
|
1584
|
-
"target-org": {
|
|
1585
|
-
"char": "o",
|
|
1586
|
-
"name": "target-org",
|
|
1587
|
-
"noCacheDefault": true,
|
|
1588
|
-
"required": true,
|
|
1589
|
-
"summary": "Username or alias of the production org that contains the sandbox license.",
|
|
1590
|
-
"hasDynamicHelp": true,
|
|
1591
|
-
"multiple": false,
|
|
1592
|
-
"type": "option"
|
|
1593
|
-
},
|
|
1594
|
-
"no-prompt": {
|
|
1595
|
-
"name": "no-prompt",
|
|
1596
|
-
"summary": "Don't prompt for confirmation about the sandbox refresh.",
|
|
1597
|
-
"allowNo": false,
|
|
1598
|
-
"type": "boolean"
|
|
1599
|
-
}
|
|
1600
|
-
},
|
|
1601
|
-
"hasDynamicHelp": true,
|
|
1602
|
-
"hiddenAliases": [],
|
|
1603
|
-
"id": "org:refresh:sandbox",
|
|
1604
|
-
"pluginAlias": "@salesforce/plugin-org",
|
|
1605
|
-
"pluginName": "@salesforce/plugin-org",
|
|
1606
|
-
"pluginType": "core",
|
|
1607
|
-
"strict": true,
|
|
1608
|
-
"summary": "Refresh a sandbox org using the sandbox name.",
|
|
1609
|
-
"isESM": true,
|
|
1610
|
-
"relativePath": [
|
|
1611
|
-
"lib",
|
|
1612
|
-
"commands",
|
|
1613
|
-
"org",
|
|
1614
|
-
"refresh",
|
|
1615
|
-
"sandbox.js"
|
|
1616
|
-
],
|
|
1617
|
-
"aliasPermutations": [],
|
|
1618
|
-
"permutations": [
|
|
1619
|
-
"org:refresh:sandbox",
|
|
1620
|
-
"refresh:org:sandbox",
|
|
1621
|
-
"refresh:sandbox:org",
|
|
1622
|
-
"org:sandbox:refresh",
|
|
1623
|
-
"sandbox:org:refresh",
|
|
1624
|
-
"sandbox:refresh:org"
|
|
1625
|
-
]
|
|
1626
|
-
},
|
|
1627
|
-
"org:resume:sandbox": {
|
|
1628
|
-
"aliases": [
|
|
1629
|
-
"env:resume:sandbox"
|
|
1630
|
-
],
|
|
1631
|
-
"args": {},
|
|
1632
|
-
"deprecateAliases": true,
|
|
1633
|
-
"description": "Sandbox creation can take a long time. If the original \"<%= config.bin %> org create sandbox\" command either times out, or you specified the --async flag, the command displays a job ID. Use this job ID to check whether the sandbox creation is complete, and if it is, the command then logs into it.\n\nYou can also use the sandbox name to check the status or the --use-most-recent flag to use the job ID of the most recent sandbox creation.",
|
|
1634
|
-
"examples": [
|
|
1635
|
-
"Check the status of a sandbox creation using its name and specify a production org with alias \"prodOrg\":\n<%= config.bin %> <%= command.id %> --name mysandbox --target-org prodOrg",
|
|
1636
|
-
"Check the status using the job ID:\n<%= config.bin %> <%= command.id %> --job-id 0GRxxxxxxxx",
|
|
1637
|
-
"Check the status of the most recent sandbox create request:\n<%= config.bin %> <%= command.id %> --use-most-recent"
|
|
1638
|
-
],
|
|
1639
|
-
"flags": {
|
|
1640
|
-
"json": {
|
|
1641
|
-
"description": "Format output as json.",
|
|
1642
|
-
"helpGroup": "GLOBAL",
|
|
1643
|
-
"name": "json",
|
|
1644
|
-
"allowNo": false,
|
|
1645
|
-
"type": "boolean"
|
|
1646
|
-
},
|
|
1647
|
-
"flags-dir": {
|
|
1648
|
-
"helpGroup": "GLOBAL",
|
|
1649
|
-
"name": "flags-dir",
|
|
1650
|
-
"summary": "Import flag values from a directory.",
|
|
1651
|
-
"hasDynamicHelp": false,
|
|
1652
|
-
"multiple": false,
|
|
1653
|
-
"type": "option"
|
|
1654
|
-
},
|
|
1655
|
-
"wait": {
|
|
1656
|
-
"char": "w",
|
|
1657
|
-
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To resume checking the sandbox creation, rerun this command.",
|
|
1658
|
-
"name": "wait",
|
|
1659
|
-
"summary": "Number of minutes to wait for the sandbox org to be ready.",
|
|
1660
|
-
"default": "0 minutes",
|
|
1661
|
-
"hasDynamicHelp": true,
|
|
1662
|
-
"helpValue": "<minutes>",
|
|
1663
|
-
"multiple": false,
|
|
1664
|
-
"type": "option"
|
|
1665
|
-
},
|
|
1666
|
-
"name": {
|
|
1667
|
-
"char": "n",
|
|
1668
|
-
"exclusive": [
|
|
1669
|
-
"job-id"
|
|
1670
|
-
],
|
|
1671
|
-
"name": "name",
|
|
1672
|
-
"summary": "Name of the sandbox org.",
|
|
1673
|
-
"hasDynamicHelp": false,
|
|
1674
|
-
"multiple": false,
|
|
1675
|
-
"type": "option"
|
|
1676
|
-
},
|
|
1677
|
-
"job-id": {
|
|
1678
|
-
"char": "i",
|
|
1679
|
-
"description": "The job ID is valid for 24 hours after you start the sandbox creation.",
|
|
1680
|
-
"exclusive": [
|
|
1681
|
-
"name"
|
|
1682
|
-
],
|
|
1683
|
-
"name": "job-id",
|
|
1684
|
-
"summary": "Job ID of the incomplete sandbox creation that you want to check the status of.",
|
|
1685
|
-
"hasDynamicHelp": false,
|
|
1686
|
-
"multiple": false,
|
|
1687
|
-
"type": "option"
|
|
1688
|
-
},
|
|
1689
|
-
"use-most-recent": {
|
|
1690
|
-
"char": "l",
|
|
1691
|
-
"name": "use-most-recent",
|
|
1692
|
-
"summary": "Use the most recent sandbox create request.",
|
|
1693
|
-
"allowNo": false,
|
|
1694
|
-
"type": "boolean"
|
|
1695
|
-
},
|
|
1696
|
-
"target-org": {
|
|
1697
|
-
"char": "o",
|
|
1698
|
-
"description": "When it creates the sandbox org, Salesforce copies the metadata, and optionally data, from your production org to the new sandbox org.",
|
|
1699
|
-
"name": "target-org",
|
|
1700
|
-
"noCacheDefault": true,
|
|
1701
|
-
"summary": "Username or alias of the production org that contains the sandbox license.",
|
|
1702
|
-
"hasDynamicHelp": true,
|
|
1703
|
-
"multiple": false,
|
|
1704
|
-
"type": "option"
|
|
1705
|
-
}
|
|
1706
|
-
},
|
|
1707
|
-
"hasDynamicHelp": true,
|
|
1708
|
-
"hiddenAliases": [],
|
|
1709
|
-
"id": "org:resume:sandbox",
|
|
1710
|
-
"pluginAlias": "@salesforce/plugin-org",
|
|
1711
|
-
"pluginName": "@salesforce/plugin-org",
|
|
1712
|
-
"pluginType": "core",
|
|
1713
|
-
"strict": true,
|
|
1714
|
-
"summary": "Check the status of a sandbox creation, and log in to it if it's ready.",
|
|
1715
|
-
"isESM": true,
|
|
1716
|
-
"relativePath": [
|
|
1717
|
-
"lib",
|
|
1718
|
-
"commands",
|
|
1719
|
-
"org",
|
|
1720
|
-
"resume",
|
|
1721
|
-
"sandbox.js"
|
|
1722
|
-
],
|
|
1723
|
-
"aliasPermutations": [
|
|
1724
|
-
"env:resume:sandbox",
|
|
1725
|
-
"resume:env:sandbox",
|
|
1726
|
-
"resume:sandbox:env",
|
|
1727
|
-
"env:sandbox:resume",
|
|
1728
|
-
"sandbox:env:resume",
|
|
1729
|
-
"sandbox:resume:env"
|
|
1730
|
-
],
|
|
1731
|
-
"permutations": [
|
|
1732
|
-
"org:resume:sandbox",
|
|
1733
|
-
"resume:org:sandbox",
|
|
1734
|
-
"resume:sandbox:org",
|
|
1735
|
-
"org:sandbox:resume",
|
|
1736
|
-
"sandbox:org:resume",
|
|
1737
|
-
"sandbox:resume:org"
|
|
1738
|
-
]
|
|
1739
|
-
},
|
|
1740
|
-
"org:resume:scratch": {
|
|
1741
|
-
"aliases": [
|
|
1742
|
-
"env:resume:scratch"
|
|
1743
|
-
],
|
|
1744
|
-
"args": {},
|
|
1745
|
-
"deprecateAliases": true,
|
|
1746
|
-
"description": "When the original \"<%= config.bin %> org create scratch\" command either times out or is run with the --async flag, it displays a job ID.\n\nRun this command by either passing it a job ID or using the --use-most-recent flag to specify the most recent incomplete scratch org.",
|
|
1747
|
-
"examples": [
|
|
1748
|
-
"Resume a scratch org create with a job ID:\n<%= config.bin %> <%= command.id %> --job-id 2SR3u0000008fBDGAY",
|
|
1749
|
-
"Resume your most recent incomplete scratch org:\n<%= config.bin %> <%= command.id %> --use-most-recent"
|
|
1750
|
-
],
|
|
1751
|
-
"flags": {
|
|
1752
|
-
"json": {
|
|
1753
|
-
"description": "Format output as json.",
|
|
1754
|
-
"helpGroup": "GLOBAL",
|
|
1755
|
-
"name": "json",
|
|
1756
|
-
"allowNo": false,
|
|
1757
|
-
"type": "boolean"
|
|
1758
|
-
},
|
|
1759
|
-
"flags-dir": {
|
|
1760
|
-
"helpGroup": "GLOBAL",
|
|
1761
|
-
"name": "flags-dir",
|
|
1762
|
-
"summary": "Import flag values from a directory.",
|
|
1763
|
-
"hasDynamicHelp": false,
|
|
1764
|
-
"multiple": false,
|
|
1765
|
-
"type": "option"
|
|
1766
|
-
},
|
|
1767
|
-
"job-id": {
|
|
1768
|
-
"char": "i",
|
|
1769
|
-
"description": "The job ID is the same as the record ID of the incomplete scratch org in the ScratchOrgInfo object of the Dev Hub.\n\nThe job ID is valid for 24 hours after you start the scratch org creation.",
|
|
1770
|
-
"name": "job-id",
|
|
1771
|
-
"summary": "Job ID of the incomplete scratch org create that you want to resume.",
|
|
1772
|
-
"hasDynamicHelp": false,
|
|
1773
|
-
"multiple": false,
|
|
1774
|
-
"type": "option"
|
|
1775
|
-
},
|
|
1776
|
-
"use-most-recent": {
|
|
1777
|
-
"char": "r",
|
|
1778
|
-
"name": "use-most-recent",
|
|
1779
|
-
"summary": "Use the job ID of the most recent incomplete scratch org.",
|
|
1780
|
-
"allowNo": false,
|
|
1781
|
-
"type": "boolean"
|
|
1782
|
-
}
|
|
1783
|
-
},
|
|
1784
|
-
"hasDynamicHelp": false,
|
|
1785
|
-
"hiddenAliases": [],
|
|
1786
|
-
"id": "org:resume:scratch",
|
|
1787
|
-
"pluginAlias": "@salesforce/plugin-org",
|
|
1788
|
-
"pluginName": "@salesforce/plugin-org",
|
|
1789
|
-
"pluginType": "core",
|
|
1790
|
-
"strict": true,
|
|
1791
|
-
"summary": "Resume the creation of an incomplete scratch org.",
|
|
1792
|
-
"enableJsonFlag": true,
|
|
1793
|
-
"isESM": true,
|
|
1794
|
-
"relativePath": [
|
|
1795
|
-
"lib",
|
|
1796
|
-
"commands",
|
|
1797
|
-
"org",
|
|
1798
|
-
"resume",
|
|
1799
|
-
"scratch.js"
|
|
1800
|
-
],
|
|
1801
|
-
"aliasPermutations": [
|
|
1802
|
-
"env:resume:scratch",
|
|
1803
|
-
"resume:env:scratch",
|
|
1804
|
-
"resume:scratch:env",
|
|
1805
|
-
"env:scratch:resume",
|
|
1806
|
-
"scratch:env:resume",
|
|
1807
|
-
"scratch:resume:env"
|
|
1808
|
-
],
|
|
1809
|
-
"permutations": [
|
|
1810
|
-
"org:resume:scratch",
|
|
1811
|
-
"resume:org:scratch",
|
|
1812
|
-
"resume:scratch:org",
|
|
1813
|
-
"org:scratch:resume",
|
|
1814
|
-
"scratch:org:resume",
|
|
1815
|
-
"scratch:resume:org"
|
|
1816
|
-
]
|
|
1817
1817
|
}
|
|
1818
1818
|
},
|
|
1819
|
-
"version": "5.2.
|
|
1819
|
+
"version": "5.2.42"
|
|
1820
1820
|
}
|