@salesforce/cli 2.123.0 → 2.124.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/README.md +1225 -952
  2. package/npm-shrinkwrap.json +385 -408
  3. package/oclif.lock +421 -427
  4. package/oclif.manifest.json +1 -1
  5. package/package.json +21 -21
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.123.0 linux-x64 node-v22.22.0
28
+ @salesforce/cli/2.124.0 linux-x64 node-v22.22.0
29
29
  $ sf --help [COMMAND]
30
30
  USAGE
31
31
  $ sf COMMAND
@@ -50,6 +50,10 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI.
50
50
  - [`sf agent generate template`](#sf-agent-generate-template)
51
51
  - [`sf agent generate test-spec`](#sf-agent-generate-test-spec)
52
52
  - [`sf agent preview`](#sf-agent-preview)
53
+ - [`sf agent preview end`](#sf-agent-preview-end)
54
+ - [`sf agent preview send`](#sf-agent-preview-send)
55
+ - [`sf agent preview sessions`](#sf-agent-preview-sessions)
56
+ - [`sf agent preview start`](#sf-agent-preview-start)
53
57
  - [`sf agent publish authoring-bundle`](#sf-agent-publish-authoring-bundle)
54
58
  - [`sf agent test create`](#sf-agent-test-create)
55
59
  - [`sf agent test list`](#sf-agent-test-list)
@@ -60,9 +64,6 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI.
60
64
  - [`sf alias list`](#sf-alias-list)
61
65
  - [`sf alias set`](#sf-alias-set)
62
66
  - [`sf alias unset`](#sf-alias-unset)
63
- - [`sf analytics generate template`](#sf-analytics-generate-template)
64
- - [`sf apex generate class`](#sf-apex-generate-class)
65
- - [`sf apex generate trigger`](#sf-apex-generate-trigger)
66
67
  - [`sf apex get log`](#sf-apex-get-log)
67
68
  - [`sf apex get test`](#sf-apex-get-test)
68
69
  - [`sf apex list log`](#sf-apex-list-log)
@@ -104,11 +105,6 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI.
104
105
  - [`sf force data bulk upsert`](#sf-force-data-bulk-upsert)
105
106
  - [`sf help [COMMAND]`](#sf-help-command)
106
107
  - [`sf info releasenotes display`](#sf-info-releasenotes-display)
107
- - [`sf lightning generate app`](#sf-lightning-generate-app)
108
- - [`sf lightning generate component`](#sf-lightning-generate-component)
109
- - [`sf lightning generate event`](#sf-lightning-generate-event)
110
- - [`sf lightning generate interface`](#sf-lightning-generate-interface)
111
- - [`sf lightning generate test`](#sf-lightning-generate-test)
112
108
  - [`sf logic get test`](#sf-logic-get-test)
113
109
  - [`sf logic run test`](#sf-logic-run-test)
114
110
  - [`sf org assign permset`](#sf-org-assign-permset)
@@ -191,7 +187,6 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI.
191
187
  - [`sf project deploy resume`](#sf-project-deploy-resume)
192
188
  - [`sf project deploy start`](#sf-project-deploy-start)
193
189
  - [`sf project deploy validate`](#sf-project-deploy-validate)
194
- - [`sf project generate`](#sf-project-generate)
195
190
  - [`sf project generate manifest`](#sf-project-generate-manifest)
196
191
  - [`sf project list ignored`](#sf-project-list-ignored)
197
192
  - [`sf project reset tracking`](#sf-project-reset-tracking)
@@ -204,11 +199,21 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI.
204
199
  - [`sf search`](#sf-search)
205
200
  - [`sf sobject describe`](#sf-sobject-describe)
206
201
  - [`sf sobject list`](#sf-sobject-list)
207
- - [`sf static-resource generate`](#sf-static-resource-generate)
202
+ - [`sf template generate analytics template`](#sf-template-generate-analytics-template)
203
+ - [`sf template generate apex class`](#sf-template-generate-apex-class)
204
+ - [`sf template generate apex trigger`](#sf-template-generate-apex-trigger)
205
+ - [`sf template generate digital-experience site`](#sf-template-generate-digital-experience-site)
206
+ - [`sf template generate lightning app`](#sf-template-generate-lightning-app)
207
+ - [`sf template generate lightning component`](#sf-template-generate-lightning-component)
208
+ - [`sf template generate lightning event`](#sf-template-generate-lightning-event)
209
+ - [`sf template generate lightning interface`](#sf-template-generate-lightning-interface)
210
+ - [`sf template generate lightning test`](#sf-template-generate-lightning-test)
211
+ - [`sf template generate project`](#sf-template-generate-project)
212
+ - [`sf template generate static-resource`](#sf-template-generate-static-resource)
213
+ - [`sf template generate visualforce component`](#sf-template-generate-visualforce-component)
214
+ - [`sf template generate visualforce page`](#sf-template-generate-visualforce-page)
208
215
  - [`sf update [CHANNEL]`](#sf-update-channel)
209
216
  - [`sf version`](#sf-version)
210
- - [`sf visualforce generate component`](#sf-visualforce-generate-component)
211
- - [`sf visualforce generate page`](#sf-visualforce-generate-page)
212
217
  - [`sf which`](#sf-which)
213
218
 
214
219
  ## `sf agent activate`
@@ -248,7 +253,7 @@ EXAMPLES
248
253
  $ sf agent activate --api-name Resort_Manager --target-org my-org
249
254
  ```
250
255
 
251
- _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.27.5/src/commands/agent/activate.ts)_
256
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.29.0/src/commands/agent/activate.ts)_
252
257
 
253
258
  ## `sf agent create`
254
259
 
@@ -315,7 +320,7 @@ EXAMPLES
315
320
  $ sf agent create --name "Resort Manager" --spec specs/resortManagerAgent.yaml --preview
316
321
  ```
317
322
 
318
- _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.27.5/src/commands/agent/create.ts)_
323
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.29.0/src/commands/agent/create.ts)_
319
324
 
320
325
  ## `sf agent deactivate`
321
326
 
@@ -355,7 +360,7 @@ EXAMPLES
355
360
  $ sf agent deactivate --api-name Resort_Manager --target-org my-org
356
361
  ```
357
362
 
358
- _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.27.5/src/commands/agent/deactivate.ts)_
363
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.29.0/src/commands/agent/deactivate.ts)_
359
364
 
360
365
  ## `sf agent generate agent-spec`
361
366
 
@@ -462,7 +467,7 @@ EXAMPLES
462
467
  $ sf agent generate agent-spec --tone formal --agent-user resortmanager@myorg.com
463
468
  ```
464
469
 
465
- _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.27.5/src/commands/agent/generate/agent-spec.ts)_
470
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.29.0/src/commands/agent/generate/agent-spec.ts)_
466
471
 
467
472
  ## `sf agent generate authoring-bundle`
468
473
 
@@ -537,7 +542,7 @@ EXAMPLES
537
542
  other-package-dir/main/default --target-org my-dev-org
538
543
  ```
539
544
 
540
- _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.27.5/src/commands/agent/generate/authoring-bundle.ts)_
545
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.29.0/src/commands/agent/generate/authoring-bundle.ts)_
541
546
 
542
547
  ## `sf agent generate template`
543
548
 
@@ -585,7 +590,7 @@ EXAMPLES
585
590
  force-app/main/default/bots/My_Awesome_Agent/My_Awesome_Agent.bot-meta.xml --agent-version 1
586
591
  ```
587
592
 
588
- _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.27.5/src/commands/agent/generate/template.ts)_
593
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.29.0/src/commands/agent/generate/template.ts)_
589
594
 
590
595
  ## `sf agent generate test-spec`
591
596
 
@@ -646,7 +651,7 @@ EXAMPLES
646
651
  force-app//main/default/aiEvaluationDefinitions/Resort_Manager_Tests.aiEvaluationDefinition-meta.xml
647
652
  ```
648
653
 
649
- _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.27.5/src/commands/agent/generate/test-spec.ts)_
654
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.29.0/src/commands/agent/generate/test-spec.ts)_
650
655
 
651
656
  ## `sf agent preview`
652
657
 
@@ -659,7 +664,7 @@ USAGE
659
664
 
660
665
  FLAGS
661
666
  -d, --output-dir=<value> Directory where conversation transcripts are saved.
662
- -n, --api-name=<value> API name of the published and active agent you want to interact with.
667
+ -n, --api-name=<value> API name of the activated published agent you want to interact with.
663
668
  -o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
664
669
  configuration variable is already set.
665
670
  -x, --apex-debug Enable Apex debug logging during the agent preview conversation.
@@ -719,7 +724,210 @@ EXAMPLES
719
724
  $ sf agent preview --use-live-actions --apex-debug --output-dir transcripts/my-preview
720
725
  ```
721
726
 
722
- _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.27.5/src/commands/agent/preview.ts)_
727
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.29.0/src/commands/agent/preview.ts)_
728
+
729
+ ## `sf agent preview end`
730
+
731
+ End an existing programmatic agent preview session and get trace location.
732
+
733
+ ```
734
+ USAGE
735
+ $ sf agent preview end -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [--session-id <value>] [-n
736
+ <value>] [--authoring-bundle <value>]
737
+
738
+ FLAGS
739
+ -n, --api-name=<value> API name of the activated published agent you want to preview.
740
+ -o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
741
+ configuration variable is already set.
742
+ --api-version=<value> Override the api version used for api requests made by this command
743
+ --authoring-bundle=<value> API name of the authoring bundle metadata component that contains the agent's Agent
744
+ Script file.
745
+ --session-id=<value> Session ID outputted by "agent preview start". Not required when the agent has exactly
746
+ one active session. Run "agent preview sessions" to see the list of all sessions.
747
+
748
+ GLOBAL FLAGS
749
+ --flags-dir=<value> Import flag values from a directory.
750
+ --json Format output as json.
751
+
752
+ DESCRIPTION
753
+ End an existing programmatic agent preview session and get trace location.
754
+
755
+ You must have previously started a programmatic agent preview session with the "agent preview start" command to then
756
+ use this command to end it. This command also displays the local directory where the session trace files are stored.
757
+
758
+ The original "agent preview start" command outputs a session ID which you then use with the --session-id flag of this
759
+ command to end the session. You don't have to specify the --session-id flag if an agent has only one active preview
760
+ session. You must also use either the --authoring-bundle or --api-name flag to specify the API name of the authoring
761
+ bundle or the published agent, respecitvely. To find either API name, navigate to your package directory in your DX
762
+ project. The API name of an authoring bundle is the same as its directory name under the "aiAuthoringBundles" metadata
763
+ directory. Similarly, the published agent's API name is the same as its directory name under the "Bots" metadata
764
+ directory.
765
+
766
+ EXAMPLES
767
+ End a preview session of a published agent by specifying its session ID and API name ; use the default org:
768
+
769
+ $ sf agent preview end --session-id <SESSION_ID> --api-name My_Published_Agent
770
+
771
+ Similar to previous example, but don't specify a session ID; you get an error if the published agent has more than
772
+ one active session. Use the org with alias "my-dev-org":
773
+
774
+ $ sf agent preview end --api-name My_Published_Agent --target-org my-dev-org
775
+
776
+ End a preview session of an agent using its authoring bundle API name; you get an error if the agent has more than
777
+ one active session.
778
+
779
+ $ sf agent preview end --authoring-bundle My_Local_Agent
780
+ ```
781
+
782
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.29.0/src/commands/agent/preview/end.ts)_
783
+
784
+ ## `sf agent preview send`
785
+
786
+ Send a message to an existing agent preview session.
787
+
788
+ ```
789
+ USAGE
790
+ $ sf agent preview send -o <value> -u <value> [--json] [--flags-dir <value>] [--api-version <value>] [--session-id
791
+ <value>] [-n <value>] [--authoring-bundle <value>]
792
+
793
+ FLAGS
794
+ -n, --api-name=<value> API name of the activated published agent you want to preview.
795
+ -o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
796
+ configuration variable is already set.
797
+ -u, --utterance=<value> (required) Utterance to send to the agent, enclosed in double quotes.
798
+ --api-version=<value> Override the api version used for api requests made by this command
799
+ --authoring-bundle=<value> API name of the authoring bundle metadata component that contains the agent's Agent
800
+ Script file.
801
+ --session-id=<value> Session ID outputted by "agent preview start". Not required when the agent has exactly
802
+ one active session. Run "agent preview sessions" to see list of all sessions.
803
+
804
+ GLOBAL FLAGS
805
+ --flags-dir=<value> Import flag values from a directory.
806
+ --json Format output as json.
807
+
808
+ DESCRIPTION
809
+ Send a message to an existing agent preview session.
810
+
811
+ You must have previously started a programmatic agent preview session with the "agent preview start" command to then
812
+ use this command to send the agent a message (utterance). This command then displays the agent's response.
813
+
814
+ The original "agent preview start" command outputs a session ID which you then use with the --session-id flag of this
815
+ command to send a message. You don't have to specify the --session-id flag if an agent has only one active preview
816
+ session. You must also use either the --authoring-bundle or --api-name flag to specify the API name of the authoring
817
+ bundle or the published agent, respecitvely. To find either API name, navigate to your package directory in your DX
818
+ project. The API name of an authoring bundle is the same as its directory name under the "aiAuthoringBundles" metadata
819
+ directory. Similarly, the published agent's API name is the same as its directory name under the "Bots" metadata
820
+ directory.
821
+
822
+ EXAMPLES
823
+ Send a message to an activated published agent using its API name and session ID; use the default org:
824
+
825
+ $ sf agent preview send --utterance "What can you help me with?" --api-name My_Published_Agent --session-id \
826
+ <SESSION_ID>
827
+
828
+ Similar to previous example, but don't specify a session ID; you get an error if the agent has more than one active
829
+ session. Use the org with alias "my-dev-org":
830
+
831
+ $ sf agent preview send --utterance "What can you help me with?" --api-name My_Published_Agent --target-org \
832
+ my-dev-org
833
+
834
+ Send a message to an agent using its authoring bundle API name; you get an error if the agent has more than one
835
+ active session:
836
+
837
+ $ sf agent preview send --utterance "what can you help me with?" --authoring-bundle My_Local_Agent
838
+ ```
839
+
840
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.29.0/src/commands/agent/preview/send.ts)_
841
+
842
+ ## `sf agent preview sessions`
843
+
844
+ List all known programmatic agent preview sessions.
845
+
846
+ ```
847
+ USAGE
848
+ $ sf agent preview sessions [--json] [--flags-dir <value>]
849
+
850
+ GLOBAL FLAGS
851
+ --flags-dir=<value> Import flag values from a directory.
852
+ --json Format output as json.
853
+
854
+ DESCRIPTION
855
+ List all known programmatic agent preview sessions.
856
+
857
+ This command lists the agent preview sessions that were started with the "agent preview start" command and are still
858
+ in the local cache. Use this command to discover specific session IDs that you can pass to the "agent preview send" or
859
+ "agent preview end" commands with the --session-id flag.
860
+
861
+ Programmatic agent preview sessions can be started for both published activated agents and by using an agent's local
862
+ authoring bundle, which contains its Agent Script file. In this command's output table, the Agent column contains
863
+ either the API name of the authoring bundle or the published agent, whichever was used when starting the session. In
864
+ the table, if the same API name has multiple rows with different session IDs, then it means that you previously
865
+ started multiple preview sessions with the associated agent.
866
+
867
+ EXAMPLES
868
+ List all cached agent preview sessions:
869
+
870
+ $ sf agent preview sessions
871
+ ```
872
+
873
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.29.0/src/commands/agent/preview/sessions.ts)_
874
+
875
+ ## `sf agent preview start`
876
+
877
+ Start a programmatic agent preview session.
878
+
879
+ ```
880
+ USAGE
881
+ $ sf agent preview start -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-n <value>]
882
+ [--authoring-bundle <value>] [--use-live-actions]
883
+
884
+ FLAGS
885
+ -n, --api-name=<value> API name of the activated published agent you want to preview.
886
+ -o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
887
+ configuration variable is already set.
888
+ --api-version=<value> Override the api version used for api requests made by this command
889
+ --authoring-bundle=<value> API name of the authoring bundle metadata component that contains the agent's Agent
890
+ Script file.
891
+ --use-live-actions Use real actions in the org; if not specified, preview uses AI to simulate (mock)
892
+ actions.
893
+
894
+ GLOBAL FLAGS
895
+ --flags-dir=<value> Import flag values from a directory.
896
+ --json Format output as json.
897
+
898
+ DESCRIPTION
899
+ Start a programmatic agent preview session.
900
+
901
+ This command outputs a session ID that you then use with the "agent preview send" command to send an utterance to the
902
+ agent. Use the "agent preview sessions" command to list all active sessions and the "agent preview end" command to
903
+ end a specific session.
904
+
905
+ Identify the agent you want to start previewing with either the --authoring-bundle flag to specify a local authoring
906
+ bundle's API name or --api-name to specify an activated published agent's API name. To find either API name, navigate
907
+ to your package directory in your DX project. The API name of an authoring bundle is the same as its directory name
908
+ under the "aiAuthoringBundles" metadata directory. Similarly, the published agent's API name is the same as its
909
+ directory name under the "Bots" metadata directory.
910
+
911
+ When starting a preview session using the authoring bundle, which contains the agent's Agent Script file, the preview
912
+ uses mocked actions by default. Specify --use-live-actions for live mode, which uses the real Apex classes, flows,
913
+ etc, in the org for the actions.
914
+
915
+ EXAMPLES
916
+ Start a programmatic agent preview session by specifying an authoring bundle; uses mocked actions by default. Use
917
+ the org with alias "my-dev-org":
918
+
919
+ $ sf agent preview start --authoring-bundle My_Agent_Bundle --target-org my-dev-org
920
+
921
+ Similar to previous example but use live actions and the default org:
922
+
923
+ $ sf agent preview start --authoring-bundle My_Agent_Bundle --use-live-actions
924
+
925
+ Start a preview session with an activated published agent:
926
+
927
+ $ sf agent preview start --api-name My_Published_Agent
928
+ ```
929
+
930
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.29.0/src/commands/agent/preview/start.ts)_
723
931
 
724
932
  ## `sf agent publish authoring-bundle`
725
933
 
@@ -768,7 +976,7 @@ EXAMPLES
768
976
  $ sf agent publish authoring-bundle --api-name MyAuthoringbundle --target-org my-dev-org
769
977
  ```
770
978
 
771
- _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.27.5/src/commands/agent/publish/authoring-bundle.ts)_
979
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.29.0/src/commands/agent/publish/authoring-bundle.ts)_
772
980
 
773
981
  ## `sf agent test create`
774
982
 
@@ -823,7 +1031,7 @@ EXAMPLES
823
1031
  $ sf agent test create --spec specs/Resort_Manager-testSpec.yaml --api-name Resort_Manager_Test --preview
824
1032
  ```
825
1033
 
826
- _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.27.5/src/commands/agent/test/create.ts)_
1034
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.29.0/src/commands/agent/test/create.ts)_
827
1035
 
828
1036
  ## `sf agent test list`
829
1037
 
@@ -858,7 +1066,7 @@ EXAMPLES
858
1066
  $ sf agent test list --target-org my-org
859
1067
  ```
860
1068
 
861
- _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.27.5/src/commands/agent/test/list.ts)_
1069
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.29.0/src/commands/agent/test/list.ts)_
862
1070
 
863
1071
  ## `sf agent test results`
864
1072
 
@@ -924,7 +1132,7 @@ FLAG DESCRIPTIONS
924
1132
  expression when using custom evaluations.
925
1133
  ```
926
1134
 
927
- _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.27.5/src/commands/agent/test/results.ts)_
1135
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.29.0/src/commands/agent/test/results.ts)_
928
1136
 
929
1137
  ## `sf agent test resume`
930
1138
 
@@ -997,7 +1205,7 @@ FLAG DESCRIPTIONS
997
1205
  expression when using custom evaluations.
998
1206
  ```
999
1207
 
1000
- _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.27.5/src/commands/agent/test/resume.ts)_
1208
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.29.0/src/commands/agent/test/resume.ts)_
1001
1209
 
1002
1210
  ## `sf agent test run`
1003
1211
 
@@ -1071,7 +1279,7 @@ FLAG DESCRIPTIONS
1071
1279
  expression when using custom evaluations.
1072
1280
  ```
1073
1281
 
1074
- _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.27.5/src/commands/agent/test/run.ts)_
1282
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.29.0/src/commands/agent/test/run.ts)_
1075
1283
 
1076
1284
  ## `sf agent validate authoring-bundle`
1077
1285
 
@@ -1118,7 +1326,7 @@ EXAMPLES
1118
1326
  $ sf agent validate authoring-bundle --api-name MyAuthoringBundle --target-org my-dev-org
1119
1327
  ```
1120
1328
 
1121
- _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.27.5/src/commands/agent/validate/authoring-bundle.ts)_
1329
+ _See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.29.0/src/commands/agent/validate/authoring-bundle.ts)_
1122
1330
 
1123
1331
  ## `sf alias list`
1124
1332
 
@@ -1146,7 +1354,7 @@ EXAMPLES
1146
1354
  $ sf alias list
1147
1355
  ```
1148
1356
 
1149
- _See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.54/src/commands/alias/list.ts)_
1357
+ _See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.56/src/commands/alias/list.ts)_
1150
1358
 
1151
1359
  ## `sf alias set`
1152
1360
 
@@ -1195,7 +1403,7 @@ EXAMPLES
1195
1403
  $ sf alias set my-scratch-org test-ss0xut7txzxf@example.com
1196
1404
  ```
1197
1405
 
1198
- _See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.54/src/commands/alias/set.ts)_
1406
+ _See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.56/src/commands/alias/set.ts)_
1199
1407
 
1200
1408
  ## `sf alias unset`
1201
1409
 
@@ -1235,19 +1443,23 @@ EXAMPLES
1235
1443
  $ sf alias unset --all [--no-prompt]
1236
1444
  ```
1237
1445
 
1238
- _See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.54/src/commands/alias/unset.ts)_
1446
+ _See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.56/src/commands/alias/unset.ts)_
1239
1447
 
1240
- ## `sf analytics generate template`
1448
+ ## `sf apex get log`
1241
1449
 
1242
- Generate a simple Analytics template.
1450
+ Fetch the specified log or given number of most recent logs from the org.
1243
1451
 
1244
1452
  ```
1245
1453
  USAGE
1246
- $ sf analytics generate template -n <value> [--json] [--flags-dir <value>] [-d <value>] [--api-version <value>]
1454
+ $ sf apex get log -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-i <value>] [-n <value>]
1455
+ [-d <value>]
1247
1456
 
1248
1457
  FLAGS
1249
- -d, --output-dir=<value> [default: .] Directory for saving the created files.
1250
- -n, --name=<value> (required) Name of the Analytics template.
1458
+ -d, --output-dir=<value> Directory for saving the log files.
1459
+ -i, --log-id=<value> ID of the specific log to display.
1460
+ -n, --number=<value> Number of the most recent logs to display.
1461
+ -o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
1462
+ configuration variable is already set.
1251
1463
  --api-version=<value> Override the api version used for api requests made by this command
1252
1464
 
1253
1465
  GLOBAL FLAGS
@@ -1255,108 +1467,111 @@ GLOBAL FLAGS
1255
1467
  --json Format output as json.
1256
1468
 
1257
1469
  DESCRIPTION
1258
- Generate a simple Analytics template.
1470
+ Fetch the specified log or given number of most recent logs from the org.
1259
1471
 
1260
- The metadata files associated with the Analytics template must be contained in a parent directory called
1261
- "waveTemplates" in your package directory. Either run this command from an existing directory of this name, or use the
1262
- --output-dir flag to generate one or point to an existing one.
1472
+ To get the IDs for your debug logs, run "sf apex log list". Executing this command without flags returns the most
1473
+ recent log.
1263
1474
 
1264
1475
  ALIASES
1265
- $ sf force analytics template create
1476
+ $ sf force apex log get
1266
1477
 
1267
1478
  EXAMPLES
1268
- Generate the metadata files for a simple Analytics template file called myTemplate in the
1269
- force-app/main/default/waveTemplates directory:
1479
+ Fetch the log in your default org using an ID:
1480
+
1481
+ $ sf apex get log --log-id <log id>
1482
+
1483
+ Fetch the log in the org with the specified username using an ID:
1484
+
1485
+ $ sf apex get log --log-id <log id> --target-org me@my.org
1486
+
1487
+ Fetch the two most recent logs in your default org:
1488
+
1489
+ $ sf apex get log --number 2
1270
1490
 
1271
- $ sf analytics generate template --name myTemplate --output-dir force-app/main/default/waveTemplates
1491
+ Similar to previous example, but save the two log files in the specified directory:
1492
+
1493
+ $ sf apex get log --output-dir /Users/sfdxUser/logs --number 2
1272
1494
 
1273
1495
  FLAG DESCRIPTIONS
1274
- -d, --output-dir=<value> Directory for saving the created files.
1496
+ -d, --output-dir=<value> Directory for saving the log files.
1275
1497
 
1276
1498
  The location can be an absolute path or relative to the current working directory. The default is the current
1277
1499
  directory.
1278
1500
  ```
1279
1501
 
1280
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.4.7/src/commands/analytics/generate/template.ts)_
1502
+ _See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.7/src/commands/apex/get/log.ts)_
1281
1503
 
1282
- ## `sf apex generate class`
1504
+ ## `sf apex get test`
1283
1505
 
1284
- Generate an Apex class.
1506
+ Display test results for a specific asynchronous test run.
1285
1507
 
1286
1508
  ```
1287
1509
  USAGE
1288
- $ sf apex generate class -n <value> [--json] [--flags-dir <value>] [-t
1289
- ApexException|ApexUnitTest|BasicUnitTest|DefaultApexClass|InboundEmailService] [-d <value>] [--api-version <value>]
1510
+ $ sf apex get test -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>]
1511
+ [--detailed-coverage -c] [-d <value>] [-r human|tap|junit|json] [--concise]
1290
1512
 
1291
1513
  FLAGS
1292
- -d, --output-dir=<value> [default: .] Directory for saving the created files.
1293
- -n, --name=<value> (required) Name of the generated Apex class.
1294
- -t, --template=<option> [default: DefaultApexClass] Template to use for file creation.
1295
- <options: ApexException|ApexUnitTest|BasicUnitTest|DefaultApexClass|InboundEmailService>
1296
- --api-version=<value> Override the api version used for api requests made by this command
1514
+ -c, --code-coverage Retrieve code coverage results.
1515
+ -d, --output-dir=<value> Directory in which to store test result files.
1516
+ -i, --test-run-id=<value> (required) ID of the test run.
1517
+ -o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
1518
+ configuration variable is already set.
1519
+ -r, --result-format=<option> [default: human] Format of the test results.
1520
+ <options: human|tap|junit|json>
1521
+ --api-version=<value> Override the api version used for api requests made by this command
1522
+ --concise Display only failed test results; works with human-readable output only.
1523
+ --detailed-coverage Display detailed code coverage per test.
1297
1524
 
1298
1525
  GLOBAL FLAGS
1299
1526
  --flags-dir=<value> Import flag values from a directory.
1300
1527
  --json Format output as json.
1301
1528
 
1302
1529
  DESCRIPTION
1303
- Generate an Apex class.
1530
+ Display test results for a specific asynchronous test run.
1304
1531
 
1305
- Generates the Apex *.cls file and associated metadata file. These files must be contained in a parent directory called
1306
- "classes" in your package directory. Either run this command from an existing directory of this name, or use the
1307
- --output-dir flag to generate one or point to an existing one.
1532
+ Provide a test run ID to display test results for an enqueued or completed asynchronous test run. The test run ID is
1533
+ displayed after running the "sf apex test run" command.
1534
+
1535
+ To see code coverage results, use the --code-coverage flag with --result-format. The output displays a high-level
1536
+ summary of the test run and the code coverage values for classes in your org. If you specify human-readable result
1537
+ format, use the --detailed-coverage flag to see detailed coverage results for each test method run.
1308
1538
 
1309
1539
  ALIASES
1310
- $ sf force apex class create
1540
+ $ sf force apex test report
1311
1541
 
1312
1542
  EXAMPLES
1313
- Generate two metadata files associated with the MyClass Apex class (MyClass.cls and MyClass.cls-meta.xml) in the
1314
- current directory:
1315
-
1316
- $ sf apex generate class --name MyClass
1317
-
1318
- Similar to previous example, but generates the files in the "force-app/main/default/classes" directory:
1319
-
1320
- $ sf apex generate class --name MyClass --output-dir force-app/main/default/classes
1543
+ Display test results for your default org using a test run ID:
1321
1544
 
1322
- FLAG DESCRIPTIONS
1323
- -d, --output-dir=<value> Directory for saving the created files.
1545
+ $ sf apex get test --test-run-id <test run id>
1324
1546
 
1325
- The location can be an absolute path or relative to the current working directory. The default is the current
1326
- directory.
1547
+ Similar to previous example, but output the result in JUnit format:
1327
1548
 
1328
- -n, --name=<value> Name of the generated Apex class.
1549
+ $ sf apex get test --test-run-id <test run id> --result-format junit
1329
1550
 
1330
- The name can be up to 40 characters and must start with a letter.
1551
+ Also retrieve code coverage results and output in JSON format:
1331
1552
 
1332
- -t, --template=ApexException|ApexUnitTest|BasicUnitTest|DefaultApexClass|InboundEmailService
1553
+ $ sf apex get test --test-run-id <test run id> --code-coverage --json
1333
1554
 
1334
- Template to use for file creation.
1555
+ Specify a directory in which to save the test results from the org with the specified username (rather than your
1556
+ default org):
1335
1557
 
1336
- Supplied parameter values or default values are filled into a copy of the template.
1558
+ $ sf apex get test --test-run-id <test run id> --code-coverage --output-dir <path to outputdir> --target-org \
1559
+ me@myorg'
1337
1560
  ```
1338
1561
 
1339
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.4.7/src/commands/apex/generate/class.ts)_
1562
+ _See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.7/src/commands/apex/get/test.ts)_
1340
1563
 
1341
- ## `sf apex generate trigger`
1564
+ ## `sf apex list log`
1342
1565
 
1343
- Generate an Apex trigger.
1566
+ Display a list of IDs and general information about debug logs.
1344
1567
 
1345
1568
  ```
1346
1569
  USAGE
1347
- $ sf apex generate trigger -n <value> [--json] [--flags-dir <value>] [-t ApexTrigger] [-d <value>] [--api-version
1348
- <value>] [-s <value>] [-e before insert|before update|before delete|after insert|after update|after delete|after
1349
- undelete...]
1570
+ $ sf apex list log -o <value> [--json] [--flags-dir <value>] [--api-version <value>]
1350
1571
 
1351
1572
  FLAGS
1352
- -d, --output-dir=<value> [default: .] Directory for saving the created files.
1353
- -e, --event=<option>... [default: before insert] Events that fire the trigger.
1354
- <options: before insert|before update|before delete|after insert|after update|after
1355
- delete|after undelete>
1356
- -n, --name=<value> (required) Name of the generated Apex trigger
1357
- -s, --sobject=<value> [default: SOBJECT] Salesforce object to generate a trigger on.
1358
- -t, --template=<option> [default: ApexTrigger] Template to use for file creation.
1359
- <options: ApexTrigger>
1573
+ -o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
1574
+ configuration variable is already set.
1360
1575
  --api-version=<value> Override the api version used for api requests made by this command
1361
1576
 
1362
1577
  GLOBAL FLAGS
@@ -1364,212 +1579,35 @@ GLOBAL FLAGS
1364
1579
  --json Format output as json.
1365
1580
 
1366
1581
  DESCRIPTION
1367
- Generate an Apex trigger.
1582
+ Display a list of IDs and general information about debug logs.
1368
1583
 
1369
- Generates the Apex trigger *.trigger file and associated metadata file. These files must be contained in a parent
1370
- directory called "triggers" in your package directory. Either run this command from an existing directory of this
1371
- name, or use the --output-dir flag to generate one or point to an existing one.
1584
+ Run this command in a project to list the IDs and general information for all debug logs in your default org.
1372
1585
 
1373
- If you don't specify the --sobject flag, the .trigger file contains the generic placeholder SOBJECT; replace it with
1374
- the Salesforce object you want to generate a trigger for. If you don't specify --event, "before insert" is used.
1586
+ To fetch a specific log from your org, obtain the ID from this command's output, then run the “sf apex log get”
1587
+ command.
1375
1588
 
1376
1589
  ALIASES
1377
- $ sf force apex trigger create
1590
+ $ sf force apex log list
1378
1591
 
1379
1592
  EXAMPLES
1380
- Generate two files associated with the MyTrigger Apex trigger (MyTrigger.trigger and MyTrigger.trigger-meta.xml) in
1381
- the current directory:
1382
-
1383
- $ sf apex generate trigger --name MyTrigger
1593
+ List the IDs and information about the debug logs in your default org:
1384
1594
 
1385
- Similar to the previous example, but generate the files in the "force-app/main/default/triggers" directory:
1595
+ $ sf apex list log
1386
1596
 
1387
- $ sf apex generate trigger --name MyTrigger --output-dir force-app/main/default/triggers
1597
+ Similar to previous example, but use the org with the specified username:
1388
1598
 
1389
- Generate files for a trigger that fires on the Account object before and after an insert:
1599
+ $ sf apex list log --target-org me@my.org
1600
+ ```
1390
1601
 
1391
- $ sf apex generate trigger --name MyTrigger --sobject Account --event "before insert,after insert"
1602
+ _See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.7/src/commands/apex/list/log.ts)_
1392
1603
 
1393
- FLAG DESCRIPTIONS
1394
- -d, --output-dir=<value> Directory for saving the created files.
1604
+ ## `sf apex run`
1395
1605
 
1396
- The location can be an absolute path or relative to the current working directory. The default is the current
1397
- directory.
1606
+ Execute anonymous Apex code entered on the command line or from a local file.
1398
1607
 
1399
- -n, --name=<value> Name of the generated Apex trigger
1400
-
1401
- The name can be up to 40 characters and must start with a letter.
1402
-
1403
- -t, --template=ApexTrigger Template to use for file creation.
1404
-
1405
- Supplied parameter values or default values are filled into a copy of the template.
1406
- ```
1407
-
1408
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.4.7/src/commands/apex/generate/trigger.ts)_
1409
-
1410
- ## `sf apex get log`
1411
-
1412
- Fetch the specified log or given number of most recent logs from the org.
1413
-
1414
- ```
1415
- USAGE
1416
- $ sf apex get log -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-i <value>] [-n <value>]
1417
- [-d <value>]
1418
-
1419
- FLAGS
1420
- -d, --output-dir=<value> Directory for saving the log files.
1421
- -i, --log-id=<value> ID of the specific log to display.
1422
- -n, --number=<value> Number of the most recent logs to display.
1423
- -o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
1424
- configuration variable is already set.
1425
- --api-version=<value> Override the api version used for api requests made by this command
1426
-
1427
- GLOBAL FLAGS
1428
- --flags-dir=<value> Import flag values from a directory.
1429
- --json Format output as json.
1430
-
1431
- DESCRIPTION
1432
- Fetch the specified log or given number of most recent logs from the org.
1433
-
1434
- To get the IDs for your debug logs, run "sf apex log list". Executing this command without flags returns the most
1435
- recent log.
1436
-
1437
- ALIASES
1438
- $ sf force apex log get
1439
-
1440
- EXAMPLES
1441
- Fetch the log in your default org using an ID:
1442
-
1443
- $ sf apex get log --log-id <log id>
1444
-
1445
- Fetch the log in the org with the specified username using an ID:
1446
-
1447
- $ sf apex get log --log-id <log id> --target-org me@my.org
1448
-
1449
- Fetch the two most recent logs in your default org:
1450
-
1451
- $ sf apex get log --number 2
1452
-
1453
- Similar to previous example, but save the two log files in the specified directory:
1454
-
1455
- $ sf apex get log --output-dir /Users/sfdxUser/logs --number 2
1456
-
1457
- FLAG DESCRIPTIONS
1458
- -d, --output-dir=<value> Directory for saving the log files.
1459
-
1460
- The location can be an absolute path or relative to the current working directory. The default is the current
1461
- directory.
1462
- ```
1463
-
1464
- _See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.5/src/commands/apex/get/log.ts)_
1465
-
1466
- ## `sf apex get test`
1467
-
1468
- Display test results for a specific asynchronous test run.
1469
-
1470
- ```
1471
- USAGE
1472
- $ sf apex get test -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>]
1473
- [--detailed-coverage -c] [-d <value>] [-r human|tap|junit|json] [--concise]
1474
-
1475
- FLAGS
1476
- -c, --code-coverage Retrieve code coverage results.
1477
- -d, --output-dir=<value> Directory in which to store test result files.
1478
- -i, --test-run-id=<value> (required) ID of the test run.
1479
- -o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
1480
- configuration variable is already set.
1481
- -r, --result-format=<option> [default: human] Format of the test results.
1482
- <options: human|tap|junit|json>
1483
- --api-version=<value> Override the api version used for api requests made by this command
1484
- --concise Display only failed test results; works with human-readable output only.
1485
- --detailed-coverage Display detailed code coverage per test.
1486
-
1487
- GLOBAL FLAGS
1488
- --flags-dir=<value> Import flag values from a directory.
1489
- --json Format output as json.
1490
-
1491
- DESCRIPTION
1492
- Display test results for a specific asynchronous test run.
1493
-
1494
- Provide a test run ID to display test results for an enqueued or completed asynchronous test run. The test run ID is
1495
- displayed after running the "sf apex test run" command.
1496
-
1497
- To see code coverage results, use the --code-coverage flag with --result-format. The output displays a high-level
1498
- summary of the test run and the code coverage values for classes in your org. If you specify human-readable result
1499
- format, use the --detailed-coverage flag to see detailed coverage results for each test method run.
1500
-
1501
- ALIASES
1502
- $ sf force apex test report
1503
-
1504
- EXAMPLES
1505
- Display test results for your default org using a test run ID:
1506
-
1507
- $ sf apex get test --test-run-id <test run id>
1508
-
1509
- Similar to previous example, but output the result in JUnit format:
1510
-
1511
- $ sf apex get test --test-run-id <test run id> --result-format junit
1512
-
1513
- Also retrieve code coverage results and output in JSON format:
1514
-
1515
- $ sf apex get test --test-run-id <test run id> --code-coverage --json
1516
-
1517
- Specify a directory in which to save the test results from the org with the specified username (rather than your
1518
- default org):
1519
-
1520
- $ sf apex get test --test-run-id <test run id> --code-coverage --output-dir <path to outputdir> --target-org \
1521
- me@myorg'
1522
- ```
1523
-
1524
- _See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.5/src/commands/apex/get/test.ts)_
1525
-
1526
- ## `sf apex list log`
1527
-
1528
- Display a list of IDs and general information about debug logs.
1529
-
1530
- ```
1531
- USAGE
1532
- $ sf apex list log -o <value> [--json] [--flags-dir <value>] [--api-version <value>]
1533
-
1534
- FLAGS
1535
- -o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
1536
- configuration variable is already set.
1537
- --api-version=<value> Override the api version used for api requests made by this command
1538
-
1539
- GLOBAL FLAGS
1540
- --flags-dir=<value> Import flag values from a directory.
1541
- --json Format output as json.
1542
-
1543
- DESCRIPTION
1544
- Display a list of IDs and general information about debug logs.
1545
-
1546
- Run this command in a project to list the IDs and general information for all debug logs in your default org.
1547
-
1548
- To fetch a specific log from your org, obtain the ID from this command's output, then run the “sf apex log get”
1549
- command.
1550
-
1551
- ALIASES
1552
- $ sf force apex log list
1553
-
1554
- EXAMPLES
1555
- List the IDs and information about the debug logs in your default org:
1556
-
1557
- $ sf apex list log
1558
-
1559
- Similar to previous example, but use the org with the specified username:
1560
-
1561
- $ sf apex list log --target-org me@my.org
1562
- ```
1563
-
1564
- _See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.5/src/commands/apex/list/log.ts)_
1565
-
1566
- ## `sf apex run`
1567
-
1568
- Execute anonymous Apex code entered on the command line or from a local file.
1569
-
1570
- ```
1571
- USAGE
1572
- $ sf apex run -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-f <value>]
1608
+ ```
1609
+ USAGE
1610
+ $ sf apex run -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-f <value>]
1573
1611
 
1574
1612
  FLAGS
1575
1613
  -f, --file=<value> Path to a local file that contains Apex code.
@@ -1608,7 +1646,7 @@ EXAMPLES
1608
1646
  $ sf apex run
1609
1647
  ```
1610
1648
 
1611
- _See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.5/src/commands/apex/run.ts)_
1649
+ _See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.7/src/commands/apex/run.ts)_
1612
1650
 
1613
1651
  ## `sf apex run test`
1614
1652
 
@@ -1755,7 +1793,7 @@ FLAG DESCRIPTIONS
1755
1793
  --tests Test1 --tests Test2
1756
1794
  ```
1757
1795
 
1758
- _See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.5/src/commands/apex/run/test.ts)_
1796
+ _See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.7/src/commands/apex/run/test.ts)_
1759
1797
 
1760
1798
  ## `sf apex tail log`
1761
1799
 
@@ -1798,7 +1836,7 @@ EXAMPLES
1798
1836
  $ sf apex tail log --color --skip-trace-flag
1799
1837
  ```
1800
1838
 
1801
- _See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.5/src/commands/apex/tail/log.ts)_
1839
+ _See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.7/src/commands/apex/tail/log.ts)_
1802
1840
 
1803
1841
  ## `sf api request graphql`
1804
1842
 
@@ -1851,7 +1889,7 @@ EXAMPLES
1851
1889
  $ sf api request graphql --body example.txt --stream-to-file output.txt --include
1852
1890
  ```
1853
1891
 
1854
- _See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.3.8/src/commands/api/request/graphql.ts)_
1892
+ _See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.3.9/src/commands/api/request/graphql.ts)_
1855
1893
 
1856
1894
  ## `sf api request rest [URL]`
1857
1895
 
@@ -1960,7 +1998,7 @@ FLAG DESCRIPTIONS
1960
1998
  https://github.com/salesforcecli/plugin-api/tree/main/test/test-files/data-project.
1961
1999
  ```
1962
2000
 
1963
- _See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.3.8/src/commands/api/request/rest.ts)_
2001
+ _See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.3.9/src/commands/api/request/rest.ts)_
1964
2002
 
1965
2003
  ## `sf autocomplete [SHELL]`
1966
2004
 
@@ -2069,7 +2107,7 @@ CONFIGURATION VARIABLES
2069
2107
  org-capitalize-record-types Whether record types are capitalized on scratch org creation.
2070
2108
  ```
2071
2109
 
2072
- _See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.54/src/commands/config/get.ts)_
2110
+ _See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.56/src/commands/config/get.ts)_
2073
2111
 
2074
2112
  ## `sf config list`
2075
2113
 
@@ -2109,7 +2147,7 @@ EXAMPLES
2109
2147
  $ sf config list
2110
2148
  ```
2111
2149
 
2112
- _See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.54/src/commands/config/list.ts)_
2150
+ _See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.56/src/commands/config/list.ts)_
2113
2151
 
2114
2152
  ## `sf config set`
2115
2153
 
@@ -2178,7 +2216,7 @@ CONFIGURATION VARIABLES
2178
2216
  org-capitalize-record-types Whether record types are capitalized on scratch org creation.
2179
2217
  ```
2180
2218
 
2181
- _See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.54/src/commands/config/set.ts)_
2219
+ _See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.56/src/commands/config/set.ts)_
2182
2220
 
2183
2221
  ## `sf config unset`
2184
2222
 
@@ -2228,7 +2266,7 @@ CONFIGURATION VARIABLES
2228
2266
  org-capitalize-record-types Whether record types are capitalized on scratch org creation.
2229
2267
  ```
2230
2268
 
2231
- _See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.54/src/commands/config/unset.ts)_
2269
+ _See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.56/src/commands/config/unset.ts)_
2232
2270
 
2233
2271
  ## `sf data bulk results`
2234
2272
 
@@ -2273,7 +2311,7 @@ EXAMPLES
2273
2311
  $ sf data bulk results --job-id 7507i000fake341G --target-org my-scratch
2274
2312
  ```
2275
2313
 
2276
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.67/src/commands/data/bulk/results.ts)_
2314
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/bulk/results.ts)_
2277
2315
 
2278
2316
  ## `sf data create file`
2279
2317
 
@@ -2322,7 +2360,7 @@ EXAMPLES
2322
2360
  $ sf data create file --file path/to/astro.png --parent-id a03fakeLoJWPIA3
2323
2361
  ```
2324
2362
 
2325
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.67/src/commands/data/create/file.ts)_
2363
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/create/file.ts)_
2326
2364
 
2327
2365
  ## `sf data create record`
2328
2366
 
@@ -2378,7 +2416,7 @@ EXAMPLES
2378
2416
  TracedEntityId=01p17000000R6bLAAS"
2379
2417
  ```
2380
2418
 
2381
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.67/src/commands/data/create/record.ts)_
2419
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/create/record.ts)_
2382
2420
 
2383
2421
  ## `sf data delete bulk`
2384
2422
 
@@ -2437,7 +2475,7 @@ FLAG DESCRIPTIONS
2437
2475
  and can be enabled only by a system administrator.
2438
2476
  ```
2439
2477
 
2440
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.67/src/commands/data/delete/bulk.ts)_
2478
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/delete/bulk.ts)_
2441
2479
 
2442
2480
  ## `sf data delete record`
2443
2481
 
@@ -2498,7 +2536,7 @@ EXAMPLES
2498
2536
  $ sf data delete record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
2499
2537
  ```
2500
2538
 
2501
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.67/src/commands/data/delete/record.ts)_
2539
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/delete/record.ts)_
2502
2540
 
2503
2541
  ## `sf data delete resume`
2504
2542
 
@@ -2537,7 +2575,7 @@ EXAMPLES
2537
2575
  $ sf data delete resume --use-most-recent --target-org my-scratch
2538
2576
  ```
2539
2577
 
2540
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.67/src/commands/data/delete/resume.ts)_
2578
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/delete/resume.ts)_
2541
2579
 
2542
2580
  ## `sf data export bulk`
2543
2581
 
@@ -2604,7 +2642,7 @@ EXAMPLES
2604
2642
  --result-format json --wait 10 --all-rows
2605
2643
  ```
2606
2644
 
2607
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.67/src/commands/data/export/bulk.ts)_
2645
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/export/bulk.ts)_
2608
2646
 
2609
2647
  ## `sf data export resume`
2610
2648
 
@@ -2643,7 +2681,7 @@ EXAMPLES
2643
2681
  $ sf data export resume --use-most-recent
2644
2682
  ```
2645
2683
 
2646
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.67/src/commands/data/export/resume.ts)_
2684
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/export/resume.ts)_
2647
2685
 
2648
2686
  ## `sf data export tree`
2649
2687
 
@@ -2703,7 +2741,7 @@ EXAMPLES
2703
2741
  my-scratch
2704
2742
  ```
2705
2743
 
2706
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.67/src/commands/data/export/tree.ts)_
2744
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/export/tree.ts)_
2707
2745
 
2708
2746
  ## `sf data get record`
2709
2747
 
@@ -2767,7 +2805,7 @@ EXAMPLES
2767
2805
  $ sf data get record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
2768
2806
  ```
2769
2807
 
2770
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.67/src/commands/data/get/record.ts)_
2808
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/get/record.ts)_
2771
2809
 
2772
2810
  ## `sf data import bulk`
2773
2811
 
@@ -2819,7 +2857,7 @@ EXAMPLES
2819
2857
  $ sf data import bulk --file accounts.csv --sobject Account --wait 10 --target-org my-scratch
2820
2858
  ```
2821
2859
 
2822
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.67/src/commands/data/import/bulk.ts)_
2860
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/import/bulk.ts)_
2823
2861
 
2824
2862
  ## `sf data import resume`
2825
2863
 
@@ -2855,7 +2893,7 @@ EXAMPLES
2855
2893
  $ sf data import resume --use-most-recent --target-org my-scratch
2856
2894
  ```
2857
2895
 
2858
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.67/src/commands/data/import/resume.ts)_
2896
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/import/resume.ts)_
2859
2897
 
2860
2898
  ## `sf data import tree`
2861
2899
 
@@ -2919,7 +2957,7 @@ FLAG DESCRIPTIONS
2919
2957
  - files(array) - Files: An array of files paths to load
2920
2958
  ```
2921
2959
 
2922
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.67/src/commands/data/import/tree.ts)_
2960
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/import/tree.ts)_
2923
2961
 
2924
2962
  ## `sf data query`
2925
2963
 
@@ -2972,7 +3010,7 @@ EXAMPLES
2972
3010
  $ sf data query --query "SELECT Name FROM ApexTrigger" --use-tooling-api
2973
3011
  ```
2974
3012
 
2975
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.67/src/commands/data/query.ts)_
3013
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/query.ts)_
2976
3014
 
2977
3015
  ## `sf data resume`
2978
3016
 
@@ -3009,7 +3047,7 @@ EXAMPLES
3009
3047
  $ sf data resume --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA
3010
3048
  ```
3011
3049
 
3012
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.67/src/commands/data/resume.ts)_
3050
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/resume.ts)_
3013
3051
 
3014
3052
  ## `sf data search`
3015
3053
 
@@ -3059,7 +3097,7 @@ EXAMPLES
3059
3097
  $ sf data search --file query.txt --target-org my-scratch --result-format csv
3060
3098
  ```
3061
3099
 
3062
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.67/src/commands/data/search.ts)_
3100
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/search.ts)_
3063
3101
 
3064
3102
  ## `sf data update bulk`
3065
3103
 
@@ -3114,7 +3152,7 @@ EXAMPLES
3114
3152
  $ sf data update bulk --file accounts.csv --sobject Account --wait 10 --target-org my-scratch
3115
3153
  ```
3116
3154
 
3117
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.67/src/commands/data/update/bulk.ts)_
3155
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/update/bulk.ts)_
3118
3156
 
3119
3157
  ## `sf data update record`
3120
3158
 
@@ -3176,7 +3214,7 @@ EXAMPLES
3176
3214
  "ExpirationDate=2017-12-01T00:58:04.000+0000"
3177
3215
  ```
3178
3216
 
3179
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.67/src/commands/data/update/record.ts)_
3217
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/update/record.ts)_
3180
3218
 
3181
3219
  ## `sf data update resume`
3182
3220
 
@@ -3215,7 +3253,7 @@ EXAMPLES
3215
3253
  $ sf data update resume --use-most-recent
3216
3254
  ```
3217
3255
 
3218
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.67/src/commands/data/update/resume.ts)_
3256
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/update/resume.ts)_
3219
3257
 
3220
3258
  ## `sf data upsert bulk`
3221
3259
 
@@ -3271,7 +3309,7 @@ EXAMPLES
3271
3309
  my-scratch
3272
3310
  ```
3273
3311
 
3274
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.67/src/commands/data/upsert/bulk.ts)_
3312
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/upsert/bulk.ts)_
3275
3313
 
3276
3314
  ## `sf data upsert resume`
3277
3315
 
@@ -3310,7 +3348,7 @@ EXAMPLES
3310
3348
  $ sf data upsert resume --use-most-recent --target-org my-scratch
3311
3349
  ```
3312
3350
 
3313
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.67/src/commands/data/upsert/resume.ts)_
3351
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/data/upsert/resume.ts)_
3314
3352
 
3315
3353
  ## `sf doctor`
3316
3354
 
@@ -3358,7 +3396,7 @@ EXAMPLES
3358
3396
  $ sf doctor --plugin @salesforce/plugin-source
3359
3397
  ```
3360
3398
 
3361
- _See code: [@salesforce/plugin-info](https://github.com/salesforcecli/plugin-info/blob/3.4.100/src/commands/doctor.ts)_
3399
+ _See code: [@salesforce/plugin-info](https://github.com/salesforcecli/plugin-info/blob/3.4.103/src/commands/doctor.ts)_
3362
3400
 
3363
3401
  ## `sf force data bulk delete`
3364
3402
 
@@ -3405,7 +3443,7 @@ EXAMPLES
3405
3443
  $ sf force data bulk delete --sobject MyObject__c --file files/delete.csv --wait 5 --target-org my-scratch
3406
3444
  ```
3407
3445
 
3408
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.67/src/commands/force/data/bulk/delete.ts)_
3446
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/force/data/bulk/delete.ts)_
3409
3447
 
3410
3448
  ## `sf force data bulk status`
3411
3449
 
@@ -3442,7 +3480,7 @@ EXAMPLES
3442
3480
  $ sf force data bulk status --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA --target-org my-scratch
3443
3481
  ```
3444
3482
 
3445
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.67/src/commands/force/data/bulk/status.ts)_
3483
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/force/data/bulk/status.ts)_
3446
3484
 
3447
3485
  ## `sf force data bulk upsert`
3448
3486
 
@@ -3500,7 +3538,7 @@ EXAMPLES
3500
3538
  --target-org my-scratch
3501
3539
  ```
3502
3540
 
3503
- _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.67/src/commands/force/data/bulk/upsert.ts)_
3541
+ _See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.70/src/commands/force/data/bulk/upsert.ts)_
3504
3542
 
3505
3543
  ## `sf help [COMMAND]`
3506
3544
 
@@ -3560,354 +3598,65 @@ EXAMPLES
3560
3598
  $ sf info releasenotes display --version latest
3561
3599
  ```
3562
3600
 
3563
- _See code: [@salesforce/plugin-info](https://github.com/salesforcecli/plugin-info/blob/3.4.100/src/commands/info/releasenotes/display.ts)_
3601
+ _See code: [@salesforce/plugin-info](https://github.com/salesforcecli/plugin-info/blob/3.4.103/src/commands/info/releasenotes/display.ts)_
3564
3602
 
3565
- ## `sf lightning generate app`
3603
+ ## `sf logic get test`
3566
3604
 
3567
- Generate a Lightning App.
3605
+ Get the results of a test run.
3568
3606
 
3569
3607
  ```
3570
3608
  USAGE
3571
- $ sf lightning generate app -n <value> [--json] [--flags-dir <value>] [-t DefaultLightningApp] [-d <value>] [--api-version
3572
- <value>]
3609
+ $ sf logic get test -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>]
3610
+ [--detailed-coverage -c] [-d <value>] [-r human|tap|junit|json] [--concise]
3573
3611
 
3574
3612
  FLAGS
3575
- -d, --output-dir=<value> [default: .] Directory for saving the created files.
3576
- -n, --name=<value> (required) Name of the generated Lightning App.
3577
- -t, --template=<option> [default: DefaultLightningApp] Template to use for file creation.
3578
- <options: DefaultLightningApp>
3579
- --api-version=<value> Override the api version used for api requests made by this command
3613
+ -c, --code-coverage Retrieve code coverage results.
3614
+ -d, --output-dir=<value> Directory in which to store test result files.
3615
+ -i, --test-run-id=<value> (required) ID of the test run.
3616
+ -o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
3617
+ configuration variable is already set.
3618
+ -r, --result-format=<option> [default: human] Format of the test results.
3619
+ <options: human|tap|junit|json>
3620
+ --api-version=<value> Override the api version used for api requests made by this command
3621
+ --concise Display only failed test results; works with human-readable output only.
3622
+ --detailed-coverage Display detailed code coverage per test.
3580
3623
 
3581
3624
  GLOBAL FLAGS
3582
3625
  --flags-dir=<value> Import flag values from a directory.
3583
3626
  --json Format output as json.
3584
3627
 
3585
3628
  DESCRIPTION
3586
- Generate a Lightning App.
3629
+ Get the results of a test run.
3587
3630
 
3588
- Generates a Lightning App bundle in the specified directory or the current working directory. The bundle consists of
3589
- multiple files in a folder with the designated name.
3631
+ When you run 'sf logic run test' to test Apex classes and Flows asynchronously, it returns a test run ID. Use that ID
3632
+ with this command to see the results.
3590
3633
 
3591
- ALIASES
3592
- $ sf force lightning app create
3634
+ To see code coverage results, use the --code-coverage flag with --result-format. The output displays a high-level
3635
+ summary of the test run and the code coverage values for classes in your org. If you specify human-readable result
3636
+ format, use the --detailed-coverage flag to see detailed coverage results for each test method run.
3593
3637
 
3594
3638
  EXAMPLES
3595
- Generate the metadata files for a Lightning app bundle called "myapp" in the current directory:
3596
-
3597
- $ sf lightning generate app --name myapp
3598
-
3599
- Similar to the previous example, but generate the files in the "force-app/main/default/aura" directory:
3600
-
3601
- $ sf lightning generate app --name myapp --output-dir force-app/main/default/aura
3602
-
3603
- FLAG DESCRIPTIONS
3604
- -d, --output-dir=<value> Directory for saving the created files.
3605
-
3606
- The location can be an absolute path or relative to the current working directory. The default is the current
3607
- directory.
3608
-
3609
- -n, --name=<value> Name of the generated Lightning App.
3639
+ Get the results for a specific test run ID in the default human-readable format; uses your default org:
3610
3640
 
3611
- The name can be up to 40 characters and must start with a letter.
3641
+ $ sf logic get test --test-run-id <test run id>
3612
3642
 
3613
- -t, --template=DefaultLightningApp Template to use for file creation.
3643
+ Get the results for a specific test run ID, format them as JUnit, and save them to the "test-results/junit"
3644
+ directory; uses the org with alias "my-scratch":
3614
3645
 
3615
- Supplied parameter values or default values are filled into a copy of the template.
3646
+ $ sf logic get test --test-run-id <test run id> --result-format junit --target-org my-scratch
3616
3647
  ```
3617
3648
 
3618
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.4.7/src/commands/lightning/generate/app.ts)_
3649
+ _See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.7/src/commands/logic/get/test.ts)_
3619
3650
 
3620
- ## `sf lightning generate component`
3651
+ ## `sf logic run test`
3621
3652
 
3622
- Generate a bundle for an Aura component or a Lightning web component.
3653
+ Invoke tests for Apex and Flows in an org.
3623
3654
 
3624
3655
  ```
3625
3656
  USAGE
3626
- $ sf lightning generate component -n <value> [--json] [--flags-dir <value>] [-t
3627
- default|analyticsDashboard|analyticsDashboardWithStep] [-d <value>] [--api-version <value>] [--type aura|lwc]
3628
-
3629
- FLAGS
3630
- -d, --output-dir=<value> [default: .] Directory for saving the created files.
3631
- -n, --name=<value> (required) Name of the generated Lightning Component.
3632
- -t, --template=<option> [default: default] Template to use for file creation.
3633
- <options: default|analyticsDashboard|analyticsDashboardWithStep>
3634
- --api-version=<value> Override the api version used for api requests made by this command
3635
- --type=<option> [default: aura] Type of the component bundle.
3636
- <options: aura|lwc>
3637
-
3638
- GLOBAL FLAGS
3639
- --flags-dir=<value> Import flag values from a directory.
3640
- --json Format output as json.
3641
-
3642
- DESCRIPTION
3643
- Generate a bundle for an Aura component or a Lightning web component.
3644
-
3645
- Generates the bundle in the specified directory or the current working directory. The bundle consists of multiple
3646
- files in a directory with the designated name. Lightning web components are contained in the directory with name
3647
- "lwc", Aura components in "aura".
3648
-
3649
- To generate a Lightning web component, pass "--type lwc" to the command. If you don’t specify --type, Salesforce CLI
3650
- generates an Aura component by default.
3651
-
3652
- ALIASES
3653
- $ sf force lightning component create
3654
-
3655
- EXAMPLES
3656
- Generate the metadata files for an Aura component bundle in the current directory:
3657
-
3658
- $ sf lightning generate component --name mycomponent
3659
-
3660
- Generate a Lightning web component bundle in the current directory:
3661
-
3662
- $ sf lightning generate component --name mycomponent --type lwc
3663
-
3664
- Generate an Aura component bundle in the "force-app/main/default/aura" directory:
3665
-
3666
- $ sf lightning generate component --name mycomponent --output-dir force-app/main/default/aura
3667
-
3668
- Generate a Lightning web component bundle in the "force-app/main/default/lwc" directory:
3669
-
3670
- $ sf lightning generate component --name mycomponent --type lwc --output-dir force-app/main/default/lwc
3671
-
3672
- FLAG DESCRIPTIONS
3673
- -d, --output-dir=<value> Directory for saving the created files.
3674
-
3675
- The location can be an absolute path or relative to the current working directory. The default is the current
3676
- directory.
3677
-
3678
- -n, --name=<value> Name of the generated Lightning Component.
3679
-
3680
- The name can be up to 40 characters and must start with a letter.
3681
-
3682
- -t, --template=default|analyticsDashboard|analyticsDashboardWithStep Template to use for file creation.
3683
-
3684
- Supplied parameter values or default values are filled into a copy of the template.
3685
- ```
3686
-
3687
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.4.7/src/commands/lightning/generate/component.ts)_
3688
-
3689
- ## `sf lightning generate event`
3690
-
3691
- Generate a Lightning Event.
3692
-
3693
- ```
3694
- USAGE
3695
- $ sf lightning generate event -n <value> [--json] [--flags-dir <value>] [-t DefaultLightningEvt] [-d <value>] [--api-version
3696
- <value>]
3697
-
3698
- FLAGS
3699
- -d, --output-dir=<value> [default: .] Directory for saving the created files.
3700
- -n, --name=<value> (required) Name of the generated Lightning Event.
3701
- -t, --template=<option> [default: DefaultLightningEvt] Template to use for file creation.
3702
- <options: DefaultLightningEvt>
3703
- --api-version=<value> Override the api version used for api requests made by this command
3704
-
3705
- GLOBAL FLAGS
3706
- --flags-dir=<value> Import flag values from a directory.
3707
- --json Format output as json.
3708
-
3709
- DESCRIPTION
3710
- Generate a Lightning Event.
3711
-
3712
- Generates a Lightning Event bundle in the specified directory or the current working directory. The bundle consists of
3713
- multiple files in a folder with the designated name.
3714
-
3715
- ALIASES
3716
- $ sf force lightning event create
3717
-
3718
- EXAMPLES
3719
- Generate the metadata files for a Lightning event bundle called "myevent" in the current directory:
3720
-
3721
- $ sf lightning generate event --name myevent
3722
-
3723
- Similar to previous example, but generate the files in the "force-app/main/default/aura" directory:
3724
-
3725
- $ sf lightning generate event --name myevent --output-dir force-app/main/default/aura
3726
-
3727
- FLAG DESCRIPTIONS
3728
- -d, --output-dir=<value> Directory for saving the created files.
3729
-
3730
- The location can be an absolute path or relative to the current working directory. The default is the current
3731
- directory.
3732
-
3733
- -n, --name=<value> Name of the generated Lightning Event.
3734
-
3735
- The name can be up to 40 characters and must start with a letter.
3736
-
3737
- -t, --template=DefaultLightningEvt Template to use for file creation.
3738
-
3739
- Supplied parameter values or default values are filled into a copy of the template.
3740
- ```
3741
-
3742
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.4.7/src/commands/lightning/generate/event.ts)_
3743
-
3744
- ## `sf lightning generate interface`
3745
-
3746
- Generate a Lightning Interface.
3747
-
3748
- ```
3749
- USAGE
3750
- $ sf lightning generate interface -n <value> [--json] [--flags-dir <value>] [-t DefaultLightningIntf] [-d <value>]
3751
- [--api-version <value>]
3752
-
3753
- FLAGS
3754
- -d, --output-dir=<value> [default: .] Directory for saving the created files.
3755
- -n, --name=<value> (required) Name of the generated Lightning Interface.
3756
- -t, --template=<option> [default: DefaultLightningIntf] Template to use for file creation.
3757
- <options: DefaultLightningIntf>
3758
- --api-version=<value> Override the api version used for api requests made by this command
3759
-
3760
- GLOBAL FLAGS
3761
- --flags-dir=<value> Import flag values from a directory.
3762
- --json Format output as json.
3763
-
3764
- DESCRIPTION
3765
- Generate a Lightning Interface.
3766
-
3767
- Generates a Lightning Interface bundle in the specified directory or the current working directory. The bundle
3768
- consists of multiple files in a folder with the designated name.
3769
-
3770
- ALIASES
3771
- $ sf force lightning interface create
3772
-
3773
- EXAMPLES
3774
- Generate the metadata files for a Lightning interface bundle called "myinterface" in the current directory:
3775
-
3776
- $ sf lightning generate interface --name myinterface
3777
-
3778
- Similar to the previous example but generate the files in the "force-app/main/default/aura" directory:
3779
-
3780
- $ sf lightning generate interface --name myinterface --output-dir force-app/main/default/aura
3781
-
3782
- FLAG DESCRIPTIONS
3783
- -d, --output-dir=<value> Directory for saving the created files.
3784
-
3785
- The location can be an absolute path or relative to the current working directory. The default is the current
3786
- directory.
3787
-
3788
- -n, --name=<value> Name of the generated Lightning Interface.
3789
-
3790
- The name can be up to 40 characters and must start with a letter.
3791
-
3792
- -t, --template=DefaultLightningIntf Template to use for file creation.
3793
-
3794
- Supplied parameter values or default values are filled into a copy of the template.
3795
- ```
3796
-
3797
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.4.7/src/commands/lightning/generate/interface.ts)_
3798
-
3799
- ## `sf lightning generate test`
3800
-
3801
- Generate a Lightning test.
3802
-
3803
- ```
3804
- USAGE
3805
- $ sf lightning generate test -n <value> [--json] [--flags-dir <value>] [-t DefaultLightningTest] [-d <value>]
3806
- [--api-version <value>]
3807
-
3808
- FLAGS
3809
- -d, --output-dir=<value> [default: .] Directory for saving the created files.
3810
- -n, --name=<value> (required) Name of the generated Lightning Test.
3811
- -t, --template=<option> [default: DefaultLightningTest] Template to use for file creation.
3812
- <options: DefaultLightningTest>
3813
- --api-version=<value> Override the api version used for api requests made by this command
3814
-
3815
- GLOBAL FLAGS
3816
- --flags-dir=<value> Import flag values from a directory.
3817
- --json Format output as json.
3818
-
3819
- DESCRIPTION
3820
- Generate a Lightning test.
3821
-
3822
- Generates the test in the specified directory or the current working directory. The .resource file and associated
3823
- metadata file are generated.
3824
-
3825
- ALIASES
3826
- $ sf force lightning test create
3827
-
3828
- EXAMPLES
3829
- Generate the metadata files for the Lightning test called MyLightningTest in the current directory:
3830
-
3831
- $ sf lightning generate test --name MyLightningTest
3832
-
3833
- Similar to the previous example but generate the files in the "force-app/main/default/lightningTests" directory:
3834
-
3835
- $ sf lightning generate test --name MyLightningTest --output-dir force-app/main/default/lightningTests
3836
-
3837
- FLAG DESCRIPTIONS
3838
- -d, --output-dir=<value> Directory for saving the created files.
3839
-
3840
- The location can be an absolute path or relative to the current working directory. The default is the current
3841
- directory.
3842
-
3843
- -n, --name=<value> Name of the generated Lightning Test.
3844
-
3845
- Name of the new Lightning test; can be up to 40 characters and must start with a letter.
3846
-
3847
- -t, --template=DefaultLightningTest Template to use for file creation.
3848
-
3849
- Supplied parameter values or default values are filled into a copy of the template.
3850
- ```
3851
-
3852
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.4.7/src/commands/lightning/generate/test.ts)_
3853
-
3854
- ## `sf logic get test`
3855
-
3856
- Get the results of a test run.
3857
-
3858
- ```
3859
- USAGE
3860
- $ sf logic get test -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>]
3861
- [--detailed-coverage -c] [-d <value>] [-r human|tap|junit|json] [--concise]
3862
-
3863
- FLAGS
3864
- -c, --code-coverage Retrieve code coverage results.
3865
- -d, --output-dir=<value> Directory in which to store test result files.
3866
- -i, --test-run-id=<value> (required) ID of the test run.
3867
- -o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
3868
- configuration variable is already set.
3869
- -r, --result-format=<option> [default: human] Format of the test results.
3870
- <options: human|tap|junit|json>
3871
- --api-version=<value> Override the api version used for api requests made by this command
3872
- --concise Display only failed test results; works with human-readable output only.
3873
- --detailed-coverage Display detailed code coverage per test.
3874
-
3875
- GLOBAL FLAGS
3876
- --flags-dir=<value> Import flag values from a directory.
3877
- --json Format output as json.
3878
-
3879
- DESCRIPTION
3880
- Get the results of a test run.
3881
-
3882
- When you run 'sf logic run test' to test Apex classes and Flows asynchronously, it returns a test run ID. Use that ID
3883
- with this command to see the results.
3884
-
3885
- To see code coverage results, use the --code-coverage flag with --result-format. The output displays a high-level
3886
- summary of the test run and the code coverage values for classes in your org. If you specify human-readable result
3887
- format, use the --detailed-coverage flag to see detailed coverage results for each test method run.
3888
-
3889
- EXAMPLES
3890
- Get the results for a specific test run ID in the default human-readable format; uses your default org:
3891
-
3892
- $ sf logic get test --test-run-id <test run id>
3893
-
3894
- Get the results for a specific test run ID, format them as JUnit, and save them to the "test-results/junit"
3895
- directory; uses the org with alias "my-scratch":
3896
-
3897
- $ sf logic get test --test-run-id <test run id> --result-format junit --target-org my-scratch
3898
- ```
3899
-
3900
- _See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.5/src/commands/logic/get/test.ts)_
3901
-
3902
- ## `sf logic run test`
3903
-
3904
- Invoke tests for Apex and Flows in an org.
3905
-
3906
- ```
3907
- USAGE
3908
- $ sf logic run test -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-d <value>] [-l
3909
- RunLocalTests|RunAllTestsInOrg|RunSpecifiedTests] [-n <value>... | -s <value>... | -t <value>... | --test-category
3910
- Apex|Flow...] [-r human|tap|junit|json] [-w <value>] [-y] [-v -c] [--concise]
3657
+ $ sf logic run test -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-d <value>] [-l
3658
+ RunLocalTests|RunAllTestsInOrg|RunSpecifiedTests] [-n <value>... | -s <value>... | -t <value>... | --test-category
3659
+ Apex|Flow...] [-r human|tap|junit|json] [-w <value>] [-y] [-v -c] [--concise]
3911
3660
 
3912
3661
  FLAGS
3913
3662
  -c, --code-coverage Retrieve code coverage results.
@@ -4019,7 +3768,7 @@ FLAG DESCRIPTIONS
4019
3768
  --tests Test1 --tests Test2
4020
3769
  ```
4021
3770
 
4022
- _See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.5/src/commands/logic/run/test.ts)_
3771
+ _See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.7/src/commands/logic/run/test.ts)_
4023
3772
 
4024
3773
  ## `sf org assign permset`
4025
3774
 
@@ -4065,7 +3814,7 @@ EXAMPLES
4065
3814
  $ sf org assign permset --name DreamHouse --on-behalf-of user1@my.org --on-behalf-of user2 --on-behalf-of user
4066
3815
  ```
4067
3816
 
4068
- _See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.6.48/src/commands/org/assign/permset.ts)_
3817
+ _See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.6.49/src/commands/org/assign/permset.ts)_
4069
3818
 
4070
3819
  ## `sf org assign permsetlicense`
4071
3820
 
@@ -4112,7 +3861,7 @@ EXAMPLES
4112
3861
  user3
4113
3862
  ```
4114
3863
 
4115
- _See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.6.48/src/commands/org/assign/permsetlicense.ts)_
3864
+ _See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.6.49/src/commands/org/assign/permsetlicense.ts)_
4116
3865
 
4117
3866
  ## `sf org create sandbox`
4118
3867
 
@@ -4246,7 +3995,7 @@ FLAG DESCRIPTIONS
4246
3995
  You can specify either --source-sandbox-name or --source-id when cloning an existing sandbox, but not both.
4247
3996
  ```
4248
3997
 
4249
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.64/src/commands/org/create/sandbox.ts)_
3998
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.66/src/commands/org/create/sandbox.ts)_
4250
3999
 
4251
4000
  ## `sf org create scratch`
4252
4001
 
@@ -4428,7 +4177,7 @@ FLAG DESCRIPTIONS
4428
4177
  Omit this flag to have Salesforce generate a unique username for your org.
4429
4178
  ```
4430
4179
 
4431
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.64/src/commands/org/create/scratch.ts)_
4180
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.66/src/commands/org/create/scratch.ts)_
4432
4181
 
4433
4182
  ## `sf org create user`
4434
4183
 
@@ -4536,7 +4285,7 @@ FLAG DESCRIPTIONS
4536
4285
  might be different than what you specify in the definition file.
4537
4286
  ```
4538
4287
 
4539
- _See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.6.48/src/commands/org/create/user.ts)_
4288
+ _See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.6.49/src/commands/org/create/user.ts)_
4540
4289
 
4541
4290
  ## `sf org delete sandbox`
4542
4291
 
@@ -4582,7 +4331,7 @@ EXAMPLES
4582
4331
  $ sf org delete sandbox --target-org my-sandbox --no-prompt
4583
4332
  ```
4584
4333
 
4585
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.64/src/commands/org/delete/sandbox.ts)_
4334
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.66/src/commands/org/delete/sandbox.ts)_
4586
4335
 
4587
4336
  ## `sf org delete scratch`
4588
4337
 
@@ -4626,7 +4375,7 @@ EXAMPLES
4626
4375
  $ sf org delete scratch --target-org my-scratch-org --no-prompt
4627
4376
  ```
4628
4377
 
4629
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.64/src/commands/org/delete/scratch.ts)_
4378
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.66/src/commands/org/delete/scratch.ts)_
4630
4379
 
4631
4380
  ## `sf org disable tracking`
4632
4381
 
@@ -4665,7 +4414,7 @@ EXAMPLES
4665
4414
  $ sf org disable tracking
4666
4415
  ```
4667
4416
 
4668
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.64/src/commands/org/disable/tracking.ts)_
4417
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.66/src/commands/org/disable/tracking.ts)_
4669
4418
 
4670
4419
  ## `sf org display`
4671
4420
 
@@ -4710,7 +4459,7 @@ EXAMPLES
4710
4459
  $ sf org display --target-org TestOrg1 --verbose
4711
4460
  ```
4712
4461
 
4713
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.64/src/commands/org/display.ts)_
4462
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.66/src/commands/org/display.ts)_
4714
4463
 
4715
4464
  ## `sf org display user`
4716
4465
 
@@ -4749,7 +4498,7 @@ EXAMPLES
4749
4498
  $ sf org display user --target-org me@my.org --json
4750
4499
  ```
4751
4500
 
4752
- _See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.6.48/src/commands/org/display/user.ts)_
4501
+ _See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.6.49/src/commands/org/display/user.ts)_
4753
4502
 
4754
4503
  ## `sf org enable tracking`
4755
4504
 
@@ -4791,7 +4540,7 @@ EXAMPLES
4791
4540
  $ sf org enable tracking
4792
4541
  ```
4793
4542
 
4794
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.64/src/commands/org/enable/tracking.ts)_
4543
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.66/src/commands/org/enable/tracking.ts)_
4795
4544
 
4796
4545
  ## `sf org generate password`
4797
4546
 
@@ -4858,7 +4607,7 @@ EXAMPLES
4858
4607
  $ sf org generate password --on-behalf-of user1@my.org --on-behalf-of user2@my.org --on-behalf-of user3@my.org
4859
4608
  ```
4860
4609
 
4861
- _See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.6.48/src/commands/org/generate/password.ts)_
4610
+ _See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.6.49/src/commands/org/generate/password.ts)_
4862
4611
 
4863
4612
  ## `sf org list`
4864
4613
 
@@ -4897,7 +4646,7 @@ EXAMPLES
4897
4646
  $ sf org list --clean
4898
4647
  ```
4899
4648
 
4900
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.64/src/commands/org/list.ts)_
4649
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.66/src/commands/org/list.ts)_
4901
4650
 
4902
4651
  ## `sf org list auth`
4903
4652
 
@@ -4929,7 +4678,7 @@ EXAMPLES
4929
4678
  $ sf org list auth
4930
4679
  ```
4931
4680
 
4932
- _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/4.1.4/src/commands/org/list/auth.ts)_
4681
+ _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/4.1.5/src/commands/org/list/auth.ts)_
4933
4682
 
4934
4683
  ## `sf org list limits`
4935
4684
 
@@ -4969,7 +4718,7 @@ EXAMPLES
4969
4718
  $ sf org list limits --target-org my-scratch-org
4970
4719
  ```
4971
4720
 
4972
- _See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.3.74/src/commands/org/list/limits.ts)_
4721
+ _See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.3.76/src/commands/org/list/limits.ts)_
4973
4722
 
4974
4723
  ## `sf org list metadata`
4975
4724
 
@@ -5036,7 +4785,7 @@ FLAG DESCRIPTIONS
5036
4785
  Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.
5037
4786
  ```
5038
4787
 
5039
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.64/src/commands/org/list/metadata.ts)_
4788
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.66/src/commands/org/list/metadata.ts)_
5040
4789
 
5041
4790
  ## `sf org list metadata-types`
5042
4791
 
@@ -5091,7 +4840,7 @@ FLAG DESCRIPTIONS
5091
4840
  Override the api version used for api requests made by this command
5092
4841
  ```
5093
4842
 
5094
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.64/src/commands/org/list/metadata-types.ts)_
4843
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.66/src/commands/org/list/metadata-types.ts)_
5095
4844
 
5096
4845
  ## `sf org list sobject record-counts`
5097
4846
 
@@ -5137,7 +4886,7 @@ EXAMPLES
5137
4886
  $ sf org list sobject record-counts --sobject Account --sobject Lead --target-org my-scratch-org
5138
4887
  ```
5139
4888
 
5140
- _See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.3.74/src/commands/org/list/sobject/record-counts.ts)_
4889
+ _See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.3.76/src/commands/org/list/sobject/record-counts.ts)_
5141
4890
 
5142
4891
  ## `sf org list users`
5143
4892
 
@@ -5175,7 +4924,7 @@ EXAMPLES
5175
4924
  $ sf org list users --target-org me@my.org
5176
4925
  ```
5177
4926
 
5178
- _See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.6.48/src/commands/org/list/users.ts)_
4927
+ _See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.6.49/src/commands/org/list/users.ts)_
5179
4928
 
5180
4929
  ## `sf org login access-token`
5181
4930
 
@@ -5229,7 +4978,7 @@ FLAG DESCRIPTIONS
5229
4978
  To specify a sandbox, set --instance-url to "https://<MyDomainName>--<SandboxName>.sandbox.my.salesforce.com".
5230
4979
  ```
5231
4980
 
5232
- _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/4.1.4/src/commands/org/login/access-token.ts)_
4981
+ _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/4.1.5/src/commands/org/login/access-token.ts)_
5233
4982
 
5234
4983
  ## `sf org login jwt`
5235
4984
 
@@ -5320,7 +5069,7 @@ FLAG DESCRIPTIONS
5320
5069
  To specify a sandbox, set --instance-url to "https://<MyDomainName>--<SandboxName>.sandbox.my.salesforce.com".
5321
5070
  ```
5322
5071
 
5323
- _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/4.1.4/src/commands/org/login/jwt.ts)_
5072
+ _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/4.1.5/src/commands/org/login/jwt.ts)_
5324
5073
 
5325
5074
  ## `sf org login sfdx-url`
5326
5075
 
@@ -5390,7 +5139,7 @@ EXAMPLES
5390
5139
  $ echo url | sf org login sfdx-url --sfdx-url-stdin
5391
5140
  ```
5392
5141
 
5393
- _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/4.1.4/src/commands/org/login/sfdx-url.ts)_
5142
+ _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/4.1.5/src/commands/org/login/sfdx-url.ts)_
5394
5143
 
5395
5144
  ## `sf org login web`
5396
5145
 
@@ -5495,7 +5244,7 @@ FLAG DESCRIPTIONS
5495
5244
  To specify a sandbox, set --instance-url to "https://<MyDomainName>--<SandboxName>.sandbox.my.salesforce.com".
5496
5245
  ```
5497
5246
 
5498
- _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/4.1.4/src/commands/org/login/web.ts)_
5247
+ _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/4.1.5/src/commands/org/login/web.ts)_
5499
5248
 
5500
5249
  ## `sf org logout`
5501
5250
 
@@ -5561,7 +5310,7 @@ FLAG DESCRIPTIONS
5561
5310
  All orgs includes Dev Hubs, sandboxes, DE orgs, and expired, deleted, and unknown-status scratch orgs.
5562
5311
  ```
5563
5312
 
5564
- _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/4.1.4/src/commands/org/logout.ts)_
5313
+ _See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/4.1.5/src/commands/org/logout.ts)_
5565
5314
 
5566
5315
  ## `sf org open`
5567
5316
 
@@ -5637,7 +5386,7 @@ EXAMPLES
5637
5386
  $ sf org open --source-file force-app/main/default/bots/Coral_Cloud_Agent/Coral_Cloud_Agent.bot-meta.xml
5638
5387
  ```
5639
5388
 
5640
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.64/src/commands/org/open.ts)_
5389
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.66/src/commands/org/open.ts)_
5641
5390
 
5642
5391
  ## `sf org open agent`
5643
5392
 
@@ -5688,7 +5437,7 @@ EXAMPLES
5688
5437
  $ sf org open agent --target-org MyTestOrg1 --browser firefox --api-name Coral_Cloud_Agent
5689
5438
  ```
5690
5439
 
5691
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.64/src/commands/org/open/agent.ts)_
5440
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.66/src/commands/org/open/agent.ts)_
5692
5441
 
5693
5442
  ## `sf org open authoring-bundle`
5694
5443
 
@@ -5734,7 +5483,7 @@ EXAMPLES
5734
5483
  $ sf org open authoring-bundle --target-org MyTestOrg1 --browser firefox
5735
5484
  ```
5736
5485
 
5737
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.64/src/commands/org/open/authoring-bundle.ts)_
5486
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.66/src/commands/org/open/authoring-bundle.ts)_
5738
5487
 
5739
5488
  ## `sf org refresh sandbox`
5740
5489
 
@@ -5837,7 +5586,7 @@ FLAG DESCRIPTIONS
5837
5586
  You can specify either --source-sandbox-name or --source-id when refreshing an existing sandbox, but not both.
5838
5587
  ```
5839
5588
 
5840
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.64/src/commands/org/refresh/sandbox.ts)_
5589
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.66/src/commands/org/refresh/sandbox.ts)_
5841
5590
 
5842
5591
  ## `sf org resume sandbox`
5843
5592
 
@@ -5900,7 +5649,7 @@ FLAG DESCRIPTIONS
5900
5649
  returns the job ID. To resume checking the sandbox creation, rerun this command.
5901
5650
  ```
5902
5651
 
5903
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.64/src/commands/org/resume/sandbox.ts)_
5652
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.66/src/commands/org/resume/sandbox.ts)_
5904
5653
 
5905
5654
  ## `sf org resume scratch`
5906
5655
 
@@ -5953,7 +5702,7 @@ FLAG DESCRIPTIONS
5953
5702
  returns the job ID. To resume checking the scratch creation, rerun this command.
5954
5703
  ```
5955
5704
 
5956
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.64/src/commands/org/resume/scratch.ts)_
5705
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.66/src/commands/org/resume/scratch.ts)_
5957
5706
 
5958
5707
  ## `sf package convert`
5959
5708
 
@@ -6050,7 +5799,7 @@ FLAG DESCRIPTIONS
6050
5799
  --installation-key-bypass flag is required.
6051
5800
  ```
6052
5801
 
6053
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.24.11/src/commands/package/convert.ts)_
5802
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/convert.ts)_
6054
5803
 
6055
5804
  ## `sf package create`
6056
5805
 
@@ -6129,7 +5878,7 @@ FLAG DESCRIPTIONS
6129
5878
  Org-Dependent Unlocked Packages" in the Salesforce DX Developer Guide.
6130
5879
  ```
6131
5880
 
6132
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.24.11/src/commands/package/create.ts)_
5881
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/create.ts)_
6133
5882
 
6134
5883
  ## `sf package delete`
6135
5884
 
@@ -6171,7 +5920,7 @@ EXAMPLES
6171
5920
  $ sf package delete --package 0Ho... --target-dev-hub devhub@example.com
6172
5921
  ```
6173
5922
 
6174
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.24.11/src/commands/package/delete.ts)_
5923
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/delete.ts)_
6175
5924
 
6176
5925
  ## `sf package install`
6177
5926
 
@@ -6270,7 +6019,7 @@ FLAG DESCRIPTIONS
6270
6019
  - Delete: Delete removed components, except for custom objects and custom fields, that don't have dependencies.
6271
6020
  ```
6272
6021
 
6273
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.24.11/src/commands/package/install.ts)_
6022
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/install.ts)_
6274
6023
 
6275
6024
  ## `sf package install report`
6276
6025
 
@@ -6303,7 +6052,7 @@ EXAMPLES
6303
6052
  $ sf package install report --request-id 0Hf... --target-org me@example.com
6304
6053
  ```
6305
6054
 
6306
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.24.11/src/commands/package/install/report.ts)_
6055
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/install/report.ts)_
6307
6056
 
6308
6057
  ## `sf package installed list`
6309
6058
 
@@ -6335,7 +6084,7 @@ EXAMPLES
6335
6084
  $ sf package installed list --target-org me@example.com
6336
6085
  ```
6337
6086
 
6338
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.24.11/src/commands/package/installed/list.ts)_
6087
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/installed/list.ts)_
6339
6088
 
6340
6089
  ## `sf package list`
6341
6090
 
@@ -6373,7 +6122,7 @@ EXAMPLES
6373
6122
  $ sf package list --target-dev-hub devhub@example.com --verbose
6374
6123
  ```
6375
6124
 
6376
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.24.11/src/commands/package/list.ts)_
6125
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/list.ts)_
6377
6126
 
6378
6127
  ## `sf package push-upgrade abort`
6379
6128
 
@@ -6412,7 +6161,7 @@ EXAMPLES
6412
6161
  $ sf package push-upgrade abort --push-request-id 0DV... --target-dev-hub devhub@example.com
6413
6162
  ```
6414
6163
 
6415
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.24.11/src/commands/package/push-upgrade/abort.ts)_
6164
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/push-upgrade/abort.ts)_
6416
6165
 
6417
6166
  ## `sf package push-upgrade list`
6418
6167
 
@@ -6471,7 +6220,7 @@ EXAMPLES
6471
6220
  $ sf package push-upgrade list --package 033xyz –-status Failed
6472
6221
  ```
6473
6222
 
6474
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.24.11/src/commands/package/push-upgrade/list.ts)_
6223
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/push-upgrade/list.ts)_
6475
6224
 
6476
6225
  ## `sf package push-upgrade report`
6477
6226
 
@@ -6513,7 +6262,7 @@ EXAMPLES
6513
6262
  $ sf package push-upgrade report --push-request-id 0DV... --target-dev-hub devhub@example.com
6514
6263
  ```
6515
6264
 
6516
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.24.11/src/commands/package/push-upgrade/report.ts)_
6265
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/push-upgrade/report.ts)_
6517
6266
 
6518
6267
  ## `sf package push-upgrade schedule`
6519
6268
 
@@ -6600,7 +6349,7 @@ FLAG DESCRIPTIONS
6600
6349
  Overrides the value of the target-dev-hub configuration variable, if set.
6601
6350
  ```
6602
6351
 
6603
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.24.11/src/commands/package/push-upgrade/schedule.ts)_
6352
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/push-upgrade/schedule.ts)_
6604
6353
 
6605
6354
  ## `sf package uninstall`
6606
6355
 
@@ -6648,7 +6397,7 @@ EXAMPLES
6648
6397
  $ sf package uninstall --package "Undesirable Package Alias"
6649
6398
  ```
6650
6399
 
6651
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.24.11/src/commands/package/uninstall.ts)_
6400
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/uninstall.ts)_
6652
6401
 
6653
6402
  ## `sf package uninstall report`
6654
6403
 
@@ -6681,7 +6430,7 @@ EXAMPLES
6681
6430
  $ sf package uninstall report --request-id 06y... --target-org me@example.com
6682
6431
  ```
6683
6432
 
6684
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.24.11/src/commands/package/uninstall/report.ts)_
6433
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/uninstall/report.ts)_
6685
6434
 
6686
6435
  ## `sf package update`
6687
6436
 
@@ -6749,7 +6498,7 @@ FLAG DESCRIPTIONS
6749
6498
  the Installed Packages page. Only released package versions can be set as the recommended version.
6750
6499
  ```
6751
6500
 
6752
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.24.11/src/commands/package/update.ts)_
6501
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/update.ts)_
6753
6502
 
6754
6503
  ## `sf package version create`
6755
6504
 
@@ -6759,9 +6508,9 @@ Create a package version in the Dev Hub org.
6759
6508
  USAGE
6760
6509
  $ sf package version create -v <value> [--json] [--flags-dir <value>] [--api-version <value>] [-b <value>] [-c |
6761
6510
  --skip-validation] [-f <value>] [-k <value>] [-x] [-p <value>] [-d <value>] [--post-install-script <value>]
6762
- [--post-install-url <value>] [--releasenotes-url <value>] [--skip-ancestor-check] [--async-validation | ] [-t
6763
- <value>] [--uninstall-script <value>] [-e <value>] [-a <value>] [-n <value>] [-w <value>] [--language <value>]
6764
- [--verbose]
6511
+ [--post-install-url <value>] [--releasenotes-url <value>] [--skip-ancestor-check] [--async-validation | ]
6512
+ [--generate-pkg-zip] [-t <value>] [--uninstall-script <value>] [-e <value>] [-a <value>] [-n <value>] [-w <value>]
6513
+ [--language <value>] [--verbose]
6765
6514
 
6766
6515
  FLAGS
6767
6516
  -a, --version-name=<value> Name of the package version to be created; overrides the sfdx-project.json value.
@@ -6788,12 +6537,14 @@ FLAGS
6788
6537
  --installation-key-bypass is required)
6789
6538
  --api-version=<value> Override the api version used for api requests made by this command
6790
6539
  --async-validation Return a new package version before completing package validations.
6540
+ --generate-pkg-zip Generate a package ZIP file that you can use for debugging or to examine the
6541
+ package contents.
6791
6542
  --language=<value> Language for the package.
6792
6543
  --post-install-script=<value> Name of the post-install script; applies to managed packages only.
6793
6544
  --post-install-url=<value> Post-install instructions URL.
6794
6545
  --releasenotes-url=<value> Release notes URL.
6795
- --skip-ancestor-check Overrides ancestry requirements, which allows you to specify a package ancestor
6796
- that isn’t the highest released package version.
6546
+ --skip-ancestor-check Override ancestry requirements, which allows you to specify a package ancestor that
6547
+ isn’t the highest released package version.
6797
6548
  --skip-validation Skip validation during package version creation; you can’t promote unvalidated
6798
6549
  package versions.
6799
6550
  --uninstall-script=<value> Uninstall script name; applies to managed packages only.
@@ -6924,7 +6675,7 @@ FLAG DESCRIPTIONS
6924
6675
  periods of no output from commands.
6925
6676
  ```
6926
6677
 
6927
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.24.11/src/commands/package/version/create.ts)_
6678
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/version/create.ts)_
6928
6679
 
6929
6680
  ## `sf package version create list`
6930
6681
 
@@ -6985,7 +6736,7 @@ EXAMPLES
6985
6736
  $ sf package version create list --created-last-days 0 --status Success
6986
6737
  ```
6987
6738
 
6988
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.24.11/src/commands/package/version/create/list.ts)_
6739
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/version/create/list.ts)_
6989
6740
 
6990
6741
  ## `sf package version create report`
6991
6742
 
@@ -7028,7 +6779,7 @@ EXAMPLES
7028
6779
  $ sf package version create report --package-create-request-id 08c... --target-dev-hub devhub@example.com
7029
6780
  ```
7030
6781
 
7031
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.24.11/src/commands/package/version/create/report.ts)_
6782
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/version/create/report.ts)_
7032
6783
 
7033
6784
  ## `sf package version delete`
7034
6785
 
@@ -7069,7 +6820,7 @@ EXAMPLES
7069
6820
  $ sf package version delete --package 04t... --target-org devhub@example.com
7070
6821
  ```
7071
6822
 
7072
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.24.11/src/commands/package/version/delete.ts)_
6823
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/version/delete.ts)_
7073
6824
 
7074
6825
  ## `sf package version displayancestry`
7075
6826
 
@@ -7129,7 +6880,7 @@ FLAG DESCRIPTIONS
7129
6880
  You can use the DOT code output in graph visualization software to create tree visualizations.
7130
6881
  ```
7131
6882
 
7132
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.24.11/src/commands/package/version/displayancestry.ts)_
6883
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/version/displayancestry.ts)_
7133
6884
 
7134
6885
  ## `sf package version displaydependencies`
7135
6886
 
@@ -7191,7 +6942,7 @@ FLAG DESCRIPTIONS
7191
6942
  package, which must be installed last.
7192
6943
  ```
7193
6944
 
7194
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.24.11/src/commands/package/version/displaydependencies.ts)_
6945
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/version/displaydependencies.ts)_
7195
6946
 
7196
6947
  ## `sf package version list`
7197
6948
 
@@ -7267,7 +7018,7 @@ EXAMPLES
7267
7018
  $ sf package version list --packages exp-mgr,exp-mgr-util --released --modified-last-days 0
7268
7019
  ```
7269
7020
 
7270
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.24.11/src/commands/package/version/list.ts)_
7021
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/version/list.ts)_
7271
7022
 
7272
7023
  ## `sf package version promote`
7273
7024
 
@@ -7311,7 +7062,7 @@ EXAMPLES
7311
7062
  $ sf package version promote --package "Awesome Package Alias"
7312
7063
  ```
7313
7064
 
7314
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.24.11/src/commands/package/version/promote.ts)_
7065
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/version/promote.ts)_
7315
7066
 
7316
7067
  ## `sf package version report`
7317
7068
 
@@ -7351,7 +7102,7 @@ EXAMPLES
7351
7102
  $ sf package version report --package "Your Package Alias" --target-dev-hub devhub@example.com
7352
7103
  ```
7353
7104
 
7354
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.24.11/src/commands/package/version/report.ts)_
7105
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/version/report.ts)_
7355
7106
 
7356
7107
  ## `sf package version retrieve`
7357
7108
 
@@ -7396,7 +7147,7 @@ EXAMPLES
7396
7147
  $ sf package version retrieve --package 04tXXX --output-dir my-directory/ --target-dev-hub devhub@example.com
7397
7148
  ```
7398
7149
 
7399
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.24.11/src/commands/package/version/retrieve.ts)_
7150
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/version/retrieve.ts)_
7400
7151
 
7401
7152
  ## `sf package version update`
7402
7153
 
@@ -7449,7 +7200,7 @@ EXAMPLES
7449
7200
  $ sf package version update --package 04t... --version-description "New Package Version Description"
7450
7201
  ```
7451
7202
 
7452
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.24.11/src/commands/package/version/update.ts)_
7203
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/version/update.ts)_
7453
7204
 
7454
7205
  ## `sf package1 version create`
7455
7206
 
@@ -7516,7 +7267,7 @@ FLAG DESCRIPTIONS
7516
7267
  subscribers.
7517
7268
  ```
7518
7269
 
7519
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.24.11/src/commands/package1/version/create.ts)_
7270
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package1/version/create.ts)_
7520
7271
 
7521
7272
  ## `sf package1 version create get`
7522
7273
 
@@ -7549,7 +7300,7 @@ EXAMPLES
7549
7300
  $ sf package1 version create get --request-id 0HD... --target-org myorg@example.com
7550
7301
  ```
7551
7302
 
7552
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.24.11/src/commands/package1/version/create/get.ts)_
7303
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package1/version/create/get.ts)_
7553
7304
 
7554
7305
  ## `sf package1 version display`
7555
7306
 
@@ -7583,7 +7334,7 @@ EXAMPLES
7583
7334
  $ sf package1 version display --package-version-id 04t... --target-org myorg@example.com
7584
7335
  ```
7585
7336
 
7586
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.24.11/src/commands/package1/version/display.ts)_
7337
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package1/version/display.ts)_
7587
7338
 
7588
7339
  ## `sf package1 version list`
7589
7340
 
@@ -7621,7 +7372,7 @@ FLAG DESCRIPTIONS
7621
7372
  If not specified, shows all versions for all packages (managed and unmanaged) in the org.
7622
7373
  ```
7623
7374
 
7624
- _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.24.11/src/commands/package1/version/list.ts)_
7375
+ _See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package1/version/list.ts)_
7625
7376
 
7626
7377
  ## `sf plugins`
7627
7378
 
@@ -7644,7 +7395,7 @@ EXAMPLES
7644
7395
  $ sf plugins
7645
7396
  ```
7646
7397
 
7647
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.55/src/commands/plugins/index.ts)_
7398
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.56/src/commands/plugins/index.ts)_
7648
7399
 
7649
7400
  ## `sf plugins discover`
7650
7401
 
@@ -7662,7 +7413,7 @@ EXAMPLES
7662
7413
  $ sf plugins discover
7663
7414
  ```
7664
7415
 
7665
- _See code: [@salesforce/plugin-marketplace](https://github.com/salesforcecli/plugin-marketplace/blob/1.3.8/src/commands/plugins/discover.ts)_
7416
+ _See code: [@salesforce/plugin-marketplace](https://github.com/salesforcecli/plugin-marketplace/blob/1.3.10/src/commands/plugins/discover.ts)_
7666
7417
 
7667
7418
  ## `sf plugins:inspect PLUGIN...`
7668
7419
 
@@ -7689,7 +7440,7 @@ EXAMPLES
7689
7440
  $ sf plugins inspect @salesforce/plugin-packaging
7690
7441
  ```
7691
7442
 
7692
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.55/src/commands/plugins/inspect.ts)_
7443
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.56/src/commands/plugins/inspect.ts)_
7693
7444
 
7694
7445
  ## `sf plugins install PLUGIN`
7695
7446
 
@@ -7738,7 +7489,7 @@ EXAMPLES
7738
7489
  $ sf plugins install someuser/someplugin
7739
7490
  ```
7740
7491
 
7741
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.55/src/commands/plugins/install.ts)_
7492
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.56/src/commands/plugins/install.ts)_
7742
7493
 
7743
7494
  ## `sf plugins link PATH`
7744
7495
 
@@ -7769,7 +7520,7 @@ EXAMPLES
7769
7520
  $ sf plugins link @salesforce/plugin-packaging
7770
7521
  ```
7771
7522
 
7772
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.55/src/commands/plugins/link.ts)_
7523
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.56/src/commands/plugins/link.ts)_
7773
7524
 
7774
7525
  ## `sf plugins reset`
7775
7526
 
@@ -7784,7 +7535,7 @@ FLAGS
7784
7535
  --reinstall Reinstall all plugins after uninstalling.
7785
7536
  ```
7786
7537
 
7787
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.55/src/commands/plugins/reset.ts)_
7538
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.56/src/commands/plugins/reset.ts)_
7788
7539
 
7789
7540
  ## `sf plugins trust verify`
7790
7541
 
@@ -7841,7 +7592,7 @@ EXAMPLES
7841
7592
  $ sf plugins uninstall @salesforce/plugin-packaging
7842
7593
  ```
7843
7594
 
7844
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.55/src/commands/plugins/uninstall.ts)_
7595
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.56/src/commands/plugins/uninstall.ts)_
7845
7596
 
7846
7597
  ## `sf plugins update`
7847
7598
 
@@ -7859,7 +7610,7 @@ DESCRIPTION
7859
7610
  Update installed plugins.
7860
7611
  ```
7861
7612
 
7862
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.55/src/commands/plugins/update.ts)_
7613
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.56/src/commands/plugins/update.ts)_
7863
7614
 
7864
7615
  ## `sf project convert mdapi`
7865
7616
 
@@ -7922,7 +7673,7 @@ FLAG DESCRIPTIONS
7922
7673
  If you specify this flag, don’t specify --metadata or --source-dir.
7923
7674
  ```
7924
7675
 
7925
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.7/src/commands/project/convert/mdapi.ts)_
7676
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.9/src/commands/project/convert/mdapi.ts)_
7926
7677
 
7927
7678
  ## `sf project convert source`
7928
7679
 
@@ -7995,7 +7746,7 @@ FLAG DESCRIPTIONS
7995
7746
  Override the api version used for api requests made by this command
7996
7747
  ```
7997
7748
 
7998
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.7/src/commands/project/convert/source.ts)_
7749
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.9/src/commands/project/convert/source.ts)_
7999
7750
 
8000
7751
  ## `sf project convert source-behavior`
8001
7752
 
@@ -8054,7 +7805,7 @@ EXAMPLES
8054
7805
  $ sf project convert source-behavior --behavior decomposePermissionSetBeta --dry-run --preserve-temp-dir
8055
7806
  ```
8056
7807
 
8057
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.7/src/commands/project/convert/source-behavior.ts)_
7808
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.9/src/commands/project/convert/source-behavior.ts)_
8058
7809
 
8059
7810
  ## `sf project delete source`
8060
7811
 
@@ -8207,7 +7958,7 @@ FLAG DESCRIPTIONS
8207
7958
  - Separate the test names with spaces: --tests Test1 Test2 "Test With Space"
8208
7959
  ```
8209
7960
 
8210
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.7/src/commands/project/delete/source.ts)_
7961
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.9/src/commands/project/delete/source.ts)_
8211
7962
 
8212
7963
  ## `sf project delete tracking`
8213
7964
 
@@ -8244,7 +7995,7 @@ EXAMPLES
8244
7995
  $ sf project delete tracking --target-org my-scratch
8245
7996
  ```
8246
7997
 
8247
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.7/src/commands/project/delete/tracking.ts)_
7998
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.9/src/commands/project/delete/tracking.ts)_
8248
7999
 
8249
8000
  ## `sf project deploy cancel`
8250
8001
 
@@ -8316,7 +8067,7 @@ FLAG DESCRIPTIONS
8316
8067
  project deploy report".
8317
8068
  ```
8318
8069
 
8319
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.7/src/commands/project/deploy/cancel.ts)_
8070
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.9/src/commands/project/deploy/cancel.ts)_
8320
8071
 
8321
8072
  ## `sf project deploy preview`
8322
8073
 
@@ -8399,7 +8150,7 @@ FLAG DESCRIPTIONS
8399
8150
  All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.
8400
8151
  ```
8401
8152
 
8402
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.7/src/commands/project/deploy/preview.ts)_
8153
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.9/src/commands/project/deploy/preview.ts)_
8403
8154
 
8404
8155
  ## `sf project deploy quick`
8405
8156
 
@@ -8492,7 +8243,7 @@ ERROR CODES
8492
8243
  Canceling (69) The deploy is being canceled.
8493
8244
  ```
8494
8245
 
8495
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.7/src/commands/project/deploy/quick.ts)_
8246
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.9/src/commands/project/deploy/quick.ts)_
8496
8247
 
8497
8248
  ## `sf project deploy report`
8498
8249
 
@@ -8584,7 +8335,7 @@ FLAG DESCRIPTIONS
8584
8335
  --coverage-formatters lcov --coverage-formatters clover
8585
8336
  ```
8586
8337
 
8587
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.7/src/commands/project/deploy/report.ts)_
8338
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.9/src/commands/project/deploy/report.ts)_
8588
8339
 
8589
8340
  ## `sf project deploy resume`
8590
8341
 
@@ -8681,7 +8432,7 @@ ERROR CODES
8681
8432
  Canceling (69) The deploy is being canceled.
8682
8433
  ```
8683
8434
 
8684
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.7/src/commands/project/deploy/resume.ts)_
8435
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.9/src/commands/project/deploy/resume.ts)_
8685
8436
 
8686
8437
  ## `sf project deploy start`
8687
8438
 
@@ -8947,7 +8698,7 @@ ERROR CODES
8947
8698
  Canceling (69) The deploy is being canceled.
8948
8699
  ```
8949
8700
 
8950
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.7/src/commands/project/deploy/start.ts)_
8701
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.9/src/commands/project/deploy/start.ts)_
8951
8702
 
8952
8703
  ## `sf project deploy validate`
8953
8704
 
@@ -9151,122 +8902,17 @@ ERROR CODES
9151
8902
  Canceling (69) The deploy is being canceled.
9152
8903
  ```
9153
8904
 
9154
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.7/src/commands/project/deploy/validate.ts)_
8905
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.9/src/commands/project/deploy/validate.ts)_
9155
8906
 
9156
- ## `sf project generate`
8907
+ ## `sf project generate manifest`
9157
8908
 
9158
- Generate a Salesforce DX project.
8909
+ Create a project manifest that lists the metadata components you want to deploy or retrieve.
9159
8910
 
9160
8911
  ```
9161
8912
  USAGE
9162
- $ sf project generate -n <value> [--json] [--flags-dir <value>] [-t standard|empty|analytics] [-d <value>] [-s
9163
- <value>] [-p <value>] [-x] [--api-version <value>]
9164
-
9165
- FLAGS
9166
- -d, --output-dir=<value> [default: .] Directory for saving the created files.
9167
- -n, --name=<value> (required) Name of the generated project.
9168
- -p, --default-package-dir=<value> [default: force-app] Default package directory name.
9169
- -s, --namespace=<value> Namespace associated with this project and any connected scratch orgs.
9170
- -t, --template=<option> [default: standard] Template to use for project creation.
9171
- <options: standard|empty|analytics>
9172
- -x, --manifest Generate a manifest (package.xml) for change-set based development.
9173
- --api-version=<value> Will set this version as sourceApiVersion in the sfdx-project.json file
9174
-
9175
- GLOBAL FLAGS
9176
- --flags-dir=<value> Import flag values from a directory.
9177
- --json Format output as json.
9178
-
9179
- DESCRIPTION
9180
- Generate a Salesforce DX project.
9181
-
9182
- A Salesforce DX project has a specific structure and a configuration file (sfdx-project.json) that identifies the
9183
- directory as a Salesforce DX project. This command generates the necessary configuration files and directories to get
9184
- you started.
9185
-
9186
- By default, the generated sfdx-project.json file sets the sourceApiVersion property to the default API version
9187
- currently used by Salesforce CLI. To specify a different version, set the apiVersion configuration variable. For
9188
- example: "sf config set apiVersion=57.0 --global".
9189
-
9190
- ALIASES
9191
- $ sf force project create
9192
-
9193
- EXAMPLES
9194
- Generate a project called "mywork":
9195
-
9196
- $ sf project generate --name mywork
9197
-
9198
- Similar to previous example, but generate the files in a directory called "myapp":
9199
-
9200
- $ sf project generate --name mywork --default-package-dir myapp
9201
-
9202
- Similar to prevoius example, but also generate a default package.xml manifest file:
9203
-
9204
- $ sf project generate --name mywork --default-package-dir myapp --manifest
9205
-
9206
- Generate a project with the minimum files and directories:
9207
-
9208
- $ sf project generate --name mywork --template empty
9209
-
9210
- FLAG DESCRIPTIONS
9211
- -d, --output-dir=<value> Directory for saving the created files.
9212
-
9213
- The location can be an absolute path or relative to the current working directory. The default is the current
9214
- directory.
9215
-
9216
- -n, --name=<value> Name of the generated project.
9217
-
9218
- Generates a project directory with this name; any valid directory name is accepted. Also sets the "name" property in
9219
- the sfdx-project.json file to this name.
9220
-
9221
- -p, --default-package-dir=<value> Default package directory name.
9222
-
9223
- Metadata items such as classes and Lightning bundles are placed inside this folder.
9224
-
9225
- -t, --template=standard|empty|analytics Template to use for project creation.
9226
-
9227
- The template determines the sample configuration files and directories that this command generates. For example, the
9228
- empty template provides these files and directory to get you started.
9229
-
9230
- - .forceignore
9231
- - config/project-scratch-def.json
9232
- - sfdx-project.json
9233
- - package.json
9234
- - force-app (basic source directory structure)
9235
-
9236
- The standard template provides a complete force-app directory structure so you know where to put your source. It
9237
- also provides additional files and scripts, especially useful when using Salesforce Extensions for VS Code. For
9238
- example:
9239
-
9240
- - .gitignore: Use Git for version control.
9241
- - .prettierrc and .prettierignore: Use Prettier to format your Aura components.
9242
- - .vscode/extensions.json: When launched, Visual Studio Code, prompts you to install the recommended extensions for
9243
- your project.
9244
- - .vscode/launch.json: Configures Replay Debugger.
9245
- - .vscode/settings.json: Additional configuration settings.
9246
-
9247
- The analytics template provides similar files and the force-app/main/default/waveTemplates directory.
9248
-
9249
- -x, --manifest Generate a manifest (package.xml) for change-set based development.
9250
-
9251
- Generates a default manifest (package.xml) for fetching Apex, Visualforce, Lightning components, and static
9252
- resources.
9253
-
9254
- --api-version=<value> Will set this version as sourceApiVersion in the sfdx-project.json file
9255
-
9256
- Override the api version used for api requests made by this command
9257
- ```
9258
-
9259
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.4.7/src/commands/project/generate.ts)_
9260
-
9261
- ## `sf project generate manifest`
9262
-
9263
- Create a project manifest that lists the metadata components you want to deploy or retrieve.
9264
-
9265
- ```
9266
- USAGE
9267
- $ sf project generate manifest [--json] [--flags-dir <value>] [--api-version <value>] [-m <value>...] [-p <value>...] [-n
9268
- <value> | -t pre|post|destroy|package] [-c managed|unlocked... --from-org <value>] [--excluded-metadata <value>...]
9269
- [-d <value>]
8913
+ $ sf project generate manifest [--json] [--flags-dir <value>] [--api-version <value>] [-m <value>...] [-p <value>...] [-n
8914
+ <value> | -t pre|post|destroy|package] [-c managed|unlocked... --from-org <value>] [--excluded-metadata <value>...]
8915
+ [-d <value>]
9270
8916
 
9271
8917
  FLAGS
9272
8918
  -c, --include-packages=<option>... Package types (managed, unlocked) whose metadata is included in the manifest; by
@@ -9352,7 +8998,7 @@ EXAMPLES
9352
8998
  $ sf project generate manifest --from-org test@myorg.com --excluded-metadata StandardValueSet
9353
8999
  ```
9354
9000
 
9355
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.7/src/commands/project/generate/manifest.ts)_
9001
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.9/src/commands/project/generate/manifest.ts)_
9356
9002
 
9357
9003
  ## `sf project list ignored`
9358
9004
 
@@ -9394,7 +9040,7 @@ EXAMPLES
9394
9040
  $ sf project list ignored --source-dir package.xml
9395
9041
  ```
9396
9042
 
9397
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.7/src/commands/project/list/ignored.ts)_
9043
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.9/src/commands/project/list/ignored.ts)_
9398
9044
 
9399
9045
  ## `sf project reset tracking`
9400
9046
 
@@ -9443,7 +9089,7 @@ EXAMPLES
9443
9089
  $ sf project reset tracking --revision 30
9444
9090
  ```
9445
9091
 
9446
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.7/src/commands/project/reset/tracking.ts)_
9092
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.9/src/commands/project/reset/tracking.ts)_
9447
9093
 
9448
9094
  ## `sf project retrieve preview`
9449
9095
 
@@ -9497,7 +9143,7 @@ FLAG DESCRIPTIONS
9497
9143
  production orgs.
9498
9144
  ```
9499
9145
 
9500
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.7/src/commands/project/retrieve/preview.ts)_
9146
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.9/src/commands/project/retrieve/preview.ts)_
9501
9147
 
9502
9148
  ## `sf project retrieve start`
9503
9149
 
@@ -9678,7 +9324,7 @@ ENVIRONMENT VARIABLES
9678
9324
  SF_USE_PROGRESS_BAR Set to false to disable the progress bar when running the metadata deploy command.
9679
9325
  ```
9680
9326
 
9681
- _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.7/src/commands/project/retrieve/start.ts)_
9327
+ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.9/src/commands/project/retrieve/start.ts)_
9682
9328
 
9683
9329
  ## `sf schema generate field`
9684
9330
 
@@ -9885,7 +9531,7 @@ DESCRIPTION
9885
9531
  Once you select a command, hit enter and it will show the help for that command.
9886
9532
  ```
9887
9533
 
9888
- _See code: [@oclif/plugin-search](https://github.com/oclif/plugin-search/blob/1.2.37/src/commands/search.ts)_
9534
+ _See code: [@oclif/plugin-search](https://github.com/oclif/plugin-search/blob/1.2.38/src/commands/search.ts)_
9889
9535
 
9890
9536
  ## `sf sobject describe`
9891
9537
 
@@ -9932,7 +9578,7 @@ EXAMPLES
9932
9578
  $ sf sobject describe --sobject ApexCodeCoverage --use-tooling-api
9933
9579
  ```
9934
9580
 
9935
- _See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.3.90/src/commands/sobject/describe.ts)_
9581
+ _See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.3.92/src/commands/sobject/describe.ts)_
9936
9582
 
9937
9583
  ## `sf sobject list`
9938
9584
 
@@ -9971,143 +9617,131 @@ EXAMPLES
9971
9617
  $ sf sobject list --sobject custom --target-org my-scratch-org
9972
9618
  ```
9973
9619
 
9974
- _See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.3.90/src/commands/sobject/list.ts)_
9620
+ _See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.3.92/src/commands/sobject/list.ts)_
9975
9621
 
9976
- ## `sf static-resource generate`
9622
+ ## `sf template generate analytics template`
9977
9623
 
9978
- Generate a static resource.
9624
+ Generate a simple Analytics template.
9979
9625
 
9980
9626
  ```
9981
9627
  USAGE
9982
- $ sf static-resource generate -n <value> [--json] [--flags-dir <value>] [--type <value>] [-d <value>] [--api-version
9628
+ $ sf template generate analytics template -n <value> [--json] [--flags-dir <value>] [-d <value>] [--api-version
9983
9629
  <value>]
9984
9630
 
9985
9631
  FLAGS
9986
9632
  -d, --output-dir=<value> [default: .] Directory for saving the created files.
9987
- -n, --name=<value> (required) Name of the generated static resource.
9633
+ -n, --name=<value> (required) Name of the Analytics template.
9988
9634
  --api-version=<value> Override the api version used for api requests made by this command
9989
- --type=<value> [default: application/zip] Content type (mime type) of the generated static resource.
9990
9635
 
9991
9636
  GLOBAL FLAGS
9992
9637
  --flags-dir=<value> Import flag values from a directory.
9993
9638
  --json Format output as json.
9994
9639
 
9995
9640
  DESCRIPTION
9996
- Generate a static resource.
9641
+ Generate a simple Analytics template.
9997
9642
 
9998
- Generates the metadata resource file in the specified directory or the current working directory. Static resource
9999
- files must be contained in a parent directory called "staticresources" in your package directory. Either run this
10000
- command from an existing directory of this name, or use the --output-dir flag to create one or point to an existing
10001
- one.
9643
+ The metadata files associated with the Analytics template must be contained in a parent directory called
9644
+ "waveTemplates" in your package directory. Either run this command from an existing directory of this name, or use the
9645
+ --output-dir flag to generate one or point to an existing one.
10002
9646
 
10003
9647
  ALIASES
10004
- $ sf force staticresource create
9648
+ $ sf force analytics template create
9649
+ $ sf analytics generate template
10005
9650
 
10006
9651
  EXAMPLES
10007
- Generate the metadata file for a static resource called MyResource in the current directory:
10008
-
10009
- $ sf static-resource generate --name MyResource
10010
-
10011
- Similar to previous example, but specifies a MIME type of application/json:
10012
-
10013
- $ sf static-resource generate --name MyResource --type application/json
10014
-
10015
- Generate the resource file in the "force-app/main/default/staticresources" directory:
9652
+ Generate the metadata files for a simple Analytics template file called myTemplate in the
9653
+ force-app/main/default/waveTemplates directory:
10016
9654
 
10017
- $ sf static-resource generate --name MyResource --output-dir force-app/main/default/staticresources
9655
+ $ sf template generate analytics template --name myTemplate --output-dir force-app/main/default/waveTemplates
10018
9656
 
10019
9657
  FLAG DESCRIPTIONS
10020
9658
  -d, --output-dir=<value> Directory for saving the created files.
10021
9659
 
10022
9660
  The location can be an absolute path or relative to the current working directory. The default is the current
10023
9661
  directory.
10024
-
10025
- -n, --name=<value> Name of the generated static resource.
10026
-
10027
- This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin
10028
- with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.
10029
-
10030
- --type=<value> Content type (mime type) of the generated static resource.
10031
-
10032
- Must be a valid MIME type such as application/json, application/javascript, application/zip, text/plain, text/css,
10033
- etc.
10034
9662
  ```
10035
9663
 
10036
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.4.7/src/commands/static-resource/generate.ts)_
9664
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/analytics/template.ts)_
10037
9665
 
10038
- ## `sf update [CHANNEL]`
9666
+ ## `sf template generate apex class`
10039
9667
 
10040
- update the sf CLI
9668
+ Generate an Apex class.
10041
9669
 
10042
9670
  ```
10043
9671
  USAGE
10044
- $ sf update [CHANNEL] [--force | | [-a | -v <value> | -i]] [-b ]
9672
+ $ sf template generate apex class -n <value> [--json] [--flags-dir <value>] [-t
9673
+ ApexException|ApexUnitTest|BasicUnitTest|DefaultApexClass|InboundEmailService] [-d <value>] [--api-version <value>]
10045
9674
 
10046
9675
  FLAGS
10047
- -a, --available See available versions.
10048
- -b, --verbose Show more details about the available versions.
10049
- -i, --interactive Interactively select version to install. This is ignored if a channel is provided.
10050
- -v, --version=<value> Install a specific version.
10051
- --force Force a re-download of the requested version.
10052
-
10053
- DESCRIPTION
10054
- update the sf CLI
9676
+ -d, --output-dir=<value> [default: .] Directory for saving the created files.
9677
+ -n, --name=<value> (required) Name of the generated Apex class.
9678
+ -t, --template=<option> [default: DefaultApexClass] Template to use for file creation.
9679
+ <options: ApexException|ApexUnitTest|BasicUnitTest|DefaultApexClass|InboundEmailService>
9680
+ --api-version=<value> Override the api version used for api requests made by this command
10055
9681
 
10056
- EXAMPLES
10057
- Update to the stable channel:
9682
+ GLOBAL FLAGS
9683
+ --flags-dir=<value> Import flag values from a directory.
9684
+ --json Format output as json.
10058
9685
 
10059
- $ sf update stable
9686
+ DESCRIPTION
9687
+ Generate an Apex class.
10060
9688
 
10061
- Update to a specific version:
9689
+ Generates the Apex *.cls file and associated metadata file. These files must be contained in a parent directory called
9690
+ "classes" in your package directory. Either run this command from an existing directory of this name, or use the
9691
+ --output-dir flag to generate one or point to an existing one.
10062
9692
 
10063
- $ sf update --version 1.0.0
9693
+ ALIASES
9694
+ $ sf force apex class create
9695
+ $ sf apex generate class
10064
9696
 
10065
- Interactively select version:
9697
+ EXAMPLES
9698
+ Generate two metadata files associated with the MyClass Apex class (MyClass.cls and MyClass.cls-meta.xml) in the
9699
+ current directory:
10066
9700
 
10067
- $ sf update --interactive
9701
+ $ sf template generate apex class --name MyClass
10068
9702
 
10069
- See available versions:
9703
+ Similar to previous example, but generates the files in the "force-app/main/default/classes" directory:
10070
9704
 
10071
- $ sf update --available
10072
- ```
9705
+ $ sf template generate apex class --name MyClass --output-dir force-app/main/default/classes
10073
9706
 
10074
- _See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/4.7.18/src/commands/update.ts)_
9707
+ FLAG DESCRIPTIONS
9708
+ -d, --output-dir=<value> Directory for saving the created files.
10075
9709
 
10076
- ## `sf version`
9710
+ The location can be an absolute path or relative to the current working directory. The default is the current
9711
+ directory.
10077
9712
 
10078
- ```
10079
- USAGE
10080
- $ sf version [--json] [--verbose]
9713
+ -n, --name=<value> Name of the generated Apex class.
10081
9714
 
10082
- FLAGS
10083
- --verbose Show additional information about the CLI.
9715
+ The name can be up to 40 characters and must start with a letter.
10084
9716
 
10085
- GLOBAL FLAGS
10086
- --json Format output as json.
9717
+ -t, --template=ApexException|ApexUnitTest|BasicUnitTest|DefaultApexClass|InboundEmailService
10087
9718
 
10088
- FLAG DESCRIPTIONS
10089
- --verbose Show additional information about the CLI.
9719
+ Template to use for file creation.
10090
9720
 
10091
- Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.
9721
+ Supplied parameter values or default values are filled into a copy of the template.
10092
9722
  ```
10093
9723
 
10094
- _See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/2.2.36/src/commands/version.ts)_
9724
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/apex/class.ts)_
10095
9725
 
10096
- ## `sf visualforce generate component`
9726
+ ## `sf template generate apex trigger`
10097
9727
 
10098
- Generate a Visualforce Component.
9728
+ Generate an Apex trigger.
10099
9729
 
10100
9730
  ```
10101
9731
  USAGE
10102
- $ sf visualforce generate component -n <value> -l <value> [--json] [--flags-dir <value>] [-t DefaultVFComponent] [-d <value>]
10103
- [--api-version <value>]
9732
+ $ sf template generate apex trigger -n <value> [--json] [--flags-dir <value>] [-t ApexTrigger] [-d <value>] [--api-version
9733
+ <value>] [-s <value>] [-e before insert|before update|before delete|after insert|after update|after delete|after
9734
+ undelete...]
10104
9735
 
10105
9736
  FLAGS
10106
9737
  -d, --output-dir=<value> [default: .] Directory for saving the created files.
10107
- -l, --label=<value> (required) Visualforce Component label.
10108
- -n, --name=<value> (required) Name of the generated Visualforce Component.
10109
- -t, --template=<option> [default: DefaultVFComponent] Template to use for file creation.
10110
- <options: DefaultVFComponent>
9738
+ -e, --event=<option>... [default: before insert] Events that fire the trigger.
9739
+ <options: before insert|before update|before delete|after insert|after update|after
9740
+ delete|after undelete>
9741
+ -n, --name=<value> (required) Name of the generated Apex trigger
9742
+ -s, --sobject=<value> [default: SOBJECT] Salesforce object to generate a trigger on.
9743
+ -t, --template=<option> [default: ApexTrigger] Template to use for file creation.
9744
+ <options: ApexTrigger>
10111
9745
  --api-version=<value> Override the api version used for api requests made by this command
10112
9746
 
10113
9747
  GLOBAL FLAGS
@@ -10115,22 +9749,32 @@ GLOBAL FLAGS
10115
9749
  --json Format output as json.
10116
9750
 
10117
9751
  DESCRIPTION
10118
- Generate a Visualforce Component.
9752
+ Generate an Apex trigger.
10119
9753
 
10120
- The command generates the .Component file and associated metadata file in the specified directory or the current
10121
- working directory by default.
9754
+ Generates the Apex trigger *.trigger file and associated metadata file. These files must be contained in a parent
9755
+ directory called "triggers" in your package directory. Either run this command from an existing directory of this
9756
+ name, or use the --output-dir flag to generate one or point to an existing one.
9757
+
9758
+ If you don't specify the --sobject flag, the .trigger file contains the generic placeholder SOBJECT; replace it with
9759
+ the Salesforce object you want to generate a trigger for. If you don't specify --event, "before insert" is used.
10122
9760
 
10123
9761
  ALIASES
10124
- $ sf force visualforce component create
9762
+ $ sf force apex trigger create
9763
+ $ sf apex generate trigger
10125
9764
 
10126
9765
  EXAMPLES
10127
- Generate the metadata files for a Visualforce component in the current directory:
9766
+ Generate two files associated with the MyTrigger Apex trigger (MyTrigger.trigger and MyTrigger.trigger-meta.xml) in
9767
+ the current directory:
10128
9768
 
10129
- $ sf visualforce generate component --name mycomponent --label mylabel
9769
+ $ sf template generate apex trigger --name MyTrigger
10130
9770
 
10131
- Similar to previous example, but generate the files in the directory "force-app/main/default/components":
9771
+ Similar to the previous example, but generate the files in the "force-app/main/default/triggers" directory:
9772
+
9773
+ $ sf template generate apex trigger --name MyTrigger --output-dir force-app/main/default/triggers
10132
9774
 
10133
- $ sf visualforce generate component --name mycomponent --label mylabel --output-dir components
9775
+ Generate files for a trigger that fires on the Account object before and after an insert:
9776
+
9777
+ $ sf template generate apex trigger --name MyTrigger --sobject Account --event "before insert,after insert"
10134
9778
 
10135
9779
  FLAG DESCRIPTIONS
10136
9780
  -d, --output-dir=<value> Directory for saving the created files.
@@ -10138,66 +9782,695 @@ FLAG DESCRIPTIONS
10138
9782
  The location can be an absolute path or relative to the current working directory. The default is the current
10139
9783
  directory.
10140
9784
 
10141
- -n, --name=<value> Name of the generated Visualforce Component.
9785
+ -n, --name=<value> Name of the generated Apex trigger
10142
9786
 
10143
9787
  The name can be up to 40 characters and must start with a letter.
10144
9788
 
10145
- -t, --template=DefaultVFComponent Template to use for file creation.
9789
+ -t, --template=ApexTrigger Template to use for file creation.
10146
9790
 
10147
9791
  Supplied parameter values or default values are filled into a copy of the template.
10148
9792
  ```
10149
9793
 
10150
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.4.7/src/commands/visualforce/generate/component.ts)_
9794
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/apex/trigger.ts)_
10151
9795
 
10152
- ## `sf visualforce generate page`
9796
+ ## `sf template generate digital-experience site`
10153
9797
 
10154
- Generate a Visualforce Page.
9798
+ Generate an Experience Cloud site.
10155
9799
 
10156
9800
  ```
10157
9801
  USAGE
10158
- $ sf visualforce generate page -n <value> -l <value> [--json] [--flags-dir <value>] [-d <value>] [--api-version
10159
- <value>]
9802
+ $ sf template generate digital-experience site -n <value> -t BuildYourOwnLWR [--json] [--flags-dir <value>] [-o <value>] [-p <value>] [-e
9803
+ <value>] [-d <value>]
10160
9804
 
10161
9805
  FLAGS
10162
- -d, --output-dir=<value> [default: .] Directory for saving the created files.
10163
- -l, --label=<value> (required) Visualforce Page label.
10164
- -n, --name=<value> (required) Name of the generated Visualforce Page.
10165
- --api-version=<value> Override the api version used for api requests made by this command
9806
+ -d, --output-dir=<value> Directory to generate the site files in.
9807
+ -e, --admin-email=<value> Email address for the site administrator. Defaults to the username of the currently
9808
+ authenticated user.
9809
+ -n, --name=<value> (required) Name of the Experience Cloud site to generate.
9810
+ -o, --target-org=<value> Username or alias of the target org.
9811
+ -p, --url-path-prefix=<value> URL path prefix for the site; must contain only alphanumeric characters.
9812
+ -t, --template=<option> (required) Template to use when generating the site.
9813
+ <options: BuildYourOwnLWR>
10166
9814
 
10167
9815
  GLOBAL FLAGS
10168
9816
  --flags-dir=<value> Import flag values from a directory.
10169
9817
  --json Format output as json.
10170
9818
 
10171
9819
  DESCRIPTION
10172
- Generate a Visualforce Page.
10173
-
10174
- The command generates the .Page file and associated metadata file in the specified directory or the current working
10175
- directory by default.
9820
+ Generate an Experience Cloud site.
10176
9821
 
10177
- ALIASES
10178
- $ sf force visualforce page create
9822
+ Creates an Experience Cloud site with the specified template, name, and URL path prefix. The site includes all
9823
+ necessary metadata files, including DigitalExperienceConfig, DigitalExperienceBundle, Network, and CustomSite.
10179
9824
 
10180
9825
  EXAMPLES
10181
- Generate the metadata files for a Visualforce page in the current directory:
9826
+ Generate an Experience Cloud site using the BuildYourOwnLWR template. The site is called "mysite" and has the URL
9827
+ path prefix "mysite":
10182
9828
 
10183
- $ sf visualforce generate page --name mypage --label mylabel
9829
+ $ sf template generate digital-experience site --template BuildYourOwnLWR --name mysite --url-path-prefix mysite
10184
9830
 
10185
- Similar to previous example, but generate the files in the directory "force-app/main/default/pages":
9831
+ Generate an Experience Cloud site like the last example, but generate the files into the specified output directory:
10186
9832
 
10187
- $ sf visualforce generate page --name mypage --label mylabel --output-dir pages
9833
+ $ sf template generate digital-experience site --template BuildYourOwnLWR --name mysite --url-path-prefix mysite \
9834
+ --output-dir force-app/main/default
10188
9835
 
10189
9836
  FLAG DESCRIPTIONS
10190
- -d, --output-dir=<value> Directory for saving the created files.
9837
+ -d, --output-dir=<value> Directory to generate the site files in.
10191
9838
 
10192
- The location can be an absolute path or relative to the current working directory. The default is the current
10193
- directory.
9839
+ The location can be an absolute path or relative to the current working directory. If not specified, the command
9840
+ reads your sfdx-project.json file and uses the default package directory. When running outside a Salesforce DX
9841
+ project, defaults to the current directory.
9842
+ ```
10194
9843
 
10195
- -n, --name=<value> Name of the generated Visualforce Page.
9844
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/digital-experience/site.ts)_
9845
+
9846
+ ## `sf template generate lightning app`
9847
+
9848
+ Generate a Lightning App.
10196
9849
 
10197
- The name can be up to 40 characters and must start with a letter.
10198
9850
  ```
9851
+ USAGE
9852
+ $ sf template generate lightning app -n <value> [--json] [--flags-dir <value>] [-t DefaultLightningApp] [-d <value>] [--api-version
9853
+ <value>]
10199
9854
 
10200
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.4.7/src/commands/visualforce/generate/page.ts)_
9855
+ FLAGS
9856
+ -d, --output-dir=<value> [default: .] Directory for saving the created files.
9857
+ -n, --name=<value> (required) Name of the generated Lightning App.
9858
+ -t, --template=<option> [default: DefaultLightningApp] Template to use for file creation.
9859
+ <options: DefaultLightningApp>
9860
+ --api-version=<value> Override the api version used for api requests made by this command
9861
+
9862
+ GLOBAL FLAGS
9863
+ --flags-dir=<value> Import flag values from a directory.
9864
+ --json Format output as json.
9865
+
9866
+ DESCRIPTION
9867
+ Generate a Lightning App.
9868
+
9869
+ Generates a Lightning App bundle in the specified directory or the current working directory. The bundle consists of
9870
+ multiple files in a folder with the designated name.
9871
+
9872
+ ALIASES
9873
+ $ sf force lightning app create
9874
+ $ sf lightning generate app
9875
+
9876
+ EXAMPLES
9877
+ Generate the metadata files for a Lightning app bundle called "myapp" in the current directory:
9878
+
9879
+ $ sf template generate lightning app --name myapp
9880
+
9881
+ Similar to the previous example, but generate the files in the "force-app/main/default/aura" directory:
9882
+
9883
+ $ sf template generate lightning app --name myapp --output-dir force-app/main/default/aura
9884
+
9885
+ FLAG DESCRIPTIONS
9886
+ -d, --output-dir=<value> Directory for saving the created files.
9887
+
9888
+ The location can be an absolute path or relative to the current working directory. The default is the current
9889
+ directory.
9890
+
9891
+ -n, --name=<value> Name of the generated Lightning App.
9892
+
9893
+ The name can be up to 40 characters and must start with a letter.
9894
+
9895
+ -t, --template=DefaultLightningApp Template to use for file creation.
9896
+
9897
+ Supplied parameter values or default values are filled into a copy of the template.
9898
+ ```
9899
+
9900
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/lightning/app.ts)_
9901
+
9902
+ ## `sf template generate lightning component`
9903
+
9904
+ Generate a bundle for an Aura component or a Lightning web component.
9905
+
9906
+ ```
9907
+ USAGE
9908
+ $ sf template generate lightning component -n <value> [--json] [--flags-dir <value>] [-t
9909
+ default|analyticsDashboard|analyticsDashboardWithStep] [-d <value>] [--api-version <value>] [--type aura|lwc]
9910
+
9911
+ FLAGS
9912
+ -d, --output-dir=<value> [default: .] Directory for saving the created files.
9913
+ -n, --name=<value> (required) Name of the generated Lightning Component.
9914
+ -t, --template=<option> [default: default] Template to use for file creation.
9915
+ <options: default|analyticsDashboard|analyticsDashboardWithStep>
9916
+ --api-version=<value> Override the api version used for api requests made by this command
9917
+ --type=<option> [default: aura] Type of the component bundle.
9918
+ <options: aura|lwc>
9919
+
9920
+ GLOBAL FLAGS
9921
+ --flags-dir=<value> Import flag values from a directory.
9922
+ --json Format output as json.
9923
+
9924
+ DESCRIPTION
9925
+ Generate a bundle for an Aura component or a Lightning web component.
9926
+
9927
+ Generates the bundle in the specified directory or the current working directory. The bundle consists of multiple
9928
+ files in a directory with the designated name. Lightning web components are contained in the directory with name
9929
+ "lwc", Aura components in "aura".
9930
+
9931
+ To generate a Lightning web component, pass "--type lwc" to the command. If you don’t specify --type, Salesforce CLI
9932
+ generates an Aura component by default.
9933
+
9934
+ ALIASES
9935
+ $ sf force lightning component create
9936
+ $ sf lightning generate component
9937
+
9938
+ EXAMPLES
9939
+ Generate the metadata files for an Aura component bundle in the current directory:
9940
+
9941
+ $ sf template generate lightning component --name mycomponent
9942
+
9943
+ Generate a Lightning web component bundle in the current directory:
9944
+
9945
+ $ sf template generate lightning component --name mycomponent --type lwc
9946
+
9947
+ Generate an Aura component bundle in the "force-app/main/default/aura" directory:
9948
+
9949
+ $ sf template generate lightning component --name mycomponent --output-dir force-app/main/default/aura
9950
+
9951
+ Generate a Lightning web component bundle in the "force-app/main/default/lwc" directory:
9952
+
9953
+ $ sf template generate lightning component --name mycomponent --type lwc --output-dir force-app/main/default/lwc
9954
+
9955
+ FLAG DESCRIPTIONS
9956
+ -d, --output-dir=<value> Directory for saving the created files.
9957
+
9958
+ The location can be an absolute path or relative to the current working directory. The default is the current
9959
+ directory.
9960
+
9961
+ -n, --name=<value> Name of the generated Lightning Component.
9962
+
9963
+ The name can be up to 40 characters and must start with a letter.
9964
+
9965
+ -t, --template=default|analyticsDashboard|analyticsDashboardWithStep Template to use for file creation.
9966
+
9967
+ Supplied parameter values or default values are filled into a copy of the template.
9968
+ ```
9969
+
9970
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/lightning/component.ts)_
9971
+
9972
+ ## `sf template generate lightning event`
9973
+
9974
+ Generate a Lightning Event.
9975
+
9976
+ ```
9977
+ USAGE
9978
+ $ sf template generate lightning event -n <value> [--json] [--flags-dir <value>] [-t DefaultLightningEvt] [-d <value>] [--api-version
9979
+ <value>]
9980
+
9981
+ FLAGS
9982
+ -d, --output-dir=<value> [default: .] Directory for saving the created files.
9983
+ -n, --name=<value> (required) Name of the generated Lightning Event.
9984
+ -t, --template=<option> [default: DefaultLightningEvt] Template to use for file creation.
9985
+ <options: DefaultLightningEvt>
9986
+ --api-version=<value> Override the api version used for api requests made by this command
9987
+
9988
+ GLOBAL FLAGS
9989
+ --flags-dir=<value> Import flag values from a directory.
9990
+ --json Format output as json.
9991
+
9992
+ DESCRIPTION
9993
+ Generate a Lightning Event.
9994
+
9995
+ Generates a Lightning Event bundle in the specified directory or the current working directory. The bundle consists of
9996
+ multiple files in a folder with the designated name.
9997
+
9998
+ ALIASES
9999
+ $ sf force lightning event create
10000
+ $ sf lightning generate event
10001
+
10002
+ EXAMPLES
10003
+ Generate the metadata files for a Lightning event bundle called "myevent" in the current directory:
10004
+
10005
+ $ sf template generate lightning event --name myevent
10006
+
10007
+ Similar to previous example, but generate the files in the "force-app/main/default/aura" directory:
10008
+
10009
+ $ sf template generate lightning event --name myevent --output-dir force-app/main/default/aura
10010
+
10011
+ FLAG DESCRIPTIONS
10012
+ -d, --output-dir=<value> Directory for saving the created files.
10013
+
10014
+ The location can be an absolute path or relative to the current working directory. The default is the current
10015
+ directory.
10016
+
10017
+ -n, --name=<value> Name of the generated Lightning Event.
10018
+
10019
+ The name can be up to 40 characters and must start with a letter.
10020
+
10021
+ -t, --template=DefaultLightningEvt Template to use for file creation.
10022
+
10023
+ Supplied parameter values or default values are filled into a copy of the template.
10024
+ ```
10025
+
10026
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/lightning/event.ts)_
10027
+
10028
+ ## `sf template generate lightning interface`
10029
+
10030
+ Generate a Lightning Interface.
10031
+
10032
+ ```
10033
+ USAGE
10034
+ $ sf template generate lightning interface -n <value> [--json] [--flags-dir <value>] [-t DefaultLightningIntf] [-d <value>]
10035
+ [--api-version <value>]
10036
+
10037
+ FLAGS
10038
+ -d, --output-dir=<value> [default: .] Directory for saving the created files.
10039
+ -n, --name=<value> (required) Name of the generated Lightning Interface.
10040
+ -t, --template=<option> [default: DefaultLightningIntf] Template to use for file creation.
10041
+ <options: DefaultLightningIntf>
10042
+ --api-version=<value> Override the api version used for api requests made by this command
10043
+
10044
+ GLOBAL FLAGS
10045
+ --flags-dir=<value> Import flag values from a directory.
10046
+ --json Format output as json.
10047
+
10048
+ DESCRIPTION
10049
+ Generate a Lightning Interface.
10050
+
10051
+ Generates a Lightning Interface bundle in the specified directory or the current working directory. The bundle
10052
+ consists of multiple files in a folder with the designated name.
10053
+
10054
+ ALIASES
10055
+ $ sf force lightning interface create
10056
+ $ sf lightning generate interface
10057
+
10058
+ EXAMPLES
10059
+ Generate the metadata files for a Lightning interface bundle called "myinterface" in the current directory:
10060
+
10061
+ $ sf template generate lightning interface --name myinterface
10062
+
10063
+ Similar to the previous example but generate the files in the "force-app/main/default/aura" directory:
10064
+
10065
+ $ sf template generate lightning interface --name myinterface --output-dir force-app/main/default/aura
10066
+
10067
+ FLAG DESCRIPTIONS
10068
+ -d, --output-dir=<value> Directory for saving the created files.
10069
+
10070
+ The location can be an absolute path or relative to the current working directory. The default is the current
10071
+ directory.
10072
+
10073
+ -n, --name=<value> Name of the generated Lightning Interface.
10074
+
10075
+ The name can be up to 40 characters and must start with a letter.
10076
+
10077
+ -t, --template=DefaultLightningIntf Template to use for file creation.
10078
+
10079
+ Supplied parameter values or default values are filled into a copy of the template.
10080
+ ```
10081
+
10082
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/lightning/interface.ts)_
10083
+
10084
+ ## `sf template generate lightning test`
10085
+
10086
+ Generate a Lightning test.
10087
+
10088
+ ```
10089
+ USAGE
10090
+ $ sf template generate lightning test -n <value> [--json] [--flags-dir <value>] [-t DefaultLightningTest] [-d <value>]
10091
+ [--api-version <value>]
10092
+
10093
+ FLAGS
10094
+ -d, --output-dir=<value> [default: .] Directory for saving the created files.
10095
+ -n, --name=<value> (required) Name of the generated Lightning Test.
10096
+ -t, --template=<option> [default: DefaultLightningTest] Template to use for file creation.
10097
+ <options: DefaultLightningTest>
10098
+ --api-version=<value> Override the api version used for api requests made by this command
10099
+
10100
+ GLOBAL FLAGS
10101
+ --flags-dir=<value> Import flag values from a directory.
10102
+ --json Format output as json.
10103
+
10104
+ DESCRIPTION
10105
+ Generate a Lightning test.
10106
+
10107
+ Generates the test in the specified directory or the current working directory. The .resource file and associated
10108
+ metadata file are generated.
10109
+
10110
+ ALIASES
10111
+ $ sf force lightning test create
10112
+ $ sf lightning generate test
10113
+
10114
+ EXAMPLES
10115
+ Generate the metadata files for the Lightning test called MyLightningTest in the current directory:
10116
+
10117
+ $ sf template generate lightning test --name MyLightningTest
10118
+
10119
+ Similar to the previous example but generate the files in the "force-app/main/default/lightningTests" directory:
10120
+
10121
+ $ sf template generate lightning test --name MyLightningTest --output-dir force-app/main/default/lightningTests
10122
+
10123
+ FLAG DESCRIPTIONS
10124
+ -d, --output-dir=<value> Directory for saving the created files.
10125
+
10126
+ The location can be an absolute path or relative to the current working directory. The default is the current
10127
+ directory.
10128
+
10129
+ -n, --name=<value> Name of the generated Lightning Test.
10130
+
10131
+ Name of the new Lightning test; can be up to 40 characters and must start with a letter.
10132
+
10133
+ -t, --template=DefaultLightningTest Template to use for file creation.
10134
+
10135
+ Supplied parameter values or default values are filled into a copy of the template.
10136
+ ```
10137
+
10138
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/lightning/test.ts)_
10139
+
10140
+ ## `sf template generate project`
10141
+
10142
+ Generate a Salesforce DX project.
10143
+
10144
+ ```
10145
+ USAGE
10146
+ $ sf template generate project -n <value> [--json] [--flags-dir <value>] [-t standard|empty|analytics] [-d <value>] [-s
10147
+ <value>] [-p <value>] [-x] [--api-version <value>]
10148
+
10149
+ FLAGS
10150
+ -d, --output-dir=<value> [default: .] Directory for saving the created files.
10151
+ -n, --name=<value> (required) Name of the generated project.
10152
+ -p, --default-package-dir=<value> [default: force-app] Default package directory name.
10153
+ -s, --namespace=<value> Namespace associated with this project and any connected scratch orgs.
10154
+ -t, --template=<option> [default: standard] Template to use for project creation.
10155
+ <options: standard|empty|analytics>
10156
+ -x, --manifest Generate a manifest (package.xml) for change-set based development.
10157
+ --api-version=<value> Will set this version as sourceApiVersion in the sfdx-project.json file
10158
+
10159
+ GLOBAL FLAGS
10160
+ --flags-dir=<value> Import flag values from a directory.
10161
+ --json Format output as json.
10162
+
10163
+ DESCRIPTION
10164
+ Generate a Salesforce DX project.
10165
+
10166
+ A Salesforce DX project has a specific structure and a configuration file (sfdx-project.json) that identifies the
10167
+ directory as a Salesforce DX project. This command generates the necessary configuration files and directories to get
10168
+ you started.
10169
+
10170
+ By default, the generated sfdx-project.json file sets the sourceApiVersion property to the default API version
10171
+ currently used by Salesforce CLI. To specify a different version, set the apiVersion configuration variable. For
10172
+ example: "sf config set apiVersion=57.0 --global".
10173
+
10174
+ ALIASES
10175
+ $ sf force project create
10176
+ $ sf project generate
10177
+
10178
+ EXAMPLES
10179
+ Generate a project called "mywork":
10180
+
10181
+ $ sf template generate project --name mywork
10182
+
10183
+ Similar to previous example, but generate the files in a directory called "myapp":
10184
+
10185
+ $ sf template generate project --name mywork --default-package-dir myapp
10186
+
10187
+ Similar to prevoius example, but also generate a default package.xml manifest file:
10188
+
10189
+ $ sf template generate project --name mywork --default-package-dir myapp --manifest
10190
+
10191
+ Generate a project with the minimum files and directories:
10192
+
10193
+ $ sf template generate project --name mywork --template empty
10194
+
10195
+ FLAG DESCRIPTIONS
10196
+ -d, --output-dir=<value> Directory for saving the created files.
10197
+
10198
+ The location can be an absolute path or relative to the current working directory. The default is the current
10199
+ directory.
10200
+
10201
+ -n, --name=<value> Name of the generated project.
10202
+
10203
+ Generates a project directory with this name; any valid directory name is accepted. Also sets the "name" property in
10204
+ the sfdx-project.json file to this name.
10205
+
10206
+ -p, --default-package-dir=<value> Default package directory name.
10207
+
10208
+ Metadata items such as classes and Lightning bundles are placed inside this folder.
10209
+
10210
+ -t, --template=standard|empty|analytics Template to use for project creation.
10211
+
10212
+ The template determines the sample configuration files and directories that this command generates. For example, the
10213
+ empty template provides these files and directory to get you started.
10214
+
10215
+ - .forceignore
10216
+ - config/project-scratch-def.json
10217
+ - sfdx-project.json
10218
+ - package.json
10219
+ - force-app (basic source directory structure)
10220
+
10221
+ The standard template provides a complete force-app directory structure so you know where to put your source. It
10222
+ also provides additional files and scripts, especially useful when using Salesforce Extensions for VS Code. For
10223
+ example:
10224
+
10225
+ - .gitignore: Use Git for version control.
10226
+ - .prettierrc and .prettierignore: Use Prettier to format your Aura components.
10227
+ - .vscode/extensions.json: When launched, Visual Studio Code, prompts you to install the recommended extensions for
10228
+ your project.
10229
+ - .vscode/launch.json: Configures Replay Debugger.
10230
+ - .vscode/settings.json: Additional configuration settings.
10231
+
10232
+ The analytics template provides similar files and the force-app/main/default/waveTemplates directory.
10233
+
10234
+ -x, --manifest Generate a manifest (package.xml) for change-set based development.
10235
+
10236
+ Generates a default manifest (package.xml) for fetching Apex, Visualforce, Lightning components, and static
10237
+ resources.
10238
+
10239
+ --api-version=<value> Will set this version as sourceApiVersion in the sfdx-project.json file
10240
+
10241
+ Override the api version used for api requests made by this command
10242
+ ```
10243
+
10244
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/project/index.ts)_
10245
+
10246
+ ## `sf template generate static-resource`
10247
+
10248
+ Generate a static resource.
10249
+
10250
+ ```
10251
+ USAGE
10252
+ $ sf template generate static-resource -n <value> [--json] [--flags-dir <value>] [--type <value>] [-d <value>]
10253
+ [--api-version <value>]
10254
+
10255
+ FLAGS
10256
+ -d, --output-dir=<value> [default: .] Directory for saving the created files.
10257
+ -n, --name=<value> (required) Name of the generated static resource.
10258
+ --api-version=<value> Override the api version used for api requests made by this command
10259
+ --type=<value> [default: application/zip] Content type (mime type) of the generated static resource.
10260
+
10261
+ GLOBAL FLAGS
10262
+ --flags-dir=<value> Import flag values from a directory.
10263
+ --json Format output as json.
10264
+
10265
+ DESCRIPTION
10266
+ Generate a static resource.
10267
+
10268
+ Generates the metadata resource file in the specified directory or the current working directory. Static resource
10269
+ files must be contained in a parent directory called "staticresources" in your package directory. Either run this
10270
+ command from an existing directory of this name, or use the --output-dir flag to create one or point to an existing
10271
+ one.
10272
+
10273
+ ALIASES
10274
+ $ sf force staticresource create
10275
+ $ sf static-resource generate
10276
+
10277
+ EXAMPLES
10278
+ Generate the metadata file for a static resource called MyResource in the current directory:
10279
+
10280
+ $ sf template generate static-resource --name MyResource
10281
+
10282
+ Similar to previous example, but specifies a MIME type of application/json:
10283
+
10284
+ $ sf template generate static-resource --name MyResource --type application/json
10285
+
10286
+ Generate the resource file in the "force-app/main/default/staticresources" directory:
10287
+
10288
+ $ sf template generate static-resource --name MyResource --output-dir force-app/main/default/staticresources
10289
+
10290
+ FLAG DESCRIPTIONS
10291
+ -d, --output-dir=<value> Directory for saving the created files.
10292
+
10293
+ The location can be an absolute path or relative to the current working directory. The default is the current
10294
+ directory.
10295
+
10296
+ -n, --name=<value> Name of the generated static resource.
10297
+
10298
+ This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin
10299
+ with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.
10300
+
10301
+ --type=<value> Content type (mime type) of the generated static resource.
10302
+
10303
+ Must be a valid MIME type such as application/json, application/javascript, application/zip, text/plain, text/css,
10304
+ etc.
10305
+ ```
10306
+
10307
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/static-resource/index.ts)_
10308
+
10309
+ ## `sf template generate visualforce component`
10310
+
10311
+ Generate a Visualforce Component.
10312
+
10313
+ ```
10314
+ USAGE
10315
+ $ sf template generate visualforce component -n <value> -l <value> [--json] [--flags-dir <value>] [-t DefaultVFComponent] [-d <value>]
10316
+ [--api-version <value>]
10317
+
10318
+ FLAGS
10319
+ -d, --output-dir=<value> [default: .] Directory for saving the created files.
10320
+ -l, --label=<value> (required) Visualforce Component label.
10321
+ -n, --name=<value> (required) Name of the generated Visualforce Component.
10322
+ -t, --template=<option> [default: DefaultVFComponent] Template to use for file creation.
10323
+ <options: DefaultVFComponent>
10324
+ --api-version=<value> Override the api version used for api requests made by this command
10325
+
10326
+ GLOBAL FLAGS
10327
+ --flags-dir=<value> Import flag values from a directory.
10328
+ --json Format output as json.
10329
+
10330
+ DESCRIPTION
10331
+ Generate a Visualforce Component.
10332
+
10333
+ The command generates the .Component file and associated metadata file in the specified directory or the current
10334
+ working directory by default.
10335
+
10336
+ ALIASES
10337
+ $ sf force visualforce component create
10338
+ $ sf visualforce generate component
10339
+
10340
+ EXAMPLES
10341
+ Generate the metadata files for a Visualforce component in the current directory:
10342
+
10343
+ $ sf template generate visualforce component --name mycomponent --label mylabel
10344
+
10345
+ Similar to previous example, but generate the files in the directory "force-app/main/default/components":
10346
+
10347
+ $ sf template generate visualforce component --name mycomponent --label mylabel --output-dir components
10348
+
10349
+ FLAG DESCRIPTIONS
10350
+ -d, --output-dir=<value> Directory for saving the created files.
10351
+
10352
+ The location can be an absolute path or relative to the current working directory. The default is the current
10353
+ directory.
10354
+
10355
+ -n, --name=<value> Name of the generated Visualforce Component.
10356
+
10357
+ The name can be up to 40 characters and must start with a letter.
10358
+
10359
+ -t, --template=DefaultVFComponent Template to use for file creation.
10360
+
10361
+ Supplied parameter values or default values are filled into a copy of the template.
10362
+ ```
10363
+
10364
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/visualforce/component.ts)_
10365
+
10366
+ ## `sf template generate visualforce page`
10367
+
10368
+ Generate a Visualforce Page.
10369
+
10370
+ ```
10371
+ USAGE
10372
+ $ sf template generate visualforce page -n <value> -l <value> [--json] [--flags-dir <value>] [-d <value>]
10373
+ [--api-version <value>]
10374
+
10375
+ FLAGS
10376
+ -d, --output-dir=<value> [default: .] Directory for saving the created files.
10377
+ -l, --label=<value> (required) Visualforce Page label.
10378
+ -n, --name=<value> (required) Name of the generated Visualforce Page.
10379
+ --api-version=<value> Override the api version used for api requests made by this command
10380
+
10381
+ GLOBAL FLAGS
10382
+ --flags-dir=<value> Import flag values from a directory.
10383
+ --json Format output as json.
10384
+
10385
+ DESCRIPTION
10386
+ Generate a Visualforce Page.
10387
+
10388
+ The command generates the .Page file and associated metadata file in the specified directory or the current working
10389
+ directory by default.
10390
+
10391
+ ALIASES
10392
+ $ sf force visualforce page create
10393
+ $ sf visualforce generate page
10394
+
10395
+ EXAMPLES
10396
+ Generate the metadata files for a Visualforce page in the current directory:
10397
+
10398
+ $ sf template generate visualforce page --name mypage --label mylabel
10399
+
10400
+ Similar to previous example, but generate the files in the directory "force-app/main/default/pages":
10401
+
10402
+ $ sf template generate visualforce page --name mypage --label mylabel --output-dir pages
10403
+
10404
+ FLAG DESCRIPTIONS
10405
+ -d, --output-dir=<value> Directory for saving the created files.
10406
+
10407
+ The location can be an absolute path or relative to the current working directory. The default is the current
10408
+ directory.
10409
+
10410
+ -n, --name=<value> Name of the generated Visualforce Page.
10411
+
10412
+ The name can be up to 40 characters and must start with a letter.
10413
+ ```
10414
+
10415
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.7.1/src/commands/template/generate/visualforce/page.ts)_
10416
+
10417
+ ## `sf update [CHANNEL]`
10418
+
10419
+ update the sf CLI
10420
+
10421
+ ```
10422
+ USAGE
10423
+ $ sf update [CHANNEL] [--force | | [-a | -v <value> | -i]] [-b ]
10424
+
10425
+ FLAGS
10426
+ -a, --available See available versions.
10427
+ -b, --verbose Show more details about the available versions.
10428
+ -i, --interactive Interactively select version to install. This is ignored if a channel is provided.
10429
+ -v, --version=<value> Install a specific version.
10430
+ --force Force a re-download of the requested version.
10431
+
10432
+ DESCRIPTION
10433
+ update the sf CLI
10434
+
10435
+ EXAMPLES
10436
+ Update to the stable channel:
10437
+
10438
+ $ sf update stable
10439
+
10440
+ Update to a specific version:
10441
+
10442
+ $ sf update --version 1.0.0
10443
+
10444
+ Interactively select version:
10445
+
10446
+ $ sf update --interactive
10447
+
10448
+ See available versions:
10449
+
10450
+ $ sf update --available
10451
+ ```
10452
+
10453
+ _See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/4.7.19/src/commands/update.ts)_
10454
+
10455
+ ## `sf version`
10456
+
10457
+ ```
10458
+ USAGE
10459
+ $ sf version [--json] [--verbose]
10460
+
10461
+ FLAGS
10462
+ --verbose Show additional information about the CLI.
10463
+
10464
+ GLOBAL FLAGS
10465
+ --json Format output as json.
10466
+
10467
+ FLAG DESCRIPTIONS
10468
+ --verbose Show additional information about the CLI.
10469
+
10470
+ Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.
10471
+ ```
10472
+
10473
+ _See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/2.2.36/src/commands/version.ts)_
10201
10474
 
10202
10475
  ## `sf which`
10203
10476