@salesforce/plugin-org 5.9.41 → 5.9.43

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +16 -16
  2. package/oclif.manifest.json +215 -215
  3. package/package.json +7 -7
package/README.md CHANGED
@@ -247,7 +247,7 @@ FLAG DESCRIPTIONS
247
247
  You can specify either --source-sandbox-name or --source-id when cloning an existing sandbox, but not both.
248
248
  ```
249
249
 
250
- _See code: [src/commands/org/create/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.41/src/commands/org/create/sandbox.ts)_
250
+ _See code: [src/commands/org/create/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.43/src/commands/org/create/sandbox.ts)_
251
251
 
252
252
  ## `sf org create scratch`
253
253
 
@@ -429,7 +429,7 @@ FLAG DESCRIPTIONS
429
429
  Omit this flag to have Salesforce generate a unique username for your org.
430
430
  ```
431
431
 
432
- _See code: [src/commands/org/create/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.41/src/commands/org/create/scratch.ts)_
432
+ _See code: [src/commands/org/create/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.43/src/commands/org/create/scratch.ts)_
433
433
 
434
434
  ## `sf org delete sandbox`
435
435
 
@@ -475,7 +475,7 @@ EXAMPLES
475
475
  $ sf org delete sandbox --target-org my-sandbox --no-prompt
476
476
  ```
477
477
 
478
- _See code: [src/commands/org/delete/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.41/src/commands/org/delete/sandbox.ts)_
478
+ _See code: [src/commands/org/delete/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.43/src/commands/org/delete/sandbox.ts)_
479
479
 
480
480
  ## `sf org delete scratch`
481
481
 
@@ -519,7 +519,7 @@ EXAMPLES
519
519
  $ sf org delete scratch --target-org my-scratch-org --no-prompt
520
520
  ```
521
521
 
522
- _See code: [src/commands/org/delete/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.41/src/commands/org/delete/scratch.ts)_
522
+ _See code: [src/commands/org/delete/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.43/src/commands/org/delete/scratch.ts)_
523
523
 
524
524
  ## `sf org disable tracking`
525
525
 
@@ -558,7 +558,7 @@ EXAMPLES
558
558
  $ sf org disable tracking
559
559
  ```
560
560
 
561
- _See code: [src/commands/org/disable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.41/src/commands/org/disable/tracking.ts)_
561
+ _See code: [src/commands/org/disable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.43/src/commands/org/disable/tracking.ts)_
562
562
 
563
563
  ## `sf org display`
564
564
 
@@ -603,7 +603,7 @@ EXAMPLES
603
603
  $ sf org display --target-org TestOrg1 --verbose
604
604
  ```
605
605
 
606
- _See code: [src/commands/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.41/src/commands/org/display.ts)_
606
+ _See code: [src/commands/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.43/src/commands/org/display.ts)_
607
607
 
608
608
  ## `sf org enable tracking`
609
609
 
@@ -645,7 +645,7 @@ EXAMPLES
645
645
  $ sf org enable tracking
646
646
  ```
647
647
 
648
- _See code: [src/commands/org/enable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.41/src/commands/org/enable/tracking.ts)_
648
+ _See code: [src/commands/org/enable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.43/src/commands/org/enable/tracking.ts)_
649
649
 
650
650
  ## `sf org list`
651
651
 
@@ -684,7 +684,7 @@ EXAMPLES
684
684
  $ sf org list --clean
685
685
  ```
686
686
 
687
- _See code: [src/commands/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.41/src/commands/org/list.ts)_
687
+ _See code: [src/commands/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.43/src/commands/org/list.ts)_
688
688
 
689
689
  ## `sf org list metadata`
690
690
 
@@ -751,7 +751,7 @@ FLAG DESCRIPTIONS
751
751
  Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.
752
752
  ```
753
753
 
754
- _See code: [src/commands/org/list/metadata.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.41/src/commands/org/list/metadata.ts)_
754
+ _See code: [src/commands/org/list/metadata.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.43/src/commands/org/list/metadata.ts)_
755
755
 
756
756
  ## `sf org list metadata-types`
757
757
 
@@ -806,7 +806,7 @@ FLAG DESCRIPTIONS
806
806
  Override the api version used for api requests made by this command
807
807
  ```
808
808
 
809
- _See code: [src/commands/org/list/metadata-types.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.41/src/commands/org/list/metadata-types.ts)_
809
+ _See code: [src/commands/org/list/metadata-types.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.43/src/commands/org/list/metadata-types.ts)_
810
810
 
811
811
  ## `sf org open`
812
812
 
@@ -823,7 +823,7 @@ FLAGS
823
823
  -f, --source-file=<value> Path to ApexPage, FlexiPage, Flow, or Agent metadata to open in the associated Builder.
824
824
  -o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
825
825
  configuration variable is already set.
826
- -p, --path=<value> Navigation URL path to open a specific page.
826
+ -p, --path=<value> [env: FORCE_OPEN_URL] Navigation URL path to open a specific page.
827
827
  -r, --url-only Display navigation URL, but don’t launch browser.
828
828
  --api-version=<value> Override the api version used for api requests made by this command
829
829
  --private Open the org in the default browser using private (incognito) mode.
@@ -882,7 +882,7 @@ EXAMPLES
882
882
  $ sf org open --source-file force-app/main/default/bots/Coral_Cloud_Agent/Coral_Cloud_Agent.bot-meta.xml
883
883
  ```
884
884
 
885
- _See code: [src/commands/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.41/src/commands/org/open.ts)_
885
+ _See code: [src/commands/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.43/src/commands/org/open.ts)_
886
886
 
887
887
  ## `sf org open agent`
888
888
 
@@ -933,7 +933,7 @@ EXAMPLES
933
933
  $ sf org open agent --target-org MyTestOrg1 --browser firefox --api-name Coral_Cloud_Agent
934
934
  ```
935
935
 
936
- _See code: [src/commands/org/open/agent.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.41/src/commands/org/open/agent.ts)_
936
+ _See code: [src/commands/org/open/agent.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.43/src/commands/org/open/agent.ts)_
937
937
 
938
938
  ## `sf org refresh sandbox`
939
939
 
@@ -1036,7 +1036,7 @@ FLAG DESCRIPTIONS
1036
1036
  You can specify either --source-sandbox-name or --source-id when refreshing an existing sandbox, but not both.
1037
1037
  ```
1038
1038
 
1039
- _See code: [src/commands/org/refresh/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.41/src/commands/org/refresh/sandbox.ts)_
1039
+ _See code: [src/commands/org/refresh/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.43/src/commands/org/refresh/sandbox.ts)_
1040
1040
 
1041
1041
  ## `sf org resume sandbox`
1042
1042
 
@@ -1099,7 +1099,7 @@ FLAG DESCRIPTIONS
1099
1099
  returns the job ID. To resume checking the sandbox creation, rerun this command.
1100
1100
  ```
1101
1101
 
1102
- _See code: [src/commands/org/resume/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.41/src/commands/org/resume/sandbox.ts)_
1102
+ _See code: [src/commands/org/resume/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.43/src/commands/org/resume/sandbox.ts)_
1103
1103
 
1104
1104
  ## `sf org resume scratch`
1105
1105
 
@@ -1152,6 +1152,6 @@ FLAG DESCRIPTIONS
1152
1152
  returns the job ID. To resume checking the scratch creation, rerun this command.
1153
1153
  ```
1154
1154
 
1155
- _See code: [src/commands/org/resume/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.41/src/commands/org/resume/scratch.ts)_
1155
+ _See code: [src/commands/org/resume/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.43/src/commands/org/resume/scratch.ts)_
1156
1156
 
1157
1157
  <!-- commandsstop -->
@@ -851,69 +851,6 @@
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
- },
917
854
  "org:delete:sandbox": {
918
855
  "aliases": [
919
856
  "env:delete:sandbox"
@@ -1082,6 +1019,69 @@
1082
1019
  "scratch:delete:org"
1083
1020
  ]
1084
1021
  },
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": {},
@@ -1521,6 +1521,157 @@
1521
1521
  "agent:open:org"
1522
1522
  ]
1523
1523
  },
1524
+ "org:refresh:sandbox": {
1525
+ "aliases": [],
1526
+ "args": {},
1527
+ "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.",
1528
+ "examples": [
1529
+ "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",
1530
+ "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",
1531
+ "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",
1532
+ "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"
1533
+ ],
1534
+ "flags": {
1535
+ "json": {
1536
+ "description": "Format output as json.",
1537
+ "helpGroup": "GLOBAL",
1538
+ "name": "json",
1539
+ "allowNo": false,
1540
+ "type": "boolean"
1541
+ },
1542
+ "flags-dir": {
1543
+ "helpGroup": "GLOBAL",
1544
+ "name": "flags-dir",
1545
+ "summary": "Import flag values from a directory.",
1546
+ "hasDynamicHelp": false,
1547
+ "multiple": false,
1548
+ "type": "option"
1549
+ },
1550
+ "no-auto-activate": {
1551
+ "description": "By default, a sandbox auto-activates after a refresh. Use this flag to control sandbox activation manually.",
1552
+ "name": "no-auto-activate",
1553
+ "summary": "Disable auto-activation of the sandbox after a successful refresh.",
1554
+ "allowNo": false,
1555
+ "type": "boolean"
1556
+ },
1557
+ "wait": {
1558
+ "char": "w",
1559
+ "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.",
1560
+ "exclusive": [
1561
+ "async"
1562
+ ],
1563
+ "name": "wait",
1564
+ "summary": "Number of minutes to poll for sandbox refresh status.",
1565
+ "hasDynamicHelp": true,
1566
+ "helpValue": "<minutes>",
1567
+ "multiple": false,
1568
+ "type": "option"
1569
+ },
1570
+ "poll-interval": {
1571
+ "char": "i",
1572
+ "exclusive": [
1573
+ "async"
1574
+ ],
1575
+ "name": "poll-interval",
1576
+ "summary": "Number of seconds to wait between status polling requests.",
1577
+ "hasDynamicHelp": true,
1578
+ "helpValue": "<seconds>",
1579
+ "multiple": false,
1580
+ "type": "option"
1581
+ },
1582
+ "source-sandbox-name": {
1583
+ "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.",
1584
+ "exclusive": [
1585
+ "source-id"
1586
+ ],
1587
+ "name": "source-sandbox-name",
1588
+ "summary": "Name of the sandbox org that becomes the new source org for the refreshed sandbox.",
1589
+ "hasDynamicHelp": false,
1590
+ "multiple": false,
1591
+ "type": "option"
1592
+ },
1593
+ "source-id": {
1594
+ "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.",
1595
+ "exclusive": [
1596
+ "source-sandbox-name"
1597
+ ],
1598
+ "name": "source-id",
1599
+ "summary": "ID of the sandbox org that becomes the new source org for the refreshed sandbox.",
1600
+ "hasDynamicHelp": false,
1601
+ "multiple": false,
1602
+ "type": "option"
1603
+ },
1604
+ "async": {
1605
+ "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\".",
1606
+ "exclusive": [
1607
+ "wait",
1608
+ "poll-interval"
1609
+ ],
1610
+ "name": "async",
1611
+ "summary": "Request the sandbox refresh, but don't wait for it to complete.",
1612
+ "allowNo": false,
1613
+ "type": "boolean"
1614
+ },
1615
+ "name": {
1616
+ "char": "n",
1617
+ "name": "name",
1618
+ "summary": "Name of the existing sandbox org in your production org that you want to refresh.",
1619
+ "hasDynamicHelp": false,
1620
+ "multiple": false,
1621
+ "type": "option"
1622
+ },
1623
+ "definition-file": {
1624
+ "char": "f",
1625
+ "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.",
1626
+ "name": "definition-file",
1627
+ "summary": "Path to a sandbox definition file for overriding its configuration when you refresh it.",
1628
+ "hasDynamicHelp": false,
1629
+ "multiple": false,
1630
+ "type": "option"
1631
+ },
1632
+ "target-org": {
1633
+ "char": "o",
1634
+ "name": "target-org",
1635
+ "noCacheDefault": true,
1636
+ "required": true,
1637
+ "summary": "Username or alias of the production org that contains the sandbox license.",
1638
+ "hasDynamicHelp": true,
1639
+ "multiple": false,
1640
+ "type": "option"
1641
+ },
1642
+ "no-prompt": {
1643
+ "name": "no-prompt",
1644
+ "summary": "Don't prompt for confirmation about the sandbox refresh.",
1645
+ "allowNo": false,
1646
+ "type": "boolean"
1647
+ }
1648
+ },
1649
+ "hasDynamicHelp": true,
1650
+ "hiddenAliases": [],
1651
+ "id": "org:refresh:sandbox",
1652
+ "pluginAlias": "@salesforce/plugin-org",
1653
+ "pluginName": "@salesforce/plugin-org",
1654
+ "pluginType": "core",
1655
+ "strict": true,
1656
+ "summary": "Refresh a sandbox org using the sandbox name.",
1657
+ "isESM": true,
1658
+ "relativePath": [
1659
+ "lib",
1660
+ "commands",
1661
+ "org",
1662
+ "refresh",
1663
+ "sandbox.js"
1664
+ ],
1665
+ "aliasPermutations": [],
1666
+ "permutations": [
1667
+ "org:refresh:sandbox",
1668
+ "refresh:org:sandbox",
1669
+ "refresh:sandbox:org",
1670
+ "org:sandbox:refresh",
1671
+ "sandbox:org:refresh",
1672
+ "sandbox:refresh:org"
1673
+ ]
1674
+ },
1524
1675
  "org:resume:sandbox": {
1525
1676
  "aliases": [
1526
1677
  "env:resume:sandbox"
@@ -1722,158 +1873,7 @@
1722
1873
  "scratch:org:resume",
1723
1874
  "scratch:resume:org"
1724
1875
  ]
1725
- },
1726
- "org:refresh:sandbox": {
1727
- "aliases": [],
1728
- "args": {},
1729
- "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.",
1730
- "examples": [
1731
- "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",
1732
- "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",
1733
- "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",
1734
- "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"
1735
- ],
1736
- "flags": {
1737
- "json": {
1738
- "description": "Format output as json.",
1739
- "helpGroup": "GLOBAL",
1740
- "name": "json",
1741
- "allowNo": false,
1742
- "type": "boolean"
1743
- },
1744
- "flags-dir": {
1745
- "helpGroup": "GLOBAL",
1746
- "name": "flags-dir",
1747
- "summary": "Import flag values from a directory.",
1748
- "hasDynamicHelp": false,
1749
- "multiple": false,
1750
- "type": "option"
1751
- },
1752
- "no-auto-activate": {
1753
- "description": "By default, a sandbox auto-activates after a refresh. Use this flag to control sandbox activation manually.",
1754
- "name": "no-auto-activate",
1755
- "summary": "Disable auto-activation of the sandbox after a successful refresh.",
1756
- "allowNo": false,
1757
- "type": "boolean"
1758
- },
1759
- "wait": {
1760
- "char": "w",
1761
- "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.",
1762
- "exclusive": [
1763
- "async"
1764
- ],
1765
- "name": "wait",
1766
- "summary": "Number of minutes to poll for sandbox refresh status.",
1767
- "hasDynamicHelp": true,
1768
- "helpValue": "<minutes>",
1769
- "multiple": false,
1770
- "type": "option"
1771
- },
1772
- "poll-interval": {
1773
- "char": "i",
1774
- "exclusive": [
1775
- "async"
1776
- ],
1777
- "name": "poll-interval",
1778
- "summary": "Number of seconds to wait between status polling requests.",
1779
- "hasDynamicHelp": true,
1780
- "helpValue": "<seconds>",
1781
- "multiple": false,
1782
- "type": "option"
1783
- },
1784
- "source-sandbox-name": {
1785
- "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.",
1786
- "exclusive": [
1787
- "source-id"
1788
- ],
1789
- "name": "source-sandbox-name",
1790
- "summary": "Name of the sandbox org that becomes the new source org for the refreshed sandbox.",
1791
- "hasDynamicHelp": false,
1792
- "multiple": false,
1793
- "type": "option"
1794
- },
1795
- "source-id": {
1796
- "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.",
1797
- "exclusive": [
1798
- "source-sandbox-name"
1799
- ],
1800
- "name": "source-id",
1801
- "summary": "ID of the sandbox org that becomes the new source org for the refreshed sandbox.",
1802
- "hasDynamicHelp": false,
1803
- "multiple": false,
1804
- "type": "option"
1805
- },
1806
- "async": {
1807
- "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\".",
1808
- "exclusive": [
1809
- "wait",
1810
- "poll-interval"
1811
- ],
1812
- "name": "async",
1813
- "summary": "Request the sandbox refresh, but don't wait for it to complete.",
1814
- "allowNo": false,
1815
- "type": "boolean"
1816
- },
1817
- "name": {
1818
- "char": "n",
1819
- "name": "name",
1820
- "summary": "Name of the existing sandbox org in your production org that you want to refresh.",
1821
- "hasDynamicHelp": false,
1822
- "multiple": false,
1823
- "type": "option"
1824
- },
1825
- "definition-file": {
1826
- "char": "f",
1827
- "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.",
1828
- "name": "definition-file",
1829
- "summary": "Path to a sandbox definition file for overriding its configuration when you refresh it.",
1830
- "hasDynamicHelp": false,
1831
- "multiple": false,
1832
- "type": "option"
1833
- },
1834
- "target-org": {
1835
- "char": "o",
1836
- "name": "target-org",
1837
- "noCacheDefault": true,
1838
- "required": true,
1839
- "summary": "Username or alias of the production org that contains the sandbox license.",
1840
- "hasDynamicHelp": true,
1841
- "multiple": false,
1842
- "type": "option"
1843
- },
1844
- "no-prompt": {
1845
- "name": "no-prompt",
1846
- "summary": "Don't prompt for confirmation about the sandbox refresh.",
1847
- "allowNo": false,
1848
- "type": "boolean"
1849
- }
1850
- },
1851
- "hasDynamicHelp": true,
1852
- "hiddenAliases": [],
1853
- "id": "org:refresh:sandbox",
1854
- "pluginAlias": "@salesforce/plugin-org",
1855
- "pluginName": "@salesforce/plugin-org",
1856
- "pluginType": "core",
1857
- "strict": true,
1858
- "summary": "Refresh a sandbox org using the sandbox name.",
1859
- "isESM": true,
1860
- "relativePath": [
1861
- "lib",
1862
- "commands",
1863
- "org",
1864
- "refresh",
1865
- "sandbox.js"
1866
- ],
1867
- "aliasPermutations": [],
1868
- "permutations": [
1869
- "org:refresh:sandbox",
1870
- "refresh:org:sandbox",
1871
- "refresh:sandbox:org",
1872
- "org:sandbox:refresh",
1873
- "sandbox:org:refresh",
1874
- "sandbox:refresh:org"
1875
- ]
1876
1876
  }
1877
1877
  },
1878
- "version": "5.9.41"
1878
+ "version": "5.9.43"
1879
1879
  }
package/package.json CHANGED
@@ -1,13 +1,13 @@
1
1
  {
2
2
  "name": "@salesforce/plugin-org",
3
3
  "description": "Commands to interact with Salesforce orgs",
4
- "version": "5.9.41",
4
+ "version": "5.9.43",
5
5
  "author": "Salesforce",
6
6
  "bugs": "https://github.com/forcedotcom/cli/issues",
7
7
  "dependencies": {
8
8
  "@oclif/core": "^4.5.6",
9
- "@oclif/multi-stage-output": "^0.8.25",
10
- "@salesforce/core": "^8.23.3",
9
+ "@oclif/multi-stage-output": "^0.8.26",
10
+ "@salesforce/core": "^8.23.4",
11
11
  "@salesforce/kit": "^3.2.4",
12
12
  "@salesforce/sf-plugins-core": "^12.2.5",
13
13
  "@salesforce/source-deploy-retrieve": "^12.25.0",
@@ -22,11 +22,11 @@
22
22
  "@oclif/plugin-command-snapshot": "^5.3.8",
23
23
  "@salesforce/cli-plugins-testkit": "^5.3.41",
24
24
  "@salesforce/dev-scripts": "^11.0.3",
25
- "@salesforce/plugin-command-reference": "^3.1.75",
25
+ "@salesforce/plugin-command-reference": "^3.1.77",
26
26
  "@salesforce/ts-sinon": "^1.4.31",
27
27
  "eslint-plugin-sf-plugin": "^1.20.33",
28
28
  "moment": "^2.30.1",
29
- "oclif": "^4.22.32",
29
+ "oclif": "^4.22.39",
30
30
  "ts-node": "^10.9.2",
31
31
  "typescript": "^5.9.3"
32
32
  },
@@ -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.41.crt",
232
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/5.9.41.sig"
231
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/5.9.43.crt",
232
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/5.9.43.sig"
233
233
  }
234
234
  }