@salesforce/cli 2.130.5 → 2.130.7

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 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.130.5 linux-x64 node-v22.22.1
28
+ @salesforce/cli/2.130.7 linux-x64 node-v22.22.1
29
29
  $ sf --help [COMMAND]
30
30
  USAGE
31
31
  $ sf COMMAND
@@ -264,9 +264,17 @@ EXAMPLES
264
264
  Activate version 2 of an agent with API name Resort_Manager in the org with alias "my-org":
265
265
 
266
266
  $ sf agent activate --api-name Resort_Manager --version 2 --target-org my-org
267
+
268
+ ENVIRONMENT VARIABLES
269
+ SF_TARGET_ORG Username or alias of your default org. Overrides the target-org configuration variable.
270
+
271
+ ERROR CODES
272
+ Succeeded (0) Agent activated successfully.
273
+ NotFound (2) Agent not found in the org.
274
+ ActivationFailed (4) Failed to activate the agent due to API or network errors.
267
275
  ```
268
276
 
269
- _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.14/src/commands/agent/activate.ts)_
277
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.16/src/commands/agent/activate.ts)_
270
278
 
271
279
  ## `sf agent create`
272
280
 
@@ -333,7 +341,7 @@ EXAMPLES
333
341
  $ sf agent create --name "Resort Manager" --spec specs/resortManagerAgent.yaml --preview
334
342
  ```
335
343
 
336
- _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.14/src/commands/agent/create.ts)_
344
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.16/src/commands/agent/create.ts)_
337
345
 
338
346
  ## `sf agent deactivate`
339
347
 
@@ -372,9 +380,17 @@ EXAMPLES
372
380
  Deactivate the agent Resort_Manager in the org with alias "my_org":
373
381
 
374
382
  $ sf agent deactivate --api-name Resort_Manager --target-org my-org
383
+
384
+ ENVIRONMENT VARIABLES
385
+ SF_TARGET_ORG Username or alias of your default org. Overrides the target-org configuration variable.
386
+
387
+ ERROR CODES
388
+ Succeeded (0) Agent deactivated successfully.
389
+ NotFound (2) Agent not found in the org.
390
+ DeactivationFailed (4) Failed to deactivate the agent due to API or network errors.
375
391
  ```
376
392
 
377
- _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.14/src/commands/agent/deactivate.ts)_
393
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.16/src/commands/agent/deactivate.ts)_
378
394
 
379
395
  ## `sf agent generate agent-spec`
380
396
 
@@ -481,7 +497,7 @@ EXAMPLES
481
497
  $ sf agent generate agent-spec --tone formal --agent-user resortmanager@myorg.com
482
498
  ```
483
499
 
484
- _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.14/src/commands/agent/generate/agent-spec.ts)_
500
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.16/src/commands/agent/generate/agent-spec.ts)_
485
501
 
486
502
  ## `sf agent generate authoring-bundle`
487
503
 
@@ -558,7 +574,7 @@ EXAMPLES
558
574
  other-package-dir/main/default --target-org my-dev-org
559
575
  ```
560
576
 
561
- _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.14/src/commands/agent/generate/authoring-bundle.ts)_
577
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.16/src/commands/agent/generate/authoring-bundle.ts)_
562
578
 
563
579
  ## `sf agent generate template`
564
580
 
@@ -620,7 +636,7 @@ EXAMPLES
620
636
  my-package --source-org my-scratch-org
621
637
  ```
622
638
 
623
- _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.14/src/commands/agent/generate/template.ts)_
639
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.16/src/commands/agent/generate/template.ts)_
624
640
 
625
641
  ## `sf agent generate test-spec`
626
642
 
@@ -685,7 +701,7 @@ EXAMPLES
685
701
  force-app//main/default/aiEvaluationDefinitions/Resort_Manager_Tests.aiEvaluationDefinition-meta.xml
686
702
  ```
687
703
 
688
- _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.14/src/commands/agent/generate/test-spec.ts)_
704
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.16/src/commands/agent/generate/test-spec.ts)_
689
705
 
690
706
  ## `sf agent preview`
691
707
 
@@ -758,7 +774,7 @@ EXAMPLES
758
774
  $ sf agent preview --use-live-actions --apex-debug --output-dir transcripts/my-preview
759
775
  ```
760
776
 
761
- _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.14/src/commands/agent/preview.ts)_
777
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.16/src/commands/agent/preview.ts)_
762
778
 
763
779
  ## `sf agent preview end`
764
780
 
@@ -790,11 +806,11 @@ DESCRIPTION
790
806
  use this command to end it. This command also displays the local directory where the session trace files are stored.
791
807
 
792
808
  The original "agent preview start" command outputs a session ID which you then use with the --session-id flag of this
793
- command to end the session. You don't have to specify the --session-id flag if an agent has only one active preview
809
+ command to end the session. You don't have to specify the --session-id flag if an agent has only one active preview
794
810
  session. You must also use either the --authoring-bundle or --api-name flag to specify the API name of the authoring
795
- bundle or the published agent, respecitvely. To find either API name, navigate to your package directory in your DX
811
+ bundle or the published agent, respecitvely. To find either API name, navigate to your package directory in your DX
796
812
  project. The API name of an authoring bundle is the same as its directory name under the "aiAuthoringBundles" metadata
797
- directory. Similarly, the published agent's API name is the same as its directory name under the "Bots" metadata
813
+ directory. Similarly, the published agent's API name is the same as its directory name under the "Bots" metadata
798
814
  directory.
799
815
 
800
816
  EXAMPLES
@@ -811,9 +827,18 @@ EXAMPLES
811
827
  one active session.
812
828
 
813
829
  $ sf agent preview end --authoring-bundle My_Local_Agent
830
+
831
+ ENVIRONMENT VARIABLES
832
+ SF_TARGET_ORG Username or alias of your default org. Overrides the target-org configuration variable.
833
+
834
+ ERROR CODES
835
+ Succeeded (0) Preview session ended successfully and traces saved.
836
+ NotFound (2) Agent not found, or no preview session exists for this agent.
837
+ PreviewEndFailed (4) Failed to end the preview session.
838
+ SessionAmbiguous (5) Multiple preview sessions found; specify --session-id to choose one.
814
839
  ```
815
840
 
816
- _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.14/src/commands/agent/preview/end.ts)_
841
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.16/src/commands/agent/preview/end.ts)_
817
842
 
818
843
  ## `sf agent preview send`
819
844
 
@@ -846,11 +871,11 @@ DESCRIPTION
846
871
  use this command to send the agent a message (utterance). This command then displays the agent's response.
847
872
 
848
873
  The original "agent preview start" command outputs a session ID which you then use with the --session-id flag of this
849
- command to send a message. You don't have to specify the --session-id flag if an agent has only one active preview
874
+ command to send a message. You don't have to specify the --session-id flag if an agent has only one active preview
850
875
  session. You must also use either the --authoring-bundle or --api-name flag to specify the API name of the authoring
851
- bundle or the published agent, respecitvely. To find either API name, navigate to your package directory in your DX
876
+ bundle or the published agent, respecitvely. To find either API name, navigate to your package directory in your DX
852
877
  project. The API name of an authoring bundle is the same as its directory name under the "aiAuthoringBundles" metadata
853
- directory. Similarly, the published agent's API name is the same as its directory name under the "Bots" metadata
878
+ directory. Similarly, the published agent's API name is the same as its directory name under the "Bots" metadata
854
879
  directory.
855
880
 
856
881
  EXAMPLES
@@ -869,9 +894,18 @@ EXAMPLES
869
894
  active session:
870
895
 
871
896
  $ sf agent preview send --utterance "what can you help me with?" --authoring-bundle My_Local_Agent
897
+
898
+ ENVIRONMENT VARIABLES
899
+ SF_TARGET_ORG Username or alias of your default org. Overrides the target-org configuration variable.
900
+
901
+ ERROR CODES
902
+ Succeeded (0) Message sent successfully and agent response received.
903
+ NotFound (2) Agent not found, or no preview session exists for this agent.
904
+ PreviewSendFailed (4) Failed to send message or receive response from the preview session.
905
+ SessionAmbiguous (5) Multiple preview sessions found; specify --session-id to choose one.
872
906
  ```
873
907
 
874
- _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.14/src/commands/agent/preview/send.ts)_
908
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.16/src/commands/agent/preview/send.ts)_
875
909
 
876
910
  ## `sf agent preview sessions`
877
911
 
@@ -902,9 +936,12 @@ EXAMPLES
902
936
  List all cached agent preview sessions:
903
937
 
904
938
  $ sf agent preview sessions
939
+
940
+ ERROR CODES
941
+ Succeeded (0) Sessions listed successfully (or empty list if no active sessions).
905
942
  ```
906
943
 
907
- _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.14/src/commands/agent/preview/sessions.ts)_
944
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.16/src/commands/agent/preview/sessions.ts)_
908
945
 
909
946
  ## `sf agent preview start`
910
947
 
@@ -913,7 +950,7 @@ Start a programmatic agent preview session.
913
950
  ```
914
951
  USAGE
915
952
  $ sf agent preview start -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-n <value>]
916
- [--authoring-bundle <value>] [--use-live-actions]
953
+ [--authoring-bundle <value>] [--use-live-actions | --simulate-actions]
917
954
 
918
955
  FLAGS
919
956
  -n, --api-name=<value> API name of the activated published agent you want to preview.
@@ -922,8 +959,10 @@ FLAGS
922
959
  --api-version=<value> Override the api version used for api requests made by this command
923
960
  --authoring-bundle=<value> API name of the authoring bundle metadata component that contains the agent's Agent
924
961
  Script file.
925
- --use-live-actions Use real actions in the org; if not specified, preview uses AI to simulate (mock)
926
- actions.
962
+ --simulate-actions Use AI to simulate action execution instead of calling real actions. Required with
963
+ --authoring-bundle.
964
+ --use-live-actions Execute real actions in the org (Apex classes, flows, etc.). Required with
965
+ --authoring-bundle.
927
966
 
928
967
  GLOBAL FLAGS
929
968
  --flags-dir=<value> Import flag values from a directory.
@@ -933,35 +972,52 @@ DESCRIPTION
933
972
  Start a programmatic agent preview session.
934
973
 
935
974
  This command outputs a session ID that you then use with the "agent preview send" command to send an utterance to the
936
- agent. Use the "agent preview sessions" command to list all active sessions and the "agent preview end" command to
937
- end a specific session.
975
+ agent. Use the "agent preview sessions" command to list all active sessions and the "agent preview end" command to end
976
+ a specific session.
938
977
 
939
978
  Identify the agent you want to start previewing with either the --authoring-bundle flag to specify a local authoring
940
- bundle's API name or --api-name to specify an activated published agent's API name. To find either API name, navigate
979
+ bundle's API name or --api-name to specify an activated published agent's API name. To find either API name, navigate
941
980
  to your package directory in your DX project. The API name of an authoring bundle is the same as its directory name
942
- under the "aiAuthoringBundles" metadata directory. Similarly, the published agent's API name is the same as its
981
+ under the "aiAuthoringBundles" metadata directory. Similarly, the published agent's API name is the same as its
943
982
  directory name under the "Bots" metadata directory.
944
983
 
945
- When starting a preview session using the authoring bundle, which contains the agent's Agent Script file, the preview
946
- uses mocked actions by default. Specify --use-live-actions for live mode, which uses the real Apex classes, flows,
947
- etc, in the org for the actions.
984
+ When starting a preview session with --authoring-bundle, you must explicitly specify the execution mode using one of
985
+ these flags:
986
+
987
+ - --use-live-actions: Executes real Apex classes, flows, and other actions in the org. This surfaces compile and
988
+ validation errors during preview.
989
+ - --simulate-actions: Uses AI to simulate action execution without calling real implementations.
990
+
991
+ Published agents (--api-name) always use live actions. The mode flags are optional and have no effect for published
992
+ agents.
948
993
 
949
994
  EXAMPLES
950
- Start a programmatic agent preview session by specifying an authoring bundle; uses mocked actions by default. Use
951
- the org with alias "my-dev-org":
995
+ Start a programmatic agent preview session by specifying an authoring bundle; use simulated actions. Use the org
996
+ with alias "my-dev-org":
952
997
 
953
- $ sf agent preview start --authoring-bundle My_Agent_Bundle --target-org my-dev-org
998
+ $ sf agent preview start --authoring-bundle My_Agent_Bundle --target-org my-dev-org --simulate-actions
954
999
 
955
1000
  Similar to previous example but use live actions and the default org:
956
1001
 
957
1002
  $ sf agent preview start --authoring-bundle My_Agent_Bundle --use-live-actions
958
1003
 
959
- Start a preview session with an activated published agent:
1004
+ Start a preview session with an activated published agent (always uses live actions):
960
1005
 
961
1006
  $ sf agent preview start --api-name My_Published_Agent
1007
+
1008
+ ENVIRONMENT VARIABLES
1009
+ SF_TARGET_ORG Username or alias of your default org. Overrides the target-org configuration variable.
1010
+
1011
+ ERROR CODES
1012
+ Succeeded (0) Preview session started successfully.
1013
+ Failed (1) Agent Script compilation failed (syntax errors in the script).
1014
+ NotFound (2) Agent not found, or compilation API returned HTTP 404 (endpoint may not be available in your
1015
+ org or region).
1016
+ ServerError (3) Compilation API returned HTTP 500 (server error during compilation).
1017
+ PreviewStartFailed (4) Preview session failed to start due to API or network errors.
962
1018
  ```
963
1019
 
964
- _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.14/src/commands/agent/preview/start.ts)_
1020
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.16/src/commands/agent/preview/start.ts)_
965
1021
 
966
1022
  ## `sf agent publish authoring-bundle`
967
1023
 
@@ -1010,7 +1066,7 @@ EXAMPLES
1010
1066
  $ sf agent publish authoring-bundle --api-name MyAuthoringbundle --target-org my-dev-org
1011
1067
  ```
1012
1068
 
1013
- _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.14/src/commands/agent/publish/authoring-bundle.ts)_
1069
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.16/src/commands/agent/publish/authoring-bundle.ts)_
1014
1070
 
1015
1071
  ## `sf agent test create`
1016
1072
 
@@ -1063,9 +1119,18 @@ EXAMPLES
1063
1119
  Preview what the agent test metadata (AiEvaluationDefinition) looks like without deploying it to your default org:
1064
1120
 
1065
1121
  $ sf agent test create --spec specs/Resort_Manager-testSpec.yaml --api-name Resort_Manager_Test --preview
1122
+
1123
+ ENVIRONMENT VARIABLES
1124
+ SF_TARGET_ORG Username or alias of your default org. Overrides the target-org configuration variable.
1125
+
1126
+ ERROR CODES
1127
+ Succeeded (0) Test created and deployed successfully.
1128
+ Failed (1) Test validation errors or metadata format issues.
1129
+ NotFound (2) Test spec file not found or org connection failed.
1130
+ DeploymentFailed (4) Deployment failed due to API or network errors.
1066
1131
  ```
1067
1132
 
1068
- _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.14/src/commands/agent/test/create.ts)_
1133
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.16/src/commands/agent/test/create.ts)_
1069
1134
 
1070
1135
  ## `sf agent test list`
1071
1136
 
@@ -1098,9 +1163,16 @@ EXAMPLES
1098
1163
  List the agent tests in an org with alias "my-org""
1099
1164
 
1100
1165
  $ sf agent test list --target-org my-org
1166
+
1167
+ ENVIRONMENT VARIABLES
1168
+ SF_TARGET_ORG Username or alias of your default org. Overrides the target-org configuration variable.
1169
+
1170
+ ERROR CODES
1171
+ Succeeded (0) Agent tests listed successfully.
1172
+ Failed (4) Failed to retrieve agent tests due to API or network errors.
1101
1173
  ```
1102
1174
 
1103
- _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.14/src/commands/agent/test/list.ts)_
1175
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.16/src/commands/agent/test/list.ts)_
1104
1176
 
1105
1177
  ## `sf agent test results`
1106
1178
 
@@ -1164,9 +1236,17 @@ FLAG DESCRIPTIONS
1164
1236
  The generated data is in JSON format and includes the Apex classes or Flows that were invoked, the Salesforce
1165
1237
  objects that were touched, and so on. Use the JSON structure of this information to build the test case JSONPath
1166
1238
  expression when using custom evaluations.
1239
+
1240
+ ENVIRONMENT VARIABLES
1241
+ SF_TARGET_ORG Username or alias of your default org. Overrides the target-org configuration variable.
1242
+
1243
+ ERROR CODES
1244
+ Succeeded (0) Results retrieved successfully. Test results (passed/failed) are in the output.
1245
+ NotFound (2) Job ID not found or invalid.
1246
+ Failed (4) Failed to retrieve results due to API or network errors.
1167
1247
  ```
1168
1248
 
1169
- _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.14/src/commands/agent/test/results.ts)_
1249
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.16/src/commands/agent/test/results.ts)_
1170
1250
 
1171
1251
  ## `sf agent test resume`
1172
1252
 
@@ -1237,9 +1317,18 @@ FLAG DESCRIPTIONS
1237
1317
  The generated data is in JSON format and includes the Apex classes or Flows that were invoked, the Salesforce
1238
1318
  objects that were touched, and so on. Use the JSON structure of this information to build the test case JSONPath
1239
1319
  expression when using custom evaluations.
1320
+
1321
+ ENVIRONMENT VARIABLES
1322
+ SF_TARGET_ORG Username or alias of your default org. Overrides the target-org configuration variable.
1323
+
1324
+ ERROR CODES
1325
+ Succeeded (0) Test completed successfully (with test results in the output).
1326
+ Failed (1) Tests encountered execution errors (test cases with ERROR status).
1327
+ NotFound (2) Job ID not found or invalid.
1328
+ OperationFailed (4) Failed to poll test due to API or network errors.
1240
1329
  ```
1241
1330
 
1242
- _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.14/src/commands/agent/test/resume.ts)_
1331
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.16/src/commands/agent/test/resume.ts)_
1243
1332
 
1244
1333
  ## `sf agent test run`
1245
1334
 
@@ -1311,9 +1400,18 @@ FLAG DESCRIPTIONS
1311
1400
  The generated data is in JSON format and includes the Apex classes or Flows that were invoked, the Salesforce
1312
1401
  objects that were touched, and so on. Use the JSON structure of this information to build the test case JSONPath
1313
1402
  expression when using custom evaluations.
1403
+
1404
+ ENVIRONMENT VARIABLES
1405
+ SF_TARGET_ORG Username or alias of your default org. Overrides the target-org configuration variable.
1406
+
1407
+ ERROR CODES
1408
+ Succeeded (0) Test started successfully (without --wait), or test completed successfully (with --wait).
1409
+ Failed (1) Tests encountered execution errors (test cases with ERROR status when using --wait).
1410
+ NotFound (2) Test definition not found or invalid test name.
1411
+ OperationFailed (4) Failed to start or poll test due to API or network errors.
1314
1412
  ```
1315
1413
 
1316
- _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.14/src/commands/agent/test/run.ts)_
1414
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.16/src/commands/agent/test/run.ts)_
1317
1415
 
1318
1416
  ## `sf agent validate authoring-bundle`
1319
1417
 
@@ -1358,9 +1456,19 @@ EXAMPLES
1358
1456
  Validate an authoring bundle with API name MyAuthoringBundle; use the org with alias "my-dev-org":
1359
1457
 
1360
1458
  $ sf agent validate authoring-bundle --api-name MyAuthoringBundle --target-org my-dev-org
1459
+
1460
+ ENVIRONMENT VARIABLES
1461
+ SF_TARGET_ORG Username or alias of your default org. Overrides the target-org configuration variable.
1462
+
1463
+ ERROR CODES
1464
+ Succeeded (0) Agent Script file compiled successfully without errors.
1465
+ Failed (1) Compilation errors found in the Agent Script file.
1466
+ NotFound (2) Validation/compilation API returned HTTP 404. The API endpoint may not be available in your org or
1467
+ region.
1468
+ ServerError (3) Validation/compilation API returned HTTP 500. A server error occurred during compilation.
1361
1469
  ```
1362
1470
 
1363
- _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.14/src/commands/agent/validate/authoring-bundle.ts)_
1471
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.32.16/src/commands/agent/validate/authoring-bundle.ts)_
1364
1472
 
1365
1473
  ## `sf alias list`
1366
1474
 
@@ -3973,7 +4081,7 @@ FLAG DESCRIPTIONS
3973
4081
  "agent.user.<GUID>@your-org-domain.com".
3974
4082
  ```
3975
4083
 
3976
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.78/src/commands/org/create/agent-user.ts)_
4084
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.79/src/commands/org/create/agent-user.ts)_
3977
4085
 
3978
4086
  ## `sf org create sandbox`
3979
4087
 
@@ -4107,7 +4215,7 @@ FLAG DESCRIPTIONS
4107
4215
  You can specify either --source-sandbox-name or --source-id when cloning an existing sandbox, but not both.
4108
4216
  ```
4109
4217
 
4110
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.78/src/commands/org/create/sandbox.ts)_
4218
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.79/src/commands/org/create/sandbox.ts)_
4111
4219
 
4112
4220
  ## `sf org create scratch`
4113
4221
 
@@ -4289,7 +4397,7 @@ FLAG DESCRIPTIONS
4289
4397
  Omit this flag to have Salesforce generate a unique username for your org.
4290
4398
  ```
4291
4399
 
4292
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.78/src/commands/org/create/scratch.ts)_
4400
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.79/src/commands/org/create/scratch.ts)_
4293
4401
 
4294
4402
  ## `sf org create user`
4295
4403
 
@@ -4443,7 +4551,7 @@ EXAMPLES
4443
4551
  $ sf org delete sandbox --target-org my-sandbox --no-prompt
4444
4552
  ```
4445
4553
 
4446
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.78/src/commands/org/delete/sandbox.ts)_
4554
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.79/src/commands/org/delete/sandbox.ts)_
4447
4555
 
4448
4556
  ## `sf org delete scratch`
4449
4557
 
@@ -4487,7 +4595,7 @@ EXAMPLES
4487
4595
  $ sf org delete scratch --target-org my-scratch-org --no-prompt
4488
4596
  ```
4489
4597
 
4490
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.78/src/commands/org/delete/scratch.ts)_
4598
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.79/src/commands/org/delete/scratch.ts)_
4491
4599
 
4492
4600
  ## `sf org disable tracking`
4493
4601
 
@@ -4526,7 +4634,7 @@ EXAMPLES
4526
4634
  $ sf org disable tracking
4527
4635
  ```
4528
4636
 
4529
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.78/src/commands/org/disable/tracking.ts)_
4637
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.79/src/commands/org/disable/tracking.ts)_
4530
4638
 
4531
4639
  ## `sf org display`
4532
4640
 
@@ -4571,7 +4679,7 @@ EXAMPLES
4571
4679
  $ sf org display --target-org TestOrg1 --verbose
4572
4680
  ```
4573
4681
 
4574
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.78/src/commands/org/display.ts)_
4682
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.79/src/commands/org/display.ts)_
4575
4683
 
4576
4684
  ## `sf org display user`
4577
4685
 
@@ -4652,7 +4760,7 @@ EXAMPLES
4652
4760
  $ sf org enable tracking
4653
4761
  ```
4654
4762
 
4655
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.78/src/commands/org/enable/tracking.ts)_
4763
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.79/src/commands/org/enable/tracking.ts)_
4656
4764
 
4657
4765
  ## `sf org generate password`
4658
4766
 
@@ -4758,7 +4866,7 @@ EXAMPLES
4758
4866
  $ sf org list --clean
4759
4867
  ```
4760
4868
 
4761
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.78/src/commands/org/list.ts)_
4869
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.79/src/commands/org/list.ts)_
4762
4870
 
4763
4871
  ## `sf org list auth`
4764
4872
 
@@ -4897,7 +5005,7 @@ FLAG DESCRIPTIONS
4897
5005
  Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.
4898
5006
  ```
4899
5007
 
4900
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.78/src/commands/org/list/metadata.ts)_
5008
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.79/src/commands/org/list/metadata.ts)_
4901
5009
 
4902
5010
  ## `sf org list metadata-types`
4903
5011
 
@@ -4952,7 +5060,7 @@ FLAG DESCRIPTIONS
4952
5060
  Override the api version used for api requests made by this command
4953
5061
  ```
4954
5062
 
4955
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.78/src/commands/org/list/metadata-types.ts)_
5063
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.79/src/commands/org/list/metadata-types.ts)_
4956
5064
 
4957
5065
  ## `sf org list sobject record-counts`
4958
5066
 
@@ -5498,7 +5606,7 @@ EXAMPLES
5498
5606
  $ sf org open --source-file force-app/main/default/bots/Coral_Cloud_Agent/Coral_Cloud_Agent.bot-meta.xml
5499
5607
  ```
5500
5608
 
5501
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.78/src/commands/org/open.ts)_
5609
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.79/src/commands/org/open.ts)_
5502
5610
 
5503
5611
  ## `sf org open agent`
5504
5612
 
@@ -5549,7 +5657,7 @@ EXAMPLES
5549
5657
  $ sf org open agent --target-org MyTestOrg1 --browser firefox --api-name Coral_Cloud_Agent
5550
5658
  ```
5551
5659
 
5552
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.78/src/commands/org/open/agent.ts)_
5660
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.79/src/commands/org/open/agent.ts)_
5553
5661
 
5554
5662
  ## `sf org open authoring-bundle`
5555
5663
 
@@ -5595,7 +5703,7 @@ EXAMPLES
5595
5703
  $ sf org open authoring-bundle --target-org MyTestOrg1 --browser firefox
5596
5704
  ```
5597
5705
 
5598
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.78/src/commands/org/open/authoring-bundle.ts)_
5706
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.79/src/commands/org/open/authoring-bundle.ts)_
5599
5707
 
5600
5708
  ## `sf org refresh sandbox`
5601
5709
 
@@ -5698,7 +5806,7 @@ FLAG DESCRIPTIONS
5698
5806
  You can specify either --source-sandbox-name or --source-id when refreshing an existing sandbox, but not both.
5699
5807
  ```
5700
5808
 
5701
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.78/src/commands/org/refresh/sandbox.ts)_
5809
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.79/src/commands/org/refresh/sandbox.ts)_
5702
5810
 
5703
5811
  ## `sf org resume sandbox`
5704
5812
 
@@ -5761,7 +5869,7 @@ FLAG DESCRIPTIONS
5761
5869
  returns the job ID. To resume checking the sandbox creation, rerun this command.
5762
5870
  ```
5763
5871
 
5764
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.78/src/commands/org/resume/sandbox.ts)_
5872
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.79/src/commands/org/resume/sandbox.ts)_
5765
5873
 
5766
5874
  ## `sf org resume scratch`
5767
5875
 
@@ -5814,7 +5922,7 @@ FLAG DESCRIPTIONS
5814
5922
  returns the job ID. To resume checking the scratch creation, rerun this command.
5815
5923
  ```
5816
5924
 
5817
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.78/src/commands/org/resume/scratch.ts)_
5925
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.79/src/commands/org/resume/scratch.ts)_
5818
5926
 
5819
5927
  ## `sf package convert`
5820
5928
 
@@ -9773,7 +9881,7 @@ FLAG DESCRIPTIONS
9773
9881
  directory.
9774
9882
  ```
9775
9883
 
9776
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/analytics/template.ts)_
9884
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.15.2/src/commands/template/generate/analytics/template.ts)_
9777
9885
 
9778
9886
  ## `sf template generate apex class`
9779
9887
 
@@ -9833,7 +9941,7 @@ FLAG DESCRIPTIONS
9833
9941
  Supplied parameter values or default values are filled into a copy of the template.
9834
9942
  ```
9835
9943
 
9836
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/apex/class.ts)_
9944
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.15.2/src/commands/template/generate/apex/class.ts)_
9837
9945
 
9838
9946
  ## `sf template generate apex trigger`
9839
9947
 
@@ -9903,7 +10011,7 @@ FLAG DESCRIPTIONS
9903
10011
  Supplied parameter values or default values are filled into a copy of the template.
9904
10012
  ```
9905
10013
 
9906
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/apex/trigger.ts)_
10014
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.15.2/src/commands/template/generate/apex/trigger.ts)_
9907
10015
 
9908
10016
  ## `sf template generate digital-experience site`
9909
10017
 
@@ -9957,7 +10065,7 @@ FLAG DESCRIPTIONS
9957
10065
  project, defaults to the current directory.
9958
10066
  ```
9959
10067
 
9960
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/digital-experience/site.ts)_
10068
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.15.2/src/commands/template/generate/digital-experience/site.ts)_
9961
10069
 
9962
10070
  ## `sf template generate flexipage`
9963
10071
 
@@ -10039,7 +10147,7 @@ FLAG DESCRIPTIONS
10039
10147
  'Custom_Object__c'. This sets the `sobjectType` field in the FlexiPage metadata.
10040
10148
  ```
10041
10149
 
10042
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/flexipage/index.ts)_
10150
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.15.2/src/commands/template/generate/flexipage/index.ts)_
10043
10151
 
10044
10152
  ## `sf template generate lightning app`
10045
10153
 
@@ -10092,10 +10200,12 @@ FLAG DESCRIPTIONS
10092
10200
 
10093
10201
  -t, --template=DefaultLightningApp Template to use for file creation.
10094
10202
 
10095
- Supplied parameter values or default values are filled into a copy of the template.
10203
+ Supplied parameter values or default values are filled into a copy of the template. For Lightning Web Components, if
10204
+ this flag isn't specified, the CLI command automatically selects the template based on the "defaultLwcLanguage"
10205
+ field in the DX project's "sfdx-project.json" file.
10096
10206
  ```
10097
10207
 
10098
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/lightning/app.ts)_
10208
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.15.2/src/commands/template/generate/lightning/app.ts)_
10099
10209
 
10100
10210
  ## `sf template generate lightning component`
10101
10211
 
@@ -10104,13 +10214,14 @@ Generate a bundle for an Aura component or a Lightning web component.
10104
10214
  ```
10105
10215
  USAGE
10106
10216
  $ sf template generate lightning component -n <value> [--json] [--flags-dir <value>] [-t
10107
- default|analyticsDashboard|analyticsDashboardWithStep] [-d <value>] [--api-version <value>] [--type aura|lwc]
10217
+ default|analyticsDashboard|analyticsDashboardWithStep|typescript] [-d <value>] [--api-version <value>] [--type
10218
+ aura|lwc]
10108
10219
 
10109
10220
  FLAGS
10110
10221
  -d, --output-dir=<value> [default: .] Directory for saving the created files.
10111
10222
  -n, --name=<value> (required) Name of the generated Lightning Component.
10112
10223
  -t, --template=<option> [default: default] Template to use for file creation.
10113
- <options: default|analyticsDashboard|analyticsDashboardWithStep>
10224
+ <options: default|analyticsDashboard|analyticsDashboardWithStep|typescript>
10114
10225
  --api-version=<value> Override the api version used for api requests made by this command
10115
10226
  --type=<option> [default: aura] Type of the component bundle.
10116
10227
  <options: aura|lwc>
@@ -10150,6 +10261,10 @@ EXAMPLES
10150
10261
 
10151
10262
  $ sf template generate lightning component --name mycomponent --type lwc --output-dir force-app/main/default/lwc
10152
10263
 
10264
+ Generate a TypeScript Lightning Web Component:
10265
+
10266
+ $ sf template generate lightning component --name mycomponent --type lwc --template typescript
10267
+
10153
10268
  FLAG DESCRIPTIONS
10154
10269
  -d, --output-dir=<value> Directory for saving the created files.
10155
10270
 
@@ -10160,12 +10275,14 @@ FLAG DESCRIPTIONS
10160
10275
 
10161
10276
  The name can be up to 40 characters and must start with a letter.
10162
10277
 
10163
- -t, --template=default|analyticsDashboard|analyticsDashboardWithStep Template to use for file creation.
10278
+ -t, --template=default|analyticsDashboard|analyticsDashboardWithStep|typescript Template to use for file creation.
10164
10279
 
10165
- Supplied parameter values or default values are filled into a copy of the template.
10280
+ Supplied parameter values or default values are filled into a copy of the template. For Lightning Web Components, if
10281
+ this flag isn't specified, the CLI command automatically selects the template based on the "defaultLwcLanguage"
10282
+ field in the DX project's "sfdx-project.json" file.
10166
10283
  ```
10167
10284
 
10168
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/lightning/component.ts)_
10285
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.15.2/src/commands/template/generate/lightning/component.ts)_
10169
10286
 
10170
10287
  ## `sf template generate lightning event`
10171
10288
 
@@ -10218,10 +10335,12 @@ FLAG DESCRIPTIONS
10218
10335
 
10219
10336
  -t, --template=DefaultLightningEvt Template to use for file creation.
10220
10337
 
10221
- Supplied parameter values or default values are filled into a copy of the template.
10338
+ Supplied parameter values or default values are filled into a copy of the template. For Lightning Web Components, if
10339
+ this flag isn't specified, the CLI command automatically selects the template based on the "defaultLwcLanguage"
10340
+ field in the DX project's "sfdx-project.json" file.
10222
10341
  ```
10223
10342
 
10224
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/lightning/event.ts)_
10343
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.15.2/src/commands/template/generate/lightning/event.ts)_
10225
10344
 
10226
10345
  ## `sf template generate lightning interface`
10227
10346
 
@@ -10274,10 +10393,12 @@ FLAG DESCRIPTIONS
10274
10393
 
10275
10394
  -t, --template=DefaultLightningIntf Template to use for file creation.
10276
10395
 
10277
- Supplied parameter values or default values are filled into a copy of the template.
10396
+ Supplied parameter values or default values are filled into a copy of the template. For Lightning Web Components, if
10397
+ this flag isn't specified, the CLI command automatically selects the template based on the "defaultLwcLanguage"
10398
+ field in the DX project's "sfdx-project.json" file.
10278
10399
  ```
10279
10400
 
10280
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/lightning/interface.ts)_
10401
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.15.2/src/commands/template/generate/lightning/interface.ts)_
10281
10402
 
10282
10403
  ## `sf template generate lightning test`
10283
10404
 
@@ -10330,10 +10451,12 @@ FLAG DESCRIPTIONS
10330
10451
 
10331
10452
  -t, --template=DefaultLightningTest Template to use for file creation.
10332
10453
 
10333
- Supplied parameter values or default values are filled into a copy of the template.
10454
+ Supplied parameter values or default values are filled into a copy of the template. For Lightning Web Components, if
10455
+ this flag isn't specified, the CLI command automatically selects the template based on the "defaultLwcLanguage"
10456
+ field in the DX project's "sfdx-project.json" file.
10334
10457
  ```
10335
10458
 
10336
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/lightning/test.ts)_
10459
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.15.2/src/commands/template/generate/lightning/test.ts)_
10337
10460
 
10338
10461
  ## `sf template generate project`
10339
10462
 
@@ -10343,7 +10466,7 @@ Generate a Salesforce DX project.
10343
10466
  USAGE
10344
10467
  $ sf template generate project -n <value> [--json] [--flags-dir <value>] [-t
10345
10468
  standard|empty|analytics|reactinternalapp|reactexternalapp|agent] [-d <value>] [-s <value>] [-p <value>] [-x]
10346
- [--api-version <value>]
10469
+ [--lwc-language javascript|typescript] [--api-version <value>]
10347
10470
 
10348
10471
  FLAGS
10349
10472
  -d, --output-dir=<value> [default: .] Directory for saving the created files.
@@ -10354,6 +10477,8 @@ FLAGS
10354
10477
  <options: standard|empty|analytics|reactinternalapp|reactexternalapp|agent>
10355
10478
  -x, --manifest Generate a manifest (package.xml) for change-set based development.
10356
10479
  --api-version=<value> Will set this version as sourceApiVersion in the sfdx-project.json file
10480
+ --lwc-language=<option> Language of the Lightning Web Components. If not specified, "javascript" is used.
10481
+ <options: javascript|typescript>
10357
10482
 
10358
10483
  GLOBAL FLAGS
10359
10484
  --flags-dir=<value> Import flag values from a directory.
@@ -10391,6 +10516,10 @@ EXAMPLES
10391
10516
 
10392
10517
  $ sf template generate project --name mywork --template empty
10393
10518
 
10519
+ Generate a project in which the Lightning Web Components use TypeScript rather than the default JavaScript:
10520
+
10521
+ $ sf template generate project --name mywork --lwc-language typescript
10522
+
10394
10523
  FLAG DESCRIPTIONS
10395
10524
  -d, --output-dir=<value> Directory for saving the created files.
10396
10525
 
@@ -10444,9 +10573,16 @@ FLAG DESCRIPTIONS
10444
10573
  --api-version=<value> Will set this version as sourceApiVersion in the sfdx-project.json file
10445
10574
 
10446
10575
  Override the api version used for api requests made by this command
10576
+
10577
+ --lwc-language=javascript|typescript Language of the Lightning Web Components. If not specified, "javascript" is used.
10578
+
10579
+ When set to `'typescript'`, generates TypeScript configuration files (tsconfig.json, package.json with TypeScript
10580
+ dependencies, and TypeScript-aware ESLint config). When you deploy the TypeScript-based Lightning Web Components,
10581
+ the TypeScript files are first compiled locally for validation and then the `.ts` files are deployed to your org for
10582
+ server-side type stripping.
10447
10583
  ```
10448
10584
 
10449
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/project/index.ts)_
10585
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.15.2/src/commands/template/generate/project/index.ts)_
10450
10586
 
10451
10587
  ## `sf template generate static-resource`
10452
10588
 
@@ -10509,11 +10645,11 @@ FLAG DESCRIPTIONS
10509
10645
  etc.
10510
10646
  ```
10511
10647
 
10512
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/static-resource/index.ts)_
10648
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.15.2/src/commands/template/generate/static-resource/index.ts)_
10513
10649
 
10514
10650
  ## `sf template generate ui-bundle`
10515
10651
 
10516
- Generate a UI bundle.
10652
+ Generate a UI bundle, which contains the code and metadata to build a UI experience that uses non-native Salesforce frameworks, such as React.
10517
10653
 
10518
10654
  ```
10519
10655
  USAGE
@@ -10521,10 +10657,10 @@ USAGE
10521
10657
  [--api-version <value>]
10522
10658
 
10523
10659
  FLAGS
10524
- -d, --output-dir=<value> Directory for saving the created files.
10660
+ -d, --output-dir=<value> Directory into which the files are created.
10525
10661
  -l, --label=<value> Master label for the UI bundle.
10526
- -n, --name=<value> (required) Name of the generated UI bundle.
10527
- -t, --template=<option> [default: default] Template to use for file creation.
10662
+ -n, --name=<value> (required) API name of the generated UI bundle.
10663
+ -t, --template=<option> [default: default] Template to use when creating the files for a specific UI framework.
10528
10664
  <options: default|reactbasic>
10529
10665
  --api-version=<value> Override the api version used for api requests made by this command
10530
10666
 
@@ -10533,15 +10669,20 @@ GLOBAL FLAGS
10533
10669
  --json Format output as json.
10534
10670
 
10535
10671
  DESCRIPTION
10536
- Generate a UI bundle.
10672
+ Generate a UI bundle, which contains the code and metadata to build a UI experience that uses non-native Salesforce
10673
+ frameworks, such as React.
10537
10674
 
10538
- Generates a UI bundle in the specified directory or the current working directory. The UI bundle files are created in
10539
- a folder with the designated name. UI bundle files must be contained in a parent directory called "uiBundles" in your
10540
- package directory. Either run this command from an existing directory of this name, or use the --output-dir flag to
10541
- create one or point to an existing one.
10675
+ Salesforce provides native UI frameworks, such as Lighting Web Components (LWC), to build applications that run on the
10676
+ Salesforce Platform. But you can also use non-native JavaScript- or TypeScript-based UI frameworks, such as React, to
10677
+ build a UI experience for the Salesforce Platform and that you can launch from the App Launcher.
10542
10678
 
10543
- ALIASES
10544
- $ sf ui-bundle generate
10679
+ These non-native UI experiences are defined by the "UIBundle" metadata type in your DX project. Use this command to
10680
+ generate the required DX project structure and files. For example, when you run this command and specify the name
10681
+ MyUiBundle, then the files are generated into a "uiBundles/MyUiBundle" directory. Use the --output-dir flag to specify
10682
+ a different directory.
10683
+
10684
+ Use the --template flag for generating the files to get started with a speciic UI framework, such as React. Check out
10685
+ the README.md file in the generated "uiBundles/<bundlename>" directory for more information about the template.
10545
10686
 
10546
10687
  EXAMPLES
10547
10688
  Generate a UI bundle called MyUiBundle in the current directory:
@@ -10552,17 +10693,21 @@ EXAMPLES
10552
10693
 
10553
10694
  $ sf template generate ui-bundle --name MyReactApp --template reactbasic
10554
10695
 
10555
- Generate the UI bundle in the "force-app/main/default/uiBundles" directory:
10696
+ Generate the React-based UI bundle in the "force-app/main/default/uiBundles" directory:
10556
10697
 
10557
- $ sf template generate ui-bundle --name MyUiBundle --output-dir force-app/main/default/uiBundles
10698
+ $ sf template generate ui-bundle --name MyUiBundle --template reactbasic --output-dir \
10699
+ force-app/main/default/uiBundles
10558
10700
 
10559
10701
  FLAG DESCRIPTIONS
10560
- -d, --output-dir=<value> Directory for saving the created files.
10702
+ -d, --output-dir=<value> Directory into which the files are created.
10561
10703
 
10562
10704
  The location can be an absolute path or relative to the current working directory.
10563
10705
 
10564
- **Important:** The generator automatically ensures the output directory ends with "uiBundles". If your specified
10565
- path doesn't end with "uiBundles", it's automatically appended. The UI bundle is created at "<output-dir>/<name>".
10706
+ If not specified, the command reads your sfdx-project.json and defaults to "uiBundles" directory within your default
10707
+ package directory. When running outside a Salesforce DX project, defaults to the current directory.
10708
+
10709
+ **Important:** This command automatically ensures the output directory ends with "uiBundles". If your specified path
10710
+ doesn't end with "uiBundles", it's automatically appended. The UI bundle is created at "<output-dir>/<name>".
10566
10711
 
10567
10712
  **Examples:**
10568
10713
 
@@ -10570,24 +10715,21 @@ FLAG DESCRIPTIONS
10570
10715
  - "--output-dir force-app/main/default/uiBundles" → Creates a UI bundle at
10571
10716
  "force-app/main/default/uiBundles/MyUiBundle/" (no change)
10572
10717
 
10573
- If not specified, the command reads your sfdx-project.json and defaults to "uiBundles" directory within your default
10574
- package directory. When running outside a Salesforce DX project, defaults to the current directory.
10575
-
10576
10718
  -l, --label=<value> Master label for the UI bundle.
10577
10719
 
10578
10720
  If not specified, the label is derived from the name.
10579
10721
 
10580
- -n, --name=<value> Name of the generated UI bundle.
10722
+ -n, --name=<value> API name of the generated UI bundle.
10581
10723
 
10582
10724
  This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin
10583
10725
  with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.
10584
10726
 
10585
- -t, --template=default|reactbasic Template to use for file creation.
10727
+ -t, --template=default|reactbasic Template to use when creating the files for a specific UI framework.
10586
10728
 
10587
10729
  Supplied parameter values or default values are filled into a copy of the template.
10588
10730
  ```
10589
10731
 
10590
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/ui-bundle/index.ts)_
10732
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.15.2/src/commands/template/generate/ui-bundle/index.ts)_
10591
10733
 
10592
10734
  ## `sf template generate visualforce component`
10593
10735
 
@@ -10644,7 +10786,7 @@ FLAG DESCRIPTIONS
10644
10786
  Supplied parameter values or default values are filled into a copy of the template.
10645
10787
  ```
10646
10788
 
10647
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/visualforce/component.ts)_
10789
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.15.2/src/commands/template/generate/visualforce/component.ts)_
10648
10790
 
10649
10791
  ## `sf template generate visualforce page`
10650
10792
 
@@ -10695,7 +10837,7 @@ FLAG DESCRIPTIONS
10695
10837
  The name can be up to 40 characters and must start with a letter.
10696
10838
  ```
10697
10839
 
10698
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.13.1/src/commands/template/generate/visualforce/page.ts)_
10840
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.15.2/src/commands/template/generate/visualforce/page.ts)_
10699
10841
 
10700
10842
  ## `sf update [CHANNEL]`
10701
10843