@salesforce/cli 2.135.0 → 2.135.2
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 +438 -106
- package/npm-shrinkwrap.json +85 -69
- package/oclif.lock +77 -71
- package/oclif.manifest.json +1 -1
- package/package.json +13 -13
package/README.md
CHANGED
|
@@ -25,7 +25,7 @@ $ npm install -g @salesforce/cli
|
|
|
25
25
|
$ sf COMMAND
|
|
26
26
|
running command...
|
|
27
27
|
$ sf (--version|-v)
|
|
28
|
-
@salesforce/cli/2.135.
|
|
28
|
+
@salesforce/cli/2.135.2 linux-x64 node-v22.22.2
|
|
29
29
|
$ sf --help [COMMAND]
|
|
30
30
|
USAGE
|
|
31
31
|
$ sf COMMAND
|
|
@@ -60,6 +60,10 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI.
|
|
|
60
60
|
- [`sf agent test results`](#sf-agent-test-results)
|
|
61
61
|
- [`sf agent test resume`](#sf-agent-test-resume)
|
|
62
62
|
- [`sf agent test run`](#sf-agent-test-run)
|
|
63
|
+
- [`sf agent test run-eval`](#sf-agent-test-run-eval)
|
|
64
|
+
- [`sf agent trace delete`](#sf-agent-trace-delete)
|
|
65
|
+
- [`sf agent trace list`](#sf-agent-trace-list)
|
|
66
|
+
- [`sf agent trace read`](#sf-agent-trace-read)
|
|
63
67
|
- [`sf agent validate authoring-bundle`](#sf-agent-validate-authoring-bundle)
|
|
64
68
|
- [`sf alias list`](#sf-alias-list)
|
|
65
69
|
- [`sf alias set`](#sf-alias-set)
|
|
@@ -277,7 +281,7 @@ ERROR CODES
|
|
|
277
281
|
ActivationFailed (4) Failed to activate the agent due to API or network errors.
|
|
278
282
|
```
|
|
279
283
|
|
|
280
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
284
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.38.0/src/commands/agent/activate.ts)_
|
|
281
285
|
|
|
282
286
|
## `sf agent create`
|
|
283
287
|
|
|
@@ -344,7 +348,7 @@ EXAMPLES
|
|
|
344
348
|
$ sf agent create --name "Resort Manager" --spec specs/resortManagerAgent.yaml --preview
|
|
345
349
|
```
|
|
346
350
|
|
|
347
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
351
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.38.0/src/commands/agent/create.ts)_
|
|
348
352
|
|
|
349
353
|
## `sf agent deactivate`
|
|
350
354
|
|
|
@@ -393,7 +397,7 @@ ERROR CODES
|
|
|
393
397
|
DeactivationFailed (4) Failed to deactivate the agent due to API or network errors.
|
|
394
398
|
```
|
|
395
399
|
|
|
396
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
400
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.38.0/src/commands/agent/deactivate.ts)_
|
|
397
401
|
|
|
398
402
|
## `sf agent generate agent-spec`
|
|
399
403
|
|
|
@@ -500,7 +504,7 @@ EXAMPLES
|
|
|
500
504
|
$ sf agent generate agent-spec --tone formal --agent-user resortmanager@myorg.com
|
|
501
505
|
```
|
|
502
506
|
|
|
503
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
507
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.38.0/src/commands/agent/generate/agent-spec.ts)_
|
|
504
508
|
|
|
505
509
|
## `sf agent generate authoring-bundle`
|
|
506
510
|
|
|
@@ -577,7 +581,7 @@ EXAMPLES
|
|
|
577
581
|
other-package-dir/main/default --target-org my-dev-org
|
|
578
582
|
```
|
|
579
583
|
|
|
580
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
584
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.38.0/src/commands/agent/generate/authoring-bundle.ts)_
|
|
581
585
|
|
|
582
586
|
## `sf agent generate template`
|
|
583
587
|
|
|
@@ -639,7 +643,7 @@ EXAMPLES
|
|
|
639
643
|
my-package --source-org my-scratch-org
|
|
640
644
|
```
|
|
641
645
|
|
|
642
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
646
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.38.0/src/commands/agent/generate/template.ts)_
|
|
643
647
|
|
|
644
648
|
## `sf agent generate test-spec`
|
|
645
649
|
|
|
@@ -704,7 +708,7 @@ EXAMPLES
|
|
|
704
708
|
force-app//main/default/aiEvaluationDefinitions/Resort_Manager_Tests.aiEvaluationDefinition-meta.xml
|
|
705
709
|
```
|
|
706
710
|
|
|
707
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
711
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.38.0/src/commands/agent/generate/test-spec.ts)_
|
|
708
712
|
|
|
709
713
|
## `sf agent preview`
|
|
710
714
|
|
|
@@ -777,7 +781,7 @@ EXAMPLES
|
|
|
777
781
|
$ sf agent preview --use-live-actions --apex-debug --output-dir transcripts/my-preview
|
|
778
782
|
```
|
|
779
783
|
|
|
780
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
784
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.38.0/src/commands/agent/preview.ts)_
|
|
781
785
|
|
|
782
786
|
## `sf agent preview end`
|
|
783
787
|
|
|
@@ -841,7 +845,7 @@ ERROR CODES
|
|
|
841
845
|
SessionAmbiguous (5) Multiple preview sessions found; specify --session-id to choose one.
|
|
842
846
|
```
|
|
843
847
|
|
|
844
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
848
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.38.0/src/commands/agent/preview/end.ts)_
|
|
845
849
|
|
|
846
850
|
## `sf agent preview send`
|
|
847
851
|
|
|
@@ -908,7 +912,7 @@ ERROR CODES
|
|
|
908
912
|
SessionAmbiguous (5) Multiple preview sessions found; specify --session-id to choose one.
|
|
909
913
|
```
|
|
910
914
|
|
|
911
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
915
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.38.0/src/commands/agent/preview/send.ts)_
|
|
912
916
|
|
|
913
917
|
## `sf agent preview sessions`
|
|
914
918
|
|
|
@@ -944,7 +948,7 @@ ERROR CODES
|
|
|
944
948
|
Succeeded (0) Sessions listed successfully (or empty list if no active sessions).
|
|
945
949
|
```
|
|
946
950
|
|
|
947
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
951
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.38.0/src/commands/agent/preview/sessions.ts)_
|
|
948
952
|
|
|
949
953
|
## `sf agent preview start`
|
|
950
954
|
|
|
@@ -1020,7 +1024,7 @@ ERROR CODES
|
|
|
1020
1024
|
PreviewStartFailed (4) Preview session failed to start due to API or network errors.
|
|
1021
1025
|
```
|
|
1022
1026
|
|
|
1023
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1027
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.38.0/src/commands/agent/preview/start.ts)_
|
|
1024
1028
|
|
|
1025
1029
|
## `sf agent publish authoring-bundle`
|
|
1026
1030
|
|
|
@@ -1029,14 +1033,17 @@ Publish an authoring bundle to your org, which results in a new agent or a new v
|
|
|
1029
1033
|
```
|
|
1030
1034
|
USAGE
|
|
1031
1035
|
$ sf agent publish authoring-bundle -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-n <value>]
|
|
1032
|
-
[--skip-retrieve]
|
|
1036
|
+
[--skip-retrieve] [-v | --concise]
|
|
1033
1037
|
|
|
1034
1038
|
FLAGS
|
|
1035
1039
|
-n, --api-name=<value> API name of the authoring bundle you want to publish; if not specified, the command
|
|
1036
1040
|
provides a list that you can choose from.
|
|
1037
1041
|
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
1038
1042
|
configuration variable is already set.
|
|
1043
|
+
-v, --verbose Display detailed output showing all metadata components retrieved and deployed during the
|
|
1044
|
+
publish process.
|
|
1039
1045
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1046
|
+
--concise Display minimal output with only essential information about the publish operation.
|
|
1040
1047
|
--skip-retrieve Don't retrieve the metadata associated with the agent to your DX project.
|
|
1041
1048
|
|
|
1042
1049
|
GLOBAL FLAGS
|
|
@@ -1068,12 +1075,20 @@ EXAMPLES
|
|
|
1068
1075
|
|
|
1069
1076
|
$ sf agent publish authoring-bundle --api-name MyAuthoringbundle --target-org my-dev-org
|
|
1070
1077
|
|
|
1078
|
+
Publish with verbose output to see all retrieved and deployed metadata components:
|
|
1079
|
+
|
|
1080
|
+
$ sf agent publish authoring-bundle --api-name MyAuthoringbundle --verbose
|
|
1081
|
+
|
|
1082
|
+
Publish with concise output showing only essential information:
|
|
1083
|
+
|
|
1084
|
+
$ sf agent publish authoring-bundle --api-name MyAuthoringbundle --concise
|
|
1085
|
+
|
|
1071
1086
|
ERROR CODES
|
|
1072
1087
|
Succeeded (0) Agent published successfully without errors.
|
|
1073
1088
|
Failed (1) Compilation errors found in the Agent Script file.
|
|
1074
1089
|
```
|
|
1075
1090
|
|
|
1076
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1091
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.38.0/src/commands/agent/publish/authoring-bundle.ts)_
|
|
1077
1092
|
|
|
1078
1093
|
## `sf agent test create`
|
|
1079
1094
|
|
|
@@ -1137,7 +1152,7 @@ ERROR CODES
|
|
|
1137
1152
|
DeploymentFailed (4) Deployment failed due to API or network errors.
|
|
1138
1153
|
```
|
|
1139
1154
|
|
|
1140
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1155
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.38.0/src/commands/agent/test/create.ts)_
|
|
1141
1156
|
|
|
1142
1157
|
## `sf agent test list`
|
|
1143
1158
|
|
|
@@ -1159,8 +1174,8 @@ GLOBAL FLAGS
|
|
|
1159
1174
|
DESCRIPTION
|
|
1160
1175
|
List the available agent tests in your org.
|
|
1161
1176
|
|
|
1162
|
-
The command outputs a table with the name (API name) of each test along with its unique ID
|
|
1163
|
-
in the org.
|
|
1177
|
+
The command outputs a table with the name (API name) of each test along with its unique ID, type ('agentforce-studio'
|
|
1178
|
+
or 'testing-center'), and the date it was created in the org.
|
|
1164
1179
|
|
|
1165
1180
|
EXAMPLES
|
|
1166
1181
|
List the agent tests in your default org:
|
|
@@ -1179,7 +1194,7 @@ ERROR CODES
|
|
|
1179
1194
|
Failed (4) Failed to retrieve agent tests due to API or network errors.
|
|
1180
1195
|
```
|
|
1181
1196
|
|
|
1182
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1197
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.38.0/src/commands/agent/test/list.ts)_
|
|
1183
1198
|
|
|
1184
1199
|
## `sf agent test results`
|
|
1185
1200
|
|
|
@@ -1188,7 +1203,7 @@ Get the results of a completed agent test run.
|
|
|
1188
1203
|
```
|
|
1189
1204
|
USAGE
|
|
1190
1205
|
$ sf agent test results -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>] [--result-format
|
|
1191
|
-
json|human|junit|tap] [-d <value>] [--verbose]
|
|
1206
|
+
json|human|junit|tap] [-d <value>] [--test-runner agentforce-studio|testing-center] [--verbose]
|
|
1192
1207
|
|
|
1193
1208
|
FLAGS
|
|
1194
1209
|
-d, --output-dir=<value> Directory to write the agent test results into.
|
|
@@ -1198,6 +1213,8 @@ FLAGS
|
|
|
1198
1213
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1199
1214
|
--result-format=<option> [default: human] Format of the agent test run results.
|
|
1200
1215
|
<options: json|human|junit|tap>
|
|
1216
|
+
--test-runner=<option> Explicitly specify which test runner to use (agentforce-studio or testing-center).
|
|
1217
|
+
<options: agentforce-studio|testing-center>
|
|
1201
1218
|
--verbose Show generated data in the test results output.
|
|
1202
1219
|
|
|
1203
1220
|
GLOBAL FLAGS
|
|
@@ -1235,6 +1252,14 @@ FLAG DESCRIPTIONS
|
|
|
1235
1252
|
If the agent test run completes, write the results to the specified directory. If the test is still running, the
|
|
1236
1253
|
test results aren't written.
|
|
1237
1254
|
|
|
1255
|
+
--test-runner=agentforce-studio|testing-center
|
|
1256
|
+
|
|
1257
|
+
Explicitly specify which test runner to use (agentforce-studio or testing-center).
|
|
1258
|
+
|
|
1259
|
+
By default, the command automatically detects which test runner to use based on the test definition metadata type in
|
|
1260
|
+
your org. Use this flag to explicitly specify the runner type. 'agentforce-studio' uses AiTestingDefinition
|
|
1261
|
+
metadata. 'testing-center' uses AiEvaluationDefinition metadata.
|
|
1262
|
+
|
|
1238
1263
|
--verbose Show generated data in the test results output.
|
|
1239
1264
|
|
|
1240
1265
|
When enabled, includes detailed generated data (such as invoked actions) in the human-readable test results output.
|
|
@@ -1253,7 +1278,7 @@ ERROR CODES
|
|
|
1253
1278
|
Failed (4) Failed to retrieve results due to API or network errors.
|
|
1254
1279
|
```
|
|
1255
1280
|
|
|
1256
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1281
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.38.0/src/commands/agent/test/results.ts)_
|
|
1257
1282
|
|
|
1258
1283
|
## `sf agent test resume`
|
|
1259
1284
|
|
|
@@ -1262,7 +1287,8 @@ Resume an agent test that you previously started in your org so you can view the
|
|
|
1262
1287
|
```
|
|
1263
1288
|
USAGE
|
|
1264
1289
|
$ sf agent test resume -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-i <value>] [-r] [-w
|
|
1265
|
-
<value>] [--result-format json|human|junit|tap] [-d <value>] [--
|
|
1290
|
+
<value>] [--result-format json|human|junit|tap] [-d <value>] [--test-runner agentforce-studio|testing-center]
|
|
1291
|
+
[--verbose]
|
|
1266
1292
|
|
|
1267
1293
|
FLAGS
|
|
1268
1294
|
-d, --output-dir=<value> Directory to write the agent test results into.
|
|
@@ -1275,6 +1301,8 @@ FLAGS
|
|
|
1275
1301
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1276
1302
|
--result-format=<option> [default: human] Format of the agent test run results.
|
|
1277
1303
|
<options: json|human|junit|tap>
|
|
1304
|
+
--test-runner=<option> Explicitly specify which test runner to use (agentforce-studio or testing-center).
|
|
1305
|
+
<options: agentforce-studio|testing-center>
|
|
1278
1306
|
--verbose Show generated data in the test results output.
|
|
1279
1307
|
|
|
1280
1308
|
GLOBAL FLAGS
|
|
@@ -1316,6 +1344,14 @@ FLAG DESCRIPTIONS
|
|
|
1316
1344
|
If the agent test run completes, write the results to the specified directory. If the test is still running, the
|
|
1317
1345
|
test results aren't written.
|
|
1318
1346
|
|
|
1347
|
+
--test-runner=agentforce-studio|testing-center
|
|
1348
|
+
|
|
1349
|
+
Explicitly specify which test runner to use (agentforce-studio or testing-center).
|
|
1350
|
+
|
|
1351
|
+
By default, the command automatically detects which test runner to use based on the test definition metadata type in
|
|
1352
|
+
your org. Use this flag to explicitly specify the runner type. 'agentforce-studio' uses AiTestingDefinition
|
|
1353
|
+
metadata. 'testing-center' uses AiEvaluationDefinition metadata.
|
|
1354
|
+
|
|
1319
1355
|
--verbose Show generated data in the test results output.
|
|
1320
1356
|
|
|
1321
1357
|
When enabled, includes detailed generated data (such as invoked actions) in the human-readable test results output.
|
|
@@ -1335,7 +1371,7 @@ ERROR CODES
|
|
|
1335
1371
|
OperationFailed (4) Failed to poll test due to API or network errors.
|
|
1336
1372
|
```
|
|
1337
1373
|
|
|
1338
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1374
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.38.0/src/commands/agent/test/resume.ts)_
|
|
1339
1375
|
|
|
1340
1376
|
## `sf agent test run`
|
|
1341
1377
|
|
|
@@ -1344,7 +1380,7 @@ Start an agent test in your org.
|
|
|
1344
1380
|
```
|
|
1345
1381
|
USAGE
|
|
1346
1382
|
$ sf agent test run -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-n <value>] [-w <value>]
|
|
1347
|
-
[--result-format json|human|junit|tap] [-d <value>] [--verbose]
|
|
1383
|
+
[--result-format json|human|junit|tap] [-d <value>] [--test-runner agentforce-studio|testing-center] [--verbose]
|
|
1348
1384
|
|
|
1349
1385
|
FLAGS
|
|
1350
1386
|
-d, --output-dir=<value> Directory to write the agent test results into.
|
|
@@ -1357,6 +1393,8 @@ FLAGS
|
|
|
1357
1393
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1358
1394
|
--result-format=<option> [default: human] Format of the agent test run results.
|
|
1359
1395
|
<options: json|human|junit|tap>
|
|
1396
|
+
--test-runner=<option> Explicitly specify which test runner to use (agentforce-studio or testing-center).
|
|
1397
|
+
<options: agentforce-studio|testing-center>
|
|
1360
1398
|
--verbose Show generated data in the test results output.
|
|
1361
1399
|
|
|
1362
1400
|
GLOBAL FLAGS
|
|
@@ -1399,6 +1437,14 @@ FLAG DESCRIPTIONS
|
|
|
1399
1437
|
If the agent test run completes, write the results to the specified directory. If the test is still running, the
|
|
1400
1438
|
test results aren't written.
|
|
1401
1439
|
|
|
1440
|
+
--test-runner=agentforce-studio|testing-center
|
|
1441
|
+
|
|
1442
|
+
Explicitly specify which test runner to use (agentforce-studio or testing-center).
|
|
1443
|
+
|
|
1444
|
+
By default, the command automatically detects which test runner to use based on the test definition metadata type in
|
|
1445
|
+
your org. Use this flag to explicitly specify the runner type. 'agentforce-studio' uses AiTestingDefinition
|
|
1446
|
+
metadata. 'testing-center' uses AiEvaluationDefinition metadata.
|
|
1447
|
+
|
|
1402
1448
|
--verbose Show generated data in the test results output.
|
|
1403
1449
|
|
|
1404
1450
|
When enabled, includes detailed generated data (such as invoked actions) in the human-readable test results output.
|
|
@@ -1418,7 +1464,293 @@ ERROR CODES
|
|
|
1418
1464
|
OperationFailed (4) Failed to start or poll test due to API or network errors.
|
|
1419
1465
|
```
|
|
1420
1466
|
|
|
1421
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1467
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.38.0/src/commands/agent/test/run.ts)_
|
|
1468
|
+
|
|
1469
|
+
## `sf agent test run-eval`
|
|
1470
|
+
|
|
1471
|
+
Run evaluation tests against an Agentforce agent.
|
|
1472
|
+
|
|
1473
|
+
```
|
|
1474
|
+
USAGE
|
|
1475
|
+
$ sf agent test run-eval -o <value> -s <value> [--json] [--flags-dir <value>] [--api-version <value>] [-n <value>]
|
|
1476
|
+
[--result-format json|human|junit|tap] [--batch-size <value>] [--no-normalize]
|
|
1477
|
+
|
|
1478
|
+
FLAGS
|
|
1479
|
+
-n, --api-name=<value> Agent DeveloperName (also called API name) to resolve agent_id and agent_version_id.
|
|
1480
|
+
Auto-inferred from the YAML spec's subjectName.
|
|
1481
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
1482
|
+
configuration variable is already set.
|
|
1483
|
+
-s, --spec=<value> (required) Path to test spec file (YAML or JSON). Supports reading from stdin when
|
|
1484
|
+
piping content.
|
|
1485
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
1486
|
+
--batch-size=<value> [default: 5] Number of tests per API request (max 5).
|
|
1487
|
+
--no-normalize Disable auto-normalization of field names and shorthand references.
|
|
1488
|
+
--result-format=<option> [default: human] Format of the agent test run results.
|
|
1489
|
+
<options: json|human|junit|tap>
|
|
1490
|
+
|
|
1491
|
+
GLOBAL FLAGS
|
|
1492
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1493
|
+
--json Format output as json.
|
|
1494
|
+
|
|
1495
|
+
DESCRIPTION
|
|
1496
|
+
Run evaluation tests against an Agentforce agent.
|
|
1497
|
+
|
|
1498
|
+
Execute rich evaluation tests against an Agentforce agent using the Einstein Evaluation API. Supports both YAML test
|
|
1499
|
+
specs (same format as `sf agent generate test-spec`) and JSON payloads.
|
|
1500
|
+
|
|
1501
|
+
When you provide a YAML test spec, the command automatically translates test cases into Evaluation API calls and
|
|
1502
|
+
infers the agent name from the spec's `subjectName` field. This means you can use the same test spec with both `sf
|
|
1503
|
+
agent test run` and `sf agent test run-eval`. YAML test specs also support contextVariables, which allow you to inject
|
|
1504
|
+
contextual data (such as CaseId or RoutableId) into agent sessions for testing with different contexts.
|
|
1505
|
+
|
|
1506
|
+
When you provide a JSON payload, it's sent directly to the API with optional normalization. The normalizer
|
|
1507
|
+
auto-corrects common field name mistakes, converts shorthand references to JSONPath, and injects defaults. Use
|
|
1508
|
+
`--no-normalize` to disable this auto-normalization. JSON payloads can also include context_variables on
|
|
1509
|
+
agent.create_session steps for the same contextual testing capabilities.
|
|
1510
|
+
|
|
1511
|
+
Supports 8+ evaluator types, including topic routing assertions, action invocation checks, string/numeric assertions,
|
|
1512
|
+
semantic similarity scoring, and LLM-based quality ratings.
|
|
1513
|
+
|
|
1514
|
+
EXAMPLES
|
|
1515
|
+
Run tests using a YAML test spec on the org with alias "my-org":
|
|
1516
|
+
|
|
1517
|
+
$ sf agent test run-eval --spec tests/my-agent-testSpec.yaml --target-org my-org
|
|
1518
|
+
|
|
1519
|
+
Run tests using a YAML spec with explicit agent name override; use your default org:
|
|
1520
|
+
|
|
1521
|
+
$ sf agent test run-eval --spec tests/my-agent-testSpec.yaml --api-name My_Agent --target-org my-org
|
|
1522
|
+
|
|
1523
|
+
Run tests using a JSON payload:
|
|
1524
|
+
|
|
1525
|
+
$ sf agent test run-eval --spec tests/eval-payload.json --target-org my-org
|
|
1526
|
+
|
|
1527
|
+
Run tests and output results in JUnit format; useful for continuous integration and deployment (CI/CD):
|
|
1528
|
+
|
|
1529
|
+
$ sf agent test run-eval --spec tests/my-agent-testSpec.yaml --target-org my-org --result-format junit
|
|
1530
|
+
|
|
1531
|
+
Run tests with contextVariables to inject contextual data into agent sessions (add contextVariables to test cases in
|
|
1532
|
+
your YAML spec):
|
|
1533
|
+
|
|
1534
|
+
$ sf agent test run-eval --spec tests/agent-with-context.yaml --target-org my-org
|
|
1535
|
+
|
|
1536
|
+
Pipe JSON payload from stdin (--spec flag is automatically populated from stdin):
|
|
1537
|
+
$ echo '{"tests":[...]}' | sf agent test run-eval --spec --target-org my-org
|
|
1538
|
+
|
|
1539
|
+
ENVIRONMENT VARIABLES
|
|
1540
|
+
SF_TARGET_ORG Username or alias of your default org. Overrides the target-org configuration variable.
|
|
1541
|
+
|
|
1542
|
+
ERROR CODES
|
|
1543
|
+
Succeeded (0) Tests completed successfully. Test results (passed/failed) are in the JSON output.
|
|
1544
|
+
Failed (1) Tests encountered execution errors (tests couldn't run properly).
|
|
1545
|
+
NotFound (2) Agent not found, spec file not found, or invalid agent name.
|
|
1546
|
+
OperationFailed (4) Failed to execute tests due to API or network errors.
|
|
1547
|
+
```
|
|
1548
|
+
|
|
1549
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.38.0/src/commands/agent/test/run-eval.ts)_
|
|
1550
|
+
|
|
1551
|
+
## `sf agent trace delete`
|
|
1552
|
+
|
|
1553
|
+
Delete agent preview trace files.
|
|
1554
|
+
|
|
1555
|
+
```
|
|
1556
|
+
USAGE
|
|
1557
|
+
$ sf agent trace delete [--json] [--flags-dir <value>] [-a <value>] [--session-id <value>] [--older-than <value>]
|
|
1558
|
+
[--no-prompt]
|
|
1559
|
+
|
|
1560
|
+
FLAGS
|
|
1561
|
+
-a, --agent=<value> Only delete traces for this agent name (substring match). Matches against the name used when
|
|
1562
|
+
starting the session, whether that's an authoring bundle or a published agent API name.
|
|
1563
|
+
--no-prompt Skip the confirmation prompt and delete immediately.
|
|
1564
|
+
--older-than=<value> Only delete traces older than this duration. Accepts a number followed by a unit: m/minutes,
|
|
1565
|
+
h/hours, d/days, w/weeks (e.g. 7d, 24h, 2w).
|
|
1566
|
+
--session-id=<value> Only delete traces from this session ID.
|
|
1567
|
+
|
|
1568
|
+
GLOBAL FLAGS
|
|
1569
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1570
|
+
--json Format output as json.
|
|
1571
|
+
|
|
1572
|
+
DESCRIPTION
|
|
1573
|
+
Delete agent preview trace files.
|
|
1574
|
+
|
|
1575
|
+
Deletes trace files recorded during agent preview sessions. By default, shows a preview of what will be deleted and
|
|
1576
|
+
prompts for confirmation. Use --no-prompt to skip confirmation.
|
|
1577
|
+
|
|
1578
|
+
Without filters, deletes all traces for all agents and sessions. Use flags to narrow the scope: filter by agent name
|
|
1579
|
+
(--agent), by session (--session-id), or by age (--older-than).
|
|
1580
|
+
|
|
1581
|
+
EXAMPLES
|
|
1582
|
+
Delete all traces for all agents and sessions (with confirmation prompt):
|
|
1583
|
+
|
|
1584
|
+
$ sf agent trace delete
|
|
1585
|
+
|
|
1586
|
+
Delete all traces for a specific agent:
|
|
1587
|
+
|
|
1588
|
+
$ sf agent trace delete --agent My_Agent
|
|
1589
|
+
|
|
1590
|
+
Delete traces from a specific session:
|
|
1591
|
+
|
|
1592
|
+
$ sf agent trace delete --session-id <SESSION_ID>
|
|
1593
|
+
|
|
1594
|
+
Delete traces older than 7 days:
|
|
1595
|
+
|
|
1596
|
+
$ sf agent trace delete --older-than 7d
|
|
1597
|
+
|
|
1598
|
+
Delete traces older than 24 hours for a specific agent, no prompt:
|
|
1599
|
+
|
|
1600
|
+
$ sf agent trace delete --agent My_Agent --older-than 24h --no-prompt
|
|
1601
|
+
|
|
1602
|
+
Delete all traces without confirmation:
|
|
1603
|
+
|
|
1604
|
+
$ sf agent trace delete --no-prompt
|
|
1605
|
+
|
|
1606
|
+
ERROR CODES
|
|
1607
|
+
Succeeded (0) Traces deleted successfully (or no traces matched).
|
|
1608
|
+
```
|
|
1609
|
+
|
|
1610
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.38.0/src/commands/agent/trace/delete.ts)_
|
|
1611
|
+
|
|
1612
|
+
## `sf agent trace list`
|
|
1613
|
+
|
|
1614
|
+
List the trace files that were recorded during all agent preview sessions.
|
|
1615
|
+
|
|
1616
|
+
```
|
|
1617
|
+
USAGE
|
|
1618
|
+
$ sf agent trace list [--json] [--flags-dir <value>] [--session-id <value>] [-a <value>] [--since <value>]
|
|
1619
|
+
|
|
1620
|
+
FLAGS
|
|
1621
|
+
-a, --agent=<value> Only show traces for this agent name (substring match). Matches against the name used when
|
|
1622
|
+
starting the session, whether that's an authoring bundle or a published agent API name.
|
|
1623
|
+
--session-id=<value> Session ID used to filter the list of trace files.
|
|
1624
|
+
--since=<value> Date used to filter the list of trace files; only those recorded on or after the date are
|
|
1625
|
+
listed.
|
|
1626
|
+
|
|
1627
|
+
GLOBAL FLAGS
|
|
1628
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1629
|
+
--json Format output as json.
|
|
1630
|
+
|
|
1631
|
+
DESCRIPTION
|
|
1632
|
+
List the trace files that were recorded during all agent preview sessions.
|
|
1633
|
+
|
|
1634
|
+
Lists trace files recorded during agent preview sessions. By default, lists all traces for all agents and all of their
|
|
1635
|
+
sessions. Use flags to narrow results: filter by agent name (--agent), by session (--session-id), or by date
|
|
1636
|
+
(--since).
|
|
1637
|
+
|
|
1638
|
+
Each row in the output corresponds to one trace file, which in turn corresponds to one agent session. The Agent column
|
|
1639
|
+
shows the authoring bundle or API name used when starting the session.
|
|
1640
|
+
|
|
1641
|
+
EXAMPLES
|
|
1642
|
+
List all traces for all agents and sessions:
|
|
1643
|
+
|
|
1644
|
+
$ sf agent trace list
|
|
1645
|
+
|
|
1646
|
+
List all traces for a specific agent:
|
|
1647
|
+
|
|
1648
|
+
$ sf agent trace list --agent My_Agent
|
|
1649
|
+
|
|
1650
|
+
List traces for a specific session:
|
|
1651
|
+
|
|
1652
|
+
$ sf agent trace list --session-id <SESSION_ID>
|
|
1653
|
+
|
|
1654
|
+
List traces recorded on or after April 20, 2026 (date-only, interpreted as UTC midnight):
|
|
1655
|
+
|
|
1656
|
+
$ sf agent trace list --since 2026-04-20
|
|
1657
|
+
|
|
1658
|
+
List traces recorded on or after a specific UTC time:
|
|
1659
|
+
|
|
1660
|
+
$ sf agent trace list --since 2026-04-20T14:00:00Z
|
|
1661
|
+
|
|
1662
|
+
Filter by agent and date together:
|
|
1663
|
+
|
|
1664
|
+
$ sf agent trace list --agent My_Agent --since 2026-04-20
|
|
1665
|
+
|
|
1666
|
+
Return results as JSON:
|
|
1667
|
+
|
|
1668
|
+
$ sf agent trace list --json
|
|
1669
|
+
|
|
1670
|
+
FLAG DESCRIPTIONS
|
|
1671
|
+
--since=<value> Date used to filter the list of trace files; only those recorded on or after the date are listed.
|
|
1672
|
+
|
|
1673
|
+
Accepts ISO 8601 format: date-only (2026-04-20), date-time (2026-04-20T14:00:00Z), or date-time with milliseconds
|
|
1674
|
+
(2026-04-20T14:00:00.000Z). The "Recorded At" values shown in the table output are valid inputs.
|
|
1675
|
+
|
|
1676
|
+
ERROR CODES
|
|
1677
|
+
Succeeded (0) Trace files listed successfully (or empty list if none found).
|
|
1678
|
+
```
|
|
1679
|
+
|
|
1680
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.38.0/src/commands/agent/trace/list.ts)_
|
|
1681
|
+
|
|
1682
|
+
## `sf agent trace read`
|
|
1683
|
+
|
|
1684
|
+
Read and analyze trace files from an agent preview session.
|
|
1685
|
+
|
|
1686
|
+
```
|
|
1687
|
+
USAGE
|
|
1688
|
+
$ sf agent trace read -s <value> [--json] [--flags-dir <value>] [-f summary|detail|raw] [-d
|
|
1689
|
+
actions|grounding|routing|errors] [-t <value>]
|
|
1690
|
+
|
|
1691
|
+
FLAGS
|
|
1692
|
+
-d, --dimension=<option> Dimension to drill into when using --format detail. One of: actions, grounding, routing,
|
|
1693
|
+
errors. Required when --format is detail.
|
|
1694
|
+
<options: actions|grounding|routing|errors>
|
|
1695
|
+
-f, --format=<option> [default: summary] Output format: summary (default), detail, or raw. Use detail with
|
|
1696
|
+
--dimension to drill into a specific aspect of the trace.
|
|
1697
|
+
<options: summary|detail|raw>
|
|
1698
|
+
-s, --session-id=<value> (required) Session ID to read traces for.
|
|
1699
|
+
-t, --turn=<value> Scope output to this conversation turn number.
|
|
1700
|
+
|
|
1701
|
+
GLOBAL FLAGS
|
|
1702
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1703
|
+
--json Format output as json.
|
|
1704
|
+
|
|
1705
|
+
DESCRIPTION
|
|
1706
|
+
Read and analyze trace files from an agent preview session.
|
|
1707
|
+
|
|
1708
|
+
Reads trace files recorded during an agent preview session and outputs them in one of three formats.
|
|
1709
|
+
|
|
1710
|
+
**--format summary** (default): A per-turn narrative showing topic routing, actions executed, and the agent's
|
|
1711
|
+
response. Use this to quickly understand what happened in a session.
|
|
1712
|
+
|
|
1713
|
+
**--format detail**: Diagnostic drill-down into a specific dimension (--dimension required). Filters output to only
|
|
1714
|
+
the trace steps relevant to that dimension, minimizing noise.
|
|
1715
|
+
|
|
1716
|
+
**--format raw**: Unprocessed trace JSON. Use this as a fallback when the trace schema has changed or you need to
|
|
1717
|
+
perform custom analysis.
|
|
1718
|
+
|
|
1719
|
+
Available dimensions for --format detail: actions, grounding, routing, errors.
|
|
1720
|
+
|
|
1721
|
+
Use --turn N to scope output to a single conversation turn.
|
|
1722
|
+
|
|
1723
|
+
EXAMPLES
|
|
1724
|
+
Show a session summary (all turns):
|
|
1725
|
+
|
|
1726
|
+
$ sf agent trace read --session-id <SESSION_ID>
|
|
1727
|
+
|
|
1728
|
+
Show summary for a single turn:
|
|
1729
|
+
|
|
1730
|
+
$ sf agent trace read --session-id <SESSION_ID> --turn 2
|
|
1731
|
+
|
|
1732
|
+
Drill into action execution across all turns:
|
|
1733
|
+
|
|
1734
|
+
$ sf agent trace read --session-id <SESSION_ID> --format detail --dimension actions
|
|
1735
|
+
|
|
1736
|
+
Drill into routing decisions for a specific turn:
|
|
1737
|
+
|
|
1738
|
+
$ sf agent trace read --session-id <SESSION_ID> --format detail --dimension routing --turn 1
|
|
1739
|
+
|
|
1740
|
+
Show all errors across the session:
|
|
1741
|
+
|
|
1742
|
+
$ sf agent trace read --session-id <SESSION_ID> --format detail --dimension errors
|
|
1743
|
+
|
|
1744
|
+
Output raw trace JSON for custom parsing:
|
|
1745
|
+
|
|
1746
|
+
$ sf agent trace read --session-id <SESSION_ID> --format raw
|
|
1747
|
+
|
|
1748
|
+
Return results as JSON:
|
|
1749
|
+
|
|
1750
|
+
$ sf agent trace read --session-id <SESSION_ID> --json
|
|
1751
|
+
```
|
|
1752
|
+
|
|
1753
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.38.0/src/commands/agent/trace/read.ts)_
|
|
1422
1754
|
|
|
1423
1755
|
## `sf agent validate authoring-bundle`
|
|
1424
1756
|
|
|
@@ -1475,7 +1807,7 @@ ERROR CODES
|
|
|
1475
1807
|
ServerError (3) Validation/compilation API returned HTTP 500. A server error occurred during compilation.
|
|
1476
1808
|
```
|
|
1477
1809
|
|
|
1478
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1810
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.38.0/src/commands/agent/validate/authoring-bundle.ts)_
|
|
1479
1811
|
|
|
1480
1812
|
## `sf alias list`
|
|
1481
1813
|
|
|
@@ -2038,7 +2370,7 @@ EXAMPLES
|
|
|
2038
2370
|
$ sf api request graphql --body example.txt --stream-to-file output.txt --include
|
|
2039
2371
|
```
|
|
2040
2372
|
|
|
2041
|
-
_See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.3.
|
|
2373
|
+
_See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.3.25/src/commands/api/request/graphql.ts)_
|
|
2042
2374
|
|
|
2043
2375
|
## `sf api request rest [URL]`
|
|
2044
2376
|
|
|
@@ -2147,7 +2479,7 @@ FLAG DESCRIPTIONS
|
|
|
2147
2479
|
https://github.com/salesforcecli/plugin-api/tree/main/test/test-files/data-project.
|
|
2148
2480
|
```
|
|
2149
2481
|
|
|
2150
|
-
_See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.3.
|
|
2482
|
+
_See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.3.25/src/commands/api/request/rest.ts)_
|
|
2151
2483
|
|
|
2152
2484
|
## `sf autocomplete [SHELL]`
|
|
2153
2485
|
|
|
@@ -3545,7 +3877,7 @@ EXAMPLES
|
|
|
3545
3877
|
$ sf doctor --plugin @salesforce/plugin-source
|
|
3546
3878
|
```
|
|
3547
3879
|
|
|
3548
|
-
_See code: [@salesforce/plugin-info](https://github.com/salesforcecli/plugin-info/blob/3.4.
|
|
3880
|
+
_See code: [@salesforce/plugin-info](https://github.com/salesforcecli/plugin-info/blob/3.4.126/src/commands/doctor.ts)_
|
|
3549
3881
|
|
|
3550
3882
|
## `sf force data bulk delete`
|
|
3551
3883
|
|
|
@@ -3747,7 +4079,7 @@ EXAMPLES
|
|
|
3747
4079
|
$ sf info releasenotes display --version latest
|
|
3748
4080
|
```
|
|
3749
4081
|
|
|
3750
|
-
_See code: [@salesforce/plugin-info](https://github.com/salesforcecli/plugin-info/blob/3.4.
|
|
4082
|
+
_See code: [@salesforce/plugin-info](https://github.com/salesforcecli/plugin-info/blob/3.4.126/src/commands/info/releasenotes/display.ts)_
|
|
3751
4083
|
|
|
3752
4084
|
## `sf logic get test`
|
|
3753
4085
|
|
|
@@ -4088,7 +4420,7 @@ FLAG DESCRIPTIONS
|
|
|
4088
4420
|
"agent.user.<GUID>@your-org-domain.com".
|
|
4089
4421
|
```
|
|
4090
4422
|
|
|
4091
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.10.
|
|
4423
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.10.8/src/commands/org/create/agent-user.ts)_
|
|
4092
4424
|
|
|
4093
4425
|
## `sf org create sandbox`
|
|
4094
4426
|
|
|
@@ -4222,7 +4554,7 @@ FLAG DESCRIPTIONS
|
|
|
4222
4554
|
You can specify either --source-sandbox-name or --source-id when cloning an existing sandbox, but not both.
|
|
4223
4555
|
```
|
|
4224
4556
|
|
|
4225
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.10.
|
|
4557
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.10.8/src/commands/org/create/sandbox.ts)_
|
|
4226
4558
|
|
|
4227
4559
|
## `sf org create scratch`
|
|
4228
4560
|
|
|
@@ -4404,7 +4736,7 @@ FLAG DESCRIPTIONS
|
|
|
4404
4736
|
Omit this flag to have Salesforce generate a unique username for your org.
|
|
4405
4737
|
```
|
|
4406
4738
|
|
|
4407
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.10.
|
|
4739
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.10.8/src/commands/org/create/scratch.ts)_
|
|
4408
4740
|
|
|
4409
4741
|
## `sf org create user`
|
|
4410
4742
|
|
|
@@ -4558,7 +4890,7 @@ EXAMPLES
|
|
|
4558
4890
|
$ sf org delete sandbox --target-org my-sandbox --no-prompt
|
|
4559
4891
|
```
|
|
4560
4892
|
|
|
4561
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.10.
|
|
4893
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.10.8/src/commands/org/delete/sandbox.ts)_
|
|
4562
4894
|
|
|
4563
4895
|
## `sf org delete scratch`
|
|
4564
4896
|
|
|
@@ -4602,7 +4934,7 @@ EXAMPLES
|
|
|
4602
4934
|
$ sf org delete scratch --target-org my-scratch-org --no-prompt
|
|
4603
4935
|
```
|
|
4604
4936
|
|
|
4605
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.10.
|
|
4937
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.10.8/src/commands/org/delete/scratch.ts)_
|
|
4606
4938
|
|
|
4607
4939
|
## `sf org disable tracking`
|
|
4608
4940
|
|
|
@@ -4641,7 +4973,7 @@ EXAMPLES
|
|
|
4641
4973
|
$ sf org disable tracking
|
|
4642
4974
|
```
|
|
4643
4975
|
|
|
4644
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.10.
|
|
4976
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.10.8/src/commands/org/disable/tracking.ts)_
|
|
4645
4977
|
|
|
4646
4978
|
## `sf org display`
|
|
4647
4979
|
|
|
@@ -4686,7 +5018,7 @@ EXAMPLES
|
|
|
4686
5018
|
$ sf org display --target-org TestOrg1 --verbose
|
|
4687
5019
|
```
|
|
4688
5020
|
|
|
4689
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.10.
|
|
5021
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.10.8/src/commands/org/display.ts)_
|
|
4690
5022
|
|
|
4691
5023
|
## `sf org display user`
|
|
4692
5024
|
|
|
@@ -4767,7 +5099,7 @@ EXAMPLES
|
|
|
4767
5099
|
$ sf org enable tracking
|
|
4768
5100
|
```
|
|
4769
5101
|
|
|
4770
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.10.
|
|
5102
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.10.8/src/commands/org/enable/tracking.ts)_
|
|
4771
5103
|
|
|
4772
5104
|
## `sf org generate password`
|
|
4773
5105
|
|
|
@@ -4873,7 +5205,7 @@ EXAMPLES
|
|
|
4873
5205
|
$ sf org list --clean
|
|
4874
5206
|
```
|
|
4875
5207
|
|
|
4876
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.10.
|
|
5208
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.10.8/src/commands/org/list.ts)_
|
|
4877
5209
|
|
|
4878
5210
|
## `sf org list auth`
|
|
4879
5211
|
|
|
@@ -5012,7 +5344,7 @@ FLAG DESCRIPTIONS
|
|
|
5012
5344
|
Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.
|
|
5013
5345
|
```
|
|
5014
5346
|
|
|
5015
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.10.
|
|
5347
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.10.8/src/commands/org/list/metadata.ts)_
|
|
5016
5348
|
|
|
5017
5349
|
## `sf org list metadata-types`
|
|
5018
5350
|
|
|
@@ -5067,7 +5399,7 @@ FLAG DESCRIPTIONS
|
|
|
5067
5399
|
Override the api version used for api requests made by this command
|
|
5068
5400
|
```
|
|
5069
5401
|
|
|
5070
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.10.
|
|
5402
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.10.8/src/commands/org/list/metadata-types.ts)_
|
|
5071
5403
|
|
|
5072
5404
|
## `sf org list sobject record-counts`
|
|
5073
5405
|
|
|
@@ -5613,7 +5945,7 @@ EXAMPLES
|
|
|
5613
5945
|
$ sf org open --source-file force-app/main/default/bots/Coral_Cloud_Agent/Coral_Cloud_Agent.bot-meta.xml
|
|
5614
5946
|
```
|
|
5615
5947
|
|
|
5616
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.10.
|
|
5948
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.10.8/src/commands/org/open.ts)_
|
|
5617
5949
|
|
|
5618
5950
|
## `sf org open agent`
|
|
5619
5951
|
|
|
@@ -5688,7 +6020,7 @@ FLAG DESCRIPTIONS
|
|
|
5688
6020
|
flag.
|
|
5689
6021
|
```
|
|
5690
6022
|
|
|
5691
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.10.
|
|
6023
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.10.8/src/commands/org/open/agent.ts)_
|
|
5692
6024
|
|
|
5693
6025
|
## `sf org open authoring-bundle`
|
|
5694
6026
|
|
|
@@ -5734,7 +6066,7 @@ EXAMPLES
|
|
|
5734
6066
|
$ sf org open authoring-bundle --target-org MyTestOrg1 --browser firefox
|
|
5735
6067
|
```
|
|
5736
6068
|
|
|
5737
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.10.
|
|
6069
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.10.8/src/commands/org/open/authoring-bundle.ts)_
|
|
5738
6070
|
|
|
5739
6071
|
## `sf org refresh sandbox`
|
|
5740
6072
|
|
|
@@ -5837,7 +6169,7 @@ FLAG DESCRIPTIONS
|
|
|
5837
6169
|
You can specify either --source-sandbox-name or --source-id when refreshing an existing sandbox, but not both.
|
|
5838
6170
|
```
|
|
5839
6171
|
|
|
5840
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.10.
|
|
6172
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.10.8/src/commands/org/refresh/sandbox.ts)_
|
|
5841
6173
|
|
|
5842
6174
|
## `sf org resume sandbox`
|
|
5843
6175
|
|
|
@@ -5900,7 +6232,7 @@ FLAG DESCRIPTIONS
|
|
|
5900
6232
|
returns the job ID. To resume checking the sandbox creation, rerun this command.
|
|
5901
6233
|
```
|
|
5902
6234
|
|
|
5903
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.10.
|
|
6235
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.10.8/src/commands/org/resume/sandbox.ts)_
|
|
5904
6236
|
|
|
5905
6237
|
## `sf org resume scratch`
|
|
5906
6238
|
|
|
@@ -5953,7 +6285,7 @@ FLAG DESCRIPTIONS
|
|
|
5953
6285
|
returns the job ID. To resume checking the scratch creation, rerun this command.
|
|
5954
6286
|
```
|
|
5955
6287
|
|
|
5956
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.10.
|
|
6288
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.10.8/src/commands/org/resume/scratch.ts)_
|
|
5957
6289
|
|
|
5958
6290
|
## `sf package convert`
|
|
5959
6291
|
|
|
@@ -6050,7 +6382,7 @@ FLAG DESCRIPTIONS
|
|
|
6050
6382
|
--installation-key-bypass flag is required.
|
|
6051
6383
|
```
|
|
6052
6384
|
|
|
6053
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.
|
|
6385
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.13/src/commands/package/convert.ts)_
|
|
6054
6386
|
|
|
6055
6387
|
## `sf package create`
|
|
6056
6388
|
|
|
@@ -6129,7 +6461,7 @@ FLAG DESCRIPTIONS
|
|
|
6129
6461
|
Org-Dependent Unlocked Packages" in the Salesforce DX Developer Guide.
|
|
6130
6462
|
```
|
|
6131
6463
|
|
|
6132
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.
|
|
6464
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.13/src/commands/package/create.ts)_
|
|
6133
6465
|
|
|
6134
6466
|
## `sf package delete`
|
|
6135
6467
|
|
|
@@ -6171,7 +6503,7 @@ EXAMPLES
|
|
|
6171
6503
|
$ sf package delete --package 0Ho... --target-dev-hub devhub@example.com
|
|
6172
6504
|
```
|
|
6173
6505
|
|
|
6174
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.
|
|
6506
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.13/src/commands/package/delete.ts)_
|
|
6175
6507
|
|
|
6176
6508
|
## `sf package install`
|
|
6177
6509
|
|
|
@@ -6270,7 +6602,7 @@ FLAG DESCRIPTIONS
|
|
|
6270
6602
|
- Delete: Delete removed components, except for custom objects and custom fields, that don't have dependencies.
|
|
6271
6603
|
```
|
|
6272
6604
|
|
|
6273
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.
|
|
6605
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.13/src/commands/package/install.ts)_
|
|
6274
6606
|
|
|
6275
6607
|
## `sf package install report`
|
|
6276
6608
|
|
|
@@ -6303,7 +6635,7 @@ EXAMPLES
|
|
|
6303
6635
|
$ sf package install report --request-id 0Hf... --target-org me@example.com
|
|
6304
6636
|
```
|
|
6305
6637
|
|
|
6306
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.
|
|
6638
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.13/src/commands/package/install/report.ts)_
|
|
6307
6639
|
|
|
6308
6640
|
## `sf package installed list`
|
|
6309
6641
|
|
|
@@ -6335,7 +6667,7 @@ EXAMPLES
|
|
|
6335
6667
|
$ sf package installed list --target-org me@example.com
|
|
6336
6668
|
```
|
|
6337
6669
|
|
|
6338
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.
|
|
6670
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.13/src/commands/package/installed/list.ts)_
|
|
6339
6671
|
|
|
6340
6672
|
## `sf package list`
|
|
6341
6673
|
|
|
@@ -6373,7 +6705,7 @@ EXAMPLES
|
|
|
6373
6705
|
$ sf package list --target-dev-hub devhub@example.com --verbose
|
|
6374
6706
|
```
|
|
6375
6707
|
|
|
6376
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.
|
|
6708
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.13/src/commands/package/list.ts)_
|
|
6377
6709
|
|
|
6378
6710
|
## `sf package push-upgrade abort`
|
|
6379
6711
|
|
|
@@ -6412,7 +6744,7 @@ EXAMPLES
|
|
|
6412
6744
|
$ sf package push-upgrade abort --push-request-id 0DV... --target-dev-hub devhub@example.com
|
|
6413
6745
|
```
|
|
6414
6746
|
|
|
6415
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.
|
|
6747
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.13/src/commands/package/push-upgrade/abort.ts)_
|
|
6416
6748
|
|
|
6417
6749
|
## `sf package push-upgrade list`
|
|
6418
6750
|
|
|
@@ -6471,7 +6803,7 @@ EXAMPLES
|
|
|
6471
6803
|
$ sf package push-upgrade list --package 033xyz –-status Failed
|
|
6472
6804
|
```
|
|
6473
6805
|
|
|
6474
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.
|
|
6806
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.13/src/commands/package/push-upgrade/list.ts)_
|
|
6475
6807
|
|
|
6476
6808
|
## `sf package push-upgrade report`
|
|
6477
6809
|
|
|
@@ -6513,7 +6845,7 @@ EXAMPLES
|
|
|
6513
6845
|
$ sf package push-upgrade report --push-request-id 0DV... --target-dev-hub devhub@example.com
|
|
6514
6846
|
```
|
|
6515
6847
|
|
|
6516
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.
|
|
6848
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.13/src/commands/package/push-upgrade/report.ts)_
|
|
6517
6849
|
|
|
6518
6850
|
## `sf package push-upgrade schedule`
|
|
6519
6851
|
|
|
@@ -6600,7 +6932,7 @@ FLAG DESCRIPTIONS
|
|
|
6600
6932
|
Overrides the value of the target-dev-hub configuration variable, if set.
|
|
6601
6933
|
```
|
|
6602
6934
|
|
|
6603
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.
|
|
6935
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.13/src/commands/package/push-upgrade/schedule.ts)_
|
|
6604
6936
|
|
|
6605
6937
|
## `sf package uninstall`
|
|
6606
6938
|
|
|
@@ -6648,7 +6980,7 @@ EXAMPLES
|
|
|
6648
6980
|
$ sf package uninstall --package "Undesirable Package Alias"
|
|
6649
6981
|
```
|
|
6650
6982
|
|
|
6651
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.
|
|
6983
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.13/src/commands/package/uninstall.ts)_
|
|
6652
6984
|
|
|
6653
6985
|
## `sf package uninstall report`
|
|
6654
6986
|
|
|
@@ -6681,7 +7013,7 @@ EXAMPLES
|
|
|
6681
7013
|
$ sf package uninstall report --request-id 06y... --target-org me@example.com
|
|
6682
7014
|
```
|
|
6683
7015
|
|
|
6684
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.
|
|
7016
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.13/src/commands/package/uninstall/report.ts)_
|
|
6685
7017
|
|
|
6686
7018
|
## `sf package update`
|
|
6687
7019
|
|
|
@@ -6749,7 +7081,7 @@ FLAG DESCRIPTIONS
|
|
|
6749
7081
|
the Installed Packages page. Only released package versions can be set as the recommended version.
|
|
6750
7082
|
```
|
|
6751
7083
|
|
|
6752
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.
|
|
7084
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.13/src/commands/package/update.ts)_
|
|
6753
7085
|
|
|
6754
7086
|
## `sf package version create`
|
|
6755
7087
|
|
|
@@ -6926,7 +7258,7 @@ FLAG DESCRIPTIONS
|
|
|
6926
7258
|
periods of no output from commands.
|
|
6927
7259
|
```
|
|
6928
7260
|
|
|
6929
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.
|
|
7261
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.13/src/commands/package/version/create.ts)_
|
|
6930
7262
|
|
|
6931
7263
|
## `sf package version create list`
|
|
6932
7264
|
|
|
@@ -6987,7 +7319,7 @@ EXAMPLES
|
|
|
6987
7319
|
$ sf package version create list --created-last-days 0 --status Success
|
|
6988
7320
|
```
|
|
6989
7321
|
|
|
6990
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.
|
|
7322
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.13/src/commands/package/version/create/list.ts)_
|
|
6991
7323
|
|
|
6992
7324
|
## `sf package version create report`
|
|
6993
7325
|
|
|
@@ -7030,7 +7362,7 @@ EXAMPLES
|
|
|
7030
7362
|
$ sf package version create report --package-create-request-id 08c... --target-dev-hub devhub@example.com
|
|
7031
7363
|
```
|
|
7032
7364
|
|
|
7033
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.
|
|
7365
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.13/src/commands/package/version/create/report.ts)_
|
|
7034
7366
|
|
|
7035
7367
|
## `sf package version delete`
|
|
7036
7368
|
|
|
@@ -7071,7 +7403,7 @@ EXAMPLES
|
|
|
7071
7403
|
$ sf package version delete --package 04t... --target-org devhub@example.com
|
|
7072
7404
|
```
|
|
7073
7405
|
|
|
7074
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.
|
|
7406
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.13/src/commands/package/version/delete.ts)_
|
|
7075
7407
|
|
|
7076
7408
|
## `sf package version displayancestry`
|
|
7077
7409
|
|
|
@@ -7131,7 +7463,7 @@ FLAG DESCRIPTIONS
|
|
|
7131
7463
|
You can use the DOT code output in graph visualization software to create tree visualizations.
|
|
7132
7464
|
```
|
|
7133
7465
|
|
|
7134
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.
|
|
7466
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.13/src/commands/package/version/displayancestry.ts)_
|
|
7135
7467
|
|
|
7136
7468
|
## `sf package version displaydependencies`
|
|
7137
7469
|
|
|
@@ -7193,7 +7525,7 @@ FLAG DESCRIPTIONS
|
|
|
7193
7525
|
package, which must be installed last.
|
|
7194
7526
|
```
|
|
7195
7527
|
|
|
7196
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.
|
|
7528
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.13/src/commands/package/version/displaydependencies.ts)_
|
|
7197
7529
|
|
|
7198
7530
|
## `sf package version list`
|
|
7199
7531
|
|
|
@@ -7269,7 +7601,7 @@ EXAMPLES
|
|
|
7269
7601
|
$ sf package version list --packages exp-mgr,exp-mgr-util --released --modified-last-days 0
|
|
7270
7602
|
```
|
|
7271
7603
|
|
|
7272
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.
|
|
7604
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.13/src/commands/package/version/list.ts)_
|
|
7273
7605
|
|
|
7274
7606
|
## `sf package version promote`
|
|
7275
7607
|
|
|
@@ -7313,7 +7645,7 @@ EXAMPLES
|
|
|
7313
7645
|
$ sf package version promote --package "Awesome Package Alias"
|
|
7314
7646
|
```
|
|
7315
7647
|
|
|
7316
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.
|
|
7648
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.13/src/commands/package/version/promote.ts)_
|
|
7317
7649
|
|
|
7318
7650
|
## `sf package version report`
|
|
7319
7651
|
|
|
@@ -7353,7 +7685,7 @@ EXAMPLES
|
|
|
7353
7685
|
$ sf package version report --package "Your Package Alias" --target-dev-hub devhub@example.com
|
|
7354
7686
|
```
|
|
7355
7687
|
|
|
7356
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.
|
|
7688
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.13/src/commands/package/version/report.ts)_
|
|
7357
7689
|
|
|
7358
7690
|
## `sf package version retrieve`
|
|
7359
7691
|
|
|
@@ -7398,7 +7730,7 @@ EXAMPLES
|
|
|
7398
7730
|
$ sf package version retrieve --package 04tXXX --output-dir my-directory/ --target-dev-hub devhub@example.com
|
|
7399
7731
|
```
|
|
7400
7732
|
|
|
7401
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.
|
|
7733
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.13/src/commands/package/version/retrieve.ts)_
|
|
7402
7734
|
|
|
7403
7735
|
## `sf package version update`
|
|
7404
7736
|
|
|
@@ -7451,7 +7783,7 @@ EXAMPLES
|
|
|
7451
7783
|
$ sf package version update --package 04t... --version-description "New Package Version Description"
|
|
7452
7784
|
```
|
|
7453
7785
|
|
|
7454
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.
|
|
7786
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.13/src/commands/package/version/update.ts)_
|
|
7455
7787
|
|
|
7456
7788
|
## `sf package1 version create`
|
|
7457
7789
|
|
|
@@ -7518,7 +7850,7 @@ FLAG DESCRIPTIONS
|
|
|
7518
7850
|
subscribers.
|
|
7519
7851
|
```
|
|
7520
7852
|
|
|
7521
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.
|
|
7853
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.13/src/commands/package1/version/create.ts)_
|
|
7522
7854
|
|
|
7523
7855
|
## `sf package1 version create get`
|
|
7524
7856
|
|
|
@@ -7551,7 +7883,7 @@ EXAMPLES
|
|
|
7551
7883
|
$ sf package1 version create get --request-id 0HD... --target-org myorg@example.com
|
|
7552
7884
|
```
|
|
7553
7885
|
|
|
7554
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.
|
|
7886
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.13/src/commands/package1/version/create/get.ts)_
|
|
7555
7887
|
|
|
7556
7888
|
## `sf package1 version display`
|
|
7557
7889
|
|
|
@@ -7585,7 +7917,7 @@ EXAMPLES
|
|
|
7585
7917
|
$ sf package1 version display --package-version-id 04t... --target-org myorg@example.com
|
|
7586
7918
|
```
|
|
7587
7919
|
|
|
7588
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.
|
|
7920
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.13/src/commands/package1/version/display.ts)_
|
|
7589
7921
|
|
|
7590
7922
|
## `sf package1 version list`
|
|
7591
7923
|
|
|
@@ -7623,7 +7955,7 @@ FLAG DESCRIPTIONS
|
|
|
7623
7955
|
If not specified, shows all versions for all packages (managed and unmanaged) in the org.
|
|
7624
7956
|
```
|
|
7625
7957
|
|
|
7626
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.
|
|
7958
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.27.13/src/commands/package1/version/list.ts)_
|
|
7627
7959
|
|
|
7628
7960
|
## `sf plugins`
|
|
7629
7961
|
|
|
@@ -7646,7 +7978,7 @@ EXAMPLES
|
|
|
7646
7978
|
$ sf plugins
|
|
7647
7979
|
```
|
|
7648
7980
|
|
|
7649
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.
|
|
7981
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.64/src/commands/plugins/index.ts)_
|
|
7650
7982
|
|
|
7651
7983
|
## `sf plugins discover`
|
|
7652
7984
|
|
|
@@ -7664,7 +7996,7 @@ EXAMPLES
|
|
|
7664
7996
|
$ sf plugins discover
|
|
7665
7997
|
```
|
|
7666
7998
|
|
|
7667
|
-
_See code: [@salesforce/plugin-marketplace](https://github.com/salesforcecli/plugin-marketplace/blob/1.3.
|
|
7999
|
+
_See code: [@salesforce/plugin-marketplace](https://github.com/salesforcecli/plugin-marketplace/blob/1.3.22/src/commands/plugins/discover.ts)_
|
|
7668
8000
|
|
|
7669
8001
|
## `sf plugins:inspect PLUGIN...`
|
|
7670
8002
|
|
|
@@ -7691,7 +8023,7 @@ EXAMPLES
|
|
|
7691
8023
|
$ sf plugins inspect @salesforce/plugin-packaging
|
|
7692
8024
|
```
|
|
7693
8025
|
|
|
7694
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.
|
|
8026
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.64/src/commands/plugins/inspect.ts)_
|
|
7695
8027
|
|
|
7696
8028
|
## `sf plugins install PLUGIN`
|
|
7697
8029
|
|
|
@@ -7740,7 +8072,7 @@ EXAMPLES
|
|
|
7740
8072
|
$ sf plugins install someuser/someplugin
|
|
7741
8073
|
```
|
|
7742
8074
|
|
|
7743
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.
|
|
8075
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.64/src/commands/plugins/install.ts)_
|
|
7744
8076
|
|
|
7745
8077
|
## `sf plugins link PATH`
|
|
7746
8078
|
|
|
@@ -7771,7 +8103,7 @@ EXAMPLES
|
|
|
7771
8103
|
$ sf plugins link @salesforce/plugin-packaging
|
|
7772
8104
|
```
|
|
7773
8105
|
|
|
7774
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.
|
|
8106
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.64/src/commands/plugins/link.ts)_
|
|
7775
8107
|
|
|
7776
8108
|
## `sf plugins reset`
|
|
7777
8109
|
|
|
@@ -7786,7 +8118,7 @@ FLAGS
|
|
|
7786
8118
|
--reinstall Reinstall all plugins after uninstalling.
|
|
7787
8119
|
```
|
|
7788
8120
|
|
|
7789
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.
|
|
8121
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.64/src/commands/plugins/reset.ts)_
|
|
7790
8122
|
|
|
7791
8123
|
## `sf plugins trust allowlist add`
|
|
7792
8124
|
|
|
@@ -7823,7 +8155,7 @@ EXAMPLES
|
|
|
7823
8155
|
$ sf plugins trust allowlist add --name @scope/my-plugin --name another-plugin
|
|
7824
8156
|
```
|
|
7825
8157
|
|
|
7826
|
-
_See code: [@salesforce/plugin-trust](https://github.com/salesforcecli/plugin-trust/blob/3.8.
|
|
8158
|
+
_See code: [@salesforce/plugin-trust](https://github.com/salesforcecli/plugin-trust/blob/3.8.2/src/commands/plugins/trust/allowlist/add.ts)_
|
|
7827
8159
|
|
|
7828
8160
|
## `sf plugins trust allowlist list`
|
|
7829
8161
|
|
|
@@ -7851,7 +8183,7 @@ EXAMPLES
|
|
|
7851
8183
|
$ sf plugins trust allowlist list
|
|
7852
8184
|
```
|
|
7853
8185
|
|
|
7854
|
-
_See code: [@salesforce/plugin-trust](https://github.com/salesforcecli/plugin-trust/blob/3.8.
|
|
8186
|
+
_See code: [@salesforce/plugin-trust](https://github.com/salesforcecli/plugin-trust/blob/3.8.2/src/commands/plugins/trust/allowlist/list.ts)_
|
|
7855
8187
|
|
|
7856
8188
|
## `sf plugins trust allowlist remove`
|
|
7857
8189
|
|
|
@@ -7888,7 +8220,7 @@ EXAMPLES
|
|
|
7888
8220
|
$ sf plugins trust allowlist remove --name @scope/my-plugin --name another-plugin
|
|
7889
8221
|
```
|
|
7890
8222
|
|
|
7891
|
-
_See code: [@salesforce/plugin-trust](https://github.com/salesforcecli/plugin-trust/blob/3.8.
|
|
8223
|
+
_See code: [@salesforce/plugin-trust](https://github.com/salesforcecli/plugin-trust/blob/3.8.2/src/commands/plugins/trust/allowlist/remove.ts)_
|
|
7892
8224
|
|
|
7893
8225
|
## `sf plugins trust verify`
|
|
7894
8226
|
|
|
@@ -7917,7 +8249,7 @@ EXAMPLES
|
|
|
7917
8249
|
$ sf plugins trust verify --npm @scope/npmName
|
|
7918
8250
|
```
|
|
7919
8251
|
|
|
7920
|
-
_See code: [@salesforce/plugin-trust](https://github.com/salesforcecli/plugin-trust/blob/3.8.
|
|
8252
|
+
_See code: [@salesforce/plugin-trust](https://github.com/salesforcecli/plugin-trust/blob/3.8.2/src/commands/plugins/trust/verify.ts)_
|
|
7921
8253
|
|
|
7922
8254
|
## `sf plugins uninstall [PLUGIN]`
|
|
7923
8255
|
|
|
@@ -7945,7 +8277,7 @@ EXAMPLES
|
|
|
7945
8277
|
$ sf plugins uninstall @salesforce/plugin-packaging
|
|
7946
8278
|
```
|
|
7947
8279
|
|
|
7948
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.
|
|
8280
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.64/src/commands/plugins/uninstall.ts)_
|
|
7949
8281
|
|
|
7950
8282
|
## `sf plugins update`
|
|
7951
8283
|
|
|
@@ -7963,7 +8295,7 @@ DESCRIPTION
|
|
|
7963
8295
|
Update installed plugins.
|
|
7964
8296
|
```
|
|
7965
8297
|
|
|
7966
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.
|
|
8298
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.64/src/commands/plugins/update.ts)_
|
|
7967
8299
|
|
|
7968
8300
|
## `sf project convert mdapi`
|
|
7969
8301
|
|
|
@@ -8026,7 +8358,7 @@ FLAG DESCRIPTIONS
|
|
|
8026
8358
|
If you specify this flag, don’t specify --metadata or --source-dir.
|
|
8027
8359
|
```
|
|
8028
8360
|
|
|
8029
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
8361
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.42/src/commands/project/convert/mdapi.ts)_
|
|
8030
8362
|
|
|
8031
8363
|
## `sf project convert source`
|
|
8032
8364
|
|
|
@@ -8099,7 +8431,7 @@ FLAG DESCRIPTIONS
|
|
|
8099
8431
|
Override the api version used for api requests made by this command
|
|
8100
8432
|
```
|
|
8101
8433
|
|
|
8102
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
8434
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.42/src/commands/project/convert/source.ts)_
|
|
8103
8435
|
|
|
8104
8436
|
## `sf project convert source-behavior`
|
|
8105
8437
|
|
|
@@ -8158,7 +8490,7 @@ EXAMPLES
|
|
|
8158
8490
|
$ sf project convert source-behavior --behavior decomposePermissionSetBeta --dry-run --preserve-temp-dir
|
|
8159
8491
|
```
|
|
8160
8492
|
|
|
8161
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
8493
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.42/src/commands/project/convert/source-behavior.ts)_
|
|
8162
8494
|
|
|
8163
8495
|
## `sf project delete source`
|
|
8164
8496
|
|
|
@@ -8311,7 +8643,7 @@ FLAG DESCRIPTIONS
|
|
|
8311
8643
|
- Separate the test names with spaces: --tests Test1 Test2 "Test With Space"
|
|
8312
8644
|
```
|
|
8313
8645
|
|
|
8314
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
8646
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.42/src/commands/project/delete/source.ts)_
|
|
8315
8647
|
|
|
8316
8648
|
## `sf project delete tracking`
|
|
8317
8649
|
|
|
@@ -8348,7 +8680,7 @@ EXAMPLES
|
|
|
8348
8680
|
$ sf project delete tracking --target-org my-scratch
|
|
8349
8681
|
```
|
|
8350
8682
|
|
|
8351
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
8683
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.42/src/commands/project/delete/tracking.ts)_
|
|
8352
8684
|
|
|
8353
8685
|
## `sf project deploy cancel`
|
|
8354
8686
|
|
|
@@ -8420,7 +8752,7 @@ FLAG DESCRIPTIONS
|
|
|
8420
8752
|
project deploy report".
|
|
8421
8753
|
```
|
|
8422
8754
|
|
|
8423
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
8755
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.42/src/commands/project/deploy/cancel.ts)_
|
|
8424
8756
|
|
|
8425
8757
|
## `sf project deploy preview`
|
|
8426
8758
|
|
|
@@ -8503,7 +8835,7 @@ FLAG DESCRIPTIONS
|
|
|
8503
8835
|
All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.
|
|
8504
8836
|
```
|
|
8505
8837
|
|
|
8506
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
8838
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.42/src/commands/project/deploy/preview.ts)_
|
|
8507
8839
|
|
|
8508
8840
|
## `sf project deploy quick`
|
|
8509
8841
|
|
|
@@ -8596,7 +8928,7 @@ ERROR CODES
|
|
|
8596
8928
|
Canceling (69) The deploy is being canceled.
|
|
8597
8929
|
```
|
|
8598
8930
|
|
|
8599
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
8931
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.42/src/commands/project/deploy/quick.ts)_
|
|
8600
8932
|
|
|
8601
8933
|
## `sf project deploy report`
|
|
8602
8934
|
|
|
@@ -8688,7 +9020,7 @@ FLAG DESCRIPTIONS
|
|
|
8688
9020
|
--coverage-formatters lcov --coverage-formatters clover
|
|
8689
9021
|
```
|
|
8690
9022
|
|
|
8691
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
9023
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.42/src/commands/project/deploy/report.ts)_
|
|
8692
9024
|
|
|
8693
9025
|
## `sf project deploy resume`
|
|
8694
9026
|
|
|
@@ -8785,7 +9117,7 @@ ERROR CODES
|
|
|
8785
9117
|
Canceling (69) The deploy is being canceled.
|
|
8786
9118
|
```
|
|
8787
9119
|
|
|
8788
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
9120
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.42/src/commands/project/deploy/resume.ts)_
|
|
8789
9121
|
|
|
8790
9122
|
## `sf project deploy start`
|
|
8791
9123
|
|
|
@@ -9051,7 +9383,7 @@ ERROR CODES
|
|
|
9051
9383
|
Canceling (69) The deploy is being canceled.
|
|
9052
9384
|
```
|
|
9053
9385
|
|
|
9054
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
9386
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.42/src/commands/project/deploy/start.ts)_
|
|
9055
9387
|
|
|
9056
9388
|
## `sf project deploy validate`
|
|
9057
9389
|
|
|
@@ -9255,7 +9587,7 @@ ERROR CODES
|
|
|
9255
9587
|
Canceling (69) The deploy is being canceled.
|
|
9256
9588
|
```
|
|
9257
9589
|
|
|
9258
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
9590
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.42/src/commands/project/deploy/validate.ts)_
|
|
9259
9591
|
|
|
9260
9592
|
## `sf project generate manifest`
|
|
9261
9593
|
|
|
@@ -9351,7 +9683,7 @@ EXAMPLES
|
|
|
9351
9683
|
$ sf project generate manifest --from-org test@myorg.com --excluded-metadata StandardValueSet
|
|
9352
9684
|
```
|
|
9353
9685
|
|
|
9354
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
9686
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.42/src/commands/project/generate/manifest.ts)_
|
|
9355
9687
|
|
|
9356
9688
|
## `sf project list ignored`
|
|
9357
9689
|
|
|
@@ -9393,7 +9725,7 @@ EXAMPLES
|
|
|
9393
9725
|
$ sf project list ignored --source-dir package.xml
|
|
9394
9726
|
```
|
|
9395
9727
|
|
|
9396
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
9728
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.42/src/commands/project/list/ignored.ts)_
|
|
9397
9729
|
|
|
9398
9730
|
## `sf project reset tracking`
|
|
9399
9731
|
|
|
@@ -9442,7 +9774,7 @@ EXAMPLES
|
|
|
9442
9774
|
$ sf project reset tracking --revision 30
|
|
9443
9775
|
```
|
|
9444
9776
|
|
|
9445
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
9777
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.42/src/commands/project/reset/tracking.ts)_
|
|
9446
9778
|
|
|
9447
9779
|
## `sf project retrieve preview`
|
|
9448
9780
|
|
|
@@ -9496,7 +9828,7 @@ FLAG DESCRIPTIONS
|
|
|
9496
9828
|
production orgs.
|
|
9497
9829
|
```
|
|
9498
9830
|
|
|
9499
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
9831
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.42/src/commands/project/retrieve/preview.ts)_
|
|
9500
9832
|
|
|
9501
9833
|
## `sf project retrieve start`
|
|
9502
9834
|
|
|
@@ -9677,7 +10009,7 @@ ENVIRONMENT VARIABLES
|
|
|
9677
10009
|
SF_USE_PROGRESS_BAR Set to false to disable the progress bar when running the metadata deploy command.
|
|
9678
10010
|
```
|
|
9679
10011
|
|
|
9680
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
10012
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.42/src/commands/project/retrieve/start.ts)_
|
|
9681
10013
|
|
|
9682
10014
|
## `sf schema generate field`
|
|
9683
10015
|
|
|
@@ -11008,7 +11340,7 @@ EXAMPLES
|
|
|
11008
11340
|
$ sf update --available
|
|
11009
11341
|
```
|
|
11010
11342
|
|
|
11011
|
-
_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/4.7.
|
|
11343
|
+
_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/4.7.36/src/commands/update.ts)_
|
|
11012
11344
|
|
|
11013
11345
|
## `sf version`
|
|
11014
11346
|
|