@salesforce/plugin-org 5.9.62 → 5.9.63

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 CHANGED
@@ -248,7 +248,7 @@ FLAG DESCRIPTIONS
248
248
  You can specify either --source-sandbox-name or --source-id when cloning an existing sandbox, but not both.
249
249
  ```
250
250
 
251
- _See code: [src/commands/org/create/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.62/src/commands/org/create/sandbox.ts)_
251
+ _See code: [src/commands/org/create/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.63/src/commands/org/create/sandbox.ts)_
252
252
 
253
253
  ## `sf org create scratch`
254
254
 
@@ -430,7 +430,7 @@ FLAG DESCRIPTIONS
430
430
  Omit this flag to have Salesforce generate a unique username for your org.
431
431
  ```
432
432
 
433
- _See code: [src/commands/org/create/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.62/src/commands/org/create/scratch.ts)_
433
+ _See code: [src/commands/org/create/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.63/src/commands/org/create/scratch.ts)_
434
434
 
435
435
  ## `sf org delete sandbox`
436
436
 
@@ -476,7 +476,7 @@ EXAMPLES
476
476
  $ sf org delete sandbox --target-org my-sandbox --no-prompt
477
477
  ```
478
478
 
479
- _See code: [src/commands/org/delete/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.62/src/commands/org/delete/sandbox.ts)_
479
+ _See code: [src/commands/org/delete/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.63/src/commands/org/delete/sandbox.ts)_
480
480
 
481
481
  ## `sf org delete scratch`
482
482
 
@@ -520,7 +520,7 @@ EXAMPLES
520
520
  $ sf org delete scratch --target-org my-scratch-org --no-prompt
521
521
  ```
522
522
 
523
- _See code: [src/commands/org/delete/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.62/src/commands/org/delete/scratch.ts)_
523
+ _See code: [src/commands/org/delete/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.63/src/commands/org/delete/scratch.ts)_
524
524
 
525
525
  ## `sf org disable tracking`
526
526
 
@@ -559,7 +559,7 @@ EXAMPLES
559
559
  $ sf org disable tracking
560
560
  ```
561
561
 
562
- _See code: [src/commands/org/disable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.62/src/commands/org/disable/tracking.ts)_
562
+ _See code: [src/commands/org/disable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.63/src/commands/org/disable/tracking.ts)_
563
563
 
564
564
  ## `sf org display`
565
565
 
@@ -604,7 +604,7 @@ EXAMPLES
604
604
  $ sf org display --target-org TestOrg1 --verbose
605
605
  ```
606
606
 
607
- _See code: [src/commands/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.62/src/commands/org/display.ts)_
607
+ _See code: [src/commands/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.63/src/commands/org/display.ts)_
608
608
 
609
609
  ## `sf org enable tracking`
610
610
 
@@ -646,7 +646,7 @@ EXAMPLES
646
646
  $ sf org enable tracking
647
647
  ```
648
648
 
649
- _See code: [src/commands/org/enable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.62/src/commands/org/enable/tracking.ts)_
649
+ _See code: [src/commands/org/enable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.63/src/commands/org/enable/tracking.ts)_
650
650
 
651
651
  ## `sf org list`
652
652
 
@@ -685,7 +685,7 @@ EXAMPLES
685
685
  $ sf org list --clean
686
686
  ```
687
687
 
688
- _See code: [src/commands/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.62/src/commands/org/list.ts)_
688
+ _See code: [src/commands/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.63/src/commands/org/list.ts)_
689
689
 
690
690
  ## `sf org list metadata`
691
691
 
@@ -752,7 +752,7 @@ FLAG DESCRIPTIONS
752
752
  Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.
753
753
  ```
754
754
 
755
- _See code: [src/commands/org/list/metadata.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.62/src/commands/org/list/metadata.ts)_
755
+ _See code: [src/commands/org/list/metadata.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.63/src/commands/org/list/metadata.ts)_
756
756
 
757
757
  ## `sf org list metadata-types`
758
758
 
@@ -807,7 +807,7 @@ FLAG DESCRIPTIONS
807
807
  Override the api version used for api requests made by this command
808
808
  ```
809
809
 
810
- _See code: [src/commands/org/list/metadata-types.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.62/src/commands/org/list/metadata-types.ts)_
810
+ _See code: [src/commands/org/list/metadata-types.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.63/src/commands/org/list/metadata-types.ts)_
811
811
 
812
812
  ## `sf org open`
813
813
 
@@ -883,7 +883,7 @@ EXAMPLES
883
883
  $ sf org open --source-file force-app/main/default/bots/Coral_Cloud_Agent/Coral_Cloud_Agent.bot-meta.xml
884
884
  ```
885
885
 
886
- _See code: [src/commands/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.62/src/commands/org/open.ts)_
886
+ _See code: [src/commands/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.63/src/commands/org/open.ts)_
887
887
 
888
888
  ## `sf org open agent`
889
889
 
@@ -934,11 +934,11 @@ EXAMPLES
934
934
  $ sf org open agent --target-org MyTestOrg1 --browser firefox --api-name Coral_Cloud_Agent
935
935
  ```
936
936
 
937
- _See code: [src/commands/org/open/agent.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.62/src/commands/org/open/agent.ts)_
937
+ _See code: [src/commands/org/open/agent.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.63/src/commands/org/open/agent.ts)_
938
938
 
939
939
  ## `sf org open authoring-bundle`
940
940
 
941
- Open your org in Agentforce Studio, specically in the list view showing the list of agents.
941
+ Open your org in Agentforce Studio, specifically in the list view showing the list of agents.
942
942
 
943
943
  ```
944
944
  USAGE
@@ -959,7 +959,7 @@ GLOBAL FLAGS
959
959
  --json Format output as json.
960
960
 
961
961
  DESCRIPTION
962
- Open your org in Agentforce Studio, specically in the list view showing the list of agents.
962
+ Open your org in Agentforce Studio, specifically in the list view showing the list of agents.
963
963
 
964
964
  The list view shows the agents in your org that are implemented with Agent Script and an authoring bundle. Click on an
965
965
  agent name to open it in Agentforce Builder in a new browser window.
@@ -980,7 +980,7 @@ EXAMPLES
980
980
  $ sf org open authoring-bundle --target-org MyTestOrg1 --browser firefox
981
981
  ```
982
982
 
983
- _See code: [src/commands/org/open/authoring-bundle.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.62/src/commands/org/open/authoring-bundle.ts)_
983
+ _See code: [src/commands/org/open/authoring-bundle.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.63/src/commands/org/open/authoring-bundle.ts)_
984
984
 
985
985
  ## `sf org refresh sandbox`
986
986
 
@@ -1083,7 +1083,7 @@ FLAG DESCRIPTIONS
1083
1083
  You can specify either --source-sandbox-name or --source-id when refreshing an existing sandbox, but not both.
1084
1084
  ```
1085
1085
 
1086
- _See code: [src/commands/org/refresh/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.62/src/commands/org/refresh/sandbox.ts)_
1086
+ _See code: [src/commands/org/refresh/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.63/src/commands/org/refresh/sandbox.ts)_
1087
1087
 
1088
1088
  ## `sf org resume sandbox`
1089
1089
 
@@ -1146,7 +1146,7 @@ FLAG DESCRIPTIONS
1146
1146
  returns the job ID. To resume checking the sandbox creation, rerun this command.
1147
1147
  ```
1148
1148
 
1149
- _See code: [src/commands/org/resume/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.62/src/commands/org/resume/sandbox.ts)_
1149
+ _See code: [src/commands/org/resume/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.63/src/commands/org/resume/sandbox.ts)_
1150
1150
 
1151
1151
  ## `sf org resume scratch`
1152
1152
 
@@ -1199,6 +1199,6 @@ FLAG DESCRIPTIONS
1199
1199
  returns the job ID. To resume checking the scratch creation, rerun this command.
1200
1200
  ```
1201
1201
 
1202
- _See code: [src/commands/org/resume/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.62/src/commands/org/resume/scratch.ts)_
1202
+ _See code: [src/commands/org/resume/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.63/src/commands/org/resume/scratch.ts)_
1203
1203
 
1204
1204
  <!-- commandsstop -->
@@ -1,6 +1,6 @@
1
1
  # summary
2
2
 
3
- Open your org in Agentforce Studio, specically in the list view showing the list of agents.
3
+ Open your org in Agentforce Studio, specifically in the list view showing the list of agents.
4
4
 
5
5
  # description
6
6
 
@@ -851,6 +851,69 @@
851
851
  "scratch:create:org"
852
852
  ]
853
853
  },
854
+ "org:disable:tracking": {
855
+ "aliases": [],
856
+ "args": {},
857
+ "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.",
858
+ "examples": [
859
+ "Disable source tracking for an org with alias \"myscratch\":\n<%= config.bin %> <%= command.id %> --target-org myscratch",
860
+ "Disable source tracking for an org using a username:\n<%= config.bin %> <%= command.id %> --target-org you@example.com",
861
+ "Disable source tracking for your default org:\n<%= config.bin %> <%= command.id %>"
862
+ ],
863
+ "flags": {
864
+ "json": {
865
+ "description": "Format output as json.",
866
+ "helpGroup": "GLOBAL",
867
+ "name": "json",
868
+ "allowNo": false,
869
+ "type": "boolean"
870
+ },
871
+ "flags-dir": {
872
+ "helpGroup": "GLOBAL",
873
+ "name": "flags-dir",
874
+ "summary": "Import flag values from a directory.",
875
+ "hasDynamicHelp": false,
876
+ "multiple": false,
877
+ "type": "option"
878
+ },
879
+ "target-org": {
880
+ "char": "o",
881
+ "name": "target-org",
882
+ "noCacheDefault": true,
883
+ "required": true,
884
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
885
+ "hasDynamicHelp": true,
886
+ "multiple": false,
887
+ "type": "option"
888
+ }
889
+ },
890
+ "hasDynamicHelp": true,
891
+ "hiddenAliases": [],
892
+ "id": "org:disable:tracking",
893
+ "pluginAlias": "@salesforce/plugin-org",
894
+ "pluginName": "@salesforce/plugin-org",
895
+ "pluginType": "core",
896
+ "strict": true,
897
+ "summary": "Prevent Salesforce CLI from tracking changes in your source files between your project and an org.",
898
+ "enableJsonFlag": true,
899
+ "isESM": true,
900
+ "relativePath": [
901
+ "lib",
902
+ "commands",
903
+ "org",
904
+ "disable",
905
+ "tracking.js"
906
+ ],
907
+ "aliasPermutations": [],
908
+ "permutations": [
909
+ "org:disable:tracking",
910
+ "disable:org:tracking",
911
+ "disable:tracking:org",
912
+ "org:tracking:disable",
913
+ "tracking:org:disable",
914
+ "tracking:disable:org"
915
+ ]
916
+ },
854
917
  "org:delete:sandbox": {
855
918
  "aliases": [
856
919
  "env:delete:sandbox"
@@ -1019,69 +1082,6 @@
1019
1082
  "scratch:delete:org"
1020
1083
  ]
1021
1084
  },
1022
- "org:disable:tracking": {
1023
- "aliases": [],
1024
- "args": {},
1025
- "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.",
1026
- "examples": [
1027
- "Disable source tracking for an org with alias \"myscratch\":\n<%= config.bin %> <%= command.id %> --target-org myscratch",
1028
- "Disable source tracking for an org using a username:\n<%= config.bin %> <%= command.id %> --target-org you@example.com",
1029
- "Disable source tracking for your default org:\n<%= config.bin %> <%= command.id %>"
1030
- ],
1031
- "flags": {
1032
- "json": {
1033
- "description": "Format output as json.",
1034
- "helpGroup": "GLOBAL",
1035
- "name": "json",
1036
- "allowNo": false,
1037
- "type": "boolean"
1038
- },
1039
- "flags-dir": {
1040
- "helpGroup": "GLOBAL",
1041
- "name": "flags-dir",
1042
- "summary": "Import flag values from a directory.",
1043
- "hasDynamicHelp": false,
1044
- "multiple": false,
1045
- "type": "option"
1046
- },
1047
- "target-org": {
1048
- "char": "o",
1049
- "name": "target-org",
1050
- "noCacheDefault": true,
1051
- "required": true,
1052
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1053
- "hasDynamicHelp": true,
1054
- "multiple": false,
1055
- "type": "option"
1056
- }
1057
- },
1058
- "hasDynamicHelp": true,
1059
- "hiddenAliases": [],
1060
- "id": "org:disable:tracking",
1061
- "pluginAlias": "@salesforce/plugin-org",
1062
- "pluginName": "@salesforce/plugin-org",
1063
- "pluginType": "core",
1064
- "strict": true,
1065
- "summary": "Prevent Salesforce CLI from tracking changes in your source files between your project and an org.",
1066
- "enableJsonFlag": true,
1067
- "isESM": true,
1068
- "relativePath": [
1069
- "lib",
1070
- "commands",
1071
- "org",
1072
- "disable",
1073
- "tracking.js"
1074
- ],
1075
- "aliasPermutations": [],
1076
- "permutations": [
1077
- "org:disable:tracking",
1078
- "disable:org:tracking",
1079
- "disable:tracking:org",
1080
- "org:tracking:disable",
1081
- "tracking:org:disable",
1082
- "tracking:disable:org"
1083
- ]
1084
- },
1085
1085
  "org:enable:tracking": {
1086
1086
  "aliases": [],
1087
1087
  "args": {},
@@ -1404,157 +1404,6 @@
1404
1404
  "metadata:list:org"
1405
1405
  ]
1406
1406
  },
1407
- "org:refresh:sandbox": {
1408
- "aliases": [],
1409
- "args": {},
1410
- "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. You can also use the --source-id or --source-sandbox-name flags to change the refreshed sandbox org's original source org to a new org; in this case, the refreshed sandbox org's metadata is updated with the new source org's metadata.\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.",
1411
- "examples": [
1412
- "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",
1413
- "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",
1414
- "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",
1415
- "Refresh the sandbox named \"devSbx2\" by changing its original source org to be a sandbox called \"devSbx3\":\n<%= config.bin %> <%= command.id %> --name devSbx2 --source-sandbox-name devSbx3 --target-org prodOrg"
1416
- ],
1417
- "flags": {
1418
- "json": {
1419
- "description": "Format output as json.",
1420
- "helpGroup": "GLOBAL",
1421
- "name": "json",
1422
- "allowNo": false,
1423
- "type": "boolean"
1424
- },
1425
- "flags-dir": {
1426
- "helpGroup": "GLOBAL",
1427
- "name": "flags-dir",
1428
- "summary": "Import flag values from a directory.",
1429
- "hasDynamicHelp": false,
1430
- "multiple": false,
1431
- "type": "option"
1432
- },
1433
- "no-auto-activate": {
1434
- "description": "By default, a sandbox auto-activates after a refresh. Use this flag to control sandbox activation manually.",
1435
- "name": "no-auto-activate",
1436
- "summary": "Disable auto-activation of the sandbox after a successful refresh.",
1437
- "allowNo": false,
1438
- "type": "boolean"
1439
- },
1440
- "wait": {
1441
- "char": "w",
1442
- "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.",
1443
- "exclusive": [
1444
- "async"
1445
- ],
1446
- "name": "wait",
1447
- "summary": "Number of minutes to poll for sandbox refresh status.",
1448
- "hasDynamicHelp": true,
1449
- "helpValue": "<minutes>",
1450
- "multiple": false,
1451
- "type": "option"
1452
- },
1453
- "poll-interval": {
1454
- "char": "i",
1455
- "exclusive": [
1456
- "async"
1457
- ],
1458
- "name": "poll-interval",
1459
- "summary": "Number of seconds to wait between status polling requests.",
1460
- "hasDynamicHelp": true,
1461
- "helpValue": "<seconds>",
1462
- "multiple": false,
1463
- "type": "option"
1464
- },
1465
- "source-sandbox-name": {
1466
- "description": "The value of --source-sandbox-name must be an existing sandbox. The new source sandbox, and the refreshed sandbox specified with the --name flag, must both be associated with the production org (--target-org) that contains the sandbox licenses.\n\nYou can specify either --source-sandbox-name or --source-id when refreshing an existing sandbox, but not both.",
1467
- "exclusive": [
1468
- "source-id"
1469
- ],
1470
- "name": "source-sandbox-name",
1471
- "summary": "Name of the sandbox org that becomes the new source org for the refreshed sandbox.",
1472
- "hasDynamicHelp": false,
1473
- "multiple": false,
1474
- "type": "option"
1475
- },
1476
- "source-id": {
1477
- "description": "The value of --source-id must be an existing sandbox. The new source sandbox, and the refreshed sandbox specified with the --name flag, must both be associated with the production org (--target-org) that contains the sandbox licenses.\n\nYou can specify either --source-id or --source-sandbox-name when refreshing an existing sandbox, but not both.",
1478
- "exclusive": [
1479
- "source-sandbox-name"
1480
- ],
1481
- "name": "source-id",
1482
- "summary": "ID of the sandbox org that becomes the new source org for the refreshed sandbox.",
1483
- "hasDynamicHelp": false,
1484
- "multiple": false,
1485
- "type": "option"
1486
- },
1487
- "async": {
1488
- "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\".",
1489
- "exclusive": [
1490
- "wait",
1491
- "poll-interval"
1492
- ],
1493
- "name": "async",
1494
- "summary": "Request the sandbox refresh, but don't wait for it to complete.",
1495
- "allowNo": false,
1496
- "type": "boolean"
1497
- },
1498
- "name": {
1499
- "char": "n",
1500
- "name": "name",
1501
- "summary": "Name of the existing sandbox org in your production org that you want to refresh.",
1502
- "hasDynamicHelp": false,
1503
- "multiple": false,
1504
- "type": "option"
1505
- },
1506
- "definition-file": {
1507
- "char": "f",
1508
- "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.",
1509
- "name": "definition-file",
1510
- "summary": "Path to a sandbox definition file for overriding its configuration when you refresh it.",
1511
- "hasDynamicHelp": false,
1512
- "multiple": false,
1513
- "type": "option"
1514
- },
1515
- "target-org": {
1516
- "char": "o",
1517
- "name": "target-org",
1518
- "noCacheDefault": true,
1519
- "required": true,
1520
- "summary": "Username or alias of the production org that contains the sandbox license.",
1521
- "hasDynamicHelp": true,
1522
- "multiple": false,
1523
- "type": "option"
1524
- },
1525
- "no-prompt": {
1526
- "name": "no-prompt",
1527
- "summary": "Don't prompt for confirmation about the sandbox refresh.",
1528
- "allowNo": false,
1529
- "type": "boolean"
1530
- }
1531
- },
1532
- "hasDynamicHelp": true,
1533
- "hiddenAliases": [],
1534
- "id": "org:refresh:sandbox",
1535
- "pluginAlias": "@salesforce/plugin-org",
1536
- "pluginName": "@salesforce/plugin-org",
1537
- "pluginType": "core",
1538
- "strict": true,
1539
- "summary": "Refresh a sandbox org using the sandbox name.",
1540
- "isESM": true,
1541
- "relativePath": [
1542
- "lib",
1543
- "commands",
1544
- "org",
1545
- "refresh",
1546
- "sandbox.js"
1547
- ],
1548
- "aliasPermutations": [],
1549
- "permutations": [
1550
- "org:refresh:sandbox",
1551
- "refresh:org:sandbox",
1552
- "refresh:sandbox:org",
1553
- "org:sandbox:refresh",
1554
- "sandbox:org:refresh",
1555
- "sandbox:refresh:org"
1556
- ]
1557
- },
1558
1407
  "org:open:agent": {
1559
1408
  "aliases": [],
1560
1409
  "args": {},
@@ -1760,7 +1609,7 @@
1760
1609
  "pluginName": "@salesforce/plugin-org",
1761
1610
  "pluginType": "core",
1762
1611
  "strict": true,
1763
- "summary": "Open your org in Agentforce Studio, specically in the list view showing the list of agents.",
1612
+ "summary": "Open your org in Agentforce Studio, specifically in the list view showing the list of agents.",
1764
1613
  "enableJsonFlag": true,
1765
1614
  "isESM": true,
1766
1615
  "relativePath": [
@@ -1780,6 +1629,157 @@
1780
1629
  "authoring-bundle:open:org"
1781
1630
  ]
1782
1631
  },
1632
+ "org:refresh:sandbox": {
1633
+ "aliases": [],
1634
+ "args": {},
1635
+ "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. You can also use the --source-id or --source-sandbox-name flags to change the refreshed sandbox org's original source org to a new org; in this case, the refreshed sandbox org's metadata is updated with the new source org's metadata.\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.",
1636
+ "examples": [
1637
+ "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",
1638
+ "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",
1639
+ "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",
1640
+ "Refresh the sandbox named \"devSbx2\" by changing its original source org to be a sandbox called \"devSbx3\":\n<%= config.bin %> <%= command.id %> --name devSbx2 --source-sandbox-name devSbx3 --target-org prodOrg"
1641
+ ],
1642
+ "flags": {
1643
+ "json": {
1644
+ "description": "Format output as json.",
1645
+ "helpGroup": "GLOBAL",
1646
+ "name": "json",
1647
+ "allowNo": false,
1648
+ "type": "boolean"
1649
+ },
1650
+ "flags-dir": {
1651
+ "helpGroup": "GLOBAL",
1652
+ "name": "flags-dir",
1653
+ "summary": "Import flag values from a directory.",
1654
+ "hasDynamicHelp": false,
1655
+ "multiple": false,
1656
+ "type": "option"
1657
+ },
1658
+ "no-auto-activate": {
1659
+ "description": "By default, a sandbox auto-activates after a refresh. Use this flag to control sandbox activation manually.",
1660
+ "name": "no-auto-activate",
1661
+ "summary": "Disable auto-activation of the sandbox after a successful refresh.",
1662
+ "allowNo": false,
1663
+ "type": "boolean"
1664
+ },
1665
+ "wait": {
1666
+ "char": "w",
1667
+ "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.",
1668
+ "exclusive": [
1669
+ "async"
1670
+ ],
1671
+ "name": "wait",
1672
+ "summary": "Number of minutes to poll for sandbox refresh status.",
1673
+ "hasDynamicHelp": true,
1674
+ "helpValue": "<minutes>",
1675
+ "multiple": false,
1676
+ "type": "option"
1677
+ },
1678
+ "poll-interval": {
1679
+ "char": "i",
1680
+ "exclusive": [
1681
+ "async"
1682
+ ],
1683
+ "name": "poll-interval",
1684
+ "summary": "Number of seconds to wait between status polling requests.",
1685
+ "hasDynamicHelp": true,
1686
+ "helpValue": "<seconds>",
1687
+ "multiple": false,
1688
+ "type": "option"
1689
+ },
1690
+ "source-sandbox-name": {
1691
+ "description": "The value of --source-sandbox-name must be an existing sandbox. The new source sandbox, and the refreshed sandbox specified with the --name flag, must both be associated with the production org (--target-org) that contains the sandbox licenses.\n\nYou can specify either --source-sandbox-name or --source-id when refreshing an existing sandbox, but not both.",
1692
+ "exclusive": [
1693
+ "source-id"
1694
+ ],
1695
+ "name": "source-sandbox-name",
1696
+ "summary": "Name of the sandbox org that becomes the new source org for the refreshed sandbox.",
1697
+ "hasDynamicHelp": false,
1698
+ "multiple": false,
1699
+ "type": "option"
1700
+ },
1701
+ "source-id": {
1702
+ "description": "The value of --source-id must be an existing sandbox. The new source sandbox, and the refreshed sandbox specified with the --name flag, must both be associated with the production org (--target-org) that contains the sandbox licenses.\n\nYou can specify either --source-id or --source-sandbox-name when refreshing an existing sandbox, but not both.",
1703
+ "exclusive": [
1704
+ "source-sandbox-name"
1705
+ ],
1706
+ "name": "source-id",
1707
+ "summary": "ID of the sandbox org that becomes the new source org for the refreshed sandbox.",
1708
+ "hasDynamicHelp": false,
1709
+ "multiple": false,
1710
+ "type": "option"
1711
+ },
1712
+ "async": {
1713
+ "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\".",
1714
+ "exclusive": [
1715
+ "wait",
1716
+ "poll-interval"
1717
+ ],
1718
+ "name": "async",
1719
+ "summary": "Request the sandbox refresh, but don't wait for it to complete.",
1720
+ "allowNo": false,
1721
+ "type": "boolean"
1722
+ },
1723
+ "name": {
1724
+ "char": "n",
1725
+ "name": "name",
1726
+ "summary": "Name of the existing sandbox org in your production org that you want to refresh.",
1727
+ "hasDynamicHelp": false,
1728
+ "multiple": false,
1729
+ "type": "option"
1730
+ },
1731
+ "definition-file": {
1732
+ "char": "f",
1733
+ "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.",
1734
+ "name": "definition-file",
1735
+ "summary": "Path to a sandbox definition file for overriding its configuration when you refresh it.",
1736
+ "hasDynamicHelp": false,
1737
+ "multiple": false,
1738
+ "type": "option"
1739
+ },
1740
+ "target-org": {
1741
+ "char": "o",
1742
+ "name": "target-org",
1743
+ "noCacheDefault": true,
1744
+ "required": true,
1745
+ "summary": "Username or alias of the production org that contains the sandbox license.",
1746
+ "hasDynamicHelp": true,
1747
+ "multiple": false,
1748
+ "type": "option"
1749
+ },
1750
+ "no-prompt": {
1751
+ "name": "no-prompt",
1752
+ "summary": "Don't prompt for confirmation about the sandbox refresh.",
1753
+ "allowNo": false,
1754
+ "type": "boolean"
1755
+ }
1756
+ },
1757
+ "hasDynamicHelp": true,
1758
+ "hiddenAliases": [],
1759
+ "id": "org:refresh:sandbox",
1760
+ "pluginAlias": "@salesforce/plugin-org",
1761
+ "pluginName": "@salesforce/plugin-org",
1762
+ "pluginType": "core",
1763
+ "strict": true,
1764
+ "summary": "Refresh a sandbox org using the sandbox name.",
1765
+ "isESM": true,
1766
+ "relativePath": [
1767
+ "lib",
1768
+ "commands",
1769
+ "org",
1770
+ "refresh",
1771
+ "sandbox.js"
1772
+ ],
1773
+ "aliasPermutations": [],
1774
+ "permutations": [
1775
+ "org:refresh:sandbox",
1776
+ "refresh:org:sandbox",
1777
+ "refresh:sandbox:org",
1778
+ "org:sandbox:refresh",
1779
+ "sandbox:org:refresh",
1780
+ "sandbox:refresh:org"
1781
+ ]
1782
+ },
1783
1783
  "org:resume:sandbox": {
1784
1784
  "aliases": [
1785
1785
  "env:resume:sandbox"
@@ -1983,5 +1983,5 @@
1983
1983
  ]
1984
1984
  }
1985
1985
  },
1986
- "version": "5.9.62"
1986
+ "version": "5.9.63"
1987
1987
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@salesforce/plugin-org",
3
3
  "description": "Commands to interact with Salesforce orgs",
4
- "version": "5.9.62",
4
+ "version": "5.9.63",
5
5
  "author": "Salesforce",
6
6
  "bugs": "https://github.com/forcedotcom/cli/issues",
7
7
  "dependencies": {
@@ -228,7 +228,7 @@
228
228
  "exports": "./lib/index.js",
229
229
  "type": "module",
230
230
  "sfdx": {
231
- "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/5.9.62.crt",
232
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/5.9.62.sig"
231
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/5.9.63.crt",
232
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/5.9.63.sig"
233
233
  }
234
234
  }