@salesforce/cli 2.116.0 → 2.116.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +322 -136
- package/npm-shrinkwrap.json +213 -142
- package/oclif.lock +158 -106
- package/oclif.manifest.json +1 -1
- package/package.json +16 -16
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.116.
|
|
28
|
+
@salesforce/cli/2.116.2 linux-x64 node-v22.21.1
|
|
29
29
|
$ sf --help [COMMAND]
|
|
30
30
|
USAGE
|
|
31
31
|
$ sf COMMAND
|
|
@@ -46,14 +46,17 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI.
|
|
|
46
46
|
- [`sf agent create`](#sf-agent-create)
|
|
47
47
|
- [`sf agent deactivate`](#sf-agent-deactivate)
|
|
48
48
|
- [`sf agent generate agent-spec`](#sf-agent-generate-agent-spec)
|
|
49
|
+
- [`sf agent generate authoring-bundle`](#sf-agent-generate-authoring-bundle)
|
|
49
50
|
- [`sf agent generate template`](#sf-agent-generate-template)
|
|
50
51
|
- [`sf agent generate test-spec`](#sf-agent-generate-test-spec)
|
|
51
52
|
- [`sf agent preview`](#sf-agent-preview)
|
|
53
|
+
- [`sf agent publish authoring-bundle`](#sf-agent-publish-authoring-bundle)
|
|
52
54
|
- [`sf agent test create`](#sf-agent-test-create)
|
|
53
55
|
- [`sf agent test list`](#sf-agent-test-list)
|
|
54
56
|
- [`sf agent test results`](#sf-agent-test-results)
|
|
55
57
|
- [`sf agent test resume`](#sf-agent-test-resume)
|
|
56
58
|
- [`sf agent test run`](#sf-agent-test-run)
|
|
59
|
+
- [`sf agent validate authoring-bundle`](#sf-agent-validate-authoring-bundle)
|
|
57
60
|
- [`sf alias list`](#sf-alias-list)
|
|
58
61
|
- [`sf alias set`](#sf-alias-set)
|
|
59
62
|
- [`sf alias unset`](#sf-alias-unset)
|
|
@@ -244,7 +247,7 @@ EXAMPLES
|
|
|
244
247
|
$ sf agent activate --api-name Resort_Manager --target-org my-org
|
|
245
248
|
```
|
|
246
249
|
|
|
247
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
250
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.25.1/src/commands/agent/activate.ts)_
|
|
248
251
|
|
|
249
252
|
## `sf agent create`
|
|
250
253
|
|
|
@@ -272,6 +275,11 @@ GLOBAL FLAGS
|
|
|
272
275
|
DESCRIPTION
|
|
273
276
|
Create an agent in your org using a local agent spec file.
|
|
274
277
|
|
|
278
|
+
NOTE: This command creates an agent that doesn't use Agent Script as its blueprint. We generally don't recommend you
|
|
279
|
+
use this workflow to create an agent. Rather, use the "agent generate|validate|publish authoring-bundle" commands to
|
|
280
|
+
author agents that use the Agent Script language. See "Author an Agent"
|
|
281
|
+
(https://developer.salesforce.com/docs/einstein/genai/guide/agent-dx-nga-author-agent.html) for details.
|
|
282
|
+
|
|
275
283
|
To run this command, you must have an agent spec file, which is a YAML file that define the agent properties and
|
|
276
284
|
contains a list of AI-generated topics. Topics define the range of jobs the agent can handle. Use the "agent generate
|
|
277
285
|
agent-spec" CLI command to generate an agent spec file. Then specify the file to this command using the --spec flag,
|
|
@@ -306,7 +314,7 @@ EXAMPLES
|
|
|
306
314
|
$ sf agent create --name "Resort Manager" --spec specs/resortManagerAgent.yaml --preview
|
|
307
315
|
```
|
|
308
316
|
|
|
309
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
317
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.25.1/src/commands/agent/create.ts)_
|
|
310
318
|
|
|
311
319
|
## `sf agent deactivate`
|
|
312
320
|
|
|
@@ -346,7 +354,7 @@ EXAMPLES
|
|
|
346
354
|
$ sf agent deactivate --api-name Resort_Manager --target-org my-org
|
|
347
355
|
```
|
|
348
356
|
|
|
349
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
357
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.25.1/src/commands/agent/deactivate.ts)_
|
|
350
358
|
|
|
351
359
|
## `sf agent generate agent-spec`
|
|
352
360
|
|
|
@@ -397,10 +405,9 @@ GLOBAL FLAGS
|
|
|
397
405
|
DESCRIPTION
|
|
398
406
|
Generate an agent spec, which is a YAML file that captures what an agent can do.
|
|
399
407
|
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
agent can handle.
|
|
408
|
+
An agent spec is a YAML-formatted file that contains basic information about the agent, such as its role, company
|
|
409
|
+
description, and an AI-generated list of topics based on this information. Topics define the range of jobs your agent
|
|
410
|
+
can handle.
|
|
404
411
|
|
|
405
412
|
Use flags, such as --role and --company-description, to provide details about your company and the role that the agent
|
|
406
413
|
plays in your company. If you prefer, you can also be prompted for the basic information; use --full-interview to be
|
|
@@ -418,8 +425,11 @@ DESCRIPTION
|
|
|
418
425
|
add context to the agent's prompts, the tone of the prompts, and the username of a user in the org to assign to the
|
|
419
426
|
agent.
|
|
420
427
|
|
|
421
|
-
When your agent spec is ready,
|
|
422
|
-
|
|
428
|
+
When your agent spec is ready, generate an authoring bundle from it by passing the spec file to the --spec flag of the
|
|
429
|
+
"agent generate authoring-bundle" CLI command. An authoring bundle is a metadata type that contains an Agent Script
|
|
430
|
+
file, which is the blueprint for an agent. (While not recommended, you can also use the agent spec file to immediately
|
|
431
|
+
create an agent with the "agent create" command. We don't recommend this workflow because these types of agents don't
|
|
432
|
+
use Agent Script, and are thus less flexible and more difficult to maintain.)
|
|
423
433
|
|
|
424
434
|
EXAMPLES
|
|
425
435
|
Generate an agent spec in the default location and use flags to specify the agent properties, such as its role and
|
|
@@ -451,7 +461,73 @@ EXAMPLES
|
|
|
451
461
|
$ sf agent generate agent-spec --tone formal --agent-user resortmanager@myorg.com
|
|
452
462
|
```
|
|
453
463
|
|
|
454
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
464
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.25.1/src/commands/agent/generate/agent-spec.ts)_
|
|
465
|
+
|
|
466
|
+
## `sf agent generate authoring-bundle`
|
|
467
|
+
|
|
468
|
+
Generate an authoring bundle from an existing agent spec YAML file.
|
|
469
|
+
|
|
470
|
+
```
|
|
471
|
+
USAGE
|
|
472
|
+
$ sf agent generate authoring-bundle -o <value> [--json] [--flags-dir <value>] [--api-name <value>] [--api-version <value>] [-f
|
|
473
|
+
<value>] [-d <value>] [-n <value>]
|
|
474
|
+
|
|
475
|
+
FLAGS
|
|
476
|
+
-d, --output-dir=<value> Directory where the authoring bundle files are generated.
|
|
477
|
+
-f, --spec=<value> Path to the agent spec YAML file; if not specified, the command provides a list that you
|
|
478
|
+
can choose from.
|
|
479
|
+
-n, --name=<value> Name (label) of the authoring bundle; if not specified, you're prompted for the name.
|
|
480
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
481
|
+
configuration variable is already set.
|
|
482
|
+
--api-name=<value> API name of the new authoring bundle; if not specified, the API name is derived from the
|
|
483
|
+
authoring bundle name (label); the API name can't exist in the org.
|
|
484
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
485
|
+
|
|
486
|
+
GLOBAL FLAGS
|
|
487
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
488
|
+
--json Format output as json.
|
|
489
|
+
|
|
490
|
+
DESCRIPTION
|
|
491
|
+
Generate an authoring bundle from an existing agent spec YAML file.
|
|
492
|
+
|
|
493
|
+
Authoring bundles are metadata components that contain an agent's Agent Script file. The Agent Script file is the
|
|
494
|
+
agent's blueprint; it fully describes what the agent can do using the Agent Script language.
|
|
495
|
+
|
|
496
|
+
Use this command to generate a new authoring bundle based on an agent spec YAML file, which you create with the "agent
|
|
497
|
+
generate agent-spec" command. The agent spec YAML file is a high-level description of the agent; it describes its
|
|
498
|
+
essence rather than exactly what it can do.
|
|
499
|
+
|
|
500
|
+
The metadata type for authoring bundles is aiAuthoringBundle, which consist of a standard
|
|
501
|
+
"<bundle-api-name>.bundle-meta.xml" metadata file and the Agent Script file (with extension ".agent"). When you run
|
|
502
|
+
this command, the new authoring bundle is generated in the force-app/main/default/aiAuthoringBundles/<bundle-api-name>
|
|
503
|
+
directory. Use the --output-dir flag to generate them elsewhere.
|
|
504
|
+
|
|
505
|
+
After you generate the initial authoring bundle, code the Agent Script file so your agent behaves exactly as you want.
|
|
506
|
+
The Agent Script file generated by this command is just a first draft of your agent! Interactively test the agent by
|
|
507
|
+
conversing with it using the "agent preview" command. Then publish the agent to your org with the "agent publish
|
|
508
|
+
authoring-bundle" command.
|
|
509
|
+
|
|
510
|
+
This command requires an org because it uses it to access an LLM for generating the Agent Script file.
|
|
511
|
+
|
|
512
|
+
EXAMPLES
|
|
513
|
+
Generate an authoring bundle by being prompted for all required values, such as the agent spec YAML file, the bundle
|
|
514
|
+
name, and the API name; use your default org:
|
|
515
|
+
|
|
516
|
+
$ sf agent generate authoring-bundle
|
|
517
|
+
|
|
518
|
+
Generate an authoring bundle from the "specs/agentSpec.yaml" agent spec YAML file and give it the label "My
|
|
519
|
+
Authoring Bundle"; use your default org:
|
|
520
|
+
|
|
521
|
+
$ sf agent generate authoring-bundle --spec specs/agentSpec.yaml --name "My Authoring Bundle"
|
|
522
|
+
|
|
523
|
+
Similar to previous example, but generate the authoring bundle files in the "other-package-dir/main/default" package
|
|
524
|
+
directory; use the org with alias "my-dev-org":
|
|
525
|
+
|
|
526
|
+
$ sf agent generate authoring-bundle --spec specs/agentSpec.yaml --name "My Authoring Bundle" --output-dir \
|
|
527
|
+
other-package-dir/main/default --target-org my-dev-org
|
|
528
|
+
```
|
|
529
|
+
|
|
530
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.25.1/src/commands/agent/generate/authoring-bundle.ts)_
|
|
455
531
|
|
|
456
532
|
## `sf agent generate template`
|
|
457
533
|
|
|
@@ -499,7 +575,7 @@ EXAMPLES
|
|
|
499
575
|
force-app/main/default/bots/My_Awesome_Agent/My_Awesome_Agent.bot-meta.xml --agent-version 1
|
|
500
576
|
```
|
|
501
577
|
|
|
502
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
578
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.25.1/src/commands/agent/generate/template.ts)_
|
|
503
579
|
|
|
504
580
|
## `sf agent generate test-spec`
|
|
505
581
|
|
|
@@ -560,71 +636,133 @@ EXAMPLES
|
|
|
560
636
|
force-app//main/default/aiEvaluationDefinitions/Resort_Manager_Tests.aiEvaluationDefinition-meta.xml
|
|
561
637
|
```
|
|
562
638
|
|
|
563
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
639
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.25.1/src/commands/agent/generate/test-spec.ts)_
|
|
564
640
|
|
|
565
641
|
## `sf agent preview`
|
|
566
642
|
|
|
567
|
-
Interact with an
|
|
643
|
+
Interact with an agent to preview how it responds to your statements, questions, and commands (utterances).
|
|
568
644
|
|
|
569
645
|
```
|
|
570
646
|
USAGE
|
|
571
|
-
$ sf agent preview
|
|
572
|
-
<value>] [-x]
|
|
647
|
+
$ sf agent preview [--flags-dir <value>] [--api-version <value>] (-c <value> -o <value>) [-n <value>]
|
|
648
|
+
[--authoring-bundle <value>] [-d <value>] [-x] [--use-live-actions]
|
|
573
649
|
|
|
574
650
|
FLAGS
|
|
575
|
-
-c, --client-app=<value>
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
-
|
|
579
|
-
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
--
|
|
651
|
+
-c, --client-app=<value> Name of the linked client app to use for the connection to the published and active
|
|
652
|
+
agent.
|
|
653
|
+
-d, --output-dir=<value> Directory where conversation transcripts are saved.
|
|
654
|
+
-n, --api-name=<value> API name of the published and active agent you want to interact with.
|
|
655
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
656
|
+
configuration variable is already set.
|
|
657
|
+
-x, --apex-debug Enable Apex debug logging during the agent preview conversation.
|
|
658
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
659
|
+
--authoring-bundle=<value> API name of the authoring bundle metadata component that contains the agent's Agent
|
|
660
|
+
Script file.
|
|
661
|
+
--use-live-actions Use real actions in the org; if not specified, preview uses AI to simulate (mock)
|
|
662
|
+
actions.
|
|
584
663
|
|
|
585
664
|
GLOBAL FLAGS
|
|
586
665
|
--flags-dir=<value> Import flag values from a directory.
|
|
587
666
|
|
|
588
667
|
DESCRIPTION
|
|
589
|
-
Interact with an
|
|
590
|
-
|
|
668
|
+
Interact with an agent to preview how it responds to your statements, questions, and commands (utterances).
|
|
669
|
+
|
|
670
|
+
Use this command to have a natural language conversation with an agent while you code its Agent Script file.
|
|
671
|
+
Previewing an agent works like an initial test to make sure it responds to your utterances as you expect. For example,
|
|
672
|
+
you can test that the agent uses a particular topic when asked a question, and then whether it invokes the correct
|
|
673
|
+
action associated with that topic. This command is the CLI-equivalent of the Preview panel in your org's Agentforce
|
|
674
|
+
Builder UI.
|
|
591
675
|
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
To exit the conversation, hit ESC or Control+C.
|
|
676
|
+
This command uses the agent's local authoring bundle, which contains its Agent Script file. You can let the command
|
|
677
|
+
provide a list of authoring bundles (labeled "(Agent Script)") to choose from or use the --authoring-bundle flag to
|
|
678
|
+
specify a bundle's API name.
|
|
596
679
|
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
680
|
+
You can use these two modes when previewing an agent from its Agent Script file:
|
|
681
|
+
|
|
682
|
+
- Simulated mode (Default): Uses only the Agent Script file to converse, and it simulates (mocks) all the actions. Use
|
|
683
|
+
this mode if none of the Apex classes, flows, and prompt templates that implement your actions are available yet. The
|
|
684
|
+
LLM uses the information about topics in the Agent Script file to simulate what the action does or how it responds.
|
|
685
|
+
- Live mode: Uses the actual Apex classes, flows, and prompt templates in your development org in the agent preview.
|
|
686
|
+
If you've changed the Apex classe, flows, or prompt templates in your local DX project, then you must deploy them to
|
|
687
|
+
your development org if you want to use them in your live preview. You can use the Apex Replay Debugger to debug your
|
|
688
|
+
Apex classes when using live mode.
|
|
689
|
+
|
|
690
|
+
The interface is simple: in the "Start typing..." prompt, enter a statement, question, or command; when you're done,
|
|
691
|
+
enter Return. Your utterance is posted on the right along with a timestamp. The agent then responds on the left. To
|
|
692
|
+
exit the conversation, hit ESC or Control+C.
|
|
600
693
|
|
|
601
694
|
When the session concludes, the command asks if you want to save the API responses and chat transcripts. By default,
|
|
602
|
-
the files are saved to the "./temp/agent-preview" directory. Specify a new default directory
|
|
603
|
-
environment variable "SF_AGENT_PREVIEW_OUTPUT_DIR" to the directory. Or you can pass the directory to the --output-dir
|
|
695
|
+
the files are saved to the "./temp/agent-preview" directory. Specify a new default directory with the --output-dir
|
|
604
696
|
flag.
|
|
605
697
|
|
|
606
|
-
|
|
607
|
-
|
|
698
|
+
NOTE: You can also use this command to connect to a published and active agent, which are labeled "(Published)" if you
|
|
699
|
+
let this command provide the list of agents to preview. That use case, however, requires additional security and
|
|
700
|
+
configuration in both your org and your DX project. The examples in this help are for previewing an agent from its
|
|
701
|
+
Agent Script file in your DX project and require only simple authorization of your org, such as with the "org login
|
|
702
|
+
web" command. The --client-app and --api-name flags are used only for previewing published and active agents, they
|
|
703
|
+
don't apply to Agent Script agents. See "Connect to a Published Agent" in the "Agentforce Developer Guide" for
|
|
704
|
+
complete documentation: https://developer.salesforce.com/docs/einstein/genai/guide/agent-dx-preview.html.
|
|
705
|
+
|
|
706
|
+
EXAMPLES
|
|
707
|
+
Preview an agent in simulated mode by choosing from a list of authoring bundles provided by the command; use the org
|
|
708
|
+
with alias "my-dev-org":
|
|
709
|
+
|
|
710
|
+
$ sf agent preview --target-org my-dev-org
|
|
711
|
+
|
|
712
|
+
Preview an agent in live mode by choosing from a list of authoring bundles. Save the conversation transcripts to the
|
|
713
|
+
"./transcripts/my-preview" directory, enable the Apex debug logs, and use your default org:
|
|
714
|
+
|
|
715
|
+
$ sf agent preview --use-live-actions --apex-debug --output-dir transcripts/my-preview
|
|
716
|
+
```
|
|
717
|
+
|
|
718
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.25.1/src/commands/agent/preview.ts)_
|
|
719
|
+
|
|
720
|
+
## `sf agent publish authoring-bundle`
|
|
721
|
+
|
|
722
|
+
Publish an authoring bundle to your org, which results in a new agent or a new version of an existing agent.
|
|
723
|
+
|
|
724
|
+
```
|
|
725
|
+
USAGE
|
|
726
|
+
$ sf agent publish authoring-bundle -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-n <value>]
|
|
608
727
|
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
728
|
+
FLAGS
|
|
729
|
+
-n, --api-name=<value> API name of the authoring bundle you want to publish; if not specified, the command
|
|
730
|
+
provides a list that you can choose from.
|
|
731
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
732
|
+
configuration variable is already set.
|
|
733
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
734
|
+
|
|
735
|
+
GLOBAL FLAGS
|
|
736
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
737
|
+
--json Format output as json.
|
|
738
|
+
|
|
739
|
+
DESCRIPTION
|
|
740
|
+
Publish an authoring bundle to your org, which results in a new agent or a new version of an existing agent.
|
|
741
|
+
|
|
742
|
+
An authoring bundle is a metadata type (named aiAuthoringBundle) that provides the blueprint for an agent. The
|
|
743
|
+
metadata type contains two files: the standard metatada XML file and an Agent Script file (extension ".agent") that
|
|
744
|
+
fully describes the agent using the Agent Script language.
|
|
745
|
+
|
|
746
|
+
When you publish an authoring bundle to your org, a number of things happen. First, this command validates that the
|
|
747
|
+
Agent Script file successfully compiles. If there are compilation errors, the command exits and you must fix the Agent
|
|
748
|
+
Script file to continue. Once the Agent Script file compiles, then it's published to the org, which in turn creates
|
|
749
|
+
new associated metadata (Bot, BotVersion, GenAiX), or new versions of the metadata if the agent already exists. The
|
|
750
|
+
new or updated metadata is retrieved back to your DX project, and then the authoring bundle metadata
|
|
751
|
+
(AiAuthoringBundle) is deployed to your org.
|
|
752
|
+
|
|
753
|
+
This command uses the API name of the authoring bundle.
|
|
613
754
|
|
|
614
755
|
EXAMPLES
|
|
615
|
-
|
|
616
|
-
connected app:
|
|
756
|
+
Publish an authoring bundle by being prompted for its API name; use your default org:
|
|
617
757
|
|
|
618
|
-
$ sf agent
|
|
758
|
+
$ sf agent publish authoring-bundle
|
|
619
759
|
|
|
620
|
-
|
|
621
|
-
directory rather than the default "./temp/agent-preview":
|
|
760
|
+
Publish an authoring bundle with API name MyAuthoringBundle to the org with alias "my-dev-org":
|
|
622
761
|
|
|
623
|
-
$ sf agent
|
|
624
|
-
transcripts/my-preview
|
|
762
|
+
$ sf agent publish authoring-bundle --api-name MyAuthoringbundle --target-org my-dev-org
|
|
625
763
|
```
|
|
626
764
|
|
|
627
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
765
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.25.1/src/commands/agent/publish/authoring-bundle.ts)_
|
|
628
766
|
|
|
629
767
|
## `sf agent test create`
|
|
630
768
|
|
|
@@ -679,7 +817,7 @@ EXAMPLES
|
|
|
679
817
|
$ sf agent test create --spec specs/Resort_Manager-testSpec.yaml --api-name Resort_Manager_Test --preview
|
|
680
818
|
```
|
|
681
819
|
|
|
682
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
820
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.25.1/src/commands/agent/test/create.ts)_
|
|
683
821
|
|
|
684
822
|
## `sf agent test list`
|
|
685
823
|
|
|
@@ -714,7 +852,7 @@ EXAMPLES
|
|
|
714
852
|
$ sf agent test list --target-org my-org
|
|
715
853
|
```
|
|
716
854
|
|
|
717
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
855
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.25.1/src/commands/agent/test/list.ts)_
|
|
718
856
|
|
|
719
857
|
## `sf agent test results`
|
|
720
858
|
|
|
@@ -780,7 +918,7 @@ FLAG DESCRIPTIONS
|
|
|
780
918
|
expression when using custom evaluations.
|
|
781
919
|
```
|
|
782
920
|
|
|
783
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
921
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.25.1/src/commands/agent/test/results.ts)_
|
|
784
922
|
|
|
785
923
|
## `sf agent test resume`
|
|
786
924
|
|
|
@@ -853,7 +991,7 @@ FLAG DESCRIPTIONS
|
|
|
853
991
|
expression when using custom evaluations.
|
|
854
992
|
```
|
|
855
993
|
|
|
856
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
994
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.25.1/src/commands/agent/test/resume.ts)_
|
|
857
995
|
|
|
858
996
|
## `sf agent test run`
|
|
859
997
|
|
|
@@ -927,7 +1065,54 @@ FLAG DESCRIPTIONS
|
|
|
927
1065
|
expression when using custom evaluations.
|
|
928
1066
|
```
|
|
929
1067
|
|
|
930
|
-
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.
|
|
1068
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.25.1/src/commands/agent/test/run.ts)_
|
|
1069
|
+
|
|
1070
|
+
## `sf agent validate authoring-bundle`
|
|
1071
|
+
|
|
1072
|
+
Validate an authoring bundle to ensure its Agent Script file compiles successfully and can be used to publish an agent.
|
|
1073
|
+
|
|
1074
|
+
```
|
|
1075
|
+
USAGE
|
|
1076
|
+
$ sf agent validate authoring-bundle -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-n <value>]
|
|
1077
|
+
|
|
1078
|
+
FLAGS
|
|
1079
|
+
-n, --api-name=<value> API name of the authoring bundle you want to validate; if not specified, the command
|
|
1080
|
+
provides a list that you can choose from.
|
|
1081
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
1082
|
+
configuration variable is already set.
|
|
1083
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
1084
|
+
|
|
1085
|
+
GLOBAL FLAGS
|
|
1086
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
1087
|
+
--json Format output as json.
|
|
1088
|
+
|
|
1089
|
+
DESCRIPTION
|
|
1090
|
+
Validate an authoring bundle to ensure its Agent Script file compiles successfully and can be used to publish an
|
|
1091
|
+
agent.
|
|
1092
|
+
|
|
1093
|
+
An authoring bundle is a metadata type (named aiAuthoringBundle) that provides the blueprint for an agent. The
|
|
1094
|
+
metadata type contains two files: the standard metatada XML file and an Agent Script file (extension ".agent") that
|
|
1095
|
+
fully describes the agent using the Agent Script language.
|
|
1096
|
+
|
|
1097
|
+
This command validates that the Agent Script file in the authoring bundle compiles without errors so that you can
|
|
1098
|
+
later publish the bundle to your org. Use this command while you code the Agent Script file to ensure that it's valid.
|
|
1099
|
+
If the validation fails, the command outputs the list of syntax errors, a brief description of the error, and the
|
|
1100
|
+
location in the Agent Script file where the error occurred.
|
|
1101
|
+
|
|
1102
|
+
This command uses the API name of the authoring bundle. If you don't provide an API name with the --api-name flag, the
|
|
1103
|
+
command searches the current DX project and outputs a list of authoring bundles that it found for you to choose from.
|
|
1104
|
+
|
|
1105
|
+
EXAMPLES
|
|
1106
|
+
Validate an authoring bundle by being prompted for its API name; use your default org:
|
|
1107
|
+
|
|
1108
|
+
$ sf agent validate authoring-bundle
|
|
1109
|
+
|
|
1110
|
+
Validate an authoring bundle with API name MyAuthoringBundle; use the org with alias "my-dev-org":
|
|
1111
|
+
|
|
1112
|
+
$ sf agent validate authoring-bundle --api-name MyAuthoringBundle --target-org my-dev-org
|
|
1113
|
+
```
|
|
1114
|
+
|
|
1115
|
+
_See code: [@salesforce/plugin-agent](https://github.com/salesforcecli/plugin-agent/blob/1.25.1/src/commands/agent/validate/authoring-bundle.ts)_
|
|
931
1116
|
|
|
932
1117
|
## `sf alias list`
|
|
933
1118
|
|
|
@@ -955,7 +1140,7 @@ EXAMPLES
|
|
|
955
1140
|
$ sf alias list
|
|
956
1141
|
```
|
|
957
1142
|
|
|
958
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.
|
|
1143
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.53/src/commands/alias/list.ts)_
|
|
959
1144
|
|
|
960
1145
|
## `sf alias set`
|
|
961
1146
|
|
|
@@ -1004,7 +1189,7 @@ EXAMPLES
|
|
|
1004
1189
|
$ sf alias set my-scratch-org test-ss0xut7txzxf@example.com
|
|
1005
1190
|
```
|
|
1006
1191
|
|
|
1007
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.
|
|
1192
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.53/src/commands/alias/set.ts)_
|
|
1008
1193
|
|
|
1009
1194
|
## `sf alias unset`
|
|
1010
1195
|
|
|
@@ -1044,7 +1229,7 @@ EXAMPLES
|
|
|
1044
1229
|
$ sf alias unset --all [--no-prompt]
|
|
1045
1230
|
```
|
|
1046
1231
|
|
|
1047
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.
|
|
1232
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.53/src/commands/alias/unset.ts)_
|
|
1048
1233
|
|
|
1049
1234
|
## `sf analytics generate template`
|
|
1050
1235
|
|
|
@@ -1086,7 +1271,7 @@ FLAG DESCRIPTIONS
|
|
|
1086
1271
|
directory.
|
|
1087
1272
|
```
|
|
1088
1273
|
|
|
1089
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.
|
|
1274
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.73/src/commands/analytics/generate/template.ts)_
|
|
1090
1275
|
|
|
1091
1276
|
## `sf apex generate class`
|
|
1092
1277
|
|
|
@@ -1145,7 +1330,7 @@ FLAG DESCRIPTIONS
|
|
|
1145
1330
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
1146
1331
|
```
|
|
1147
1332
|
|
|
1148
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.
|
|
1333
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.73/src/commands/apex/generate/class.ts)_
|
|
1149
1334
|
|
|
1150
1335
|
## `sf apex generate trigger`
|
|
1151
1336
|
|
|
@@ -1214,7 +1399,7 @@ FLAG DESCRIPTIONS
|
|
|
1214
1399
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
1215
1400
|
```
|
|
1216
1401
|
|
|
1217
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.
|
|
1402
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.73/src/commands/apex/generate/trigger.ts)_
|
|
1218
1403
|
|
|
1219
1404
|
## `sf apex get log`
|
|
1220
1405
|
|
|
@@ -1270,7 +1455,7 @@ FLAG DESCRIPTIONS
|
|
|
1270
1455
|
directory.
|
|
1271
1456
|
```
|
|
1272
1457
|
|
|
1273
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.
|
|
1458
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.2/src/commands/apex/get/log.ts)_
|
|
1274
1459
|
|
|
1275
1460
|
## `sf apex get test`
|
|
1276
1461
|
|
|
@@ -1330,7 +1515,7 @@ EXAMPLES
|
|
|
1330
1515
|
me@myorg'
|
|
1331
1516
|
```
|
|
1332
1517
|
|
|
1333
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.
|
|
1518
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.2/src/commands/apex/get/test.ts)_
|
|
1334
1519
|
|
|
1335
1520
|
## `sf apex list log`
|
|
1336
1521
|
|
|
@@ -1370,7 +1555,7 @@ EXAMPLES
|
|
|
1370
1555
|
$ sf apex list log --target-org me@my.org
|
|
1371
1556
|
```
|
|
1372
1557
|
|
|
1373
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.
|
|
1558
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.2/src/commands/apex/list/log.ts)_
|
|
1374
1559
|
|
|
1375
1560
|
## `sf apex run`
|
|
1376
1561
|
|
|
@@ -1417,7 +1602,7 @@ EXAMPLES
|
|
|
1417
1602
|
$ sf apex run
|
|
1418
1603
|
```
|
|
1419
1604
|
|
|
1420
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.
|
|
1605
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.2/src/commands/apex/run.ts)_
|
|
1421
1606
|
|
|
1422
1607
|
## `sf apex run test`
|
|
1423
1608
|
|
|
@@ -1427,11 +1612,12 @@ Invoke Apex tests in an org.
|
|
|
1427
1612
|
USAGE
|
|
1428
1613
|
$ sf apex run test -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-d <value>] [-l
|
|
1429
1614
|
RunLocalTests|RunAllTestsInOrg|RunSpecifiedTests] [-n <value>... | -s <value>... | -t <value>...] [-r
|
|
1430
|
-
human|tap|junit|json] [-w <value>] [-y] [-v -c] [--concise]
|
|
1615
|
+
human|tap|junit|json] [-i <value>] [-w <value>] [-y] [-v -c] [--concise]
|
|
1431
1616
|
|
|
1432
1617
|
FLAGS
|
|
1433
1618
|
-c, --code-coverage Retrieve code coverage results.
|
|
1434
1619
|
-d, --output-dir=<value> Directory in which to store test run files.
|
|
1620
|
+
-i, --poll-interval=<value> Number of seconds to wait between retries.
|
|
1435
1621
|
-l, --test-level=<option> Level of tests to run; default is RunLocalTests.
|
|
1436
1622
|
<options: RunLocalTests|RunAllTestsInOrg|RunSpecifiedTests>
|
|
1437
1623
|
-n, --class-names=<value>... Apex test class names to run; default is all classes.
|
|
@@ -1563,7 +1749,7 @@ FLAG DESCRIPTIONS
|
|
|
1563
1749
|
--tests Test1 --tests Test2
|
|
1564
1750
|
```
|
|
1565
1751
|
|
|
1566
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.
|
|
1752
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.2/src/commands/apex/run/test.ts)_
|
|
1567
1753
|
|
|
1568
1754
|
## `sf apex tail log`
|
|
1569
1755
|
|
|
@@ -1606,7 +1792,7 @@ EXAMPLES
|
|
|
1606
1792
|
$ sf apex tail log --color --skip-trace-flag
|
|
1607
1793
|
```
|
|
1608
1794
|
|
|
1609
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.
|
|
1795
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.2/src/commands/apex/tail/log.ts)_
|
|
1610
1796
|
|
|
1611
1797
|
## `sf api request graphql`
|
|
1612
1798
|
|
|
@@ -1659,7 +1845,7 @@ EXAMPLES
|
|
|
1659
1845
|
$ sf api request graphql --body example.txt --stream-to-file output.txt --include
|
|
1660
1846
|
```
|
|
1661
1847
|
|
|
1662
|
-
_See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.3.
|
|
1848
|
+
_See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.3.6/src/commands/api/request/graphql.ts)_
|
|
1663
1849
|
|
|
1664
1850
|
## `sf api request rest [URL]`
|
|
1665
1851
|
|
|
@@ -1768,7 +1954,7 @@ FLAG DESCRIPTIONS
|
|
|
1768
1954
|
https://github.com/salesforcecli/plugin-api/tree/main/test/test-files/data-project.
|
|
1769
1955
|
```
|
|
1770
1956
|
|
|
1771
|
-
_See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.3.
|
|
1957
|
+
_See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.3.6/src/commands/api/request/rest.ts)_
|
|
1772
1958
|
|
|
1773
1959
|
## `sf autocomplete [SHELL]`
|
|
1774
1960
|
|
|
@@ -1877,7 +2063,7 @@ CONFIGURATION VARIABLES
|
|
|
1877
2063
|
org-capitalize-record-types Whether record types are capitalized on scratch org creation.
|
|
1878
2064
|
```
|
|
1879
2065
|
|
|
1880
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.
|
|
2066
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.53/src/commands/config/get.ts)_
|
|
1881
2067
|
|
|
1882
2068
|
## `sf config list`
|
|
1883
2069
|
|
|
@@ -1917,7 +2103,7 @@ EXAMPLES
|
|
|
1917
2103
|
$ sf config list
|
|
1918
2104
|
```
|
|
1919
2105
|
|
|
1920
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.
|
|
2106
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.53/src/commands/config/list.ts)_
|
|
1921
2107
|
|
|
1922
2108
|
## `sf config set`
|
|
1923
2109
|
|
|
@@ -1986,7 +2172,7 @@ CONFIGURATION VARIABLES
|
|
|
1986
2172
|
org-capitalize-record-types Whether record types are capitalized on scratch org creation.
|
|
1987
2173
|
```
|
|
1988
2174
|
|
|
1989
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.
|
|
2175
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.53/src/commands/config/set.ts)_
|
|
1990
2176
|
|
|
1991
2177
|
## `sf config unset`
|
|
1992
2178
|
|
|
@@ -2036,7 +2222,7 @@ CONFIGURATION VARIABLES
|
|
|
2036
2222
|
org-capitalize-record-types Whether record types are capitalized on scratch org creation.
|
|
2037
2223
|
```
|
|
2038
2224
|
|
|
2039
|
-
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.
|
|
2225
|
+
_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.4.53/src/commands/config/unset.ts)_
|
|
2040
2226
|
|
|
2041
2227
|
## `sf data bulk results`
|
|
2042
2228
|
|
|
@@ -3166,7 +3352,7 @@ EXAMPLES
|
|
|
3166
3352
|
$ sf doctor --plugin @salesforce/plugin-source
|
|
3167
3353
|
```
|
|
3168
3354
|
|
|
3169
|
-
_See code: [@salesforce/plugin-info](https://github.com/salesforcecli/plugin-info/blob/3.4.
|
|
3355
|
+
_See code: [@salesforce/plugin-info](https://github.com/salesforcecli/plugin-info/blob/3.4.98/src/commands/doctor.ts)_
|
|
3170
3356
|
|
|
3171
3357
|
## `sf force data bulk delete`
|
|
3172
3358
|
|
|
@@ -3368,7 +3554,7 @@ EXAMPLES
|
|
|
3368
3554
|
$ sf info releasenotes display --version latest
|
|
3369
3555
|
```
|
|
3370
3556
|
|
|
3371
|
-
_See code: [@salesforce/plugin-info](https://github.com/salesforcecli/plugin-info/blob/3.4.
|
|
3557
|
+
_See code: [@salesforce/plugin-info](https://github.com/salesforcecli/plugin-info/blob/3.4.98/src/commands/info/releasenotes/display.ts)_
|
|
3372
3558
|
|
|
3373
3559
|
## `sf lightning generate app`
|
|
3374
3560
|
|
|
@@ -3423,7 +3609,7 @@ FLAG DESCRIPTIONS
|
|
|
3423
3609
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
3424
3610
|
```
|
|
3425
3611
|
|
|
3426
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.
|
|
3612
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.73/src/commands/lightning/generate/app.ts)_
|
|
3427
3613
|
|
|
3428
3614
|
## `sf lightning generate component`
|
|
3429
3615
|
|
|
@@ -3492,7 +3678,7 @@ FLAG DESCRIPTIONS
|
|
|
3492
3678
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
3493
3679
|
```
|
|
3494
3680
|
|
|
3495
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.
|
|
3681
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.73/src/commands/lightning/generate/component.ts)_
|
|
3496
3682
|
|
|
3497
3683
|
## `sf lightning generate event`
|
|
3498
3684
|
|
|
@@ -3547,7 +3733,7 @@ FLAG DESCRIPTIONS
|
|
|
3547
3733
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
3548
3734
|
```
|
|
3549
3735
|
|
|
3550
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.
|
|
3736
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.73/src/commands/lightning/generate/event.ts)_
|
|
3551
3737
|
|
|
3552
3738
|
## `sf lightning generate interface`
|
|
3553
3739
|
|
|
@@ -3602,7 +3788,7 @@ FLAG DESCRIPTIONS
|
|
|
3602
3788
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
3603
3789
|
```
|
|
3604
3790
|
|
|
3605
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.
|
|
3791
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.73/src/commands/lightning/generate/interface.ts)_
|
|
3606
3792
|
|
|
3607
3793
|
## `sf lightning generate test`
|
|
3608
3794
|
|
|
@@ -3657,7 +3843,7 @@ FLAG DESCRIPTIONS
|
|
|
3657
3843
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
3658
3844
|
```
|
|
3659
3845
|
|
|
3660
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.
|
|
3846
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.73/src/commands/lightning/generate/test.ts)_
|
|
3661
3847
|
|
|
3662
3848
|
## `sf logic get test`
|
|
3663
3849
|
|
|
@@ -3705,7 +3891,7 @@ EXAMPLES
|
|
|
3705
3891
|
$ sf logic get test --test-run-id <test run id> --result-format junit --target-org my-scratch
|
|
3706
3892
|
```
|
|
3707
3893
|
|
|
3708
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.
|
|
3894
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.2/src/commands/logic/get/test.ts)_
|
|
3709
3895
|
|
|
3710
3896
|
## `sf logic run test`
|
|
3711
3897
|
|
|
@@ -3827,7 +4013,7 @@ FLAG DESCRIPTIONS
|
|
|
3827
4013
|
--tests Test1 --tests Test2
|
|
3828
4014
|
```
|
|
3829
4015
|
|
|
3830
|
-
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.
|
|
4016
|
+
_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.9.2/src/commands/logic/run/test.ts)_
|
|
3831
4017
|
|
|
3832
4018
|
## `sf org assign permset`
|
|
3833
4019
|
|
|
@@ -3873,7 +4059,7 @@ EXAMPLES
|
|
|
3873
4059
|
$ sf org assign permset --name DreamHouse --on-behalf-of user1@my.org --on-behalf-of user2 --on-behalf-of user
|
|
3874
4060
|
```
|
|
3875
4061
|
|
|
3876
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.6.
|
|
4062
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.6.43/src/commands/org/assign/permset.ts)_
|
|
3877
4063
|
|
|
3878
4064
|
## `sf org assign permsetlicense`
|
|
3879
4065
|
|
|
@@ -3920,7 +4106,7 @@ EXAMPLES
|
|
|
3920
4106
|
user3
|
|
3921
4107
|
```
|
|
3922
4108
|
|
|
3923
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.6.
|
|
4109
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.6.43/src/commands/org/assign/permsetlicense.ts)_
|
|
3924
4110
|
|
|
3925
4111
|
## `sf org create sandbox`
|
|
3926
4112
|
|
|
@@ -4344,7 +4530,7 @@ FLAG DESCRIPTIONS
|
|
|
4344
4530
|
might be different than what you specify in the definition file.
|
|
4345
4531
|
```
|
|
4346
4532
|
|
|
4347
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.6.
|
|
4533
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.6.43/src/commands/org/create/user.ts)_
|
|
4348
4534
|
|
|
4349
4535
|
## `sf org delete sandbox`
|
|
4350
4536
|
|
|
@@ -4557,7 +4743,7 @@ EXAMPLES
|
|
|
4557
4743
|
$ sf org display user --target-org me@my.org --json
|
|
4558
4744
|
```
|
|
4559
4745
|
|
|
4560
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.6.
|
|
4746
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.6.43/src/commands/org/display/user.ts)_
|
|
4561
4747
|
|
|
4562
4748
|
## `sf org enable tracking`
|
|
4563
4749
|
|
|
@@ -4666,7 +4852,7 @@ EXAMPLES
|
|
|
4666
4852
|
$ sf org generate password --on-behalf-of user1@my.org --on-behalf-of user2@my.org --on-behalf-of user3@my.org
|
|
4667
4853
|
```
|
|
4668
4854
|
|
|
4669
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.6.
|
|
4855
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.6.43/src/commands/org/generate/password.ts)_
|
|
4670
4856
|
|
|
4671
4857
|
## `sf org list`
|
|
4672
4858
|
|
|
@@ -4737,7 +4923,7 @@ EXAMPLES
|
|
|
4737
4923
|
$ sf org list auth
|
|
4738
4924
|
```
|
|
4739
4925
|
|
|
4740
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.9.
|
|
4926
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.9.23/src/commands/org/list/auth.ts)_
|
|
4741
4927
|
|
|
4742
4928
|
## `sf org list limits`
|
|
4743
4929
|
|
|
@@ -4777,7 +4963,7 @@ EXAMPLES
|
|
|
4777
4963
|
$ sf org list limits --target-org my-scratch-org
|
|
4778
4964
|
```
|
|
4779
4965
|
|
|
4780
|
-
_See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.3.
|
|
4966
|
+
_See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.3.73/src/commands/org/list/limits.ts)_
|
|
4781
4967
|
|
|
4782
4968
|
## `sf org list metadata`
|
|
4783
4969
|
|
|
@@ -4945,7 +5131,7 @@ EXAMPLES
|
|
|
4945
5131
|
$ sf org list sobject record-counts --sobject Account --sobject Lead --target-org my-scratch-org
|
|
4946
5132
|
```
|
|
4947
5133
|
|
|
4948
|
-
_See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.3.
|
|
5134
|
+
_See code: [@salesforce/plugin-limits](https://github.com/salesforcecli/plugin-limits/blob/3.3.73/src/commands/org/list/sobject/record-counts.ts)_
|
|
4949
5135
|
|
|
4950
5136
|
## `sf org list users`
|
|
4951
5137
|
|
|
@@ -4983,7 +5169,7 @@ EXAMPLES
|
|
|
4983
5169
|
$ sf org list users --target-org me@my.org
|
|
4984
5170
|
```
|
|
4985
5171
|
|
|
4986
|
-
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.6.
|
|
5172
|
+
_See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.6.43/src/commands/org/list/users.ts)_
|
|
4987
5173
|
|
|
4988
5174
|
## `sf org login access-token`
|
|
4989
5175
|
|
|
@@ -5037,7 +5223,7 @@ FLAG DESCRIPTIONS
|
|
|
5037
5223
|
To specify a sandbox, set --instance-url to "https://<MyDomainName>--<SandboxName>.sandbox.my.salesforce.com".
|
|
5038
5224
|
```
|
|
5039
5225
|
|
|
5040
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.9.
|
|
5226
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.9.23/src/commands/org/login/access-token.ts)_
|
|
5041
5227
|
|
|
5042
5228
|
## `sf org login jwt`
|
|
5043
5229
|
|
|
@@ -5128,7 +5314,7 @@ FLAG DESCRIPTIONS
|
|
|
5128
5314
|
To specify a sandbox, set --instance-url to "https://<MyDomainName>--<SandboxName>.sandbox.my.salesforce.com".
|
|
5129
5315
|
```
|
|
5130
5316
|
|
|
5131
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.9.
|
|
5317
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.9.23/src/commands/org/login/jwt.ts)_
|
|
5132
5318
|
|
|
5133
5319
|
## `sf org login sfdx-url`
|
|
5134
5320
|
|
|
@@ -5198,7 +5384,7 @@ EXAMPLES
|
|
|
5198
5384
|
$ echo url | sf org login sfdx-url --sfdx-url-stdin
|
|
5199
5385
|
```
|
|
5200
5386
|
|
|
5201
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.9.
|
|
5387
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.9.23/src/commands/org/login/sfdx-url.ts)_
|
|
5202
5388
|
|
|
5203
5389
|
## `sf org login web`
|
|
5204
5390
|
|
|
@@ -5303,7 +5489,7 @@ FLAG DESCRIPTIONS
|
|
|
5303
5489
|
To specify a sandbox, set --instance-url to "https://<MyDomainName>--<SandboxName>.sandbox.my.salesforce.com".
|
|
5304
5490
|
```
|
|
5305
5491
|
|
|
5306
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.9.
|
|
5492
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.9.23/src/commands/org/login/web.ts)_
|
|
5307
5493
|
|
|
5308
5494
|
## `sf org logout`
|
|
5309
5495
|
|
|
@@ -5369,7 +5555,7 @@ FLAG DESCRIPTIONS
|
|
|
5369
5555
|
All orgs includes Dev Hubs, sandboxes, DE orgs, and expired, deleted, and unknown-status scratch orgs.
|
|
5370
5556
|
```
|
|
5371
5557
|
|
|
5372
|
-
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.9.
|
|
5558
|
+
_See code: [@salesforce/plugin-auth](https://github.com/salesforcecli/plugin-auth/blob/3.9.23/src/commands/org/logout.ts)_
|
|
5373
5559
|
|
|
5374
5560
|
## `sf org open`
|
|
5375
5561
|
|
|
@@ -5812,7 +5998,7 @@ FLAG DESCRIPTIONS
|
|
|
5812
5998
|
--installation-key-bypass flag is required.
|
|
5813
5999
|
```
|
|
5814
6000
|
|
|
5815
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.
|
|
6001
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.6/src/commands/package/convert.ts)_
|
|
5816
6002
|
|
|
5817
6003
|
## `sf package create`
|
|
5818
6004
|
|
|
@@ -5891,7 +6077,7 @@ FLAG DESCRIPTIONS
|
|
|
5891
6077
|
Org-Dependent Unlocked Packages" in the Salesforce DX Developer Guide.
|
|
5892
6078
|
```
|
|
5893
6079
|
|
|
5894
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.
|
|
6080
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.6/src/commands/package/create.ts)_
|
|
5895
6081
|
|
|
5896
6082
|
## `sf package delete`
|
|
5897
6083
|
|
|
@@ -5933,7 +6119,7 @@ EXAMPLES
|
|
|
5933
6119
|
$ sf package delete --package 0Ho... --target-dev-hub devhub@example.com
|
|
5934
6120
|
```
|
|
5935
6121
|
|
|
5936
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.
|
|
6122
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.6/src/commands/package/delete.ts)_
|
|
5937
6123
|
|
|
5938
6124
|
## `sf package install`
|
|
5939
6125
|
|
|
@@ -6032,7 +6218,7 @@ FLAG DESCRIPTIONS
|
|
|
6032
6218
|
- Delete: Delete removed components, except for custom objects and custom fields, that don't have dependencies.
|
|
6033
6219
|
```
|
|
6034
6220
|
|
|
6035
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.
|
|
6221
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.6/src/commands/package/install.ts)_
|
|
6036
6222
|
|
|
6037
6223
|
## `sf package install report`
|
|
6038
6224
|
|
|
@@ -6065,7 +6251,7 @@ EXAMPLES
|
|
|
6065
6251
|
$ sf package install report --request-id 0Hf... --target-org me@example.com
|
|
6066
6252
|
```
|
|
6067
6253
|
|
|
6068
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.
|
|
6254
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.6/src/commands/package/install/report.ts)_
|
|
6069
6255
|
|
|
6070
6256
|
## `sf package installed list`
|
|
6071
6257
|
|
|
@@ -6097,7 +6283,7 @@ EXAMPLES
|
|
|
6097
6283
|
$ sf package installed list --target-org me@example.com
|
|
6098
6284
|
```
|
|
6099
6285
|
|
|
6100
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.
|
|
6286
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.6/src/commands/package/installed/list.ts)_
|
|
6101
6287
|
|
|
6102
6288
|
## `sf package list`
|
|
6103
6289
|
|
|
@@ -6135,7 +6321,7 @@ EXAMPLES
|
|
|
6135
6321
|
$ sf package list --target-dev-hub devhub@example.com --verbose
|
|
6136
6322
|
```
|
|
6137
6323
|
|
|
6138
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.
|
|
6324
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.6/src/commands/package/list.ts)_
|
|
6139
6325
|
|
|
6140
6326
|
## `sf package push-upgrade abort`
|
|
6141
6327
|
|
|
@@ -6174,7 +6360,7 @@ EXAMPLES
|
|
|
6174
6360
|
$ sf package push-upgrade abort --push-request-id 0DV... --target-dev-hub devhub@example.com
|
|
6175
6361
|
```
|
|
6176
6362
|
|
|
6177
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.
|
|
6363
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.6/src/commands/package/push-upgrade/abort.ts)_
|
|
6178
6364
|
|
|
6179
6365
|
## `sf package push-upgrade list`
|
|
6180
6366
|
|
|
@@ -6233,7 +6419,7 @@ EXAMPLES
|
|
|
6233
6419
|
$ sf package push-upgrade list --package 033xyz –-status Failed
|
|
6234
6420
|
```
|
|
6235
6421
|
|
|
6236
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.
|
|
6422
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.6/src/commands/package/push-upgrade/list.ts)_
|
|
6237
6423
|
|
|
6238
6424
|
## `sf package push-upgrade report`
|
|
6239
6425
|
|
|
@@ -6275,7 +6461,7 @@ EXAMPLES
|
|
|
6275
6461
|
$ sf package push-upgrade report --push-request-id 0DV... --target-dev-hub devhub@example.com
|
|
6276
6462
|
```
|
|
6277
6463
|
|
|
6278
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.
|
|
6464
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.6/src/commands/package/push-upgrade/report.ts)_
|
|
6279
6465
|
|
|
6280
6466
|
## `sf package push-upgrade schedule`
|
|
6281
6467
|
|
|
@@ -6362,7 +6548,7 @@ FLAG DESCRIPTIONS
|
|
|
6362
6548
|
Overrides the value of the target-dev-hub configuration variable, if set.
|
|
6363
6549
|
```
|
|
6364
6550
|
|
|
6365
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.
|
|
6551
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.6/src/commands/package/push-upgrade/schedule.ts)_
|
|
6366
6552
|
|
|
6367
6553
|
## `sf package uninstall`
|
|
6368
6554
|
|
|
@@ -6410,7 +6596,7 @@ EXAMPLES
|
|
|
6410
6596
|
$ sf package uninstall --package "Undesirable Package Alias"
|
|
6411
6597
|
```
|
|
6412
6598
|
|
|
6413
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.
|
|
6599
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.6/src/commands/package/uninstall.ts)_
|
|
6414
6600
|
|
|
6415
6601
|
## `sf package uninstall report`
|
|
6416
6602
|
|
|
@@ -6443,7 +6629,7 @@ EXAMPLES
|
|
|
6443
6629
|
$ sf package uninstall report --request-id 06y... --target-org me@example.com
|
|
6444
6630
|
```
|
|
6445
6631
|
|
|
6446
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.
|
|
6632
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.6/src/commands/package/uninstall/report.ts)_
|
|
6447
6633
|
|
|
6448
6634
|
## `sf package update`
|
|
6449
6635
|
|
|
@@ -6506,7 +6692,7 @@ FLAG DESCRIPTIONS
|
|
|
6506
6692
|
notified to upgrade to the recommended version.
|
|
6507
6693
|
```
|
|
6508
6694
|
|
|
6509
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.
|
|
6695
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.6/src/commands/package/update.ts)_
|
|
6510
6696
|
|
|
6511
6697
|
## `sf package version create`
|
|
6512
6698
|
|
|
@@ -6681,7 +6867,7 @@ FLAG DESCRIPTIONS
|
|
|
6681
6867
|
periods of no output from commands.
|
|
6682
6868
|
```
|
|
6683
6869
|
|
|
6684
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.
|
|
6870
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.6/src/commands/package/version/create.ts)_
|
|
6685
6871
|
|
|
6686
6872
|
## `sf package version create list`
|
|
6687
6873
|
|
|
@@ -6742,7 +6928,7 @@ EXAMPLES
|
|
|
6742
6928
|
$ sf package version create list --created-last-days 0 --status Success
|
|
6743
6929
|
```
|
|
6744
6930
|
|
|
6745
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.
|
|
6931
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.6/src/commands/package/version/create/list.ts)_
|
|
6746
6932
|
|
|
6747
6933
|
## `sf package version create report`
|
|
6748
6934
|
|
|
@@ -6785,7 +6971,7 @@ EXAMPLES
|
|
|
6785
6971
|
$ sf package version create report --package-create-request-id 08c... --target-dev-hub devhub@example.com
|
|
6786
6972
|
```
|
|
6787
6973
|
|
|
6788
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.
|
|
6974
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.6/src/commands/package/version/create/report.ts)_
|
|
6789
6975
|
|
|
6790
6976
|
## `sf package version delete`
|
|
6791
6977
|
|
|
@@ -6826,7 +7012,7 @@ EXAMPLES
|
|
|
6826
7012
|
$ sf package version delete --package 04t... --target-org devhub@example.com
|
|
6827
7013
|
```
|
|
6828
7014
|
|
|
6829
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.
|
|
7015
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.6/src/commands/package/version/delete.ts)_
|
|
6830
7016
|
|
|
6831
7017
|
## `sf package version displayancestry`
|
|
6832
7018
|
|
|
@@ -6886,7 +7072,7 @@ FLAG DESCRIPTIONS
|
|
|
6886
7072
|
You can use the DOT code output in graph visualization software to create tree visualizations.
|
|
6887
7073
|
```
|
|
6888
7074
|
|
|
6889
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.
|
|
7075
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.6/src/commands/package/version/displayancestry.ts)_
|
|
6890
7076
|
|
|
6891
7077
|
## `sf package version displaydependencies`
|
|
6892
7078
|
|
|
@@ -6948,7 +7134,7 @@ FLAG DESCRIPTIONS
|
|
|
6948
7134
|
package, which must be installed last.
|
|
6949
7135
|
```
|
|
6950
7136
|
|
|
6951
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.
|
|
7137
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.6/src/commands/package/version/displaydependencies.ts)_
|
|
6952
7138
|
|
|
6953
7139
|
## `sf package version list`
|
|
6954
7140
|
|
|
@@ -7024,7 +7210,7 @@ EXAMPLES
|
|
|
7024
7210
|
$ sf package version list --packages exp-mgr,exp-mgr-util --released --modified-last-days 0
|
|
7025
7211
|
```
|
|
7026
7212
|
|
|
7027
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.
|
|
7213
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.6/src/commands/package/version/list.ts)_
|
|
7028
7214
|
|
|
7029
7215
|
## `sf package version promote`
|
|
7030
7216
|
|
|
@@ -7068,7 +7254,7 @@ EXAMPLES
|
|
|
7068
7254
|
$ sf package version promote --package "Awesome Package Alias"
|
|
7069
7255
|
```
|
|
7070
7256
|
|
|
7071
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.
|
|
7257
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.6/src/commands/package/version/promote.ts)_
|
|
7072
7258
|
|
|
7073
7259
|
## `sf package version report`
|
|
7074
7260
|
|
|
@@ -7108,7 +7294,7 @@ EXAMPLES
|
|
|
7108
7294
|
$ sf package version report --package "Your Package Alias" --target-dev-hub devhub@example.com
|
|
7109
7295
|
```
|
|
7110
7296
|
|
|
7111
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.
|
|
7297
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.6/src/commands/package/version/report.ts)_
|
|
7112
7298
|
|
|
7113
7299
|
## `sf package version retrieve`
|
|
7114
7300
|
|
|
@@ -7153,7 +7339,7 @@ EXAMPLES
|
|
|
7153
7339
|
$ sf package version retrieve --package 04tXXX --output-dir my-directory/ --target-dev-hub devhub@example.com
|
|
7154
7340
|
```
|
|
7155
7341
|
|
|
7156
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.
|
|
7342
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.6/src/commands/package/version/retrieve.ts)_
|
|
7157
7343
|
|
|
7158
7344
|
## `sf package version update`
|
|
7159
7345
|
|
|
@@ -7206,7 +7392,7 @@ EXAMPLES
|
|
|
7206
7392
|
$ sf package version update --package 04t... --version-description "New Package Version Description"
|
|
7207
7393
|
```
|
|
7208
7394
|
|
|
7209
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.
|
|
7395
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.6/src/commands/package/version/update.ts)_
|
|
7210
7396
|
|
|
7211
7397
|
## `sf package1 version create`
|
|
7212
7398
|
|
|
@@ -7273,7 +7459,7 @@ FLAG DESCRIPTIONS
|
|
|
7273
7459
|
subscribers.
|
|
7274
7460
|
```
|
|
7275
7461
|
|
|
7276
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.
|
|
7462
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.6/src/commands/package1/version/create.ts)_
|
|
7277
7463
|
|
|
7278
7464
|
## `sf package1 version create get`
|
|
7279
7465
|
|
|
@@ -7306,7 +7492,7 @@ EXAMPLES
|
|
|
7306
7492
|
$ sf package1 version create get --request-id 0HD... --target-org myorg@example.com
|
|
7307
7493
|
```
|
|
7308
7494
|
|
|
7309
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.
|
|
7495
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.6/src/commands/package1/version/create/get.ts)_
|
|
7310
7496
|
|
|
7311
7497
|
## `sf package1 version display`
|
|
7312
7498
|
|
|
@@ -7340,7 +7526,7 @@ EXAMPLES
|
|
|
7340
7526
|
$ sf package1 version display --package-version-id 04t... --target-org myorg@example.com
|
|
7341
7527
|
```
|
|
7342
7528
|
|
|
7343
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.
|
|
7529
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.6/src/commands/package1/version/display.ts)_
|
|
7344
7530
|
|
|
7345
7531
|
## `sf package1 version list`
|
|
7346
7532
|
|
|
@@ -7378,7 +7564,7 @@ FLAG DESCRIPTIONS
|
|
|
7378
7564
|
If not specified, shows all versions for all packages (managed and unmanaged) in the org.
|
|
7379
7565
|
```
|
|
7380
7566
|
|
|
7381
|
-
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.
|
|
7567
|
+
_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.23.6/src/commands/package1/version/list.ts)_
|
|
7382
7568
|
|
|
7383
7569
|
## `sf plugins`
|
|
7384
7570
|
|
|
@@ -8983,7 +9169,7 @@ FLAG DESCRIPTIONS
|
|
|
8983
9169
|
Override the api version used for api requests made by this command
|
|
8984
9170
|
```
|
|
8985
9171
|
|
|
8986
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.
|
|
9172
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.73/src/commands/project/generate.ts)_
|
|
8987
9173
|
|
|
8988
9174
|
## `sf project generate manifest`
|
|
8989
9175
|
|
|
@@ -9459,7 +9645,7 @@ FLAG DESCRIPTIONS
|
|
|
9459
9645
|
If you don't specify this flag, the command prompts you to choose from your local objects.
|
|
9460
9646
|
```
|
|
9461
9647
|
|
|
9462
|
-
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.4.
|
|
9648
|
+
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.4.80/src/commands/schema/generate/field.ts)_
|
|
9463
9649
|
|
|
9464
9650
|
## `sf schema generate platformevent`
|
|
9465
9651
|
|
|
@@ -9491,7 +9677,7 @@ EXAMPLES
|
|
|
9491
9677
|
$ sf schema generate platformevent --label "My Platform Event"
|
|
9492
9678
|
```
|
|
9493
9679
|
|
|
9494
|
-
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.4.
|
|
9680
|
+
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.4.80/src/commands/schema/generate/platformevent.ts)_
|
|
9495
9681
|
|
|
9496
9682
|
## `sf schema generate sobject`
|
|
9497
9683
|
|
|
@@ -9548,7 +9734,7 @@ FLAG DESCRIPTIONS
|
|
|
9548
9734
|
- Streaming API: With Bulk API and Sharing, classifies the custom object as an Enterprise Application object.
|
|
9549
9735
|
```
|
|
9550
9736
|
|
|
9551
|
-
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.4.
|
|
9737
|
+
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.4.80/src/commands/schema/generate/sobject.ts)_
|
|
9552
9738
|
|
|
9553
9739
|
## `sf schema generate tab`
|
|
9554
9740
|
|
|
@@ -9596,7 +9782,7 @@ FLAG DESCRIPTIONS
|
|
|
9596
9782
|
The API name for a custom object always ends in `__c`, such as `MyObject__c`.
|
|
9597
9783
|
```
|
|
9598
9784
|
|
|
9599
|
-
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.4.
|
|
9785
|
+
_See code: [@salesforce/plugin-sobject](https://github.com/salesforcecli/plugin-sobject/blob/1.4.80/src/commands/schema/generate/tab.ts)_
|
|
9600
9786
|
|
|
9601
9787
|
## `sf search`
|
|
9602
9788
|
|
|
@@ -9659,7 +9845,7 @@ EXAMPLES
|
|
|
9659
9845
|
$ sf sobject describe --sobject ApexCodeCoverage --use-tooling-api
|
|
9660
9846
|
```
|
|
9661
9847
|
|
|
9662
|
-
_See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.3.
|
|
9848
|
+
_See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.3.89/src/commands/sobject/describe.ts)_
|
|
9663
9849
|
|
|
9664
9850
|
## `sf sobject list`
|
|
9665
9851
|
|
|
@@ -9698,7 +9884,7 @@ EXAMPLES
|
|
|
9698
9884
|
$ sf sobject list --sobject custom --target-org my-scratch-org
|
|
9699
9885
|
```
|
|
9700
9886
|
|
|
9701
|
-
_See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.3.
|
|
9887
|
+
_See code: [@salesforce/plugin-schema](https://github.com/salesforcecli/plugin-schema/blob/3.3.89/src/commands/sobject/list.ts)_
|
|
9702
9888
|
|
|
9703
9889
|
## `sf static-resource generate`
|
|
9704
9890
|
|
|
@@ -9760,7 +9946,7 @@ FLAG DESCRIPTIONS
|
|
|
9760
9946
|
etc.
|
|
9761
9947
|
```
|
|
9762
9948
|
|
|
9763
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.
|
|
9949
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.73/src/commands/static-resource/generate.ts)_
|
|
9764
9950
|
|
|
9765
9951
|
## `sf update [CHANNEL]`
|
|
9766
9952
|
|
|
@@ -9874,7 +10060,7 @@ FLAG DESCRIPTIONS
|
|
|
9874
10060
|
Supplied parameter values or default values are filled into a copy of the template.
|
|
9875
10061
|
```
|
|
9876
10062
|
|
|
9877
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.
|
|
10063
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.73/src/commands/visualforce/generate/component.ts)_
|
|
9878
10064
|
|
|
9879
10065
|
## `sf visualforce generate page`
|
|
9880
10066
|
|
|
@@ -9924,7 +10110,7 @@ FLAG DESCRIPTIONS
|
|
|
9924
10110
|
The name can be up to 40 characters and must start with a letter.
|
|
9925
10111
|
```
|
|
9926
10112
|
|
|
9927
|
-
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.
|
|
10113
|
+
_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.73/src/commands/visualforce/generate/page.ts)_
|
|
9928
10114
|
|
|
9929
10115
|
## `sf which`
|
|
9930
10116
|
|