@salesforce/plugin-org 5.2.33 → 5.2.34

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 +319 -319
  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.2.33/src/commands/org/create/sandbox.ts)_
245
+ _See code: [src/commands/org/create/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.34/src/commands/org/create/sandbox.ts)_
246
246
 
247
247
  ## `sf org create scratch`
248
248
 
@@ -396,7 +396,7 @@ FLAG DESCRIPTIONS
396
396
  Omit this flag to have Salesforce generate a unique username for your org.
397
397
  ```
398
398
 
399
- _See code: [src/commands/org/create/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.33/src/commands/org/create/scratch.ts)_
399
+ _See code: [src/commands/org/create/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.34/src/commands/org/create/scratch.ts)_
400
400
 
401
401
  ## `sf org delete sandbox`
402
402
 
@@ -442,7 +442,7 @@ EXAMPLES
442
442
  $ sf org delete sandbox --target-org my-sandbox --no-prompt
443
443
  ```
444
444
 
445
- _See code: [src/commands/org/delete/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.33/src/commands/org/delete/sandbox.ts)_
445
+ _See code: [src/commands/org/delete/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.34/src/commands/org/delete/sandbox.ts)_
446
446
 
447
447
  ## `sf org delete scratch`
448
448
 
@@ -486,7 +486,7 @@ EXAMPLES
486
486
  $ sf org delete scratch --target-org my-scratch-org --no-prompt
487
487
  ```
488
488
 
489
- _See code: [src/commands/org/delete/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.33/src/commands/org/delete/scratch.ts)_
489
+ _See code: [src/commands/org/delete/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.34/src/commands/org/delete/scratch.ts)_
490
490
 
491
491
  ## `sf org disable tracking`
492
492
 
@@ -525,7 +525,7 @@ EXAMPLES
525
525
  $ sf org disable tracking
526
526
  ```
527
527
 
528
- _See code: [src/commands/org/disable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.33/src/commands/org/disable/tracking.ts)_
528
+ _See code: [src/commands/org/disable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.34/src/commands/org/disable/tracking.ts)_
529
529
 
530
530
  ## `sf org display`
531
531
 
@@ -570,7 +570,7 @@ EXAMPLES
570
570
  $ sf org display --target-org TestOrg1 --verbose
571
571
  ```
572
572
 
573
- _See code: [src/commands/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.33/src/commands/org/display.ts)_
573
+ _See code: [src/commands/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.34/src/commands/org/display.ts)_
574
574
 
575
575
  ## `sf org enable tracking`
576
576
 
@@ -612,7 +612,7 @@ EXAMPLES
612
612
  $ sf org enable tracking
613
613
  ```
614
614
 
615
- _See code: [src/commands/org/enable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.33/src/commands/org/enable/tracking.ts)_
615
+ _See code: [src/commands/org/enable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.34/src/commands/org/enable/tracking.ts)_
616
616
 
617
617
  ## `sf org list`
618
618
 
@@ -651,7 +651,7 @@ EXAMPLES
651
651
  $ sf org list --clean
652
652
  ```
653
653
 
654
- _See code: [src/commands/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.33/src/commands/org/list.ts)_
654
+ _See code: [src/commands/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.34/src/commands/org/list.ts)_
655
655
 
656
656
  ## `sf org list metadata`
657
657
 
@@ -718,7 +718,7 @@ FLAG DESCRIPTIONS
718
718
  Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.
719
719
  ```
720
720
 
721
- _See code: [src/commands/org/list/metadata.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.33/src/commands/org/list/metadata.ts)_
721
+ _See code: [src/commands/org/list/metadata.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.34/src/commands/org/list/metadata.ts)_
722
722
 
723
723
  ## `sf org list metadata-types`
724
724
 
@@ -773,7 +773,7 @@ FLAG DESCRIPTIONS
773
773
  Override the api version used for api requests made by this command
774
774
  ```
775
775
 
776
- _See code: [src/commands/org/list/metadata-types.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.33/src/commands/org/list/metadata-types.ts)_
776
+ _See code: [src/commands/org/list/metadata-types.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.34/src/commands/org/list/metadata-types.ts)_
777
777
 
778
778
  ## `sf org open`
779
779
 
@@ -849,7 +849,7 @@ EXAMPLES
849
849
  $ sf org open --source-file force-app/main/default/bots/Coral_Cloud_Agent/Coral_Cloud_Agent.bot-meta.xml
850
850
  ```
851
851
 
852
- _See code: [src/commands/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.33/src/commands/org/open.ts)_
852
+ _See code: [src/commands/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.34/src/commands/org/open.ts)_
853
853
 
854
854
  ## `sf org open agent`
855
855
 
@@ -900,7 +900,7 @@ EXAMPLES
900
900
  $ sf org open agent --target-org MyTestOrg1 --browser firefox --name Coral_Cloud_Agent
901
901
  ```
902
902
 
903
- _See code: [src/commands/org/open/agent.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.33/src/commands/org/open/agent.ts)_
903
+ _See code: [src/commands/org/open/agent.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.34/src/commands/org/open/agent.ts)_
904
904
 
905
905
  ## `sf org refresh sandbox`
906
906
 
@@ -977,7 +977,7 @@ FLAG DESCRIPTIONS
977
977
  By default, a sandbox auto-activates after a refresh. Use this flag to control sandbox activation manually.
978
978
  ```
979
979
 
980
- _See code: [src/commands/org/refresh/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.33/src/commands/org/refresh/sandbox.ts)_
980
+ _See code: [src/commands/org/refresh/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.34/src/commands/org/refresh/sandbox.ts)_
981
981
 
982
982
  ## `sf org resume sandbox`
983
983
 
@@ -1040,7 +1040,7 @@ FLAG DESCRIPTIONS
1040
1040
  returns the job ID. To resume checking the sandbox creation, rerun this command.
1041
1041
  ```
1042
1042
 
1043
- _See code: [src/commands/org/resume/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.33/src/commands/org/resume/sandbox.ts)_
1043
+ _See code: [src/commands/org/resume/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.34/src/commands/org/resume/sandbox.ts)_
1044
1044
 
1045
1045
  ## `sf org resume scratch`
1046
1046
 
@@ -1087,6 +1087,6 @@ FLAG DESCRIPTIONS
1087
1087
  The job ID is valid for 24 hours after you start the scratch org creation.
1088
1088
  ```
1089
1089
 
1090
- _See code: [src/commands/org/resume/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.33/src/commands/org/resume/scratch.ts)_
1090
+ _See code: [src/commands/org/resume/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.34/src/commands/org/resume/scratch.ts)_
1091
1091
 
1092
1092
  <!-- commandsstop -->
@@ -1119,16 +1119,14 @@
1119
1119
  "tracking:enable:org"
1120
1120
  ]
1121
1121
  },
1122
- "org:list:metadata-types": {
1123
- "aliases": [
1124
- "force:mdapi:describemetadata"
1125
- ],
1122
+ "org:open:agent": {
1123
+ "aliases": [],
1126
1124
  "args": {},
1127
- "deprecateAliases": true,
1128
- "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.",
1125
+ "description": "Use the --name flag to open an agent using its API name in the Agent Builder UI of your org. To find the agent's API name, go to Setup in your org and navigate to the agent's details page.\n\nTo generate the URL but not launch it in your browser, specify --url-only.\n\nTo open Agent Builder in a specific browser, use the --browser flag. Supported browsers are \"chrome\", \"edge\", and \"firefox\". If you don't specify --browser, the org opens in your default browser.",
1129
1126
  "examples": [
1130
- "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",
1131
- "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"
1127
+ "Open the agent with API name Coral_Cloud_Agent in your default org using your default browser:\n$ <%= config.bin %> <%= command.id %> --name Coral_Cloud_Agent",
1128
+ "Open the agent in an incognito window of your default browser:\n$ <%= config.bin %> <%= command.id %> --private --name Coral_Cloud_Agent:",
1129
+ "Open the agent in an org with alias MyTestOrg1 using the Firefox browser:\n$ <%= config.bin %> <%= command.id %> --target-org MyTestOrg1 --browser firefox --name Coral_Cloud_Agent"
1132
1130
  ],
1133
1131
  "flags": {
1134
1132
  "json": {
@@ -1146,36 +1144,8 @@
1146
1144
  "multiple": false,
1147
1145
  "type": "option"
1148
1146
  },
1149
- "api-version": {
1150
- "aliases": [
1151
- "apiversion",
1152
- "a"
1153
- ],
1154
- "deprecateAliases": true,
1155
- "description": "Override the api version used for api requests made by this command",
1156
- "name": "api-version",
1157
- "summary": "API version to use; default is the most recent API version.",
1158
- "hasDynamicHelp": false,
1159
- "multiple": false,
1160
- "type": "option"
1161
- },
1162
- "loglevel": {
1163
- "deprecated": {
1164
- "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."
1165
- },
1166
- "hidden": true,
1167
- "name": "loglevel",
1168
- "hasDynamicHelp": false,
1169
- "multiple": false,
1170
- "type": "option"
1171
- },
1172
1147
  "target-org": {
1173
- "aliases": [
1174
- "targetusername",
1175
- "u"
1176
- ],
1177
1148
  "char": "o",
1178
- "deprecateAliases": true,
1179
1149
  "name": "target-org",
1180
1150
  "noCacheDefault": true,
1181
1151
  "required": true,
@@ -1184,198 +1154,87 @@
1184
1154
  "multiple": false,
1185
1155
  "type": "option"
1186
1156
  },
1187
- "output-file": {
1188
- "aliases": [
1189
- "resultfile"
1190
- ],
1191
- "char": "f",
1192
- "deprecateAliases": true,
1193
- "description": "Directing the output to a file makes it easier to extract relevant information for your package.xml manifest file. The default output destination is the terminal or command window console.",
1194
- "name": "output-file",
1195
- "summary": "Pathname of the file in which to write the results.",
1196
- "hasDynamicHelp": false,
1197
- "multiple": false,
1198
- "type": "option"
1199
- },
1200
- "filter-known": {
1201
- "aliases": [
1202
- "filterknown"
1203
- ],
1204
- "char": "k",
1205
- "deprecateAliases": true,
1206
- "hidden": true,
1207
- "name": "filter-known",
1208
- "summary": "Filter the known metadata types from the result to display only the types not yet fully supported by Salesforce CLI.\n\nfilter metadata known by the CLI",
1209
- "allowNo": false,
1210
- "type": "boolean"
1211
- }
1212
- },
1213
- "hasDynamicHelp": true,
1214
- "hiddenAliases": [],
1215
- "id": "org:list:metadata-types",
1216
- "pluginAlias": "@salesforce/plugin-org",
1217
- "pluginName": "@salesforce/plugin-org",
1218
- "pluginType": "core",
1219
- "strict": true,
1220
- "summary": "Display details about the metadata types that are enabled for your org.",
1221
- "enableJsonFlag": true,
1222
- "isESM": true,
1223
- "relativePath": [
1224
- "lib",
1225
- "commands",
1226
- "org",
1227
- "list",
1228
- "metadata-types.js"
1229
- ],
1230
- "aliasPermutations": [
1231
- "force:mdapi:describemetadata",
1232
- "mdapi:force:describemetadata",
1233
- "mdapi:describemetadata:force",
1234
- "force:describemetadata:mdapi",
1235
- "describemetadata:force:mdapi",
1236
- "describemetadata:mdapi:force"
1237
- ],
1238
- "permutations": [
1239
- "org:list:metadata-types",
1240
- "list:org:metadata-types",
1241
- "list:metadata-types:org",
1242
- "org:metadata-types:list",
1243
- "metadata-types:org:list",
1244
- "metadata-types:list:org"
1245
- ]
1246
- },
1247
- "org:list:metadata": {
1248
- "aliases": [
1249
- "force:mdapi:listmetadata"
1250
- ],
1251
- "args": {},
1252
- "deprecateAliases": true,
1253
- "description": "Use this command to identify individual components in your manifest file or if you want a high-level view of particular metadata types in your org. For example, you can use this command to return a list of names of all the CustomObject or Layout components in your org, then use this information in a retrieve command that returns a subset of these components.\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.",
1254
- "examples": [
1255
- "List the CustomObject components, and their properties, in the org with alias \"my-dev-org\":\n$ <%= config.bin %> <%= command.id %> --metadata-type CustomObject --target-org my-dev-org",
1256
- "List the CustomObject components in your default org, write the output to the specified file, and use API version 57.0:\n$ <%= config.bin %> <%= command.id %> --metadata-type CustomObject --api-version 57.0 --output-file /path/to/outputfilename.txt",
1257
- "List the Dashboard components in your default org that are contained in the \"folderSales\" folder, write the output to the specified file, and use API version 57.0:\n$ <%= config.bin %> <%= command.id %> --metadata-type Dashboard --folder folderSales --api-version 57.0 --output-file /path/to/outputfilename.txt"
1258
- ],
1259
- "flags": {
1260
- "json": {
1261
- "description": "Format output as json.",
1262
- "helpGroup": "GLOBAL",
1263
- "name": "json",
1264
- "allowNo": false,
1265
- "type": "boolean"
1266
- },
1267
- "flags-dir": {
1268
- "helpGroup": "GLOBAL",
1269
- "name": "flags-dir",
1270
- "summary": "Import flag values from a directory.",
1271
- "hasDynamicHelp": false,
1272
- "multiple": false,
1273
- "type": "option"
1274
- },
1275
1157
  "api-version": {
1276
- "aliases": [
1277
- "apiversion",
1278
- "a"
1279
- ],
1280
- "deprecateAliases": true,
1281
1158
  "description": "Override the api version used for api requests made by this command",
1282
1159
  "name": "api-version",
1283
- "summary": "API version to use; default is the most recent API version.",
1284
1160
  "hasDynamicHelp": false,
1285
1161
  "multiple": false,
1286
1162
  "type": "option"
1287
1163
  },
1288
- "loglevel": {
1289
- "deprecated": {
1290
- "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."
1291
- },
1292
- "hidden": true,
1293
- "name": "loglevel",
1164
+ "name": {
1165
+ "char": "n",
1166
+ "name": "name",
1167
+ "required": true,
1168
+ "summary": "API name, also known as developer name, of the agent you want to open in the org's Agent Builder UI.",
1294
1169
  "hasDynamicHelp": false,
1295
1170
  "multiple": false,
1296
1171
  "type": "option"
1297
1172
  },
1298
- "target-org": {
1299
- "aliases": [
1300
- "targetusername",
1301
- "u"
1173
+ "private": {
1174
+ "exclusive": [
1175
+ "url-only",
1176
+ "browser"
1302
1177
  ],
1303
- "char": "o",
1304
- "deprecateAliases": true,
1305
- "name": "target-org",
1306
- "noCacheDefault": true,
1307
- "required": true,
1308
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1309
- "hasDynamicHelp": true,
1310
- "multiple": false,
1311
- "type": "option"
1178
+ "name": "private",
1179
+ "summary": "Open the org in the default browser using private (incognito) mode.",
1180
+ "allowNo": false,
1181
+ "type": "boolean"
1312
1182
  },
1313
- "output-file": {
1314
- "aliases": [
1315
- "resultfile"
1183
+ "browser": {
1184
+ "char": "b",
1185
+ "exclusive": [
1186
+ "url-only",
1187
+ "private"
1316
1188
  ],
1317
- "char": "f",
1318
- "deprecateAliases": true,
1319
- "name": "output-file",
1320
- "summary": "Pathname of the file in which to write the results.",
1189
+ "name": "browser",
1190
+ "summary": "Browser where the org opens.",
1321
1191
  "hasDynamicHelp": false,
1322
1192
  "multiple": false,
1193
+ "options": [
1194
+ "chrome",
1195
+ "edge",
1196
+ "firefox"
1197
+ ],
1323
1198
  "type": "option"
1324
1199
  },
1325
- "metadata-type": {
1200
+ "url-only": {
1326
1201
  "aliases": [
1327
- "metadatatype"
1202
+ "urlonly"
1328
1203
  ],
1329
- "char": "m",
1204
+ "char": "r",
1330
1205
  "deprecateAliases": true,
1331
- "name": "metadata-type",
1332
- "required": true,
1333
- "summary": "Metadata type to be retrieved, such as CustomObject; metadata type names are case-sensitive.",
1334
- "hasDynamicHelp": false,
1335
- "multiple": false,
1336
- "type": "option"
1337
- },
1338
- "folder": {
1339
- "description": "Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.",
1340
- "name": "folder",
1341
- "summary": "Folder associated with the component; required for components that use folders; folder names are case-sensitive.",
1342
- "hasDynamicHelp": false,
1343
- "multiple": false,
1344
- "type": "option"
1206
+ "name": "url-only",
1207
+ "summary": "Display navigation URL, but don’t launch browser.",
1208
+ "allowNo": false,
1209
+ "type": "boolean"
1345
1210
  }
1346
1211
  },
1347
1212
  "hasDynamicHelp": true,
1348
1213
  "hiddenAliases": [],
1349
- "id": "org:list:metadata",
1214
+ "id": "org:open:agent",
1350
1215
  "pluginAlias": "@salesforce/plugin-org",
1351
1216
  "pluginName": "@salesforce/plugin-org",
1352
1217
  "pluginType": "core",
1218
+ "state": "beta",
1353
1219
  "strict": true,
1354
- "summary": "List the metadata components and properties of a specified type.",
1220
+ "summary": "Open an agent in your org's Agent Builder UI in a browser.",
1355
1221
  "enableJsonFlag": true,
1356
1222
  "isESM": true,
1357
1223
  "relativePath": [
1358
1224
  "lib",
1359
1225
  "commands",
1360
1226
  "org",
1361
- "list",
1362
- "metadata.js"
1363
- ],
1364
- "aliasPermutations": [
1365
- "force:mdapi:listmetadata",
1366
- "mdapi:force:listmetadata",
1367
- "mdapi:listmetadata:force",
1368
- "force:listmetadata:mdapi",
1369
- "listmetadata:force:mdapi",
1370
- "listmetadata:mdapi:force"
1227
+ "open",
1228
+ "agent.js"
1371
1229
  ],
1230
+ "aliasPermutations": [],
1372
1231
  "permutations": [
1373
- "org:list:metadata",
1374
- "list:org:metadata",
1375
- "list:metadata:org",
1376
- "org:metadata:list",
1377
- "metadata:org:list",
1378
- "metadata:list:org"
1232
+ "org:open:agent",
1233
+ "open:org:agent",
1234
+ "open:agent:org",
1235
+ "org:agent:open",
1236
+ "agent:org:open",
1237
+ "agent:open:org"
1379
1238
  ]
1380
1239
  },
1381
1240
  "org:refresh:sandbox": {
@@ -1506,135 +1365,17 @@
1506
1365
  "sandbox:refresh:org"
1507
1366
  ]
1508
1367
  },
1509
- "org:open:agent": {
1510
- "aliases": [],
1368
+ "org:resume:sandbox": {
1369
+ "aliases": [
1370
+ "env:resume:sandbox"
1371
+ ],
1511
1372
  "args": {},
1512
- "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.",
1373
+ "deprecateAliases": true,
1374
+ "description": "Sandbox creation can take a long time. If the original \"<%= config.bin %> org create sandbox\" command either times out, or you specified the --async flag, the command displays a job ID. Use this job ID to check whether the sandbox creation is complete, and if it is, the command then logs into it.\n\nYou can also use the sandbox name to check the status or the --use-most-recent flag to use the job ID of the most recent sandbox creation.",
1513
1375
  "examples": [
1514
- "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",
1515
- "Open the agent in an incognito window of your default browser:\n$ <%= config.bin %> <%= command.id %> --private --name Coral_Cloud_Agent:",
1516
- "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"
1517
- ],
1518
- "flags": {
1519
- "json": {
1520
- "description": "Format output as json.",
1521
- "helpGroup": "GLOBAL",
1522
- "name": "json",
1523
- "allowNo": false,
1524
- "type": "boolean"
1525
- },
1526
- "flags-dir": {
1527
- "helpGroup": "GLOBAL",
1528
- "name": "flags-dir",
1529
- "summary": "Import flag values from a directory.",
1530
- "hasDynamicHelp": false,
1531
- "multiple": false,
1532
- "type": "option"
1533
- },
1534
- "target-org": {
1535
- "char": "o",
1536
- "name": "target-org",
1537
- "noCacheDefault": true,
1538
- "required": true,
1539
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1540
- "hasDynamicHelp": true,
1541
- "multiple": false,
1542
- "type": "option"
1543
- },
1544
- "api-version": {
1545
- "description": "Override the api version used for api requests made by this command",
1546
- "name": "api-version",
1547
- "hasDynamicHelp": false,
1548
- "multiple": false,
1549
- "type": "option"
1550
- },
1551
- "name": {
1552
- "char": "n",
1553
- "name": "name",
1554
- "required": true,
1555
- "summary": "API name, also known as developer name, of the agent you want to open in the org's Agent Builder UI.",
1556
- "hasDynamicHelp": false,
1557
- "multiple": false,
1558
- "type": "option"
1559
- },
1560
- "private": {
1561
- "exclusive": [
1562
- "url-only",
1563
- "browser"
1564
- ],
1565
- "name": "private",
1566
- "summary": "Open the org in the default browser using private (incognito) mode.",
1567
- "allowNo": false,
1568
- "type": "boolean"
1569
- },
1570
- "browser": {
1571
- "char": "b",
1572
- "exclusive": [
1573
- "url-only",
1574
- "private"
1575
- ],
1576
- "name": "browser",
1577
- "summary": "Browser where the org opens.",
1578
- "hasDynamicHelp": false,
1579
- "multiple": false,
1580
- "options": [
1581
- "chrome",
1582
- "edge",
1583
- "firefox"
1584
- ],
1585
- "type": "option"
1586
- },
1587
- "url-only": {
1588
- "aliases": [
1589
- "urlonly"
1590
- ],
1591
- "char": "r",
1592
- "deprecateAliases": true,
1593
- "name": "url-only",
1594
- "summary": "Display navigation URL, but don’t launch browser.",
1595
- "allowNo": false,
1596
- "type": "boolean"
1597
- }
1598
- },
1599
- "hasDynamicHelp": true,
1600
- "hiddenAliases": [],
1601
- "id": "org:open:agent",
1602
- "pluginAlias": "@salesforce/plugin-org",
1603
- "pluginName": "@salesforce/plugin-org",
1604
- "pluginType": "core",
1605
- "state": "beta",
1606
- "strict": true,
1607
- "summary": "Open an agent in your org's Agent Builder UI in a browser.",
1608
- "enableJsonFlag": true,
1609
- "isESM": true,
1610
- "relativePath": [
1611
- "lib",
1612
- "commands",
1613
- "org",
1614
- "open",
1615
- "agent.js"
1616
- ],
1617
- "aliasPermutations": [],
1618
- "permutations": [
1619
- "org:open:agent",
1620
- "open:org:agent",
1621
- "open:agent:org",
1622
- "org:agent:open",
1623
- "agent:org:open",
1624
- "agent:open:org"
1625
- ]
1626
- },
1627
- "org:resume:sandbox": {
1628
- "aliases": [
1629
- "env:resume:sandbox"
1630
- ],
1631
- "args": {},
1632
- "deprecateAliases": true,
1633
- "description": "Sandbox creation can take a long time. If the original \"<%= config.bin %> org create sandbox\" command either times out, or you specified the --async flag, the command displays a job ID. Use this job ID to check whether the sandbox creation is complete, and if it is, the command then logs into it.\n\nYou can also use the sandbox name to check the status or the --use-most-recent flag to use the job ID of the most recent sandbox creation.",
1634
- "examples": [
1635
- "Check the status of a sandbox creation using its name and specify a production org with alias \"prodOrg\":\n<%= config.bin %> <%= command.id %> --name mysandbox --target-org prodOrg",
1636
- "Check the status using the job ID:\n<%= config.bin %> <%= command.id %> --job-id 0GRxxxxxxxx",
1637
- "Check the status of the most recent sandbox create request:\n<%= config.bin %> <%= command.id %> --use-most-recent"
1376
+ "Check the status of a sandbox creation using its name and specify a production org with alias \"prodOrg\":\n<%= config.bin %> <%= command.id %> --name mysandbox --target-org prodOrg",
1377
+ "Check the status using the job ID:\n<%= config.bin %> <%= command.id %> --job-id 0GRxxxxxxxx",
1378
+ "Check the status of the most recent sandbox create request:\n<%= config.bin %> <%= command.id %> --use-most-recent"
1638
1379
  ],
1639
1380
  "flags": {
1640
1381
  "json": {
@@ -1814,7 +1555,266 @@
1814
1555
  "scratch:org:resume",
1815
1556
  "scratch:resume:org"
1816
1557
  ]
1558
+ },
1559
+ "org:list:metadata-types": {
1560
+ "aliases": [
1561
+ "force:mdapi:describemetadata"
1562
+ ],
1563
+ "args": {},
1564
+ "deprecateAliases": true,
1565
+ "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.",
1566
+ "examples": [
1567
+ "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",
1568
+ "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"
1569
+ ],
1570
+ "flags": {
1571
+ "json": {
1572
+ "description": "Format output as json.",
1573
+ "helpGroup": "GLOBAL",
1574
+ "name": "json",
1575
+ "allowNo": false,
1576
+ "type": "boolean"
1577
+ },
1578
+ "flags-dir": {
1579
+ "helpGroup": "GLOBAL",
1580
+ "name": "flags-dir",
1581
+ "summary": "Import flag values from a directory.",
1582
+ "hasDynamicHelp": false,
1583
+ "multiple": false,
1584
+ "type": "option"
1585
+ },
1586
+ "api-version": {
1587
+ "aliases": [
1588
+ "apiversion",
1589
+ "a"
1590
+ ],
1591
+ "deprecateAliases": true,
1592
+ "description": "Override the api version used for api requests made by this command",
1593
+ "name": "api-version",
1594
+ "summary": "API version to use; default is the most recent API version.",
1595
+ "hasDynamicHelp": false,
1596
+ "multiple": false,
1597
+ "type": "option"
1598
+ },
1599
+ "loglevel": {
1600
+ "deprecated": {
1601
+ "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."
1602
+ },
1603
+ "hidden": true,
1604
+ "name": "loglevel",
1605
+ "hasDynamicHelp": false,
1606
+ "multiple": false,
1607
+ "type": "option"
1608
+ },
1609
+ "target-org": {
1610
+ "aliases": [
1611
+ "targetusername",
1612
+ "u"
1613
+ ],
1614
+ "char": "o",
1615
+ "deprecateAliases": true,
1616
+ "name": "target-org",
1617
+ "noCacheDefault": true,
1618
+ "required": true,
1619
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1620
+ "hasDynamicHelp": true,
1621
+ "multiple": false,
1622
+ "type": "option"
1623
+ },
1624
+ "output-file": {
1625
+ "aliases": [
1626
+ "resultfile"
1627
+ ],
1628
+ "char": "f",
1629
+ "deprecateAliases": true,
1630
+ "description": "Directing the output to a file makes it easier to extract relevant information for your package.xml manifest file. The default output destination is the terminal or command window console.",
1631
+ "name": "output-file",
1632
+ "summary": "Pathname of the file in which to write the results.",
1633
+ "hasDynamicHelp": false,
1634
+ "multiple": false,
1635
+ "type": "option"
1636
+ },
1637
+ "filter-known": {
1638
+ "aliases": [
1639
+ "filterknown"
1640
+ ],
1641
+ "char": "k",
1642
+ "deprecateAliases": true,
1643
+ "hidden": true,
1644
+ "name": "filter-known",
1645
+ "summary": "Filter the known metadata types from the result to display only the types not yet fully supported by Salesforce CLI.\n\nfilter metadata known by the CLI",
1646
+ "allowNo": false,
1647
+ "type": "boolean"
1648
+ }
1649
+ },
1650
+ "hasDynamicHelp": true,
1651
+ "hiddenAliases": [],
1652
+ "id": "org:list:metadata-types",
1653
+ "pluginAlias": "@salesforce/plugin-org",
1654
+ "pluginName": "@salesforce/plugin-org",
1655
+ "pluginType": "core",
1656
+ "strict": true,
1657
+ "summary": "Display details about the metadata types that are enabled for your org.",
1658
+ "enableJsonFlag": true,
1659
+ "isESM": true,
1660
+ "relativePath": [
1661
+ "lib",
1662
+ "commands",
1663
+ "org",
1664
+ "list",
1665
+ "metadata-types.js"
1666
+ ],
1667
+ "aliasPermutations": [
1668
+ "force:mdapi:describemetadata",
1669
+ "mdapi:force:describemetadata",
1670
+ "mdapi:describemetadata:force",
1671
+ "force:describemetadata:mdapi",
1672
+ "describemetadata:force:mdapi",
1673
+ "describemetadata:mdapi:force"
1674
+ ],
1675
+ "permutations": [
1676
+ "org:list:metadata-types",
1677
+ "list:org:metadata-types",
1678
+ "list:metadata-types:org",
1679
+ "org:metadata-types:list",
1680
+ "metadata-types:org:list",
1681
+ "metadata-types:list:org"
1682
+ ]
1683
+ },
1684
+ "org:list:metadata": {
1685
+ "aliases": [
1686
+ "force:mdapi:listmetadata"
1687
+ ],
1688
+ "args": {},
1689
+ "deprecateAliases": true,
1690
+ "description": "Use this command to identify individual components in your manifest file or if you want a high-level view of particular metadata types in your org. For example, you can use this command to return a list of names of all the CustomObject or Layout components in your org, then use this information in a retrieve command that returns a subset of these components.\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.",
1691
+ "examples": [
1692
+ "List the CustomObject components, and their properties, in the org with alias \"my-dev-org\":\n$ <%= config.bin %> <%= command.id %> --metadata-type CustomObject --target-org my-dev-org",
1693
+ "List the CustomObject components in your default org, write the output to the specified file, and use API version 57.0:\n$ <%= config.bin %> <%= command.id %> --metadata-type CustomObject --api-version 57.0 --output-file /path/to/outputfilename.txt",
1694
+ "List the Dashboard components in your default org that are contained in the \"folderSales\" folder, write the output to the specified file, and use API version 57.0:\n$ <%= config.bin %> <%= command.id %> --metadata-type Dashboard --folder folderSales --api-version 57.0 --output-file /path/to/outputfilename.txt"
1695
+ ],
1696
+ "flags": {
1697
+ "json": {
1698
+ "description": "Format output as json.",
1699
+ "helpGroup": "GLOBAL",
1700
+ "name": "json",
1701
+ "allowNo": false,
1702
+ "type": "boolean"
1703
+ },
1704
+ "flags-dir": {
1705
+ "helpGroup": "GLOBAL",
1706
+ "name": "flags-dir",
1707
+ "summary": "Import flag values from a directory.",
1708
+ "hasDynamicHelp": false,
1709
+ "multiple": false,
1710
+ "type": "option"
1711
+ },
1712
+ "api-version": {
1713
+ "aliases": [
1714
+ "apiversion",
1715
+ "a"
1716
+ ],
1717
+ "deprecateAliases": true,
1718
+ "description": "Override the api version used for api requests made by this command",
1719
+ "name": "api-version",
1720
+ "summary": "API version to use; default is the most recent API version.",
1721
+ "hasDynamicHelp": false,
1722
+ "multiple": false,
1723
+ "type": "option"
1724
+ },
1725
+ "loglevel": {
1726
+ "deprecated": {
1727
+ "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."
1728
+ },
1729
+ "hidden": true,
1730
+ "name": "loglevel",
1731
+ "hasDynamicHelp": false,
1732
+ "multiple": false,
1733
+ "type": "option"
1734
+ },
1735
+ "target-org": {
1736
+ "aliases": [
1737
+ "targetusername",
1738
+ "u"
1739
+ ],
1740
+ "char": "o",
1741
+ "deprecateAliases": true,
1742
+ "name": "target-org",
1743
+ "noCacheDefault": true,
1744
+ "required": true,
1745
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1746
+ "hasDynamicHelp": true,
1747
+ "multiple": false,
1748
+ "type": "option"
1749
+ },
1750
+ "output-file": {
1751
+ "aliases": [
1752
+ "resultfile"
1753
+ ],
1754
+ "char": "f",
1755
+ "deprecateAliases": true,
1756
+ "name": "output-file",
1757
+ "summary": "Pathname of the file in which to write the results.",
1758
+ "hasDynamicHelp": false,
1759
+ "multiple": false,
1760
+ "type": "option"
1761
+ },
1762
+ "metadata-type": {
1763
+ "aliases": [
1764
+ "metadatatype"
1765
+ ],
1766
+ "char": "m",
1767
+ "deprecateAliases": true,
1768
+ "name": "metadata-type",
1769
+ "required": true,
1770
+ "summary": "Metadata type to be retrieved, such as CustomObject; metadata type names are case-sensitive.",
1771
+ "hasDynamicHelp": false,
1772
+ "multiple": false,
1773
+ "type": "option"
1774
+ },
1775
+ "folder": {
1776
+ "description": "Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.",
1777
+ "name": "folder",
1778
+ "summary": "Folder associated with the component; required for components that use folders; folder names are case-sensitive.",
1779
+ "hasDynamicHelp": false,
1780
+ "multiple": false,
1781
+ "type": "option"
1782
+ }
1783
+ },
1784
+ "hasDynamicHelp": true,
1785
+ "hiddenAliases": [],
1786
+ "id": "org:list:metadata",
1787
+ "pluginAlias": "@salesforce/plugin-org",
1788
+ "pluginName": "@salesforce/plugin-org",
1789
+ "pluginType": "core",
1790
+ "strict": true,
1791
+ "summary": "List the metadata components and properties of a specified type.",
1792
+ "enableJsonFlag": true,
1793
+ "isESM": true,
1794
+ "relativePath": [
1795
+ "lib",
1796
+ "commands",
1797
+ "org",
1798
+ "list",
1799
+ "metadata.js"
1800
+ ],
1801
+ "aliasPermutations": [
1802
+ "force:mdapi:listmetadata",
1803
+ "mdapi:force:listmetadata",
1804
+ "mdapi:listmetadata:force",
1805
+ "force:listmetadata:mdapi",
1806
+ "listmetadata:force:mdapi",
1807
+ "listmetadata:mdapi:force"
1808
+ ],
1809
+ "permutations": [
1810
+ "org:list:metadata",
1811
+ "list:org:metadata",
1812
+ "list:metadata:org",
1813
+ "org:metadata:list",
1814
+ "metadata:org:list",
1815
+ "metadata:list:org"
1816
+ ]
1817
1817
  }
1818
1818
  },
1819
- "version": "5.2.33"
1819
+ "version": "5.2.34"
1820
1820
  }
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.2.33",
4
+ "version": "5.2.34",
5
5
  "author": "Salesforce",
6
6
  "bugs": "https://github.com/forcedotcom/cli/issues",
7
7
  "dependencies": {
@@ -10,7 +10,7 @@
10
10
  "@salesforce/core": "^8.8.2",
11
11
  "@salesforce/kit": "^3.2.3",
12
12
  "@salesforce/sf-plugins-core": "^12.1.4",
13
- "@salesforce/source-deploy-retrieve": "^12.14.5",
13
+ "@salesforce/source-deploy-retrieve": "^12.15.0",
14
14
  "@salesforce/ts-types": "^2.0.12",
15
15
  "ansis": "^3.10.0",
16
16
  "change-case": "^5.4.4",
@@ -26,7 +26,7 @@
26
26
  "@salesforce/ts-sinon": "^1.4.30",
27
27
  "eslint-plugin-sf-plugin": "^1.20.14",
28
28
  "moment": "^2.30.1",
29
- "oclif": "^4.17.26",
29
+ "oclif": "^4.17.28",
30
30
  "ts-node": "^10.9.2",
31
31
  "typescript": "^5.7.3"
32
32
  },
@@ -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.2.33.crt",
231
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/5.2.33.sig"
230
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/5.2.34.crt",
231
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/5.2.34.sig"
232
232
  }
233
233
  }