@salesforce/cli 2.152.12 → 2.152.13
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 +264 -107
- package/npm-shrinkwrap.json +655 -203
- package/oclif.lock +209 -76
- package/oclif.manifest.json +1 -1
- package/package.json +7 -7
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.152.
|
|
28
|
+
@salesforce/cli/2.152.13 linux-x64 node-v24.20.0
|
|
29
29
|
$ sf --help [COMMAND]
|
|
30
30
|
USAGE
|
|
31
31
|
$ sf COMMAND
|
|
@@ -241,6 +241,7 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI.
|
|
|
241
241
|
- [`sf template generate project`](#sf-template-generate-project)
|
|
242
242
|
- [`sf template generate static-resource`](#sf-template-generate-static-resource)
|
|
243
243
|
- [`sf template generate ui-bundle`](#sf-template-generate-ui-bundle)
|
|
244
|
+
- [`sf template generate ui-embedding`](#sf-template-generate-ui-embedding)
|
|
244
245
|
- [`sf template generate visualforce component`](#sf-template-generate-visualforce-component)
|
|
245
246
|
- [`sf template generate visualforce page`](#sf-template-generate-visualforce-page)
|
|
246
247
|
- [`sf update [CHANNEL]`](#sf-update-channel)
|
|
@@ -302,7 +303,7 @@ ERROR CODES
|
|
|
302
303
|
ActivationFailed (4) Failed to activate the agent due to API or network errors.
|
|
303
304
|
```
|
|
304
305
|
|
|
305
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
306
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/activate.ts)_
|
|
306
307
|
|
|
307
308
|
## `sf agent adl create`
|
|
308
309
|
|
|
@@ -374,7 +375,7 @@ EXAMPLES
|
|
|
374
375
|
--source-type retriever --retriever-id 0ppXX0000000001
|
|
375
376
|
```
|
|
376
377
|
|
|
377
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
378
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/adl/create.ts)_
|
|
378
379
|
|
|
379
380
|
## `sf agent adl delete`
|
|
380
381
|
|
|
@@ -405,7 +406,7 @@ EXAMPLES
|
|
|
405
406
|
$ sf agent adl delete --library-id 1JDSG000007IbWX4A0 --target-org myOrg
|
|
406
407
|
```
|
|
407
408
|
|
|
408
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
409
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/adl/delete.ts)_
|
|
409
410
|
|
|
410
411
|
## `sf agent adl file add`
|
|
411
412
|
|
|
@@ -447,7 +448,7 @@ EXAMPLES
|
|
|
447
448
|
$ sf agent adl file add -i 1JDSG000007IbWX4A0 --path ./docs/guide.pdf --path ./docs/faq.txt --target-org myOrg
|
|
448
449
|
```
|
|
449
450
|
|
|
450
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
451
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/adl/file/add.ts)_
|
|
451
452
|
|
|
452
453
|
## `sf agent adl file delete`
|
|
453
454
|
|
|
@@ -480,7 +481,7 @@ EXAMPLES
|
|
|
480
481
|
$ sf agent adl file delete --library-id 1JDSG000007IbWX4A0 --file-id a1B2C3D4E5F6G7H8I9 --target-org myOrg
|
|
481
482
|
```
|
|
482
483
|
|
|
483
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
484
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/adl/file/delete.ts)_
|
|
484
485
|
|
|
485
486
|
## `sf agent adl file list`
|
|
486
487
|
|
|
@@ -520,7 +521,7 @@ EXAMPLES
|
|
|
520
521
|
$ sf agent adl file list --library-id 1JDSG000007IbWX4A0 --target-org myOrg --json
|
|
521
522
|
```
|
|
522
523
|
|
|
523
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
524
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/adl/file/list.ts)_
|
|
524
525
|
|
|
525
526
|
## `sf agent adl get`
|
|
526
527
|
|
|
@@ -551,7 +552,7 @@ EXAMPLES
|
|
|
551
552
|
$ sf agent adl get --library-id 1JDSG000007IbWX4A0 --target-org myOrg
|
|
552
553
|
```
|
|
553
554
|
|
|
554
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
555
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/adl/get.ts)_
|
|
555
556
|
|
|
556
557
|
## `sf agent adl list`
|
|
557
558
|
|
|
@@ -588,7 +589,7 @@ EXAMPLES
|
|
|
588
589
|
$ sf agent adl list --target-org myOrg --json
|
|
589
590
|
```
|
|
590
591
|
|
|
591
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
592
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/adl/list.ts)_
|
|
592
593
|
|
|
593
594
|
## `sf agent adl status`
|
|
594
595
|
|
|
@@ -623,7 +624,7 @@ EXAMPLES
|
|
|
623
624
|
$ sf agent adl status --library-id 1JDSG000007IbWX4A0 --target-org myOrg
|
|
624
625
|
```
|
|
625
626
|
|
|
626
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
627
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/adl/status.ts)_
|
|
627
628
|
|
|
628
629
|
## `sf agent adl update`
|
|
629
630
|
|
|
@@ -678,7 +679,7 @@ EXAMPLES
|
|
|
678
679
|
$ sf agent adl update --library-id 1JDSG000007IbWX4A0 --restrict-to-public-articles --target-org myOrg
|
|
679
680
|
```
|
|
680
681
|
|
|
681
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
682
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/adl/update.ts)_
|
|
682
683
|
|
|
683
684
|
## `sf agent adl upload`
|
|
684
685
|
|
|
@@ -725,7 +726,7 @@ EXAMPLES
|
|
|
725
726
|
$ sf agent adl upload --library-id 1JDSG000007IbWX4A0 --file ./docs/guide.pdf --target-org myOrg
|
|
726
727
|
```
|
|
727
728
|
|
|
728
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
729
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/adl/upload.ts)_
|
|
729
730
|
|
|
730
731
|
## `sf agent create`
|
|
731
732
|
|
|
@@ -792,7 +793,7 @@ EXAMPLES
|
|
|
792
793
|
$ sf agent create --name "Resort Manager" --spec specs/resortManagerAgent.yaml --preview
|
|
793
794
|
```
|
|
794
795
|
|
|
795
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
796
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/create.ts)_
|
|
796
797
|
|
|
797
798
|
## `sf agent deactivate`
|
|
798
799
|
|
|
@@ -841,7 +842,7 @@ ERROR CODES
|
|
|
841
842
|
DeactivationFailed (4) Failed to deactivate the agent due to API or network errors.
|
|
842
843
|
```
|
|
843
844
|
|
|
844
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
845
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/deactivate.ts)_
|
|
845
846
|
|
|
846
847
|
## `sf agent generate agent-spec`
|
|
847
848
|
|
|
@@ -948,7 +949,7 @@ EXAMPLES
|
|
|
948
949
|
$ sf agent generate agent-spec --tone formal --agent-user resortmanager@myorg.com
|
|
949
950
|
```
|
|
950
951
|
|
|
951
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
952
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/generate/agent-spec.ts)_
|
|
952
953
|
|
|
953
954
|
## `sf agent generate authoring-bundle`
|
|
954
955
|
|
|
@@ -1025,7 +1026,7 @@ EXAMPLES
|
|
|
1025
1026
|
other-package-dir/main/default --target-org my-dev-org
|
|
1026
1027
|
```
|
|
1027
1028
|
|
|
1028
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
1029
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/generate/authoring-bundle.ts)_
|
|
1029
1030
|
|
|
1030
1031
|
## `sf agent generate template`
|
|
1031
1032
|
|
|
@@ -1087,7 +1088,7 @@ EXAMPLES
|
|
|
1087
1088
|
my-package --source-org my-scratch-org
|
|
1088
1089
|
```
|
|
1089
1090
|
|
|
1090
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
1091
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/generate/template.ts)_
|
|
1091
1092
|
|
|
1092
1093
|
## `sf agent generate test-spec`
|
|
1093
1094
|
|
|
@@ -1176,7 +1177,7 @@ FLAG DESCRIPTIONS
|
|
|
1176
1177
|
metadata. 'testing-center' uses AiEvaluationDefinition metadata.
|
|
1177
1178
|
```
|
|
1178
1179
|
|
|
1179
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
1180
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/generate/test-spec.ts)_
|
|
1180
1181
|
|
|
1181
1182
|
## `sf agent mcp asset list`
|
|
1182
1183
|
|
|
@@ -1212,7 +1213,7 @@ EXAMPLES
|
|
|
1212
1213
|
$ sf agent mcp asset list --target-org myOrg --mcp-server-id 0XSxx0000000001 --json
|
|
1213
1214
|
```
|
|
1214
1215
|
|
|
1215
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
1216
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/mcp/asset/list.ts)_
|
|
1216
1217
|
|
|
1217
1218
|
## `sf agent mcp asset replace`
|
|
1218
1219
|
|
|
@@ -1261,7 +1262,7 @@ EXAMPLES
|
|
|
1261
1262
|
cat assets.json | sf agent mcp asset replace --mcp-server-id 0XSxx0000000001 --assets - --target-org myOrg
|
|
1262
1263
|
```
|
|
1263
1264
|
|
|
1264
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
1265
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/mcp/asset/replace.ts)_
|
|
1265
1266
|
|
|
1266
1267
|
## `sf agent mcp create`
|
|
1267
1268
|
|
|
@@ -1309,7 +1310,7 @@ EXAMPLES
|
|
|
1309
1310
|
cat secret.txt | sf agent mcp create --name myServer --server-url https://mcp.example.com --auth-type OAUTH --identity-provider myIdp --client-id abc123 --client-secret - --scope "read write" --target-org myOrg
|
|
1310
1311
|
```
|
|
1311
1312
|
|
|
1312
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
1313
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/mcp/create.ts)_
|
|
1313
1314
|
|
|
1314
1315
|
## `sf agent mcp delete`
|
|
1315
1316
|
|
|
@@ -1347,7 +1348,7 @@ EXAMPLES
|
|
|
1347
1348
|
$ sf agent mcp delete --mcp-server-id 0XSxx0000000001 --target-org myOrg --no-prompt
|
|
1348
1349
|
```
|
|
1349
1350
|
|
|
1350
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
1351
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/mcp/delete.ts)_
|
|
1351
1352
|
|
|
1352
1353
|
## `sf agent mcp fetch`
|
|
1353
1354
|
|
|
@@ -1384,7 +1385,7 @@ EXAMPLES
|
|
|
1384
1385
|
$ sf agent mcp fetch --target-org myOrg --mcp-server-id 0XSxx0000000001 --json
|
|
1385
1386
|
```
|
|
1386
1387
|
|
|
1387
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
1388
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/mcp/fetch.ts)_
|
|
1388
1389
|
|
|
1389
1390
|
## `sf agent mcp get`
|
|
1390
1391
|
|
|
@@ -1420,7 +1421,7 @@ EXAMPLES
|
|
|
1420
1421
|
$ sf agent mcp get --target-org myOrg --mcp-server-id 0Mx000000000001 --json
|
|
1421
1422
|
```
|
|
1422
1423
|
|
|
1423
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
1424
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/mcp/get.ts)_
|
|
1424
1425
|
|
|
1425
1426
|
## `sf agent mcp list`
|
|
1426
1427
|
|
|
@@ -1462,7 +1463,7 @@ EXAMPLES
|
|
|
1462
1463
|
$ sf agent mcp list --target-org myOrg --type EXTERNAL --status ACTIVE --json
|
|
1463
1464
|
```
|
|
1464
1465
|
|
|
1465
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
1466
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/mcp/list.ts)_
|
|
1466
1467
|
|
|
1467
1468
|
## `sf agent mcp update`
|
|
1468
1469
|
|
|
@@ -1513,7 +1514,7 @@ EXAMPLES
|
|
|
1513
1514
|
cat secret.txt | sf agent mcp update --mcp-server-id 0XSxx0000000001 --server-url https://mcp.example.com --auth-type OAUTH --identity-provider MyIdp --client-id abc --client-secret - --scope "read write" --target-org myOrg --json
|
|
1514
1515
|
```
|
|
1515
1516
|
|
|
1516
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
1517
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/mcp/update.ts)_
|
|
1517
1518
|
|
|
1518
1519
|
## `sf agent preview`
|
|
1519
1520
|
|
|
@@ -1522,20 +1523,21 @@ Interact with an agent to preview how it responds to your statements, questions,
|
|
|
1522
1523
|
```
|
|
1523
1524
|
USAGE
|
|
1524
1525
|
$ sf agent preview -o <value> [--flags-dir <value>] [--api-version <value>] [-n <value>] [--authoring-bundle
|
|
1525
|
-
<value>] [-d <value>] [-x] [--use-live-actions] [--context-variables <value>...]
|
|
1526
|
+
<value>] [-d <value>] [-x] [--use-live-actions] [--context-variables <value>...] [--context-variables-json <value>]
|
|
1526
1527
|
|
|
1527
1528
|
FLAGS
|
|
1528
|
-
-d, --output-dir=<value>
|
|
1529
|
-
-n, --api-name=<value>
|
|
1530
|
-
-o, --target-org=<value>
|
|
1531
|
-
|
|
1532
|
-
-x, --apex-debug
|
|
1533
|
-
--api-version=<value>
|
|
1534
|
-
--authoring-bundle=<value>
|
|
1535
|
-
|
|
1536
|
-
--context-variables=<value>...
|
|
1537
|
-
--
|
|
1538
|
-
|
|
1529
|
+
-d, --output-dir=<value> Directory where conversation transcripts are saved.
|
|
1530
|
+
-n, --api-name=<value> API name of the activated published agent you want to interact with.
|
|
1531
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
1532
|
+
configuration variable is already set.
|
|
1533
|
+
-x, --apex-debug Enable Apex debug logging during the agent preview conversation.
|
|
1534
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
1535
|
+
--authoring-bundle=<value> API name of the authoring bundle metadata component that contains the agent's
|
|
1536
|
+
Agent Script file.
|
|
1537
|
+
--context-variables=<value>... Session variables for the agent preview session, in the form Name=Value.
|
|
1538
|
+
--context-variables-json=<value> Typed session variables for the agent preview session, as a JSON array.
|
|
1539
|
+
--use-live-actions Use real actions in the org; if not specified, preview uses AI to simulate
|
|
1540
|
+
(mock) actions.
|
|
1539
1541
|
|
|
1540
1542
|
GLOBAL FLAGS
|
|
1541
1543
|
--flags-dir=<value> Import flag values from a directory.
|
|
@@ -1605,10 +1607,30 @@ FLAG DESCRIPTIONS
|
|
|
1605
1607
|
|
|
1606
1608
|
Tips: (1) Quote the whole value in single quotes so $Context isn't shell-expanded. (2) Names are sent verbatim — a
|
|
1607
1609
|
bare name is treated as a state variable, not a linked context variable, so live actions that bind via $Context.Name
|
|
1608
|
-
will see null. (3) Type
|
|
1610
|
+
will see null. (3) Type is always Text; to send a typed variable, use --context-variables-json.
|
|
1611
|
+
|
|
1612
|
+
--context-variables-json=<value> Typed session variables for the agent preview session, as a JSON array.
|
|
1613
|
+
|
|
1614
|
+
Sets typed variables on the agent preview session. Use this instead of --context-variables when a variable is not
|
|
1615
|
+
Text, for example a boolean-gated route (available when @variables.myFlag == True) that needs a real Boolean, or a
|
|
1616
|
+
Number, Object, List, or Json value.
|
|
1617
|
+
|
|
1618
|
+
The value is a JSON array of objects, each with a "name", a "type", and an optional "value". The "type" is one of
|
|
1619
|
+
Text, Date, DateTime, Money, Ref, Boolean, Number, Object, List, or Json. The JSON type of "value" must match
|
|
1620
|
+
"type": Boolean takes a boolean, Number takes a number, the string types take a string, Object and List take an
|
|
1621
|
+
array, and Json takes an object.
|
|
1622
|
+
|
|
1623
|
+
Example: --context-variables-json
|
|
1624
|
+
'[{"name":"probeGate","type":"Boolean","value":true},{"name":"retryCount","type":"Number","value":3}]'.
|
|
1625
|
+
|
|
1626
|
+
You can pass both --context-variables and --context-variables-json in the same command. When the same variable name
|
|
1627
|
+
appears in both, the --context-variables-json value wins.
|
|
1628
|
+
|
|
1629
|
+
Tip: names follow the same rules as --context-variables. Use the "$Context." prefix for linked context variables,
|
|
1630
|
+
and a bare name for state variables.
|
|
1609
1631
|
```
|
|
1610
1632
|
|
|
1611
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
1633
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/preview.ts)_
|
|
1612
1634
|
|
|
1613
1635
|
## `sf agent preview end`
|
|
1614
1636
|
|
|
@@ -1692,7 +1714,7 @@ ERROR CODES
|
|
|
1692
1714
|
SessionAmbiguous (5) Multiple preview sessions found; specify --session-id to choose one.
|
|
1693
1715
|
```
|
|
1694
1716
|
|
|
1695
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
1717
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/preview/end.ts)_
|
|
1696
1718
|
|
|
1697
1719
|
## `sf agent preview send`
|
|
1698
1720
|
|
|
@@ -1759,7 +1781,7 @@ ERROR CODES
|
|
|
1759
1781
|
SessionAmbiguous (5) Multiple preview sessions found; specify --session-id to choose one.
|
|
1760
1782
|
```
|
|
1761
1783
|
|
|
1762
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
1784
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/preview/send.ts)_
|
|
1763
1785
|
|
|
1764
1786
|
## `sf agent preview sessions`
|
|
1765
1787
|
|
|
@@ -1795,7 +1817,7 @@ ERROR CODES
|
|
|
1795
1817
|
Succeeded (0) Sessions listed successfully (or empty list if no active sessions).
|
|
1796
1818
|
```
|
|
1797
1819
|
|
|
1798
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
1820
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/preview/sessions.ts)_
|
|
1799
1821
|
|
|
1800
1822
|
## `sf agent preview start`
|
|
1801
1823
|
|
|
@@ -1805,19 +1827,21 @@ Start a programmatic agent preview session.
|
|
|
1805
1827
|
USAGE
|
|
1806
1828
|
$ sf agent preview start -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-n <value>]
|
|
1807
1829
|
[--authoring-bundle <value>] [--use-live-actions | --simulate-actions] [--context-variables <value>...]
|
|
1830
|
+
[--context-variables-json <value>]
|
|
1808
1831
|
|
|
1809
1832
|
FLAGS
|
|
1810
|
-
-n, --api-name=<value>
|
|
1811
|
-
-o, --target-org=<value>
|
|
1812
|
-
|
|
1813
|
-
--api-version=<value>
|
|
1814
|
-
--authoring-bundle=<value>
|
|
1815
|
-
|
|
1816
|
-
--context-variables=<value>...
|
|
1817
|
-
--
|
|
1818
|
-
|
|
1819
|
-
|
|
1820
|
-
|
|
1833
|
+
-n, --api-name=<value> API name of the activated published agent you want to preview.
|
|
1834
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
1835
|
+
configuration variable is already set.
|
|
1836
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
1837
|
+
--authoring-bundle=<value> API name of the authoring bundle metadata component that contains the agent's
|
|
1838
|
+
Agent Script file.
|
|
1839
|
+
--context-variables=<value>... Session variables for the agent preview session, in the form Name=Value.
|
|
1840
|
+
--context-variables-json=<value> Typed session variables for the agent preview session, as a JSON array.
|
|
1841
|
+
--simulate-actions Use AI to simulate action execution instead of calling real actions. Required
|
|
1842
|
+
with --authoring-bundle.
|
|
1843
|
+
--use-live-actions Execute real actions in the org (Apex classes, flows, etc.). Required with
|
|
1844
|
+
--authoring-bundle.
|
|
1821
1845
|
|
|
1822
1846
|
GLOBAL FLAGS
|
|
1823
1847
|
--flags-dir=<value> Import flag values from a directory.
|
|
@@ -1879,7 +1903,27 @@ FLAG DESCRIPTIONS
|
|
|
1879
1903
|
|
|
1880
1904
|
Tips: (1) Quote the whole value in single quotes so $Context isn't shell-expanded. (2) Names are sent verbatim — a
|
|
1881
1905
|
bare name is treated as a state variable, not a linked context variable, so live actions that bind via $Context.Name
|
|
1882
|
-
will see null. (3) Type
|
|
1906
|
+
will see null. (3) Type is always Text; to send a typed variable, use --context-variables-json.
|
|
1907
|
+
|
|
1908
|
+
--context-variables-json=<value> Typed session variables for the agent preview session, as a JSON array.
|
|
1909
|
+
|
|
1910
|
+
Sets typed variables on the agent preview session. Use this instead of --context-variables when a variable is not
|
|
1911
|
+
Text, for example a boolean-gated route (available when @variables.myFlag == True) that needs a real Boolean, or a
|
|
1912
|
+
Number, Object, List, or Json value.
|
|
1913
|
+
|
|
1914
|
+
The value is a JSON array of objects, each with a "name", a "type", and an optional "value". The "type" is one of
|
|
1915
|
+
Text, Date, DateTime, Money, Ref, Boolean, Number, Object, List, or Json. The JSON type of "value" must match
|
|
1916
|
+
"type": Boolean takes a boolean, Number takes a number, the string types take a string, Object and List take an
|
|
1917
|
+
array, and Json takes an object.
|
|
1918
|
+
|
|
1919
|
+
Example: --context-variables-json
|
|
1920
|
+
'[{"name":"probeGate","type":"Boolean","value":true},{"name":"retryCount","type":"Number","value":3}]'.
|
|
1921
|
+
|
|
1922
|
+
You can pass both --context-variables and --context-variables-json in the same command. When the same variable name
|
|
1923
|
+
appears in both, the --context-variables-json value wins.
|
|
1924
|
+
|
|
1925
|
+
Tip: names follow the same rules as --context-variables. Use the "$Context." prefix for linked context variables,
|
|
1926
|
+
and a bare name for state variables.
|
|
1883
1927
|
|
|
1884
1928
|
ENVIRONMENT VARIABLES
|
|
1885
1929
|
SF_TARGET_ORG Username or alias of your default org. Overrides the target-org configuration variable.
|
|
@@ -1893,7 +1937,7 @@ ERROR CODES
|
|
|
1893
1937
|
PreviewStartFailed (4) Preview session failed to start due to API or network errors.
|
|
1894
1938
|
```
|
|
1895
1939
|
|
|
1896
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
1940
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/preview/start.ts)_
|
|
1897
1941
|
|
|
1898
1942
|
## `sf agent publish authoring-bundle`
|
|
1899
1943
|
|
|
@@ -1957,7 +2001,7 @@ ERROR CODES
|
|
|
1957
2001
|
Failed (1) Compilation errors found in the Agent Script file.
|
|
1958
2002
|
```
|
|
1959
2003
|
|
|
1960
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
2004
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/publish/authoring-bundle.ts)_
|
|
1961
2005
|
|
|
1962
2006
|
## `sf agent test create`
|
|
1963
2007
|
|
|
@@ -2038,7 +2082,7 @@ ERROR CODES
|
|
|
2038
2082
|
DeploymentFailed (4) Deployment failed due to API or network errors.
|
|
2039
2083
|
```
|
|
2040
2084
|
|
|
2041
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
2085
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/test/create.ts)_
|
|
2042
2086
|
|
|
2043
2087
|
## `sf agent test list`
|
|
2044
2088
|
|
|
@@ -2080,7 +2124,7 @@ ERROR CODES
|
|
|
2080
2124
|
Failed (4) Failed to retrieve agent tests due to API or network errors.
|
|
2081
2125
|
```
|
|
2082
2126
|
|
|
2083
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
2127
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/test/list.ts)_
|
|
2084
2128
|
|
|
2085
2129
|
## `sf agent test results`
|
|
2086
2130
|
|
|
@@ -2164,7 +2208,7 @@ ERROR CODES
|
|
|
2164
2208
|
Failed (4) Failed to retrieve results due to API or network errors.
|
|
2165
2209
|
```
|
|
2166
2210
|
|
|
2167
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
2211
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/test/results.ts)_
|
|
2168
2212
|
|
|
2169
2213
|
## `sf agent test resume`
|
|
2170
2214
|
|
|
@@ -2257,7 +2301,7 @@ ERROR CODES
|
|
|
2257
2301
|
OperationFailed (4) Failed to poll test due to API or network errors.
|
|
2258
2302
|
```
|
|
2259
2303
|
|
|
2260
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
2304
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/test/resume.ts)_
|
|
2261
2305
|
|
|
2262
2306
|
## `sf agent test run`
|
|
2263
2307
|
|
|
@@ -2350,7 +2394,7 @@ ERROR CODES
|
|
|
2350
2394
|
OperationFailed (4) Failed to start or poll test due to API or network errors.
|
|
2351
2395
|
```
|
|
2352
2396
|
|
|
2353
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
2397
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/test/run.ts)_
|
|
2354
2398
|
|
|
2355
2399
|
## `sf agent test run-eval`
|
|
2356
2400
|
|
|
@@ -2435,7 +2479,7 @@ ERROR CODES
|
|
|
2435
2479
|
OperationFailed (4) Failed to execute tests due to API or network errors.
|
|
2436
2480
|
```
|
|
2437
2481
|
|
|
2438
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
2482
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/test/run-eval.ts)_
|
|
2439
2483
|
|
|
2440
2484
|
## `sf agent trace delete`
|
|
2441
2485
|
|
|
@@ -2502,7 +2546,7 @@ ERROR CODES
|
|
|
2502
2546
|
Succeeded (0) Traces deleted successfully (or no traces matched).
|
|
2503
2547
|
```
|
|
2504
2548
|
|
|
2505
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
2549
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/trace/delete.ts)_
|
|
2506
2550
|
|
|
2507
2551
|
## `sf agent trace list`
|
|
2508
2552
|
|
|
@@ -2575,7 +2619,7 @@ ERROR CODES
|
|
|
2575
2619
|
Succeeded (0) Trace files listed successfully (or empty list if none found).
|
|
2576
2620
|
```
|
|
2577
2621
|
|
|
2578
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
2622
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/trace/list.ts)_
|
|
2579
2623
|
|
|
2580
2624
|
## `sf agent trace read`
|
|
2581
2625
|
|
|
@@ -2663,7 +2707,7 @@ EXAMPLES
|
|
|
2663
2707
|
$ sf agent trace read --session-id <SESSION_ID> --json
|
|
2664
2708
|
```
|
|
2665
2709
|
|
|
2666
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
2710
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/trace/read.ts)_
|
|
2667
2711
|
|
|
2668
2712
|
## `sf agent validate authoring-bundle`
|
|
2669
2713
|
|
|
@@ -2720,7 +2764,7 @@ ERROR CODES
|
|
|
2720
2764
|
ServerError (3) Validation/compilation API returned HTTP 500. A server error occurred during compilation.
|
|
2721
2765
|
```
|
|
2722
2766
|
|
|
2723
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.
|
|
2767
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/2.2.2/src/commands/agent/validate/authoring-bundle.ts)_
|
|
2724
2768
|
|
|
2725
2769
|
## `sf alias list`
|
|
2726
2770
|
|
|
@@ -2893,7 +2937,7 @@ FLAG DESCRIPTIONS
|
|
|
2893
2937
|
directory.
|
|
2894
2938
|
```
|
|
2895
2939
|
|
|
2896
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/4.
|
|
2940
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/4.2.0/src/commands/apex/get/log.ts)_
|
|
2897
2941
|
|
|
2898
2942
|
## `sf apex get test`
|
|
2899
2943
|
|
|
@@ -2953,7 +2997,7 @@ EXAMPLES
|
|
|
2953
2997
|
me@myorg'
|
|
2954
2998
|
```
|
|
2955
2999
|
|
|
2956
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/4.
|
|
3000
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/4.2.0/src/commands/apex/get/test.ts)_
|
|
2957
3001
|
|
|
2958
3002
|
## `sf apex list log`
|
|
2959
3003
|
|
|
@@ -2993,7 +3037,7 @@ EXAMPLES
|
|
|
2993
3037
|
$ sf apex list log --target-org me@my.org
|
|
2994
3038
|
```
|
|
2995
3039
|
|
|
2996
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/4.
|
|
3040
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/4.2.0/src/commands/apex/list/log.ts)_
|
|
2997
3041
|
|
|
2998
3042
|
## `sf apex run`
|
|
2999
3043
|
|
|
@@ -3001,13 +3045,18 @@ Execute anonymous Apex code entered on the command line or from a local file.
|
|
|
3001
3045
|
|
|
3002
3046
|
```
|
|
3003
3047
|
USAGE
|
|
3004
|
-
$ sf apex run -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-f <value>]
|
|
3048
|
+
$ sf apex run -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-f <value>] [-d
|
|
3049
|
+
NONE|DEBUGONLY|DB|PROFILING|CALLOUT|DETAIL | --category-level <value>...]
|
|
3005
3050
|
|
|
3006
3051
|
FLAGS
|
|
3007
|
-
-
|
|
3008
|
-
|
|
3009
|
-
|
|
3010
|
-
|
|
3052
|
+
-d, --debug-level=<option> Debug level to use for the debug log that's generated in the org.
|
|
3053
|
+
<options: NONE|DEBUGONLY|DB|PROFILING|CALLOUT|DETAIL>
|
|
3054
|
+
-f, --file=<value> Path to a local file that contains Apex code.
|
|
3055
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
3056
|
+
configuration variable is already set.
|
|
3057
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
3058
|
+
--category-level=<value>... Log level for a specific log category in the debug log generated in the org. Use the
|
|
3059
|
+
format: Category=Level.
|
|
3011
3060
|
|
|
3012
3061
|
GLOBAL FLAGS
|
|
3013
3062
|
--flags-dir=<value> Import flag values from a directory.
|
|
@@ -3038,9 +3087,38 @@ EXAMPLES
|
|
|
3038
3087
|
the prompt, start type Apex code and press the Enter key after each line. Press CTRL+D when finished.
|
|
3039
3088
|
|
|
3040
3089
|
$ sf apex run
|
|
3090
|
+
|
|
3091
|
+
Execute the Apex code and generate a debug log with maximum detail:
|
|
3092
|
+
|
|
3093
|
+
$ sf apex run --file ~/test.apex --debug-level DETAIL
|
|
3094
|
+
|
|
3095
|
+
Execute the Apex code and generate a debug log with fine-grained control over specific log categories:
|
|
3096
|
+
|
|
3097
|
+
$ sf apex run --file ~/test.apex --category-level Apex_code=FINEST --category-level Db=FINE
|
|
3098
|
+
|
|
3099
|
+
FLAG DESCRIPTIONS
|
|
3100
|
+
-d, --debug-level=NONE|DEBUGONLY|DB|PROFILING|CALLOUT|DETAIL
|
|
3101
|
+
|
|
3102
|
+
Debug level to use for the debug log that's generated in the org.
|
|
3103
|
+
|
|
3104
|
+
Sets the debug log level for the anonymous Apex execution. Defaults to DEBUGONLY if not specified. Mutually
|
|
3105
|
+
exclusive with --category-level.
|
|
3106
|
+
|
|
3107
|
+
--category-level=<value>...
|
|
3108
|
+
|
|
3109
|
+
Log level for a specific log category in the debug log generated in the org. Use the format: Category=Level.
|
|
3110
|
+
|
|
3111
|
+
Use this flag to set individual log category levels for fine-grained control over the debug log. Use this format:
|
|
3112
|
+
Category=Level, such as Apex_code=FINEST.
|
|
3113
|
+
|
|
3114
|
+
Valid categories: Db, Workflow, Validation, Callout, Apex_code, Apex_profiling, Visualforce, System, Wave, Nba, All.
|
|
3115
|
+
|
|
3116
|
+
Valid levels: NONE, ERROR, WARN, INFO, DEBUG, FINE, FINER, FINEST.
|
|
3117
|
+
|
|
3118
|
+
Can be specified multiple times. Mutually exclusive with --debug-level.
|
|
3041
3119
|
```
|
|
3042
3120
|
|
|
3043
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/4.
|
|
3121
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/4.2.0/src/commands/apex/run.ts)_
|
|
3044
3122
|
|
|
3045
3123
|
## `sf apex run test`
|
|
3046
3124
|
|
|
@@ -3187,7 +3265,7 @@ FLAG DESCRIPTIONS
|
|
|
3187
3265
|
--tests Test1 --tests Test2
|
|
3188
3266
|
```
|
|
3189
3267
|
|
|
3190
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/4.
|
|
3268
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/4.2.0/src/commands/apex/run/test.ts)_
|
|
3191
3269
|
|
|
3192
3270
|
## `sf apex tail log`
|
|
3193
3271
|
|
|
@@ -3230,7 +3308,7 @@ EXAMPLES
|
|
|
3230
3308
|
$ sf apex tail log --color --skip-trace-flag
|
|
3231
3309
|
```
|
|
3232
3310
|
|
|
3233
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/4.
|
|
3311
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/4.2.0/src/commands/apex/tail/log.ts)_
|
|
3234
3312
|
|
|
3235
3313
|
## `sf api request graphql`
|
|
3236
3314
|
|
|
@@ -3424,7 +3502,7 @@ EXAMPLES
|
|
|
3424
3502
|
$ sf autocomplete --refresh-cache
|
|
3425
3503
|
```
|
|
3426
3504
|
|
|
3427
|
-
_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/4.0.
|
|
3505
|
+
_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/4.0.1/src/commands/autocomplete/index.ts)_
|
|
3428
3506
|
|
|
3429
3507
|
## `sf commands`
|
|
3430
3508
|
|
|
@@ -5046,7 +5124,7 @@ EXAMPLES
|
|
|
5046
5124
|
$ sf logic get test --test-run-id <test run id> --result-format junit --target-org my-scratch
|
|
5047
5125
|
```
|
|
5048
5126
|
|
|
5049
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/4.
|
|
5127
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/4.2.0/src/commands/logic/get/test.ts)_
|
|
5050
5128
|
|
|
5051
5129
|
## `sf logic run test`
|
|
5052
5130
|
|
|
@@ -5168,7 +5246,7 @@ FLAG DESCRIPTIONS
|
|
|
5168
5246
|
--tests Test1 --tests Test2
|
|
5169
5247
|
```
|
|
5170
5248
|
|
|
5171
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/4.
|
|
5249
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/4.2.0/src/commands/logic/run/test.ts)_
|
|
5172
5250
|
|
|
5173
5251
|
## `sf org assign permset`
|
|
5174
5252
|
|
|
@@ -9021,7 +9099,7 @@ EXAMPLES
|
|
|
9021
9099
|
$ sf plugins
|
|
9022
9100
|
```
|
|
9023
9101
|
|
|
9024
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/7.0.
|
|
9102
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/7.0.1/src/commands/plugins/index.ts)_
|
|
9025
9103
|
|
|
9026
9104
|
## `sf plugins discover`
|
|
9027
9105
|
|
|
@@ -9066,7 +9144,7 @@ EXAMPLES
|
|
|
9066
9144
|
$ sf plugins inspect @salesforce/plugin-packaging
|
|
9067
9145
|
```
|
|
9068
9146
|
|
|
9069
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/7.0.
|
|
9147
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/7.0.1/src/commands/plugins/inspect.ts)_
|
|
9070
9148
|
|
|
9071
9149
|
## `sf plugins install PLUGIN`
|
|
9072
9150
|
|
|
@@ -9115,7 +9193,7 @@ EXAMPLES
|
|
|
9115
9193
|
$ sf plugins install someuser/someplugin
|
|
9116
9194
|
```
|
|
9117
9195
|
|
|
9118
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/7.0.
|
|
9196
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/7.0.1/src/commands/plugins/install.ts)_
|
|
9119
9197
|
|
|
9120
9198
|
## `sf plugins link PATH`
|
|
9121
9199
|
|
|
@@ -9146,7 +9224,7 @@ EXAMPLES
|
|
|
9146
9224
|
$ sf plugins link @salesforce/plugin-packaging
|
|
9147
9225
|
```
|
|
9148
9226
|
|
|
9149
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/7.0.
|
|
9227
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/7.0.1/src/commands/plugins/link.ts)_
|
|
9150
9228
|
|
|
9151
9229
|
## `sf plugins reset`
|
|
9152
9230
|
|
|
@@ -9161,7 +9239,7 @@ FLAGS
|
|
|
9161
9239
|
--reinstall Reinstall all plugins after uninstalling.
|
|
9162
9240
|
```
|
|
9163
9241
|
|
|
9164
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/7.0.
|
|
9242
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/7.0.1/src/commands/plugins/reset.ts)_
|
|
9165
9243
|
|
|
9166
9244
|
## `sf plugins trust allowlist add`
|
|
9167
9245
|
|
|
@@ -9198,7 +9276,7 @@ EXAMPLES
|
|
|
9198
9276
|
$ sf plugins trust allowlist add --name @scope/my-plugin --name another-plugin
|
|
9199
9277
|
```
|
|
9200
9278
|
|
|
9201
|
-
_See code: [@salesforce/plugin-trust](https://github.com/salesforcecli/plugin-trust/blob/4.0.
|
|
9279
|
+
_See code: [@salesforce/plugin-trust](https://github.com/salesforcecli/plugin-trust/blob/4.0.12/src/commands/plugins/trust/allowlist/add.ts)_
|
|
9202
9280
|
|
|
9203
9281
|
## `sf plugins trust allowlist list`
|
|
9204
9282
|
|
|
@@ -9226,7 +9304,7 @@ EXAMPLES
|
|
|
9226
9304
|
$ sf plugins trust allowlist list
|
|
9227
9305
|
```
|
|
9228
9306
|
|
|
9229
|
-
_See code: [@salesforce/plugin-trust](https://github.com/salesforcecli/plugin-trust/blob/4.0.
|
|
9307
|
+
_See code: [@salesforce/plugin-trust](https://github.com/salesforcecli/plugin-trust/blob/4.0.12/src/commands/plugins/trust/allowlist/list.ts)_
|
|
9230
9308
|
|
|
9231
9309
|
## `sf plugins trust allowlist remove`
|
|
9232
9310
|
|
|
@@ -9263,7 +9341,7 @@ EXAMPLES
|
|
|
9263
9341
|
$ sf plugins trust allowlist remove --name @scope/my-plugin --name another-plugin
|
|
9264
9342
|
```
|
|
9265
9343
|
|
|
9266
|
-
_See code: [@salesforce/plugin-trust](https://github.com/salesforcecli/plugin-trust/blob/4.0.
|
|
9344
|
+
_See code: [@salesforce/plugin-trust](https://github.com/salesforcecli/plugin-trust/blob/4.0.12/src/commands/plugins/trust/allowlist/remove.ts)_
|
|
9267
9345
|
|
|
9268
9346
|
## `sf plugins trust verify`
|
|
9269
9347
|
|
|
@@ -9292,7 +9370,7 @@ EXAMPLES
|
|
|
9292
9370
|
$ sf plugins trust verify --npm @scope/npmName
|
|
9293
9371
|
```
|
|
9294
9372
|
|
|
9295
|
-
_See code: [@salesforce/plugin-trust](https://github.com/salesforcecli/plugin-trust/blob/4.0.
|
|
9373
|
+
_See code: [@salesforce/plugin-trust](https://github.com/salesforcecli/plugin-trust/blob/4.0.12/src/commands/plugins/trust/verify.ts)_
|
|
9296
9374
|
|
|
9297
9375
|
## `sf plugins uninstall [PLUGIN]`
|
|
9298
9376
|
|
|
@@ -9320,7 +9398,7 @@ EXAMPLES
|
|
|
9320
9398
|
$ sf plugins uninstall @salesforce/plugin-packaging
|
|
9321
9399
|
```
|
|
9322
9400
|
|
|
9323
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/7.0.
|
|
9401
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/7.0.1/src/commands/plugins/uninstall.ts)_
|
|
9324
9402
|
|
|
9325
9403
|
## `sf plugins update`
|
|
9326
9404
|
|
|
@@ -9338,7 +9416,7 @@ DESCRIPTION
|
|
|
9338
9416
|
Update installed plugins.
|
|
9339
9417
|
```
|
|
9340
9418
|
|
|
9341
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/7.0.
|
|
9419
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/7.0.1/src/commands/plugins/update.ts)_
|
|
9342
9420
|
|
|
9343
9421
|
## `sf project convert mdapi`
|
|
9344
9422
|
|
|
@@ -11397,7 +11475,7 @@ FLAG DESCRIPTIONS
|
|
|
11397
11475
|
directory.
|
|
11398
11476
|
```
|
|
11399
11477
|
|
|
11400
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.
|
|
11478
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.3.0/src/commands/template/generate/analytics/template.ts)_
|
|
11401
11479
|
|
|
11402
11480
|
## `sf template generate apex class`
|
|
11403
11481
|
|
|
@@ -11459,7 +11537,7 @@ FLAG DESCRIPTIONS
|
|
|
11459
11537
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
11460
11538
|
```
|
|
11461
11539
|
|
|
11462
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.
|
|
11540
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.3.0/src/commands/template/generate/apex/class.ts)_
|
|
11463
11541
|
|
|
11464
11542
|
## `sf template generate apex trigger`
|
|
11465
11543
|
|
|
@@ -11529,7 +11607,7 @@ FLAG DESCRIPTIONS
|
|
|
11529
11607
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
11530
11608
|
```
|
|
11531
11609
|
|
|
11532
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.
|
|
11610
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.3.0/src/commands/template/generate/apex/trigger.ts)_
|
|
11533
11611
|
|
|
11534
11612
|
## `sf template generate digital-experience site`
|
|
11535
11613
|
|
|
@@ -11583,7 +11661,7 @@ FLAG DESCRIPTIONS
|
|
|
11583
11661
|
project, defaults to the current directory.
|
|
11584
11662
|
```
|
|
11585
11663
|
|
|
11586
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.
|
|
11664
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.3.0/src/commands/template/generate/digital-experience/site.ts)_
|
|
11587
11665
|
|
|
11588
11666
|
## `sf template generate flexipage`
|
|
11589
11667
|
|
|
@@ -11665,7 +11743,7 @@ FLAG DESCRIPTIONS
|
|
|
11665
11743
|
'Custom_Object__c'. This sets the `sobjectType` field in the FlexiPage metadata.
|
|
11666
11744
|
```
|
|
11667
11745
|
|
|
11668
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.
|
|
11746
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.3.0/src/commands/template/generate/flexipage/index.ts)_
|
|
11669
11747
|
|
|
11670
11748
|
## `sf template generate lightning app`
|
|
11671
11749
|
|
|
@@ -11723,7 +11801,7 @@ FLAG DESCRIPTIONS
|
|
|
11723
11801
|
field in the DX project's "sfdx-project.json" file.
|
|
11724
11802
|
```
|
|
11725
11803
|
|
|
11726
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.
|
|
11804
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.3.0/src/commands/template/generate/lightning/app.ts)_
|
|
11727
11805
|
|
|
11728
11806
|
## `sf template generate lightning component`
|
|
11729
11807
|
|
|
@@ -11800,7 +11878,7 @@ FLAG DESCRIPTIONS
|
|
|
11800
11878
|
field in the DX project's "sfdx-project.json" file.
|
|
11801
11879
|
```
|
|
11802
11880
|
|
|
11803
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.
|
|
11881
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.3.0/src/commands/template/generate/lightning/component.ts)_
|
|
11804
11882
|
|
|
11805
11883
|
## `sf template generate lightning event`
|
|
11806
11884
|
|
|
@@ -11858,7 +11936,7 @@ FLAG DESCRIPTIONS
|
|
|
11858
11936
|
field in the DX project's "sfdx-project.json" file.
|
|
11859
11937
|
```
|
|
11860
11938
|
|
|
11861
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.
|
|
11939
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.3.0/src/commands/template/generate/lightning/event.ts)_
|
|
11862
11940
|
|
|
11863
11941
|
## `sf template generate lightning interface`
|
|
11864
11942
|
|
|
@@ -11916,7 +11994,7 @@ FLAG DESCRIPTIONS
|
|
|
11916
11994
|
field in the DX project's "sfdx-project.json" file.
|
|
11917
11995
|
```
|
|
11918
11996
|
|
|
11919
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.
|
|
11997
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.3.0/src/commands/template/generate/lightning/interface.ts)_
|
|
11920
11998
|
|
|
11921
11999
|
## `sf template generate lightning test`
|
|
11922
12000
|
|
|
@@ -11974,7 +12052,7 @@ FLAG DESCRIPTIONS
|
|
|
11974
12052
|
field in the DX project's "sfdx-project.json" file.
|
|
11975
12053
|
```
|
|
11976
12054
|
|
|
11977
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.
|
|
12055
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.3.0/src/commands/template/generate/lightning/test.ts)_
|
|
11978
12056
|
|
|
11979
12057
|
## `sf template generate project`
|
|
11980
12058
|
|
|
@@ -12106,7 +12184,7 @@ FLAG DESCRIPTIONS
|
|
|
12106
12184
|
server-side type stripping.
|
|
12107
12185
|
```
|
|
12108
12186
|
|
|
12109
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.
|
|
12187
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.3.0/src/commands/template/generate/project/index.ts)_
|
|
12110
12188
|
|
|
12111
12189
|
## `sf template generate static-resource`
|
|
12112
12190
|
|
|
@@ -12169,7 +12247,7 @@ FLAG DESCRIPTIONS
|
|
|
12169
12247
|
etc.
|
|
12170
12248
|
```
|
|
12171
12249
|
|
|
12172
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.
|
|
12250
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.3.0/src/commands/template/generate/static-resource/index.ts)_
|
|
12173
12251
|
|
|
12174
12252
|
## `sf template generate ui-bundle`
|
|
12175
12253
|
|
|
@@ -12258,7 +12336,86 @@ FLAG DESCRIPTIONS
|
|
|
12258
12336
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
12259
12337
|
```
|
|
12260
12338
|
|
|
12261
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.
|
|
12339
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.3.0/src/commands/template/generate/ui-bundle/index.ts)_
|
|
12340
|
+
|
|
12341
|
+
## `sf template generate ui-embedding`
|
|
12342
|
+
|
|
12343
|
+
Generate a Lightning Web Component (LWC) bundle that wraps the <lightning-ui-embedding> base component.
|
|
12344
|
+
|
|
12345
|
+
```
|
|
12346
|
+
USAGE
|
|
12347
|
+
$ sf template generate ui-embedding -n <value> -s <value> --sandbox
|
|
12348
|
+
allow-forms|allow-modals|allow-orientation-lock|allow-pointer-lock|allow-popups|allow-popups-to-escape-sandbox|allow
|
|
12349
|
+
-presentation|allow-same-origin|allow-scripts|allow-storage-access-by-user-activation|allow-top-navigation|allow-top
|
|
12350
|
+
-navigation-by-user-activation... --title <value> [--json] [--flags-dir <value>] [-d <value>] [--api-version
|
|
12351
|
+
<value>]
|
|
12352
|
+
|
|
12353
|
+
FLAGS
|
|
12354
|
+
-d, --output-dir=<value> [default: .] Directory for saving the created files.
|
|
12355
|
+
-n, --name=<value> (required) Name of the generated component; must be in PascalCase format.
|
|
12356
|
+
-s, --src=<value> (required) Absolute HTTPS URL that the iframe will load.
|
|
12357
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
12358
|
+
--sandbox=<option>... (required) Iframe sandbox token. Specify this flag multiple times to set more than one
|
|
12359
|
+
token.
|
|
12360
|
+
<options: allow-forms|allow-modals|allow-orientation-lock|allow-pointer-lock|allow-popups|a
|
|
12361
|
+
llow-popups-to-escape-sandbox|allow-presentation|allow-same-origin|allow-scripts|allow-stor
|
|
12362
|
+
age-access-by-user-activation|allow-top-navigation|allow-top-navigation-by-user-activation>
|
|
12363
|
+
--title=<value> (required) Accessible title for the embedded iframe.
|
|
12364
|
+
|
|
12365
|
+
GLOBAL FLAGS
|
|
12366
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
12367
|
+
--json Format output as json.
|
|
12368
|
+
|
|
12369
|
+
DESCRIPTION
|
|
12370
|
+
Generate a Lightning Web Component (LWC) bundle that wraps the <lightning-ui-embedding> base component.
|
|
12371
|
+
|
|
12372
|
+
The generated LWC bundle consumes the first-party <lightning-ui-embedding> component, which is pre-wired with the
|
|
12373
|
+
three required attributes: the embedding URL (--src), iframe sandbox tokens, and an accessible iframe title (--title).
|
|
12374
|
+
|
|
12375
|
+
The generated LWC bundle contains four files (.html, .js, .js-meta.xml, .css) in a directory named with the camelCased
|
|
12376
|
+
component name. The bundle must live under a parent folder named "lwc".
|
|
12377
|
+
|
|
12378
|
+
EXAMPLES
|
|
12379
|
+
Generate an embedding wrapper LWC in the current directory:
|
|
12380
|
+
|
|
12381
|
+
$ sf template generate ui-embedding --name MyEmbeddingWrapper --src https://app.example.com --sandbox \
|
|
12382
|
+
allow-forms --title "Expense Report Embedding"
|
|
12383
|
+
|
|
12384
|
+
Generate an embedding wrapper LWC in the "force-app/main/default/lwc" directory with multiple sandbox tokens:
|
|
12385
|
+
|
|
12386
|
+
$ sf template generate ui-embedding --name MyEmbeddingWrapper --src https://app.example.com --sandbox \
|
|
12387
|
+
allow-forms --sandbox allow-scripts --title "Expense Report Embedding" --output-dir force-app/main/default/lwc
|
|
12388
|
+
|
|
12389
|
+
FLAG DESCRIPTIONS
|
|
12390
|
+
-d, --output-dir=<value> Directory for saving the created files.
|
|
12391
|
+
|
|
12392
|
+
The location can be an absolute path or relative to the current working directory. The default is the current
|
|
12393
|
+
directory.
|
|
12394
|
+
|
|
12395
|
+
-n, --name=<value> Name of the generated component; must be in PascalCase format.
|
|
12396
|
+
|
|
12397
|
+
The component name is also used (camelCased) as the LWC folder name and file stem. Must contain only alphanumeric
|
|
12398
|
+
characters and start with a letter.
|
|
12399
|
+
|
|
12400
|
+
-s, --src=<value> Absolute HTTPS URL that the iframe will load.
|
|
12401
|
+
|
|
12402
|
+
The URL is bound to the <lightning-ui-embedding> "src" attribute as a reactive property in the generated LWC. Must
|
|
12403
|
+
use HTTPS; plain HTTP is allowed only for localhost or 127.0.0.1 (for local development).
|
|
12404
|
+
|
|
12405
|
+
--sandbox=allow-forms|allow-modals|allow-orientation-lock|allow-pointer-lock|allow-popups|allow-popups-to-escape-sandbox|allow-presentation|allow-same-origin|allow-scripts|allow-storage-access-by-user-activation|allow-top-navigation|allow-top-navigation-by-user-activation...
|
|
12406
|
+
|
|
12407
|
+
Iframe sandbox token. Specify this flag multiple times to set more than one token.
|
|
12408
|
+
|
|
12409
|
+
Each token is written into the space-separated "sandbox" attribute on <lightning-ui-embedding>. Only W3C-defined
|
|
12410
|
+
sandbox tokens are accepted.
|
|
12411
|
+
|
|
12412
|
+
--title=<value> Accessible title for the embedded iframe.
|
|
12413
|
+
|
|
12414
|
+
Written to the "shell-title" attribute on <lightning-ui-embedding> and used as the iframe's accessible name
|
|
12415
|
+
(announced by screen readers).
|
|
12416
|
+
```
|
|
12417
|
+
|
|
12418
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.3.0/src/commands/template/generate/ui-embedding/index.ts)_
|
|
12262
12419
|
|
|
12263
12420
|
## `sf template generate visualforce component`
|
|
12264
12421
|
|
|
@@ -12315,7 +12472,7 @@ FLAG DESCRIPTIONS
|
|
|
12315
12472
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
12316
12473
|
```
|
|
12317
12474
|
|
|
12318
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.
|
|
12475
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.3.0/src/commands/template/generate/visualforce/component.ts)_
|
|
12319
12476
|
|
|
12320
12477
|
## `sf template generate visualforce page`
|
|
12321
12478
|
|
|
@@ -12366,7 +12523,7 @@ FLAG DESCRIPTIONS
|
|
|
12366
12523
|
The name can be up to 40 characters and must start with a letter.
|
|
12367
12524
|
```
|
|
12368
12525
|
|
|
12369
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.
|
|
12526
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/57.3.0/src/commands/template/generate/visualforce/page.ts)_
|
|
12370
12527
|
|
|
12371
12528
|
## `sf update [CHANNEL]`
|
|
12372
12529
|
|