@salesforce/cli 2.122.6 → 2.123.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1238 -956
- package/npm-shrinkwrap.json +348 -341
- package/oclif.lock +385 -379
- package/oclif.manifest.json +1 -1
- 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.
|
|
28
|
+
@salesforce/cli/2.123.1 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
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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
|
|
|
@@ -471,18 +476,20 @@ Generate an authoring bundle from an existing agent spec YAML file.
|
|
|
471
476
|
```
|
|
472
477
|
USAGE
|
|
473
478
|
$ sf agent generate authoring-bundle -o <value> [--json] [--flags-dir <value>] [--api-name <value>] [--api-version <value>] [-f
|
|
474
|
-
<value>] [-d <value>] [-n <value>]
|
|
479
|
+
<value>] [--no-spec] [-d <value>] [-n <value>]
|
|
475
480
|
|
|
476
481
|
FLAGS
|
|
477
482
|
-d, --output-dir=<value> Directory where the authoring bundle files are generated.
|
|
478
|
-
-f, --spec=<value> Path to the agent spec YAML file
|
|
479
|
-
can choose from.
|
|
483
|
+
-f, --spec=<value> Path to the agent spec YAML file. If you don't specify the flag, the command provides a
|
|
484
|
+
list that you can choose from. Use the --no-spec flag to skip using an agent spec entirely.
|
|
480
485
|
-n, --name=<value> Name (label) of the authoring bundle; if not specified, you're prompted for the name.
|
|
481
486
|
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
482
487
|
configuration variable is already set.
|
|
483
488
|
--api-name=<value> API name of the new authoring bundle; if not specified, the API name is derived from the
|
|
484
489
|
authoring bundle name (label); the API name can't exist in the org.
|
|
485
490
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
491
|
+
--no-spec Skip prompting for an agent spec and use the default Agent Script boilerplate in the
|
|
492
|
+
generated authoring bundle.
|
|
486
493
|
|
|
487
494
|
GLOBAL FLAGS
|
|
488
495
|
--flags-dir=<value> Import flag values from a directory.
|
|
@@ -496,7 +503,9 @@ DESCRIPTION
|
|
|
496
503
|
|
|
497
504
|
Use this command to generate a new authoring bundle based on an agent spec YAML file, which you create with the "agent
|
|
498
505
|
generate agent-spec" command. The agent spec YAML file is a high-level description of the agent; it describes its
|
|
499
|
-
essence rather than exactly what it can do.
|
|
506
|
+
essence rather than exactly what it can do. The resulting Agent Script file is customized to reflect what's in the
|
|
507
|
+
agent spec file. You can also create an authoring bundle without an agent spec file by specifying the "--no-spec"
|
|
508
|
+
flag; in this case, the resulting Agent Script file is just the default boilerplate.
|
|
500
509
|
|
|
501
510
|
The metadata type for authoring bundles is aiAuthoringBundle, which consist of a standard
|
|
502
511
|
"<bundle-api-name>.bundle-meta.xml" metadata file and the Agent Script file (with extension ".agent"). When you run
|
|
@@ -516,6 +525,11 @@ EXAMPLES
|
|
|
516
525
|
|
|
517
526
|
$ sf agent generate authoring-bundle
|
|
518
527
|
|
|
528
|
+
Generate an authoring bundle without using an agent spec file; give the bundle the label "My Authoring Bundle" and
|
|
529
|
+
use your default org:
|
|
530
|
+
|
|
531
|
+
$ sf agent generate authoring-bundle --no-spec --name "My Authoring Bundle"
|
|
532
|
+
|
|
519
533
|
Generate an authoring bundle from the "specs/agentSpec.yaml" agent spec YAML file and give it the label "My
|
|
520
534
|
Authoring Bundle"; use your default org:
|
|
521
535
|
|
|
@@ -528,7 +542,7 @@ EXAMPLES
|
|
|
528
542
|
other-package-dir/main/default --target-org my-dev-org
|
|
529
543
|
```
|
|
530
544
|
|
|
531
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
545
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.29.0/src/commands/agent/generate/authoring-bundle.ts)_
|
|
532
546
|
|
|
533
547
|
## `sf agent generate template`
|
|
534
548
|
|
|
@@ -576,7 +590,7 @@ EXAMPLES
|
|
|
576
590
|
force-app/main/default/bots/My_Awesome_Agent/My_Awesome_Agent.bot-meta.xml --agent-version 1
|
|
577
591
|
```
|
|
578
592
|
|
|
579
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
593
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.29.0/src/commands/agent/generate/template.ts)_
|
|
580
594
|
|
|
581
595
|
## `sf agent generate test-spec`
|
|
582
596
|
|
|
@@ -637,7 +651,7 @@ EXAMPLES
|
|
|
637
651
|
force-app//main/default/aiEvaluationDefinitions/Resort_Manager_Tests.aiEvaluationDefinition-meta.xml
|
|
638
652
|
```
|
|
639
653
|
|
|
640
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
654
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.29.0/src/commands/agent/generate/test-spec.ts)_
|
|
641
655
|
|
|
642
656
|
## `sf agent preview`
|
|
643
657
|
|
|
@@ -650,7 +664,7 @@ USAGE
|
|
|
650
664
|
|
|
651
665
|
FLAGS
|
|
652
666
|
-d, --output-dir=<value> Directory where conversation transcripts are saved.
|
|
653
|
-
-n, --api-name=<value> API name of the published
|
|
667
|
+
-n, --api-name=<value> API name of the activated published agent you want to interact with.
|
|
654
668
|
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
655
669
|
configuration variable is already set.
|
|
656
670
|
-x, --apex-debug Enable Apex debug logging during the agent preview conversation.
|
|
@@ -710,7 +724,210 @@ EXAMPLES
|
|
|
710
724
|
$ sf agent preview --use-live-actions --apex-debug --output-dir transcripts/my-preview
|
|
711
725
|
```
|
|
712
726
|
|
|
713
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
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)_
|
|
714
931
|
|
|
715
932
|
## `sf agent publish authoring-bundle`
|
|
716
933
|
|
|
@@ -759,7 +976,7 @@ EXAMPLES
|
|
|
759
976
|
$ sf agent publish authoring-bundle --api-name MyAuthoringbundle --target-org my-dev-org
|
|
760
977
|
```
|
|
761
978
|
|
|
762
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
979
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.29.0/src/commands/agent/publish/authoring-bundle.ts)_
|
|
763
980
|
|
|
764
981
|
## `sf agent test create`
|
|
765
982
|
|
|
@@ -814,7 +1031,7 @@ EXAMPLES
|
|
|
814
1031
|
$ sf agent test create --spec specs/Resort_Manager-testSpec.yaml --api-name Resort_Manager_Test --preview
|
|
815
1032
|
```
|
|
816
1033
|
|
|
817
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1034
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.29.0/src/commands/agent/test/create.ts)_
|
|
818
1035
|
|
|
819
1036
|
## `sf agent test list`
|
|
820
1037
|
|
|
@@ -849,7 +1066,7 @@ EXAMPLES
|
|
|
849
1066
|
$ sf agent test list --target-org my-org
|
|
850
1067
|
```
|
|
851
1068
|
|
|
852
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1069
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.29.0/src/commands/agent/test/list.ts)_
|
|
853
1070
|
|
|
854
1071
|
## `sf agent test results`
|
|
855
1072
|
|
|
@@ -915,7 +1132,7 @@ FLAG DESCRIPTIONS
|
|
|
915
1132
|
expression when using custom evaluations.
|
|
916
1133
|
```
|
|
917
1134
|
|
|
918
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1135
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.29.0/src/commands/agent/test/results.ts)_
|
|
919
1136
|
|
|
920
1137
|
## `sf agent test resume`
|
|
921
1138
|
|
|
@@ -988,7 +1205,7 @@ FLAG DESCRIPTIONS
|
|
|
988
1205
|
expression when using custom evaluations.
|
|
989
1206
|
```
|
|
990
1207
|
|
|
991
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1208
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.29.0/src/commands/agent/test/resume.ts)_
|
|
992
1209
|
|
|
993
1210
|
## `sf agent test run`
|
|
994
1211
|
|
|
@@ -1062,7 +1279,7 @@ FLAG DESCRIPTIONS
|
|
|
1062
1279
|
expression when using custom evaluations.
|
|
1063
1280
|
```
|
|
1064
1281
|
|
|
1065
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1282
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.29.0/src/commands/agent/test/run.ts)_
|
|
1066
1283
|
|
|
1067
1284
|
## `sf agent validate authoring-bundle`
|
|
1068
1285
|
|
|
@@ -1109,7 +1326,7 @@ EXAMPLES
|
|
|
1109
1326
|
$ sf agent validate authoring-bundle --api-name MyAuthoringBundle --target-org my-dev-org
|
|
1110
1327
|
```
|
|
1111
1328
|
|
|
1112
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1329
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.29.0/src/commands/agent/validate/authoring-bundle.ts)_
|
|
1113
1330
|
|
|
1114
1331
|
## `sf alias list`
|
|
1115
1332
|
|
|
@@ -1137,7 +1354,7 @@ EXAMPLES
|
|
|
1137
1354
|
$ sf alias list
|
|
1138
1355
|
```
|
|
1139
1356
|
|
|
1140
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.
|
|
1357
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.55/src/commands/alias/list.ts)_
|
|
1141
1358
|
|
|
1142
1359
|
## `sf alias set`
|
|
1143
1360
|
|
|
@@ -1186,7 +1403,7 @@ EXAMPLES
|
|
|
1186
1403
|
$ sf alias set my-scratch-org test-ss0xut7txzxf@example.com
|
|
1187
1404
|
```
|
|
1188
1405
|
|
|
1189
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.
|
|
1406
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.55/src/commands/alias/set.ts)_
|
|
1190
1407
|
|
|
1191
1408
|
## `sf alias unset`
|
|
1192
1409
|
|
|
@@ -1226,19 +1443,23 @@ EXAMPLES
|
|
|
1226
1443
|
$ sf alias unset --all [--no-prompt]
|
|
1227
1444
|
```
|
|
1228
1445
|
|
|
1229
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.
|
|
1446
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.55/src/commands/alias/unset.ts)_
|
|
1230
1447
|
|
|
1231
|
-
## `sf
|
|
1448
|
+
## `sf apex get log`
|
|
1232
1449
|
|
|
1233
|
-
|
|
1450
|
+
Fetch the specified log or given number of most recent logs from the org.
|
|
1234
1451
|
|
|
1235
1452
|
```
|
|
1236
1453
|
USAGE
|
|
1237
|
-
$ sf
|
|
1454
|
+
$ sf apex get log -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-i <value>] [-n <value>]
|
|
1455
|
+
[-d <value>]
|
|
1238
1456
|
|
|
1239
1457
|
FLAGS
|
|
1240
|
-
-d, --output-dir=<value>
|
|
1241
|
-
-
|
|
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.
|
|
1242
1463
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1243
1464
|
|
|
1244
1465
|
GLOBAL FLAGS
|
|
@@ -1246,108 +1467,111 @@ GLOBAL FLAGS
|
|
|
1246
1467
|
--json Format output as json.
|
|
1247
1468
|
|
|
1248
1469
|
DESCRIPTION
|
|
1249
|
-
|
|
1470
|
+
Fetch the specified log or given number of most recent logs from the org.
|
|
1250
1471
|
|
|
1251
|
-
|
|
1252
|
-
|
|
1253
|
-
--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.
|
|
1254
1474
|
|
|
1255
1475
|
ALIASES
|
|
1256
|
-
$ sf force
|
|
1476
|
+
$ sf force apex log get
|
|
1257
1477
|
|
|
1258
1478
|
EXAMPLES
|
|
1259
|
-
|
|
1260
|
-
|
|
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:
|
|
1261
1488
|
|
|
1262
|
-
$ sf
|
|
1489
|
+
$ sf apex get log --number 2
|
|
1490
|
+
|
|
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
|
|
1263
1494
|
|
|
1264
1495
|
FLAG DESCRIPTIONS
|
|
1265
|
-
-d, --output-dir=<value> Directory for saving the
|
|
1496
|
+
-d, --output-dir=<value> Directory for saving the log files.
|
|
1266
1497
|
|
|
1267
1498
|
The location can be an absolute path or relative to the current working directory. The default is the current
|
|
1268
1499
|
directory.
|
|
1269
1500
|
```
|
|
1270
1501
|
|
|
1271
|
-
_See code: [@salesforce/plugin-
|
|
1502
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.6/src/commands/apex/get/log.ts)_
|
|
1272
1503
|
|
|
1273
|
-
## `sf apex
|
|
1504
|
+
## `sf apex get test`
|
|
1274
1505
|
|
|
1275
|
-
|
|
1506
|
+
Display test results for a specific asynchronous test run.
|
|
1276
1507
|
|
|
1277
1508
|
```
|
|
1278
1509
|
USAGE
|
|
1279
|
-
$ sf apex
|
|
1280
|
-
|
|
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]
|
|
1281
1512
|
|
|
1282
1513
|
FLAGS
|
|
1283
|
-
-
|
|
1284
|
-
-
|
|
1285
|
-
-
|
|
1286
|
-
|
|
1287
|
-
|
|
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.
|
|
1288
1524
|
|
|
1289
1525
|
GLOBAL FLAGS
|
|
1290
1526
|
--flags-dir=<value> Import flag values from a directory.
|
|
1291
1527
|
--json Format output as json.
|
|
1292
1528
|
|
|
1293
1529
|
DESCRIPTION
|
|
1294
|
-
|
|
1530
|
+
Display test results for a specific asynchronous test run.
|
|
1295
1531
|
|
|
1296
|
-
|
|
1297
|
-
|
|
1298
|
-
|
|
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.
|
|
1299
1538
|
|
|
1300
1539
|
ALIASES
|
|
1301
|
-
$ sf force apex
|
|
1540
|
+
$ sf force apex test report
|
|
1302
1541
|
|
|
1303
1542
|
EXAMPLES
|
|
1304
|
-
|
|
1305
|
-
current directory:
|
|
1306
|
-
|
|
1307
|
-
$ sf apex generate class --name MyClass
|
|
1308
|
-
|
|
1309
|
-
Similar to previous example, but generates the files in the "force-app/main/default/classes" directory:
|
|
1310
|
-
|
|
1311
|
-
$ 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:
|
|
1312
1544
|
|
|
1313
|
-
|
|
1314
|
-
-d, --output-dir=<value> Directory for saving the created files.
|
|
1545
|
+
$ sf apex get test --test-run-id <test run id>
|
|
1315
1546
|
|
|
1316
|
-
|
|
1317
|
-
directory.
|
|
1547
|
+
Similar to previous example, but output the result in JUnit format:
|
|
1318
1548
|
|
|
1319
|
-
|
|
1549
|
+
$ sf apex get test --test-run-id <test run id> --result-format junit
|
|
1320
1550
|
|
|
1321
|
-
|
|
1551
|
+
Also retrieve code coverage results and output in JSON format:
|
|
1322
1552
|
|
|
1323
|
-
|
|
1553
|
+
$ sf apex get test --test-run-id <test run id> --code-coverage --json
|
|
1324
1554
|
|
|
1325
|
-
|
|
1555
|
+
Specify a directory in which to save the test results from the org with the specified username (rather than your
|
|
1556
|
+
default org):
|
|
1326
1557
|
|
|
1327
|
-
|
|
1558
|
+
$ sf apex get test --test-run-id <test run id> --code-coverage --output-dir <path to outputdir> --target-org \
|
|
1559
|
+
me@myorg'
|
|
1328
1560
|
```
|
|
1329
1561
|
|
|
1330
|
-
_See code: [@salesforce/plugin-
|
|
1562
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.6/src/commands/apex/get/test.ts)_
|
|
1331
1563
|
|
|
1332
|
-
## `sf apex
|
|
1564
|
+
## `sf apex list log`
|
|
1333
1565
|
|
|
1334
|
-
|
|
1566
|
+
Display a list of IDs and general information about debug logs.
|
|
1335
1567
|
|
|
1336
1568
|
```
|
|
1337
1569
|
USAGE
|
|
1338
|
-
$ sf apex
|
|
1339
|
-
<value>] [-s <value>] [-e before insert|before update|before delete|after insert|after update|after delete|after
|
|
1340
|
-
undelete...]
|
|
1570
|
+
$ sf apex list log -o <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
1341
1571
|
|
|
1342
1572
|
FLAGS
|
|
1343
|
-
-
|
|
1344
|
-
|
|
1345
|
-
<options: before insert|before update|before delete|after insert|after update|after
|
|
1346
|
-
delete|after undelete>
|
|
1347
|
-
-n, --name=<value> (required) Name of the generated Apex trigger
|
|
1348
|
-
-s, --sobject=<value> [default: SOBJECT] Salesforce object to generate a trigger on.
|
|
1349
|
-
-t, --template=<option> [default: ApexTrigger] Template to use for file creation.
|
|
1350
|
-
<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.
|
|
1351
1575
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
1352
1576
|
|
|
1353
1577
|
GLOBAL FLAGS
|
|
@@ -1355,212 +1579,35 @@ GLOBAL FLAGS
|
|
|
1355
1579
|
--json Format output as json.
|
|
1356
1580
|
|
|
1357
1581
|
DESCRIPTION
|
|
1358
|
-
|
|
1582
|
+
Display a list of IDs and general information about debug logs.
|
|
1359
1583
|
|
|
1360
|
-
|
|
1361
|
-
directory called "triggers" in your package directory. Either run this command from an existing directory of this
|
|
1362
|
-
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.
|
|
1363
1585
|
|
|
1364
|
-
|
|
1365
|
-
|
|
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.
|
|
1366
1588
|
|
|
1367
1589
|
ALIASES
|
|
1368
|
-
$ sf force apex
|
|
1590
|
+
$ sf force apex log list
|
|
1369
1591
|
|
|
1370
1592
|
EXAMPLES
|
|
1371
|
-
|
|
1372
|
-
the current directory:
|
|
1593
|
+
List the IDs and information about the debug logs in your default org:
|
|
1373
1594
|
|
|
1374
|
-
$ sf apex
|
|
1595
|
+
$ sf apex list log
|
|
1375
1596
|
|
|
1376
|
-
Similar to
|
|
1597
|
+
Similar to previous example, but use the org with the specified username:
|
|
1377
1598
|
|
|
1378
|
-
$ sf apex
|
|
1599
|
+
$ sf apex list log --target-org me@my.org
|
|
1600
|
+
```
|
|
1379
1601
|
|
|
1380
|
-
|
|
1602
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.6/src/commands/apex/list/log.ts)_
|
|
1381
1603
|
|
|
1382
|
-
|
|
1604
|
+
## `sf apex run`
|
|
1383
1605
|
|
|
1384
|
-
|
|
1385
|
-
-d, --output-dir=<value> Directory for saving the created files.
|
|
1606
|
+
Execute anonymous Apex code entered on the command line or from a local file.
|
|
1386
1607
|
|
|
1387
|
-
|
|
1388
|
-
|
|
1389
|
-
|
|
1390
|
-
-n, --name=<value> Name of the generated Apex trigger
|
|
1391
|
-
|
|
1392
|
-
The name can be up to 40 characters and must start with a letter.
|
|
1393
|
-
|
|
1394
|
-
-t, --template=ApexTrigger Template to use for file creation.
|
|
1395
|
-
|
|
1396
|
-
Supplied parameter values or default values are filled into a copy of the template.
|
|
1397
|
-
```
|
|
1398
|
-
|
|
1399
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.4.7/src/commands/apex/generate/trigger.ts)_
|
|
1400
|
-
|
|
1401
|
-
## `sf apex get log`
|
|
1402
|
-
|
|
1403
|
-
Fetch the specified log or given number of most recent logs from the org.
|
|
1404
|
-
|
|
1405
|
-
```
|
|
1406
|
-
USAGE
|
|
1407
|
-
$ sf apex get log -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-i <value>] [-n <value>]
|
|
1408
|
-
[-d <value>]
|
|
1409
|
-
|
|
1410
|
-
FLAGS
|
|
1411
|
-
-d, --output-dir=<value> Directory for saving the log files.
|
|
1412
|
-
-i, --log-id=<value> ID of the specific log to display.
|
|
1413
|
-
-n, --number=<value> Number of the most recent logs to display.
|
|
1414
|
-
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
1415
|
-
configuration variable is already set.
|
|
1416
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
1417
|
-
|
|
1418
|
-
GLOBAL FLAGS
|
|
1419
|
-
--flags-dir=<value> Import flag values from a directory.
|
|
1420
|
-
--json Format output as json.
|
|
1421
|
-
|
|
1422
|
-
DESCRIPTION
|
|
1423
|
-
Fetch the specified log or given number of most recent logs from the org.
|
|
1424
|
-
|
|
1425
|
-
To get the IDs for your debug logs, run "sf apex log list". Executing this command without flags returns the most
|
|
1426
|
-
recent log.
|
|
1427
|
-
|
|
1428
|
-
ALIASES
|
|
1429
|
-
$ sf force apex log get
|
|
1430
|
-
|
|
1431
|
-
EXAMPLES
|
|
1432
|
-
Fetch the log in your default org using an ID:
|
|
1433
|
-
|
|
1434
|
-
$ sf apex get log --log-id <log id>
|
|
1435
|
-
|
|
1436
|
-
Fetch the log in the org with the specified username using an ID:
|
|
1437
|
-
|
|
1438
|
-
$ sf apex get log --log-id <log id> --target-org me@my.org
|
|
1439
|
-
|
|
1440
|
-
Fetch the two most recent logs in your default org:
|
|
1441
|
-
|
|
1442
|
-
$ sf apex get log --number 2
|
|
1443
|
-
|
|
1444
|
-
Similar to previous example, but save the two log files in the specified directory:
|
|
1445
|
-
|
|
1446
|
-
$ sf apex get log --output-dir /Users/sfdxUser/logs --number 2
|
|
1447
|
-
|
|
1448
|
-
FLAG DESCRIPTIONS
|
|
1449
|
-
-d, --output-dir=<value> Directory for saving the log files.
|
|
1450
|
-
|
|
1451
|
-
The location can be an absolute path or relative to the current working directory. The default is the current
|
|
1452
|
-
directory.
|
|
1453
|
-
```
|
|
1454
|
-
|
|
1455
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.5/src/commands/apex/get/log.ts)_
|
|
1456
|
-
|
|
1457
|
-
## `sf apex get test`
|
|
1458
|
-
|
|
1459
|
-
Display test results for a specific asynchronous test run.
|
|
1460
|
-
|
|
1461
|
-
```
|
|
1462
|
-
USAGE
|
|
1463
|
-
$ sf apex get test -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
1464
|
-
[--detailed-coverage -c] [-d <value>] [-r human|tap|junit|json] [--concise]
|
|
1465
|
-
|
|
1466
|
-
FLAGS
|
|
1467
|
-
-c, --code-coverage Retrieve code coverage results.
|
|
1468
|
-
-d, --output-dir=<value> Directory in which to store test result files.
|
|
1469
|
-
-i, --test-run-id=<value> (required) ID of the test run.
|
|
1470
|
-
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
1471
|
-
configuration variable is already set.
|
|
1472
|
-
-r, --result-format=<option> [default: human] Format of the test results.
|
|
1473
|
-
<options: human|tap|junit|json>
|
|
1474
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
1475
|
-
--concise Display only failed test results; works with human-readable output only.
|
|
1476
|
-
--detailed-coverage Display detailed code coverage per test.
|
|
1477
|
-
|
|
1478
|
-
GLOBAL FLAGS
|
|
1479
|
-
--flags-dir=<value> Import flag values from a directory.
|
|
1480
|
-
--json Format output as json.
|
|
1481
|
-
|
|
1482
|
-
DESCRIPTION
|
|
1483
|
-
Display test results for a specific asynchronous test run.
|
|
1484
|
-
|
|
1485
|
-
Provide a test run ID to display test results for an enqueued or completed asynchronous test run. The test run ID is
|
|
1486
|
-
displayed after running the "sf apex test run" command.
|
|
1487
|
-
|
|
1488
|
-
To see code coverage results, use the --code-coverage flag with --result-format. The output displays a high-level
|
|
1489
|
-
summary of the test run and the code coverage values for classes in your org. If you specify human-readable result
|
|
1490
|
-
format, use the --detailed-coverage flag to see detailed coverage results for each test method run.
|
|
1491
|
-
|
|
1492
|
-
ALIASES
|
|
1493
|
-
$ sf force apex test report
|
|
1494
|
-
|
|
1495
|
-
EXAMPLES
|
|
1496
|
-
Display test results for your default org using a test run ID:
|
|
1497
|
-
|
|
1498
|
-
$ sf apex get test --test-run-id <test run id>
|
|
1499
|
-
|
|
1500
|
-
Similar to previous example, but output the result in JUnit format:
|
|
1501
|
-
|
|
1502
|
-
$ sf apex get test --test-run-id <test run id> --result-format junit
|
|
1503
|
-
|
|
1504
|
-
Also retrieve code coverage results and output in JSON format:
|
|
1505
|
-
|
|
1506
|
-
$ sf apex get test --test-run-id <test run id> --code-coverage --json
|
|
1507
|
-
|
|
1508
|
-
Specify a directory in which to save the test results from the org with the specified username (rather than your
|
|
1509
|
-
default org):
|
|
1510
|
-
|
|
1511
|
-
$ sf apex get test --test-run-id <test run id> --code-coverage --output-dir <path to outputdir> --target-org \
|
|
1512
|
-
me@myorg'
|
|
1513
|
-
```
|
|
1514
|
-
|
|
1515
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.5/src/commands/apex/get/test.ts)_
|
|
1516
|
-
|
|
1517
|
-
## `sf apex list log`
|
|
1518
|
-
|
|
1519
|
-
Display a list of IDs and general information about debug logs.
|
|
1520
|
-
|
|
1521
|
-
```
|
|
1522
|
-
USAGE
|
|
1523
|
-
$ sf apex list log -o <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
1524
|
-
|
|
1525
|
-
FLAGS
|
|
1526
|
-
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
1527
|
-
configuration variable is already set.
|
|
1528
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
1529
|
-
|
|
1530
|
-
GLOBAL FLAGS
|
|
1531
|
-
--flags-dir=<value> Import flag values from a directory.
|
|
1532
|
-
--json Format output as json.
|
|
1533
|
-
|
|
1534
|
-
DESCRIPTION
|
|
1535
|
-
Display a list of IDs and general information about debug logs.
|
|
1536
|
-
|
|
1537
|
-
Run this command in a project to list the IDs and general information for all debug logs in your default org.
|
|
1538
|
-
|
|
1539
|
-
To fetch a specific log from your org, obtain the ID from this command's output, then run the “sf apex log get”
|
|
1540
|
-
command.
|
|
1541
|
-
|
|
1542
|
-
ALIASES
|
|
1543
|
-
$ sf force apex log list
|
|
1544
|
-
|
|
1545
|
-
EXAMPLES
|
|
1546
|
-
List the IDs and information about the debug logs in your default org:
|
|
1547
|
-
|
|
1548
|
-
$ sf apex list log
|
|
1549
|
-
|
|
1550
|
-
Similar to previous example, but use the org with the specified username:
|
|
1551
|
-
|
|
1552
|
-
$ sf apex list log --target-org me@my.org
|
|
1553
|
-
```
|
|
1554
|
-
|
|
1555
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.5/src/commands/apex/list/log.ts)_
|
|
1556
|
-
|
|
1557
|
-
## `sf apex run`
|
|
1558
|
-
|
|
1559
|
-
Execute anonymous Apex code entered on the command line or from a local file.
|
|
1560
|
-
|
|
1561
|
-
```
|
|
1562
|
-
USAGE
|
|
1563
|
-
$ 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>]
|
|
1564
1611
|
|
|
1565
1612
|
FLAGS
|
|
1566
1613
|
-f, --file=<value> Path to a local file that contains Apex code.
|
|
@@ -1599,7 +1646,7 @@ EXAMPLES
|
|
|
1599
1646
|
$ sf apex run
|
|
1600
1647
|
```
|
|
1601
1648
|
|
|
1602
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.
|
|
1649
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.6/src/commands/apex/run.ts)_
|
|
1603
1650
|
|
|
1604
1651
|
## `sf apex run test`
|
|
1605
1652
|
|
|
@@ -1746,7 +1793,7 @@ FLAG DESCRIPTIONS
|
|
|
1746
1793
|
--tests Test1 --tests Test2
|
|
1747
1794
|
```
|
|
1748
1795
|
|
|
1749
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.
|
|
1796
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.6/src/commands/apex/run/test.ts)_
|
|
1750
1797
|
|
|
1751
1798
|
## `sf apex tail log`
|
|
1752
1799
|
|
|
@@ -1789,7 +1836,7 @@ EXAMPLES
|
|
|
1789
1836
|
$ sf apex tail log --color --skip-trace-flag
|
|
1790
1837
|
```
|
|
1791
1838
|
|
|
1792
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.
|
|
1839
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.6/src/commands/apex/tail/log.ts)_
|
|
1793
1840
|
|
|
1794
1841
|
## `sf api request graphql`
|
|
1795
1842
|
|
|
@@ -1842,7 +1889,7 @@ EXAMPLES
|
|
|
1842
1889
|
$ sf api request graphql --body example.txt --stream-to-file output.txt --include
|
|
1843
1890
|
```
|
|
1844
1891
|
|
|
1845
|
-
_See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.3.
|
|
1892
|
+
_See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.3.9/src/commands/api/request/graphql.ts)_
|
|
1846
1893
|
|
|
1847
1894
|
## `sf api request rest [URL]`
|
|
1848
1895
|
|
|
@@ -1951,7 +1998,7 @@ FLAG DESCRIPTIONS
|
|
|
1951
1998
|
https://github.com/salesforcecli/plugin-api/tree/main/test/test-files/data-project.
|
|
1952
1999
|
```
|
|
1953
2000
|
|
|
1954
|
-
_See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.3.
|
|
2001
|
+
_See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.3.9/src/commands/api/request/rest.ts)_
|
|
1955
2002
|
|
|
1956
2003
|
## `sf autocomplete [SHELL]`
|
|
1957
2004
|
|
|
@@ -2060,7 +2107,7 @@ CONFIGURATION VARIABLES
|
|
|
2060
2107
|
org-capitalize-record-types Whether record types are capitalized on scratch org creation.
|
|
2061
2108
|
```
|
|
2062
2109
|
|
|
2063
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.
|
|
2110
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.55/src/commands/config/get.ts)_
|
|
2064
2111
|
|
|
2065
2112
|
## `sf config list`
|
|
2066
2113
|
|
|
@@ -2100,7 +2147,7 @@ EXAMPLES
|
|
|
2100
2147
|
$ sf config list
|
|
2101
2148
|
```
|
|
2102
2149
|
|
|
2103
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.
|
|
2150
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.55/src/commands/config/list.ts)_
|
|
2104
2151
|
|
|
2105
2152
|
## `sf config set`
|
|
2106
2153
|
|
|
@@ -2169,7 +2216,7 @@ CONFIGURATION VARIABLES
|
|
|
2169
2216
|
org-capitalize-record-types Whether record types are capitalized on scratch org creation.
|
|
2170
2217
|
```
|
|
2171
2218
|
|
|
2172
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.
|
|
2219
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.55/src/commands/config/set.ts)_
|
|
2173
2220
|
|
|
2174
2221
|
## `sf config unset`
|
|
2175
2222
|
|
|
@@ -2219,7 +2266,7 @@ CONFIGURATION VARIABLES
|
|
|
2219
2266
|
org-capitalize-record-types Whether record types are capitalized on scratch org creation.
|
|
2220
2267
|
```
|
|
2221
2268
|
|
|
2222
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.
|
|
2269
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.55/src/commands/config/unset.ts)_
|
|
2223
2270
|
|
|
2224
2271
|
## `sf data bulk results`
|
|
2225
2272
|
|
|
@@ -2264,7 +2311,7 @@ EXAMPLES
|
|
|
2264
2311
|
$ sf data bulk results --job-id 7507i000fake341G --target-org my-scratch
|
|
2265
2312
|
```
|
|
2266
2313
|
|
|
2267
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
2314
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.68/src/commands/data/bulk/results.ts)_
|
|
2268
2315
|
|
|
2269
2316
|
## `sf data create file`
|
|
2270
2317
|
|
|
@@ -2313,7 +2360,7 @@ EXAMPLES
|
|
|
2313
2360
|
$ sf data create file --file path/to/astro.png --parent-id a03fakeLoJWPIA3
|
|
2314
2361
|
```
|
|
2315
2362
|
|
|
2316
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
2363
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.68/src/commands/data/create/file.ts)_
|
|
2317
2364
|
|
|
2318
2365
|
## `sf data create record`
|
|
2319
2366
|
|
|
@@ -2369,7 +2416,7 @@ EXAMPLES
|
|
|
2369
2416
|
TracedEntityId=01p17000000R6bLAAS"
|
|
2370
2417
|
```
|
|
2371
2418
|
|
|
2372
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
2419
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.68/src/commands/data/create/record.ts)_
|
|
2373
2420
|
|
|
2374
2421
|
## `sf data delete bulk`
|
|
2375
2422
|
|
|
@@ -2428,7 +2475,7 @@ FLAG DESCRIPTIONS
|
|
|
2428
2475
|
and can be enabled only by a system administrator.
|
|
2429
2476
|
```
|
|
2430
2477
|
|
|
2431
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
2478
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.68/src/commands/data/delete/bulk.ts)_
|
|
2432
2479
|
|
|
2433
2480
|
## `sf data delete record`
|
|
2434
2481
|
|
|
@@ -2489,7 +2536,7 @@ EXAMPLES
|
|
|
2489
2536
|
$ sf data delete record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
|
|
2490
2537
|
```
|
|
2491
2538
|
|
|
2492
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
2539
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.68/src/commands/data/delete/record.ts)_
|
|
2493
2540
|
|
|
2494
2541
|
## `sf data delete resume`
|
|
2495
2542
|
|
|
@@ -2528,7 +2575,7 @@ EXAMPLES
|
|
|
2528
2575
|
$ sf data delete resume --use-most-recent --target-org my-scratch
|
|
2529
2576
|
```
|
|
2530
2577
|
|
|
2531
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
2578
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.68/src/commands/data/delete/resume.ts)_
|
|
2532
2579
|
|
|
2533
2580
|
## `sf data export bulk`
|
|
2534
2581
|
|
|
@@ -2595,7 +2642,7 @@ EXAMPLES
|
|
|
2595
2642
|
--result-format json --wait 10 --all-rows
|
|
2596
2643
|
```
|
|
2597
2644
|
|
|
2598
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
2645
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.68/src/commands/data/export/bulk.ts)_
|
|
2599
2646
|
|
|
2600
2647
|
## `sf data export resume`
|
|
2601
2648
|
|
|
@@ -2634,7 +2681,7 @@ EXAMPLES
|
|
|
2634
2681
|
$ sf data export resume --use-most-recent
|
|
2635
2682
|
```
|
|
2636
2683
|
|
|
2637
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
2684
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.68/src/commands/data/export/resume.ts)_
|
|
2638
2685
|
|
|
2639
2686
|
## `sf data export tree`
|
|
2640
2687
|
|
|
@@ -2694,7 +2741,7 @@ EXAMPLES
|
|
|
2694
2741
|
my-scratch
|
|
2695
2742
|
```
|
|
2696
2743
|
|
|
2697
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
2744
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.68/src/commands/data/export/tree.ts)_
|
|
2698
2745
|
|
|
2699
2746
|
## `sf data get record`
|
|
2700
2747
|
|
|
@@ -2758,7 +2805,7 @@ EXAMPLES
|
|
|
2758
2805
|
$ sf data get record --use-tooling-api --sobject TraceFlag --record-id 7tf8c
|
|
2759
2806
|
```
|
|
2760
2807
|
|
|
2761
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
2808
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.68/src/commands/data/get/record.ts)_
|
|
2762
2809
|
|
|
2763
2810
|
## `sf data import bulk`
|
|
2764
2811
|
|
|
@@ -2810,7 +2857,7 @@ EXAMPLES
|
|
|
2810
2857
|
$ sf data import bulk --file accounts.csv --sobject Account --wait 10 --target-org my-scratch
|
|
2811
2858
|
```
|
|
2812
2859
|
|
|
2813
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
2860
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.68/src/commands/data/import/bulk.ts)_
|
|
2814
2861
|
|
|
2815
2862
|
## `sf data import resume`
|
|
2816
2863
|
|
|
@@ -2846,7 +2893,7 @@ EXAMPLES
|
|
|
2846
2893
|
$ sf data import resume --use-most-recent --target-org my-scratch
|
|
2847
2894
|
```
|
|
2848
2895
|
|
|
2849
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
2896
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.68/src/commands/data/import/resume.ts)_
|
|
2850
2897
|
|
|
2851
2898
|
## `sf data import tree`
|
|
2852
2899
|
|
|
@@ -2910,7 +2957,7 @@ FLAG DESCRIPTIONS
|
|
|
2910
2957
|
- files(array) - Files: An array of files paths to load
|
|
2911
2958
|
```
|
|
2912
2959
|
|
|
2913
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
2960
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.68/src/commands/data/import/tree.ts)_
|
|
2914
2961
|
|
|
2915
2962
|
## `sf data query`
|
|
2916
2963
|
|
|
@@ -2963,7 +3010,7 @@ EXAMPLES
|
|
|
2963
3010
|
$ sf data query --query "SELECT Name FROM ApexTrigger" --use-tooling-api
|
|
2964
3011
|
```
|
|
2965
3012
|
|
|
2966
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
3013
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.68/src/commands/data/query.ts)_
|
|
2967
3014
|
|
|
2968
3015
|
## `sf data resume`
|
|
2969
3016
|
|
|
@@ -3000,7 +3047,7 @@ EXAMPLES
|
|
|
3000
3047
|
$ sf data resume --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA
|
|
3001
3048
|
```
|
|
3002
3049
|
|
|
3003
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
3050
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.68/src/commands/data/resume.ts)_
|
|
3004
3051
|
|
|
3005
3052
|
## `sf data search`
|
|
3006
3053
|
|
|
@@ -3050,7 +3097,7 @@ EXAMPLES
|
|
|
3050
3097
|
$ sf data search --file query.txt --target-org my-scratch --result-format csv
|
|
3051
3098
|
```
|
|
3052
3099
|
|
|
3053
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
3100
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.68/src/commands/data/search.ts)_
|
|
3054
3101
|
|
|
3055
3102
|
## `sf data update bulk`
|
|
3056
3103
|
|
|
@@ -3105,7 +3152,7 @@ EXAMPLES
|
|
|
3105
3152
|
$ sf data update bulk --file accounts.csv --sobject Account --wait 10 --target-org my-scratch
|
|
3106
3153
|
```
|
|
3107
3154
|
|
|
3108
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
3155
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.68/src/commands/data/update/bulk.ts)_
|
|
3109
3156
|
|
|
3110
3157
|
## `sf data update record`
|
|
3111
3158
|
|
|
@@ -3167,7 +3214,7 @@ EXAMPLES
|
|
|
3167
3214
|
"ExpirationDate=2017-12-01T00:58:04.000+0000"
|
|
3168
3215
|
```
|
|
3169
3216
|
|
|
3170
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
3217
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.68/src/commands/data/update/record.ts)_
|
|
3171
3218
|
|
|
3172
3219
|
## `sf data update resume`
|
|
3173
3220
|
|
|
@@ -3206,7 +3253,7 @@ EXAMPLES
|
|
|
3206
3253
|
$ sf data update resume --use-most-recent
|
|
3207
3254
|
```
|
|
3208
3255
|
|
|
3209
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
3256
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.68/src/commands/data/update/resume.ts)_
|
|
3210
3257
|
|
|
3211
3258
|
## `sf data upsert bulk`
|
|
3212
3259
|
|
|
@@ -3262,7 +3309,7 @@ EXAMPLES
|
|
|
3262
3309
|
my-scratch
|
|
3263
3310
|
```
|
|
3264
3311
|
|
|
3265
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
3312
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.68/src/commands/data/upsert/bulk.ts)_
|
|
3266
3313
|
|
|
3267
3314
|
## `sf data upsert resume`
|
|
3268
3315
|
|
|
@@ -3301,7 +3348,7 @@ EXAMPLES
|
|
|
3301
3348
|
$ sf data upsert resume --use-most-recent --target-org my-scratch
|
|
3302
3349
|
```
|
|
3303
3350
|
|
|
3304
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
3351
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.68/src/commands/data/upsert/resume.ts)_
|
|
3305
3352
|
|
|
3306
3353
|
## `sf doctor`
|
|
3307
3354
|
|
|
@@ -3349,7 +3396,7 @@ EXAMPLES
|
|
|
3349
3396
|
$ sf doctor --plugin @salesforce/plugin-source
|
|
3350
3397
|
```
|
|
3351
3398
|
|
|
3352
|
-
_See code: [@salesforce/plugin-info](https://github.com/salesforcecli/plugin-info/blob/3.4.
|
|
3399
|
+
_See code: [@salesforce/plugin-info](https://github.com/salesforcecli/plugin-info/blob/3.4.101/src/commands/doctor.ts)_
|
|
3353
3400
|
|
|
3354
3401
|
## `sf force data bulk delete`
|
|
3355
3402
|
|
|
@@ -3396,7 +3443,7 @@ EXAMPLES
|
|
|
3396
3443
|
$ sf force data bulk delete --sobject MyObject__c --file files/delete.csv --wait 5 --target-org my-scratch
|
|
3397
3444
|
```
|
|
3398
3445
|
|
|
3399
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
3446
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.68/src/commands/force/data/bulk/delete.ts)_
|
|
3400
3447
|
|
|
3401
3448
|
## `sf force data bulk status`
|
|
3402
3449
|
|
|
@@ -3433,7 +3480,7 @@ EXAMPLES
|
|
|
3433
3480
|
$ sf force data bulk status --job-id 750xx000000005sAAA --batch-id 751xx000000005nAAA --target-org my-scratch
|
|
3434
3481
|
```
|
|
3435
3482
|
|
|
3436
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
3483
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.68/src/commands/force/data/bulk/status.ts)_
|
|
3437
3484
|
|
|
3438
3485
|
## `sf force data bulk upsert`
|
|
3439
3486
|
|
|
@@ -3491,7 +3538,7 @@ EXAMPLES
|
|
|
3491
3538
|
--target-org my-scratch
|
|
3492
3539
|
```
|
|
3493
3540
|
|
|
3494
|
-
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.
|
|
3541
|
+
_See code: [@salesforce/plugin-data](https://github.com/salesforcecli/plugin-data/blob/4.0.68/src/commands/force/data/bulk/upsert.ts)_
|
|
3495
3542
|
|
|
3496
3543
|
## `sf help [COMMAND]`
|
|
3497
3544
|
|
|
@@ -3551,354 +3598,65 @@ EXAMPLES
|
|
|
3551
3598
|
$ sf info releasenotes display --version latest
|
|
3552
3599
|
```
|
|
3553
3600
|
|
|
3554
|
-
_See code: [@salesforce/plugin-info](https://github.com/salesforcecli/plugin-info/blob/3.4.
|
|
3601
|
+
_See code: [@salesforce/plugin-info](https://github.com/salesforcecli/plugin-info/blob/3.4.101/src/commands/info/releasenotes/display.ts)_
|
|
3555
3602
|
|
|
3556
|
-
## `sf
|
|
3603
|
+
## `sf logic get test`
|
|
3557
3604
|
|
|
3558
|
-
|
|
3605
|
+
Get the results of a test run.
|
|
3559
3606
|
|
|
3560
3607
|
```
|
|
3561
3608
|
USAGE
|
|
3562
|
-
$ sf
|
|
3563
|
-
<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]
|
|
3564
3611
|
|
|
3565
3612
|
FLAGS
|
|
3566
|
-
-
|
|
3567
|
-
-
|
|
3568
|
-
-
|
|
3569
|
-
|
|
3570
|
-
|
|
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.
|
|
3571
3623
|
|
|
3572
3624
|
GLOBAL FLAGS
|
|
3573
3625
|
--flags-dir=<value> Import flag values from a directory.
|
|
3574
3626
|
--json Format output as json.
|
|
3575
3627
|
|
|
3576
3628
|
DESCRIPTION
|
|
3577
|
-
|
|
3629
|
+
Get the results of a test run.
|
|
3578
3630
|
|
|
3579
|
-
|
|
3580
|
-
|
|
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.
|
|
3581
3633
|
|
|
3582
|
-
|
|
3583
|
-
|
|
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.
|
|
3584
3637
|
|
|
3585
3638
|
EXAMPLES
|
|
3586
|
-
|
|
3587
|
-
|
|
3588
|
-
$ sf lightning generate app --name myapp
|
|
3589
|
-
|
|
3590
|
-
Similar to the previous example, but generate the files in the "force-app/main/default/aura" directory:
|
|
3591
|
-
|
|
3592
|
-
$ sf lightning generate app --name myapp --output-dir force-app/main/default/aura
|
|
3593
|
-
|
|
3594
|
-
FLAG DESCRIPTIONS
|
|
3595
|
-
-d, --output-dir=<value> Directory for saving the created files.
|
|
3596
|
-
|
|
3597
|
-
The location can be an absolute path or relative to the current working directory. The default is the current
|
|
3598
|
-
directory.
|
|
3599
|
-
|
|
3600
|
-
-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:
|
|
3601
3640
|
|
|
3602
|
-
|
|
3641
|
+
$ sf logic get test --test-run-id <test run id>
|
|
3603
3642
|
|
|
3604
|
-
|
|
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":
|
|
3605
3645
|
|
|
3606
|
-
|
|
3646
|
+
$ sf logic get test --test-run-id <test run id> --result-format junit --target-org my-scratch
|
|
3607
3647
|
```
|
|
3608
3648
|
|
|
3609
|
-
_See code: [@salesforce/plugin-
|
|
3649
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.6/src/commands/logic/get/test.ts)_
|
|
3610
3650
|
|
|
3611
|
-
## `sf
|
|
3651
|
+
## `sf logic run test`
|
|
3612
3652
|
|
|
3613
|
-
|
|
3653
|
+
Invoke tests for Apex and Flows in an org.
|
|
3614
3654
|
|
|
3615
3655
|
```
|
|
3616
3656
|
USAGE
|
|
3617
|
-
$ sf
|
|
3618
|
-
|
|
3619
|
-
|
|
3620
|
-
FLAGS
|
|
3621
|
-
-d, --output-dir=<value> [default: .] Directory for saving the created files.
|
|
3622
|
-
-n, --name=<value> (required) Name of the generated Lightning Component.
|
|
3623
|
-
-t, --template=<option> [default: default] Template to use for file creation.
|
|
3624
|
-
<options: default|analyticsDashboard|analyticsDashboardWithStep>
|
|
3625
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
3626
|
-
--type=<option> [default: aura] Type of the component bundle.
|
|
3627
|
-
<options: aura|lwc>
|
|
3628
|
-
|
|
3629
|
-
GLOBAL FLAGS
|
|
3630
|
-
--flags-dir=<value> Import flag values from a directory.
|
|
3631
|
-
--json Format output as json.
|
|
3632
|
-
|
|
3633
|
-
DESCRIPTION
|
|
3634
|
-
Generate a bundle for an Aura component or a Lightning web component.
|
|
3635
|
-
|
|
3636
|
-
Generates the bundle in the specified directory or the current working directory. The bundle consists of multiple
|
|
3637
|
-
files in a directory with the designated name. Lightning web components are contained in the directory with name
|
|
3638
|
-
"lwc", Aura components in "aura".
|
|
3639
|
-
|
|
3640
|
-
To generate a Lightning web component, pass "--type lwc" to the command. If you don’t specify --type, Salesforce CLI
|
|
3641
|
-
generates an Aura component by default.
|
|
3642
|
-
|
|
3643
|
-
ALIASES
|
|
3644
|
-
$ sf force lightning component create
|
|
3645
|
-
|
|
3646
|
-
EXAMPLES
|
|
3647
|
-
Generate the metadata files for an Aura component bundle in the current directory:
|
|
3648
|
-
|
|
3649
|
-
$ sf lightning generate component --name mycomponent
|
|
3650
|
-
|
|
3651
|
-
Generate a Lightning web component bundle in the current directory:
|
|
3652
|
-
|
|
3653
|
-
$ sf lightning generate component --name mycomponent --type lwc
|
|
3654
|
-
|
|
3655
|
-
Generate an Aura component bundle in the "force-app/main/default/aura" directory:
|
|
3656
|
-
|
|
3657
|
-
$ sf lightning generate component --name mycomponent --output-dir force-app/main/default/aura
|
|
3658
|
-
|
|
3659
|
-
Generate a Lightning web component bundle in the "force-app/main/default/lwc" directory:
|
|
3660
|
-
|
|
3661
|
-
$ sf lightning generate component --name mycomponent --type lwc --output-dir force-app/main/default/lwc
|
|
3662
|
-
|
|
3663
|
-
FLAG DESCRIPTIONS
|
|
3664
|
-
-d, --output-dir=<value> Directory for saving the created files.
|
|
3665
|
-
|
|
3666
|
-
The location can be an absolute path or relative to the current working directory. The default is the current
|
|
3667
|
-
directory.
|
|
3668
|
-
|
|
3669
|
-
-n, --name=<value> Name of the generated Lightning Component.
|
|
3670
|
-
|
|
3671
|
-
The name can be up to 40 characters and must start with a letter.
|
|
3672
|
-
|
|
3673
|
-
-t, --template=default|analyticsDashboard|analyticsDashboardWithStep Template to use for file creation.
|
|
3674
|
-
|
|
3675
|
-
Supplied parameter values or default values are filled into a copy of the template.
|
|
3676
|
-
```
|
|
3677
|
-
|
|
3678
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.4.7/src/commands/lightning/generate/component.ts)_
|
|
3679
|
-
|
|
3680
|
-
## `sf lightning generate event`
|
|
3681
|
-
|
|
3682
|
-
Generate a Lightning Event.
|
|
3683
|
-
|
|
3684
|
-
```
|
|
3685
|
-
USAGE
|
|
3686
|
-
$ sf lightning generate event -n <value> [--json] [--flags-dir <value>] [-t DefaultLightningEvt] [-d <value>] [--api-version
|
|
3687
|
-
<value>]
|
|
3688
|
-
|
|
3689
|
-
FLAGS
|
|
3690
|
-
-d, --output-dir=<value> [default: .] Directory for saving the created files.
|
|
3691
|
-
-n, --name=<value> (required) Name of the generated Lightning Event.
|
|
3692
|
-
-t, --template=<option> [default: DefaultLightningEvt] Template to use for file creation.
|
|
3693
|
-
<options: DefaultLightningEvt>
|
|
3694
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
3695
|
-
|
|
3696
|
-
GLOBAL FLAGS
|
|
3697
|
-
--flags-dir=<value> Import flag values from a directory.
|
|
3698
|
-
--json Format output as json.
|
|
3699
|
-
|
|
3700
|
-
DESCRIPTION
|
|
3701
|
-
Generate a Lightning Event.
|
|
3702
|
-
|
|
3703
|
-
Generates a Lightning Event bundle in the specified directory or the current working directory. The bundle consists of
|
|
3704
|
-
multiple files in a folder with the designated name.
|
|
3705
|
-
|
|
3706
|
-
ALIASES
|
|
3707
|
-
$ sf force lightning event create
|
|
3708
|
-
|
|
3709
|
-
EXAMPLES
|
|
3710
|
-
Generate the metadata files for a Lightning event bundle called "myevent" in the current directory:
|
|
3711
|
-
|
|
3712
|
-
$ sf lightning generate event --name myevent
|
|
3713
|
-
|
|
3714
|
-
Similar to previous example, but generate the files in the "force-app/main/default/aura" directory:
|
|
3715
|
-
|
|
3716
|
-
$ sf lightning generate event --name myevent --output-dir force-app/main/default/aura
|
|
3717
|
-
|
|
3718
|
-
FLAG DESCRIPTIONS
|
|
3719
|
-
-d, --output-dir=<value> Directory for saving the created files.
|
|
3720
|
-
|
|
3721
|
-
The location can be an absolute path or relative to the current working directory. The default is the current
|
|
3722
|
-
directory.
|
|
3723
|
-
|
|
3724
|
-
-n, --name=<value> Name of the generated Lightning Event.
|
|
3725
|
-
|
|
3726
|
-
The name can be up to 40 characters and must start with a letter.
|
|
3727
|
-
|
|
3728
|
-
-t, --template=DefaultLightningEvt Template to use for file creation.
|
|
3729
|
-
|
|
3730
|
-
Supplied parameter values or default values are filled into a copy of the template.
|
|
3731
|
-
```
|
|
3732
|
-
|
|
3733
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.4.7/src/commands/lightning/generate/event.ts)_
|
|
3734
|
-
|
|
3735
|
-
## `sf lightning generate interface`
|
|
3736
|
-
|
|
3737
|
-
Generate a Lightning Interface.
|
|
3738
|
-
|
|
3739
|
-
```
|
|
3740
|
-
USAGE
|
|
3741
|
-
$ sf lightning generate interface -n <value> [--json] [--flags-dir <value>] [-t DefaultLightningIntf] [-d <value>]
|
|
3742
|
-
[--api-version <value>]
|
|
3743
|
-
|
|
3744
|
-
FLAGS
|
|
3745
|
-
-d, --output-dir=<value> [default: .] Directory for saving the created files.
|
|
3746
|
-
-n, --name=<value> (required) Name of the generated Lightning Interface.
|
|
3747
|
-
-t, --template=<option> [default: DefaultLightningIntf] Template to use for file creation.
|
|
3748
|
-
<options: DefaultLightningIntf>
|
|
3749
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
3750
|
-
|
|
3751
|
-
GLOBAL FLAGS
|
|
3752
|
-
--flags-dir=<value> Import flag values from a directory.
|
|
3753
|
-
--json Format output as json.
|
|
3754
|
-
|
|
3755
|
-
DESCRIPTION
|
|
3756
|
-
Generate a Lightning Interface.
|
|
3757
|
-
|
|
3758
|
-
Generates a Lightning Interface bundle in the specified directory or the current working directory. The bundle
|
|
3759
|
-
consists of multiple files in a folder with the designated name.
|
|
3760
|
-
|
|
3761
|
-
ALIASES
|
|
3762
|
-
$ sf force lightning interface create
|
|
3763
|
-
|
|
3764
|
-
EXAMPLES
|
|
3765
|
-
Generate the metadata files for a Lightning interface bundle called "myinterface" in the current directory:
|
|
3766
|
-
|
|
3767
|
-
$ sf lightning generate interface --name myinterface
|
|
3768
|
-
|
|
3769
|
-
Similar to the previous example but generate the files in the "force-app/main/default/aura" directory:
|
|
3770
|
-
|
|
3771
|
-
$ sf lightning generate interface --name myinterface --output-dir force-app/main/default/aura
|
|
3772
|
-
|
|
3773
|
-
FLAG DESCRIPTIONS
|
|
3774
|
-
-d, --output-dir=<value> Directory for saving the created files.
|
|
3775
|
-
|
|
3776
|
-
The location can be an absolute path or relative to the current working directory. The default is the current
|
|
3777
|
-
directory.
|
|
3778
|
-
|
|
3779
|
-
-n, --name=<value> Name of the generated Lightning Interface.
|
|
3780
|
-
|
|
3781
|
-
The name can be up to 40 characters and must start with a letter.
|
|
3782
|
-
|
|
3783
|
-
-t, --template=DefaultLightningIntf Template to use for file creation.
|
|
3784
|
-
|
|
3785
|
-
Supplied parameter values or default values are filled into a copy of the template.
|
|
3786
|
-
```
|
|
3787
|
-
|
|
3788
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.4.7/src/commands/lightning/generate/interface.ts)_
|
|
3789
|
-
|
|
3790
|
-
## `sf lightning generate test`
|
|
3791
|
-
|
|
3792
|
-
Generate a Lightning test.
|
|
3793
|
-
|
|
3794
|
-
```
|
|
3795
|
-
USAGE
|
|
3796
|
-
$ sf lightning generate test -n <value> [--json] [--flags-dir <value>] [-t DefaultLightningTest] [-d <value>]
|
|
3797
|
-
[--api-version <value>]
|
|
3798
|
-
|
|
3799
|
-
FLAGS
|
|
3800
|
-
-d, --output-dir=<value> [default: .] Directory for saving the created files.
|
|
3801
|
-
-n, --name=<value> (required) Name of the generated Lightning Test.
|
|
3802
|
-
-t, --template=<option> [default: DefaultLightningTest] Template to use for file creation.
|
|
3803
|
-
<options: DefaultLightningTest>
|
|
3804
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
3805
|
-
|
|
3806
|
-
GLOBAL FLAGS
|
|
3807
|
-
--flags-dir=<value> Import flag values from a directory.
|
|
3808
|
-
--json Format output as json.
|
|
3809
|
-
|
|
3810
|
-
DESCRIPTION
|
|
3811
|
-
Generate a Lightning test.
|
|
3812
|
-
|
|
3813
|
-
Generates the test in the specified directory or the current working directory. The .resource file and associated
|
|
3814
|
-
metadata file are generated.
|
|
3815
|
-
|
|
3816
|
-
ALIASES
|
|
3817
|
-
$ sf force lightning test create
|
|
3818
|
-
|
|
3819
|
-
EXAMPLES
|
|
3820
|
-
Generate the metadata files for the Lightning test called MyLightningTest in the current directory:
|
|
3821
|
-
|
|
3822
|
-
$ sf lightning generate test --name MyLightningTest
|
|
3823
|
-
|
|
3824
|
-
Similar to the previous example but generate the files in the "force-app/main/default/lightningTests" directory:
|
|
3825
|
-
|
|
3826
|
-
$ sf lightning generate test --name MyLightningTest --output-dir force-app/main/default/lightningTests
|
|
3827
|
-
|
|
3828
|
-
FLAG DESCRIPTIONS
|
|
3829
|
-
-d, --output-dir=<value> Directory for saving the created files.
|
|
3830
|
-
|
|
3831
|
-
The location can be an absolute path or relative to the current working directory. The default is the current
|
|
3832
|
-
directory.
|
|
3833
|
-
|
|
3834
|
-
-n, --name=<value> Name of the generated Lightning Test.
|
|
3835
|
-
|
|
3836
|
-
Name of the new Lightning test; can be up to 40 characters and must start with a letter.
|
|
3837
|
-
|
|
3838
|
-
-t, --template=DefaultLightningTest Template to use for file creation.
|
|
3839
|
-
|
|
3840
|
-
Supplied parameter values or default values are filled into a copy of the template.
|
|
3841
|
-
```
|
|
3842
|
-
|
|
3843
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.4.7/src/commands/lightning/generate/test.ts)_
|
|
3844
|
-
|
|
3845
|
-
## `sf logic get test`
|
|
3846
|
-
|
|
3847
|
-
Get the results of a test run.
|
|
3848
|
-
|
|
3849
|
-
```
|
|
3850
|
-
USAGE
|
|
3851
|
-
$ sf logic get test -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
3852
|
-
[--detailed-coverage -c] [-d <value>] [-r human|tap|junit|json] [--concise]
|
|
3853
|
-
|
|
3854
|
-
FLAGS
|
|
3855
|
-
-c, --code-coverage Retrieve code coverage results.
|
|
3856
|
-
-d, --output-dir=<value> Directory in which to store test result files.
|
|
3857
|
-
-i, --test-run-id=<value> (required) ID of the test run.
|
|
3858
|
-
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
3859
|
-
configuration variable is already set.
|
|
3860
|
-
-r, --result-format=<option> [default: human] Format of the test results.
|
|
3861
|
-
<options: human|tap|junit|json>
|
|
3862
|
-
--api-version=<value> Override the api version used for api requests made by this command
|
|
3863
|
-
--concise Display only failed test results; works with human-readable output only.
|
|
3864
|
-
--detailed-coverage Display detailed code coverage per test.
|
|
3865
|
-
|
|
3866
|
-
GLOBAL FLAGS
|
|
3867
|
-
--flags-dir=<value> Import flag values from a directory.
|
|
3868
|
-
--json Format output as json.
|
|
3869
|
-
|
|
3870
|
-
DESCRIPTION
|
|
3871
|
-
Get the results of a test run.
|
|
3872
|
-
|
|
3873
|
-
When you run 'sf logic run test' to test Apex classes and Flows asynchronously, it returns a test run ID. Use that ID
|
|
3874
|
-
with this command to see the results.
|
|
3875
|
-
|
|
3876
|
-
To see code coverage results, use the --code-coverage flag with --result-format. The output displays a high-level
|
|
3877
|
-
summary of the test run and the code coverage values for classes in your org. If you specify human-readable result
|
|
3878
|
-
format, use the --detailed-coverage flag to see detailed coverage results for each test method run.
|
|
3879
|
-
|
|
3880
|
-
EXAMPLES
|
|
3881
|
-
Get the results for a specific test run ID in the default human-readable format; uses your default org:
|
|
3882
|
-
|
|
3883
|
-
$ sf logic get test --test-run-id <test run id>
|
|
3884
|
-
|
|
3885
|
-
Get the results for a specific test run ID, format them as JUnit, and save them to the "test-results/junit"
|
|
3886
|
-
directory; uses the org with alias "my-scratch":
|
|
3887
|
-
|
|
3888
|
-
$ sf logic get test --test-run-id <test run id> --result-format junit --target-org my-scratch
|
|
3889
|
-
```
|
|
3890
|
-
|
|
3891
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.5/src/commands/logic/get/test.ts)_
|
|
3892
|
-
|
|
3893
|
-
## `sf logic run test`
|
|
3894
|
-
|
|
3895
|
-
Invoke tests for Apex and Flows in an org.
|
|
3896
|
-
|
|
3897
|
-
```
|
|
3898
|
-
USAGE
|
|
3899
|
-
$ sf logic run test -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-d <value>] [-l
|
|
3900
|
-
RunLocalTests|RunAllTestsInOrg|RunSpecifiedTests] [-n <value>... | -s <value>... | -t <value>... | --test-category
|
|
3901
|
-
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]
|
|
3902
3660
|
|
|
3903
3661
|
FLAGS
|
|
3904
3662
|
-c, --code-coverage Retrieve code coverage results.
|
|
@@ -4010,7 +3768,7 @@ FLAG DESCRIPTIONS
|
|
|
4010
3768
|
--tests Test1 --tests Test2
|
|
4011
3769
|
```
|
|
4012
3770
|
|
|
4013
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.
|
|
3771
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.6/src/commands/logic/run/test.ts)_
|
|
4014
3772
|
|
|
4015
3773
|
## `sf org assign permset`
|
|
4016
3774
|
|
|
@@ -4056,7 +3814,7 @@ EXAMPLES
|
|
|
4056
3814
|
$ sf org assign permset --name DreamHouse --on-behalf-of user1@my.org --on-behalf-of user2 --on-behalf-of user
|
|
4057
3815
|
```
|
|
4058
3816
|
|
|
4059
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.6.
|
|
3817
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.6.49/src/commands/org/assign/permset.ts)_
|
|
4060
3818
|
|
|
4061
3819
|
## `sf org assign permsetlicense`
|
|
4062
3820
|
|
|
@@ -4103,7 +3861,7 @@ EXAMPLES
|
|
|
4103
3861
|
user3
|
|
4104
3862
|
```
|
|
4105
3863
|
|
|
4106
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.6.
|
|
3864
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.6.49/src/commands/org/assign/permsetlicense.ts)_
|
|
4107
3865
|
|
|
4108
3866
|
## `sf org create sandbox`
|
|
4109
3867
|
|
|
@@ -4237,7 +3995,7 @@ FLAG DESCRIPTIONS
|
|
|
4237
3995
|
You can specify either --source-sandbox-name or --source-id when cloning an existing sandbox, but not both.
|
|
4238
3996
|
```
|
|
4239
3997
|
|
|
4240
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.
|
|
3998
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.66/src/commands/org/create/sandbox.ts)_
|
|
4241
3999
|
|
|
4242
4000
|
## `sf org create scratch`
|
|
4243
4001
|
|
|
@@ -4419,7 +4177,7 @@ FLAG DESCRIPTIONS
|
|
|
4419
4177
|
Omit this flag to have Salesforce generate a unique username for your org.
|
|
4420
4178
|
```
|
|
4421
4179
|
|
|
4422
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.
|
|
4180
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.66/src/commands/org/create/scratch.ts)_
|
|
4423
4181
|
|
|
4424
4182
|
## `sf org create user`
|
|
4425
4183
|
|
|
@@ -4527,7 +4285,7 @@ FLAG DESCRIPTIONS
|
|
|
4527
4285
|
might be different than what you specify in the definition file.
|
|
4528
4286
|
```
|
|
4529
4287
|
|
|
4530
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.6.
|
|
4288
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.6.49/src/commands/org/create/user.ts)_
|
|
4531
4289
|
|
|
4532
4290
|
## `sf org delete sandbox`
|
|
4533
4291
|
|
|
@@ -4573,7 +4331,7 @@ EXAMPLES
|
|
|
4573
4331
|
$ sf org delete sandbox --target-org my-sandbox --no-prompt
|
|
4574
4332
|
```
|
|
4575
4333
|
|
|
4576
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.
|
|
4334
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.66/src/commands/org/delete/sandbox.ts)_
|
|
4577
4335
|
|
|
4578
4336
|
## `sf org delete scratch`
|
|
4579
4337
|
|
|
@@ -4617,7 +4375,7 @@ EXAMPLES
|
|
|
4617
4375
|
$ sf org delete scratch --target-org my-scratch-org --no-prompt
|
|
4618
4376
|
```
|
|
4619
4377
|
|
|
4620
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.
|
|
4378
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.66/src/commands/org/delete/scratch.ts)_
|
|
4621
4379
|
|
|
4622
4380
|
## `sf org disable tracking`
|
|
4623
4381
|
|
|
@@ -4656,7 +4414,7 @@ EXAMPLES
|
|
|
4656
4414
|
$ sf org disable tracking
|
|
4657
4415
|
```
|
|
4658
4416
|
|
|
4659
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.
|
|
4417
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.66/src/commands/org/disable/tracking.ts)_
|
|
4660
4418
|
|
|
4661
4419
|
## `sf org display`
|
|
4662
4420
|
|
|
@@ -4701,7 +4459,7 @@ EXAMPLES
|
|
|
4701
4459
|
$ sf org display --target-org TestOrg1 --verbose
|
|
4702
4460
|
```
|
|
4703
4461
|
|
|
4704
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.
|
|
4462
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.66/src/commands/org/display.ts)_
|
|
4705
4463
|
|
|
4706
4464
|
## `sf org display user`
|
|
4707
4465
|
|
|
@@ -4740,7 +4498,7 @@ EXAMPLES
|
|
|
4740
4498
|
$ sf org display user --target-org me@my.org --json
|
|
4741
4499
|
```
|
|
4742
4500
|
|
|
4743
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.6.
|
|
4501
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.6.49/src/commands/org/display/user.ts)_
|
|
4744
4502
|
|
|
4745
4503
|
## `sf org enable tracking`
|
|
4746
4504
|
|
|
@@ -4782,7 +4540,7 @@ EXAMPLES
|
|
|
4782
4540
|
$ sf org enable tracking
|
|
4783
4541
|
```
|
|
4784
4542
|
|
|
4785
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.
|
|
4543
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.66/src/commands/org/enable/tracking.ts)_
|
|
4786
4544
|
|
|
4787
4545
|
## `sf org generate password`
|
|
4788
4546
|
|
|
@@ -4849,7 +4607,7 @@ EXAMPLES
|
|
|
4849
4607
|
$ sf org generate password --on-behalf-of user1@my.org --on-behalf-of user2@my.org --on-behalf-of user3@my.org
|
|
4850
4608
|
```
|
|
4851
4609
|
|
|
4852
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.6.
|
|
4610
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.6.49/src/commands/org/generate/password.ts)_
|
|
4853
4611
|
|
|
4854
4612
|
## `sf org list`
|
|
4855
4613
|
|
|
@@ -4888,7 +4646,7 @@ EXAMPLES
|
|
|
4888
4646
|
$ sf org list --clean
|
|
4889
4647
|
```
|
|
4890
4648
|
|
|
4891
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.
|
|
4649
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.66/src/commands/org/list.ts)_
|
|
4892
4650
|
|
|
4893
4651
|
## `sf org list auth`
|
|
4894
4652
|
|
|
@@ -4920,7 +4678,7 @@ EXAMPLES
|
|
|
4920
4678
|
$ sf org list auth
|
|
4921
4679
|
```
|
|
4922
4680
|
|
|
4923
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/4.1.
|
|
4681
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/4.1.5/src/commands/org/list/auth.ts)_
|
|
4924
4682
|
|
|
4925
4683
|
## `sf org list limits`
|
|
4926
4684
|
|
|
@@ -4960,7 +4718,7 @@ EXAMPLES
|
|
|
4960
4718
|
$ sf org list limits --target-org my-scratch-org
|
|
4961
4719
|
```
|
|
4962
4720
|
|
|
4963
|
-
_See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.3.
|
|
4721
|
+
_See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.3.75/src/commands/org/list/limits.ts)_
|
|
4964
4722
|
|
|
4965
4723
|
## `sf org list metadata`
|
|
4966
4724
|
|
|
@@ -5027,7 +4785,7 @@ FLAG DESCRIPTIONS
|
|
|
5027
4785
|
Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.
|
|
5028
4786
|
```
|
|
5029
4787
|
|
|
5030
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.
|
|
4788
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.66/src/commands/org/list/metadata.ts)_
|
|
5031
4789
|
|
|
5032
4790
|
## `sf org list metadata-types`
|
|
5033
4791
|
|
|
@@ -5082,7 +4840,7 @@ FLAG DESCRIPTIONS
|
|
|
5082
4840
|
Override the api version used for api requests made by this command
|
|
5083
4841
|
```
|
|
5084
4842
|
|
|
5085
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.
|
|
4843
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.66/src/commands/org/list/metadata-types.ts)_
|
|
5086
4844
|
|
|
5087
4845
|
## `sf org list sobject record-counts`
|
|
5088
4846
|
|
|
@@ -5128,7 +4886,7 @@ EXAMPLES
|
|
|
5128
4886
|
$ sf org list sobject record-counts --sobject Account --sobject Lead --target-org my-scratch-org
|
|
5129
4887
|
```
|
|
5130
4888
|
|
|
5131
|
-
_See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.3.
|
|
4889
|
+
_See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.3.75/src/commands/org/list/sobject/record-counts.ts)_
|
|
5132
4890
|
|
|
5133
4891
|
## `sf org list users`
|
|
5134
4892
|
|
|
@@ -5166,7 +4924,7 @@ EXAMPLES
|
|
|
5166
4924
|
$ sf org list users --target-org me@my.org
|
|
5167
4925
|
```
|
|
5168
4926
|
|
|
5169
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.6.
|
|
4927
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.6.49/src/commands/org/list/users.ts)_
|
|
5170
4928
|
|
|
5171
4929
|
## `sf org login access-token`
|
|
5172
4930
|
|
|
@@ -5220,7 +4978,7 @@ FLAG DESCRIPTIONS
|
|
|
5220
4978
|
To specify a sandbox, set --instance-url to "https://<MyDomainName>--<SandboxName>.sandbox.my.salesforce.com".
|
|
5221
4979
|
```
|
|
5222
4980
|
|
|
5223
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/4.1.
|
|
4981
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/4.1.5/src/commands/org/login/access-token.ts)_
|
|
5224
4982
|
|
|
5225
4983
|
## `sf org login jwt`
|
|
5226
4984
|
|
|
@@ -5311,7 +5069,7 @@ FLAG DESCRIPTIONS
|
|
|
5311
5069
|
To specify a sandbox, set --instance-url to "https://<MyDomainName>--<SandboxName>.sandbox.my.salesforce.com".
|
|
5312
5070
|
```
|
|
5313
5071
|
|
|
5314
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/4.1.
|
|
5072
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/4.1.5/src/commands/org/login/jwt.ts)_
|
|
5315
5073
|
|
|
5316
5074
|
## `sf org login sfdx-url`
|
|
5317
5075
|
|
|
@@ -5381,7 +5139,7 @@ EXAMPLES
|
|
|
5381
5139
|
$ echo url | sf org login sfdx-url --sfdx-url-stdin
|
|
5382
5140
|
```
|
|
5383
5141
|
|
|
5384
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/4.1.
|
|
5142
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/4.1.5/src/commands/org/login/sfdx-url.ts)_
|
|
5385
5143
|
|
|
5386
5144
|
## `sf org login web`
|
|
5387
5145
|
|
|
@@ -5486,7 +5244,7 @@ FLAG DESCRIPTIONS
|
|
|
5486
5244
|
To specify a sandbox, set --instance-url to "https://<MyDomainName>--<SandboxName>.sandbox.my.salesforce.com".
|
|
5487
5245
|
```
|
|
5488
5246
|
|
|
5489
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/4.1.
|
|
5247
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/4.1.5/src/commands/org/login/web.ts)_
|
|
5490
5248
|
|
|
5491
5249
|
## `sf org logout`
|
|
5492
5250
|
|
|
@@ -5552,7 +5310,7 @@ FLAG DESCRIPTIONS
|
|
|
5552
5310
|
All orgs includes Dev Hubs, sandboxes, DE orgs, and expired, deleted, and unknown-status scratch orgs.
|
|
5553
5311
|
```
|
|
5554
5312
|
|
|
5555
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/4.1.
|
|
5313
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/4.1.5/src/commands/org/logout.ts)_
|
|
5556
5314
|
|
|
5557
5315
|
## `sf org open`
|
|
5558
5316
|
|
|
@@ -5628,7 +5386,7 @@ EXAMPLES
|
|
|
5628
5386
|
$ sf org open --source-file force-app/main/default/bots/Coral_Cloud_Agent/Coral_Cloud_Agent.bot-meta.xml
|
|
5629
5387
|
```
|
|
5630
5388
|
|
|
5631
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.
|
|
5389
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.66/src/commands/org/open.ts)_
|
|
5632
5390
|
|
|
5633
5391
|
## `sf org open agent`
|
|
5634
5392
|
|
|
@@ -5679,7 +5437,7 @@ EXAMPLES
|
|
|
5679
5437
|
$ sf org open agent --target-org MyTestOrg1 --browser firefox --api-name Coral_Cloud_Agent
|
|
5680
5438
|
```
|
|
5681
5439
|
|
|
5682
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.
|
|
5440
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.66/src/commands/org/open/agent.ts)_
|
|
5683
5441
|
|
|
5684
5442
|
## `sf org open authoring-bundle`
|
|
5685
5443
|
|
|
@@ -5725,7 +5483,7 @@ EXAMPLES
|
|
|
5725
5483
|
$ sf org open authoring-bundle --target-org MyTestOrg1 --browser firefox
|
|
5726
5484
|
```
|
|
5727
5485
|
|
|
5728
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.
|
|
5486
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.66/src/commands/org/open/authoring-bundle.ts)_
|
|
5729
5487
|
|
|
5730
5488
|
## `sf org refresh sandbox`
|
|
5731
5489
|
|
|
@@ -5828,7 +5586,7 @@ FLAG DESCRIPTIONS
|
|
|
5828
5586
|
You can specify either --source-sandbox-name or --source-id when refreshing an existing sandbox, but not both.
|
|
5829
5587
|
```
|
|
5830
5588
|
|
|
5831
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.
|
|
5589
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.66/src/commands/org/refresh/sandbox.ts)_
|
|
5832
5590
|
|
|
5833
5591
|
## `sf org resume sandbox`
|
|
5834
5592
|
|
|
@@ -5891,7 +5649,7 @@ FLAG DESCRIPTIONS
|
|
|
5891
5649
|
returns the job ID. To resume checking the sandbox creation, rerun this command.
|
|
5892
5650
|
```
|
|
5893
5651
|
|
|
5894
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.
|
|
5652
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.66/src/commands/org/resume/sandbox.ts)_
|
|
5895
5653
|
|
|
5896
5654
|
## `sf org resume scratch`
|
|
5897
5655
|
|
|
@@ -5944,7 +5702,7 @@ FLAG DESCRIPTIONS
|
|
|
5944
5702
|
returns the job ID. To resume checking the scratch creation, rerun this command.
|
|
5945
5703
|
```
|
|
5946
5704
|
|
|
5947
|
-
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.
|
|
5705
|
+
_See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.66/src/commands/org/resume/scratch.ts)_
|
|
5948
5706
|
|
|
5949
5707
|
## `sf package convert`
|
|
5950
5708
|
|
|
@@ -6041,7 +5799,7 @@ FLAG DESCRIPTIONS
|
|
|
6041
5799
|
--installation-key-bypass flag is required.
|
|
6042
5800
|
```
|
|
6043
5801
|
|
|
6044
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
5802
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/convert.ts)_
|
|
6045
5803
|
|
|
6046
5804
|
## `sf package create`
|
|
6047
5805
|
|
|
@@ -6120,7 +5878,7 @@ FLAG DESCRIPTIONS
|
|
|
6120
5878
|
Org-Dependent Unlocked Packages" in the Salesforce DX Developer Guide.
|
|
6121
5879
|
```
|
|
6122
5880
|
|
|
6123
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
5881
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/create.ts)_
|
|
6124
5882
|
|
|
6125
5883
|
## `sf package delete`
|
|
6126
5884
|
|
|
@@ -6162,7 +5920,7 @@ EXAMPLES
|
|
|
6162
5920
|
$ sf package delete --package 0Ho... --target-dev-hub devhub@example.com
|
|
6163
5921
|
```
|
|
6164
5922
|
|
|
6165
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
5923
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/delete.ts)_
|
|
6166
5924
|
|
|
6167
5925
|
## `sf package install`
|
|
6168
5926
|
|
|
@@ -6261,7 +6019,7 @@ FLAG DESCRIPTIONS
|
|
|
6261
6019
|
- Delete: Delete removed components, except for custom objects and custom fields, that don't have dependencies.
|
|
6262
6020
|
```
|
|
6263
6021
|
|
|
6264
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
6022
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/install.ts)_
|
|
6265
6023
|
|
|
6266
6024
|
## `sf package install report`
|
|
6267
6025
|
|
|
@@ -6294,7 +6052,7 @@ EXAMPLES
|
|
|
6294
6052
|
$ sf package install report --request-id 0Hf... --target-org me@example.com
|
|
6295
6053
|
```
|
|
6296
6054
|
|
|
6297
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
6055
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/install/report.ts)_
|
|
6298
6056
|
|
|
6299
6057
|
## `sf package installed list`
|
|
6300
6058
|
|
|
@@ -6326,7 +6084,7 @@ EXAMPLES
|
|
|
6326
6084
|
$ sf package installed list --target-org me@example.com
|
|
6327
6085
|
```
|
|
6328
6086
|
|
|
6329
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
6087
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/installed/list.ts)_
|
|
6330
6088
|
|
|
6331
6089
|
## `sf package list`
|
|
6332
6090
|
|
|
@@ -6364,7 +6122,7 @@ EXAMPLES
|
|
|
6364
6122
|
$ sf package list --target-dev-hub devhub@example.com --verbose
|
|
6365
6123
|
```
|
|
6366
6124
|
|
|
6367
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
6125
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/list.ts)_
|
|
6368
6126
|
|
|
6369
6127
|
## `sf package push-upgrade abort`
|
|
6370
6128
|
|
|
@@ -6403,7 +6161,7 @@ EXAMPLES
|
|
|
6403
6161
|
$ sf package push-upgrade abort --push-request-id 0DV... --target-dev-hub devhub@example.com
|
|
6404
6162
|
```
|
|
6405
6163
|
|
|
6406
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
6164
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/push-upgrade/abort.ts)_
|
|
6407
6165
|
|
|
6408
6166
|
## `sf package push-upgrade list`
|
|
6409
6167
|
|
|
@@ -6462,7 +6220,7 @@ EXAMPLES
|
|
|
6462
6220
|
$ sf package push-upgrade list --package 033xyz –-status Failed
|
|
6463
6221
|
```
|
|
6464
6222
|
|
|
6465
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
6223
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/push-upgrade/list.ts)_
|
|
6466
6224
|
|
|
6467
6225
|
## `sf package push-upgrade report`
|
|
6468
6226
|
|
|
@@ -6504,7 +6262,7 @@ EXAMPLES
|
|
|
6504
6262
|
$ sf package push-upgrade report --push-request-id 0DV... --target-dev-hub devhub@example.com
|
|
6505
6263
|
```
|
|
6506
6264
|
|
|
6507
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
6265
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/push-upgrade/report.ts)_
|
|
6508
6266
|
|
|
6509
6267
|
## `sf package push-upgrade schedule`
|
|
6510
6268
|
|
|
@@ -6591,7 +6349,7 @@ FLAG DESCRIPTIONS
|
|
|
6591
6349
|
Overrides the value of the target-dev-hub configuration variable, if set.
|
|
6592
6350
|
```
|
|
6593
6351
|
|
|
6594
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
6352
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/push-upgrade/schedule.ts)_
|
|
6595
6353
|
|
|
6596
6354
|
## `sf package uninstall`
|
|
6597
6355
|
|
|
@@ -6639,7 +6397,7 @@ EXAMPLES
|
|
|
6639
6397
|
$ sf package uninstall --package "Undesirable Package Alias"
|
|
6640
6398
|
```
|
|
6641
6399
|
|
|
6642
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
6400
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/uninstall.ts)_
|
|
6643
6401
|
|
|
6644
6402
|
## `sf package uninstall report`
|
|
6645
6403
|
|
|
@@ -6672,7 +6430,7 @@ EXAMPLES
|
|
|
6672
6430
|
$ sf package uninstall report --request-id 06y... --target-org me@example.com
|
|
6673
6431
|
```
|
|
6674
6432
|
|
|
6675
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
6433
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/uninstall/report.ts)_
|
|
6676
6434
|
|
|
6677
6435
|
## `sf package update`
|
|
6678
6436
|
|
|
@@ -6740,7 +6498,7 @@ FLAG DESCRIPTIONS
|
|
|
6740
6498
|
the Installed Packages page. Only released package versions can be set as the recommended version.
|
|
6741
6499
|
```
|
|
6742
6500
|
|
|
6743
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
6501
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/update.ts)_
|
|
6744
6502
|
|
|
6745
6503
|
## `sf package version create`
|
|
6746
6504
|
|
|
@@ -6750,9 +6508,9 @@ Create a package version in the Dev Hub org.
|
|
|
6750
6508
|
USAGE
|
|
6751
6509
|
$ sf package version create -v <value> [--json] [--flags-dir <value>] [--api-version <value>] [-b <value>] [-c |
|
|
6752
6510
|
--skip-validation] [-f <value>] [-k <value>] [-x] [-p <value>] [-d <value>] [--post-install-script <value>]
|
|
6753
|
-
[--post-install-url <value>] [--releasenotes-url <value>] [--skip-ancestor-check] [--async-validation | ]
|
|
6754
|
-
<value>] [--uninstall-script <value>] [-e <value>] [-a <value>] [-n <value>] [-w <value>]
|
|
6755
|
-
[--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]
|
|
6756
6514
|
|
|
6757
6515
|
FLAGS
|
|
6758
6516
|
-a, --version-name=<value> Name of the package version to be created; overrides the sfdx-project.json value.
|
|
@@ -6779,12 +6537,14 @@ FLAGS
|
|
|
6779
6537
|
--installation-key-bypass is required)
|
|
6780
6538
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
6781
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.
|
|
6782
6542
|
--language=<value> Language for the package.
|
|
6783
6543
|
--post-install-script=<value> Name of the post-install script; applies to managed packages only.
|
|
6784
6544
|
--post-install-url=<value> Post-install instructions URL.
|
|
6785
6545
|
--releasenotes-url=<value> Release notes URL.
|
|
6786
|
-
--skip-ancestor-check
|
|
6787
|
-
|
|
6546
|
+
--skip-ancestor-check Override ancestry requirements, which allows you to specify a package ancestor that
|
|
6547
|
+
isn’t the highest released package version.
|
|
6788
6548
|
--skip-validation Skip validation during package version creation; you can’t promote unvalidated
|
|
6789
6549
|
package versions.
|
|
6790
6550
|
--uninstall-script=<value> Uninstall script name; applies to managed packages only.
|
|
@@ -6915,7 +6675,7 @@ FLAG DESCRIPTIONS
|
|
|
6915
6675
|
periods of no output from commands.
|
|
6916
6676
|
```
|
|
6917
6677
|
|
|
6918
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
6678
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/version/create.ts)_
|
|
6919
6679
|
|
|
6920
6680
|
## `sf package version create list`
|
|
6921
6681
|
|
|
@@ -6976,7 +6736,7 @@ EXAMPLES
|
|
|
6976
6736
|
$ sf package version create list --created-last-days 0 --status Success
|
|
6977
6737
|
```
|
|
6978
6738
|
|
|
6979
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
6739
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/version/create/list.ts)_
|
|
6980
6740
|
|
|
6981
6741
|
## `sf package version create report`
|
|
6982
6742
|
|
|
@@ -7019,7 +6779,7 @@ EXAMPLES
|
|
|
7019
6779
|
$ sf package version create report --package-create-request-id 08c... --target-dev-hub devhub@example.com
|
|
7020
6780
|
```
|
|
7021
6781
|
|
|
7022
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
6782
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/version/create/report.ts)_
|
|
7023
6783
|
|
|
7024
6784
|
## `sf package version delete`
|
|
7025
6785
|
|
|
@@ -7060,7 +6820,7 @@ EXAMPLES
|
|
|
7060
6820
|
$ sf package version delete --package 04t... --target-org devhub@example.com
|
|
7061
6821
|
```
|
|
7062
6822
|
|
|
7063
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
6823
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/version/delete.ts)_
|
|
7064
6824
|
|
|
7065
6825
|
## `sf package version displayancestry`
|
|
7066
6826
|
|
|
@@ -7120,7 +6880,7 @@ FLAG DESCRIPTIONS
|
|
|
7120
6880
|
You can use the DOT code output in graph visualization software to create tree visualizations.
|
|
7121
6881
|
```
|
|
7122
6882
|
|
|
7123
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
6883
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/version/displayancestry.ts)_
|
|
7124
6884
|
|
|
7125
6885
|
## `sf package version displaydependencies`
|
|
7126
6886
|
|
|
@@ -7182,7 +6942,7 @@ FLAG DESCRIPTIONS
|
|
|
7182
6942
|
package, which must be installed last.
|
|
7183
6943
|
```
|
|
7184
6944
|
|
|
7185
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
6945
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/version/displaydependencies.ts)_
|
|
7186
6946
|
|
|
7187
6947
|
## `sf package version list`
|
|
7188
6948
|
|
|
@@ -7258,7 +7018,7 @@ EXAMPLES
|
|
|
7258
7018
|
$ sf package version list --packages exp-mgr,exp-mgr-util --released --modified-last-days 0
|
|
7259
7019
|
```
|
|
7260
7020
|
|
|
7261
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
7021
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/version/list.ts)_
|
|
7262
7022
|
|
|
7263
7023
|
## `sf package version promote`
|
|
7264
7024
|
|
|
@@ -7302,7 +7062,7 @@ EXAMPLES
|
|
|
7302
7062
|
$ sf package version promote --package "Awesome Package Alias"
|
|
7303
7063
|
```
|
|
7304
7064
|
|
|
7305
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
7065
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/version/promote.ts)_
|
|
7306
7066
|
|
|
7307
7067
|
## `sf package version report`
|
|
7308
7068
|
|
|
@@ -7342,7 +7102,7 @@ EXAMPLES
|
|
|
7342
7102
|
$ sf package version report --package "Your Package Alias" --target-dev-hub devhub@example.com
|
|
7343
7103
|
```
|
|
7344
7104
|
|
|
7345
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
7105
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/version/report.ts)_
|
|
7346
7106
|
|
|
7347
7107
|
## `sf package version retrieve`
|
|
7348
7108
|
|
|
@@ -7387,7 +7147,7 @@ EXAMPLES
|
|
|
7387
7147
|
$ sf package version retrieve --package 04tXXX --output-dir my-directory/ --target-dev-hub devhub@example.com
|
|
7388
7148
|
```
|
|
7389
7149
|
|
|
7390
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
7150
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/version/retrieve.ts)_
|
|
7391
7151
|
|
|
7392
7152
|
## `sf package version update`
|
|
7393
7153
|
|
|
@@ -7440,7 +7200,7 @@ EXAMPLES
|
|
|
7440
7200
|
$ sf package version update --package 04t... --version-description "New Package Version Description"
|
|
7441
7201
|
```
|
|
7442
7202
|
|
|
7443
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
7203
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package/version/update.ts)_
|
|
7444
7204
|
|
|
7445
7205
|
## `sf package1 version create`
|
|
7446
7206
|
|
|
@@ -7507,7 +7267,7 @@ FLAG DESCRIPTIONS
|
|
|
7507
7267
|
subscribers.
|
|
7508
7268
|
```
|
|
7509
7269
|
|
|
7510
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
7270
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package1/version/create.ts)_
|
|
7511
7271
|
|
|
7512
7272
|
## `sf package1 version create get`
|
|
7513
7273
|
|
|
@@ -7540,7 +7300,7 @@ EXAMPLES
|
|
|
7540
7300
|
$ sf package1 version create get --request-id 0HD... --target-org myorg@example.com
|
|
7541
7301
|
```
|
|
7542
7302
|
|
|
7543
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
7303
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package1/version/create/get.ts)_
|
|
7544
7304
|
|
|
7545
7305
|
## `sf package1 version display`
|
|
7546
7306
|
|
|
@@ -7574,7 +7334,7 @@ EXAMPLES
|
|
|
7574
7334
|
$ sf package1 version display --package-version-id 04t... --target-org myorg@example.com
|
|
7575
7335
|
```
|
|
7576
7336
|
|
|
7577
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
7337
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package1/version/display.ts)_
|
|
7578
7338
|
|
|
7579
7339
|
## `sf package1 version list`
|
|
7580
7340
|
|
|
@@ -7612,7 +7372,7 @@ FLAG DESCRIPTIONS
|
|
|
7612
7372
|
If not specified, shows all versions for all packages (managed and unmanaged) in the org.
|
|
7613
7373
|
```
|
|
7614
7374
|
|
|
7615
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.
|
|
7375
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.25.1/src/commands/package1/version/list.ts)_
|
|
7616
7376
|
|
|
7617
7377
|
## `sf plugins`
|
|
7618
7378
|
|
|
@@ -7635,7 +7395,7 @@ EXAMPLES
|
|
|
7635
7395
|
$ sf plugins
|
|
7636
7396
|
```
|
|
7637
7397
|
|
|
7638
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.
|
|
7398
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.56/src/commands/plugins/index.ts)_
|
|
7639
7399
|
|
|
7640
7400
|
## `sf plugins discover`
|
|
7641
7401
|
|
|
@@ -7653,7 +7413,7 @@ EXAMPLES
|
|
|
7653
7413
|
$ sf plugins discover
|
|
7654
7414
|
```
|
|
7655
7415
|
|
|
7656
|
-
_See code: [@salesforce/plugin-marketplace](https://github.com/salesforcecli/plugin-marketplace/blob/1.3.
|
|
7416
|
+
_See code: [@salesforce/plugin-marketplace](https://github.com/salesforcecli/plugin-marketplace/blob/1.3.10/src/commands/plugins/discover.ts)_
|
|
7657
7417
|
|
|
7658
7418
|
## `sf plugins:inspect PLUGIN...`
|
|
7659
7419
|
|
|
@@ -7680,7 +7440,7 @@ EXAMPLES
|
|
|
7680
7440
|
$ sf plugins inspect @salesforce/plugin-packaging
|
|
7681
7441
|
```
|
|
7682
7442
|
|
|
7683
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.
|
|
7443
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.56/src/commands/plugins/inspect.ts)_
|
|
7684
7444
|
|
|
7685
7445
|
## `sf plugins install PLUGIN`
|
|
7686
7446
|
|
|
@@ -7729,7 +7489,7 @@ EXAMPLES
|
|
|
7729
7489
|
$ sf plugins install someuser/someplugin
|
|
7730
7490
|
```
|
|
7731
7491
|
|
|
7732
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.
|
|
7492
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.56/src/commands/plugins/install.ts)_
|
|
7733
7493
|
|
|
7734
7494
|
## `sf plugins link PATH`
|
|
7735
7495
|
|
|
@@ -7760,7 +7520,7 @@ EXAMPLES
|
|
|
7760
7520
|
$ sf plugins link @salesforce/plugin-packaging
|
|
7761
7521
|
```
|
|
7762
7522
|
|
|
7763
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.
|
|
7523
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.56/src/commands/plugins/link.ts)_
|
|
7764
7524
|
|
|
7765
7525
|
## `sf plugins reset`
|
|
7766
7526
|
|
|
@@ -7775,7 +7535,7 @@ FLAGS
|
|
|
7775
7535
|
--reinstall Reinstall all plugins after uninstalling.
|
|
7776
7536
|
```
|
|
7777
7537
|
|
|
7778
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.
|
|
7538
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.56/src/commands/plugins/reset.ts)_
|
|
7779
7539
|
|
|
7780
7540
|
## `sf plugins trust verify`
|
|
7781
7541
|
|
|
@@ -7832,7 +7592,7 @@ EXAMPLES
|
|
|
7832
7592
|
$ sf plugins uninstall @salesforce/plugin-packaging
|
|
7833
7593
|
```
|
|
7834
7594
|
|
|
7835
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.
|
|
7595
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.56/src/commands/plugins/uninstall.ts)_
|
|
7836
7596
|
|
|
7837
7597
|
## `sf plugins update`
|
|
7838
7598
|
|
|
@@ -7850,7 +7610,7 @@ DESCRIPTION
|
|
|
7850
7610
|
Update installed plugins.
|
|
7851
7611
|
```
|
|
7852
7612
|
|
|
7853
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.
|
|
7613
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.56/src/commands/plugins/update.ts)_
|
|
7854
7614
|
|
|
7855
7615
|
## `sf project convert mdapi`
|
|
7856
7616
|
|
|
@@ -7913,7 +7673,7 @@ FLAG DESCRIPTIONS
|
|
|
7913
7673
|
If you specify this flag, don’t specify --metadata or --source-dir.
|
|
7914
7674
|
```
|
|
7915
7675
|
|
|
7916
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
7676
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.8/src/commands/project/convert/mdapi.ts)_
|
|
7917
7677
|
|
|
7918
7678
|
## `sf project convert source`
|
|
7919
7679
|
|
|
@@ -7986,7 +7746,7 @@ FLAG DESCRIPTIONS
|
|
|
7986
7746
|
Override the api version used for api requests made by this command
|
|
7987
7747
|
```
|
|
7988
7748
|
|
|
7989
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
7749
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.8/src/commands/project/convert/source.ts)_
|
|
7990
7750
|
|
|
7991
7751
|
## `sf project convert source-behavior`
|
|
7992
7752
|
|
|
@@ -8045,7 +7805,7 @@ EXAMPLES
|
|
|
8045
7805
|
$ sf project convert source-behavior --behavior decomposePermissionSetBeta --dry-run --preserve-temp-dir
|
|
8046
7806
|
```
|
|
8047
7807
|
|
|
8048
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
7808
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.8/src/commands/project/convert/source-behavior.ts)_
|
|
8049
7809
|
|
|
8050
7810
|
## `sf project delete source`
|
|
8051
7811
|
|
|
@@ -8198,7 +7958,7 @@ FLAG DESCRIPTIONS
|
|
|
8198
7958
|
- Separate the test names with spaces: --tests Test1 Test2 "Test With Space"
|
|
8199
7959
|
```
|
|
8200
7960
|
|
|
8201
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
7961
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.8/src/commands/project/delete/source.ts)_
|
|
8202
7962
|
|
|
8203
7963
|
## `sf project delete tracking`
|
|
8204
7964
|
|
|
@@ -8235,7 +7995,7 @@ EXAMPLES
|
|
|
8235
7995
|
$ sf project delete tracking --target-org my-scratch
|
|
8236
7996
|
```
|
|
8237
7997
|
|
|
8238
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
7998
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.8/src/commands/project/delete/tracking.ts)_
|
|
8239
7999
|
|
|
8240
8000
|
## `sf project deploy cancel`
|
|
8241
8001
|
|
|
@@ -8307,7 +8067,7 @@ FLAG DESCRIPTIONS
|
|
|
8307
8067
|
project deploy report".
|
|
8308
8068
|
```
|
|
8309
8069
|
|
|
8310
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
8070
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.8/src/commands/project/deploy/cancel.ts)_
|
|
8311
8071
|
|
|
8312
8072
|
## `sf project deploy preview`
|
|
8313
8073
|
|
|
@@ -8390,7 +8150,7 @@ FLAG DESCRIPTIONS
|
|
|
8390
8150
|
All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.
|
|
8391
8151
|
```
|
|
8392
8152
|
|
|
8393
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
8153
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.8/src/commands/project/deploy/preview.ts)_
|
|
8394
8154
|
|
|
8395
8155
|
## `sf project deploy quick`
|
|
8396
8156
|
|
|
@@ -8483,7 +8243,7 @@ ERROR CODES
|
|
|
8483
8243
|
Canceling (69) The deploy is being canceled.
|
|
8484
8244
|
```
|
|
8485
8245
|
|
|
8486
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
8246
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.8/src/commands/project/deploy/quick.ts)_
|
|
8487
8247
|
|
|
8488
8248
|
## `sf project deploy report`
|
|
8489
8249
|
|
|
@@ -8575,7 +8335,7 @@ FLAG DESCRIPTIONS
|
|
|
8575
8335
|
--coverage-formatters lcov --coverage-formatters clover
|
|
8576
8336
|
```
|
|
8577
8337
|
|
|
8578
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
8338
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.8/src/commands/project/deploy/report.ts)_
|
|
8579
8339
|
|
|
8580
8340
|
## `sf project deploy resume`
|
|
8581
8341
|
|
|
@@ -8672,7 +8432,7 @@ ERROR CODES
|
|
|
8672
8432
|
Canceling (69) The deploy is being canceled.
|
|
8673
8433
|
```
|
|
8674
8434
|
|
|
8675
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
8435
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.8/src/commands/project/deploy/resume.ts)_
|
|
8676
8436
|
|
|
8677
8437
|
## `sf project deploy start`
|
|
8678
8438
|
|
|
@@ -8938,7 +8698,7 @@ ERROR CODES
|
|
|
8938
8698
|
Canceling (69) The deploy is being canceled.
|
|
8939
8699
|
```
|
|
8940
8700
|
|
|
8941
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
8701
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.8/src/commands/project/deploy/start.ts)_
|
|
8942
8702
|
|
|
8943
8703
|
## `sf project deploy validate`
|
|
8944
8704
|
|
|
@@ -9142,122 +8902,17 @@ ERROR CODES
|
|
|
9142
8902
|
Canceling (69) The deploy is being canceled.
|
|
9143
8903
|
```
|
|
9144
8904
|
|
|
9145
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
8905
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.8/src/commands/project/deploy/validate.ts)_
|
|
9146
8906
|
|
|
9147
|
-
## `sf project generate`
|
|
8907
|
+
## `sf project generate manifest`
|
|
9148
8908
|
|
|
9149
|
-
|
|
8909
|
+
Create a project manifest that lists the metadata components you want to deploy or retrieve.
|
|
9150
8910
|
|
|
9151
8911
|
```
|
|
9152
8912
|
USAGE
|
|
9153
|
-
$ sf project generate
|
|
9154
|
-
<value>] [-
|
|
9155
|
-
|
|
9156
|
-
FLAGS
|
|
9157
|
-
-d, --output-dir=<value> [default: .] Directory for saving the created files.
|
|
9158
|
-
-n, --name=<value> (required) Name of the generated project.
|
|
9159
|
-
-p, --default-package-dir=<value> [default: force-app] Default package directory name.
|
|
9160
|
-
-s, --namespace=<value> Namespace associated with this project and any connected scratch orgs.
|
|
9161
|
-
-t, --template=<option> [default: standard] Template to use for project creation.
|
|
9162
|
-
<options: standard|empty|analytics>
|
|
9163
|
-
-x, --manifest Generate a manifest (package.xml) for change-set based development.
|
|
9164
|
-
--api-version=<value> Will set this version as sourceApiVersion in the sfdx-project.json file
|
|
9165
|
-
|
|
9166
|
-
GLOBAL FLAGS
|
|
9167
|
-
--flags-dir=<value> Import flag values from a directory.
|
|
9168
|
-
--json Format output as json.
|
|
9169
|
-
|
|
9170
|
-
DESCRIPTION
|
|
9171
|
-
Generate a Salesforce DX project.
|
|
9172
|
-
|
|
9173
|
-
A Salesforce DX project has a specific structure and a configuration file (sfdx-project.json) that identifies the
|
|
9174
|
-
directory as a Salesforce DX project. This command generates the necessary configuration files and directories to get
|
|
9175
|
-
you started.
|
|
9176
|
-
|
|
9177
|
-
By default, the generated sfdx-project.json file sets the sourceApiVersion property to the default API version
|
|
9178
|
-
currently used by Salesforce CLI. To specify a different version, set the apiVersion configuration variable. For
|
|
9179
|
-
example: "sf config set apiVersion=57.0 --global".
|
|
9180
|
-
|
|
9181
|
-
ALIASES
|
|
9182
|
-
$ sf force project create
|
|
9183
|
-
|
|
9184
|
-
EXAMPLES
|
|
9185
|
-
Generate a project called "mywork":
|
|
9186
|
-
|
|
9187
|
-
$ sf project generate --name mywork
|
|
9188
|
-
|
|
9189
|
-
Similar to previous example, but generate the files in a directory called "myapp":
|
|
9190
|
-
|
|
9191
|
-
$ sf project generate --name mywork --default-package-dir myapp
|
|
9192
|
-
|
|
9193
|
-
Similar to prevoius example, but also generate a default package.xml manifest file:
|
|
9194
|
-
|
|
9195
|
-
$ sf project generate --name mywork --default-package-dir myapp --manifest
|
|
9196
|
-
|
|
9197
|
-
Generate a project with the minimum files and directories:
|
|
9198
|
-
|
|
9199
|
-
$ sf project generate --name mywork --template empty
|
|
9200
|
-
|
|
9201
|
-
FLAG DESCRIPTIONS
|
|
9202
|
-
-d, --output-dir=<value> Directory for saving the created files.
|
|
9203
|
-
|
|
9204
|
-
The location can be an absolute path or relative to the current working directory. The default is the current
|
|
9205
|
-
directory.
|
|
9206
|
-
|
|
9207
|
-
-n, --name=<value> Name of the generated project.
|
|
9208
|
-
|
|
9209
|
-
Generates a project directory with this name; any valid directory name is accepted. Also sets the "name" property in
|
|
9210
|
-
the sfdx-project.json file to this name.
|
|
9211
|
-
|
|
9212
|
-
-p, --default-package-dir=<value> Default package directory name.
|
|
9213
|
-
|
|
9214
|
-
Metadata items such as classes and Lightning bundles are placed inside this folder.
|
|
9215
|
-
|
|
9216
|
-
-t, --template=standard|empty|analytics Template to use for project creation.
|
|
9217
|
-
|
|
9218
|
-
The template determines the sample configuration files and directories that this command generates. For example, the
|
|
9219
|
-
empty template provides these files and directory to get you started.
|
|
9220
|
-
|
|
9221
|
-
- .forceignore
|
|
9222
|
-
- config/project-scratch-def.json
|
|
9223
|
-
- sfdx-project.json
|
|
9224
|
-
- package.json
|
|
9225
|
-
- force-app (basic source directory structure)
|
|
9226
|
-
|
|
9227
|
-
The standard template provides a complete force-app directory structure so you know where to put your source. It
|
|
9228
|
-
also provides additional files and scripts, especially useful when using Salesforce Extensions for VS Code. For
|
|
9229
|
-
example:
|
|
9230
|
-
|
|
9231
|
-
- .gitignore: Use Git for version control.
|
|
9232
|
-
- .prettierrc and .prettierignore: Use Prettier to format your Aura components.
|
|
9233
|
-
- .vscode/extensions.json: When launched, Visual Studio Code, prompts you to install the recommended extensions for
|
|
9234
|
-
your project.
|
|
9235
|
-
- .vscode/launch.json: Configures Replay Debugger.
|
|
9236
|
-
- .vscode/settings.json: Additional configuration settings.
|
|
9237
|
-
|
|
9238
|
-
The analytics template provides similar files and the force-app/main/default/waveTemplates directory.
|
|
9239
|
-
|
|
9240
|
-
-x, --manifest Generate a manifest (package.xml) for change-set based development.
|
|
9241
|
-
|
|
9242
|
-
Generates a default manifest (package.xml) for fetching Apex, Visualforce, Lightning components, and static
|
|
9243
|
-
resources.
|
|
9244
|
-
|
|
9245
|
-
--api-version=<value> Will set this version as sourceApiVersion in the sfdx-project.json file
|
|
9246
|
-
|
|
9247
|
-
Override the api version used for api requests made by this command
|
|
9248
|
-
```
|
|
9249
|
-
|
|
9250
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.4.7/src/commands/project/generate.ts)_
|
|
9251
|
-
|
|
9252
|
-
## `sf project generate manifest`
|
|
9253
|
-
|
|
9254
|
-
Create a project manifest that lists the metadata components you want to deploy or retrieve.
|
|
9255
|
-
|
|
9256
|
-
```
|
|
9257
|
-
USAGE
|
|
9258
|
-
$ sf project generate manifest [--json] [--flags-dir <value>] [--api-version <value>] [-m <value>...] [-p <value>...] [-n
|
|
9259
|
-
<value> | -t pre|post|destroy|package] [-c managed|unlocked... --from-org <value>] [--excluded-metadata <value>...]
|
|
9260
|
-
[-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>]
|
|
9261
8916
|
|
|
9262
8917
|
FLAGS
|
|
9263
8918
|
-c, --include-packages=<option>... Package types (managed, unlocked) whose metadata is included in the manifest; by
|
|
@@ -9343,7 +8998,7 @@ EXAMPLES
|
|
|
9343
8998
|
$ sf project generate manifest --from-org test@myorg.com --excluded-metadata StandardValueSet
|
|
9344
8999
|
```
|
|
9345
9000
|
|
|
9346
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
9001
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.8/src/commands/project/generate/manifest.ts)_
|
|
9347
9002
|
|
|
9348
9003
|
## `sf project list ignored`
|
|
9349
9004
|
|
|
@@ -9385,7 +9040,7 @@ EXAMPLES
|
|
|
9385
9040
|
$ sf project list ignored --source-dir package.xml
|
|
9386
9041
|
```
|
|
9387
9042
|
|
|
9388
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
9043
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.8/src/commands/project/list/ignored.ts)_
|
|
9389
9044
|
|
|
9390
9045
|
## `sf project reset tracking`
|
|
9391
9046
|
|
|
@@ -9434,7 +9089,7 @@ EXAMPLES
|
|
|
9434
9089
|
$ sf project reset tracking --revision 30
|
|
9435
9090
|
```
|
|
9436
9091
|
|
|
9437
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
9092
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.8/src/commands/project/reset/tracking.ts)_
|
|
9438
9093
|
|
|
9439
9094
|
## `sf project retrieve preview`
|
|
9440
9095
|
|
|
@@ -9488,7 +9143,7 @@ FLAG DESCRIPTIONS
|
|
|
9488
9143
|
production orgs.
|
|
9489
9144
|
```
|
|
9490
9145
|
|
|
9491
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
9146
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.8/src/commands/project/retrieve/preview.ts)_
|
|
9492
9147
|
|
|
9493
9148
|
## `sf project retrieve start`
|
|
9494
9149
|
|
|
@@ -9669,7 +9324,7 @@ ENVIRONMENT VARIABLES
|
|
|
9669
9324
|
SF_USE_PROGRESS_BAR Set to false to disable the progress bar when running the metadata deploy command.
|
|
9670
9325
|
```
|
|
9671
9326
|
|
|
9672
|
-
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.
|
|
9327
|
+
_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.24.8/src/commands/project/retrieve/start.ts)_
|
|
9673
9328
|
|
|
9674
9329
|
## `sf schema generate field`
|
|
9675
9330
|
|
|
@@ -9876,7 +9531,7 @@ DESCRIPTION
|
|
|
9876
9531
|
Once you select a command, hit enter and it will show the help for that command.
|
|
9877
9532
|
```
|
|
9878
9533
|
|
|
9879
|
-
_See code: [@oclif/plugin-search](https://github.com/oclif/plugin-search/blob/1.2.
|
|
9534
|
+
_See code: [@oclif/plugin-search](https://github.com/oclif/plugin-search/blob/1.2.38/src/commands/search.ts)_
|
|
9880
9535
|
|
|
9881
9536
|
## `sf sobject describe`
|
|
9882
9537
|
|
|
@@ -9923,7 +9578,7 @@ EXAMPLES
|
|
|
9923
9578
|
$ sf sobject describe --sobject ApexCodeCoverage --use-tooling-api
|
|
9924
9579
|
```
|
|
9925
9580
|
|
|
9926
|
-
_See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.3.
|
|
9581
|
+
_See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.3.91/src/commands/sobject/describe.ts)_
|
|
9927
9582
|
|
|
9928
9583
|
## `sf sobject list`
|
|
9929
9584
|
|
|
@@ -9962,143 +9617,131 @@ EXAMPLES
|
|
|
9962
9617
|
$ sf sobject list --sobject custom --target-org my-scratch-org
|
|
9963
9618
|
```
|
|
9964
9619
|
|
|
9965
|
-
_See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.3.
|
|
9620
|
+
_See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.3.91/src/commands/sobject/list.ts)_
|
|
9966
9621
|
|
|
9967
|
-
## `sf
|
|
9622
|
+
## `sf template generate analytics template`
|
|
9968
9623
|
|
|
9969
|
-
Generate a
|
|
9624
|
+
Generate a simple Analytics template.
|
|
9970
9625
|
|
|
9971
9626
|
```
|
|
9972
9627
|
USAGE
|
|
9973
|
-
$ sf
|
|
9628
|
+
$ sf template generate analytics template -n <value> [--json] [--flags-dir <value>] [-d <value>] [--api-version
|
|
9974
9629
|
<value>]
|
|
9975
9630
|
|
|
9976
9631
|
FLAGS
|
|
9977
9632
|
-d, --output-dir=<value> [default: .] Directory for saving the created files.
|
|
9978
|
-
-n, --name=<value> (required) Name of the
|
|
9633
|
+
-n, --name=<value> (required) Name of the Analytics template.
|
|
9979
9634
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
9980
|
-
--type=<value> [default: application/zip] Content type (mime type) of the generated static resource.
|
|
9981
9635
|
|
|
9982
9636
|
GLOBAL FLAGS
|
|
9983
9637
|
--flags-dir=<value> Import flag values from a directory.
|
|
9984
9638
|
--json Format output as json.
|
|
9985
9639
|
|
|
9986
9640
|
DESCRIPTION
|
|
9987
|
-
Generate a
|
|
9641
|
+
Generate a simple Analytics template.
|
|
9988
9642
|
|
|
9989
|
-
|
|
9990
|
-
|
|
9991
|
-
|
|
9992
|
-
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.
|
|
9993
9646
|
|
|
9994
9647
|
ALIASES
|
|
9995
|
-
$ sf force
|
|
9648
|
+
$ sf force analytics template create
|
|
9649
|
+
$ sf analytics generate template
|
|
9996
9650
|
|
|
9997
9651
|
EXAMPLES
|
|
9998
|
-
Generate the metadata
|
|
9999
|
-
|
|
10000
|
-
$ sf static-resource generate --name MyResource
|
|
10001
|
-
|
|
10002
|
-
Similar to previous example, but specifies a MIME type of application/json:
|
|
10003
|
-
|
|
10004
|
-
$ sf static-resource generate --name MyResource --type application/json
|
|
10005
|
-
|
|
10006
|
-
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:
|
|
10007
9654
|
|
|
10008
|
-
$ sf
|
|
9655
|
+
$ sf template generate analytics template --name myTemplate --output-dir force-app/main/default/waveTemplates
|
|
10009
9656
|
|
|
10010
9657
|
FLAG DESCRIPTIONS
|
|
10011
9658
|
-d, --output-dir=<value> Directory for saving the created files.
|
|
10012
9659
|
|
|
10013
9660
|
The location can be an absolute path or relative to the current working directory. The default is the current
|
|
10014
9661
|
directory.
|
|
10015
|
-
|
|
10016
|
-
-n, --name=<value> Name of the generated static resource.
|
|
10017
|
-
|
|
10018
|
-
This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin
|
|
10019
|
-
with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.
|
|
10020
|
-
|
|
10021
|
-
--type=<value> Content type (mime type) of the generated static resource.
|
|
10022
|
-
|
|
10023
|
-
Must be a valid MIME type such as application/json, application/javascript, application/zip, text/plain, text/css,
|
|
10024
|
-
etc.
|
|
10025
9662
|
```
|
|
10026
9663
|
|
|
10027
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
9664
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.7.0/src/commands/template/generate/analytics/template.ts)_
|
|
10028
9665
|
|
|
10029
|
-
## `sf
|
|
9666
|
+
## `sf template generate apex class`
|
|
10030
9667
|
|
|
10031
|
-
|
|
9668
|
+
Generate an Apex class.
|
|
10032
9669
|
|
|
10033
9670
|
```
|
|
10034
9671
|
USAGE
|
|
10035
|
-
$ sf
|
|
9672
|
+
$ sf template generate apex class -n <value> [--json] [--flags-dir <value>] [-t
|
|
9673
|
+
ApexException|ApexUnitTest|BasicUnitTest|DefaultApexClass|InboundEmailService] [-d <value>] [--api-version <value>]
|
|
10036
9674
|
|
|
10037
9675
|
FLAGS
|
|
10038
|
-
-
|
|
10039
|
-
-
|
|
10040
|
-
-
|
|
10041
|
-
|
|
10042
|
-
--
|
|
10043
|
-
|
|
10044
|
-
DESCRIPTION
|
|
10045
|
-
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
|
|
10046
9681
|
|
|
10047
|
-
|
|
10048
|
-
|
|
9682
|
+
GLOBAL FLAGS
|
|
9683
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
9684
|
+
--json Format output as json.
|
|
10049
9685
|
|
|
10050
|
-
|
|
9686
|
+
DESCRIPTION
|
|
9687
|
+
Generate an Apex class.
|
|
10051
9688
|
|
|
10052
|
-
|
|
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.
|
|
10053
9692
|
|
|
10054
|
-
|
|
9693
|
+
ALIASES
|
|
9694
|
+
$ sf force apex class create
|
|
9695
|
+
$ sf apex generate class
|
|
10055
9696
|
|
|
10056
|
-
|
|
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:
|
|
10057
9700
|
|
|
10058
|
-
$ sf
|
|
9701
|
+
$ sf template generate apex class --name MyClass
|
|
10059
9702
|
|
|
10060
|
-
|
|
9703
|
+
Similar to previous example, but generates the files in the "force-app/main/default/classes" directory:
|
|
10061
9704
|
|
|
10062
|
-
$ sf
|
|
10063
|
-
```
|
|
9705
|
+
$ sf template generate apex class --name MyClass --output-dir force-app/main/default/classes
|
|
10064
9706
|
|
|
10065
|
-
|
|
9707
|
+
FLAG DESCRIPTIONS
|
|
9708
|
+
-d, --output-dir=<value> Directory for saving the created files.
|
|
10066
9709
|
|
|
10067
|
-
|
|
9710
|
+
The location can be an absolute path or relative to the current working directory. The default is the current
|
|
9711
|
+
directory.
|
|
10068
9712
|
|
|
10069
|
-
|
|
10070
|
-
USAGE
|
|
10071
|
-
$ sf version [--json] [--verbose]
|
|
9713
|
+
-n, --name=<value> Name of the generated Apex class.
|
|
10072
9714
|
|
|
10073
|
-
|
|
10074
|
-
--verbose Show additional information about the CLI.
|
|
9715
|
+
The name can be up to 40 characters and must start with a letter.
|
|
10075
9716
|
|
|
10076
|
-
|
|
10077
|
-
--json Format output as json.
|
|
9717
|
+
-t, --template=ApexException|ApexUnitTest|BasicUnitTest|DefaultApexClass|InboundEmailService
|
|
10078
9718
|
|
|
10079
|
-
|
|
10080
|
-
--verbose Show additional information about the CLI.
|
|
9719
|
+
Template to use for file creation.
|
|
10081
9720
|
|
|
10082
|
-
|
|
9721
|
+
Supplied parameter values or default values are filled into a copy of the template.
|
|
10083
9722
|
```
|
|
10084
9723
|
|
|
10085
|
-
_See code: [@
|
|
9724
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.7.0/src/commands/template/generate/apex/class.ts)_
|
|
10086
9725
|
|
|
10087
|
-
## `sf
|
|
9726
|
+
## `sf template generate apex trigger`
|
|
10088
9727
|
|
|
10089
|
-
Generate
|
|
9728
|
+
Generate an Apex trigger.
|
|
10090
9729
|
|
|
10091
9730
|
```
|
|
10092
9731
|
USAGE
|
|
10093
|
-
$ sf
|
|
10094
|
-
[
|
|
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...]
|
|
10095
9735
|
|
|
10096
9736
|
FLAGS
|
|
10097
9737
|
-d, --output-dir=<value> [default: .] Directory for saving the created files.
|
|
10098
|
-
-
|
|
10099
|
-
|
|
10100
|
-
|
|
10101
|
-
|
|
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>
|
|
10102
9745
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
10103
9746
|
|
|
10104
9747
|
GLOBAL FLAGS
|
|
@@ -10106,22 +9749,32 @@ GLOBAL FLAGS
|
|
|
10106
9749
|
--json Format output as json.
|
|
10107
9750
|
|
|
10108
9751
|
DESCRIPTION
|
|
10109
|
-
Generate
|
|
9752
|
+
Generate an Apex trigger.
|
|
10110
9753
|
|
|
10111
|
-
|
|
10112
|
-
|
|
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.
|
|
10113
9760
|
|
|
10114
9761
|
ALIASES
|
|
10115
|
-
$ sf force
|
|
9762
|
+
$ sf force apex trigger create
|
|
9763
|
+
$ sf apex generate trigger
|
|
10116
9764
|
|
|
10117
9765
|
EXAMPLES
|
|
10118
|
-
Generate
|
|
9766
|
+
Generate two files associated with the MyTrigger Apex trigger (MyTrigger.trigger and MyTrigger.trigger-meta.xml) in
|
|
9767
|
+
the current directory:
|
|
10119
9768
|
|
|
10120
|
-
$ sf
|
|
9769
|
+
$ sf template generate apex trigger --name MyTrigger
|
|
10121
9770
|
|
|
10122
|
-
Similar to previous example, but generate the files in the
|
|
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
|
|
9774
|
+
|
|
9775
|
+
Generate files for a trigger that fires on the Account object before and after an insert:
|
|
10123
9776
|
|
|
10124
|
-
$ sf
|
|
9777
|
+
$ sf template generate apex trigger --name MyTrigger --sobject Account --event "before insert,after insert"
|
|
10125
9778
|
|
|
10126
9779
|
FLAG DESCRIPTIONS
|
|
10127
9780
|
-d, --output-dir=<value> Directory for saving the created files.
|
|
@@ -10129,66 +9782,695 @@ FLAG DESCRIPTIONS
|
|
|
10129
9782
|
The location can be an absolute path or relative to the current working directory. The default is the current
|
|
10130
9783
|
directory.
|
|
10131
9784
|
|
|
10132
|
-
-n, --name=<value> Name of the generated
|
|
9785
|
+
-n, --name=<value> Name of the generated Apex trigger
|
|
10133
9786
|
|
|
10134
9787
|
The name can be up to 40 characters and must start with a letter.
|
|
10135
9788
|
|
|
10136
|
-
-t, --template=
|
|
9789
|
+
-t, --template=ApexTrigger Template to use for file creation.
|
|
10137
9790
|
|
|
10138
9791
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
10139
9792
|
```
|
|
10140
9793
|
|
|
10141
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.
|
|
9794
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.7.0/src/commands/template/generate/apex/trigger.ts)_
|
|
10142
9795
|
|
|
10143
|
-
## `sf
|
|
9796
|
+
## `sf template generate digital-experience site`
|
|
10144
9797
|
|
|
10145
|
-
Generate
|
|
9798
|
+
Generate an Experience Cloud site.
|
|
10146
9799
|
|
|
10147
9800
|
```
|
|
10148
9801
|
USAGE
|
|
10149
|
-
$ sf
|
|
10150
|
-
|
|
9802
|
+
$ sf template generate digital-experience site -n <value> -t BuildYourOwnLWR [--json] [--flags-dir <value>] [-o <value>] [-p <value>] [-e
|
|
9803
|
+
<value>] [-d <value>]
|
|
10151
9804
|
|
|
10152
9805
|
FLAGS
|
|
10153
|
-
-d, --output-dir=<value>
|
|
10154
|
-
-
|
|
10155
|
-
|
|
10156
|
-
|
|
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>
|
|
10157
9814
|
|
|
10158
9815
|
GLOBAL FLAGS
|
|
10159
9816
|
--flags-dir=<value> Import flag values from a directory.
|
|
10160
9817
|
--json Format output as json.
|
|
10161
9818
|
|
|
10162
9819
|
DESCRIPTION
|
|
10163
|
-
Generate
|
|
9820
|
+
Generate an Experience Cloud site.
|
|
10164
9821
|
|
|
10165
|
-
|
|
10166
|
-
|
|
10167
|
-
|
|
10168
|
-
ALIASES
|
|
10169
|
-
$ 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.
|
|
10170
9824
|
|
|
10171
9825
|
EXAMPLES
|
|
10172
|
-
Generate the
|
|
9826
|
+
Generate an Experience Cloud site using the BuildYourOwnLWR template. The site is called "mysite" and has the URL
|
|
9827
|
+
path prefix "mysite":
|
|
10173
9828
|
|
|
10174
|
-
$ sf
|
|
9829
|
+
$ sf template generate digital-experience site --template BuildYourOwnLWR --name mysite --url-path-prefix mysite
|
|
10175
9830
|
|
|
10176
|
-
|
|
9831
|
+
Generate an Experience Cloud site like the last example, but generate the files into the specified output directory:
|
|
10177
9832
|
|
|
10178
|
-
$ sf
|
|
9833
|
+
$ sf template generate digital-experience site --template BuildYourOwnLWR --name mysite --url-path-prefix mysite \
|
|
9834
|
+
--output-dir force-app/main/default
|
|
10179
9835
|
|
|
10180
9836
|
FLAG DESCRIPTIONS
|
|
10181
|
-
-d, --output-dir=<value> Directory
|
|
9837
|
+
-d, --output-dir=<value> Directory to generate the site files in.
|
|
10182
9838
|
|
|
10183
|
-
The location can be an absolute path or relative to the current working directory.
|
|
10184
|
-
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
|
+
```
|
|
10185
9843
|
|
|
10186
|
-
|
|
9844
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.7.0/src/commands/template/generate/digital-experience/site.ts)_
|
|
9845
|
+
|
|
9846
|
+
## `sf template generate lightning app`
|
|
9847
|
+
|
|
9848
|
+
Generate a Lightning App.
|
|
10187
9849
|
|
|
10188
|
-
The name can be up to 40 characters and must start with a letter.
|
|
10189
9850
|
```
|
|
9851
|
+
USAGE
|
|
9852
|
+
$ sf template generate lightning app -n <value> [--json] [--flags-dir <value>] [-t DefaultLightningApp] [-d <value>] [--api-version
|
|
9853
|
+
<value>]
|
|
10190
9854
|
|
|
10191
|
-
|
|
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.0/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.0/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.0/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.0/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.0/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.0/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.0/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.0/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.0/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)_
|
|
10192
10474
|
|
|
10193
10475
|
## `sf which`
|
|
10194
10476
|
|