@salesforce/plugin-org 5.9.19 → 5.9.20

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.
@@ -1145,15 +1145,16 @@
1145
1145
  "tracking:enable:org"
1146
1146
  ]
1147
1147
  },
1148
- "org:refresh:sandbox": {
1149
- "aliases": [],
1148
+ "org:list:metadata-types": {
1149
+ "aliases": [
1150
+ "force:mdapi:describemetadata"
1151
+ ],
1150
1152
  "args": {},
1151
- "description": "Refreshing a sandbox copies the metadata, and optionally data, from your source org to the refreshed sandbox org. You can optionally specify a definition file if you want to change the configuration of the refreshed sandbox, such as its license type or template ID. You can also use the --source-id or --source-sandbox-name flags to change the refreshed sandbox org's original source org to a new org; in this case, the refreshed sandbox org's metadata is updated with the new source org's metadata.\n\nYou're not allowed to change the sandbox name when you refresh it with this command. If you want to change the sandbox name, first delete it with the \"org delete sandbox\" command. And then recreate it with the \"org create sandbox\" command and give it a new name.",
1153
+ "deprecateAliases": true,
1154
+ "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.",
1152
1155
  "examples": [
1153
- "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",
1154
- "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",
1155
- "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",
1156
- "Refresh the sandbox named \"devSbx2\" by changing its original source org to be a sandbox called \"devSbx3\":\n<%= config.bin %> <%= command.id %> --name devSbx2 --source-sandbox-name devSbx3 --target-org prodOrg"
1156
+ "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",
1157
+ "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"
1157
1158
  ],
1158
1159
  "flags": {
1159
1160
  "json": {
@@ -1171,142 +1172,115 @@
1171
1172
  "multiple": false,
1172
1173
  "type": "option"
1173
1174
  },
1174
- "no-auto-activate": {
1175
- "description": "By default, a sandbox auto-activates after a refresh. Use this flag to control sandbox activation manually.",
1176
- "name": "no-auto-activate",
1177
- "summary": "Disable auto-activation of the sandbox after a successful refresh.",
1178
- "allowNo": false,
1179
- "type": "boolean"
1180
- },
1181
- "wait": {
1182
- "char": "w",
1183
- "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.",
1184
- "exclusive": [
1185
- "async"
1186
- ],
1187
- "name": "wait",
1188
- "summary": "Number of minutes to poll for sandbox refresh status.",
1189
- "hasDynamicHelp": true,
1190
- "helpValue": "<minutes>",
1191
- "multiple": false,
1192
- "type": "option"
1193
- },
1194
- "poll-interval": {
1195
- "char": "i",
1196
- "exclusive": [
1197
- "async"
1198
- ],
1199
- "name": "poll-interval",
1200
- "summary": "Number of seconds to wait between status polling requests.",
1201
- "hasDynamicHelp": true,
1202
- "helpValue": "<seconds>",
1203
- "multiple": false,
1204
- "type": "option"
1205
- },
1206
- "source-sandbox-name": {
1207
- "description": "The value of --source-sandbox-name must be an existing sandbox. The new source sandbox, and the refreshed sandbox specified with the --name flag, must both be associated with the production org (--target-org) that contains the sandbox licenses.\n\nYou can specify either --source-sandbox-name or --source-id when refreshing an existing sandbox, but not both.",
1208
- "exclusive": [
1209
- "source-id"
1210
- ],
1211
- "name": "source-sandbox-name",
1212
- "summary": "Name of the sandbox org that becomes the new source org for the refreshed sandbox.",
1213
- "hasDynamicHelp": false,
1214
- "multiple": false,
1215
- "type": "option"
1216
- },
1217
- "source-id": {
1218
- "description": "The value of --source-id must be an existing sandbox. The new source sandbox, and the refreshed sandbox specified with the --name flag, must both be associated with the production org (--target-org) that contains the sandbox licenses.\n\nYou can specify either --source-id or --source-sandbox-name when refreshing an existing sandbox, but not both.",
1219
- "exclusive": [
1220
- "source-sandbox-name"
1221
- ],
1222
- "name": "source-id",
1223
- "summary": "ID of the sandbox org that becomes the new source org for the refreshed sandbox.",
1224
- "hasDynamicHelp": false,
1225
- "multiple": false,
1226
- "type": "option"
1227
- },
1228
- "async": {
1229
- "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\".",
1230
- "exclusive": [
1231
- "wait",
1232
- "poll-interval"
1175
+ "api-version": {
1176
+ "aliases": [
1177
+ "apiversion",
1178
+ "a"
1233
1179
  ],
1234
- "name": "async",
1235
- "summary": "Request the sandbox refresh, but don't wait for it to complete.",
1236
- "allowNo": false,
1237
- "type": "boolean"
1238
- },
1239
- "name": {
1240
- "char": "n",
1241
- "name": "name",
1242
- "summary": "Name of the existing sandbox org in your production org that you want to refresh.",
1180
+ "deprecateAliases": true,
1181
+ "description": "Override the api version used for api requests made by this command",
1182
+ "name": "api-version",
1183
+ "summary": "API version to use; default is the most recent API version.",
1243
1184
  "hasDynamicHelp": false,
1244
1185
  "multiple": false,
1245
1186
  "type": "option"
1246
1187
  },
1247
- "definition-file": {
1248
- "char": "f",
1249
- "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.",
1250
- "name": "definition-file",
1251
- "summary": "Path to a sandbox definition file for overriding its configuration when you refresh it.",
1188
+ "loglevel": {
1189
+ "deprecated": {
1190
+ "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."
1191
+ },
1192
+ "hidden": true,
1193
+ "name": "loglevel",
1252
1194
  "hasDynamicHelp": false,
1253
1195
  "multiple": false,
1254
1196
  "type": "option"
1255
1197
  },
1256
1198
  "target-org": {
1199
+ "aliases": [
1200
+ "targetusername",
1201
+ "u"
1202
+ ],
1257
1203
  "char": "o",
1204
+ "deprecateAliases": true,
1258
1205
  "name": "target-org",
1259
1206
  "noCacheDefault": true,
1260
1207
  "required": true,
1261
- "summary": "Username or alias of the production org that contains the sandbox license.",
1208
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1262
1209
  "hasDynamicHelp": true,
1263
1210
  "multiple": false,
1264
1211
  "type": "option"
1265
1212
  },
1266
- "no-prompt": {
1267
- "name": "no-prompt",
1268
- "summary": "Don't prompt for confirmation about the sandbox refresh.",
1213
+ "output-file": {
1214
+ "aliases": [
1215
+ "resultfile"
1216
+ ],
1217
+ "char": "f",
1218
+ "deprecateAliases": true,
1219
+ "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.",
1220
+ "name": "output-file",
1221
+ "summary": "Pathname of the file in which to write the results.",
1222
+ "hasDynamicHelp": false,
1223
+ "multiple": false,
1224
+ "type": "option"
1225
+ },
1226
+ "filter-known": {
1227
+ "aliases": [
1228
+ "filterknown"
1229
+ ],
1230
+ "char": "k",
1231
+ "deprecateAliases": true,
1232
+ "hidden": true,
1233
+ "name": "filter-known",
1234
+ "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",
1269
1235
  "allowNo": false,
1270
1236
  "type": "boolean"
1271
1237
  }
1272
1238
  },
1273
1239
  "hasDynamicHelp": true,
1274
1240
  "hiddenAliases": [],
1275
- "id": "org:refresh:sandbox",
1241
+ "id": "org:list:metadata-types",
1276
1242
  "pluginAlias": "@salesforce/plugin-org",
1277
1243
  "pluginName": "@salesforce/plugin-org",
1278
1244
  "pluginType": "core",
1279
1245
  "strict": true,
1280
- "summary": "Refresh a sandbox org using the sandbox name.",
1246
+ "summary": "Display details about the metadata types that are enabled for your org.",
1247
+ "enableJsonFlag": true,
1281
1248
  "isESM": true,
1282
1249
  "relativePath": [
1283
1250
  "lib",
1284
1251
  "commands",
1285
1252
  "org",
1286
- "refresh",
1287
- "sandbox.js"
1253
+ "list",
1254
+ "metadata-types.js"
1255
+ ],
1256
+ "aliasPermutations": [
1257
+ "force:mdapi:describemetadata",
1258
+ "mdapi:force:describemetadata",
1259
+ "mdapi:describemetadata:force",
1260
+ "force:describemetadata:mdapi",
1261
+ "describemetadata:force:mdapi",
1262
+ "describemetadata:mdapi:force"
1288
1263
  ],
1289
- "aliasPermutations": [],
1290
1264
  "permutations": [
1291
- "org:refresh:sandbox",
1292
- "refresh:org:sandbox",
1293
- "refresh:sandbox:org",
1294
- "org:sandbox:refresh",
1295
- "sandbox:org:refresh",
1296
- "sandbox:refresh:org"
1265
+ "org:list:metadata-types",
1266
+ "list:org:metadata-types",
1267
+ "list:metadata-types:org",
1268
+ "org:metadata-types:list",
1269
+ "metadata-types:org:list",
1270
+ "metadata-types:list:org"
1297
1271
  ]
1298
1272
  },
1299
- "org:resume:sandbox": {
1273
+ "org:list:metadata": {
1300
1274
  "aliases": [
1301
- "env:resume:sandbox"
1275
+ "force:mdapi:listmetadata"
1302
1276
  ],
1303
1277
  "args": {},
1304
1278
  "deprecateAliases": true,
1305
- "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.",
1279
+ "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.",
1306
1280
  "examples": [
1307
- "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",
1308
- "Check the status using the job ID:\n<%= config.bin %> <%= command.id %> --job-id 0GRxxxxxxxx",
1309
- "Check the status of the most recent sandbox create request:\n<%= config.bin %> <%= command.id %> --use-most-recent"
1281
+ "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",
1282
+ "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",
1283
+ "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"
1310
1284
  ],
1311
1285
  "flags": {
1312
1286
  "json": {
@@ -1324,178 +1298,110 @@
1324
1298
  "multiple": false,
1325
1299
  "type": "option"
1326
1300
  },
1327
- "wait": {
1328
- "char": "w",
1329
- "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.",
1330
- "name": "wait",
1331
- "summary": "Number of minutes to wait for the sandbox org to be ready.",
1332
- "default": "0 minutes",
1333
- "hasDynamicHelp": true,
1334
- "helpValue": "<minutes>",
1335
- "multiple": false,
1336
- "type": "option"
1337
- },
1338
- "name": {
1339
- "char": "n",
1340
- "exclusive": [
1341
- "job-id"
1301
+ "api-version": {
1302
+ "aliases": [
1303
+ "apiversion",
1304
+ "a"
1342
1305
  ],
1343
- "name": "name",
1344
- "summary": "Name of the sandbox org.",
1306
+ "deprecateAliases": true,
1307
+ "description": "Override the api version used for api requests made by this command",
1308
+ "name": "api-version",
1309
+ "summary": "API version to use; default is the most recent API version.",
1345
1310
  "hasDynamicHelp": false,
1346
1311
  "multiple": false,
1347
1312
  "type": "option"
1348
1313
  },
1349
- "job-id": {
1350
- "char": "i",
1351
- "description": "The job ID is valid for 24 hours after you start the sandbox creation.",
1352
- "exclusive": [
1353
- "name"
1354
- ],
1355
- "name": "job-id",
1356
- "summary": "Job ID of the incomplete sandbox creation that you want to check the status of.",
1314
+ "loglevel": {
1315
+ "deprecated": {
1316
+ "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."
1317
+ },
1318
+ "hidden": true,
1319
+ "name": "loglevel",
1357
1320
  "hasDynamicHelp": false,
1358
1321
  "multiple": false,
1359
1322
  "type": "option"
1360
1323
  },
1361
- "use-most-recent": {
1362
- "char": "l",
1363
- "name": "use-most-recent",
1364
- "summary": "Use the most recent sandbox create request.",
1365
- "allowNo": false,
1366
- "type": "boolean"
1367
- },
1368
1324
  "target-org": {
1325
+ "aliases": [
1326
+ "targetusername",
1327
+ "u"
1328
+ ],
1369
1329
  "char": "o",
1370
- "description": "When it creates the sandbox org, Salesforce copies the metadata, and optionally data, from your production org to the new sandbox org.",
1330
+ "deprecateAliases": true,
1371
1331
  "name": "target-org",
1372
1332
  "noCacheDefault": true,
1373
- "summary": "Username or alias of the production org that contains the sandbox license.",
1333
+ "required": true,
1334
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1374
1335
  "hasDynamicHelp": true,
1375
1336
  "multiple": false,
1376
1337
  "type": "option"
1377
- }
1378
- },
1379
- "hasDynamicHelp": true,
1380
- "hiddenAliases": [],
1381
- "id": "org:resume:sandbox",
1382
- "pluginAlias": "@salesforce/plugin-org",
1383
- "pluginName": "@salesforce/plugin-org",
1384
- "pluginType": "core",
1385
- "strict": true,
1386
- "summary": "Check the status of a sandbox creation, and log in to it if it's ready.",
1387
- "isESM": true,
1388
- "relativePath": [
1389
- "lib",
1390
- "commands",
1391
- "org",
1392
- "resume",
1393
- "sandbox.js"
1394
- ],
1395
- "aliasPermutations": [
1396
- "env:resume:sandbox",
1397
- "resume:env:sandbox",
1398
- "resume:sandbox:env",
1399
- "env:sandbox:resume",
1400
- "sandbox:env:resume",
1401
- "sandbox:resume:env"
1402
- ],
1403
- "permutations": [
1404
- "org:resume:sandbox",
1405
- "resume:org:sandbox",
1406
- "resume:sandbox:org",
1407
- "org:sandbox:resume",
1408
- "sandbox:org:resume",
1409
- "sandbox:resume:org"
1410
- ]
1411
- },
1412
- "org:resume:scratch": {
1413
- "aliases": [
1414
- "env:resume:scratch"
1415
- ],
1416
- "args": {},
1417
- "deprecateAliases": true,
1418
- "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.",
1419
- "examples": [
1420
- "Resume a scratch org create with a job ID:\n<%= config.bin %> <%= command.id %> --job-id 2SR3u0000008fBDGAY",
1421
- "Resume your most recent incomplete scratch org:\n<%= config.bin %> <%= command.id %> --use-most-recent"
1422
- ],
1423
- "flags": {
1424
- "json": {
1425
- "description": "Format output as json.",
1426
- "helpGroup": "GLOBAL",
1427
- "name": "json",
1428
- "allowNo": false,
1429
- "type": "boolean"
1430
1338
  },
1431
- "flags-dir": {
1432
- "helpGroup": "GLOBAL",
1433
- "name": "flags-dir",
1434
- "summary": "Import flag values from a directory.",
1339
+ "output-file": {
1340
+ "aliases": [
1341
+ "resultfile"
1342
+ ],
1343
+ "char": "f",
1344
+ "deprecateAliases": true,
1345
+ "name": "output-file",
1346
+ "summary": "Pathname of the file in which to write the results.",
1435
1347
  "hasDynamicHelp": false,
1436
1348
  "multiple": false,
1437
1349
  "type": "option"
1438
1350
  },
1439
- "job-id": {
1440
- "char": "i",
1441
- "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.",
1442
- "name": "job-id",
1443
- "summary": "Job ID of the incomplete scratch org create that you want to resume.",
1351
+ "metadata-type": {
1352
+ "aliases": [
1353
+ "metadatatype"
1354
+ ],
1355
+ "char": "m",
1356
+ "deprecateAliases": true,
1357
+ "name": "metadata-type",
1358
+ "required": true,
1359
+ "summary": "Metadata type to be retrieved, such as CustomObject; metadata type names are case-sensitive.",
1444
1360
  "hasDynamicHelp": false,
1445
1361
  "multiple": false,
1446
1362
  "type": "option"
1447
1363
  },
1448
- "use-most-recent": {
1449
- "char": "r",
1450
- "name": "use-most-recent",
1451
- "summary": "Use the job ID of the most recent incomplete scratch org.",
1452
- "allowNo": false,
1453
- "type": "boolean"
1454
- },
1455
- "wait": {
1456
- "char": "w",
1457
- "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 scratch creation, rerun this command.",
1458
- "name": "wait",
1459
- "summary": "Number of minutes to wait for the scratch org to be ready.",
1460
- "default": "0 minutes",
1461
- "hasDynamicHelp": true,
1462
- "helpValue": "<minutes>",
1364
+ "folder": {
1365
+ "description": "Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.",
1366
+ "name": "folder",
1367
+ "summary": "Folder associated with the component; required for components that use folders; folder names are case-sensitive.",
1368
+ "hasDynamicHelp": false,
1463
1369
  "multiple": false,
1464
1370
  "type": "option"
1465
1371
  }
1466
1372
  },
1467
1373
  "hasDynamicHelp": true,
1468
1374
  "hiddenAliases": [],
1469
- "id": "org:resume:scratch",
1375
+ "id": "org:list:metadata",
1470
1376
  "pluginAlias": "@salesforce/plugin-org",
1471
1377
  "pluginName": "@salesforce/plugin-org",
1472
1378
  "pluginType": "core",
1473
1379
  "strict": true,
1474
- "summary": "Resume the creation of an incomplete scratch org.",
1380
+ "summary": "List the metadata components and properties of a specified type.",
1475
1381
  "enableJsonFlag": true,
1476
1382
  "isESM": true,
1477
1383
  "relativePath": [
1478
1384
  "lib",
1479
1385
  "commands",
1480
1386
  "org",
1481
- "resume",
1482
- "scratch.js"
1387
+ "list",
1388
+ "metadata.js"
1483
1389
  ],
1484
1390
  "aliasPermutations": [
1485
- "env:resume:scratch",
1486
- "resume:env:scratch",
1487
- "resume:scratch:env",
1488
- "env:scratch:resume",
1489
- "scratch:env:resume",
1490
- "scratch:resume:env"
1391
+ "force:mdapi:listmetadata",
1392
+ "mdapi:force:listmetadata",
1393
+ "mdapi:listmetadata:force",
1394
+ "force:listmetadata:mdapi",
1395
+ "listmetadata:force:mdapi",
1396
+ "listmetadata:mdapi:force"
1491
1397
  ],
1492
1398
  "permutations": [
1493
- "org:resume:scratch",
1494
- "resume:org:scratch",
1495
- "resume:scratch:org",
1496
- "org:scratch:resume",
1497
- "scratch:org:resume",
1498
- "scratch:resume:org"
1399
+ "org:list:metadata",
1400
+ "list:org:metadata",
1401
+ "list:metadata:org",
1402
+ "org:metadata:list",
1403
+ "metadata:org:list",
1404
+ "metadata:list:org"
1499
1405
  ]
1500
1406
  },
1501
1407
  "org:open:agent": {
@@ -1615,16 +1521,168 @@
1615
1521
  "agent:open:org"
1616
1522
  ]
1617
1523
  },
1618
- "org:list:metadata-types": {
1524
+ "org:refresh:sandbox": {
1525
+ "aliases": [],
1526
+ "args": {},
1527
+ "description": "Refreshing a sandbox copies the metadata, and optionally data, from your source org to the refreshed sandbox org. You can optionally specify a definition file if you want to change the configuration of the refreshed sandbox, such as its license type or template ID. You can also use the --source-id or --source-sandbox-name flags to change the refreshed sandbox org's original source org to a new org; in this case, the refreshed sandbox org's metadata is updated with the new source org's metadata.\n\nYou're not allowed to change the sandbox name when you refresh it with this command. If you want to change the sandbox name, first delete it with the \"org delete sandbox\" command. And then recreate it with the \"org create sandbox\" command and give it a new name.",
1528
+ "examples": [
1529
+ "Refresh the sandbox named \"devSbx1\". The production org that contains the sandbox license has the alias \"prodOrg\".\n<%= config.bin %> <%= command.id %> --name devSbx1 --target-org prodOrg",
1530
+ "Refresh the sandbox named \"devSbx2\", and override the configuration of the refreshed sandbox with the properties in the specified defintion file. The default target org is the production org, so you don't need to specify the `--target-org` flag in this case.\n<%= config.bin %> <%= command.id %> --name devSbx2 --definition-file devSbx2-config.json",
1531
+ "Refresh the sandbox using the name defined in the definition file. The production org that contains the sandbox license has the alias \"prodOrg\".\n<%= config.bin %> <%= command.id %> --definition-file devSbx3-config.json --target-org prodOrg",
1532
+ "Refresh the sandbox named \"devSbx2\" by changing its original source org to be a sandbox called \"devSbx3\":\n<%= config.bin %> <%= command.id %> --name devSbx2 --source-sandbox-name devSbx3 --target-org prodOrg"
1533
+ ],
1534
+ "flags": {
1535
+ "json": {
1536
+ "description": "Format output as json.",
1537
+ "helpGroup": "GLOBAL",
1538
+ "name": "json",
1539
+ "allowNo": false,
1540
+ "type": "boolean"
1541
+ },
1542
+ "flags-dir": {
1543
+ "helpGroup": "GLOBAL",
1544
+ "name": "flags-dir",
1545
+ "summary": "Import flag values from a directory.",
1546
+ "hasDynamicHelp": false,
1547
+ "multiple": false,
1548
+ "type": "option"
1549
+ },
1550
+ "no-auto-activate": {
1551
+ "description": "By default, a sandbox auto-activates after a refresh. Use this flag to control sandbox activation manually.",
1552
+ "name": "no-auto-activate",
1553
+ "summary": "Disable auto-activation of the sandbox after a successful refresh.",
1554
+ "allowNo": false,
1555
+ "type": "boolean"
1556
+ },
1557
+ "wait": {
1558
+ "char": "w",
1559
+ "description": "If the command continues to run after the wait period, the CLI returns control of the terminal to you and displays the \"<%= config.bin %> org resume sandbox\" command for you run to check the status of the refresh. The displayed command includes the job ID for the running sandbox refresh.",
1560
+ "exclusive": [
1561
+ "async"
1562
+ ],
1563
+ "name": "wait",
1564
+ "summary": "Number of minutes to poll for sandbox refresh status.",
1565
+ "hasDynamicHelp": true,
1566
+ "helpValue": "<minutes>",
1567
+ "multiple": false,
1568
+ "type": "option"
1569
+ },
1570
+ "poll-interval": {
1571
+ "char": "i",
1572
+ "exclusive": [
1573
+ "async"
1574
+ ],
1575
+ "name": "poll-interval",
1576
+ "summary": "Number of seconds to wait between status polling requests.",
1577
+ "hasDynamicHelp": true,
1578
+ "helpValue": "<seconds>",
1579
+ "multiple": false,
1580
+ "type": "option"
1581
+ },
1582
+ "source-sandbox-name": {
1583
+ "description": "The value of --source-sandbox-name must be an existing sandbox. The new source sandbox, and the refreshed sandbox specified with the --name flag, must both be associated with the production org (--target-org) that contains the sandbox licenses.\n\nYou can specify either --source-sandbox-name or --source-id when refreshing an existing sandbox, but not both.",
1584
+ "exclusive": [
1585
+ "source-id"
1586
+ ],
1587
+ "name": "source-sandbox-name",
1588
+ "summary": "Name of the sandbox org that becomes the new source org for the refreshed sandbox.",
1589
+ "hasDynamicHelp": false,
1590
+ "multiple": false,
1591
+ "type": "option"
1592
+ },
1593
+ "source-id": {
1594
+ "description": "The value of --source-id must be an existing sandbox. The new source sandbox, and the refreshed sandbox specified with the --name flag, must both be associated with the production org (--target-org) that contains the sandbox licenses.\n\nYou can specify either --source-id or --source-sandbox-name when refreshing an existing sandbox, but not both.",
1595
+ "exclusive": [
1596
+ "source-sandbox-name"
1597
+ ],
1598
+ "name": "source-id",
1599
+ "summary": "ID of the sandbox org that becomes the new source org for the refreshed sandbox.",
1600
+ "hasDynamicHelp": false,
1601
+ "multiple": false,
1602
+ "type": "option"
1603
+ },
1604
+ "async": {
1605
+ "description": "The command immediately displays the job ID and returns control of the terminal to you. This way, you can continue to use the CLI. To check the status of the sandbox refresh, run \"<%= config.bin %> org resume sandbox\".",
1606
+ "exclusive": [
1607
+ "wait",
1608
+ "poll-interval"
1609
+ ],
1610
+ "name": "async",
1611
+ "summary": "Request the sandbox refresh, but don't wait for it to complete.",
1612
+ "allowNo": false,
1613
+ "type": "boolean"
1614
+ },
1615
+ "name": {
1616
+ "char": "n",
1617
+ "name": "name",
1618
+ "summary": "Name of the existing sandbox org in your production org that you want to refresh.",
1619
+ "hasDynamicHelp": false,
1620
+ "multiple": false,
1621
+ "type": "option"
1622
+ },
1623
+ "definition-file": {
1624
+ "char": "f",
1625
+ "description": "The sandbox definition file is a blueprint for the sandbox; use the file to change the sandbox configuration during a refresh. If you don't want to change the sandbox configuration when you refresh it, then simply use the --name flag to specify the sandbox and don't use this flag. See <https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_sandbox_definition.htm> for all the options you can specify in the definition file.",
1626
+ "name": "definition-file",
1627
+ "summary": "Path to a sandbox definition file for overriding its configuration when you refresh it.",
1628
+ "hasDynamicHelp": false,
1629
+ "multiple": false,
1630
+ "type": "option"
1631
+ },
1632
+ "target-org": {
1633
+ "char": "o",
1634
+ "name": "target-org",
1635
+ "noCacheDefault": true,
1636
+ "required": true,
1637
+ "summary": "Username or alias of the production org that contains the sandbox license.",
1638
+ "hasDynamicHelp": true,
1639
+ "multiple": false,
1640
+ "type": "option"
1641
+ },
1642
+ "no-prompt": {
1643
+ "name": "no-prompt",
1644
+ "summary": "Don't prompt for confirmation about the sandbox refresh.",
1645
+ "allowNo": false,
1646
+ "type": "boolean"
1647
+ }
1648
+ },
1649
+ "hasDynamicHelp": true,
1650
+ "hiddenAliases": [],
1651
+ "id": "org:refresh:sandbox",
1652
+ "pluginAlias": "@salesforce/plugin-org",
1653
+ "pluginName": "@salesforce/plugin-org",
1654
+ "pluginType": "core",
1655
+ "strict": true,
1656
+ "summary": "Refresh a sandbox org using the sandbox name.",
1657
+ "isESM": true,
1658
+ "relativePath": [
1659
+ "lib",
1660
+ "commands",
1661
+ "org",
1662
+ "refresh",
1663
+ "sandbox.js"
1664
+ ],
1665
+ "aliasPermutations": [],
1666
+ "permutations": [
1667
+ "org:refresh:sandbox",
1668
+ "refresh:org:sandbox",
1669
+ "refresh:sandbox:org",
1670
+ "org:sandbox:refresh",
1671
+ "sandbox:org:refresh",
1672
+ "sandbox:refresh:org"
1673
+ ]
1674
+ },
1675
+ "org:resume:sandbox": {
1619
1676
  "aliases": [
1620
- "force:mdapi:describemetadata"
1677
+ "env:resume:sandbox"
1621
1678
  ],
1622
1679
  "args": {},
1623
1680
  "deprecateAliases": true,
1624
- "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.",
1681
+ "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.",
1625
1682
  "examples": [
1626
- "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",
1627
- "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"
1683
+ "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",
1684
+ "Check the status using the job ID:\n<%= config.bin %> <%= command.id %> --job-id 0GRxxxxxxxx",
1685
+ "Check the status of the most recent sandbox create request:\n<%= config.bin %> <%= command.id %> --use-most-recent"
1628
1686
  ],
1629
1687
  "flags": {
1630
1688
  "json": {
@@ -1642,115 +1700,101 @@
1642
1700
  "multiple": false,
1643
1701
  "type": "option"
1644
1702
  },
1645
- "api-version": {
1646
- "aliases": [
1647
- "apiversion",
1648
- "a"
1703
+ "wait": {
1704
+ "char": "w",
1705
+ "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.",
1706
+ "name": "wait",
1707
+ "summary": "Number of minutes to wait for the sandbox org to be ready.",
1708
+ "default": "0 minutes",
1709
+ "hasDynamicHelp": true,
1710
+ "helpValue": "<minutes>",
1711
+ "multiple": false,
1712
+ "type": "option"
1713
+ },
1714
+ "name": {
1715
+ "char": "n",
1716
+ "exclusive": [
1717
+ "job-id"
1649
1718
  ],
1650
- "deprecateAliases": true,
1651
- "description": "Override the api version used for api requests made by this command",
1652
- "name": "api-version",
1653
- "summary": "API version to use; default is the most recent API version.",
1719
+ "name": "name",
1720
+ "summary": "Name of the sandbox org.",
1654
1721
  "hasDynamicHelp": false,
1655
1722
  "multiple": false,
1656
1723
  "type": "option"
1657
1724
  },
1658
- "loglevel": {
1659
- "deprecated": {
1660
- "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."
1661
- },
1662
- "hidden": true,
1663
- "name": "loglevel",
1725
+ "job-id": {
1726
+ "char": "i",
1727
+ "description": "The job ID is valid for 24 hours after you start the sandbox creation.",
1728
+ "exclusive": [
1729
+ "name"
1730
+ ],
1731
+ "name": "job-id",
1732
+ "summary": "Job ID of the incomplete sandbox creation that you want to check the status of.",
1664
1733
  "hasDynamicHelp": false,
1665
1734
  "multiple": false,
1666
1735
  "type": "option"
1667
1736
  },
1737
+ "use-most-recent": {
1738
+ "char": "l",
1739
+ "name": "use-most-recent",
1740
+ "summary": "Use the most recent sandbox create request.",
1741
+ "allowNo": false,
1742
+ "type": "boolean"
1743
+ },
1668
1744
  "target-org": {
1669
- "aliases": [
1670
- "targetusername",
1671
- "u"
1672
- ],
1673
1745
  "char": "o",
1674
- "deprecateAliases": true,
1746
+ "description": "When it creates the sandbox org, Salesforce copies the metadata, and optionally data, from your production org to the new sandbox org.",
1675
1747
  "name": "target-org",
1676
1748
  "noCacheDefault": true,
1677
- "required": true,
1678
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1749
+ "summary": "Username or alias of the production org that contains the sandbox license.",
1679
1750
  "hasDynamicHelp": true,
1680
1751
  "multiple": false,
1681
1752
  "type": "option"
1682
- },
1683
- "output-file": {
1684
- "aliases": [
1685
- "resultfile"
1686
- ],
1687
- "char": "f",
1688
- "deprecateAliases": true,
1689
- "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.",
1690
- "name": "output-file",
1691
- "summary": "Pathname of the file in which to write the results.",
1692
- "hasDynamicHelp": false,
1693
- "multiple": false,
1694
- "type": "option"
1695
- },
1696
- "filter-known": {
1697
- "aliases": [
1698
- "filterknown"
1699
- ],
1700
- "char": "k",
1701
- "deprecateAliases": true,
1702
- "hidden": true,
1703
- "name": "filter-known",
1704
- "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",
1705
- "allowNo": false,
1706
- "type": "boolean"
1707
1753
  }
1708
1754
  },
1709
1755
  "hasDynamicHelp": true,
1710
1756
  "hiddenAliases": [],
1711
- "id": "org:list:metadata-types",
1757
+ "id": "org:resume:sandbox",
1712
1758
  "pluginAlias": "@salesforce/plugin-org",
1713
1759
  "pluginName": "@salesforce/plugin-org",
1714
1760
  "pluginType": "core",
1715
1761
  "strict": true,
1716
- "summary": "Display details about the metadata types that are enabled for your org.",
1717
- "enableJsonFlag": true,
1762
+ "summary": "Check the status of a sandbox creation, and log in to it if it's ready.",
1718
1763
  "isESM": true,
1719
1764
  "relativePath": [
1720
1765
  "lib",
1721
1766
  "commands",
1722
1767
  "org",
1723
- "list",
1724
- "metadata-types.js"
1768
+ "resume",
1769
+ "sandbox.js"
1725
1770
  ],
1726
1771
  "aliasPermutations": [
1727
- "force:mdapi:describemetadata",
1728
- "mdapi:force:describemetadata",
1729
- "mdapi:describemetadata:force",
1730
- "force:describemetadata:mdapi",
1731
- "describemetadata:force:mdapi",
1732
- "describemetadata:mdapi:force"
1772
+ "env:resume:sandbox",
1773
+ "resume:env:sandbox",
1774
+ "resume:sandbox:env",
1775
+ "env:sandbox:resume",
1776
+ "sandbox:env:resume",
1777
+ "sandbox:resume:env"
1733
1778
  ],
1734
1779
  "permutations": [
1735
- "org:list:metadata-types",
1736
- "list:org:metadata-types",
1737
- "list:metadata-types:org",
1738
- "org:metadata-types:list",
1739
- "metadata-types:org:list",
1740
- "metadata-types:list:org"
1780
+ "org:resume:sandbox",
1781
+ "resume:org:sandbox",
1782
+ "resume:sandbox:org",
1783
+ "org:sandbox:resume",
1784
+ "sandbox:org:resume",
1785
+ "sandbox:resume:org"
1741
1786
  ]
1742
1787
  },
1743
- "org:list:metadata": {
1788
+ "org:resume:scratch": {
1744
1789
  "aliases": [
1745
- "force:mdapi:listmetadata"
1790
+ "env:resume:scratch"
1746
1791
  ],
1747
1792
  "args": {},
1748
1793
  "deprecateAliases": true,
1749
- "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.",
1794
+ "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.",
1750
1795
  "examples": [
1751
- "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",
1752
- "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",
1753
- "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"
1796
+ "Resume a scratch org create with a job ID:\n<%= config.bin %> <%= command.id %> --job-id 2SR3u0000008fBDGAY",
1797
+ "Resume your most recent incomplete scratch org:\n<%= config.bin %> <%= command.id %> --use-most-recent"
1754
1798
  ],
1755
1799
  "flags": {
1756
1800
  "json": {
@@ -1768,112 +1812,68 @@
1768
1812
  "multiple": false,
1769
1813
  "type": "option"
1770
1814
  },
1771
- "api-version": {
1772
- "aliases": [
1773
- "apiversion",
1774
- "a"
1775
- ],
1776
- "deprecateAliases": true,
1777
- "description": "Override the api version used for api requests made by this command",
1778
- "name": "api-version",
1779
- "summary": "API version to use; default is the most recent API version.",
1815
+ "job-id": {
1816
+ "char": "i",
1817
+ "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.",
1818
+ "name": "job-id",
1819
+ "summary": "Job ID of the incomplete scratch org create that you want to resume.",
1780
1820
  "hasDynamicHelp": false,
1781
1821
  "multiple": false,
1782
1822
  "type": "option"
1783
1823
  },
1784
- "loglevel": {
1785
- "deprecated": {
1786
- "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."
1787
- },
1788
- "hidden": true,
1789
- "name": "loglevel",
1790
- "hasDynamicHelp": false,
1791
- "multiple": false,
1792
- "type": "option"
1824
+ "use-most-recent": {
1825
+ "char": "r",
1826
+ "name": "use-most-recent",
1827
+ "summary": "Use the job ID of the most recent incomplete scratch org.",
1828
+ "allowNo": false,
1829
+ "type": "boolean"
1793
1830
  },
1794
- "target-org": {
1795
- "aliases": [
1796
- "targetusername",
1797
- "u"
1798
- ],
1799
- "char": "o",
1800
- "deprecateAliases": true,
1801
- "name": "target-org",
1802
- "noCacheDefault": true,
1803
- "required": true,
1804
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1831
+ "wait": {
1832
+ "char": "w",
1833
+ "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 scratch creation, rerun this command.",
1834
+ "name": "wait",
1835
+ "summary": "Number of minutes to wait for the scratch org to be ready.",
1836
+ "default": "0 minutes",
1805
1837
  "hasDynamicHelp": true,
1806
- "multiple": false,
1807
- "type": "option"
1808
- },
1809
- "output-file": {
1810
- "aliases": [
1811
- "resultfile"
1812
- ],
1813
- "char": "f",
1814
- "deprecateAliases": true,
1815
- "name": "output-file",
1816
- "summary": "Pathname of the file in which to write the results.",
1817
- "hasDynamicHelp": false,
1818
- "multiple": false,
1819
- "type": "option"
1820
- },
1821
- "metadata-type": {
1822
- "aliases": [
1823
- "metadatatype"
1824
- ],
1825
- "char": "m",
1826
- "deprecateAliases": true,
1827
- "name": "metadata-type",
1828
- "required": true,
1829
- "summary": "Metadata type to be retrieved, such as CustomObject; metadata type names are case-sensitive.",
1830
- "hasDynamicHelp": false,
1831
- "multiple": false,
1832
- "type": "option"
1833
- },
1834
- "folder": {
1835
- "description": "Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.",
1836
- "name": "folder",
1837
- "summary": "Folder associated with the component; required for components that use folders; folder names are case-sensitive.",
1838
- "hasDynamicHelp": false,
1838
+ "helpValue": "<minutes>",
1839
1839
  "multiple": false,
1840
1840
  "type": "option"
1841
1841
  }
1842
1842
  },
1843
1843
  "hasDynamicHelp": true,
1844
1844
  "hiddenAliases": [],
1845
- "id": "org:list:metadata",
1845
+ "id": "org:resume:scratch",
1846
1846
  "pluginAlias": "@salesforce/plugin-org",
1847
1847
  "pluginName": "@salesforce/plugin-org",
1848
1848
  "pluginType": "core",
1849
1849
  "strict": true,
1850
- "summary": "List the metadata components and properties of a specified type.",
1850
+ "summary": "Resume the creation of an incomplete scratch org.",
1851
1851
  "enableJsonFlag": true,
1852
1852
  "isESM": true,
1853
1853
  "relativePath": [
1854
1854
  "lib",
1855
1855
  "commands",
1856
1856
  "org",
1857
- "list",
1858
- "metadata.js"
1857
+ "resume",
1858
+ "scratch.js"
1859
1859
  ],
1860
1860
  "aliasPermutations": [
1861
- "force:mdapi:listmetadata",
1862
- "mdapi:force:listmetadata",
1863
- "mdapi:listmetadata:force",
1864
- "force:listmetadata:mdapi",
1865
- "listmetadata:force:mdapi",
1866
- "listmetadata:mdapi:force"
1861
+ "env:resume:scratch",
1862
+ "resume:env:scratch",
1863
+ "resume:scratch:env",
1864
+ "env:scratch:resume",
1865
+ "scratch:env:resume",
1866
+ "scratch:resume:env"
1867
1867
  ],
1868
1868
  "permutations": [
1869
- "org:list:metadata",
1870
- "list:org:metadata",
1871
- "list:metadata:org",
1872
- "org:metadata:list",
1873
- "metadata:org:list",
1874
- "metadata:list:org"
1869
+ "org:resume:scratch",
1870
+ "resume:org:scratch",
1871
+ "resume:scratch:org",
1872
+ "org:scratch:resume",
1873
+ "scratch:org:resume",
1874
+ "scratch:resume:org"
1875
1875
  ]
1876
1876
  }
1877
1877
  },
1878
- "version": "5.9.19"
1878
+ "version": "5.9.20"
1879
1879
  }