@salesforce/plugin-org 5.8.3 → 5.8.4

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 +364 -364
  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.8.3/src/commands/org/create/sandbox.ts)_
245
+ _See code: [src/commands/org/create/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.8.4/src/commands/org/create/sandbox.ts)_
246
246
 
247
247
  ## `sf org create scratch`
248
248
 
@@ -424,7 +424,7 @@ FLAG DESCRIPTIONS
424
424
  Omit this flag to have Salesforce generate a unique username for your org.
425
425
  ```
426
426
 
427
- _See code: [src/commands/org/create/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.8.3/src/commands/org/create/scratch.ts)_
427
+ _See code: [src/commands/org/create/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.8.4/src/commands/org/create/scratch.ts)_
428
428
 
429
429
  ## `sf org delete sandbox`
430
430
 
@@ -470,7 +470,7 @@ EXAMPLES
470
470
  $ sf org delete sandbox --target-org my-sandbox --no-prompt
471
471
  ```
472
472
 
473
- _See code: [src/commands/org/delete/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.8.3/src/commands/org/delete/sandbox.ts)_
473
+ _See code: [src/commands/org/delete/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.8.4/src/commands/org/delete/sandbox.ts)_
474
474
 
475
475
  ## `sf org delete scratch`
476
476
 
@@ -514,7 +514,7 @@ EXAMPLES
514
514
  $ sf org delete scratch --target-org my-scratch-org --no-prompt
515
515
  ```
516
516
 
517
- _See code: [src/commands/org/delete/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.8.3/src/commands/org/delete/scratch.ts)_
517
+ _See code: [src/commands/org/delete/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.8.4/src/commands/org/delete/scratch.ts)_
518
518
 
519
519
  ## `sf org disable tracking`
520
520
 
@@ -553,7 +553,7 @@ EXAMPLES
553
553
  $ sf org disable tracking
554
554
  ```
555
555
 
556
- _See code: [src/commands/org/disable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.8.3/src/commands/org/disable/tracking.ts)_
556
+ _See code: [src/commands/org/disable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.8.4/src/commands/org/disable/tracking.ts)_
557
557
 
558
558
  ## `sf org display`
559
559
 
@@ -598,7 +598,7 @@ EXAMPLES
598
598
  $ sf org display --target-org TestOrg1 --verbose
599
599
  ```
600
600
 
601
- _See code: [src/commands/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/5.8.3/src/commands/org/display.ts)_
601
+ _See code: [src/commands/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/5.8.4/src/commands/org/display.ts)_
602
602
 
603
603
  ## `sf org enable tracking`
604
604
 
@@ -640,7 +640,7 @@ EXAMPLES
640
640
  $ sf org enable tracking
641
641
  ```
642
642
 
643
- _See code: [src/commands/org/enable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.8.3/src/commands/org/enable/tracking.ts)_
643
+ _See code: [src/commands/org/enable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.8.4/src/commands/org/enable/tracking.ts)_
644
644
 
645
645
  ## `sf org list`
646
646
 
@@ -679,7 +679,7 @@ EXAMPLES
679
679
  $ sf org list --clean
680
680
  ```
681
681
 
682
- _See code: [src/commands/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/5.8.3/src/commands/org/list.ts)_
682
+ _See code: [src/commands/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/5.8.4/src/commands/org/list.ts)_
683
683
 
684
684
  ## `sf org list metadata`
685
685
 
@@ -746,7 +746,7 @@ FLAG DESCRIPTIONS
746
746
  Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.
747
747
  ```
748
748
 
749
- _See code: [src/commands/org/list/metadata.ts](https://github.com/salesforcecli/plugin-org/blob/5.8.3/src/commands/org/list/metadata.ts)_
749
+ _See code: [src/commands/org/list/metadata.ts](https://github.com/salesforcecli/plugin-org/blob/5.8.4/src/commands/org/list/metadata.ts)_
750
750
 
751
751
  ## `sf org list metadata-types`
752
752
 
@@ -801,7 +801,7 @@ FLAG DESCRIPTIONS
801
801
  Override the api version used for api requests made by this command
802
802
  ```
803
803
 
804
- _See code: [src/commands/org/list/metadata-types.ts](https://github.com/salesforcecli/plugin-org/blob/5.8.3/src/commands/org/list/metadata-types.ts)_
804
+ _See code: [src/commands/org/list/metadata-types.ts](https://github.com/salesforcecli/plugin-org/blob/5.8.4/src/commands/org/list/metadata-types.ts)_
805
805
 
806
806
  ## `sf org open`
807
807
 
@@ -877,7 +877,7 @@ EXAMPLES
877
877
  $ sf org open --source-file force-app/main/default/bots/Coral_Cloud_Agent/Coral_Cloud_Agent.bot-meta.xml
878
878
  ```
879
879
 
880
- _See code: [src/commands/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/5.8.3/src/commands/org/open.ts)_
880
+ _See code: [src/commands/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/5.8.4/src/commands/org/open.ts)_
881
881
 
882
882
  ## `sf org open agent`
883
883
 
@@ -928,7 +928,7 @@ EXAMPLES
928
928
  $ sf org open agent --target-org MyTestOrg1 --browser firefox --api-name Coral_Cloud_Agent
929
929
  ```
930
930
 
931
- _See code: [src/commands/org/open/agent.ts](https://github.com/salesforcecli/plugin-org/blob/5.8.3/src/commands/org/open/agent.ts)_
931
+ _See code: [src/commands/org/open/agent.ts](https://github.com/salesforcecli/plugin-org/blob/5.8.4/src/commands/org/open/agent.ts)_
932
932
 
933
933
  ## `sf org refresh sandbox`
934
934
 
@@ -1031,7 +1031,7 @@ FLAG DESCRIPTIONS
1031
1031
  You can specify either --source-sandbox-name or --source-id when refreshing an existing sandbox, but not both.
1032
1032
  ```
1033
1033
 
1034
- _See code: [src/commands/org/refresh/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.8.3/src/commands/org/refresh/sandbox.ts)_
1034
+ _See code: [src/commands/org/refresh/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.8.4/src/commands/org/refresh/sandbox.ts)_
1035
1035
 
1036
1036
  ## `sf org resume sandbox`
1037
1037
 
@@ -1094,7 +1094,7 @@ FLAG DESCRIPTIONS
1094
1094
  returns the job ID. To resume checking the sandbox creation, rerun this command.
1095
1095
  ```
1096
1096
 
1097
- _See code: [src/commands/org/resume/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.8.3/src/commands/org/resume/sandbox.ts)_
1097
+ _See code: [src/commands/org/resume/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.8.4/src/commands/org/resume/sandbox.ts)_
1098
1098
 
1099
1099
  ## `sf org resume scratch`
1100
1100
 
@@ -1147,6 +1147,6 @@ FLAG DESCRIPTIONS
1147
1147
  returns the job ID. To resume checking the scratch creation, rerun this command.
1148
1148
  ```
1149
1149
 
1150
- _See code: [src/commands/org/resume/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.8.3/src/commands/org/resume/scratch.ts)_
1150
+ _See code: [src/commands/org/resume/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.8.4/src/commands/org/resume/scratch.ts)_
1151
1151
 
1152
1152
  <!-- commandsstop -->
@@ -1143,15 +1143,16 @@
1143
1143
  "tracking:enable:org"
1144
1144
  ]
1145
1145
  },
1146
- "org:refresh:sandbox": {
1147
- "aliases": [],
1146
+ "org:list:metadata-types": {
1147
+ "aliases": [
1148
+ "force:mdapi:describemetadata"
1149
+ ],
1148
1150
  "args": {},
1149
- "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.",
1151
+ "deprecateAliases": true,
1152
+ "description": "The information includes Apex classes and triggers, custom objects, custom fields on standard objects, tab sets that define an app, and many other metadata types. Use this information to identify the syntax needed for a <name> element in a manifest file (package.xml).\n\nThe username that you use to connect to the org must have the Modify All Data or Modify Metadata Through Metadata API Functions permission.",
1150
1153
  "examples": [
1151
- "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",
1152
- "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",
1153
- "Refresh the sandbox using the name defined in the definition file. The production org that contains the sandbox license has the alias \"prodOrg\".\n<%= config.bin %> <%= command.id %> --definition-file devSbx3-config.json --target-org prodOrg",
1154
- "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"
1154
+ "Display information about all known and enabled metadata types in the org with alias \"my-dev-org\" using API version 57.0:\n$ <%= config.bin %> <%= command.id %> --api-version 57.0 --target-org my-dev-org",
1155
+ "Display only the metadata types that aren't yet supported by Salesforce CLI in your default org and write the results to the specified file:\n$ <%= config.bin %> <%= command.id %> --output-file /path/to/outputfilename.txt --filter-known"
1155
1156
  ],
1156
1157
  "flags": {
1157
1158
  "json": {
@@ -1169,129 +1170,236 @@
1169
1170
  "multiple": false,
1170
1171
  "type": "option"
1171
1172
  },
1172
- "no-auto-activate": {
1173
- "description": "By default, a sandbox auto-activates after a refresh. Use this flag to control sandbox activation manually.",
1174
- "name": "no-auto-activate",
1175
- "summary": "Disable auto-activation of the sandbox after a successful refresh.",
1176
- "allowNo": false,
1177
- "type": "boolean"
1178
- },
1179
- "wait": {
1180
- "char": "w",
1181
- "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.",
1182
- "exclusive": [
1183
- "async"
1173
+ "api-version": {
1174
+ "aliases": [
1175
+ "apiversion",
1176
+ "a"
1184
1177
  ],
1185
- "name": "wait",
1186
- "summary": "Number of minutes to poll for sandbox refresh status.",
1187
- "hasDynamicHelp": true,
1188
- "helpValue": "<minutes>",
1178
+ "deprecateAliases": true,
1179
+ "description": "Override the api version used for api requests made by this command",
1180
+ "name": "api-version",
1181
+ "summary": "API version to use; default is the most recent API version.",
1182
+ "hasDynamicHelp": false,
1189
1183
  "multiple": false,
1190
1184
  "type": "option"
1191
1185
  },
1192
- "poll-interval": {
1193
- "char": "i",
1194
- "exclusive": [
1195
- "async"
1196
- ],
1197
- "name": "poll-interval",
1198
- "summary": "Number of seconds to wait between status polling requests.",
1199
- "hasDynamicHelp": true,
1200
- "helpValue": "<seconds>",
1186
+ "loglevel": {
1187
+ "deprecated": {
1188
+ "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
1189
+ },
1190
+ "hidden": true,
1191
+ "name": "loglevel",
1192
+ "hasDynamicHelp": false,
1201
1193
  "multiple": false,
1202
1194
  "type": "option"
1203
1195
  },
1204
- "source-sandbox-name": {
1205
- "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.",
1206
- "exclusive": [
1207
- "source-id"
1196
+ "target-org": {
1197
+ "aliases": [
1198
+ "targetusername",
1199
+ "u"
1208
1200
  ],
1209
- "name": "source-sandbox-name",
1210
- "summary": "Name of the sandbox org that becomes the new source org for the refreshed sandbox.",
1211
- "hasDynamicHelp": false,
1201
+ "char": "o",
1202
+ "deprecateAliases": true,
1203
+ "name": "target-org",
1204
+ "noCacheDefault": true,
1205
+ "required": true,
1206
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1207
+ "hasDynamicHelp": true,
1212
1208
  "multiple": false,
1213
1209
  "type": "option"
1214
1210
  },
1215
- "source-id": {
1216
- "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.",
1217
- "exclusive": [
1218
- "source-sandbox-name"
1211
+ "output-file": {
1212
+ "aliases": [
1213
+ "resultfile"
1219
1214
  ],
1220
- "name": "source-id",
1221
- "summary": "ID of the sandbox org that becomes the new source org for the refreshed sandbox.",
1215
+ "char": "f",
1216
+ "deprecateAliases": true,
1217
+ "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.",
1218
+ "name": "output-file",
1219
+ "summary": "Pathname of the file in which to write the results.",
1222
1220
  "hasDynamicHelp": false,
1223
1221
  "multiple": false,
1224
1222
  "type": "option"
1225
1223
  },
1226
- "async": {
1227
- "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\".",
1228
- "exclusive": [
1229
- "wait",
1230
- "poll-interval"
1224
+ "filter-known": {
1225
+ "aliases": [
1226
+ "filterknown"
1231
1227
  ],
1232
- "name": "async",
1233
- "summary": "Request the sandbox refresh, but don't wait for it to complete.",
1228
+ "char": "k",
1229
+ "deprecateAliases": true,
1230
+ "hidden": true,
1231
+ "name": "filter-known",
1232
+ "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",
1233
+ "allowNo": false,
1234
+ "type": "boolean"
1235
+ }
1236
+ },
1237
+ "hasDynamicHelp": true,
1238
+ "hiddenAliases": [],
1239
+ "id": "org:list:metadata-types",
1240
+ "pluginAlias": "@salesforce/plugin-org",
1241
+ "pluginName": "@salesforce/plugin-org",
1242
+ "pluginType": "core",
1243
+ "strict": true,
1244
+ "summary": "Display details about the metadata types that are enabled for your org.",
1245
+ "enableJsonFlag": true,
1246
+ "isESM": true,
1247
+ "relativePath": [
1248
+ "lib",
1249
+ "commands",
1250
+ "org",
1251
+ "list",
1252
+ "metadata-types.js"
1253
+ ],
1254
+ "aliasPermutations": [
1255
+ "force:mdapi:describemetadata",
1256
+ "mdapi:force:describemetadata",
1257
+ "mdapi:describemetadata:force",
1258
+ "force:describemetadata:mdapi",
1259
+ "describemetadata:force:mdapi",
1260
+ "describemetadata:mdapi:force"
1261
+ ],
1262
+ "permutations": [
1263
+ "org:list:metadata-types",
1264
+ "list:org:metadata-types",
1265
+ "list:metadata-types:org",
1266
+ "org:metadata-types:list",
1267
+ "metadata-types:org:list",
1268
+ "metadata-types:list:org"
1269
+ ]
1270
+ },
1271
+ "org:list:metadata": {
1272
+ "aliases": [
1273
+ "force:mdapi:listmetadata"
1274
+ ],
1275
+ "args": {},
1276
+ "deprecateAliases": true,
1277
+ "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.",
1278
+ "examples": [
1279
+ "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",
1280
+ "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",
1281
+ "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"
1282
+ ],
1283
+ "flags": {
1284
+ "json": {
1285
+ "description": "Format output as json.",
1286
+ "helpGroup": "GLOBAL",
1287
+ "name": "json",
1234
1288
  "allowNo": false,
1235
1289
  "type": "boolean"
1236
1290
  },
1237
- "name": {
1238
- "char": "n",
1239
- "name": "name",
1240
- "summary": "Name of the existing sandbox org in your production org that you want to refresh.",
1291
+ "flags-dir": {
1292
+ "helpGroup": "GLOBAL",
1293
+ "name": "flags-dir",
1294
+ "summary": "Import flag values from a directory.",
1241
1295
  "hasDynamicHelp": false,
1242
1296
  "multiple": false,
1243
1297
  "type": "option"
1244
1298
  },
1245
- "definition-file": {
1246
- "char": "f",
1247
- "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.",
1248
- "name": "definition-file",
1249
- "summary": "Path to a sandbox definition file for overriding its configuration when you refresh it.",
1299
+ "api-version": {
1300
+ "aliases": [
1301
+ "apiversion",
1302
+ "a"
1303
+ ],
1304
+ "deprecateAliases": true,
1305
+ "description": "Override the api version used for api requests made by this command",
1306
+ "name": "api-version",
1307
+ "summary": "API version to use; default is the most recent API version.",
1308
+ "hasDynamicHelp": false,
1309
+ "multiple": false,
1310
+ "type": "option"
1311
+ },
1312
+ "loglevel": {
1313
+ "deprecated": {
1314
+ "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."
1315
+ },
1316
+ "hidden": true,
1317
+ "name": "loglevel",
1250
1318
  "hasDynamicHelp": false,
1251
1319
  "multiple": false,
1252
1320
  "type": "option"
1253
1321
  },
1254
1322
  "target-org": {
1323
+ "aliases": [
1324
+ "targetusername",
1325
+ "u"
1326
+ ],
1255
1327
  "char": "o",
1328
+ "deprecateAliases": true,
1256
1329
  "name": "target-org",
1257
1330
  "noCacheDefault": true,
1258
1331
  "required": true,
1259
- "summary": "Username or alias of the production org that contains the sandbox license.",
1332
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1260
1333
  "hasDynamicHelp": true,
1261
1334
  "multiple": false,
1262
1335
  "type": "option"
1263
1336
  },
1264
- "no-prompt": {
1265
- "name": "no-prompt",
1266
- "summary": "Don't prompt for confirmation about the sandbox refresh.",
1267
- "allowNo": false,
1268
- "type": "boolean"
1337
+ "output-file": {
1338
+ "aliases": [
1339
+ "resultfile"
1340
+ ],
1341
+ "char": "f",
1342
+ "deprecateAliases": true,
1343
+ "name": "output-file",
1344
+ "summary": "Pathname of the file in which to write the results.",
1345
+ "hasDynamicHelp": false,
1346
+ "multiple": false,
1347
+ "type": "option"
1348
+ },
1349
+ "metadata-type": {
1350
+ "aliases": [
1351
+ "metadatatype"
1352
+ ],
1353
+ "char": "m",
1354
+ "deprecateAliases": true,
1355
+ "name": "metadata-type",
1356
+ "required": true,
1357
+ "summary": "Metadata type to be retrieved, such as CustomObject; metadata type names are case-sensitive.",
1358
+ "hasDynamicHelp": false,
1359
+ "multiple": false,
1360
+ "type": "option"
1361
+ },
1362
+ "folder": {
1363
+ "description": "Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.",
1364
+ "name": "folder",
1365
+ "summary": "Folder associated with the component; required for components that use folders; folder names are case-sensitive.",
1366
+ "hasDynamicHelp": false,
1367
+ "multiple": false,
1368
+ "type": "option"
1269
1369
  }
1270
1370
  },
1271
1371
  "hasDynamicHelp": true,
1272
1372
  "hiddenAliases": [],
1273
- "id": "org:refresh:sandbox",
1373
+ "id": "org:list:metadata",
1274
1374
  "pluginAlias": "@salesforce/plugin-org",
1275
1375
  "pluginName": "@salesforce/plugin-org",
1276
1376
  "pluginType": "core",
1277
1377
  "strict": true,
1278
- "summary": "Refresh a sandbox org using the sandbox name.",
1378
+ "summary": "List the metadata components and properties of a specified type.",
1379
+ "enableJsonFlag": true,
1279
1380
  "isESM": true,
1280
1381
  "relativePath": [
1281
1382
  "lib",
1282
1383
  "commands",
1283
1384
  "org",
1284
- "refresh",
1285
- "sandbox.js"
1385
+ "list",
1386
+ "metadata.js"
1387
+ ],
1388
+ "aliasPermutations": [
1389
+ "force:mdapi:listmetadata",
1390
+ "mdapi:force:listmetadata",
1391
+ "mdapi:listmetadata:force",
1392
+ "force:listmetadata:mdapi",
1393
+ "listmetadata:force:mdapi",
1394
+ "listmetadata:mdapi:force"
1286
1395
  ],
1287
- "aliasPermutations": [],
1288
1396
  "permutations": [
1289
- "org:refresh:sandbox",
1290
- "refresh:org:sandbox",
1291
- "refresh:sandbox:org",
1292
- "org:sandbox:refresh",
1293
- "sandbox:org:refresh",
1294
- "sandbox:refresh:org"
1397
+ "org:list:metadata",
1398
+ "list:org:metadata",
1399
+ "list:metadata:org",
1400
+ "org:metadata:list",
1401
+ "metadata:org:list",
1402
+ "metadata:list:org"
1295
1403
  ]
1296
1404
  },
1297
1405
  "org:open:agent": {
@@ -1411,17 +1519,15 @@
1411
1519
  "agent:open:org"
1412
1520
  ]
1413
1521
  },
1414
- "org:resume:sandbox": {
1415
- "aliases": [
1416
- "env:resume:sandbox"
1417
- ],
1522
+ "org:refresh:sandbox": {
1523
+ "aliases": [],
1418
1524
  "args": {},
1419
- "deprecateAliases": true,
1420
- "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.",
1525
+ "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.",
1421
1526
  "examples": [
1422
- "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",
1423
- "Check the status using the job ID:\n<%= config.bin %> <%= command.id %> --job-id 0GRxxxxxxxx",
1424
- "Check the status of the most recent sandbox create request:\n<%= config.bin %> <%= command.id %> --use-most-recent"
1527
+ "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",
1528
+ "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",
1529
+ "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",
1530
+ "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"
1425
1531
  ],
1426
1532
  "flags": {
1427
1533
  "json": {
@@ -1439,190 +1545,142 @@
1439
1545
  "multiple": false,
1440
1546
  "type": "option"
1441
1547
  },
1548
+ "no-auto-activate": {
1549
+ "description": "By default, a sandbox auto-activates after a refresh. Use this flag to control sandbox activation manually.",
1550
+ "name": "no-auto-activate",
1551
+ "summary": "Disable auto-activation of the sandbox after a successful refresh.",
1552
+ "allowNo": false,
1553
+ "type": "boolean"
1554
+ },
1442
1555
  "wait": {
1443
1556
  "char": "w",
1444
- "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.",
1557
+ "description": "If the command continues to run after the wait period, the CLI returns control of the terminal to you and displays the \"<%= config.bin %> org resume sandbox\" command for you run to check the status of the refresh. The displayed command includes the job ID for the running sandbox refresh.",
1558
+ "exclusive": [
1559
+ "async"
1560
+ ],
1445
1561
  "name": "wait",
1446
- "summary": "Number of minutes to wait for the sandbox org to be ready.",
1447
- "default": "0 minutes",
1562
+ "summary": "Number of minutes to poll for sandbox refresh status.",
1448
1563
  "hasDynamicHelp": true,
1449
1564
  "helpValue": "<minutes>",
1450
1565
  "multiple": false,
1451
1566
  "type": "option"
1452
1567
  },
1453
- "name": {
1454
- "char": "n",
1568
+ "poll-interval": {
1569
+ "char": "i",
1455
1570
  "exclusive": [
1456
- "job-id"
1571
+ "async"
1457
1572
  ],
1458
- "name": "name",
1459
- "summary": "Name of the sandbox org.",
1460
- "hasDynamicHelp": false,
1573
+ "name": "poll-interval",
1574
+ "summary": "Number of seconds to wait between status polling requests.",
1575
+ "hasDynamicHelp": true,
1576
+ "helpValue": "<seconds>",
1461
1577
  "multiple": false,
1462
1578
  "type": "option"
1463
1579
  },
1464
- "job-id": {
1465
- "char": "i",
1466
- "description": "The job ID is valid for 24 hours after you start the sandbox creation.",
1580
+ "source-sandbox-name": {
1581
+ "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.",
1467
1582
  "exclusive": [
1468
- "name"
1583
+ "source-id"
1469
1584
  ],
1470
- "name": "job-id",
1471
- "summary": "Job ID of the incomplete sandbox creation that you want to check the status of.",
1585
+ "name": "source-sandbox-name",
1586
+ "summary": "Name of the sandbox org that becomes the new source org for the refreshed sandbox.",
1472
1587
  "hasDynamicHelp": false,
1473
1588
  "multiple": false,
1474
1589
  "type": "option"
1475
1590
  },
1476
- "use-most-recent": {
1477
- "char": "l",
1478
- "name": "use-most-recent",
1479
- "summary": "Use the most recent sandbox create request.",
1480
- "allowNo": false,
1481
- "type": "boolean"
1482
- },
1483
- "target-org": {
1484
- "char": "o",
1485
- "description": "When it creates the sandbox org, Salesforce copies the metadata, and optionally data, from your production org to the new sandbox org.",
1486
- "name": "target-org",
1487
- "noCacheDefault": true,
1488
- "summary": "Username or alias of the production org that contains the sandbox license.",
1489
- "hasDynamicHelp": true,
1591
+ "source-id": {
1592
+ "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.",
1593
+ "exclusive": [
1594
+ "source-sandbox-name"
1595
+ ],
1596
+ "name": "source-id",
1597
+ "summary": "ID of the sandbox org that becomes the new source org for the refreshed sandbox.",
1598
+ "hasDynamicHelp": false,
1490
1599
  "multiple": false,
1491
1600
  "type": "option"
1492
- }
1493
- },
1494
- "hasDynamicHelp": true,
1495
- "hiddenAliases": [],
1496
- "id": "org:resume:sandbox",
1497
- "pluginAlias": "@salesforce/plugin-org",
1498
- "pluginName": "@salesforce/plugin-org",
1499
- "pluginType": "core",
1500
- "strict": true,
1501
- "summary": "Check the status of a sandbox creation, and log in to it if it's ready.",
1502
- "isESM": true,
1503
- "relativePath": [
1504
- "lib",
1505
- "commands",
1506
- "org",
1507
- "resume",
1508
- "sandbox.js"
1509
- ],
1510
- "aliasPermutations": [
1511
- "env:resume:sandbox",
1512
- "resume:env:sandbox",
1513
- "resume:sandbox:env",
1514
- "env:sandbox:resume",
1515
- "sandbox:env:resume",
1516
- "sandbox:resume:env"
1517
- ],
1518
- "permutations": [
1519
- "org:resume:sandbox",
1520
- "resume:org:sandbox",
1521
- "resume:sandbox:org",
1522
- "org:sandbox:resume",
1523
- "sandbox:org:resume",
1524
- "sandbox:resume:org"
1525
- ]
1526
- },
1527
- "org:resume:scratch": {
1528
- "aliases": [
1529
- "env:resume:scratch"
1530
- ],
1531
- "args": {},
1532
- "deprecateAliases": true,
1533
- "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.",
1534
- "examples": [
1535
- "Resume a scratch org create with a job ID:\n<%= config.bin %> <%= command.id %> --job-id 2SR3u0000008fBDGAY",
1536
- "Resume your most recent incomplete scratch org:\n<%= config.bin %> <%= command.id %> --use-most-recent"
1537
- ],
1538
- "flags": {
1539
- "json": {
1540
- "description": "Format output as json.",
1541
- "helpGroup": "GLOBAL",
1542
- "name": "json",
1601
+ },
1602
+ "async": {
1603
+ "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\".",
1604
+ "exclusive": [
1605
+ "wait",
1606
+ "poll-interval"
1607
+ ],
1608
+ "name": "async",
1609
+ "summary": "Request the sandbox refresh, but don't wait for it to complete.",
1543
1610
  "allowNo": false,
1544
1611
  "type": "boolean"
1545
1612
  },
1546
- "flags-dir": {
1547
- "helpGroup": "GLOBAL",
1548
- "name": "flags-dir",
1549
- "summary": "Import flag values from a directory.",
1613
+ "name": {
1614
+ "char": "n",
1615
+ "name": "name",
1616
+ "summary": "Name of the existing sandbox org in your production org that you want to refresh.",
1550
1617
  "hasDynamicHelp": false,
1551
1618
  "multiple": false,
1552
1619
  "type": "option"
1553
1620
  },
1554
- "job-id": {
1555
- "char": "i",
1556
- "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.",
1557
- "name": "job-id",
1558
- "summary": "Job ID of the incomplete scratch org create that you want to resume.",
1621
+ "definition-file": {
1622
+ "char": "f",
1623
+ "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.",
1624
+ "name": "definition-file",
1625
+ "summary": "Path to a sandbox definition file for overriding its configuration when you refresh it.",
1559
1626
  "hasDynamicHelp": false,
1560
1627
  "multiple": false,
1561
1628
  "type": "option"
1562
1629
  },
1563
- "use-most-recent": {
1564
- "char": "r",
1565
- "name": "use-most-recent",
1566
- "summary": "Use the job ID of the most recent incomplete scratch org.",
1567
- "allowNo": false,
1568
- "type": "boolean"
1569
- },
1570
- "wait": {
1571
- "char": "w",
1572
- "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.",
1573
- "name": "wait",
1574
- "summary": "Number of minutes to wait for the scratch org to be ready.",
1575
- "default": "0 minutes",
1630
+ "target-org": {
1631
+ "char": "o",
1632
+ "name": "target-org",
1633
+ "noCacheDefault": true,
1634
+ "required": true,
1635
+ "summary": "Username or alias of the production org that contains the sandbox license.",
1576
1636
  "hasDynamicHelp": true,
1577
- "helpValue": "<minutes>",
1578
1637
  "multiple": false,
1579
1638
  "type": "option"
1639
+ },
1640
+ "no-prompt": {
1641
+ "name": "no-prompt",
1642
+ "summary": "Don't prompt for confirmation about the sandbox refresh.",
1643
+ "allowNo": false,
1644
+ "type": "boolean"
1580
1645
  }
1581
1646
  },
1582
1647
  "hasDynamicHelp": true,
1583
1648
  "hiddenAliases": [],
1584
- "id": "org:resume:scratch",
1649
+ "id": "org:refresh:sandbox",
1585
1650
  "pluginAlias": "@salesforce/plugin-org",
1586
1651
  "pluginName": "@salesforce/plugin-org",
1587
1652
  "pluginType": "core",
1588
1653
  "strict": true,
1589
- "summary": "Resume the creation of an incomplete scratch org.",
1590
- "enableJsonFlag": true,
1654
+ "summary": "Refresh a sandbox org using the sandbox name.",
1591
1655
  "isESM": true,
1592
1656
  "relativePath": [
1593
1657
  "lib",
1594
1658
  "commands",
1595
1659
  "org",
1596
- "resume",
1597
- "scratch.js"
1598
- ],
1599
- "aliasPermutations": [
1600
- "env:resume:scratch",
1601
- "resume:env:scratch",
1602
- "resume:scratch:env",
1603
- "env:scratch:resume",
1604
- "scratch:env:resume",
1605
- "scratch:resume:env"
1606
- ],
1607
- "permutations": [
1608
- "org:resume:scratch",
1609
- "resume:org:scratch",
1610
- "resume:scratch:org",
1611
- "org:scratch:resume",
1612
- "scratch:org:resume",
1613
- "scratch:resume:org"
1660
+ "refresh",
1661
+ "sandbox.js"
1662
+ ],
1663
+ "aliasPermutations": [],
1664
+ "permutations": [
1665
+ "org:refresh:sandbox",
1666
+ "refresh:org:sandbox",
1667
+ "refresh:sandbox:org",
1668
+ "org:sandbox:refresh",
1669
+ "sandbox:org:refresh",
1670
+ "sandbox:refresh:org"
1614
1671
  ]
1615
1672
  },
1616
- "org:list:metadata-types": {
1673
+ "org:resume:sandbox": {
1617
1674
  "aliases": [
1618
- "force:mdapi:describemetadata"
1675
+ "env:resume:sandbox"
1619
1676
  ],
1620
1677
  "args": {},
1621
1678
  "deprecateAliases": true,
1622
- "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.",
1679
+ "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.",
1623
1680
  "examples": [
1624
- "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",
1625
- "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"
1681
+ "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",
1682
+ "Check the status using the job ID:\n<%= config.bin %> <%= command.id %> --job-id 0GRxxxxxxxx",
1683
+ "Check the status of the most recent sandbox create request:\n<%= config.bin %> <%= command.id %> --use-most-recent"
1626
1684
  ],
1627
1685
  "flags": {
1628
1686
  "json": {
@@ -1640,115 +1698,101 @@
1640
1698
  "multiple": false,
1641
1699
  "type": "option"
1642
1700
  },
1643
- "api-version": {
1644
- "aliases": [
1645
- "apiversion",
1646
- "a"
1701
+ "wait": {
1702
+ "char": "w",
1703
+ "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.",
1704
+ "name": "wait",
1705
+ "summary": "Number of minutes to wait for the sandbox org to be ready.",
1706
+ "default": "0 minutes",
1707
+ "hasDynamicHelp": true,
1708
+ "helpValue": "<minutes>",
1709
+ "multiple": false,
1710
+ "type": "option"
1711
+ },
1712
+ "name": {
1713
+ "char": "n",
1714
+ "exclusive": [
1715
+ "job-id"
1647
1716
  ],
1648
- "deprecateAliases": true,
1649
- "description": "Override the api version used for api requests made by this command",
1650
- "name": "api-version",
1651
- "summary": "API version to use; default is the most recent API version.",
1717
+ "name": "name",
1718
+ "summary": "Name of the sandbox org.",
1652
1719
  "hasDynamicHelp": false,
1653
1720
  "multiple": false,
1654
1721
  "type": "option"
1655
1722
  },
1656
- "loglevel": {
1657
- "deprecated": {
1658
- "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."
1659
- },
1660
- "hidden": true,
1661
- "name": "loglevel",
1723
+ "job-id": {
1724
+ "char": "i",
1725
+ "description": "The job ID is valid for 24 hours after you start the sandbox creation.",
1726
+ "exclusive": [
1727
+ "name"
1728
+ ],
1729
+ "name": "job-id",
1730
+ "summary": "Job ID of the incomplete sandbox creation that you want to check the status of.",
1662
1731
  "hasDynamicHelp": false,
1663
1732
  "multiple": false,
1664
1733
  "type": "option"
1665
1734
  },
1735
+ "use-most-recent": {
1736
+ "char": "l",
1737
+ "name": "use-most-recent",
1738
+ "summary": "Use the most recent sandbox create request.",
1739
+ "allowNo": false,
1740
+ "type": "boolean"
1741
+ },
1666
1742
  "target-org": {
1667
- "aliases": [
1668
- "targetusername",
1669
- "u"
1670
- ],
1671
1743
  "char": "o",
1672
- "deprecateAliases": true,
1744
+ "description": "When it creates the sandbox org, Salesforce copies the metadata, and optionally data, from your production org to the new sandbox org.",
1673
1745
  "name": "target-org",
1674
1746
  "noCacheDefault": true,
1675
- "required": true,
1676
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1747
+ "summary": "Username or alias of the production org that contains the sandbox license.",
1677
1748
  "hasDynamicHelp": true,
1678
1749
  "multiple": false,
1679
1750
  "type": "option"
1680
- },
1681
- "output-file": {
1682
- "aliases": [
1683
- "resultfile"
1684
- ],
1685
- "char": "f",
1686
- "deprecateAliases": true,
1687
- "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.",
1688
- "name": "output-file",
1689
- "summary": "Pathname of the file in which to write the results.",
1690
- "hasDynamicHelp": false,
1691
- "multiple": false,
1692
- "type": "option"
1693
- },
1694
- "filter-known": {
1695
- "aliases": [
1696
- "filterknown"
1697
- ],
1698
- "char": "k",
1699
- "deprecateAliases": true,
1700
- "hidden": true,
1701
- "name": "filter-known",
1702
- "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",
1703
- "allowNo": false,
1704
- "type": "boolean"
1705
1751
  }
1706
1752
  },
1707
1753
  "hasDynamicHelp": true,
1708
1754
  "hiddenAliases": [],
1709
- "id": "org:list:metadata-types",
1755
+ "id": "org:resume:sandbox",
1710
1756
  "pluginAlias": "@salesforce/plugin-org",
1711
1757
  "pluginName": "@salesforce/plugin-org",
1712
1758
  "pluginType": "core",
1713
1759
  "strict": true,
1714
- "summary": "Display details about the metadata types that are enabled for your org.",
1715
- "enableJsonFlag": true,
1760
+ "summary": "Check the status of a sandbox creation, and log in to it if it's ready.",
1716
1761
  "isESM": true,
1717
1762
  "relativePath": [
1718
1763
  "lib",
1719
1764
  "commands",
1720
1765
  "org",
1721
- "list",
1722
- "metadata-types.js"
1766
+ "resume",
1767
+ "sandbox.js"
1723
1768
  ],
1724
1769
  "aliasPermutations": [
1725
- "force:mdapi:describemetadata",
1726
- "mdapi:force:describemetadata",
1727
- "mdapi:describemetadata:force",
1728
- "force:describemetadata:mdapi",
1729
- "describemetadata:force:mdapi",
1730
- "describemetadata:mdapi:force"
1770
+ "env:resume:sandbox",
1771
+ "resume:env:sandbox",
1772
+ "resume:sandbox:env",
1773
+ "env:sandbox:resume",
1774
+ "sandbox:env:resume",
1775
+ "sandbox:resume:env"
1731
1776
  ],
1732
1777
  "permutations": [
1733
- "org:list:metadata-types",
1734
- "list:org:metadata-types",
1735
- "list:metadata-types:org",
1736
- "org:metadata-types:list",
1737
- "metadata-types:org:list",
1738
- "metadata-types:list:org"
1778
+ "org:resume:sandbox",
1779
+ "resume:org:sandbox",
1780
+ "resume:sandbox:org",
1781
+ "org:sandbox:resume",
1782
+ "sandbox:org:resume",
1783
+ "sandbox:resume:org"
1739
1784
  ]
1740
1785
  },
1741
- "org:list:metadata": {
1786
+ "org:resume:scratch": {
1742
1787
  "aliases": [
1743
- "force:mdapi:listmetadata"
1788
+ "env:resume:scratch"
1744
1789
  ],
1745
1790
  "args": {},
1746
1791
  "deprecateAliases": true,
1747
- "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.",
1792
+ "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.",
1748
1793
  "examples": [
1749
- "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",
1750
- "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",
1751
- "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"
1794
+ "Resume a scratch org create with a job ID:\n<%= config.bin %> <%= command.id %> --job-id 2SR3u0000008fBDGAY",
1795
+ "Resume your most recent incomplete scratch org:\n<%= config.bin %> <%= command.id %> --use-most-recent"
1752
1796
  ],
1753
1797
  "flags": {
1754
1798
  "json": {
@@ -1766,112 +1810,68 @@
1766
1810
  "multiple": false,
1767
1811
  "type": "option"
1768
1812
  },
1769
- "api-version": {
1770
- "aliases": [
1771
- "apiversion",
1772
- "a"
1773
- ],
1774
- "deprecateAliases": true,
1775
- "description": "Override the api version used for api requests made by this command",
1776
- "name": "api-version",
1777
- "summary": "API version to use; default is the most recent API version.",
1813
+ "job-id": {
1814
+ "char": "i",
1815
+ "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.",
1816
+ "name": "job-id",
1817
+ "summary": "Job ID of the incomplete scratch org create that you want to resume.",
1778
1818
  "hasDynamicHelp": false,
1779
1819
  "multiple": false,
1780
1820
  "type": "option"
1781
1821
  },
1782
- "loglevel": {
1783
- "deprecated": {
1784
- "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."
1785
- },
1786
- "hidden": true,
1787
- "name": "loglevel",
1788
- "hasDynamicHelp": false,
1789
- "multiple": false,
1790
- "type": "option"
1822
+ "use-most-recent": {
1823
+ "char": "r",
1824
+ "name": "use-most-recent",
1825
+ "summary": "Use the job ID of the most recent incomplete scratch org.",
1826
+ "allowNo": false,
1827
+ "type": "boolean"
1791
1828
  },
1792
- "target-org": {
1793
- "aliases": [
1794
- "targetusername",
1795
- "u"
1796
- ],
1797
- "char": "o",
1798
- "deprecateAliases": true,
1799
- "name": "target-org",
1800
- "noCacheDefault": true,
1801
- "required": true,
1802
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1829
+ "wait": {
1830
+ "char": "w",
1831
+ "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.",
1832
+ "name": "wait",
1833
+ "summary": "Number of minutes to wait for the scratch org to be ready.",
1834
+ "default": "0 minutes",
1803
1835
  "hasDynamicHelp": true,
1804
- "multiple": false,
1805
- "type": "option"
1806
- },
1807
- "output-file": {
1808
- "aliases": [
1809
- "resultfile"
1810
- ],
1811
- "char": "f",
1812
- "deprecateAliases": true,
1813
- "name": "output-file",
1814
- "summary": "Pathname of the file in which to write the results.",
1815
- "hasDynamicHelp": false,
1816
- "multiple": false,
1817
- "type": "option"
1818
- },
1819
- "metadata-type": {
1820
- "aliases": [
1821
- "metadatatype"
1822
- ],
1823
- "char": "m",
1824
- "deprecateAliases": true,
1825
- "name": "metadata-type",
1826
- "required": true,
1827
- "summary": "Metadata type to be retrieved, such as CustomObject; metadata type names are case-sensitive.",
1828
- "hasDynamicHelp": false,
1829
- "multiple": false,
1830
- "type": "option"
1831
- },
1832
- "folder": {
1833
- "description": "Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.",
1834
- "name": "folder",
1835
- "summary": "Folder associated with the component; required for components that use folders; folder names are case-sensitive.",
1836
- "hasDynamicHelp": false,
1836
+ "helpValue": "<minutes>",
1837
1837
  "multiple": false,
1838
1838
  "type": "option"
1839
1839
  }
1840
1840
  },
1841
1841
  "hasDynamicHelp": true,
1842
1842
  "hiddenAliases": [],
1843
- "id": "org:list:metadata",
1843
+ "id": "org:resume:scratch",
1844
1844
  "pluginAlias": "@salesforce/plugin-org",
1845
1845
  "pluginName": "@salesforce/plugin-org",
1846
1846
  "pluginType": "core",
1847
1847
  "strict": true,
1848
- "summary": "List the metadata components and properties of a specified type.",
1848
+ "summary": "Resume the creation of an incomplete scratch org.",
1849
1849
  "enableJsonFlag": true,
1850
1850
  "isESM": true,
1851
1851
  "relativePath": [
1852
1852
  "lib",
1853
1853
  "commands",
1854
1854
  "org",
1855
- "list",
1856
- "metadata.js"
1855
+ "resume",
1856
+ "scratch.js"
1857
1857
  ],
1858
1858
  "aliasPermutations": [
1859
- "force:mdapi:listmetadata",
1860
- "mdapi:force:listmetadata",
1861
- "mdapi:listmetadata:force",
1862
- "force:listmetadata:mdapi",
1863
- "listmetadata:force:mdapi",
1864
- "listmetadata:mdapi:force"
1859
+ "env:resume:scratch",
1860
+ "resume:env:scratch",
1861
+ "resume:scratch:env",
1862
+ "env:scratch:resume",
1863
+ "scratch:env:resume",
1864
+ "scratch:resume:env"
1865
1865
  ],
1866
1866
  "permutations": [
1867
- "org:list:metadata",
1868
- "list:org:metadata",
1869
- "list:metadata:org",
1870
- "org:metadata:list",
1871
- "metadata:org:list",
1872
- "metadata:list:org"
1867
+ "org:resume:scratch",
1868
+ "resume:org:scratch",
1869
+ "resume:scratch:org",
1870
+ "org:scratch:resume",
1871
+ "scratch:org:resume",
1872
+ "scratch:resume:org"
1873
1873
  ]
1874
1874
  }
1875
1875
  },
1876
- "version": "5.8.3"
1876
+ "version": "5.8.4"
1877
1877
  }
package/package.json CHANGED
@@ -1,11 +1,11 @@
1
1
  {
2
2
  "name": "@salesforce/plugin-org",
3
3
  "description": "Commands to interact with Salesforce orgs",
4
- "version": "5.8.3",
4
+ "version": "5.8.4",
5
5
  "author": "Salesforce",
6
6
  "bugs": "https://github.com/forcedotcom/cli/issues",
7
7
  "dependencies": {
8
- "@oclif/core": "^4.3.3",
8
+ "@oclif/core": "^4.4.0",
9
9
  "@oclif/multi-stage-output": "^0.8.14",
10
10
  "@salesforce/core": "^8.13.0",
11
11
  "@salesforce/kit": "^3.2.3",
@@ -24,7 +24,7 @@
24
24
  "@salesforce/dev-scripts": "^11.0.2",
25
25
  "@salesforce/plugin-command-reference": "^3.1.56",
26
26
  "@salesforce/ts-sinon": "^1.4.30",
27
- "eslint-plugin-sf-plugin": "^1.20.24",
27
+ "eslint-plugin-sf-plugin": "^1.20.25",
28
28
  "moment": "^2.30.1",
29
29
  "oclif": "^4.18.1",
30
30
  "ts-node": "^10.9.2",
@@ -228,7 +228,7 @@
228
228
  "exports": "./lib/index.js",
229
229
  "type": "module",
230
230
  "sfdx": {
231
- "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/5.8.3.crt",
232
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/5.8.3.sig"
231
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/5.8.4.crt",
232
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/5.8.4.sig"
233
233
  }
234
234
  }