@salesforce/plugin-org 5.6.1 → 5.6.3

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 +15 -15
  2. package/oclif.manifest.json +298 -298
  3. package/package.json +5 -5
package/README.md CHANGED
@@ -242,7 +242,7 @@ FLAG DESCRIPTIONS
242
242
  You can specify either --source-sandbox-name or --source-id when cloning an existing sandbox, but not both.
243
243
  ```
244
244
 
245
- _See code: [src/commands/org/create/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.6.1/src/commands/org/create/sandbox.ts)_
245
+ _See code: [src/commands/org/create/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.6.3/src/commands/org/create/sandbox.ts)_
246
246
 
247
247
  ## `sf org create scratch`
248
248
 
@@ -424,7 +424,7 @@ FLAG DESCRIPTIONS
424
424
  Omit this flag to have Salesforce generate a unique username for your org.
425
425
  ```
426
426
 
427
- _See code: [src/commands/org/create/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.6.1/src/commands/org/create/scratch.ts)_
427
+ _See code: [src/commands/org/create/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.6.3/src/commands/org/create/scratch.ts)_
428
428
 
429
429
  ## `sf org delete sandbox`
430
430
 
@@ -470,7 +470,7 @@ EXAMPLES
470
470
  $ sf org delete sandbox --target-org my-sandbox --no-prompt
471
471
  ```
472
472
 
473
- _See code: [src/commands/org/delete/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.6.1/src/commands/org/delete/sandbox.ts)_
473
+ _See code: [src/commands/org/delete/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.6.3/src/commands/org/delete/sandbox.ts)_
474
474
 
475
475
  ## `sf org delete scratch`
476
476
 
@@ -514,7 +514,7 @@ EXAMPLES
514
514
  $ sf org delete scratch --target-org my-scratch-org --no-prompt
515
515
  ```
516
516
 
517
- _See code: [src/commands/org/delete/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.6.1/src/commands/org/delete/scratch.ts)_
517
+ _See code: [src/commands/org/delete/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.6.3/src/commands/org/delete/scratch.ts)_
518
518
 
519
519
  ## `sf org disable tracking`
520
520
 
@@ -553,7 +553,7 @@ EXAMPLES
553
553
  $ sf org disable tracking
554
554
  ```
555
555
 
556
- _See code: [src/commands/org/disable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.6.1/src/commands/org/disable/tracking.ts)_
556
+ _See code: [src/commands/org/disable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.6.3/src/commands/org/disable/tracking.ts)_
557
557
 
558
558
  ## `sf org display`
559
559
 
@@ -598,7 +598,7 @@ EXAMPLES
598
598
  $ sf org display --target-org TestOrg1 --verbose
599
599
  ```
600
600
 
601
- _See code: [src/commands/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/5.6.1/src/commands/org/display.ts)_
601
+ _See code: [src/commands/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/5.6.3/src/commands/org/display.ts)_
602
602
 
603
603
  ## `sf org enable tracking`
604
604
 
@@ -640,7 +640,7 @@ EXAMPLES
640
640
  $ sf org enable tracking
641
641
  ```
642
642
 
643
- _See code: [src/commands/org/enable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.6.1/src/commands/org/enable/tracking.ts)_
643
+ _See code: [src/commands/org/enable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.6.3/src/commands/org/enable/tracking.ts)_
644
644
 
645
645
  ## `sf org list`
646
646
 
@@ -679,7 +679,7 @@ EXAMPLES
679
679
  $ sf org list --clean
680
680
  ```
681
681
 
682
- _See code: [src/commands/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/5.6.1/src/commands/org/list.ts)_
682
+ _See code: [src/commands/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/5.6.3/src/commands/org/list.ts)_
683
683
 
684
684
  ## `sf org list metadata`
685
685
 
@@ -746,7 +746,7 @@ FLAG DESCRIPTIONS
746
746
  Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.
747
747
  ```
748
748
 
749
- _See code: [src/commands/org/list/metadata.ts](https://github.com/salesforcecli/plugin-org/blob/5.6.1/src/commands/org/list/metadata.ts)_
749
+ _See code: [src/commands/org/list/metadata.ts](https://github.com/salesforcecli/plugin-org/blob/5.6.3/src/commands/org/list/metadata.ts)_
750
750
 
751
751
  ## `sf org list metadata-types`
752
752
 
@@ -801,7 +801,7 @@ FLAG DESCRIPTIONS
801
801
  Override the api version used for api requests made by this command
802
802
  ```
803
803
 
804
- _See code: [src/commands/org/list/metadata-types.ts](https://github.com/salesforcecli/plugin-org/blob/5.6.1/src/commands/org/list/metadata-types.ts)_
804
+ _See code: [src/commands/org/list/metadata-types.ts](https://github.com/salesforcecli/plugin-org/blob/5.6.3/src/commands/org/list/metadata-types.ts)_
805
805
 
806
806
  ## `sf org open`
807
807
 
@@ -877,7 +877,7 @@ EXAMPLES
877
877
  $ sf org open --source-file force-app/main/default/bots/Coral_Cloud_Agent/Coral_Cloud_Agent.bot-meta.xml
878
878
  ```
879
879
 
880
- _See code: [src/commands/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/5.6.1/src/commands/org/open.ts)_
880
+ _See code: [src/commands/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/5.6.3/src/commands/org/open.ts)_
881
881
 
882
882
  ## `sf org open agent`
883
883
 
@@ -928,7 +928,7 @@ EXAMPLES
928
928
  $ sf org open agent --target-org MyTestOrg1 --browser firefox --name Coral_Cloud_Agent
929
929
  ```
930
930
 
931
- _See code: [src/commands/org/open/agent.ts](https://github.com/salesforcecli/plugin-org/blob/5.6.1/src/commands/org/open/agent.ts)_
931
+ _See code: [src/commands/org/open/agent.ts](https://github.com/salesforcecli/plugin-org/blob/5.6.3/src/commands/org/open/agent.ts)_
932
932
 
933
933
  ## `sf org refresh sandbox`
934
934
 
@@ -1005,7 +1005,7 @@ FLAG DESCRIPTIONS
1005
1005
  By default, a sandbox auto-activates after a refresh. Use this flag to control sandbox activation manually.
1006
1006
  ```
1007
1007
 
1008
- _See code: [src/commands/org/refresh/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.6.1/src/commands/org/refresh/sandbox.ts)_
1008
+ _See code: [src/commands/org/refresh/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.6.3/src/commands/org/refresh/sandbox.ts)_
1009
1009
 
1010
1010
  ## `sf org resume sandbox`
1011
1011
 
@@ -1068,7 +1068,7 @@ FLAG DESCRIPTIONS
1068
1068
  returns the job ID. To resume checking the sandbox creation, rerun this command.
1069
1069
  ```
1070
1070
 
1071
- _See code: [src/commands/org/resume/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.6.1/src/commands/org/resume/sandbox.ts)_
1071
+ _See code: [src/commands/org/resume/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.6.3/src/commands/org/resume/sandbox.ts)_
1072
1072
 
1073
1073
  ## `sf org resume scratch`
1074
1074
 
@@ -1121,6 +1121,6 @@ FLAG DESCRIPTIONS
1121
1121
  returns the job ID. To resume checking the scratch creation, rerun this command.
1122
1122
  ```
1123
1123
 
1124
- _See code: [src/commands/org/resume/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.6.1/src/commands/org/resume/scratch.ts)_
1124
+ _See code: [src/commands/org/resume/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.6.3/src/commands/org/resume/scratch.ts)_
1125
1125
 
1126
1126
  <!-- commandsstop -->
@@ -849,69 +849,6 @@
849
849
  "scratch:create:org"
850
850
  ]
851
851
  },
852
- "org:disable:tracking": {
853
- "aliases": [],
854
- "args": {},
855
- "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.",
856
- "examples": [
857
- "Disable source tracking for an org with alias \"myscratch\":\n<%= config.bin %> <%= command.id %> --target-org myscratch",
858
- "Disable source tracking for an org using a username:\n<%= config.bin %> <%= command.id %> --target-org you@example.com",
859
- "Disable source tracking for your default org:\n<%= config.bin %> <%= command.id %>"
860
- ],
861
- "flags": {
862
- "json": {
863
- "description": "Format output as json.",
864
- "helpGroup": "GLOBAL",
865
- "name": "json",
866
- "allowNo": false,
867
- "type": "boolean"
868
- },
869
- "flags-dir": {
870
- "helpGroup": "GLOBAL",
871
- "name": "flags-dir",
872
- "summary": "Import flag values from a directory.",
873
- "hasDynamicHelp": false,
874
- "multiple": false,
875
- "type": "option"
876
- },
877
- "target-org": {
878
- "char": "o",
879
- "name": "target-org",
880
- "noCacheDefault": true,
881
- "required": true,
882
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
883
- "hasDynamicHelp": true,
884
- "multiple": false,
885
- "type": "option"
886
- }
887
- },
888
- "hasDynamicHelp": true,
889
- "hiddenAliases": [],
890
- "id": "org:disable:tracking",
891
- "pluginAlias": "@salesforce/plugin-org",
892
- "pluginName": "@salesforce/plugin-org",
893
- "pluginType": "core",
894
- "strict": true,
895
- "summary": "Prevent Salesforce CLI from tracking changes in your source files between your project and an org.",
896
- "enableJsonFlag": true,
897
- "isESM": true,
898
- "relativePath": [
899
- "lib",
900
- "commands",
901
- "org",
902
- "disable",
903
- "tracking.js"
904
- ],
905
- "aliasPermutations": [],
906
- "permutations": [
907
- "org:disable:tracking",
908
- "disable:org:tracking",
909
- "disable:tracking:org",
910
- "org:tracking:disable",
911
- "tracking:org:disable",
912
- "tracking:disable:org"
913
- ]
914
- },
915
852
  "org:delete:sandbox": {
916
853
  "aliases": [
917
854
  "env:delete:sandbox"
@@ -1080,14 +1017,14 @@
1080
1017
  "scratch:delete:org"
1081
1018
  ]
1082
1019
  },
1083
- "org:enable:tracking": {
1020
+ "org:disable:tracking": {
1084
1021
  "aliases": [],
1085
1022
  "args": {},
1086
- "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.",
1023
+ "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.",
1087
1024
  "examples": [
1088
- "Enable source tracking for an org with alias \"myscratch\":\n<%= config.bin %> <%= command.id %> --target-org myscratch",
1089
- "Enable source tracking for an org using a username:\n<%= config.bin %> <%= command.id %> --target-org you@example.com",
1090
- "Enable source tracking for your default org:\n<%= config.bin %> <%= command.id %>"
1025
+ "Disable source tracking for an org with alias \"myscratch\":\n<%= config.bin %> <%= command.id %> --target-org myscratch",
1026
+ "Disable source tracking for an org using a username:\n<%= config.bin %> <%= command.id %> --target-org you@example.com",
1027
+ "Disable source tracking for your default org:\n<%= config.bin %> <%= command.id %>"
1091
1028
  ],
1092
1029
  "flags": {
1093
1030
  "json": {
@@ -1118,39 +1055,39 @@
1118
1055
  },
1119
1056
  "hasDynamicHelp": true,
1120
1057
  "hiddenAliases": [],
1121
- "id": "org:enable:tracking",
1058
+ "id": "org:disable:tracking",
1122
1059
  "pluginAlias": "@salesforce/plugin-org",
1123
1060
  "pluginName": "@salesforce/plugin-org",
1124
1061
  "pluginType": "core",
1125
1062
  "strict": true,
1126
- "summary": "Allow Salesforce CLI to track changes in your source files between your project and an org.",
1063
+ "summary": "Prevent Salesforce CLI from tracking changes in your source files between your project and an org.",
1127
1064
  "enableJsonFlag": true,
1128
1065
  "isESM": true,
1129
1066
  "relativePath": [
1130
1067
  "lib",
1131
1068
  "commands",
1132
1069
  "org",
1133
- "enable",
1070
+ "disable",
1134
1071
  "tracking.js"
1135
1072
  ],
1136
1073
  "aliasPermutations": [],
1137
1074
  "permutations": [
1138
- "org:enable:tracking",
1139
- "enable:org:tracking",
1140
- "enable:tracking:org",
1141
- "org:tracking:enable",
1142
- "tracking:org:enable",
1143
- "tracking:enable:org"
1075
+ "org:disable:tracking",
1076
+ "disable:org:tracking",
1077
+ "disable:tracking:org",
1078
+ "org:tracking:disable",
1079
+ "tracking:org:disable",
1080
+ "tracking:disable:org"
1144
1081
  ]
1145
1082
  },
1146
- "org:open:agent": {
1083
+ "org:enable:tracking": {
1147
1084
  "aliases": [],
1148
1085
  "args": {},
1149
- "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.",
1086
+ "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.",
1150
1087
  "examples": [
1151
- "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",
1152
- "Open the agent in an incognito window of your default browser:\n$ <%= config.bin %> <%= command.id %> --private --name Coral_Cloud_Agent:",
1153
- "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"
1088
+ "Enable source tracking for an org with alias \"myscratch\":\n<%= config.bin %> <%= command.id %> --target-org myscratch",
1089
+ "Enable source tracking for an org using a username:\n<%= config.bin %> <%= command.id %> --target-org you@example.com",
1090
+ "Enable source tracking for your default org:\n<%= config.bin %> <%= command.id %>"
1154
1091
  ],
1155
1092
  "flags": {
1156
1093
  "json": {
@@ -1177,98 +1114,45 @@
1177
1114
  "hasDynamicHelp": true,
1178
1115
  "multiple": false,
1179
1116
  "type": "option"
1180
- },
1181
- "api-version": {
1182
- "description": "Override the api version used for api requests made by this command",
1183
- "name": "api-version",
1184
- "hasDynamicHelp": false,
1185
- "multiple": false,
1186
- "type": "option"
1187
- },
1188
- "name": {
1189
- "char": "n",
1190
- "name": "name",
1191
- "required": true,
1192
- "summary": "API name, also known as developer name, of the agent you want to open in the org's Agent Builder UI.",
1193
- "hasDynamicHelp": false,
1194
- "multiple": false,
1195
- "type": "option"
1196
- },
1197
- "private": {
1198
- "exclusive": [
1199
- "url-only",
1200
- "browser"
1201
- ],
1202
- "name": "private",
1203
- "summary": "Open the org in the default browser using private (incognito) mode.",
1204
- "allowNo": false,
1205
- "type": "boolean"
1206
- },
1207
- "browser": {
1208
- "char": "b",
1209
- "exclusive": [
1210
- "url-only",
1211
- "private"
1212
- ],
1213
- "name": "browser",
1214
- "summary": "Browser where the org opens.",
1215
- "hasDynamicHelp": false,
1216
- "multiple": false,
1217
- "options": [
1218
- "chrome",
1219
- "edge",
1220
- "firefox"
1221
- ],
1222
- "type": "option"
1223
- },
1224
- "url-only": {
1225
- "aliases": [
1226
- "urlonly"
1227
- ],
1228
- "char": "r",
1229
- "deprecateAliases": true,
1230
- "name": "url-only",
1231
- "summary": "Display navigation URL, but don’t launch browser.",
1232
- "allowNo": false,
1233
- "type": "boolean"
1234
1117
  }
1235
1118
  },
1236
1119
  "hasDynamicHelp": true,
1237
1120
  "hiddenAliases": [],
1238
- "id": "org:open:agent",
1121
+ "id": "org:enable:tracking",
1239
1122
  "pluginAlias": "@salesforce/plugin-org",
1240
1123
  "pluginName": "@salesforce/plugin-org",
1241
1124
  "pluginType": "core",
1242
- "state": "beta",
1243
1125
  "strict": true,
1244
- "summary": "Open an agent in your org's Agent Builder UI in a browser.",
1126
+ "summary": "Allow Salesforce CLI to track changes in your source files between your project and an org.",
1245
1127
  "enableJsonFlag": true,
1246
1128
  "isESM": true,
1247
1129
  "relativePath": [
1248
1130
  "lib",
1249
1131
  "commands",
1250
1132
  "org",
1251
- "open",
1252
- "agent.js"
1133
+ "enable",
1134
+ "tracking.js"
1253
1135
  ],
1254
1136
  "aliasPermutations": [],
1255
1137
  "permutations": [
1256
- "org:open:agent",
1257
- "open:org:agent",
1258
- "open:agent:org",
1259
- "org:agent:open",
1260
- "agent:org:open",
1261
- "agent:open:org"
1138
+ "org:enable:tracking",
1139
+ "enable:org:tracking",
1140
+ "enable:tracking:org",
1141
+ "org:tracking:enable",
1142
+ "tracking:org:enable",
1143
+ "tracking:enable:org"
1262
1144
  ]
1263
1145
  },
1264
- "org:refresh:sandbox": {
1265
- "aliases": [],
1146
+ "org:list:metadata-types": {
1147
+ "aliases": [
1148
+ "force:mdapi:describemetadata"
1149
+ ],
1266
1150
  "args": {},
1267
- "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.",
1151
+ "deprecateAliases": true,
1152
+ "description": "The information includes Apex classes and triggers, custom objects, custom fields on standard objects, tab sets that define an app, and many other metadata types. Use this information to identify the syntax needed for a <name> element in a manifest file (package.xml).\n\nThe username that you use to connect to the org must have the Modify All Data or Modify Metadata Through Metadata API Functions permission.",
1268
1153
  "examples": [
1269
- "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",
1270
- "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",
1271
- "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"
1154
+ "Display information about all known and enabled metadata types in the org with alias \"my-dev-org\" using API version 57.0:\n$ <%= config.bin %> <%= command.id %> --api-version 57.0 --target-org my-dev-org",
1155
+ "Display only the metadata types that aren't yet supported by Salesforce CLI in your default org and write the results to the specified file:\n$ <%= config.bin %> <%= command.id %> --output-file /path/to/outputfilename.txt --filter-known"
1272
1156
  ],
1273
1157
  "flags": {
1274
1158
  "json": {
@@ -1286,155 +1170,25 @@
1286
1170
  "multiple": false,
1287
1171
  "type": "option"
1288
1172
  },
1289
- "no-auto-activate": {
1290
- "description": "By default, a sandbox auto-activates after a refresh. Use this flag to control sandbox activation manually.",
1291
- "name": "no-auto-activate",
1292
- "summary": "Disable auto-activation of the sandbox after a successful refresh.",
1293
- "allowNo": false,
1294
- "type": "boolean"
1295
- },
1296
- "wait": {
1297
- "char": "w",
1298
- "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.",
1299
- "exclusive": [
1300
- "async"
1301
- ],
1302
- "name": "wait",
1303
- "summary": "Number of minutes to poll for sandbox refresh status.",
1304
- "hasDynamicHelp": true,
1305
- "helpValue": "<minutes>",
1306
- "multiple": false,
1307
- "type": "option"
1308
- },
1309
- "poll-interval": {
1310
- "char": "i",
1311
- "exclusive": [
1312
- "async"
1313
- ],
1314
- "name": "poll-interval",
1315
- "summary": "Number of seconds to wait between status polling requests.",
1316
- "hasDynamicHelp": true,
1317
- "helpValue": "<seconds>",
1318
- "multiple": false,
1319
- "type": "option"
1320
- },
1321
- "async": {
1322
- "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\".",
1323
- "exclusive": [
1324
- "wait",
1325
- "poll-interval"
1173
+ "api-version": {
1174
+ "aliases": [
1175
+ "apiversion",
1176
+ "a"
1326
1177
  ],
1327
- "name": "async",
1328
- "summary": "Request the sandbox refresh, but don't wait for it to complete.",
1329
- "allowNo": false,
1330
- "type": "boolean"
1331
- },
1332
- "name": {
1333
- "char": "n",
1334
- "name": "name",
1335
- "summary": "Name of the existing sandbox org in your production org that you want to refresh.",
1178
+ "deprecateAliases": true,
1179
+ "description": "Override the api version used for api requests made by this command",
1180
+ "name": "api-version",
1181
+ "summary": "API version to use; default is the most recent API version.",
1336
1182
  "hasDynamicHelp": false,
1337
1183
  "multiple": false,
1338
1184
  "type": "option"
1339
1185
  },
1340
- "definition-file": {
1341
- "char": "f",
1342
- "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.",
1343
- "name": "definition-file",
1344
- "summary": "Path to a sandbox definition file for overriding its configuration when you refresh it.",
1345
- "hasDynamicHelp": false,
1346
- "multiple": false,
1347
- "type": "option"
1348
- },
1349
- "target-org": {
1350
- "char": "o",
1351
- "name": "target-org",
1352
- "noCacheDefault": true,
1353
- "required": true,
1354
- "summary": "Username or alias of the production org that contains the sandbox license.",
1355
- "hasDynamicHelp": true,
1356
- "multiple": false,
1357
- "type": "option"
1358
- },
1359
- "no-prompt": {
1360
- "name": "no-prompt",
1361
- "summary": "Don't prompt for confirmation about the sandbox refresh.",
1362
- "allowNo": false,
1363
- "type": "boolean"
1364
- }
1365
- },
1366
- "hasDynamicHelp": true,
1367
- "hiddenAliases": [],
1368
- "id": "org:refresh:sandbox",
1369
- "pluginAlias": "@salesforce/plugin-org",
1370
- "pluginName": "@salesforce/plugin-org",
1371
- "pluginType": "core",
1372
- "strict": true,
1373
- "summary": "Refresh a sandbox org using the sandbox name.",
1374
- "isESM": true,
1375
- "relativePath": [
1376
- "lib",
1377
- "commands",
1378
- "org",
1379
- "refresh",
1380
- "sandbox.js"
1381
- ],
1382
- "aliasPermutations": [],
1383
- "permutations": [
1384
- "org:refresh:sandbox",
1385
- "refresh:org:sandbox",
1386
- "refresh:sandbox:org",
1387
- "org:sandbox:refresh",
1388
- "sandbox:org:refresh",
1389
- "sandbox:refresh:org"
1390
- ]
1391
- },
1392
- "org:list:metadata-types": {
1393
- "aliases": [
1394
- "force:mdapi:describemetadata"
1395
- ],
1396
- "args": {},
1397
- "deprecateAliases": true,
1398
- "description": "The information includes Apex classes and triggers, custom objects, custom fields on standard objects, tab sets that define an app, and many other metadata types. Use this information to identify the syntax needed for a <name> element in a manifest file (package.xml).\n\nThe username that you use to connect to the org must have the Modify All Data or Modify Metadata Through Metadata API Functions permission.",
1399
- "examples": [
1400
- "Display information about all known and enabled metadata types in the org with alias \"my-dev-org\" using API version 57.0:\n$ <%= config.bin %> <%= command.id %> --api-version 57.0 --target-org my-dev-org",
1401
- "Display only the metadata types that aren't yet supported by Salesforce CLI in your default org and write the results to the specified file:\n$ <%= config.bin %> <%= command.id %> --output-file /path/to/outputfilename.txt --filter-known"
1402
- ],
1403
- "flags": {
1404
- "json": {
1405
- "description": "Format output as json.",
1406
- "helpGroup": "GLOBAL",
1407
- "name": "json",
1408
- "allowNo": false,
1409
- "type": "boolean"
1410
- },
1411
- "flags-dir": {
1412
- "helpGroup": "GLOBAL",
1413
- "name": "flags-dir",
1414
- "summary": "Import flag values from a directory.",
1415
- "hasDynamicHelp": false,
1416
- "multiple": false,
1417
- "type": "option"
1418
- },
1419
- "api-version": {
1420
- "aliases": [
1421
- "apiversion",
1422
- "a"
1423
- ],
1424
- "deprecateAliases": true,
1425
- "description": "Override the api version used for api requests made by this command",
1426
- "name": "api-version",
1427
- "summary": "API version to use; default is the most recent API version.",
1428
- "hasDynamicHelp": false,
1429
- "multiple": false,
1430
- "type": "option"
1431
- },
1432
- "loglevel": {
1433
- "deprecated": {
1434
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
1435
- },
1436
- "hidden": true,
1437
- "name": "loglevel",
1186
+ "loglevel": {
1187
+ "deprecated": {
1188
+ "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
1189
+ },
1190
+ "hidden": true,
1191
+ "name": "loglevel",
1438
1192
  "hasDynamicHelp": false,
1439
1193
  "multiple": false,
1440
1194
  "type": "option"
@@ -1648,6 +1402,252 @@
1648
1402
  "metadata:list:org"
1649
1403
  ]
1650
1404
  },
1405
+ "org:open:agent": {
1406
+ "aliases": [],
1407
+ "args": {},
1408
+ "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.",
1409
+ "examples": [
1410
+ "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",
1411
+ "Open the agent in an incognito window of your default browser:\n$ <%= config.bin %> <%= command.id %> --private --name Coral_Cloud_Agent:",
1412
+ "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"
1413
+ ],
1414
+ "flags": {
1415
+ "json": {
1416
+ "description": "Format output as json.",
1417
+ "helpGroup": "GLOBAL",
1418
+ "name": "json",
1419
+ "allowNo": false,
1420
+ "type": "boolean"
1421
+ },
1422
+ "flags-dir": {
1423
+ "helpGroup": "GLOBAL",
1424
+ "name": "flags-dir",
1425
+ "summary": "Import flag values from a directory.",
1426
+ "hasDynamicHelp": false,
1427
+ "multiple": false,
1428
+ "type": "option"
1429
+ },
1430
+ "target-org": {
1431
+ "char": "o",
1432
+ "name": "target-org",
1433
+ "noCacheDefault": true,
1434
+ "required": true,
1435
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1436
+ "hasDynamicHelp": true,
1437
+ "multiple": false,
1438
+ "type": "option"
1439
+ },
1440
+ "api-version": {
1441
+ "description": "Override the api version used for api requests made by this command",
1442
+ "name": "api-version",
1443
+ "hasDynamicHelp": false,
1444
+ "multiple": false,
1445
+ "type": "option"
1446
+ },
1447
+ "name": {
1448
+ "char": "n",
1449
+ "name": "name",
1450
+ "required": true,
1451
+ "summary": "API name, also known as developer name, of the agent you want to open in the org's Agent Builder UI.",
1452
+ "hasDynamicHelp": false,
1453
+ "multiple": false,
1454
+ "type": "option"
1455
+ },
1456
+ "private": {
1457
+ "exclusive": [
1458
+ "url-only",
1459
+ "browser"
1460
+ ],
1461
+ "name": "private",
1462
+ "summary": "Open the org in the default browser using private (incognito) mode.",
1463
+ "allowNo": false,
1464
+ "type": "boolean"
1465
+ },
1466
+ "browser": {
1467
+ "char": "b",
1468
+ "exclusive": [
1469
+ "url-only",
1470
+ "private"
1471
+ ],
1472
+ "name": "browser",
1473
+ "summary": "Browser where the org opens.",
1474
+ "hasDynamicHelp": false,
1475
+ "multiple": false,
1476
+ "options": [
1477
+ "chrome",
1478
+ "edge",
1479
+ "firefox"
1480
+ ],
1481
+ "type": "option"
1482
+ },
1483
+ "url-only": {
1484
+ "aliases": [
1485
+ "urlonly"
1486
+ ],
1487
+ "char": "r",
1488
+ "deprecateAliases": true,
1489
+ "name": "url-only",
1490
+ "summary": "Display navigation URL, but don’t launch browser.",
1491
+ "allowNo": false,
1492
+ "type": "boolean"
1493
+ }
1494
+ },
1495
+ "hasDynamicHelp": true,
1496
+ "hiddenAliases": [],
1497
+ "id": "org:open:agent",
1498
+ "pluginAlias": "@salesforce/plugin-org",
1499
+ "pluginName": "@salesforce/plugin-org",
1500
+ "pluginType": "core",
1501
+ "state": "beta",
1502
+ "strict": true,
1503
+ "summary": "Open an agent in your org's Agent Builder UI in a browser.",
1504
+ "enableJsonFlag": true,
1505
+ "isESM": true,
1506
+ "relativePath": [
1507
+ "lib",
1508
+ "commands",
1509
+ "org",
1510
+ "open",
1511
+ "agent.js"
1512
+ ],
1513
+ "aliasPermutations": [],
1514
+ "permutations": [
1515
+ "org:open:agent",
1516
+ "open:org:agent",
1517
+ "open:agent:org",
1518
+ "org:agent:open",
1519
+ "agent:org:open",
1520
+ "agent:open:org"
1521
+ ]
1522
+ },
1523
+ "org:refresh:sandbox": {
1524
+ "aliases": [],
1525
+ "args": {},
1526
+ "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.",
1527
+ "examples": [
1528
+ "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",
1529
+ "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",
1530
+ "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"
1531
+ ],
1532
+ "flags": {
1533
+ "json": {
1534
+ "description": "Format output as json.",
1535
+ "helpGroup": "GLOBAL",
1536
+ "name": "json",
1537
+ "allowNo": false,
1538
+ "type": "boolean"
1539
+ },
1540
+ "flags-dir": {
1541
+ "helpGroup": "GLOBAL",
1542
+ "name": "flags-dir",
1543
+ "summary": "Import flag values from a directory.",
1544
+ "hasDynamicHelp": false,
1545
+ "multiple": false,
1546
+ "type": "option"
1547
+ },
1548
+ "no-auto-activate": {
1549
+ "description": "By default, a sandbox auto-activates after a refresh. Use this flag to control sandbox activation manually.",
1550
+ "name": "no-auto-activate",
1551
+ "summary": "Disable auto-activation of the sandbox after a successful refresh.",
1552
+ "allowNo": false,
1553
+ "type": "boolean"
1554
+ },
1555
+ "wait": {
1556
+ "char": "w",
1557
+ "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.",
1558
+ "exclusive": [
1559
+ "async"
1560
+ ],
1561
+ "name": "wait",
1562
+ "summary": "Number of minutes to poll for sandbox refresh status.",
1563
+ "hasDynamicHelp": true,
1564
+ "helpValue": "<minutes>",
1565
+ "multiple": false,
1566
+ "type": "option"
1567
+ },
1568
+ "poll-interval": {
1569
+ "char": "i",
1570
+ "exclusive": [
1571
+ "async"
1572
+ ],
1573
+ "name": "poll-interval",
1574
+ "summary": "Number of seconds to wait between status polling requests.",
1575
+ "hasDynamicHelp": true,
1576
+ "helpValue": "<seconds>",
1577
+ "multiple": false,
1578
+ "type": "option"
1579
+ },
1580
+ "async": {
1581
+ "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\".",
1582
+ "exclusive": [
1583
+ "wait",
1584
+ "poll-interval"
1585
+ ],
1586
+ "name": "async",
1587
+ "summary": "Request the sandbox refresh, but don't wait for it to complete.",
1588
+ "allowNo": false,
1589
+ "type": "boolean"
1590
+ },
1591
+ "name": {
1592
+ "char": "n",
1593
+ "name": "name",
1594
+ "summary": "Name of the existing sandbox org in your production org that you want to refresh.",
1595
+ "hasDynamicHelp": false,
1596
+ "multiple": false,
1597
+ "type": "option"
1598
+ },
1599
+ "definition-file": {
1600
+ "char": "f",
1601
+ "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.",
1602
+ "name": "definition-file",
1603
+ "summary": "Path to a sandbox definition file for overriding its configuration when you refresh it.",
1604
+ "hasDynamicHelp": false,
1605
+ "multiple": false,
1606
+ "type": "option"
1607
+ },
1608
+ "target-org": {
1609
+ "char": "o",
1610
+ "name": "target-org",
1611
+ "noCacheDefault": true,
1612
+ "required": true,
1613
+ "summary": "Username or alias of the production org that contains the sandbox license.",
1614
+ "hasDynamicHelp": true,
1615
+ "multiple": false,
1616
+ "type": "option"
1617
+ },
1618
+ "no-prompt": {
1619
+ "name": "no-prompt",
1620
+ "summary": "Don't prompt for confirmation about the sandbox refresh.",
1621
+ "allowNo": false,
1622
+ "type": "boolean"
1623
+ }
1624
+ },
1625
+ "hasDynamicHelp": true,
1626
+ "hiddenAliases": [],
1627
+ "id": "org:refresh:sandbox",
1628
+ "pluginAlias": "@salesforce/plugin-org",
1629
+ "pluginName": "@salesforce/plugin-org",
1630
+ "pluginType": "core",
1631
+ "strict": true,
1632
+ "summary": "Refresh a sandbox org using the sandbox name.",
1633
+ "isESM": true,
1634
+ "relativePath": [
1635
+ "lib",
1636
+ "commands",
1637
+ "org",
1638
+ "refresh",
1639
+ "sandbox.js"
1640
+ ],
1641
+ "aliasPermutations": [],
1642
+ "permutations": [
1643
+ "org:refresh:sandbox",
1644
+ "refresh:org:sandbox",
1645
+ "refresh:sandbox:org",
1646
+ "org:sandbox:refresh",
1647
+ "sandbox:org:refresh",
1648
+ "sandbox:refresh:org"
1649
+ ]
1650
+ },
1651
1651
  "org:resume:sandbox": {
1652
1652
  "aliases": [
1653
1653
  "env:resume:sandbox"
@@ -1851,5 +1851,5 @@
1851
1851
  ]
1852
1852
  }
1853
1853
  },
1854
- "version": "5.6.1"
1854
+ "version": "5.6.3"
1855
1855
  }
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.6.1",
4
+ "version": "5.6.3",
5
5
  "author": "Salesforce",
6
6
  "bugs": "https://github.com/forcedotcom/cli/issues",
7
7
  "dependencies": {
8
8
  "@oclif/core": "^4.2.10",
9
9
  "@oclif/multi-stage-output": "^0.8.12",
10
- "@salesforce/core": "^8.9.0",
10
+ "@salesforce/core": "^8.9.1",
11
11
  "@salesforce/kit": "^3.2.3",
12
12
  "@salesforce/sf-plugins-core": "^12.2.1",
13
13
  "@salesforce/source-deploy-retrieve": "^12.19.0",
@@ -15,7 +15,7 @@
15
15
  "ansis": "^3.16.0",
16
16
  "change-case": "^5.4.4",
17
17
  "is-wsl": "^3.1.0",
18
- "open": "^10.1.0",
18
+ "open": "^10.1.1",
19
19
  "terminal-link": "^3.0.0"
20
20
  },
21
21
  "devDependencies": {
@@ -227,7 +227,7 @@
227
227
  "exports": "./lib/index.js",
228
228
  "type": "module",
229
229
  "sfdx": {
230
- "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/5.6.1.crt",
231
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/5.6.1.sig"
230
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/5.6.3.crt",
231
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/5.6.3.sig"
232
232
  }
233
233
  }