@salesforce/cli 2.129.5 → 2.129.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -25,7 +25,7 @@ $ npm install -g @salesforce/cli
25
25
  $ sf COMMAND
26
26
  running command...
27
27
  $ sf (--version|-v)
28
- @salesforce/cli/2.129.5 linux-x64 node-v22.22.1
28
+ @salesforce/cli/2.129.6 linux-x64 node-v22.22.1
29
29
  $ sf --help [COMMAND]
30
30
  USAGE
31
31
  $ sf COMMAND
@@ -109,6 +109,7 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI.
109
109
  - [`sf logic run test`](#sf-logic-run-test)
110
110
  - [`sf org assign permset`](#sf-org-assign-permset)
111
111
  - [`sf org assign permsetlicense`](#sf-org-assign-permsetlicense)
112
+ - [`sf org create agent-user`](#sf-org-create-agent-user)
112
113
  - [`sf org create sandbox`](#sf-org-create-sandbox)
113
114
  - [`sf org create scratch`](#sf-org-create-scratch)
114
115
  - [`sf org create user`](#sf-org-create-user)
@@ -3881,6 +3882,84 @@ EXAMPLES
3881
3882
 
3882
3883
  _See code: [@salesforce/plugin-user](https://github.com/salesforcecli/plugin-user/blob/3.8.0/src/commands/org/assign/permsetlicense.ts)_
3883
3884
 
3885
+ ## `sf org create agent-user`
3886
+
3887
+ Create the default Salesforce user that is used to run an agent.
3888
+
3889
+ ```
3890
+ USAGE
3891
+ $ sf org create agent-user -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [--base-username <value>]
3892
+ [--first-name <value>] [--last-name <value>]
3893
+
3894
+ FLAGS
3895
+ -o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
3896
+ configuration variable is already set.
3897
+ --api-version=<value> Override the api version used for api requests made by this command
3898
+ --base-username=<value> Base username pattern. A unique ID is appended to ensure global uniqueness of the
3899
+ usename.
3900
+ --first-name=<value> [default: Agent] First name for the agent user.
3901
+ --last-name=<value> [default: User] Last name for the agent user.
3902
+
3903
+ GLOBAL FLAGS
3904
+ --flags-dir=<value> Import flag values from a directory.
3905
+ --json Format output as json.
3906
+
3907
+ DESCRIPTION
3908
+ Create the default Salesforce user that is used to run an agent.
3909
+
3910
+ You specify this user in the agent's Agent Script file using the "default_agent_user" parameter in the "config" block.
3911
+
3912
+ By default, this command:
3913
+
3914
+ - Generates a user called "Agent User" with a globally unique username. Use flags to change these default names.
3915
+ - Sets the user's email to the new username.
3916
+ - Assigns the user the "Einstein Agent User" profile.
3917
+ - Assigns the user these required permission sets: AgentforceServiceAgentBase, AgentforceServiceAgentUser,
3918
+ EinsteinGPTPromptTemplateUser
3919
+ - Checks that the user licenses required by the profile and permission sets are available in your org.
3920
+
3921
+ The generated user doesn't have a password. You can’t log into Salesforce using the agent user's username. Only
3922
+ Salesforce users with admin permissions can view or edit an agent user in Setup.
3923
+
3924
+ To assign additional permission sets or licenses after the user was created, use the "org assign permset" or "org
3925
+ assign
3926
+ permsetlicense" commands.
3927
+
3928
+ When the command completes, it displays a summary of what it did, including the new agent user's username and ID, the
3929
+ available licenses associated with the Einstein Agent User profile, and the profile and permission sets assigned to
3930
+ the
3931
+ agent user.
3932
+
3933
+ EXAMPLES
3934
+ Create an agent user with an auto-generated username; create the user in the org with alias "myorg":
3935
+
3936
+ $ sf org create agent-user --target-org myorg
3937
+
3938
+ Create an agent user by specifying a base username pattern; to make the username unique, the command appends a unique
3939
+ identifier:
3940
+ $ sf org create agent-user --base-username service-agent@corp.com --target-org myorg
3941
+
3942
+ Create an agent user with an auto-generated username but the custom name "Service Agent"; create the user in your
3943
+ default org:
3944
+ $ sf org create agent-user --first-name Service --last-name Agent
3945
+
3946
+ FLAG DESCRIPTIONS
3947
+ --base-username=<value> Base username pattern. A unique ID is appended to ensure global uniqueness of the usename.
3948
+
3949
+ Specify a base username in email format, such as "service-agent@corp.com". The command then appends a 12-character
3950
+ globally unique ID (GUID) to the name before the "@" sign, which ensures that the username is globally unique across
3951
+ all
3952
+ Salesforce orgs and sandboxes.
3953
+
3954
+ For example, if you specify "service-agent@corp.com", then the username might be
3955
+ "service-agent.a1b2c3d4e5f6@corp.com".
3956
+
3957
+ If not specified, the command auto-generates the username using this pattern:
3958
+ "agent.user.<GUID>@your-org-domain.com".
3959
+ ```
3960
+
3961
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.75/src/commands/org/create/agent-user.ts)_
3962
+
3884
3963
  ## `sf org create sandbox`
3885
3964
 
3886
3965
  Create a sandbox org.
@@ -4013,7 +4092,7 @@ FLAG DESCRIPTIONS
4013
4092
  You can specify either --source-sandbox-name or --source-id when cloning an existing sandbox, but not both.
4014
4093
  ```
4015
4094
 
4016
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.74/src/commands/org/create/sandbox.ts)_
4095
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.75/src/commands/org/create/sandbox.ts)_
4017
4096
 
4018
4097
  ## `sf org create scratch`
4019
4098
 
@@ -4195,7 +4274,7 @@ FLAG DESCRIPTIONS
4195
4274
  Omit this flag to have Salesforce generate a unique username for your org.
4196
4275
  ```
4197
4276
 
4198
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.74/src/commands/org/create/scratch.ts)_
4277
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.75/src/commands/org/create/scratch.ts)_
4199
4278
 
4200
4279
  ## `sf org create user`
4201
4280
 
@@ -4349,7 +4428,7 @@ EXAMPLES
4349
4428
  $ sf org delete sandbox --target-org my-sandbox --no-prompt
4350
4429
  ```
4351
4430
 
4352
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.74/src/commands/org/delete/sandbox.ts)_
4431
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.75/src/commands/org/delete/sandbox.ts)_
4353
4432
 
4354
4433
  ## `sf org delete scratch`
4355
4434
 
@@ -4393,7 +4472,7 @@ EXAMPLES
4393
4472
  $ sf org delete scratch --target-org my-scratch-org --no-prompt
4394
4473
  ```
4395
4474
 
4396
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.74/src/commands/org/delete/scratch.ts)_
4475
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.75/src/commands/org/delete/scratch.ts)_
4397
4476
 
4398
4477
  ## `sf org disable tracking`
4399
4478
 
@@ -4432,7 +4511,7 @@ EXAMPLES
4432
4511
  $ sf org disable tracking
4433
4512
  ```
4434
4513
 
4435
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.74/src/commands/org/disable/tracking.ts)_
4514
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.75/src/commands/org/disable/tracking.ts)_
4436
4515
 
4437
4516
  ## `sf org display`
4438
4517
 
@@ -4477,7 +4556,7 @@ EXAMPLES
4477
4556
  $ sf org display --target-org TestOrg1 --verbose
4478
4557
  ```
4479
4558
 
4480
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.74/src/commands/org/display.ts)_
4559
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.75/src/commands/org/display.ts)_
4481
4560
 
4482
4561
  ## `sf org display user`
4483
4562
 
@@ -4558,7 +4637,7 @@ EXAMPLES
4558
4637
  $ sf org enable tracking
4559
4638
  ```
4560
4639
 
4561
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.74/src/commands/org/enable/tracking.ts)_
4640
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.75/src/commands/org/enable/tracking.ts)_
4562
4641
 
4563
4642
  ## `sf org generate password`
4564
4643
 
@@ -4664,7 +4743,7 @@ EXAMPLES
4664
4743
  $ sf org list --clean
4665
4744
  ```
4666
4745
 
4667
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.74/src/commands/org/list.ts)_
4746
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.75/src/commands/org/list.ts)_
4668
4747
 
4669
4748
  ## `sf org list auth`
4670
4749
 
@@ -4803,7 +4882,7 @@ FLAG DESCRIPTIONS
4803
4882
  Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.
4804
4883
  ```
4805
4884
 
4806
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.74/src/commands/org/list/metadata.ts)_
4885
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.75/src/commands/org/list/metadata.ts)_
4807
4886
 
4808
4887
  ## `sf org list metadata-types`
4809
4888
 
@@ -4858,7 +4937,7 @@ FLAG DESCRIPTIONS
4858
4937
  Override the api version used for api requests made by this command
4859
4938
  ```
4860
4939
 
4861
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.74/src/commands/org/list/metadata-types.ts)_
4940
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.75/src/commands/org/list/metadata-types.ts)_
4862
4941
 
4863
4942
  ## `sf org list sobject record-counts`
4864
4943
 
@@ -5404,7 +5483,7 @@ EXAMPLES
5404
5483
  $ sf org open --source-file force-app/main/default/bots/Coral_Cloud_Agent/Coral_Cloud_Agent.bot-meta.xml
5405
5484
  ```
5406
5485
 
5407
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.74/src/commands/org/open.ts)_
5486
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.75/src/commands/org/open.ts)_
5408
5487
 
5409
5488
  ## `sf org open agent`
5410
5489
 
@@ -5455,7 +5534,7 @@ EXAMPLES
5455
5534
  $ sf org open agent --target-org MyTestOrg1 --browser firefox --api-name Coral_Cloud_Agent
5456
5535
  ```
5457
5536
 
5458
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.74/src/commands/org/open/agent.ts)_
5537
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.75/src/commands/org/open/agent.ts)_
5459
5538
 
5460
5539
  ## `sf org open authoring-bundle`
5461
5540
 
@@ -5501,7 +5580,7 @@ EXAMPLES
5501
5580
  $ sf org open authoring-bundle --target-org MyTestOrg1 --browser firefox
5502
5581
  ```
5503
5582
 
5504
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.74/src/commands/org/open/authoring-bundle.ts)_
5583
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.75/src/commands/org/open/authoring-bundle.ts)_
5505
5584
 
5506
5585
  ## `sf org refresh sandbox`
5507
5586
 
@@ -5604,7 +5683,7 @@ FLAG DESCRIPTIONS
5604
5683
  You can specify either --source-sandbox-name or --source-id when refreshing an existing sandbox, but not both.
5605
5684
  ```
5606
5685
 
5607
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.74/src/commands/org/refresh/sandbox.ts)_
5686
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.75/src/commands/org/refresh/sandbox.ts)_
5608
5687
 
5609
5688
  ## `sf org resume sandbox`
5610
5689
 
@@ -5667,7 +5746,7 @@ FLAG DESCRIPTIONS
5667
5746
  returns the job ID. To resume checking the sandbox creation, rerun this command.
5668
5747
  ```
5669
5748
 
5670
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.74/src/commands/org/resume/sandbox.ts)_
5749
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.75/src/commands/org/resume/sandbox.ts)_
5671
5750
 
5672
5751
  ## `sf org resume scratch`
5673
5752
 
@@ -5720,7 +5799,7 @@ FLAG DESCRIPTIONS
5720
5799
  returns the job ID. To resume checking the scratch creation, rerun this command.
5721
5800
  ```
5722
5801
 
5723
- _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.74/src/commands/org/resume/scratch.ts)_
5802
+ _See code: [@salesforce/plugin-org](https://github.com/salesforcecli/plugin-org/blob/5.9.75/src/commands/org/resume/scratch.ts)_
5724
5803
 
5725
5804
  ## `sf package convert`
5726
5805
 
@@ -9679,7 +9758,7 @@ FLAG DESCRIPTIONS
9679
9758
  directory.
9680
9759
  ```
9681
9760
 
9682
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.11.3/src/commands/template/generate/analytics/template.ts)_
9761
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.11.4/src/commands/template/generate/analytics/template.ts)_
9683
9762
 
9684
9763
  ## `sf template generate apex class`
9685
9764
 
@@ -9739,7 +9818,7 @@ FLAG DESCRIPTIONS
9739
9818
  Supplied parameter values or default values are filled into a copy of the template.
9740
9819
  ```
9741
9820
 
9742
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.11.3/src/commands/template/generate/apex/class.ts)_
9821
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.11.4/src/commands/template/generate/apex/class.ts)_
9743
9822
 
9744
9823
  ## `sf template generate apex trigger`
9745
9824
 
@@ -9809,7 +9888,7 @@ FLAG DESCRIPTIONS
9809
9888
  Supplied parameter values or default values are filled into a copy of the template.
9810
9889
  ```
9811
9890
 
9812
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.11.3/src/commands/template/generate/apex/trigger.ts)_
9891
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.11.4/src/commands/template/generate/apex/trigger.ts)_
9813
9892
 
9814
9893
  ## `sf template generate digital-experience site`
9815
9894
 
@@ -9863,7 +9942,7 @@ FLAG DESCRIPTIONS
9863
9942
  project, defaults to the current directory.
9864
9943
  ```
9865
9944
 
9866
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.11.3/src/commands/template/generate/digital-experience/site.ts)_
9945
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.11.4/src/commands/template/generate/digital-experience/site.ts)_
9867
9946
 
9868
9947
  ## `sf template generate flexipage`
9869
9948
 
@@ -9945,7 +10024,7 @@ FLAG DESCRIPTIONS
9945
10024
  'Custom_Object__c'. This sets the `sobjectType` field in the FlexiPage metadata.
9946
10025
  ```
9947
10026
 
9948
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.11.3/src/commands/template/generate/flexipage/index.ts)_
10027
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.11.4/src/commands/template/generate/flexipage/index.ts)_
9949
10028
 
9950
10029
  ## `sf template generate lightning app`
9951
10030
 
@@ -10001,7 +10080,7 @@ FLAG DESCRIPTIONS
10001
10080
  Supplied parameter values or default values are filled into a copy of the template.
10002
10081
  ```
10003
10082
 
10004
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.11.3/src/commands/template/generate/lightning/app.ts)_
10083
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.11.4/src/commands/template/generate/lightning/app.ts)_
10005
10084
 
10006
10085
  ## `sf template generate lightning component`
10007
10086
 
@@ -10071,7 +10150,7 @@ FLAG DESCRIPTIONS
10071
10150
  Supplied parameter values or default values are filled into a copy of the template.
10072
10151
  ```
10073
10152
 
10074
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.11.3/src/commands/template/generate/lightning/component.ts)_
10153
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.11.4/src/commands/template/generate/lightning/component.ts)_
10075
10154
 
10076
10155
  ## `sf template generate lightning event`
10077
10156
 
@@ -10127,7 +10206,7 @@ FLAG DESCRIPTIONS
10127
10206
  Supplied parameter values or default values are filled into a copy of the template.
10128
10207
  ```
10129
10208
 
10130
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.11.3/src/commands/template/generate/lightning/event.ts)_
10209
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.11.4/src/commands/template/generate/lightning/event.ts)_
10131
10210
 
10132
10211
  ## `sf template generate lightning interface`
10133
10212
 
@@ -10183,7 +10262,7 @@ FLAG DESCRIPTIONS
10183
10262
  Supplied parameter values or default values are filled into a copy of the template.
10184
10263
  ```
10185
10264
 
10186
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.11.3/src/commands/template/generate/lightning/interface.ts)_
10265
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.11.4/src/commands/template/generate/lightning/interface.ts)_
10187
10266
 
10188
10267
  ## `sf template generate lightning test`
10189
10268
 
@@ -10239,7 +10318,7 @@ FLAG DESCRIPTIONS
10239
10318
  Supplied parameter values or default values are filled into a copy of the template.
10240
10319
  ```
10241
10320
 
10242
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.11.3/src/commands/template/generate/lightning/test.ts)_
10321
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.11.4/src/commands/template/generate/lightning/test.ts)_
10243
10322
 
10244
10323
  ## `sf template generate project`
10245
10324
 
@@ -10352,7 +10431,7 @@ FLAG DESCRIPTIONS
10352
10431
  Override the api version used for api requests made by this command
10353
10432
  ```
10354
10433
 
10355
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.11.3/src/commands/template/generate/project/index.ts)_
10434
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.11.4/src/commands/template/generate/project/index.ts)_
10356
10435
 
10357
10436
  ## `sf template generate static-resource`
10358
10437
 
@@ -10415,7 +10494,7 @@ FLAG DESCRIPTIONS
10415
10494
  etc.
10416
10495
  ```
10417
10496
 
10418
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.11.3/src/commands/template/generate/static-resource/index.ts)_
10497
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.11.4/src/commands/template/generate/static-resource/index.ts)_
10419
10498
 
10420
10499
  ## `sf template generate visualforce component`
10421
10500
 
@@ -10472,7 +10551,7 @@ FLAG DESCRIPTIONS
10472
10551
  Supplied parameter values or default values are filled into a copy of the template.
10473
10552
  ```
10474
10553
 
10475
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.11.3/src/commands/template/generate/visualforce/component.ts)_
10554
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.11.4/src/commands/template/generate/visualforce/component.ts)_
10476
10555
 
10477
10556
  ## `sf template generate visualforce page`
10478
10557
 
@@ -10523,7 +10602,7 @@ FLAG DESCRIPTIONS
10523
10602
  The name can be up to 40 characters and must start with a letter.
10524
10603
  ```
10525
10604
 
10526
- _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.11.3/src/commands/template/generate/visualforce/page.ts)_
10605
+ _See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.11.4/src/commands/template/generate/visualforce/page.ts)_
10527
10606
 
10528
10607
  ## `sf update [CHANNEL]`
10529
10608