@salesforce/plugin-org 5.9.18 → 5.9.19
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.
- package/README.md +15 -15
- package/oclif.manifest.json +390 -390
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -247,7 +247,7 @@ FLAG DESCRIPTIONS
|
|
|
247
247
|
You can specify either --source-sandbox-name or --source-id when cloning an existing sandbox, but not both.
|
|
248
248
|
```
|
|
249
249
|
|
|
250
|
-
_See code: [src/commands/org/create/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.
|
|
250
|
+
_See code: [src/commands/org/create/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.19/src/commands/org/create/sandbox.ts)_
|
|
251
251
|
|
|
252
252
|
## `sf org create scratch`
|
|
253
253
|
|
|
@@ -429,7 +429,7 @@ FLAG DESCRIPTIONS
|
|
|
429
429
|
Omit this flag to have Salesforce generate a unique username for your org.
|
|
430
430
|
```
|
|
431
431
|
|
|
432
|
-
_See code: [src/commands/org/create/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.
|
|
432
|
+
_See code: [src/commands/org/create/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.19/src/commands/org/create/scratch.ts)_
|
|
433
433
|
|
|
434
434
|
## `sf org delete sandbox`
|
|
435
435
|
|
|
@@ -475,7 +475,7 @@ EXAMPLES
|
|
|
475
475
|
$ sf org delete sandbox --target-org my-sandbox --no-prompt
|
|
476
476
|
```
|
|
477
477
|
|
|
478
|
-
_See code: [src/commands/org/delete/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.
|
|
478
|
+
_See code: [src/commands/org/delete/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.19/src/commands/org/delete/sandbox.ts)_
|
|
479
479
|
|
|
480
480
|
## `sf org delete scratch`
|
|
481
481
|
|
|
@@ -519,7 +519,7 @@ EXAMPLES
|
|
|
519
519
|
$ sf org delete scratch --target-org my-scratch-org --no-prompt
|
|
520
520
|
```
|
|
521
521
|
|
|
522
|
-
_See code: [src/commands/org/delete/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.
|
|
522
|
+
_See code: [src/commands/org/delete/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.19/src/commands/org/delete/scratch.ts)_
|
|
523
523
|
|
|
524
524
|
## `sf org disable tracking`
|
|
525
525
|
|
|
@@ -558,7 +558,7 @@ EXAMPLES
|
|
|
558
558
|
$ sf org disable tracking
|
|
559
559
|
```
|
|
560
560
|
|
|
561
|
-
_See code: [src/commands/org/disable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.
|
|
561
|
+
_See code: [src/commands/org/disable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.19/src/commands/org/disable/tracking.ts)_
|
|
562
562
|
|
|
563
563
|
## `sf org display`
|
|
564
564
|
|
|
@@ -603,7 +603,7 @@ EXAMPLES
|
|
|
603
603
|
$ sf org display --target-org TestOrg1 --verbose
|
|
604
604
|
```
|
|
605
605
|
|
|
606
|
-
_See code: [src/commands/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.
|
|
606
|
+
_See code: [src/commands/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.19/src/commands/org/display.ts)_
|
|
607
607
|
|
|
608
608
|
## `sf org enable tracking`
|
|
609
609
|
|
|
@@ -645,7 +645,7 @@ EXAMPLES
|
|
|
645
645
|
$ sf org enable tracking
|
|
646
646
|
```
|
|
647
647
|
|
|
648
|
-
_See code: [src/commands/org/enable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.
|
|
648
|
+
_See code: [src/commands/org/enable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.19/src/commands/org/enable/tracking.ts)_
|
|
649
649
|
|
|
650
650
|
## `sf org list`
|
|
651
651
|
|
|
@@ -684,7 +684,7 @@ EXAMPLES
|
|
|
684
684
|
$ sf org list --clean
|
|
685
685
|
```
|
|
686
686
|
|
|
687
|
-
_See code: [src/commands/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.
|
|
687
|
+
_See code: [src/commands/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.19/src/commands/org/list.ts)_
|
|
688
688
|
|
|
689
689
|
## `sf org list metadata`
|
|
690
690
|
|
|
@@ -751,7 +751,7 @@ FLAG DESCRIPTIONS
|
|
|
751
751
|
Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.
|
|
752
752
|
```
|
|
753
753
|
|
|
754
|
-
_See code: [src/commands/org/list/metadata.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.
|
|
754
|
+
_See code: [src/commands/org/list/metadata.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.19/src/commands/org/list/metadata.ts)_
|
|
755
755
|
|
|
756
756
|
## `sf org list metadata-types`
|
|
757
757
|
|
|
@@ -806,7 +806,7 @@ FLAG DESCRIPTIONS
|
|
|
806
806
|
Override the api version used for api requests made by this command
|
|
807
807
|
```
|
|
808
808
|
|
|
809
|
-
_See code: [src/commands/org/list/metadata-types.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.
|
|
809
|
+
_See code: [src/commands/org/list/metadata-types.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.19/src/commands/org/list/metadata-types.ts)_
|
|
810
810
|
|
|
811
811
|
## `sf org open`
|
|
812
812
|
|
|
@@ -882,7 +882,7 @@ EXAMPLES
|
|
|
882
882
|
$ sf org open --source-file force-app/main/default/bots/Coral_Cloud_Agent/Coral_Cloud_Agent.bot-meta.xml
|
|
883
883
|
```
|
|
884
884
|
|
|
885
|
-
_See code: [src/commands/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.
|
|
885
|
+
_See code: [src/commands/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.19/src/commands/org/open.ts)_
|
|
886
886
|
|
|
887
887
|
## `sf org open agent`
|
|
888
888
|
|
|
@@ -933,7 +933,7 @@ EXAMPLES
|
|
|
933
933
|
$ sf org open agent --target-org MyTestOrg1 --browser firefox --api-name Coral_Cloud_Agent
|
|
934
934
|
```
|
|
935
935
|
|
|
936
|
-
_See code: [src/commands/org/open/agent.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.
|
|
936
|
+
_See code: [src/commands/org/open/agent.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.19/src/commands/org/open/agent.ts)_
|
|
937
937
|
|
|
938
938
|
## `sf org refresh sandbox`
|
|
939
939
|
|
|
@@ -1036,7 +1036,7 @@ FLAG DESCRIPTIONS
|
|
|
1036
1036
|
You can specify either --source-sandbox-name or --source-id when refreshing an existing sandbox, but not both.
|
|
1037
1037
|
```
|
|
1038
1038
|
|
|
1039
|
-
_See code: [src/commands/org/refresh/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.
|
|
1039
|
+
_See code: [src/commands/org/refresh/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.19/src/commands/org/refresh/sandbox.ts)_
|
|
1040
1040
|
|
|
1041
1041
|
## `sf org resume sandbox`
|
|
1042
1042
|
|
|
@@ -1099,7 +1099,7 @@ FLAG DESCRIPTIONS
|
|
|
1099
1099
|
returns the job ID. To resume checking the sandbox creation, rerun this command.
|
|
1100
1100
|
```
|
|
1101
1101
|
|
|
1102
|
-
_See code: [src/commands/org/resume/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.
|
|
1102
|
+
_See code: [src/commands/org/resume/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.19/src/commands/org/resume/sandbox.ts)_
|
|
1103
1103
|
|
|
1104
1104
|
## `sf org resume scratch`
|
|
1105
1105
|
|
|
@@ -1152,6 +1152,6 @@ FLAG DESCRIPTIONS
|
|
|
1152
1152
|
returns the job ID. To resume checking the scratch creation, rerun this command.
|
|
1153
1153
|
```
|
|
1154
1154
|
|
|
1155
|
-
_See code: [src/commands/org/resume/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.
|
|
1155
|
+
_See code: [src/commands/org/resume/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.9.19/src/commands/org/resume/scratch.ts)_
|
|
1156
1156
|
|
|
1157
1157
|
<!-- commandsstop -->
|
package/oclif.manifest.json
CHANGED
|
@@ -1145,16 +1145,15 @@
|
|
|
1145
1145
|
"tracking:enable:org"
|
|
1146
1146
|
]
|
|
1147
1147
|
},
|
|
1148
|
-
"org:
|
|
1149
|
-
"aliases": [
|
|
1150
|
-
"force:mdapi:describemetadata"
|
|
1151
|
-
],
|
|
1148
|
+
"org:refresh:sandbox": {
|
|
1149
|
+
"aliases": [],
|
|
1152
1150
|
"args": {},
|
|
1153
|
-
"
|
|
1154
|
-
"description": "The information includes Apex classes and triggers, custom objects, custom fields on standard objects, tab sets that define an app, and many other metadata types. Use this information to identify the syntax needed for a <name> element in a manifest file (package.xml).\n\nThe username that you use to connect to the org must have the Modify All Data or Modify Metadata Through Metadata API Functions permission.",
|
|
1151
|
+
"description": "Refreshing a sandbox copies the metadata, and optionally data, from your source org to the refreshed sandbox org. You can optionally specify a definition file if you want to change the configuration of the refreshed sandbox, such as its license type or template ID. You can also use the --source-id or --source-sandbox-name flags to change the refreshed sandbox org's original source org to a new org; in this case, the refreshed sandbox org's metadata is updated with the new source org's metadata.\n\nYou're not allowed to change the sandbox name when you refresh it with this command. If you want to change the sandbox name, first delete it with the \"org delete sandbox\" command. And then recreate it with the \"org create sandbox\" command and give it a new name.",
|
|
1155
1152
|
"examples": [
|
|
1156
|
-
"
|
|
1157
|
-
"
|
|
1153
|
+
"Refresh the sandbox named \"devSbx1\". The production org that contains the sandbox license has the alias \"prodOrg\".\n<%= config.bin %> <%= command.id %> --name devSbx1 --target-org prodOrg",
|
|
1154
|
+
"Refresh the sandbox named \"devSbx2\", and override the configuration of the refreshed sandbox with the properties in the specified defintion file. The default target org is the production org, so you don't need to specify the `--target-org` flag in this case.\n<%= config.bin %> <%= command.id %> --name devSbx2 --definition-file devSbx2-config.json",
|
|
1155
|
+
"Refresh the sandbox using the name defined in the definition file. The production org that contains the sandbox license has the alias \"prodOrg\".\n<%= config.bin %> <%= command.id %> --definition-file devSbx3-config.json --target-org prodOrg",
|
|
1156
|
+
"Refresh the sandbox named \"devSbx2\" by changing its original source org to be a sandbox called \"devSbx3\":\n<%= config.bin %> <%= command.id %> --name devSbx2 --source-sandbox-name devSbx3 --target-org prodOrg"
|
|
1158
1157
|
],
|
|
1159
1158
|
"flags": {
|
|
1160
1159
|
"json": {
|
|
@@ -1172,115 +1171,142 @@
|
|
|
1172
1171
|
"multiple": false,
|
|
1173
1172
|
"type": "option"
|
|
1174
1173
|
},
|
|
1175
|
-
"
|
|
1176
|
-
"
|
|
1177
|
-
|
|
1178
|
-
|
|
1174
|
+
"no-auto-activate": {
|
|
1175
|
+
"description": "By default, a sandbox auto-activates after a refresh. Use this flag to control sandbox activation manually.",
|
|
1176
|
+
"name": "no-auto-activate",
|
|
1177
|
+
"summary": "Disable auto-activation of the sandbox after a successful refresh.",
|
|
1178
|
+
"allowNo": false,
|
|
1179
|
+
"type": "boolean"
|
|
1180
|
+
},
|
|
1181
|
+
"wait": {
|
|
1182
|
+
"char": "w",
|
|
1183
|
+
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal to you and displays the \"<%= config.bin %> org resume sandbox\" command for you run to check the status of the refresh. The displayed command includes the job ID for the running sandbox refresh.",
|
|
1184
|
+
"exclusive": [
|
|
1185
|
+
"async"
|
|
1179
1186
|
],
|
|
1180
|
-
"
|
|
1181
|
-
"
|
|
1182
|
-
"
|
|
1183
|
-
"
|
|
1184
|
-
"hasDynamicHelp": false,
|
|
1187
|
+
"name": "wait",
|
|
1188
|
+
"summary": "Number of minutes to poll for sandbox refresh status.",
|
|
1189
|
+
"hasDynamicHelp": true,
|
|
1190
|
+
"helpValue": "<minutes>",
|
|
1185
1191
|
"multiple": false,
|
|
1186
1192
|
"type": "option"
|
|
1187
1193
|
},
|
|
1188
|
-
"
|
|
1189
|
-
"
|
|
1190
|
-
|
|
1191
|
-
|
|
1192
|
-
|
|
1193
|
-
"name": "
|
|
1194
|
+
"poll-interval": {
|
|
1195
|
+
"char": "i",
|
|
1196
|
+
"exclusive": [
|
|
1197
|
+
"async"
|
|
1198
|
+
],
|
|
1199
|
+
"name": "poll-interval",
|
|
1200
|
+
"summary": "Number of seconds to wait between status polling requests.",
|
|
1201
|
+
"hasDynamicHelp": true,
|
|
1202
|
+
"helpValue": "<seconds>",
|
|
1203
|
+
"multiple": false,
|
|
1204
|
+
"type": "option"
|
|
1205
|
+
},
|
|
1206
|
+
"source-sandbox-name": {
|
|
1207
|
+
"description": "The value of --source-sandbox-name must be an existing sandbox. The new source sandbox, and the refreshed sandbox specified with the --name flag, must both be associated with the production org (--target-org) that contains the sandbox licenses.\n\nYou can specify either --source-sandbox-name or --source-id when refreshing an existing sandbox, but not both.",
|
|
1208
|
+
"exclusive": [
|
|
1209
|
+
"source-id"
|
|
1210
|
+
],
|
|
1211
|
+
"name": "source-sandbox-name",
|
|
1212
|
+
"summary": "Name of the sandbox org that becomes the new source org for the refreshed sandbox.",
|
|
1194
1213
|
"hasDynamicHelp": false,
|
|
1195
1214
|
"multiple": false,
|
|
1196
1215
|
"type": "option"
|
|
1197
1216
|
},
|
|
1198
|
-
"
|
|
1199
|
-
"
|
|
1200
|
-
|
|
1201
|
-
"
|
|
1217
|
+
"source-id": {
|
|
1218
|
+
"description": "The value of --source-id must be an existing sandbox. The new source sandbox, and the refreshed sandbox specified with the --name flag, must both be associated with the production org (--target-org) that contains the sandbox licenses.\n\nYou can specify either --source-id or --source-sandbox-name when refreshing an existing sandbox, but not both.",
|
|
1219
|
+
"exclusive": [
|
|
1220
|
+
"source-sandbox-name"
|
|
1202
1221
|
],
|
|
1203
|
-
"
|
|
1204
|
-
"
|
|
1205
|
-
"
|
|
1206
|
-
"noCacheDefault": true,
|
|
1207
|
-
"required": true,
|
|
1208
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1209
|
-
"hasDynamicHelp": true,
|
|
1222
|
+
"name": "source-id",
|
|
1223
|
+
"summary": "ID of the sandbox org that becomes the new source org for the refreshed sandbox.",
|
|
1224
|
+
"hasDynamicHelp": false,
|
|
1210
1225
|
"multiple": false,
|
|
1211
1226
|
"type": "option"
|
|
1212
1227
|
},
|
|
1213
|
-
"
|
|
1214
|
-
"
|
|
1215
|
-
|
|
1228
|
+
"async": {
|
|
1229
|
+
"description": "The command immediately displays the job ID and returns control of the terminal to you. This way, you can continue to use the CLI. To check the status of the sandbox refresh, run \"<%= config.bin %> org resume sandbox\".",
|
|
1230
|
+
"exclusive": [
|
|
1231
|
+
"wait",
|
|
1232
|
+
"poll-interval"
|
|
1216
1233
|
],
|
|
1234
|
+
"name": "async",
|
|
1235
|
+
"summary": "Request the sandbox refresh, but don't wait for it to complete.",
|
|
1236
|
+
"allowNo": false,
|
|
1237
|
+
"type": "boolean"
|
|
1238
|
+
},
|
|
1239
|
+
"name": {
|
|
1240
|
+
"char": "n",
|
|
1241
|
+
"name": "name",
|
|
1242
|
+
"summary": "Name of the existing sandbox org in your production org that you want to refresh.",
|
|
1243
|
+
"hasDynamicHelp": false,
|
|
1244
|
+
"multiple": false,
|
|
1245
|
+
"type": "option"
|
|
1246
|
+
},
|
|
1247
|
+
"definition-file": {
|
|
1217
1248
|
"char": "f",
|
|
1218
|
-
"
|
|
1219
|
-
"
|
|
1220
|
-
"
|
|
1221
|
-
"summary": "Pathname of the file in which to write the results.",
|
|
1249
|
+
"description": "The sandbox definition file is a blueprint for the sandbox; use the file to change the sandbox configuration during a refresh. If you don't want to change the sandbox configuration when you refresh it, then simply use the --name flag to specify the sandbox and don't use this flag. See <https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_sandbox_definition.htm> for all the options you can specify in the definition file.",
|
|
1250
|
+
"name": "definition-file",
|
|
1251
|
+
"summary": "Path to a sandbox definition file for overriding its configuration when you refresh it.",
|
|
1222
1252
|
"hasDynamicHelp": false,
|
|
1223
1253
|
"multiple": false,
|
|
1224
1254
|
"type": "option"
|
|
1225
1255
|
},
|
|
1226
|
-
"
|
|
1227
|
-
"
|
|
1228
|
-
|
|
1229
|
-
|
|
1230
|
-
"
|
|
1231
|
-
"
|
|
1232
|
-
"
|
|
1233
|
-
"
|
|
1234
|
-
"
|
|
1256
|
+
"target-org": {
|
|
1257
|
+
"char": "o",
|
|
1258
|
+
"name": "target-org",
|
|
1259
|
+
"noCacheDefault": true,
|
|
1260
|
+
"required": true,
|
|
1261
|
+
"summary": "Username or alias of the production org that contains the sandbox license.",
|
|
1262
|
+
"hasDynamicHelp": true,
|
|
1263
|
+
"multiple": false,
|
|
1264
|
+
"type": "option"
|
|
1265
|
+
},
|
|
1266
|
+
"no-prompt": {
|
|
1267
|
+
"name": "no-prompt",
|
|
1268
|
+
"summary": "Don't prompt for confirmation about the sandbox refresh.",
|
|
1235
1269
|
"allowNo": false,
|
|
1236
1270
|
"type": "boolean"
|
|
1237
1271
|
}
|
|
1238
1272
|
},
|
|
1239
1273
|
"hasDynamicHelp": true,
|
|
1240
1274
|
"hiddenAliases": [],
|
|
1241
|
-
"id": "org:
|
|
1275
|
+
"id": "org:refresh:sandbox",
|
|
1242
1276
|
"pluginAlias": "@salesforce/plugin-org",
|
|
1243
1277
|
"pluginName": "@salesforce/plugin-org",
|
|
1244
1278
|
"pluginType": "core",
|
|
1245
1279
|
"strict": true,
|
|
1246
|
-
"summary": "
|
|
1247
|
-
"enableJsonFlag": true,
|
|
1280
|
+
"summary": "Refresh a sandbox org using the sandbox name.",
|
|
1248
1281
|
"isESM": true,
|
|
1249
1282
|
"relativePath": [
|
|
1250
1283
|
"lib",
|
|
1251
1284
|
"commands",
|
|
1252
1285
|
"org",
|
|
1253
|
-
"
|
|
1254
|
-
"
|
|
1255
|
-
],
|
|
1256
|
-
"aliasPermutations": [
|
|
1257
|
-
"force:mdapi:describemetadata",
|
|
1258
|
-
"mdapi:force:describemetadata",
|
|
1259
|
-
"mdapi:describemetadata:force",
|
|
1260
|
-
"force:describemetadata:mdapi",
|
|
1261
|
-
"describemetadata:force:mdapi",
|
|
1262
|
-
"describemetadata:mdapi:force"
|
|
1286
|
+
"refresh",
|
|
1287
|
+
"sandbox.js"
|
|
1263
1288
|
],
|
|
1289
|
+
"aliasPermutations": [],
|
|
1264
1290
|
"permutations": [
|
|
1265
|
-
"org:
|
|
1266
|
-
"
|
|
1267
|
-
"
|
|
1268
|
-
"org:
|
|
1269
|
-
"
|
|
1270
|
-
"
|
|
1291
|
+
"org:refresh:sandbox",
|
|
1292
|
+
"refresh:org:sandbox",
|
|
1293
|
+
"refresh:sandbox:org",
|
|
1294
|
+
"org:sandbox:refresh",
|
|
1295
|
+
"sandbox:org:refresh",
|
|
1296
|
+
"sandbox:refresh:org"
|
|
1271
1297
|
]
|
|
1272
1298
|
},
|
|
1273
|
-
"org:
|
|
1299
|
+
"org:resume:sandbox": {
|
|
1274
1300
|
"aliases": [
|
|
1275
|
-
"
|
|
1301
|
+
"env:resume:sandbox"
|
|
1276
1302
|
],
|
|
1277
1303
|
"args": {},
|
|
1278
1304
|
"deprecateAliases": true,
|
|
1279
|
-
"description": "
|
|
1305
|
+
"description": "Sandbox creation can take a long time. If the original \"<%= config.bin %> org create sandbox\" command either times out, or you specified the --async flag, the command displays a job ID. Use this job ID to check whether the sandbox creation is complete, and if it is, the command then logs into it.\n\nYou can also use the sandbox name to check the status or the --use-most-recent flag to use the job ID of the most recent sandbox creation.",
|
|
1280
1306
|
"examples": [
|
|
1281
|
-
"
|
|
1282
|
-
"
|
|
1283
|
-
"
|
|
1307
|
+
"Check the status of a sandbox creation using its name and specify a production org with alias \"prodOrg\":\n<%= config.bin %> <%= command.id %> --name mysandbox --target-org prodOrg",
|
|
1308
|
+
"Check the status using the job ID:\n<%= config.bin %> <%= command.id %> --job-id 0GRxxxxxxxx",
|
|
1309
|
+
"Check the status of the most recent sandbox create request:\n<%= config.bin %> <%= command.id %> --use-most-recent"
|
|
1284
1310
|
],
|
|
1285
1311
|
"flags": {
|
|
1286
1312
|
"json": {
|
|
@@ -1298,110 +1324,178 @@
|
|
|
1298
1324
|
"multiple": false,
|
|
1299
1325
|
"type": "option"
|
|
1300
1326
|
},
|
|
1301
|
-
"
|
|
1302
|
-
"
|
|
1303
|
-
|
|
1304
|
-
|
|
1327
|
+
"wait": {
|
|
1328
|
+
"char": "w",
|
|
1329
|
+
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To resume checking the sandbox creation, rerun this command.",
|
|
1330
|
+
"name": "wait",
|
|
1331
|
+
"summary": "Number of minutes to wait for the sandbox org to be ready.",
|
|
1332
|
+
"default": "0 minutes",
|
|
1333
|
+
"hasDynamicHelp": true,
|
|
1334
|
+
"helpValue": "<minutes>",
|
|
1335
|
+
"multiple": false,
|
|
1336
|
+
"type": "option"
|
|
1337
|
+
},
|
|
1338
|
+
"name": {
|
|
1339
|
+
"char": "n",
|
|
1340
|
+
"exclusive": [
|
|
1341
|
+
"job-id"
|
|
1305
1342
|
],
|
|
1306
|
-
"
|
|
1307
|
-
"
|
|
1308
|
-
"name": "api-version",
|
|
1309
|
-
"summary": "API version to use; default is the most recent API version.",
|
|
1343
|
+
"name": "name",
|
|
1344
|
+
"summary": "Name of the sandbox org.",
|
|
1310
1345
|
"hasDynamicHelp": false,
|
|
1311
1346
|
"multiple": false,
|
|
1312
1347
|
"type": "option"
|
|
1313
1348
|
},
|
|
1314
|
-
"
|
|
1315
|
-
"
|
|
1316
|
-
|
|
1317
|
-
|
|
1318
|
-
|
|
1319
|
-
|
|
1349
|
+
"job-id": {
|
|
1350
|
+
"char": "i",
|
|
1351
|
+
"description": "The job ID is valid for 24 hours after you start the sandbox creation.",
|
|
1352
|
+
"exclusive": [
|
|
1353
|
+
"name"
|
|
1354
|
+
],
|
|
1355
|
+
"name": "job-id",
|
|
1356
|
+
"summary": "Job ID of the incomplete sandbox creation that you want to check the status of.",
|
|
1320
1357
|
"hasDynamicHelp": false,
|
|
1321
1358
|
"multiple": false,
|
|
1322
1359
|
"type": "option"
|
|
1323
1360
|
},
|
|
1361
|
+
"use-most-recent": {
|
|
1362
|
+
"char": "l",
|
|
1363
|
+
"name": "use-most-recent",
|
|
1364
|
+
"summary": "Use the most recent sandbox create request.",
|
|
1365
|
+
"allowNo": false,
|
|
1366
|
+
"type": "boolean"
|
|
1367
|
+
},
|
|
1324
1368
|
"target-org": {
|
|
1325
|
-
"aliases": [
|
|
1326
|
-
"targetusername",
|
|
1327
|
-
"u"
|
|
1328
|
-
],
|
|
1329
1369
|
"char": "o",
|
|
1330
|
-
"
|
|
1370
|
+
"description": "When it creates the sandbox org, Salesforce copies the metadata, and optionally data, from your production org to the new sandbox org.",
|
|
1331
1371
|
"name": "target-org",
|
|
1332
1372
|
"noCacheDefault": true,
|
|
1333
|
-
"
|
|
1334
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1373
|
+
"summary": "Username or alias of the production org that contains the sandbox license.",
|
|
1335
1374
|
"hasDynamicHelp": true,
|
|
1336
1375
|
"multiple": false,
|
|
1337
1376
|
"type": "option"
|
|
1377
|
+
}
|
|
1378
|
+
},
|
|
1379
|
+
"hasDynamicHelp": true,
|
|
1380
|
+
"hiddenAliases": [],
|
|
1381
|
+
"id": "org:resume:sandbox",
|
|
1382
|
+
"pluginAlias": "@salesforce/plugin-org",
|
|
1383
|
+
"pluginName": "@salesforce/plugin-org",
|
|
1384
|
+
"pluginType": "core",
|
|
1385
|
+
"strict": true,
|
|
1386
|
+
"summary": "Check the status of a sandbox creation, and log in to it if it's ready.",
|
|
1387
|
+
"isESM": true,
|
|
1388
|
+
"relativePath": [
|
|
1389
|
+
"lib",
|
|
1390
|
+
"commands",
|
|
1391
|
+
"org",
|
|
1392
|
+
"resume",
|
|
1393
|
+
"sandbox.js"
|
|
1394
|
+
],
|
|
1395
|
+
"aliasPermutations": [
|
|
1396
|
+
"env:resume:sandbox",
|
|
1397
|
+
"resume:env:sandbox",
|
|
1398
|
+
"resume:sandbox:env",
|
|
1399
|
+
"env:sandbox:resume",
|
|
1400
|
+
"sandbox:env:resume",
|
|
1401
|
+
"sandbox:resume:env"
|
|
1402
|
+
],
|
|
1403
|
+
"permutations": [
|
|
1404
|
+
"org:resume:sandbox",
|
|
1405
|
+
"resume:org:sandbox",
|
|
1406
|
+
"resume:sandbox:org",
|
|
1407
|
+
"org:sandbox:resume",
|
|
1408
|
+
"sandbox:org:resume",
|
|
1409
|
+
"sandbox:resume:org"
|
|
1410
|
+
]
|
|
1411
|
+
},
|
|
1412
|
+
"org:resume:scratch": {
|
|
1413
|
+
"aliases": [
|
|
1414
|
+
"env:resume:scratch"
|
|
1415
|
+
],
|
|
1416
|
+
"args": {},
|
|
1417
|
+
"deprecateAliases": true,
|
|
1418
|
+
"description": "When the original \"<%= config.bin %> org create scratch\" command either times out or is run with the --async flag, it displays a job ID.\n\nRun this command by either passing it a job ID or using the --use-most-recent flag to specify the most recent incomplete scratch org.",
|
|
1419
|
+
"examples": [
|
|
1420
|
+
"Resume a scratch org create with a job ID:\n<%= config.bin %> <%= command.id %> --job-id 2SR3u0000008fBDGAY",
|
|
1421
|
+
"Resume your most recent incomplete scratch org:\n<%= config.bin %> <%= command.id %> --use-most-recent"
|
|
1422
|
+
],
|
|
1423
|
+
"flags": {
|
|
1424
|
+
"json": {
|
|
1425
|
+
"description": "Format output as json.",
|
|
1426
|
+
"helpGroup": "GLOBAL",
|
|
1427
|
+
"name": "json",
|
|
1428
|
+
"allowNo": false,
|
|
1429
|
+
"type": "boolean"
|
|
1338
1430
|
},
|
|
1339
|
-
"
|
|
1340
|
-
"
|
|
1341
|
-
|
|
1342
|
-
|
|
1343
|
-
"char": "f",
|
|
1344
|
-
"deprecateAliases": true,
|
|
1345
|
-
"name": "output-file",
|
|
1346
|
-
"summary": "Pathname of the file in which to write the results.",
|
|
1431
|
+
"flags-dir": {
|
|
1432
|
+
"helpGroup": "GLOBAL",
|
|
1433
|
+
"name": "flags-dir",
|
|
1434
|
+
"summary": "Import flag values from a directory.",
|
|
1347
1435
|
"hasDynamicHelp": false,
|
|
1348
1436
|
"multiple": false,
|
|
1349
1437
|
"type": "option"
|
|
1350
1438
|
},
|
|
1351
|
-
"
|
|
1352
|
-
"
|
|
1353
|
-
|
|
1354
|
-
|
|
1355
|
-
"
|
|
1356
|
-
"deprecateAliases": true,
|
|
1357
|
-
"name": "metadata-type",
|
|
1358
|
-
"required": true,
|
|
1359
|
-
"summary": "Metadata type to be retrieved, such as CustomObject; metadata type names are case-sensitive.",
|
|
1439
|
+
"job-id": {
|
|
1440
|
+
"char": "i",
|
|
1441
|
+
"description": "The job ID is the same as the record ID of the incomplete scratch org in the ScratchOrgInfo object of the Dev Hub.\n\nThe job ID is valid for 24 hours after you start the scratch org creation.",
|
|
1442
|
+
"name": "job-id",
|
|
1443
|
+
"summary": "Job ID of the incomplete scratch org create that you want to resume.",
|
|
1360
1444
|
"hasDynamicHelp": false,
|
|
1361
1445
|
"multiple": false,
|
|
1362
1446
|
"type": "option"
|
|
1363
1447
|
},
|
|
1364
|
-
"
|
|
1365
|
-
"
|
|
1366
|
-
"name": "
|
|
1367
|
-
"summary": "
|
|
1368
|
-
"
|
|
1448
|
+
"use-most-recent": {
|
|
1449
|
+
"char": "r",
|
|
1450
|
+
"name": "use-most-recent",
|
|
1451
|
+
"summary": "Use the job ID of the most recent incomplete scratch org.",
|
|
1452
|
+
"allowNo": false,
|
|
1453
|
+
"type": "boolean"
|
|
1454
|
+
},
|
|
1455
|
+
"wait": {
|
|
1456
|
+
"char": "w",
|
|
1457
|
+
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To resume checking the scratch creation, rerun this command.",
|
|
1458
|
+
"name": "wait",
|
|
1459
|
+
"summary": "Number of minutes to wait for the scratch org to be ready.",
|
|
1460
|
+
"default": "0 minutes",
|
|
1461
|
+
"hasDynamicHelp": true,
|
|
1462
|
+
"helpValue": "<minutes>",
|
|
1369
1463
|
"multiple": false,
|
|
1370
1464
|
"type": "option"
|
|
1371
1465
|
}
|
|
1372
1466
|
},
|
|
1373
1467
|
"hasDynamicHelp": true,
|
|
1374
1468
|
"hiddenAliases": [],
|
|
1375
|
-
"id": "org:
|
|
1469
|
+
"id": "org:resume:scratch",
|
|
1376
1470
|
"pluginAlias": "@salesforce/plugin-org",
|
|
1377
1471
|
"pluginName": "@salesforce/plugin-org",
|
|
1378
1472
|
"pluginType": "core",
|
|
1379
1473
|
"strict": true,
|
|
1380
|
-
"summary": "
|
|
1474
|
+
"summary": "Resume the creation of an incomplete scratch org.",
|
|
1381
1475
|
"enableJsonFlag": true,
|
|
1382
1476
|
"isESM": true,
|
|
1383
1477
|
"relativePath": [
|
|
1384
1478
|
"lib",
|
|
1385
1479
|
"commands",
|
|
1386
1480
|
"org",
|
|
1387
|
-
"
|
|
1388
|
-
"
|
|
1481
|
+
"resume",
|
|
1482
|
+
"scratch.js"
|
|
1389
1483
|
],
|
|
1390
1484
|
"aliasPermutations": [
|
|
1391
|
-
"
|
|
1392
|
-
"
|
|
1393
|
-
"
|
|
1394
|
-
"
|
|
1395
|
-
"
|
|
1396
|
-
"
|
|
1485
|
+
"env:resume:scratch",
|
|
1486
|
+
"resume:env:scratch",
|
|
1487
|
+
"resume:scratch:env",
|
|
1488
|
+
"env:scratch:resume",
|
|
1489
|
+
"scratch:env:resume",
|
|
1490
|
+
"scratch:resume:env"
|
|
1397
1491
|
],
|
|
1398
1492
|
"permutations": [
|
|
1399
|
-
"org:
|
|
1400
|
-
"
|
|
1401
|
-
"
|
|
1402
|
-
"org:
|
|
1403
|
-
"
|
|
1404
|
-
"
|
|
1493
|
+
"org:resume:scratch",
|
|
1494
|
+
"resume:org:scratch",
|
|
1495
|
+
"resume:scratch:org",
|
|
1496
|
+
"org:scratch:resume",
|
|
1497
|
+
"scratch:org:resume",
|
|
1498
|
+
"scratch:resume:org"
|
|
1405
1499
|
]
|
|
1406
1500
|
},
|
|
1407
1501
|
"org:open:agent": {
|
|
@@ -1510,179 +1604,27 @@
|
|
|
1510
1604
|
"org",
|
|
1511
1605
|
"open",
|
|
1512
1606
|
"agent.js"
|
|
1513
|
-
],
|
|
1514
|
-
"aliasPermutations": [],
|
|
1515
|
-
"permutations": [
|
|
1516
|
-
"org:open:agent",
|
|
1517
|
-
"open:org:agent",
|
|
1518
|
-
"open:agent:org",
|
|
1519
|
-
"org:agent:open",
|
|
1520
|
-
"agent:org:open",
|
|
1521
|
-
"agent:open:org"
|
|
1522
|
-
]
|
|
1523
|
-
},
|
|
1524
|
-
"org:refresh:sandbox": {
|
|
1525
|
-
"aliases": [],
|
|
1526
|
-
"args": {},
|
|
1527
|
-
"description": "Refreshing a sandbox copies the metadata, and optionally data, from your source org to the refreshed sandbox org. You can optionally specify a definition file if you want to change the configuration of the refreshed sandbox, such as its license type or template ID. You can also use the --source-id or --source-sandbox-name flags to change the refreshed sandbox org's original source org to a new org; in this case, the refreshed sandbox org's metadata is updated with the new source org's metadata.\n\nYou're not allowed to change the sandbox name when you refresh it with this command. If you want to change the sandbox name, first delete it with the \"org delete sandbox\" command. And then recreate it with the \"org create sandbox\" command and give it a new name.",
|
|
1528
|
-
"examples": [
|
|
1529
|
-
"Refresh the sandbox named \"devSbx1\". The production org that contains the sandbox license has the alias \"prodOrg\".\n<%= config.bin %> <%= command.id %> --name devSbx1 --target-org prodOrg",
|
|
1530
|
-
"Refresh the sandbox named \"devSbx2\", and override the configuration of the refreshed sandbox with the properties in the specified defintion file. The default target org is the production org, so you don't need to specify the `--target-org` flag in this case.\n<%= config.bin %> <%= command.id %> --name devSbx2 --definition-file devSbx2-config.json",
|
|
1531
|
-
"Refresh the sandbox using the name defined in the definition file. The production org that contains the sandbox license has the alias \"prodOrg\".\n<%= config.bin %> <%= command.id %> --definition-file devSbx3-config.json --target-org prodOrg",
|
|
1532
|
-
"Refresh the sandbox named \"devSbx2\" by changing its original source org to be a sandbox called \"devSbx3\":\n<%= config.bin %> <%= command.id %> --name devSbx2 --source-sandbox-name devSbx3 --target-org prodOrg"
|
|
1533
|
-
],
|
|
1534
|
-
"flags": {
|
|
1535
|
-
"json": {
|
|
1536
|
-
"description": "Format output as json.",
|
|
1537
|
-
"helpGroup": "GLOBAL",
|
|
1538
|
-
"name": "json",
|
|
1539
|
-
"allowNo": false,
|
|
1540
|
-
"type": "boolean"
|
|
1541
|
-
},
|
|
1542
|
-
"flags-dir": {
|
|
1543
|
-
"helpGroup": "GLOBAL",
|
|
1544
|
-
"name": "flags-dir",
|
|
1545
|
-
"summary": "Import flag values from a directory.",
|
|
1546
|
-
"hasDynamicHelp": false,
|
|
1547
|
-
"multiple": false,
|
|
1548
|
-
"type": "option"
|
|
1549
|
-
},
|
|
1550
|
-
"no-auto-activate": {
|
|
1551
|
-
"description": "By default, a sandbox auto-activates after a refresh. Use this flag to control sandbox activation manually.",
|
|
1552
|
-
"name": "no-auto-activate",
|
|
1553
|
-
"summary": "Disable auto-activation of the sandbox after a successful refresh.",
|
|
1554
|
-
"allowNo": false,
|
|
1555
|
-
"type": "boolean"
|
|
1556
|
-
},
|
|
1557
|
-
"wait": {
|
|
1558
|
-
"char": "w",
|
|
1559
|
-
"description": "If the command continues to run after the wait period, the CLI returns control of the terminal to you and displays the \"<%= config.bin %> org resume sandbox\" command for you run to check the status of the refresh. The displayed command includes the job ID for the running sandbox refresh.",
|
|
1560
|
-
"exclusive": [
|
|
1561
|
-
"async"
|
|
1562
|
-
],
|
|
1563
|
-
"name": "wait",
|
|
1564
|
-
"summary": "Number of minutes to poll for sandbox refresh status.",
|
|
1565
|
-
"hasDynamicHelp": true,
|
|
1566
|
-
"helpValue": "<minutes>",
|
|
1567
|
-
"multiple": false,
|
|
1568
|
-
"type": "option"
|
|
1569
|
-
},
|
|
1570
|
-
"poll-interval": {
|
|
1571
|
-
"char": "i",
|
|
1572
|
-
"exclusive": [
|
|
1573
|
-
"async"
|
|
1574
|
-
],
|
|
1575
|
-
"name": "poll-interval",
|
|
1576
|
-
"summary": "Number of seconds to wait between status polling requests.",
|
|
1577
|
-
"hasDynamicHelp": true,
|
|
1578
|
-
"helpValue": "<seconds>",
|
|
1579
|
-
"multiple": false,
|
|
1580
|
-
"type": "option"
|
|
1581
|
-
},
|
|
1582
|
-
"source-sandbox-name": {
|
|
1583
|
-
"description": "The value of --source-sandbox-name must be an existing sandbox. The new source sandbox, and the refreshed sandbox specified with the --name flag, must both be associated with the production org (--target-org) that contains the sandbox licenses.\n\nYou can specify either --source-sandbox-name or --source-id when refreshing an existing sandbox, but not both.",
|
|
1584
|
-
"exclusive": [
|
|
1585
|
-
"source-id"
|
|
1586
|
-
],
|
|
1587
|
-
"name": "source-sandbox-name",
|
|
1588
|
-
"summary": "Name of the sandbox org that becomes the new source org for the refreshed sandbox.",
|
|
1589
|
-
"hasDynamicHelp": false,
|
|
1590
|
-
"multiple": false,
|
|
1591
|
-
"type": "option"
|
|
1592
|
-
},
|
|
1593
|
-
"source-id": {
|
|
1594
|
-
"description": "The value of --source-id must be an existing sandbox. The new source sandbox, and the refreshed sandbox specified with the --name flag, must both be associated with the production org (--target-org) that contains the sandbox licenses.\n\nYou can specify either --source-id or --source-sandbox-name when refreshing an existing sandbox, but not both.",
|
|
1595
|
-
"exclusive": [
|
|
1596
|
-
"source-sandbox-name"
|
|
1597
|
-
],
|
|
1598
|
-
"name": "source-id",
|
|
1599
|
-
"summary": "ID of the sandbox org that becomes the new source org for the refreshed sandbox.",
|
|
1600
|
-
"hasDynamicHelp": false,
|
|
1601
|
-
"multiple": false,
|
|
1602
|
-
"type": "option"
|
|
1603
|
-
},
|
|
1604
|
-
"async": {
|
|
1605
|
-
"description": "The command immediately displays the job ID and returns control of the terminal to you. This way, you can continue to use the CLI. To check the status of the sandbox refresh, run \"<%= config.bin %> org resume sandbox\".",
|
|
1606
|
-
"exclusive": [
|
|
1607
|
-
"wait",
|
|
1608
|
-
"poll-interval"
|
|
1609
|
-
],
|
|
1610
|
-
"name": "async",
|
|
1611
|
-
"summary": "Request the sandbox refresh, but don't wait for it to complete.",
|
|
1612
|
-
"allowNo": false,
|
|
1613
|
-
"type": "boolean"
|
|
1614
|
-
},
|
|
1615
|
-
"name": {
|
|
1616
|
-
"char": "n",
|
|
1617
|
-
"name": "name",
|
|
1618
|
-
"summary": "Name of the existing sandbox org in your production org that you want to refresh.",
|
|
1619
|
-
"hasDynamicHelp": false,
|
|
1620
|
-
"multiple": false,
|
|
1621
|
-
"type": "option"
|
|
1622
|
-
},
|
|
1623
|
-
"definition-file": {
|
|
1624
|
-
"char": "f",
|
|
1625
|
-
"description": "The sandbox definition file is a blueprint for the sandbox; use the file to change the sandbox configuration during a refresh. If you don't want to change the sandbox configuration when you refresh it, then simply use the --name flag to specify the sandbox and don't use this flag. See <https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_sandbox_definition.htm> for all the options you can specify in the definition file.",
|
|
1626
|
-
"name": "definition-file",
|
|
1627
|
-
"summary": "Path to a sandbox definition file for overriding its configuration when you refresh it.",
|
|
1628
|
-
"hasDynamicHelp": false,
|
|
1629
|
-
"multiple": false,
|
|
1630
|
-
"type": "option"
|
|
1631
|
-
},
|
|
1632
|
-
"target-org": {
|
|
1633
|
-
"char": "o",
|
|
1634
|
-
"name": "target-org",
|
|
1635
|
-
"noCacheDefault": true,
|
|
1636
|
-
"required": true,
|
|
1637
|
-
"summary": "Username or alias of the production org that contains the sandbox license.",
|
|
1638
|
-
"hasDynamicHelp": true,
|
|
1639
|
-
"multiple": false,
|
|
1640
|
-
"type": "option"
|
|
1641
|
-
},
|
|
1642
|
-
"no-prompt": {
|
|
1643
|
-
"name": "no-prompt",
|
|
1644
|
-
"summary": "Don't prompt for confirmation about the sandbox refresh.",
|
|
1645
|
-
"allowNo": false,
|
|
1646
|
-
"type": "boolean"
|
|
1647
|
-
}
|
|
1648
|
-
},
|
|
1649
|
-
"hasDynamicHelp": true,
|
|
1650
|
-
"hiddenAliases": [],
|
|
1651
|
-
"id": "org:refresh:sandbox",
|
|
1652
|
-
"pluginAlias": "@salesforce/plugin-org",
|
|
1653
|
-
"pluginName": "@salesforce/plugin-org",
|
|
1654
|
-
"pluginType": "core",
|
|
1655
|
-
"strict": true,
|
|
1656
|
-
"summary": "Refresh a sandbox org using the sandbox name.",
|
|
1657
|
-
"isESM": true,
|
|
1658
|
-
"relativePath": [
|
|
1659
|
-
"lib",
|
|
1660
|
-
"commands",
|
|
1661
|
-
"org",
|
|
1662
|
-
"refresh",
|
|
1663
|
-
"sandbox.js"
|
|
1664
|
-
],
|
|
1665
|
-
"aliasPermutations": [],
|
|
1666
|
-
"permutations": [
|
|
1667
|
-
"org:refresh:sandbox",
|
|
1668
|
-
"refresh:org:sandbox",
|
|
1669
|
-
"refresh:sandbox:org",
|
|
1670
|
-
"org:sandbox:refresh",
|
|
1671
|
-
"sandbox:org:refresh",
|
|
1672
|
-
"sandbox:refresh:org"
|
|
1607
|
+
],
|
|
1608
|
+
"aliasPermutations": [],
|
|
1609
|
+
"permutations": [
|
|
1610
|
+
"org:open:agent",
|
|
1611
|
+
"open:org:agent",
|
|
1612
|
+
"open:agent:org",
|
|
1613
|
+
"org:agent:open",
|
|
1614
|
+
"agent:org:open",
|
|
1615
|
+
"agent:open:org"
|
|
1673
1616
|
]
|
|
1674
1617
|
},
|
|
1675
|
-
"org:
|
|
1618
|
+
"org:list:metadata-types": {
|
|
1676
1619
|
"aliases": [
|
|
1677
|
-
"
|
|
1620
|
+
"force:mdapi:describemetadata"
|
|
1678
1621
|
],
|
|
1679
1622
|
"args": {},
|
|
1680
1623
|
"deprecateAliases": true,
|
|
1681
|
-
"description": "
|
|
1624
|
+
"description": "The information includes Apex classes and triggers, custom objects, custom fields on standard objects, tab sets that define an app, and many other metadata types. Use this information to identify the syntax needed for a <name> element in a manifest file (package.xml).\n\nThe username that you use to connect to the org must have the Modify All Data or Modify Metadata Through Metadata API Functions permission.",
|
|
1682
1625
|
"examples": [
|
|
1683
|
-
"
|
|
1684
|
-
"
|
|
1685
|
-
"Check the status of the most recent sandbox create request:\n<%= config.bin %> <%= command.id %> --use-most-recent"
|
|
1626
|
+
"Display information about all known and enabled metadata types in the org with alias \"my-dev-org\" using API version 57.0:\n$ <%= config.bin %> <%= command.id %> --api-version 57.0 --target-org my-dev-org",
|
|
1627
|
+
"Display only the metadata types that aren't yet supported by Salesforce CLI in your default org and write the results to the specified file:\n$ <%= config.bin %> <%= command.id %> --output-file /path/to/outputfilename.txt --filter-known"
|
|
1686
1628
|
],
|
|
1687
1629
|
"flags": {
|
|
1688
1630
|
"json": {
|
|
@@ -1700,101 +1642,115 @@
|
|
|
1700
1642
|
"multiple": false,
|
|
1701
1643
|
"type": "option"
|
|
1702
1644
|
},
|
|
1703
|
-
"
|
|
1704
|
-
"
|
|
1705
|
-
|
|
1706
|
-
|
|
1707
|
-
"summary": "Number of minutes to wait for the sandbox org to be ready.",
|
|
1708
|
-
"default": "0 minutes",
|
|
1709
|
-
"hasDynamicHelp": true,
|
|
1710
|
-
"helpValue": "<minutes>",
|
|
1711
|
-
"multiple": false,
|
|
1712
|
-
"type": "option"
|
|
1713
|
-
},
|
|
1714
|
-
"name": {
|
|
1715
|
-
"char": "n",
|
|
1716
|
-
"exclusive": [
|
|
1717
|
-
"job-id"
|
|
1645
|
+
"api-version": {
|
|
1646
|
+
"aliases": [
|
|
1647
|
+
"apiversion",
|
|
1648
|
+
"a"
|
|
1718
1649
|
],
|
|
1719
|
-
"
|
|
1720
|
-
"
|
|
1650
|
+
"deprecateAliases": true,
|
|
1651
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1652
|
+
"name": "api-version",
|
|
1653
|
+
"summary": "API version to use; default is the most recent API version.",
|
|
1721
1654
|
"hasDynamicHelp": false,
|
|
1722
1655
|
"multiple": false,
|
|
1723
1656
|
"type": "option"
|
|
1724
1657
|
},
|
|
1725
|
-
"
|
|
1726
|
-
"
|
|
1727
|
-
|
|
1728
|
-
|
|
1729
|
-
|
|
1730
|
-
|
|
1731
|
-
"name": "job-id",
|
|
1732
|
-
"summary": "Job ID of the incomplete sandbox creation that you want to check the status of.",
|
|
1658
|
+
"loglevel": {
|
|
1659
|
+
"deprecated": {
|
|
1660
|
+
"message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
|
|
1661
|
+
},
|
|
1662
|
+
"hidden": true,
|
|
1663
|
+
"name": "loglevel",
|
|
1733
1664
|
"hasDynamicHelp": false,
|
|
1734
1665
|
"multiple": false,
|
|
1735
1666
|
"type": "option"
|
|
1736
1667
|
},
|
|
1737
|
-
"use-most-recent": {
|
|
1738
|
-
"char": "l",
|
|
1739
|
-
"name": "use-most-recent",
|
|
1740
|
-
"summary": "Use the most recent sandbox create request.",
|
|
1741
|
-
"allowNo": false,
|
|
1742
|
-
"type": "boolean"
|
|
1743
|
-
},
|
|
1744
1668
|
"target-org": {
|
|
1669
|
+
"aliases": [
|
|
1670
|
+
"targetusername",
|
|
1671
|
+
"u"
|
|
1672
|
+
],
|
|
1745
1673
|
"char": "o",
|
|
1746
|
-
"
|
|
1674
|
+
"deprecateAliases": true,
|
|
1747
1675
|
"name": "target-org",
|
|
1748
1676
|
"noCacheDefault": true,
|
|
1749
|
-
"
|
|
1677
|
+
"required": true,
|
|
1678
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1750
1679
|
"hasDynamicHelp": true,
|
|
1751
1680
|
"multiple": false,
|
|
1752
1681
|
"type": "option"
|
|
1682
|
+
},
|
|
1683
|
+
"output-file": {
|
|
1684
|
+
"aliases": [
|
|
1685
|
+
"resultfile"
|
|
1686
|
+
],
|
|
1687
|
+
"char": "f",
|
|
1688
|
+
"deprecateAliases": true,
|
|
1689
|
+
"description": "Directing the output to a file makes it easier to extract relevant information for your package.xml manifest file. The default output destination is the terminal or command window console.",
|
|
1690
|
+
"name": "output-file",
|
|
1691
|
+
"summary": "Pathname of the file in which to write the results.",
|
|
1692
|
+
"hasDynamicHelp": false,
|
|
1693
|
+
"multiple": false,
|
|
1694
|
+
"type": "option"
|
|
1695
|
+
},
|
|
1696
|
+
"filter-known": {
|
|
1697
|
+
"aliases": [
|
|
1698
|
+
"filterknown"
|
|
1699
|
+
],
|
|
1700
|
+
"char": "k",
|
|
1701
|
+
"deprecateAliases": true,
|
|
1702
|
+
"hidden": true,
|
|
1703
|
+
"name": "filter-known",
|
|
1704
|
+
"summary": "Filter the known metadata types from the result to display only the types not yet fully supported by Salesforce CLI.\n\nfilter metadata known by the CLI",
|
|
1705
|
+
"allowNo": false,
|
|
1706
|
+
"type": "boolean"
|
|
1753
1707
|
}
|
|
1754
1708
|
},
|
|
1755
1709
|
"hasDynamicHelp": true,
|
|
1756
1710
|
"hiddenAliases": [],
|
|
1757
|
-
"id": "org:
|
|
1711
|
+
"id": "org:list:metadata-types",
|
|
1758
1712
|
"pluginAlias": "@salesforce/plugin-org",
|
|
1759
1713
|
"pluginName": "@salesforce/plugin-org",
|
|
1760
1714
|
"pluginType": "core",
|
|
1761
1715
|
"strict": true,
|
|
1762
|
-
"summary": "
|
|
1716
|
+
"summary": "Display details about the metadata types that are enabled for your org.",
|
|
1717
|
+
"enableJsonFlag": true,
|
|
1763
1718
|
"isESM": true,
|
|
1764
1719
|
"relativePath": [
|
|
1765
1720
|
"lib",
|
|
1766
1721
|
"commands",
|
|
1767
1722
|
"org",
|
|
1768
|
-
"
|
|
1769
|
-
"
|
|
1723
|
+
"list",
|
|
1724
|
+
"metadata-types.js"
|
|
1770
1725
|
],
|
|
1771
1726
|
"aliasPermutations": [
|
|
1772
|
-
"
|
|
1773
|
-
"
|
|
1774
|
-
"
|
|
1775
|
-
"
|
|
1776
|
-
"
|
|
1777
|
-
"
|
|
1727
|
+
"force:mdapi:describemetadata",
|
|
1728
|
+
"mdapi:force:describemetadata",
|
|
1729
|
+
"mdapi:describemetadata:force",
|
|
1730
|
+
"force:describemetadata:mdapi",
|
|
1731
|
+
"describemetadata:force:mdapi",
|
|
1732
|
+
"describemetadata:mdapi:force"
|
|
1778
1733
|
],
|
|
1779
1734
|
"permutations": [
|
|
1780
|
-
"org:
|
|
1781
|
-
"
|
|
1782
|
-
"
|
|
1783
|
-
"org:
|
|
1784
|
-
"
|
|
1785
|
-
"
|
|
1735
|
+
"org:list:metadata-types",
|
|
1736
|
+
"list:org:metadata-types",
|
|
1737
|
+
"list:metadata-types:org",
|
|
1738
|
+
"org:metadata-types:list",
|
|
1739
|
+
"metadata-types:org:list",
|
|
1740
|
+
"metadata-types:list:org"
|
|
1786
1741
|
]
|
|
1787
1742
|
},
|
|
1788
|
-
"org:
|
|
1743
|
+
"org:list:metadata": {
|
|
1789
1744
|
"aliases": [
|
|
1790
|
-
"
|
|
1745
|
+
"force:mdapi:listmetadata"
|
|
1791
1746
|
],
|
|
1792
1747
|
"args": {},
|
|
1793
1748
|
"deprecateAliases": true,
|
|
1794
|
-
"description": "
|
|
1749
|
+
"description": "Use this command to identify individual components in your manifest file or if you want a high-level view of particular metadata types in your org. For example, you can use this command to return a list of names of all the CustomObject or Layout components in your org, then use this information in a retrieve command that returns a subset of these components.\n\nThe username that you use to connect to the org must have the Modify All Data or Modify Metadata Through Metadata API Functions permission.",
|
|
1795
1750
|
"examples": [
|
|
1796
|
-
"
|
|
1797
|
-
"
|
|
1751
|
+
"List the CustomObject components, and their properties, in the org with alias \"my-dev-org\":\n$ <%= config.bin %> <%= command.id %> --metadata-type CustomObject --target-org my-dev-org",
|
|
1752
|
+
"List the CustomObject components in your default org, write the output to the specified file, and use API version 57.0:\n$ <%= config.bin %> <%= command.id %> --metadata-type CustomObject --api-version 57.0 --output-file /path/to/outputfilename.txt",
|
|
1753
|
+
"List the Dashboard components in your default org that are contained in the \"folderSales\" folder, write the output to the specified file, and use API version 57.0:\n$ <%= config.bin %> <%= command.id %> --metadata-type Dashboard --folder folderSales --api-version 57.0 --output-file /path/to/outputfilename.txt"
|
|
1798
1754
|
],
|
|
1799
1755
|
"flags": {
|
|
1800
1756
|
"json": {
|
|
@@ -1812,68 +1768,112 @@
|
|
|
1812
1768
|
"multiple": false,
|
|
1813
1769
|
"type": "option"
|
|
1814
1770
|
},
|
|
1815
|
-
"
|
|
1816
|
-
"
|
|
1817
|
-
|
|
1818
|
-
|
|
1819
|
-
|
|
1771
|
+
"api-version": {
|
|
1772
|
+
"aliases": [
|
|
1773
|
+
"apiversion",
|
|
1774
|
+
"a"
|
|
1775
|
+
],
|
|
1776
|
+
"deprecateAliases": true,
|
|
1777
|
+
"description": "Override the api version used for api requests made by this command",
|
|
1778
|
+
"name": "api-version",
|
|
1779
|
+
"summary": "API version to use; default is the most recent API version.",
|
|
1820
1780
|
"hasDynamicHelp": false,
|
|
1821
1781
|
"multiple": false,
|
|
1822
1782
|
"type": "option"
|
|
1823
1783
|
},
|
|
1824
|
-
"
|
|
1825
|
-
"
|
|
1826
|
-
|
|
1827
|
-
|
|
1828
|
-
"
|
|
1829
|
-
"
|
|
1784
|
+
"loglevel": {
|
|
1785
|
+
"deprecated": {
|
|
1786
|
+
"message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
|
|
1787
|
+
},
|
|
1788
|
+
"hidden": true,
|
|
1789
|
+
"name": "loglevel",
|
|
1790
|
+
"hasDynamicHelp": false,
|
|
1791
|
+
"multiple": false,
|
|
1792
|
+
"type": "option"
|
|
1830
1793
|
},
|
|
1831
|
-
"
|
|
1832
|
-
"
|
|
1833
|
-
|
|
1834
|
-
|
|
1835
|
-
|
|
1836
|
-
"
|
|
1794
|
+
"target-org": {
|
|
1795
|
+
"aliases": [
|
|
1796
|
+
"targetusername",
|
|
1797
|
+
"u"
|
|
1798
|
+
],
|
|
1799
|
+
"char": "o",
|
|
1800
|
+
"deprecateAliases": true,
|
|
1801
|
+
"name": "target-org",
|
|
1802
|
+
"noCacheDefault": true,
|
|
1803
|
+
"required": true,
|
|
1804
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
1837
1805
|
"hasDynamicHelp": true,
|
|
1838
|
-
"
|
|
1806
|
+
"multiple": false,
|
|
1807
|
+
"type": "option"
|
|
1808
|
+
},
|
|
1809
|
+
"output-file": {
|
|
1810
|
+
"aliases": [
|
|
1811
|
+
"resultfile"
|
|
1812
|
+
],
|
|
1813
|
+
"char": "f",
|
|
1814
|
+
"deprecateAliases": true,
|
|
1815
|
+
"name": "output-file",
|
|
1816
|
+
"summary": "Pathname of the file in which to write the results.",
|
|
1817
|
+
"hasDynamicHelp": false,
|
|
1818
|
+
"multiple": false,
|
|
1819
|
+
"type": "option"
|
|
1820
|
+
},
|
|
1821
|
+
"metadata-type": {
|
|
1822
|
+
"aliases": [
|
|
1823
|
+
"metadatatype"
|
|
1824
|
+
],
|
|
1825
|
+
"char": "m",
|
|
1826
|
+
"deprecateAliases": true,
|
|
1827
|
+
"name": "metadata-type",
|
|
1828
|
+
"required": true,
|
|
1829
|
+
"summary": "Metadata type to be retrieved, such as CustomObject; metadata type names are case-sensitive.",
|
|
1830
|
+
"hasDynamicHelp": false,
|
|
1831
|
+
"multiple": false,
|
|
1832
|
+
"type": "option"
|
|
1833
|
+
},
|
|
1834
|
+
"folder": {
|
|
1835
|
+
"description": "Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.",
|
|
1836
|
+
"name": "folder",
|
|
1837
|
+
"summary": "Folder associated with the component; required for components that use folders; folder names are case-sensitive.",
|
|
1838
|
+
"hasDynamicHelp": false,
|
|
1839
1839
|
"multiple": false,
|
|
1840
1840
|
"type": "option"
|
|
1841
1841
|
}
|
|
1842
1842
|
},
|
|
1843
1843
|
"hasDynamicHelp": true,
|
|
1844
1844
|
"hiddenAliases": [],
|
|
1845
|
-
"id": "org:
|
|
1845
|
+
"id": "org:list:metadata",
|
|
1846
1846
|
"pluginAlias": "@salesforce/plugin-org",
|
|
1847
1847
|
"pluginName": "@salesforce/plugin-org",
|
|
1848
1848
|
"pluginType": "core",
|
|
1849
1849
|
"strict": true,
|
|
1850
|
-
"summary": "
|
|
1850
|
+
"summary": "List the metadata components and properties of a specified type.",
|
|
1851
1851
|
"enableJsonFlag": true,
|
|
1852
1852
|
"isESM": true,
|
|
1853
1853
|
"relativePath": [
|
|
1854
1854
|
"lib",
|
|
1855
1855
|
"commands",
|
|
1856
1856
|
"org",
|
|
1857
|
-
"
|
|
1858
|
-
"
|
|
1857
|
+
"list",
|
|
1858
|
+
"metadata.js"
|
|
1859
1859
|
],
|
|
1860
1860
|
"aliasPermutations": [
|
|
1861
|
-
"
|
|
1862
|
-
"
|
|
1863
|
-
"
|
|
1864
|
-
"
|
|
1865
|
-
"
|
|
1866
|
-
"
|
|
1861
|
+
"force:mdapi:listmetadata",
|
|
1862
|
+
"mdapi:force:listmetadata",
|
|
1863
|
+
"mdapi:listmetadata:force",
|
|
1864
|
+
"force:listmetadata:mdapi",
|
|
1865
|
+
"listmetadata:force:mdapi",
|
|
1866
|
+
"listmetadata:mdapi:force"
|
|
1867
1867
|
],
|
|
1868
1868
|
"permutations": [
|
|
1869
|
-
"org:
|
|
1870
|
-
"
|
|
1871
|
-
"
|
|
1872
|
-
"org:
|
|
1873
|
-
"
|
|
1874
|
-
"
|
|
1869
|
+
"org:list:metadata",
|
|
1870
|
+
"list:org:metadata",
|
|
1871
|
+
"list:metadata:org",
|
|
1872
|
+
"org:metadata:list",
|
|
1873
|
+
"metadata:org:list",
|
|
1874
|
+
"metadata:list:org"
|
|
1875
1875
|
]
|
|
1876
1876
|
}
|
|
1877
1877
|
},
|
|
1878
|
-
"version": "5.9.
|
|
1878
|
+
"version": "5.9.19"
|
|
1879
1879
|
}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@salesforce/plugin-org",
|
|
3
3
|
"description": "Commands to interact with Salesforce orgs",
|
|
4
|
-
"version": "5.9.
|
|
4
|
+
"version": "5.9.19",
|
|
5
5
|
"author": "Salesforce",
|
|
6
6
|
"bugs": "https://github.com/forcedotcom/cli/issues",
|
|
7
7
|
"dependencies": {
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
"@salesforce/core": "^8.18.7",
|
|
11
11
|
"@salesforce/kit": "^3.2.3",
|
|
12
12
|
"@salesforce/sf-plugins-core": "^12.2.3",
|
|
13
|
-
"@salesforce/source-deploy-retrieve": "^12.
|
|
13
|
+
"@salesforce/source-deploy-retrieve": "^12.22.2",
|
|
14
14
|
"@salesforce/ts-types": "^2.0.12",
|
|
15
15
|
"ansis": "^3.16.0",
|
|
16
16
|
"change-case": "^5.4.4",
|
|
@@ -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.9.
|
|
232
|
-
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/5.9.
|
|
231
|
+
"publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/5.9.19.crt",
|
|
232
|
+
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/5.9.19.sig"
|
|
233
233
|
}
|
|
234
234
|
}
|