Skip to content

Commit 9c29017

Browse files
committed
chore(release): 1.28.0 [skip ci]
1 parent b89c252 commit 9c29017

File tree

3 files changed

+236
-17
lines changed

3 files changed

+236
-17
lines changed

CHANGELOG.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1+
# [1.28.0](https://github.com/salesforcecli/plugin-agent/compare/1.27.7...1.28.0) (2026-02-10)
2+
3+
### Bug Fixes
4+
5+
- add agent preview start,send,end commands ([c06d638](https://github.com/salesforcecli/plugin-agent/commit/c06d6386b8840a757147713ca518cf174ecf9523))
6+
- edit ([90c924e](https://github.com/salesforcecli/plugin-agent/commit/90c924e977613d5be9697e72734d7cccd174a9de))
7+
- teeny edit to existing "agent preview" messages file ([2a2d74a](https://github.com/salesforcecli/plugin-agent/commit/2a2d74ab453d98b77c55f365e80809542e38d08a))
8+
9+
### Features
10+
11+
- add 'agent preview sessions' to list sessions' ([8d3e807](https://github.com/salesforcecli/plugin-agent/commit/8d3e80734a1cd6eaeaffac37532634f06c6cd7af))
12+
113
## [1.27.7](https://github.com/salesforcecli/plugin-agent/compare/1.27.6...1.27.7) (2026-02-10)
214

315
### Bug Fixes

README.md

Lines changed: 223 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,10 @@ sf plugins
6767
- [`sf agent generate template`](#sf-agent-generate-template)
6868
- [`sf agent generate test-spec`](#sf-agent-generate-test-spec)
6969
- [`sf agent preview`](#sf-agent-preview)
70+
- [`sf agent preview end`](#sf-agent-preview-end)
71+
- [`sf agent preview send`](#sf-agent-preview-send)
72+
- [`sf agent preview sessions`](#sf-agent-preview-sessions)
73+
- [`sf agent preview start`](#sf-agent-preview-start)
7074
- [`sf agent publish authoring-bundle`](#sf-agent-publish-authoring-bundle)
7175
- [`sf agent test create`](#sf-agent-test-create)
7276
- [`sf agent test list`](#sf-agent-test-list)
@@ -112,7 +116,7 @@ EXAMPLES
112116
$ sf agent activate --api-name Resort_Manager --target-org my-org
113117
```
114118

115-
_See code: [src/commands/agent/activate.ts](https://github.com/salesforcecli/plugin-agent/blob/1.27.7/src/commands/agent/activate.ts)_
119+
_See code: [src/commands/agent/activate.ts](https://github.com/salesforcecli/plugin-agent/blob/1.28.0/src/commands/agent/activate.ts)_
116120

117121
## `sf agent create`
118122

@@ -179,7 +183,7 @@ EXAMPLES
179183
$ sf agent create --name "Resort Manager" --spec specs/resortManagerAgent.yaml --preview
180184
```
181185

182-
_See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.27.7/src/commands/agent/create.ts)_
186+
_See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.28.0/src/commands/agent/create.ts)_
183187

184188
## `sf agent deactivate`
185189

@@ -219,7 +223,7 @@ EXAMPLES
219223
$ sf agent deactivate --api-name Resort_Manager --target-org my-org
220224
```
221225

222-
_See code: [src/commands/agent/deactivate.ts](https://github.com/salesforcecli/plugin-agent/blob/1.27.7/src/commands/agent/deactivate.ts)_
226+
_See code: [src/commands/agent/deactivate.ts](https://github.com/salesforcecli/plugin-agent/blob/1.28.0/src/commands/agent/deactivate.ts)_
223227

224228
## `sf agent generate agent-spec`
225229

@@ -326,7 +330,7 @@ EXAMPLES
326330
$ sf agent generate agent-spec --tone formal --agent-user resortmanager@myorg.com
327331
```
328332

329-
_See code: [src/commands/agent/generate/agent-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.27.7/src/commands/agent/generate/agent-spec.ts)_
333+
_See code: [src/commands/agent/generate/agent-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.28.0/src/commands/agent/generate/agent-spec.ts)_
330334

331335
## `sf agent generate authoring-bundle`
332336

@@ -401,7 +405,7 @@ EXAMPLES
401405
other-package-dir/main/default --target-org my-dev-org
402406
```
403407

404-
_See code: [src/commands/agent/generate/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.27.7/src/commands/agent/generate/authoring-bundle.ts)_
408+
_See code: [src/commands/agent/generate/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.28.0/src/commands/agent/generate/authoring-bundle.ts)_
405409

406410
## `sf agent generate template`
407411

@@ -449,7 +453,7 @@ EXAMPLES
449453
force-app/main/default/bots/My_Awesome_Agent/My_Awesome_Agent.bot-meta.xml --agent-version 1
450454
```
451455

452-
_See code: [src/commands/agent/generate/template.ts](https://github.com/salesforcecli/plugin-agent/blob/1.27.7/src/commands/agent/generate/template.ts)_
456+
_See code: [src/commands/agent/generate/template.ts](https://github.com/salesforcecli/plugin-agent/blob/1.28.0/src/commands/agent/generate/template.ts)_
453457

454458
## `sf agent generate test-spec`
455459

@@ -510,7 +514,7 @@ EXAMPLES
510514
force-app//main/default/aiEvaluationDefinitions/Resort_Manager_Tests.aiEvaluationDefinition-meta.xml
511515
```
512516

513-
_See code: [src/commands/agent/generate/test-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.27.7/src/commands/agent/generate/test-spec.ts)_
517+
_See code: [src/commands/agent/generate/test-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.28.0/src/commands/agent/generate/test-spec.ts)_
514518

515519
## `sf agent preview`
516520

@@ -523,7 +527,7 @@ USAGE
523527
524528
FLAGS
525529
-d, --output-dir=<value> Directory where conversation transcripts are saved.
526-
-n, --api-name=<value> API name of the published and active agent you want to interact with.
530+
-n, --api-name=<value> API name of the activated published agent you want to interact with.
527531
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
528532
configuration variable is already set.
529533
-x, --apex-debug Enable Apex debug logging during the agent preview conversation.
@@ -583,7 +587,210 @@ EXAMPLES
583587
$ sf agent preview --use-live-actions --apex-debug --output-dir transcripts/my-preview
584588
```
585589

586-
_See code: [src/commands/agent/preview.ts](https://github.com/salesforcecli/plugin-agent/blob/1.27.7/src/commands/agent/preview.ts)_
590+
_See code: [src/commands/agent/preview.ts](https://github.com/salesforcecli/plugin-agent/blob/1.28.0/src/commands/agent/preview.ts)_
591+
592+
## `sf agent preview end`
593+
594+
End an existing programmatic agent preview session and get trace location.
595+
596+
```
597+
USAGE
598+
$ sf agent preview end -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [--session-id <value>] [-n
599+
<value>] [--authoring-bundle <value>]
600+
601+
FLAGS
602+
-n, --api-name=<value> API name of the activated published agent you want to preview.
603+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
604+
configuration variable is already set.
605+
--api-version=<value> Override the api version used for api requests made by this command
606+
--authoring-bundle=<value> API name of the authoring bundle metadata component that contains the agent's Agent
607+
Script file.
608+
--session-id=<value> Session ID outputted by "agent preview start". Not required when the agent has exactly
609+
one active session. Run "agent preview sessions" to see the list of all sessions.
610+
611+
GLOBAL FLAGS
612+
--flags-dir=<value> Import flag values from a directory.
613+
--json Format output as json.
614+
615+
DESCRIPTION
616+
End an existing programmatic agent preview session and get trace location.
617+
618+
You must have previously started a programmatic agent preview session with the "agent preview start" command to then
619+
use this command to end it. This command also displays the local directory where the session trace files are stored.
620+
621+
The original "agent preview start" command outputs a session ID which you then use with the --session-id flag of this
622+
command to end the session. You don't have to specify the --session-id flag if an agent has only one active preview
623+
session. You must also use either the --authoring-bundle or --api-name flag to specify the API name of the authoring
624+
bundle or the published agent, respecitvely. To find either API name, navigate to your package directory in your DX
625+
project. The API name of an authoring bundle is the same as its directory name under the "aiAuthoringBundles" metadata
626+
directory. Similarly, the published agent's API name is the same as its directory name under the "Bots" metadata
627+
directory.
628+
629+
EXAMPLES
630+
End a preview session of a published agent by specifying its session ID and API name ; use the default org:
631+
632+
$ sf agent preview end --session-id <SESSION_ID> --api-name My_Published_Agent
633+
634+
Similar to previous example, but don't specify a session ID; you get an error if the published agent has more than
635+
one active session. Use the org with alias "my-dev-org":
636+
637+
$ sf agent preview end --api-name My_Published_Agent --target-org my-dev-org
638+
639+
End a preview session of an agent using its authoring bundle API name; you get an error if the agent has more than
640+
one active session.
641+
642+
$ sf agent preview end --authoring-bundle My_Local_Agent
643+
```
644+
645+
_See code: [src/commands/agent/preview/end.ts](https://github.com/salesforcecli/plugin-agent/blob/1.28.0/src/commands/agent/preview/end.ts)_
646+
647+
## `sf agent preview send`
648+
649+
Send a message to an existing agent preview session.
650+
651+
```
652+
USAGE
653+
$ sf agent preview send -o <value> -u <value> [--json] [--flags-dir <value>] [--api-version <value>] [--session-id
654+
<value>] [-n <value>] [--authoring-bundle <value>]
655+
656+
FLAGS
657+
-n, --api-name=<value> API name of the activated published agent you want to preview.
658+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
659+
configuration variable is already set.
660+
-u, --utterance=<value> (required) Utterance to send to the agent, enclosed in double quotes.
661+
--api-version=<value> Override the api version used for api requests made by this command
662+
--authoring-bundle=<value> API name of the authoring bundle metadata component that contains the agent's Agent
663+
Script file.
664+
--session-id=<value> Session ID outputted by "agent preview start". Not required when the agent has exactly
665+
one active session. Run "agent preview sessions" to see list of all sessions.
666+
667+
GLOBAL FLAGS
668+
--flags-dir=<value> Import flag values from a directory.
669+
--json Format output as json.
670+
671+
DESCRIPTION
672+
Send a message to an existing agent preview session.
673+
674+
You must have previously started a programmatic agent preview session with the "agent preview start" command to then
675+
use this command to send the agent a message (utterance). This command then displays the agent's response.
676+
677+
The original "agent preview start" command outputs a session ID which you then use with the --session-id flag of this
678+
command to send a message. You don't have to specify the --session-id flag if an agent has only one active preview
679+
session. You must also use either the --authoring-bundle or --api-name flag to specify the API name of the authoring
680+
bundle or the published agent, respecitvely. To find either API name, navigate to your package directory in your DX
681+
project. The API name of an authoring bundle is the same as its directory name under the "aiAuthoringBundles" metadata
682+
directory. Similarly, the published agent's API name is the same as its directory name under the "Bots" metadata
683+
directory.
684+
685+
EXAMPLES
686+
Send a message to an activated published agent using its API name and session ID; use the default org:
687+
688+
$ sf agent preview send --utterance "What can you help me with?" --api-name My_Published_Agent --session-id \
689+
<SESSION_ID>
690+
691+
Similar to previous example, but don't specify a session ID; you get an error if the agent has more than one active
692+
session. Use the org with alias "my-dev-org":
693+
694+
$ sf agent preview send --utterance "What can you help me with?" --api-name My_Published_Agent --target-org \
695+
my-dev-org
696+
697+
Send a message to an agent using its authoring bundle API name; you get an error if the agent has more than one
698+
active session:
699+
700+
$ sf agent preview send --utterance "what can you help me with?" --authoring-bundle My_Local_Agent
701+
```
702+
703+
_See code: [src/commands/agent/preview/send.ts](https://github.com/salesforcecli/plugin-agent/blob/1.28.0/src/commands/agent/preview/send.ts)_
704+
705+
## `sf agent preview sessions`
706+
707+
List all known programmatic agent preview sessions.
708+
709+
```
710+
USAGE
711+
$ sf agent preview sessions [--json] [--flags-dir <value>]
712+
713+
GLOBAL FLAGS
714+
--flags-dir=<value> Import flag values from a directory.
715+
--json Format output as json.
716+
717+
DESCRIPTION
718+
List all known programmatic agent preview sessions.
719+
720+
This command lists the agent preview sessions that were started with the "agent preview start" command and are still
721+
in the local cache. Use this command to discover specific session IDs that you can pass to the "agent preview send" or
722+
"agent preview end" commands with the --session-id flag.
723+
724+
Programmatic agent preview sessions can be started for both published activated agents and by using an agent's local
725+
authoring bundle, which contains its Agent Script file. In this command's output table, the Agent column contains
726+
either the API name of the authoring bundle or the published agent, whichever was used when starting the session. In
727+
the table, if the same API name has multiple rows with different session IDs, then it means that you previously
728+
started multiple preview sessions with the associated agent.
729+
730+
EXAMPLES
731+
List all cached agent preview sessions:
732+
733+
$ sf agent preview sessions
734+
```
735+
736+
_See code: [src/commands/agent/preview/sessions.ts](https://github.com/salesforcecli/plugin-agent/blob/1.28.0/src/commands/agent/preview/sessions.ts)_
737+
738+
## `sf agent preview start`
739+
740+
Start a programmatic agent preview session.
741+
742+
```
743+
USAGE
744+
$ sf agent preview start -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-n <value>]
745+
[--authoring-bundle <value>] [--use-live-actions]
746+
747+
FLAGS
748+
-n, --api-name=<value> API name of the activated published agent you want to preview.
749+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
750+
configuration variable is already set.
751+
--api-version=<value> Override the api version used for api requests made by this command
752+
--authoring-bundle=<value> API name of the authoring bundle metadata component that contains the agent's Agent
753+
Script file.
754+
--use-live-actions Use real actions in the org; if not specified, preview uses AI to simulate (mock)
755+
actions.
756+
757+
GLOBAL FLAGS
758+
--flags-dir=<value> Import flag values from a directory.
759+
--json Format output as json.
760+
761+
DESCRIPTION
762+
Start a programmatic agent preview session.
763+
764+
This command outputs a session ID that you then use with the "agent preview send" command to send an utterance to the
765+
agent. Use the "agent preview sessions" command to list all active sessions and the "agent preview end" command to
766+
end a specific session.
767+
768+
Identify the agent you want to start previewing with either the --authoring-bundle flag to specify a local authoring
769+
bundle's API name or --api-name to specify an activated published agent's API name. To find either API name, navigate
770+
to your package directory in your DX project. The API name of an authoring bundle is the same as its directory name
771+
under the "aiAuthoringBundles" metadata directory. Similarly, the published agent's API name is the same as its
772+
directory name under the "Bots" metadata directory.
773+
774+
When starting a preview session using the authoring bundle, which contains the agent's Agent Script file, the preview
775+
uses mocked actions by default. Specify --use-live-actions for live mode, which uses the real Apex classes, flows,
776+
etc, in the org for the actions.
777+
778+
EXAMPLES
779+
Start a programmatic agent preview session by specifying an authoring bundle; uses mocked actions by default. Use
780+
the org with alias "my-dev-org":
781+
782+
$ sf agent preview start --authoring-bundle My_Agent_Bundle --target-org my-dev-org
783+
784+
Similar to previous example but use live actions and the default org:
785+
786+
$ sf agent preview start --authoring-bundle My_Agent_Bundle --use-live-actions
787+
788+
Start a preview session with an activated published agent:
789+
790+
$ sf agent preview start --api-name My_Published_Agent
791+
```
792+
793+
_See code: [src/commands/agent/preview/start.ts](https://github.com/salesforcecli/plugin-agent/blob/1.28.0/src/commands/agent/preview/start.ts)_
587794

588795
## `sf agent publish authoring-bundle`
589796

@@ -632,7 +839,7 @@ EXAMPLES
632839
$ sf agent publish authoring-bundle --api-name MyAuthoringbundle --target-org my-dev-org
633840
```
634841

635-
_See code: [src/commands/agent/publish/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.27.7/src/commands/agent/publish/authoring-bundle.ts)_
842+
_See code: [src/commands/agent/publish/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.28.0/src/commands/agent/publish/authoring-bundle.ts)_
636843

637844
## `sf agent test create`
638845

@@ -687,7 +894,7 @@ EXAMPLES
687894
$ sf agent test create --spec specs/Resort_Manager-testSpec.yaml --api-name Resort_Manager_Test --preview
688895
```
689896

690-
_See code: [src/commands/agent/test/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.27.7/src/commands/agent/test/create.ts)_
897+
_See code: [src/commands/agent/test/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.28.0/src/commands/agent/test/create.ts)_
691898

692899
## `sf agent test list`
693900

@@ -722,7 +929,7 @@ EXAMPLES
722929
$ sf agent test list --target-org my-org
723930
```
724931

725-
_See code: [src/commands/agent/test/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.27.7/src/commands/agent/test/list.ts)_
932+
_See code: [src/commands/agent/test/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.28.0/src/commands/agent/test/list.ts)_
726933

727934
## `sf agent test results`
728935

@@ -788,7 +995,7 @@ FLAG DESCRIPTIONS
788995
expression when using custom evaluations.
789996
```
790997

791-
_See code: [src/commands/agent/test/results.ts](https://github.com/salesforcecli/plugin-agent/blob/1.27.7/src/commands/agent/test/results.ts)_
998+
_See code: [src/commands/agent/test/results.ts](https://github.com/salesforcecli/plugin-agent/blob/1.28.0/src/commands/agent/test/results.ts)_
792999

7931000
## `sf agent test resume`
7941001

@@ -861,7 +1068,7 @@ FLAG DESCRIPTIONS
8611068
expression when using custom evaluations.
8621069
```
8631070

864-
_See code: [src/commands/agent/test/resume.ts](https://github.com/salesforcecli/plugin-agent/blob/1.27.7/src/commands/agent/test/resume.ts)_
1071+
_See code: [src/commands/agent/test/resume.ts](https://github.com/salesforcecli/plugin-agent/blob/1.28.0/src/commands/agent/test/resume.ts)_
8651072

8661073
## `sf agent test run`
8671074

@@ -935,7 +1142,7 @@ FLAG DESCRIPTIONS
9351142
expression when using custom evaluations.
9361143
```
9371144

938-
_See code: [src/commands/agent/test/run.ts](https://github.com/salesforcecli/plugin-agent/blob/1.27.7/src/commands/agent/test/run.ts)_
1145+
_See code: [src/commands/agent/test/run.ts](https://github.com/salesforcecli/plugin-agent/blob/1.28.0/src/commands/agent/test/run.ts)_
9391146

9401147
## `sf agent validate authoring-bundle`
9411148

@@ -982,6 +1189,6 @@ EXAMPLES
9821189
$ sf agent validate authoring-bundle --api-name MyAuthoringBundle --target-org my-dev-org
9831190
```
9841191

985-
_See code: [src/commands/agent/validate/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.27.7/src/commands/agent/validate/authoring-bundle.ts)_
1192+
_See code: [src/commands/agent/validate/authoring-bundle.ts](https://github.com/salesforcecli/plugin-agent/blob/1.28.0/src/commands/agent/validate/authoring-bundle.ts)_
9861193

9871194
<!-- commandsstop -->

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@salesforce/plugin-agent",
33
"description": "Commands to interact with Salesforce agents",
4-
"version": "1.27.7",
4+
"version": "1.28.0",
55
"author": "Salesforce",
66
"bugs": "https://github.com/forcedotcom/cli/issues",
77
"enableO11y": true,

0 commit comments

Comments
 (0)