@salesforce/plugin-org 5.2.34 → 5.2.36

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 +383 -383
  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.34/src/commands/org/create/sandbox.ts)_
245
+ _See code: [src/commands/org/create/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.36/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.34/src/commands/org/create/scratch.ts)_
399
+ _See code: [src/commands/org/create/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.36/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.34/src/commands/org/delete/sandbox.ts)_
445
+ _See code: [src/commands/org/delete/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.36/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.34/src/commands/org/delete/scratch.ts)_
489
+ _See code: [src/commands/org/delete/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.36/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.34/src/commands/org/disable/tracking.ts)_
528
+ _See code: [src/commands/org/disable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.36/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.34/src/commands/org/display.ts)_
573
+ _See code: [src/commands/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.36/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.34/src/commands/org/enable/tracking.ts)_
615
+ _See code: [src/commands/org/enable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.36/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.34/src/commands/org/list.ts)_
654
+ _See code: [src/commands/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.36/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.34/src/commands/org/list/metadata.ts)_
721
+ _See code: [src/commands/org/list/metadata.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.36/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.34/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.36/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.34/src/commands/org/open.ts)_
852
+ _See code: [src/commands/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.36/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.34/src/commands/org/open/agent.ts)_
903
+ _See code: [src/commands/org/open/agent.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.36/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.34/src/commands/org/refresh/sandbox.ts)_
980
+ _See code: [src/commands/org/refresh/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.36/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.34/src/commands/org/resume/sandbox.ts)_
1043
+ _See code: [src/commands/org/resume/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.36/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.34/src/commands/org/resume/scratch.ts)_
1090
+ _See code: [src/commands/org/resume/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.2.36/src/commands/org/resume/scratch.ts)_
1091
1091
 
1092
1092
  <!-- commandsstop -->
@@ -1119,14 +1119,16 @@
1119
1119
  "tracking:enable:org"
1120
1120
  ]
1121
1121
  },
1122
- "org:open:agent": {
1123
- "aliases": [],
1122
+ "org:list:metadata-types": {
1123
+ "aliases": [
1124
+ "force:mdapi:describemetadata"
1125
+ ],
1124
1126
  "args": {},
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.",
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.",
1126
1129
  "examples": [
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"
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"
1130
1132
  ],
1131
1133
  "flags": {
1132
1134
  "json": {
@@ -1144,107 +1146,115 @@
1144
1146
  "multiple": false,
1145
1147
  "type": "option"
1146
1148
  },
1147
- "target-org": {
1148
- "char": "o",
1149
- "name": "target-org",
1150
- "noCacheDefault": true,
1151
- "required": true,
1152
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1153
- "hasDynamicHelp": true,
1154
- "multiple": false,
1155
- "type": "option"
1156
- },
1157
1149
  "api-version": {
1150
+ "aliases": [
1151
+ "apiversion",
1152
+ "a"
1153
+ ],
1154
+ "deprecateAliases": true,
1158
1155
  "description": "Override the api version used for api requests made by this command",
1159
1156
  "name": "api-version",
1157
+ "summary": "API version to use; default is the most recent API version.",
1160
1158
  "hasDynamicHelp": false,
1161
1159
  "multiple": false,
1162
1160
  "type": "option"
1163
1161
  },
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.",
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",
1169
1168
  "hasDynamicHelp": false,
1170
1169
  "multiple": false,
1171
1170
  "type": "option"
1172
1171
  },
1173
- "private": {
1174
- "exclusive": [
1175
- "url-only",
1176
- "browser"
1172
+ "target-org": {
1173
+ "aliases": [
1174
+ "targetusername",
1175
+ "u"
1177
1176
  ],
1178
- "name": "private",
1179
- "summary": "Open the org in the default browser using private (incognito) mode.",
1180
- "allowNo": false,
1181
- "type": "boolean"
1177
+ "char": "o",
1178
+ "deprecateAliases": true,
1179
+ "name": "target-org",
1180
+ "noCacheDefault": true,
1181
+ "required": true,
1182
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1183
+ "hasDynamicHelp": true,
1184
+ "multiple": false,
1185
+ "type": "option"
1182
1186
  },
1183
- "browser": {
1184
- "char": "b",
1185
- "exclusive": [
1186
- "url-only",
1187
- "private"
1187
+ "output-file": {
1188
+ "aliases": [
1189
+ "resultfile"
1188
1190
  ],
1189
- "name": "browser",
1190
- "summary": "Browser where the org opens.",
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.",
1191
1196
  "hasDynamicHelp": false,
1192
1197
  "multiple": false,
1193
- "options": [
1194
- "chrome",
1195
- "edge",
1196
- "firefox"
1197
- ],
1198
1198
  "type": "option"
1199
1199
  },
1200
- "url-only": {
1200
+ "filter-known": {
1201
1201
  "aliases": [
1202
- "urlonly"
1202
+ "filterknown"
1203
1203
  ],
1204
- "char": "r",
1204
+ "char": "k",
1205
1205
  "deprecateAliases": true,
1206
- "name": "url-only",
1207
- "summary": "Display navigation URL, but don’t launch browser.",
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",
1208
1209
  "allowNo": false,
1209
1210
  "type": "boolean"
1210
1211
  }
1211
1212
  },
1212
1213
  "hasDynamicHelp": true,
1213
1214
  "hiddenAliases": [],
1214
- "id": "org:open:agent",
1215
+ "id": "org:list:metadata-types",
1215
1216
  "pluginAlias": "@salesforce/plugin-org",
1216
1217
  "pluginName": "@salesforce/plugin-org",
1217
1218
  "pluginType": "core",
1218
- "state": "beta",
1219
1219
  "strict": true,
1220
- "summary": "Open an agent in your org's Agent Builder UI in a browser.",
1220
+ "summary": "Display details about the metadata types that are enabled for your org.",
1221
1221
  "enableJsonFlag": true,
1222
1222
  "isESM": true,
1223
1223
  "relativePath": [
1224
1224
  "lib",
1225
1225
  "commands",
1226
1226
  "org",
1227
- "open",
1228
- "agent.js"
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"
1229
1237
  ],
1230
- "aliasPermutations": [],
1231
1238
  "permutations": [
1232
- "org:open:agent",
1233
- "open:org:agent",
1234
- "open:agent:org",
1235
- "org:agent:open",
1236
- "agent:org:open",
1237
- "agent:open:org"
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"
1238
1245
  ]
1239
1246
  },
1240
- "org:refresh:sandbox": {
1241
- "aliases": [],
1247
+ "org:list:metadata": {
1248
+ "aliases": [
1249
+ "force:mdapi:listmetadata"
1250
+ ],
1242
1251
  "args": {},
1243
- "description": "Refreshing a sandbox copies the metadata, and optionally data, from your source org to the refreshed sandbox org. You can optionally specify a definition file if you want to change the configuration of the refreshed sandbox, such as its license type or template ID.\n\nYou're not allowed to change the sandbox name when you refresh it with this command. If you want to change the sandbox name, first delete it with the \"org delete sandbox\" command. And then recreate it with the \"org create sandbox\" command and give it a new name.",
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.",
1244
1254
  "examples": [
1245
- "Refresh the sandbox named \"devSbx1\". The production org that contains the sandbox license has the alias \"prodOrg\".\n<%= config.bin %> <%= command.id %> --name devSbx1 --target-org prodOrg",
1246
- "Refresh the sandbox named \"devSbx2\", and override the configuration of the refreshed sandbox with the properties in the specified defintion file. The default target org is the production org, so you don't need to specify the `--target-org` flag in this case.\n<%= config.bin %> <%= command.id %> --name devSbx2 --definition-file devSbx2-config.json",
1247
- "Refresh the sandbox using the name defined in the definition file. The production org that contains the sandbox license has the alias \"prodOrg\".\n<%= config.bin %> <%= command.id %> --definition-file devSbx3-config.json --target-org prodOrg"
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"
1248
1258
  ],
1249
1259
  "flags": {
1250
1260
  "json": {
@@ -1262,120 +1272,120 @@
1262
1272
  "multiple": false,
1263
1273
  "type": "option"
1264
1274
  },
1265
- "no-auto-activate": {
1266
- "description": "By default, a sandbox auto-activates after a refresh. Use this flag to control sandbox activation manually.",
1267
- "name": "no-auto-activate",
1268
- "summary": "Disable auto-activation of the sandbox after a successful refresh.",
1269
- "allowNo": false,
1270
- "type": "boolean"
1271
- },
1272
- "wait": {
1273
- "char": "w",
1274
- "description": "If the command continues to run after the wait period, the CLI returns control of the terminal to you and displays the \"<%= config.bin %> org resume sandbox\" command for you run to check the status of the refresh. The displayed command includes the job ID for the running sandbox refresh.",
1275
- "exclusive": [
1276
- "async"
1275
+ "api-version": {
1276
+ "aliases": [
1277
+ "apiversion",
1278
+ "a"
1277
1279
  ],
1278
- "name": "wait",
1279
- "summary": "Number of minutes to poll for sandbox refresh status.",
1280
- "hasDynamicHelp": true,
1281
- "helpValue": "<minutes>",
1280
+ "deprecateAliases": true,
1281
+ "description": "Override the api version used for api requests made by this command",
1282
+ "name": "api-version",
1283
+ "summary": "API version to use; default is the most recent API version.",
1284
+ "hasDynamicHelp": false,
1282
1285
  "multiple": false,
1283
1286
  "type": "option"
1284
1287
  },
1285
- "poll-interval": {
1286
- "char": "i",
1287
- "exclusive": [
1288
- "async"
1289
- ],
1290
- "name": "poll-interval",
1291
- "summary": "Number of seconds to wait between status polling requests.",
1292
- "hasDynamicHelp": true,
1293
- "helpValue": "<seconds>",
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",
1294
+ "hasDynamicHelp": false,
1294
1295
  "multiple": false,
1295
1296
  "type": "option"
1296
1297
  },
1297
- "async": {
1298
- "description": "The command immediately displays the job ID and returns control of the terminal to you. This way, you can continue to use the CLI. To check the status of the sandbox refresh, run \"<%= config.bin %> org resume sandbox\".",
1299
- "exclusive": [
1300
- "wait",
1301
- "poll-interval"
1298
+ "target-org": {
1299
+ "aliases": [
1300
+ "targetusername",
1301
+ "u"
1302
1302
  ],
1303
- "name": "async",
1304
- "summary": "Request the sandbox refresh, but don't wait for it to complete.",
1305
- "allowNo": false,
1306
- "type": "boolean"
1307
- },
1308
- "name": {
1309
- "char": "n",
1310
- "name": "name",
1311
- "summary": "Name of the existing sandbox org in your production org that you want to refresh.",
1312
- "hasDynamicHelp": false,
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,
1313
1310
  "multiple": false,
1314
1311
  "type": "option"
1315
1312
  },
1316
- "definition-file": {
1313
+ "output-file": {
1314
+ "aliases": [
1315
+ "resultfile"
1316
+ ],
1317
1317
  "char": "f",
1318
- "description": "The sandbox definition file is a blueprint for the sandbox; use the file to change the sandbox configuration during a refresh. If you don't want to change the sandbox configuration when you refresh it, then simply use the --name flag to specify the sandbox and don't use this flag. See <https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_sandbox_definition.htm> for all the options you can specify in the definition file.",
1319
- "name": "definition-file",
1320
- "summary": "Path to a sandbox definition file for overriding its configuration when you refresh it.",
1318
+ "deprecateAliases": true,
1319
+ "name": "output-file",
1320
+ "summary": "Pathname of the file in which to write the results.",
1321
1321
  "hasDynamicHelp": false,
1322
1322
  "multiple": false,
1323
1323
  "type": "option"
1324
1324
  },
1325
- "target-org": {
1326
- "char": "o",
1327
- "name": "target-org",
1328
- "noCacheDefault": true,
1325
+ "metadata-type": {
1326
+ "aliases": [
1327
+ "metadatatype"
1328
+ ],
1329
+ "char": "m",
1330
+ "deprecateAliases": true,
1331
+ "name": "metadata-type",
1329
1332
  "required": true,
1330
- "summary": "Username or alias of the production org that contains the sandbox license.",
1331
- "hasDynamicHelp": true,
1333
+ "summary": "Metadata type to be retrieved, such as CustomObject; metadata type names are case-sensitive.",
1334
+ "hasDynamicHelp": false,
1332
1335
  "multiple": false,
1333
1336
  "type": "option"
1334
1337
  },
1335
- "no-prompt": {
1336
- "name": "no-prompt",
1337
- "summary": "Don't prompt for confirmation about the sandbox refresh.",
1338
- "allowNo": false,
1339
- "type": "boolean"
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"
1340
1345
  }
1341
1346
  },
1342
1347
  "hasDynamicHelp": true,
1343
1348
  "hiddenAliases": [],
1344
- "id": "org:refresh:sandbox",
1349
+ "id": "org:list:metadata",
1345
1350
  "pluginAlias": "@salesforce/plugin-org",
1346
1351
  "pluginName": "@salesforce/plugin-org",
1347
1352
  "pluginType": "core",
1348
1353
  "strict": true,
1349
- "summary": "Refresh a sandbox org using the sandbox name.",
1354
+ "summary": "List the metadata components and properties of a specified type.",
1355
+ "enableJsonFlag": true,
1350
1356
  "isESM": true,
1351
1357
  "relativePath": [
1352
1358
  "lib",
1353
1359
  "commands",
1354
1360
  "org",
1355
- "refresh",
1356
- "sandbox.js"
1361
+ "list",
1362
+ "metadata.js"
1357
1363
  ],
1358
- "aliasPermutations": [],
1359
- "permutations": [
1360
- "org:refresh:sandbox",
1361
- "refresh:org:sandbox",
1362
- "refresh:sandbox:org",
1363
- "org:sandbox:refresh",
1364
- "sandbox:org:refresh",
1365
- "sandbox:refresh:org"
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"
1371
+ ],
1372
+ "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"
1366
1379
  ]
1367
1380
  },
1368
- "org:resume:sandbox": {
1369
- "aliases": [
1370
- "env:resume:sandbox"
1371
- ],
1381
+ "org:open:agent": {
1382
+ "aliases": [],
1372
1383
  "args": {},
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.",
1384
+ "description": "Use the --name flag to open an agent using its API name in the Agent Builder UI of your org. To find the agent's API name, go to Setup in your org and navigate to the agent's details page.\n\nTo generate the URL but not launch it in your browser, specify --url-only.\n\nTo open Agent Builder in a specific browser, use the --browser flag. Supported browsers are \"chrome\", \"edge\", and \"firefox\". If you don't specify --browser, the org opens in your default browser.",
1375
1385
  "examples": [
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"
1386
+ "Open the agent with API name Coral_Cloud_Agent in your default org using your default browser:\n$ <%= config.bin %> <%= command.id %> --name Coral_Cloud_Agent",
1387
+ "Open the agent in an incognito window of your default browser:\n$ <%= config.bin %> <%= command.id %> --private --name Coral_Cloud_Agent:",
1388
+ "Open the agent in an org with alias MyTestOrg1 using the Firefox browser:\n$ <%= config.bin %> <%= command.id %> --target-org MyTestOrg1 --browser firefox --name Coral_Cloud_Agent"
1379
1389
  ],
1380
1390
  "flags": {
1381
1391
  "json": {
@@ -1393,101 +1403,107 @@
1393
1403
  "multiple": false,
1394
1404
  "type": "option"
1395
1405
  },
1396
- "wait": {
1397
- "char": "w",
1398
- "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To resume checking the sandbox creation, rerun this command.",
1399
- "name": "wait",
1400
- "summary": "Number of minutes to wait for the sandbox org to be ready.",
1401
- "default": "0 minutes",
1406
+ "target-org": {
1407
+ "char": "o",
1408
+ "name": "target-org",
1409
+ "noCacheDefault": true,
1410
+ "required": true,
1411
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1402
1412
  "hasDynamicHelp": true,
1403
- "helpValue": "<minutes>",
1413
+ "multiple": false,
1414
+ "type": "option"
1415
+ },
1416
+ "api-version": {
1417
+ "description": "Override the api version used for api requests made by this command",
1418
+ "name": "api-version",
1419
+ "hasDynamicHelp": false,
1404
1420
  "multiple": false,
1405
1421
  "type": "option"
1406
1422
  },
1407
1423
  "name": {
1408
1424
  "char": "n",
1409
- "exclusive": [
1410
- "job-id"
1411
- ],
1412
1425
  "name": "name",
1413
- "summary": "Name of the sandbox org.",
1426
+ "required": true,
1427
+ "summary": "API name, also known as developer name, of the agent you want to open in the org's Agent Builder UI.",
1414
1428
  "hasDynamicHelp": false,
1415
1429
  "multiple": false,
1416
1430
  "type": "option"
1417
1431
  },
1418
- "job-id": {
1419
- "char": "i",
1420
- "description": "The job ID is valid for 24 hours after you start the sandbox creation.",
1432
+ "private": {
1421
1433
  "exclusive": [
1422
- "name"
1434
+ "url-only",
1435
+ "browser"
1423
1436
  ],
1424
- "name": "job-id",
1425
- "summary": "Job ID of the incomplete sandbox creation that you want to check the status of.",
1437
+ "name": "private",
1438
+ "summary": "Open the org in the default browser using private (incognito) mode.",
1439
+ "allowNo": false,
1440
+ "type": "boolean"
1441
+ },
1442
+ "browser": {
1443
+ "char": "b",
1444
+ "exclusive": [
1445
+ "url-only",
1446
+ "private"
1447
+ ],
1448
+ "name": "browser",
1449
+ "summary": "Browser where the org opens.",
1426
1450
  "hasDynamicHelp": false,
1427
1451
  "multiple": false,
1452
+ "options": [
1453
+ "chrome",
1454
+ "edge",
1455
+ "firefox"
1456
+ ],
1428
1457
  "type": "option"
1429
1458
  },
1430
- "use-most-recent": {
1431
- "char": "l",
1432
- "name": "use-most-recent",
1433
- "summary": "Use the most recent sandbox create request.",
1459
+ "url-only": {
1460
+ "aliases": [
1461
+ "urlonly"
1462
+ ],
1463
+ "char": "r",
1464
+ "deprecateAliases": true,
1465
+ "name": "url-only",
1466
+ "summary": "Display navigation URL, but don’t launch browser.",
1434
1467
  "allowNo": false,
1435
1468
  "type": "boolean"
1436
- },
1437
- "target-org": {
1438
- "char": "o",
1439
- "description": "When it creates the sandbox org, Salesforce copies the metadata, and optionally data, from your production org to the new sandbox org.",
1440
- "name": "target-org",
1441
- "noCacheDefault": true,
1442
- "summary": "Username or alias of the production org that contains the sandbox license.",
1443
- "hasDynamicHelp": true,
1444
- "multiple": false,
1445
- "type": "option"
1446
1469
  }
1447
1470
  },
1448
1471
  "hasDynamicHelp": true,
1449
1472
  "hiddenAliases": [],
1450
- "id": "org:resume:sandbox",
1473
+ "id": "org:open:agent",
1451
1474
  "pluginAlias": "@salesforce/plugin-org",
1452
1475
  "pluginName": "@salesforce/plugin-org",
1453
1476
  "pluginType": "core",
1477
+ "state": "beta",
1454
1478
  "strict": true,
1455
- "summary": "Check the status of a sandbox creation, and log in to it if it's ready.",
1479
+ "summary": "Open an agent in your org's Agent Builder UI in a browser.",
1480
+ "enableJsonFlag": true,
1456
1481
  "isESM": true,
1457
1482
  "relativePath": [
1458
1483
  "lib",
1459
1484
  "commands",
1460
1485
  "org",
1461
- "resume",
1462
- "sandbox.js"
1463
- ],
1464
- "aliasPermutations": [
1465
- "env:resume:sandbox",
1466
- "resume:env:sandbox",
1467
- "resume:sandbox:env",
1468
- "env:sandbox:resume",
1469
- "sandbox:env:resume",
1470
- "sandbox:resume:env"
1486
+ "open",
1487
+ "agent.js"
1471
1488
  ],
1489
+ "aliasPermutations": [],
1472
1490
  "permutations": [
1473
- "org:resume:sandbox",
1474
- "resume:org:sandbox",
1475
- "resume:sandbox:org",
1476
- "org:sandbox:resume",
1477
- "sandbox:org:resume",
1478
- "sandbox:resume:org"
1491
+ "org:open:agent",
1492
+ "open:org:agent",
1493
+ "open:agent:org",
1494
+ "org:agent:open",
1495
+ "agent:org:open",
1496
+ "agent:open:org"
1479
1497
  ]
1480
1498
  },
1481
- "org:resume:scratch": {
1482
- "aliases": [
1483
- "env:resume:scratch"
1484
- ],
1499
+ "org:refresh:sandbox": {
1500
+ "aliases": [],
1485
1501
  "args": {},
1486
- "deprecateAliases": true,
1487
- "description": "When the original \"<%= config.bin %> org create scratch\" command either times out or is run with the --async flag, it displays a job ID.\n\nRun this command by either passing it a job ID or using the --use-most-recent flag to specify the most recent incomplete scratch org.",
1502
+ "description": "Refreshing a sandbox copies the metadata, and optionally data, from your source org to the refreshed sandbox org. You can optionally specify a definition file if you want to change the configuration of the refreshed sandbox, such as its license type or template ID.\n\nYou're not allowed to change the sandbox name when you refresh it with this command. If you want to change the sandbox name, first delete it with the \"org delete sandbox\" command. And then recreate it with the \"org create sandbox\" command and give it a new name.",
1488
1503
  "examples": [
1489
- "Resume a scratch org create with a job ID:\n<%= config.bin %> <%= command.id %> --job-id 2SR3u0000008fBDGAY",
1490
- "Resume your most recent incomplete scratch org:\n<%= config.bin %> <%= command.id %> --use-most-recent"
1504
+ "Refresh the sandbox named \"devSbx1\". The production org that contains the sandbox license has the alias \"prodOrg\".\n<%= config.bin %> <%= command.id %> --name devSbx1 --target-org prodOrg",
1505
+ "Refresh the sandbox named \"devSbx2\", and override the configuration of the refreshed sandbox with the properties in the specified defintion file. The default target org is the production org, so you don't need to specify the `--target-org` flag in this case.\n<%= config.bin %> <%= command.id %> --name devSbx2 --definition-file devSbx2-config.json",
1506
+ "Refresh the sandbox using the name defined in the definition file. The production org that contains the sandbox license has the alias \"prodOrg\".\n<%= config.bin %> <%= command.id %> --definition-file devSbx3-config.json --target-org prodOrg"
1491
1507
  ],
1492
1508
  "flags": {
1493
1509
  "json": {
@@ -1505,67 +1521,120 @@
1505
1521
  "multiple": false,
1506
1522
  "type": "option"
1507
1523
  },
1508
- "job-id": {
1524
+ "no-auto-activate": {
1525
+ "description": "By default, a sandbox auto-activates after a refresh. Use this flag to control sandbox activation manually.",
1526
+ "name": "no-auto-activate",
1527
+ "summary": "Disable auto-activation of the sandbox after a successful refresh.",
1528
+ "allowNo": false,
1529
+ "type": "boolean"
1530
+ },
1531
+ "wait": {
1532
+ "char": "w",
1533
+ "description": "If the command continues to run after the wait period, the CLI returns control of the terminal to you and displays the \"<%= config.bin %> org resume sandbox\" command for you run to check the status of the refresh. The displayed command includes the job ID for the running sandbox refresh.",
1534
+ "exclusive": [
1535
+ "async"
1536
+ ],
1537
+ "name": "wait",
1538
+ "summary": "Number of minutes to poll for sandbox refresh status.",
1539
+ "hasDynamicHelp": true,
1540
+ "helpValue": "<minutes>",
1541
+ "multiple": false,
1542
+ "type": "option"
1543
+ },
1544
+ "poll-interval": {
1509
1545
  "char": "i",
1510
- "description": "The job ID is the same as the record ID of the incomplete scratch org in the ScratchOrgInfo object of the Dev Hub.\n\nThe job ID is valid for 24 hours after you start the scratch org creation.",
1511
- "name": "job-id",
1512
- "summary": "Job ID of the incomplete scratch org create that you want to resume.",
1546
+ "exclusive": [
1547
+ "async"
1548
+ ],
1549
+ "name": "poll-interval",
1550
+ "summary": "Number of seconds to wait between status polling requests.",
1551
+ "hasDynamicHelp": true,
1552
+ "helpValue": "<seconds>",
1553
+ "multiple": false,
1554
+ "type": "option"
1555
+ },
1556
+ "async": {
1557
+ "description": "The command immediately displays the job ID and returns control of the terminal to you. This way, you can continue to use the CLI. To check the status of the sandbox refresh, run \"<%= config.bin %> org resume sandbox\".",
1558
+ "exclusive": [
1559
+ "wait",
1560
+ "poll-interval"
1561
+ ],
1562
+ "name": "async",
1563
+ "summary": "Request the sandbox refresh, but don't wait for it to complete.",
1564
+ "allowNo": false,
1565
+ "type": "boolean"
1566
+ },
1567
+ "name": {
1568
+ "char": "n",
1569
+ "name": "name",
1570
+ "summary": "Name of the existing sandbox org in your production org that you want to refresh.",
1513
1571
  "hasDynamicHelp": false,
1514
1572
  "multiple": false,
1515
1573
  "type": "option"
1516
1574
  },
1517
- "use-most-recent": {
1518
- "char": "r",
1519
- "name": "use-most-recent",
1520
- "summary": "Use the job ID of the most recent incomplete scratch org.",
1575
+ "definition-file": {
1576
+ "char": "f",
1577
+ "description": "The sandbox definition file is a blueprint for the sandbox; use the file to change the sandbox configuration during a refresh. If you don't want to change the sandbox configuration when you refresh it, then simply use the --name flag to specify the sandbox and don't use this flag. See <https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_sandbox_definition.htm> for all the options you can specify in the definition file.",
1578
+ "name": "definition-file",
1579
+ "summary": "Path to a sandbox definition file for overriding its configuration when you refresh it.",
1580
+ "hasDynamicHelp": false,
1581
+ "multiple": false,
1582
+ "type": "option"
1583
+ },
1584
+ "target-org": {
1585
+ "char": "o",
1586
+ "name": "target-org",
1587
+ "noCacheDefault": true,
1588
+ "required": true,
1589
+ "summary": "Username or alias of the production org that contains the sandbox license.",
1590
+ "hasDynamicHelp": true,
1591
+ "multiple": false,
1592
+ "type": "option"
1593
+ },
1594
+ "no-prompt": {
1595
+ "name": "no-prompt",
1596
+ "summary": "Don't prompt for confirmation about the sandbox refresh.",
1521
1597
  "allowNo": false,
1522
1598
  "type": "boolean"
1523
1599
  }
1524
1600
  },
1525
- "hasDynamicHelp": false,
1601
+ "hasDynamicHelp": true,
1526
1602
  "hiddenAliases": [],
1527
- "id": "org:resume:scratch",
1603
+ "id": "org:refresh:sandbox",
1528
1604
  "pluginAlias": "@salesforce/plugin-org",
1529
1605
  "pluginName": "@salesforce/plugin-org",
1530
1606
  "pluginType": "core",
1531
1607
  "strict": true,
1532
- "summary": "Resume the creation of an incomplete scratch org.",
1533
- "enableJsonFlag": true,
1608
+ "summary": "Refresh a sandbox org using the sandbox name.",
1534
1609
  "isESM": true,
1535
1610
  "relativePath": [
1536
1611
  "lib",
1537
1612
  "commands",
1538
1613
  "org",
1539
- "resume",
1540
- "scratch.js"
1541
- ],
1542
- "aliasPermutations": [
1543
- "env:resume:scratch",
1544
- "resume:env:scratch",
1545
- "resume:scratch:env",
1546
- "env:scratch:resume",
1547
- "scratch:env:resume",
1548
- "scratch:resume:env"
1614
+ "refresh",
1615
+ "sandbox.js"
1549
1616
  ],
1617
+ "aliasPermutations": [],
1550
1618
  "permutations": [
1551
- "org:resume:scratch",
1552
- "resume:org:scratch",
1553
- "resume:scratch:org",
1554
- "org:scratch:resume",
1555
- "scratch:org:resume",
1556
- "scratch:resume:org"
1619
+ "org:refresh:sandbox",
1620
+ "refresh:org:sandbox",
1621
+ "refresh:sandbox:org",
1622
+ "org:sandbox:refresh",
1623
+ "sandbox:org:refresh",
1624
+ "sandbox:refresh:org"
1557
1625
  ]
1558
1626
  },
1559
- "org:list:metadata-types": {
1627
+ "org:resume:sandbox": {
1560
1628
  "aliases": [
1561
- "force:mdapi:describemetadata"
1629
+ "env:resume:sandbox"
1562
1630
  ],
1563
1631
  "args": {},
1564
1632
  "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.",
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.",
1566
1634
  "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"
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"
1569
1638
  ],
1570
1639
  "flags": {
1571
1640
  "json": {
@@ -1583,115 +1652,101 @@
1583
1652
  "multiple": false,
1584
1653
  "type": "option"
1585
1654
  },
1586
- "api-version": {
1587
- "aliases": [
1588
- "apiversion",
1589
- "a"
1655
+ "wait": {
1656
+ "char": "w",
1657
+ "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To resume checking the sandbox creation, rerun this command.",
1658
+ "name": "wait",
1659
+ "summary": "Number of minutes to wait for the sandbox org to be ready.",
1660
+ "default": "0 minutes",
1661
+ "hasDynamicHelp": true,
1662
+ "helpValue": "<minutes>",
1663
+ "multiple": false,
1664
+ "type": "option"
1665
+ },
1666
+ "name": {
1667
+ "char": "n",
1668
+ "exclusive": [
1669
+ "job-id"
1590
1670
  ],
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.",
1671
+ "name": "name",
1672
+ "summary": "Name of the sandbox org.",
1595
1673
  "hasDynamicHelp": false,
1596
1674
  "multiple": false,
1597
1675
  "type": "option"
1598
1676
  },
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",
1677
+ "job-id": {
1678
+ "char": "i",
1679
+ "description": "The job ID is valid for 24 hours after you start the sandbox creation.",
1680
+ "exclusive": [
1681
+ "name"
1682
+ ],
1683
+ "name": "job-id",
1684
+ "summary": "Job ID of the incomplete sandbox creation that you want to check the status of.",
1605
1685
  "hasDynamicHelp": false,
1606
1686
  "multiple": false,
1607
1687
  "type": "option"
1608
1688
  },
1689
+ "use-most-recent": {
1690
+ "char": "l",
1691
+ "name": "use-most-recent",
1692
+ "summary": "Use the most recent sandbox create request.",
1693
+ "allowNo": false,
1694
+ "type": "boolean"
1695
+ },
1609
1696
  "target-org": {
1610
- "aliases": [
1611
- "targetusername",
1612
- "u"
1613
- ],
1614
1697
  "char": "o",
1615
- "deprecateAliases": true,
1698
+ "description": "When it creates the sandbox org, Salesforce copies the metadata, and optionally data, from your production org to the new sandbox org.",
1616
1699
  "name": "target-org",
1617
1700
  "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.",
1701
+ "summary": "Username or alias of the production org that contains the sandbox license.",
1620
1702
  "hasDynamicHelp": true,
1621
1703
  "multiple": false,
1622
1704
  "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
1705
  }
1649
1706
  },
1650
1707
  "hasDynamicHelp": true,
1651
1708
  "hiddenAliases": [],
1652
- "id": "org:list:metadata-types",
1709
+ "id": "org:resume:sandbox",
1653
1710
  "pluginAlias": "@salesforce/plugin-org",
1654
1711
  "pluginName": "@salesforce/plugin-org",
1655
1712
  "pluginType": "core",
1656
1713
  "strict": true,
1657
- "summary": "Display details about the metadata types that are enabled for your org.",
1658
- "enableJsonFlag": true,
1714
+ "summary": "Check the status of a sandbox creation, and log in to it if it's ready.",
1659
1715
  "isESM": true,
1660
1716
  "relativePath": [
1661
1717
  "lib",
1662
1718
  "commands",
1663
1719
  "org",
1664
- "list",
1665
- "metadata-types.js"
1720
+ "resume",
1721
+ "sandbox.js"
1666
1722
  ],
1667
1723
  "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"
1724
+ "env:resume:sandbox",
1725
+ "resume:env:sandbox",
1726
+ "resume:sandbox:env",
1727
+ "env:sandbox:resume",
1728
+ "sandbox:env:resume",
1729
+ "sandbox:resume:env"
1674
1730
  ],
1675
1731
  "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"
1732
+ "org:resume:sandbox",
1733
+ "resume:org:sandbox",
1734
+ "resume:sandbox:org",
1735
+ "org:sandbox:resume",
1736
+ "sandbox:org:resume",
1737
+ "sandbox:resume:org"
1682
1738
  ]
1683
1739
  },
1684
- "org:list:metadata": {
1740
+ "org:resume:scratch": {
1685
1741
  "aliases": [
1686
- "force:mdapi:listmetadata"
1742
+ "env:resume:scratch"
1687
1743
  ],
1688
1744
  "args": {},
1689
1745
  "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.",
1746
+ "description": "When the original \"<%= config.bin %> org create scratch\" command either times out or is run with the --async flag, it displays a job ID.\n\nRun this command by either passing it a job ID or using the --use-most-recent flag to specify the most recent incomplete scratch org.",
1691
1747
  "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"
1748
+ "Resume a scratch org create with a job ID:\n<%= config.bin %> <%= command.id %> --job-id 2SR3u0000008fBDGAY",
1749
+ "Resume your most recent incomplete scratch org:\n<%= config.bin %> <%= command.id %> --use-most-recent"
1695
1750
  ],
1696
1751
  "flags": {
1697
1752
  "json": {
@@ -1709,112 +1764,57 @@
1709
1764
  "multiple": false,
1710
1765
  "type": "option"
1711
1766
  },
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.",
1767
+ "job-id": {
1768
+ "char": "i",
1769
+ "description": "The job ID is the same as the record ID of the incomplete scratch org in the ScratchOrgInfo object of the Dev Hub.\n\nThe job ID is valid for 24 hours after you start the scratch org creation.",
1770
+ "name": "job-id",
1771
+ "summary": "Job ID of the incomplete scratch org create that you want to resume.",
1771
1772
  "hasDynamicHelp": false,
1772
1773
  "multiple": false,
1773
1774
  "type": "option"
1774
1775
  },
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"
1776
+ "use-most-recent": {
1777
+ "char": "r",
1778
+ "name": "use-most-recent",
1779
+ "summary": "Use the job ID of the most recent incomplete scratch org.",
1780
+ "allowNo": false,
1781
+ "type": "boolean"
1782
1782
  }
1783
1783
  },
1784
- "hasDynamicHelp": true,
1784
+ "hasDynamicHelp": false,
1785
1785
  "hiddenAliases": [],
1786
- "id": "org:list:metadata",
1786
+ "id": "org:resume:scratch",
1787
1787
  "pluginAlias": "@salesforce/plugin-org",
1788
1788
  "pluginName": "@salesforce/plugin-org",
1789
1789
  "pluginType": "core",
1790
1790
  "strict": true,
1791
- "summary": "List the metadata components and properties of a specified type.",
1791
+ "summary": "Resume the creation of an incomplete scratch org.",
1792
1792
  "enableJsonFlag": true,
1793
1793
  "isESM": true,
1794
1794
  "relativePath": [
1795
1795
  "lib",
1796
1796
  "commands",
1797
1797
  "org",
1798
- "list",
1799
- "metadata.js"
1798
+ "resume",
1799
+ "scratch.js"
1800
1800
  ],
1801
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"
1802
+ "env:resume:scratch",
1803
+ "resume:env:scratch",
1804
+ "resume:scratch:env",
1805
+ "env:scratch:resume",
1806
+ "scratch:env:resume",
1807
+ "scratch:resume:env"
1808
1808
  ],
1809
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"
1810
+ "org:resume:scratch",
1811
+ "resume:org:scratch",
1812
+ "resume:scratch:org",
1813
+ "org:scratch:resume",
1814
+ "scratch:org:resume",
1815
+ "scratch:resume:org"
1816
1816
  ]
1817
1817
  }
1818
1818
  },
1819
- "version": "5.2.34"
1819
+ "version": "5.2.36"
1820
1820
  }
package/package.json CHANGED
@@ -1,18 +1,18 @@
1
1
  {
2
2
  "name": "@salesforce/plugin-org",
3
3
  "description": "Commands to interact with Salesforce orgs",
4
- "version": "5.2.34",
4
+ "version": "5.2.36",
5
5
  "author": "Salesforce",
6
6
  "bugs": "https://github.com/forcedotcom/cli/issues",
7
7
  "dependencies": {
8
- "@oclif/core": "^4.2.5",
8
+ "@oclif/core": "^4.2.6",
9
9
  "@oclif/multi-stage-output": "^0.8.9",
10
10
  "@salesforce/core": "^8.8.2",
11
11
  "@salesforce/kit": "^3.2.3",
12
12
  "@salesforce/sf-plugins-core": "^12.1.4",
13
13
  "@salesforce/source-deploy-retrieve": "^12.15.0",
14
14
  "@salesforce/ts-types": "^2.0.12",
15
- "ansis": "^3.10.0",
15
+ "ansis": "^3.14.0",
16
16
  "change-case": "^5.4.4",
17
17
  "is-wsl": "^3.1.0",
18
18
  "open": "^10.1.0",
@@ -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.34.crt",
231
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/5.2.34.sig"
230
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/5.2.36.crt",
231
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/5.2.36.sig"
232
232
  }
233
233
  }