Skip to content

Commit 48500a6

Browse files
committed
chore(release): 1.8.0 [skip ci]
1 parent f742205 commit 48500a6

File tree

3 files changed

+82
-10
lines changed

3 files changed

+82
-10
lines changed

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
# [1.8.0](https://github.com/salesforcecli/plugin-agent/compare/1.7.2...1.8.0) (2025-01-16)
2+
3+
### Features
4+
5+
- add ability to create a spec from a spec ([4805a2f](https://github.com/salesforcecli/plugin-agent/commit/4805a2f66acb2984375d863276b05f91a51f8709))
6+
- add generate spec v2 command and tests ([3d5261b](https://github.com/salesforcecli/plugin-agent/commit/3d5261bffca3386e742ab8127f766cfc5c5adf88))
7+
18
## [1.7.2](https://github.com/salesforcecli/plugin-agent/compare/1.7.2-dev.1...1.7.2) (2024-12-18)
29

310
### Bug Fixes

README.md

Lines changed: 74 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ sf plugins
6464
- [`sf agent create`](#sf-agent-create)
6565
- [`sf agent generate definition`](#sf-agent-generate-definition)
6666
- [`sf agent generate spec`](#sf-agent-generate-spec)
67+
- [`sf agent generate spec-v2`](#sf-agent-generate-spec-v2)
6768
- [`sf agent generate testset`](#sf-agent-generate-testset)
6869
- [`sf agent preview`](#sf-agent-preview)
6970
- [`sf agent test cancel`](#sf-agent-test-cancel)
@@ -111,7 +112,7 @@ EXAMPLES
111112
$ sf agent create --name CustomerSupportAgent --spec ./config/agentSpec.json --target-org my-org
112113
```
113114

114-
_See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.7.2/src/commands/agent/create.ts)_
115+
_See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.8.0/src/commands/agent/create.ts)_
115116

116117
## `sf agent generate definition`
117118

@@ -136,7 +137,7 @@ EXAMPLES
136137
$ sf agent generate definition
137138
```
138139

139-
_See code: [src/commands/agent/generate/definition.ts](https://github.com/salesforcecli/plugin-agent/blob/1.7.2/src/commands/agent/generate/definition.ts)_
140+
_See code: [src/commands/agent/generate/definition.ts](https://github.com/salesforcecli/plugin-agent/blob/1.8.0/src/commands/agent/generate/definition.ts)_
140141

141142
## `sf agent generate spec`
142143

@@ -197,7 +198,71 @@ EXAMPLES
197198
$ sf agent generate spec --output-dir specs --target-org my-org
198199
```
199200

200-
_See code: [src/commands/agent/generate/spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.7.2/src/commands/agent/generate/spec.ts)_
201+
_See code: [src/commands/agent/generate/spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.8.0/src/commands/agent/generate/spec.ts)_
202+
203+
## `sf agent generate spec-v2`
204+
205+
Generate an agent spec, which is the list of jobs that the agent performs.
206+
207+
```
208+
USAGE
209+
$ sf agent generate spec-v2 -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-t customer|internal]
210+
[--role <value>] [--company-name <value>] [--company-description <value>] [--company-website <value>] [--spec
211+
<value>] [--output-file <value>] [--max-topics <value>] [--grounding-context <value> --prompt-template <value>]
212+
213+
FLAGS
214+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
215+
configuration variable is already set.
216+
-t, --type=<option> Type of agent to create.
217+
<options: customer|internal>
218+
--api-version=<value> Override the api version used for api requests made by this command
219+
--company-description=<value> Description of your company.
220+
--company-name=<value> Name of your company.
221+
--company-website=<value> Website URL of your company.
222+
--grounding-context=<value> Context information to be used with the customized prompt template.
223+
--max-topics=<value> Maximum number of agent job topics to generate in the spec; default is 10.
224+
--output-file=<value> [default: config/agentSpec.yaml] Path for the generated agent spec file (yaml); can
225+
be an absolute or relative path.
226+
--prompt-template=<value> Developer name of a customized prompt template to use instead of the default.
227+
--role=<value> Role of the agent.
228+
--spec=<value> Spec file (yaml) to use as input to the command.
229+
230+
GLOBAL FLAGS
231+
--flags-dir=<value> Import flag values from a directory.
232+
--json Format output as json.
233+
234+
DESCRIPTION
235+
Generate an agent spec, which is the list of jobs that the agent performs.
236+
237+
When using Salesforce CLI to create an agent in your org, you can choose to generate a YAML-formatted agent spec file
238+
with this command as a first step.
239+
240+
An agent spec is a list of jobs and descriptions that capture what the agent can do. Use flags such as --role and
241+
--company-description to provide details about your company and the role that the agent plays in your company; you can
242+
also enter the information interactively if you prefer. When you then execute this command, the large language model
243+
(LLM) associated with your org uses the information to generate the list of jobs that the agent most likely performs.
244+
We recommend that you provide good details for --role, --company-description, etc, so that the LLM can generate the
245+
best and most relevant list of jobs and descriptions. Once generated, you can edit the spec file; for example, you can
246+
remove jobs that don't apply to your agent.
247+
248+
When your agent spec is ready, you then create the agent in your org by specifying the agent spec file to the
249+
--job-spec flag of the "agent create" CLI command.
250+
251+
EXAMPLES
252+
Create an agent spec for your default org in the default location and use flags to specify the agent's role and your
253+
company details:
254+
255+
$ sf agent generate spec-v2 --type customer --role "Assist users in navigating and managing bookings" \
256+
--company-name "Coral Cloud" --company-description "Resort that manages guests and their reservations and \
257+
experiences"
258+
259+
Create an agent spec by being prompted for role and company details interactively; write the generated file to the
260+
"specs" directory and use the org with alias "my-org":
261+
262+
$ sf agent generate spec-v2 --output-dir specs --target-org my-org
263+
```
264+
265+
_See code: [src/commands/agent/generate/spec-v2.ts](https://github.com/salesforcecli/plugin-agent/blob/1.8.0/src/commands/agent/generate/spec-v2.ts)_
201266

202267
## `sf agent generate testset`
203268

@@ -220,7 +285,7 @@ EXAMPLES
220285
$ sf agent generate testset
221286
```
222287

223-
_See code: [src/commands/agent/generate/testset.ts](https://github.com/salesforcecli/plugin-agent/blob/1.7.2/src/commands/agent/generate/testset.ts)_
288+
_See code: [src/commands/agent/generate/testset.ts](https://github.com/salesforcecli/plugin-agent/blob/1.8.0/src/commands/agent/generate/testset.ts)_
224289

225290
## `sf agent preview`
226291

@@ -255,7 +320,7 @@ FLAG DESCRIPTIONS
255320
the API name of the agent? (TBD based on agents library)
256321
```
257322

258-
_See code: [src/commands/agent/preview.ts](https://github.com/salesforcecli/plugin-agent/blob/1.7.2/src/commands/agent/preview.ts)_
323+
_See code: [src/commands/agent/preview.ts](https://github.com/salesforcecli/plugin-agent/blob/1.8.0/src/commands/agent/preview.ts)_
259324

260325
## `sf agent test cancel`
261326

@@ -292,7 +357,7 @@ EXAMPLES
292357
$ sf agent test cancel --job-id 4KBfake0000003F4AQ --target-org my-org
293358
```
294359

295-
_See code: [src/commands/agent/test/cancel.ts](https://github.com/salesforcecli/plugin-agent/blob/1.7.2/src/commands/agent/test/cancel.ts)_
360+
_See code: [src/commands/agent/test/cancel.ts](https://github.com/salesforcecli/plugin-agent/blob/1.8.0/src/commands/agent/test/cancel.ts)_
296361

297362
## `sf agent test results`
298363

@@ -348,7 +413,7 @@ FLAG DESCRIPTIONS
348413
test results aren't written.
349414
```
350415

351-
_See code: [src/commands/agent/test/results.ts](https://github.com/salesforcecli/plugin-agent/blob/1.7.2/src/commands/agent/test/results.ts)_
416+
_See code: [src/commands/agent/test/results.ts](https://github.com/salesforcecli/plugin-agent/blob/1.8.0/src/commands/agent/test/results.ts)_
352417

353418
## `sf agent test resume`
354419

@@ -411,7 +476,7 @@ FLAG DESCRIPTIONS
411476
test results aren't written.
412477
```
413478

414-
_See code: [src/commands/agent/test/resume.ts](https://github.com/salesforcecli/plugin-agent/blob/1.7.2/src/commands/agent/test/resume.ts)_
479+
_See code: [src/commands/agent/test/resume.ts](https://github.com/salesforcecli/plugin-agent/blob/1.8.0/src/commands/agent/test/resume.ts)_
415480

416481
## `sf agent test run`
417482

@@ -474,6 +539,6 @@ FLAG DESCRIPTIONS
474539
test results aren't written.
475540
```
476541

477-
_See code: [src/commands/agent/test/run.ts](https://github.com/salesforcecli/plugin-agent/blob/1.7.2/src/commands/agent/test/run.ts)_
542+
_See code: [src/commands/agent/test/run.ts](https://github.com/salesforcecli/plugin-agent/blob/1.8.0/src/commands/agent/test/run.ts)_
478543

479544
<!-- 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.7.2",
4+
"version": "1.8.0",
55
"author": "Salesforce",
66
"bugs": "https://github.com/forcedotcom/cli/issues",
77
"dependencies": {

0 commit comments

Comments
 (0)