@salesforce/plugin-org 5.8.1 → 5.8.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +15 -15
  2. package/oclif.manifest.json +363 -363
  3. package/package.json +6 -6
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.1/src/commands/org/create/sandbox.ts)_
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)_
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.1/src/commands/org/create/scratch.ts)_
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)_
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.1/src/commands/org/delete/sandbox.ts)_
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)_
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.1/src/commands/org/delete/scratch.ts)_
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)_
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.1/src/commands/org/disable/tracking.ts)_
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)_
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.1/src/commands/org/display.ts)_
601
+ _See code: [src/commands/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/5.8.3/src/commands/org/display.ts)_
602
602
 
603
603
  ## `sf org enable tracking`
604
604
 
@@ -640,7 +640,7 @@ EXAMPLES
640
640
  $ sf org enable tracking
641
641
  ```
642
642
 
643
- _See code: [src/commands/org/enable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.8.1/src/commands/org/enable/tracking.ts)_
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)_
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.1/src/commands/org/list.ts)_
682
+ _See code: [src/commands/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/5.8.3/src/commands/org/list.ts)_
683
683
 
684
684
  ## `sf org list metadata`
685
685
 
@@ -746,7 +746,7 @@ FLAG DESCRIPTIONS
746
746
  Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.
747
747
  ```
748
748
 
749
- _See code: [src/commands/org/list/metadata.ts](https://github.com/salesforcecli/plugin-org/blob/5.8.1/src/commands/org/list/metadata.ts)_
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)_
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.1/src/commands/org/list/metadata-types.ts)_
804
+ _See code: [src/commands/org/list/metadata-types.ts](https://github.com/salesforcecli/plugin-org/blob/5.8.3/src/commands/org/list/metadata-types.ts)_
805
805
 
806
806
  ## `sf org open`
807
807
 
@@ -877,7 +877,7 @@ EXAMPLES
877
877
  $ sf org open --source-file force-app/main/default/bots/Coral_Cloud_Agent/Coral_Cloud_Agent.bot-meta.xml
878
878
  ```
879
879
 
880
- _See code: [src/commands/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/5.8.1/src/commands/org/open.ts)_
880
+ _See code: [src/commands/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/5.8.3/src/commands/org/open.ts)_
881
881
 
882
882
  ## `sf org open agent`
883
883
 
@@ -928,7 +928,7 @@ EXAMPLES
928
928
  $ sf org open agent --target-org MyTestOrg1 --browser firefox --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.1/src/commands/org/open/agent.ts)_
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)_
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.1/src/commands/org/refresh/sandbox.ts)_
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)_
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.1/src/commands/org/resume/sandbox.ts)_
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)_
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.1/src/commands/org/resume/scratch.ts)_
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)_
1151
1151
 
1152
1152
  <!-- commandsstop -->
@@ -1143,16 +1143,15 @@
1143
1143
  "tracking:enable:org"
1144
1144
  ]
1145
1145
  },
1146
- "org:list:metadata-types": {
1147
- "aliases": [
1148
- "force:mdapi:describemetadata"
1149
- ],
1146
+ "org:refresh:sandbox": {
1147
+ "aliases": [],
1150
1148
  "args": {},
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.",
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.",
1153
1150
  "examples": [
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"
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"
1156
1155
  ],
1157
1156
  "flags": {
1158
1157
  "json": {
@@ -1170,236 +1169,129 @@
1170
1169
  "multiple": false,
1171
1170
  "type": "option"
1172
1171
  },
1173
- "api-version": {
1174
- "aliases": [
1175
- "apiversion",
1176
- "a"
1177
- ],
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,
1183
- "multiple": false,
1184
- "type": "option"
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"
1185
1178
  },
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,
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"
1184
+ ],
1185
+ "name": "wait",
1186
+ "summary": "Number of minutes to poll for sandbox refresh status.",
1187
+ "hasDynamicHelp": true,
1188
+ "helpValue": "<minutes>",
1193
1189
  "multiple": false,
1194
1190
  "type": "option"
1195
1191
  },
1196
- "target-org": {
1197
- "aliases": [
1198
- "targetusername",
1199
- "u"
1192
+ "poll-interval": {
1193
+ "char": "i",
1194
+ "exclusive": [
1195
+ "async"
1200
1196
  ],
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.",
1197
+ "name": "poll-interval",
1198
+ "summary": "Number of seconds to wait between status polling requests.",
1207
1199
  "hasDynamicHelp": true,
1200
+ "helpValue": "<seconds>",
1208
1201
  "multiple": false,
1209
1202
  "type": "option"
1210
1203
  },
1211
- "output-file": {
1212
- "aliases": [
1213
- "resultfile"
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"
1214
1208
  ],
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.",
1209
+ "name": "source-sandbox-name",
1210
+ "summary": "Name of the sandbox org that becomes the new source org for the refreshed sandbox.",
1220
1211
  "hasDynamicHelp": false,
1221
1212
  "multiple": false,
1222
1213
  "type": "option"
1223
1214
  },
1224
- "filter-known": {
1225
- "aliases": [
1226
- "filterknown"
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"
1227
1219
  ],
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",
1288
- "allowNo": false,
1289
- "type": "boolean"
1290
- },
1291
- "flags-dir": {
1292
- "helpGroup": "GLOBAL",
1293
- "name": "flags-dir",
1294
- "summary": "Import flag values from a directory.",
1220
+ "name": "source-id",
1221
+ "summary": "ID of the sandbox org that becomes the new source org for the refreshed sandbox.",
1295
1222
  "hasDynamicHelp": false,
1296
1223
  "multiple": false,
1297
1224
  "type": "option"
1298
1225
  },
1299
- "api-version": {
1300
- "aliases": [
1301
- "apiversion",
1302
- "a"
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"
1303
1231
  ],
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.",
1232
+ "name": "async",
1233
+ "summary": "Request the sandbox refresh, but don't wait for it to complete.",
1234
+ "allowNo": false,
1235
+ "type": "boolean"
1236
+ },
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.",
1308
1241
  "hasDynamicHelp": false,
1309
1242
  "multiple": false,
1310
1243
  "type": "option"
1311
1244
  },
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",
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.",
1318
1250
  "hasDynamicHelp": false,
1319
1251
  "multiple": false,
1320
1252
  "type": "option"
1321
1253
  },
1322
1254
  "target-org": {
1323
- "aliases": [
1324
- "targetusername",
1325
- "u"
1326
- ],
1327
1255
  "char": "o",
1328
- "deprecateAliases": true,
1329
1256
  "name": "target-org",
1330
1257
  "noCacheDefault": true,
1331
1258
  "required": true,
1332
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1259
+ "summary": "Username or alias of the production org that contains the sandbox license.",
1333
1260
  "hasDynamicHelp": true,
1334
1261
  "multiple": false,
1335
1262
  "type": "option"
1336
1263
  },
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"
1264
+ "no-prompt": {
1265
+ "name": "no-prompt",
1266
+ "summary": "Don't prompt for confirmation about the sandbox refresh.",
1267
+ "allowNo": false,
1268
+ "type": "boolean"
1369
1269
  }
1370
1270
  },
1371
1271
  "hasDynamicHelp": true,
1372
1272
  "hiddenAliases": [],
1373
- "id": "org:list:metadata",
1273
+ "id": "org:refresh:sandbox",
1374
1274
  "pluginAlias": "@salesforce/plugin-org",
1375
1275
  "pluginName": "@salesforce/plugin-org",
1376
1276
  "pluginType": "core",
1377
1277
  "strict": true,
1378
- "summary": "List the metadata components and properties of a specified type.",
1379
- "enableJsonFlag": true,
1278
+ "summary": "Refresh a sandbox org using the sandbox name.",
1380
1279
  "isESM": true,
1381
1280
  "relativePath": [
1382
1281
  "lib",
1383
1282
  "commands",
1384
1283
  "org",
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"
1284
+ "refresh",
1285
+ "sandbox.js"
1395
1286
  ],
1287
+ "aliasPermutations": [],
1396
1288
  "permutations": [
1397
- "org:list:metadata",
1398
- "list:org:metadata",
1399
- "list:metadata:org",
1400
- "org:metadata:list",
1401
- "metadata:org:list",
1402
- "metadata:list:org"
1289
+ "org:refresh:sandbox",
1290
+ "refresh:org:sandbox",
1291
+ "refresh:sandbox:org",
1292
+ "org:sandbox:refresh",
1293
+ "sandbox:org:refresh",
1294
+ "sandbox:refresh:org"
1403
1295
  ]
1404
1296
  },
1405
1297
  "org:open:agent": {
@@ -1519,15 +1411,17 @@
1519
1411
  "agent:open:org"
1520
1412
  ]
1521
1413
  },
1522
- "org:refresh:sandbox": {
1523
- "aliases": [],
1414
+ "org:resume:sandbox": {
1415
+ "aliases": [
1416
+ "env:resume:sandbox"
1417
+ ],
1524
1418
  "args": {},
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.",
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.",
1526
1421
  "examples": [
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"
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"
1531
1425
  ],
1532
1426
  "flags": {
1533
1427
  "json": {
@@ -1545,142 +1439,190 @@
1545
1439
  "multiple": false,
1546
1440
  "type": "option"
1547
1441
  },
1548
- "no-auto-activate": {
1549
- "description": "By default, a sandbox auto-activates after a refresh. Use this flag to control sandbox activation manually.",
1550
- "name": "no-auto-activate",
1551
- "summary": "Disable auto-activation of the sandbox after a successful refresh.",
1552
- "allowNo": false,
1553
- "type": "boolean"
1554
- },
1555
1442
  "wait": {
1556
1443
  "char": "w",
1557
- "description": "If the command continues to run after the wait period, the CLI returns control of the terminal to you and displays the \"<%= config.bin %> org resume sandbox\" command for you run to check the status of the refresh. The displayed command includes the job ID for the running sandbox refresh.",
1558
- "exclusive": [
1559
- "async"
1560
- ],
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.",
1561
1445
  "name": "wait",
1562
- "summary": "Number of minutes to poll for sandbox refresh status.",
1446
+ "summary": "Number of minutes to wait for the sandbox org to be ready.",
1447
+ "default": "0 minutes",
1563
1448
  "hasDynamicHelp": true,
1564
1449
  "helpValue": "<minutes>",
1565
1450
  "multiple": false,
1566
1451
  "type": "option"
1567
1452
  },
1568
- "poll-interval": {
1569
- "char": "i",
1570
- "exclusive": [
1571
- "async"
1572
- ],
1573
- "name": "poll-interval",
1574
- "summary": "Number of seconds to wait between status polling requests.",
1575
- "hasDynamicHelp": true,
1576
- "helpValue": "<seconds>",
1577
- "multiple": false,
1578
- "type": "option"
1579
- },
1580
- "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.",
1453
+ "name": {
1454
+ "char": "n",
1582
1455
  "exclusive": [
1583
- "source-id"
1456
+ "job-id"
1584
1457
  ],
1585
- "name": "source-sandbox-name",
1586
- "summary": "Name of the sandbox org that becomes the new source org for the refreshed sandbox.",
1458
+ "name": "name",
1459
+ "summary": "Name of the sandbox org.",
1587
1460
  "hasDynamicHelp": false,
1588
1461
  "multiple": false,
1589
1462
  "type": "option"
1590
1463
  },
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.",
1464
+ "job-id": {
1465
+ "char": "i",
1466
+ "description": "The job ID is valid for 24 hours after you start the sandbox creation.",
1593
1467
  "exclusive": [
1594
- "source-sandbox-name"
1468
+ "name"
1595
1469
  ],
1596
- "name": "source-id",
1597
- "summary": "ID of the sandbox org that becomes the new source org for the refreshed sandbox.",
1470
+ "name": "job-id",
1471
+ "summary": "Job ID of the incomplete sandbox creation that you want to check the status of.",
1598
1472
  "hasDynamicHelp": false,
1599
1473
  "multiple": false,
1600
1474
  "type": "option"
1601
1475
  },
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.",
1476
+ "use-most-recent": {
1477
+ "char": "l",
1478
+ "name": "use-most-recent",
1479
+ "summary": "Use the most recent sandbox create request.",
1610
1480
  "allowNo": false,
1611
1481
  "type": "boolean"
1612
1482
  },
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.",
1617
- "hasDynamicHelp": false,
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,
1618
1490
  "multiple": false,
1619
1491
  "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",
1543
+ "allowNo": false,
1544
+ "type": "boolean"
1620
1545
  },
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.",
1546
+ "flags-dir": {
1547
+ "helpGroup": "GLOBAL",
1548
+ "name": "flags-dir",
1549
+ "summary": "Import flag values from a directory.",
1626
1550
  "hasDynamicHelp": false,
1627
1551
  "multiple": false,
1628
1552
  "type": "option"
1629
1553
  },
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.",
1636
- "hasDynamicHelp": true,
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.",
1559
+ "hasDynamicHelp": false,
1637
1560
  "multiple": false,
1638
1561
  "type": "option"
1639
1562
  },
1640
- "no-prompt": {
1641
- "name": "no-prompt",
1642
- "summary": "Don't prompt for confirmation about the sandbox refresh.",
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.",
1643
1567
  "allowNo": false,
1644
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",
1576
+ "hasDynamicHelp": true,
1577
+ "helpValue": "<minutes>",
1578
+ "multiple": false,
1579
+ "type": "option"
1645
1580
  }
1646
1581
  },
1647
1582
  "hasDynamicHelp": true,
1648
1583
  "hiddenAliases": [],
1649
- "id": "org:refresh:sandbox",
1584
+ "id": "org:resume:scratch",
1650
1585
  "pluginAlias": "@salesforce/plugin-org",
1651
1586
  "pluginName": "@salesforce/plugin-org",
1652
1587
  "pluginType": "core",
1653
1588
  "strict": true,
1654
- "summary": "Refresh a sandbox org using the sandbox name.",
1589
+ "summary": "Resume the creation of an incomplete scratch org.",
1590
+ "enableJsonFlag": true,
1655
1591
  "isESM": true,
1656
1592
  "relativePath": [
1657
1593
  "lib",
1658
1594
  "commands",
1659
1595
  "org",
1660
- "refresh",
1661
- "sandbox.js"
1596
+ "resume",
1597
+ "scratch.js"
1662
1598
  ],
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"
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"
1671
1614
  ]
1672
1615
  },
1673
- "org:resume:sandbox": {
1616
+ "org:list:metadata-types": {
1674
1617
  "aliases": [
1675
- "env:resume:sandbox"
1618
+ "force:mdapi:describemetadata"
1676
1619
  ],
1677
1620
  "args": {},
1678
1621
  "deprecateAliases": true,
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.",
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.",
1680
1623
  "examples": [
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"
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"
1684
1626
  ],
1685
1627
  "flags": {
1686
1628
  "json": {
@@ -1698,101 +1640,115 @@
1698
1640
  "multiple": false,
1699
1641
  "type": "option"
1700
1642
  },
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"
1643
+ "api-version": {
1644
+ "aliases": [
1645
+ "apiversion",
1646
+ "a"
1716
1647
  ],
1717
- "name": "name",
1718
- "summary": "Name of the sandbox org.",
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.",
1719
1652
  "hasDynamicHelp": false,
1720
1653
  "multiple": false,
1721
1654
  "type": "option"
1722
1655
  },
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.",
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",
1731
1662
  "hasDynamicHelp": false,
1732
1663
  "multiple": false,
1733
1664
  "type": "option"
1734
1665
  },
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
- },
1742
1666
  "target-org": {
1667
+ "aliases": [
1668
+ "targetusername",
1669
+ "u"
1670
+ ],
1743
1671
  "char": "o",
1744
- "description": "When it creates the sandbox org, Salesforce copies the metadata, and optionally data, from your production org to the new sandbox org.",
1672
+ "deprecateAliases": true,
1745
1673
  "name": "target-org",
1746
1674
  "noCacheDefault": true,
1747
- "summary": "Username or alias of the production org that contains the sandbox license.",
1675
+ "required": true,
1676
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1748
1677
  "hasDynamicHelp": true,
1749
1678
  "multiple": false,
1750
1679
  "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"
1751
1705
  }
1752
1706
  },
1753
1707
  "hasDynamicHelp": true,
1754
1708
  "hiddenAliases": [],
1755
- "id": "org:resume:sandbox",
1709
+ "id": "org:list:metadata-types",
1756
1710
  "pluginAlias": "@salesforce/plugin-org",
1757
1711
  "pluginName": "@salesforce/plugin-org",
1758
1712
  "pluginType": "core",
1759
1713
  "strict": true,
1760
- "summary": "Check the status of a sandbox creation, and log in to it if it's ready.",
1714
+ "summary": "Display details about the metadata types that are enabled for your org.",
1715
+ "enableJsonFlag": true,
1761
1716
  "isESM": true,
1762
1717
  "relativePath": [
1763
1718
  "lib",
1764
1719
  "commands",
1765
1720
  "org",
1766
- "resume",
1767
- "sandbox.js"
1721
+ "list",
1722
+ "metadata-types.js"
1768
1723
  ],
1769
1724
  "aliasPermutations": [
1770
- "env:resume:sandbox",
1771
- "resume:env:sandbox",
1772
- "resume:sandbox:env",
1773
- "env:sandbox:resume",
1774
- "sandbox:env:resume",
1775
- "sandbox:resume:env"
1725
+ "force:mdapi:describemetadata",
1726
+ "mdapi:force:describemetadata",
1727
+ "mdapi:describemetadata:force",
1728
+ "force:describemetadata:mdapi",
1729
+ "describemetadata:force:mdapi",
1730
+ "describemetadata:mdapi:force"
1776
1731
  ],
1777
1732
  "permutations": [
1778
- "org:resume:sandbox",
1779
- "resume:org:sandbox",
1780
- "resume:sandbox:org",
1781
- "org:sandbox:resume",
1782
- "sandbox:org:resume",
1783
- "sandbox:resume:org"
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"
1784
1739
  ]
1785
1740
  },
1786
- "org:resume:scratch": {
1741
+ "org:list:metadata": {
1787
1742
  "aliases": [
1788
- "env:resume:scratch"
1743
+ "force:mdapi:listmetadata"
1789
1744
  ],
1790
1745
  "args": {},
1791
1746
  "deprecateAliases": true,
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.",
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.",
1793
1748
  "examples": [
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"
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"
1796
1752
  ],
1797
1753
  "flags": {
1798
1754
  "json": {
@@ -1810,68 +1766,112 @@
1810
1766
  "multiple": false,
1811
1767
  "type": "option"
1812
1768
  },
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.",
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.",
1818
1778
  "hasDynamicHelp": false,
1819
1779
  "multiple": false,
1820
1780
  "type": "option"
1821
1781
  },
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"
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"
1828
1791
  },
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",
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.",
1835
1803
  "hasDynamicHelp": true,
1836
- "helpValue": "<minutes>",
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,
1837
1837
  "multiple": false,
1838
1838
  "type": "option"
1839
1839
  }
1840
1840
  },
1841
1841
  "hasDynamicHelp": true,
1842
1842
  "hiddenAliases": [],
1843
- "id": "org:resume:scratch",
1843
+ "id": "org:list:metadata",
1844
1844
  "pluginAlias": "@salesforce/plugin-org",
1845
1845
  "pluginName": "@salesforce/plugin-org",
1846
1846
  "pluginType": "core",
1847
1847
  "strict": true,
1848
- "summary": "Resume the creation of an incomplete scratch org.",
1848
+ "summary": "List the metadata components and properties of a specified type.",
1849
1849
  "enableJsonFlag": true,
1850
1850
  "isESM": true,
1851
1851
  "relativePath": [
1852
1852
  "lib",
1853
1853
  "commands",
1854
1854
  "org",
1855
- "resume",
1856
- "scratch.js"
1855
+ "list",
1856
+ "metadata.js"
1857
1857
  ],
1858
1858
  "aliasPermutations": [
1859
- "env:resume:scratch",
1860
- "resume:env:scratch",
1861
- "resume:scratch:env",
1862
- "env:scratch:resume",
1863
- "scratch:env:resume",
1864
- "scratch:resume:env"
1859
+ "force:mdapi:listmetadata",
1860
+ "mdapi:force:listmetadata",
1861
+ "mdapi:listmetadata:force",
1862
+ "force:listmetadata:mdapi",
1863
+ "listmetadata:force:mdapi",
1864
+ "listmetadata:mdapi:force"
1865
1865
  ],
1866
1866
  "permutations": [
1867
- "org:resume:scratch",
1868
- "resume:org:scratch",
1869
- "resume:scratch:org",
1870
- "org:scratch:resume",
1871
- "scratch:org:resume",
1872
- "scratch:resume:org"
1867
+ "org:list:metadata",
1868
+ "list:org:metadata",
1869
+ "list:metadata:org",
1870
+ "org:metadata:list",
1871
+ "metadata:org:list",
1872
+ "metadata:list:org"
1873
1873
  ]
1874
1874
  }
1875
1875
  },
1876
- "version": "5.8.1"
1876
+ "version": "5.8.3"
1877
1877
  }
package/package.json CHANGED
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "@salesforce/plugin-org",
3
3
  "description": "Commands to interact with Salesforce orgs",
4
- "version": "5.8.1",
4
+ "version": "5.8.3",
5
5
  "author": "Salesforce",
6
6
  "bugs": "https://github.com/forcedotcom/cli/issues",
7
7
  "dependencies": {
8
- "@oclif/core": "^4.3.0",
9
- "@oclif/multi-stage-output": "^0.8.13",
8
+ "@oclif/core": "^4.3.3",
9
+ "@oclif/multi-stage-output": "^0.8.14",
10
10
  "@salesforce/core": "^8.13.0",
11
11
  "@salesforce/kit": "^3.2.3",
12
12
  "@salesforce/sf-plugins-core": "^12.2.2",
@@ -22,7 +22,7 @@
22
22
  "@oclif/plugin-command-snapshot": "^5.3.1",
23
23
  "@salesforce/cli-plugins-testkit": "^5.3.39",
24
24
  "@salesforce/dev-scripts": "^11.0.2",
25
- "@salesforce/plugin-command-reference": "^3.1.54",
25
+ "@salesforce/plugin-command-reference": "^3.1.56",
26
26
  "@salesforce/ts-sinon": "^1.4.30",
27
27
  "eslint-plugin-sf-plugin": "^1.20.24",
28
28
  "moment": "^2.30.1",
@@ -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.1.crt",
232
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/5.8.1.sig"
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"
233
233
  }
234
234
  }