Skip to content

Commit 2dd0c41

Browse files
committed
chore(release): 1.24.0 [skip ci]
1 parent 394525e commit 2dd0c41

File tree

4 files changed

+108
-15
lines changed

4 files changed

+108
-15
lines changed

CHANGELOG.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
# [1.24.0](https://github.com/salesforcecli/plugin-agent/compare/1.23.8...1.24.0) (2025-08-04)
2+
3+
### Bug Fixes
4+
5+
- add tests for activate and deactivate ([400a1e6](https://github.com/salesforcecli/plugin-agent/commit/400a1e6bd33c17befe0bf1717feeafebd26104e5))
6+
- Update agent.deactivate.md ([c4c4e5c](https://github.com/salesforcecli/plugin-agent/commit/c4c4e5c286d463ea44daaa658a9eaac01fc55146))
7+
8+
### Features
9+
10+
- adds agent activate and deactivate commands ([fbad38c](https://github.com/salesforcecli/plugin-agent/commit/fbad38c7405357f3caf786d2c6cc17af40c3a161))
11+
112
## [1.23.8](https://github.com/salesforcecli/plugin-agent/compare/1.23.7...1.23.8) (2025-08-01)
213

314
### Bug Fixes

README.md

Lines changed: 94 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,9 @@ sf plugins
5959

6060
<!-- commands -->
6161

62+
- [`sf agent activate`](#sf-agent-activate)
6263
- [`sf agent create`](#sf-agent-create)
64+
- [`sf agent deactivate`](#sf-agent-deactivate)
6365
- [`sf agent generate agent-spec`](#sf-agent-generate-agent-spec)
6466
- [`sf agent generate template`](#sf-agent-generate-template)
6567
- [`sf agent generate test-spec`](#sf-agent-generate-test-spec)
@@ -70,6 +72,45 @@ sf plugins
7072
- [`sf agent test resume`](#sf-agent-test-resume)
7173
- [`sf agent test run`](#sf-agent-test-run)
7274

75+
## `sf agent activate`
76+
77+
Activate an agent in an org.
78+
79+
```
80+
USAGE
81+
$ sf agent activate -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-n <value>]
82+
83+
FLAGS
84+
-n, --api-name=<value> API name of the agent to activate.
85+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
86+
configuration variable is already set.
87+
--api-version=<value> Override the api version used for api requests made by this command
88+
89+
GLOBAL FLAGS
90+
--flags-dir=<value> Import flag values from a directory.
91+
--json Format output as json.
92+
93+
DESCRIPTION
94+
Activate an agent in an org.
95+
96+
Activating an agent makes it immediately available to your users. An agent must be active before you can preview it
97+
with the "agent preview" CLI command or VS Code.
98+
99+
You must know the agent's API name to activate it; you can either be prompted for it or you can specify it with the
100+
--api-name flag. Find the agent's API name in its Agent Details page of your org's Agentforce Studio UI in Setup.
101+
102+
EXAMPLES
103+
Activate an agent in your default target org by being prompted:
104+
105+
$ sf agent activate
106+
107+
Activate an agent with API name Resort_Manager in the org with alias "my-org":
108+
109+
$ sf agent activate --api-name Resort_Manager --target-org my-org
110+
```
111+
112+
_See code: [src/commands/agent/activate.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.0/src/commands/agent/activate.ts)_
113+
73114
## `sf agent create`
74115

75116
Create an agent in your org using a local agent spec file.
@@ -130,7 +171,47 @@ EXAMPLES
130171
$ sf agent create --name "Resort Manager" --spec specs/resortManagerAgent.yaml --preview
131172
```
132173

133-
_See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.23.8/src/commands/agent/create.ts)_
174+
_See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.0/src/commands/agent/create.ts)_
175+
176+
## `sf agent deactivate`
177+
178+
Deactivate an agent in an org.
179+
180+
```
181+
USAGE
182+
$ sf agent deactivate -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-n <value>]
183+
184+
FLAGS
185+
-n, --api-name=<value> API name of the agent to deactivate.
186+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
187+
configuration variable is already set.
188+
--api-version=<value> Override the api version used for api requests made by this command
189+
190+
GLOBAL FLAGS
191+
--flags-dir=<value> Import flag values from a directory.
192+
--json Format output as json.
193+
194+
DESCRIPTION
195+
Deactivate an agent in an org.
196+
197+
Deactivating an agent makes it unavailable to your users. To make changes to an agent, such as adding or removing
198+
topics or actions, you must deactivate it. You can't preview an agent with the "agent preview" CLI command or VS Code
199+
if it's deactivated.
200+
201+
You must know the agent's API name to deactivate it; you can either be prompted for it or you can specify it with the
202+
--api-name flag. Find the agent's API name in its Agent Details page of your org's Agentforce Studio UI in Setup.
203+
204+
EXAMPLES
205+
Deactivate an agent in your default target org by being prompted:
206+
207+
$ sf agent deactivate
208+
209+
Deactivate the agent Resort_Manager in the org with alias "my_org":
210+
211+
$ sf agent deactivate --api-name Resort_Manager --target-org my-org
212+
```
213+
214+
_See code: [src/commands/agent/deactivate.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.0/src/commands/agent/deactivate.ts)_
134215

135216
## `sf agent generate agent-spec`
136217

@@ -235,7 +316,7 @@ EXAMPLES
235316
$ sf agent generate agent-spec --tone formal --agent-user resortmanager@myorg.com
236317
```
237318

238-
_See code: [src/commands/agent/generate/agent-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.23.8/src/commands/agent/generate/agent-spec.ts)_
319+
_See code: [src/commands/agent/generate/agent-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.0/src/commands/agent/generate/agent-spec.ts)_
239320

240321
## `sf agent generate template`
241322

@@ -283,7 +364,7 @@ EXAMPLES
283364
force-app/main/default/bots/My_Awesome_Agent/My_Awesome_Agent.bot-meta.xml --agent-version 1
284365
```
285366

286-
_See code: [src/commands/agent/generate/template.ts](https://github.com/salesforcecli/plugin-agent/blob/1.23.8/src/commands/agent/generate/template.ts)_
367+
_See code: [src/commands/agent/generate/template.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.0/src/commands/agent/generate/template.ts)_
287368

288369
## `sf agent generate test-spec`
289370

@@ -341,7 +422,7 @@ EXAMPLES
341422
force-app//main/default/aiEvaluationDefinitions/Resort_Manager_Tests.aiEvaluationDefinition-meta.xml
342423
```
343424

344-
_See code: [src/commands/agent/generate/test-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.23.8/src/commands/agent/generate/test-spec.ts)_
425+
_See code: [src/commands/agent/generate/test-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.0/src/commands/agent/generate/test-spec.ts)_
345426

346427
## `sf agent preview`
347428

@@ -384,15 +465,16 @@ DESCRIPTION
384465
environment variable "SF_AGENT_PREVIEW_OUTPUT_DIR" to the directory. Or you can pass the directory to the --output-dir
385466
flag.
386467
387-
Find the agent's API name in its main details page in your org's Agent page in Setup.
468+
Find the agent's API name in its Agent Details page of your org's Agentforce Studio UI in Setup. If your agent is
469+
currently deactivated, use the "agent activate" CLI command to activate it.
388470
389471
IMPORTANT: Before you use this command, you must complete a number of configuration steps in your org and your DX
390472
project. The examples in this help assume you've completed the steps. See "Preview an Agent" in the "Agentforce
391473
Developer Guide" for complete documentation:
392474
https://developer.salesforce.com/docs/einstein/genai/guide/agent-dx-preview.html.
393475
394476
EXAMPLES
395-
Interact with an agent with API name "Resort_Manager" in the org with alias "my-org" and the linked "agent-app"
477+
Interact with an agent with API name Resort_Manager in the org with alias "my-org" and the linked "agent-app"
396478
connected app:
397479
398480
$ sf agent preview --api-name Resort_Manager --target-org my-org --client-app agent-app
@@ -404,7 +486,7 @@ EXAMPLES
404486
transcripts/my-preview
405487
```
406488

407-
_See code: [src/commands/agent/preview.ts](https://github.com/salesforcecli/plugin-agent/blob/1.23.8/src/commands/agent/preview.ts)_
489+
_See code: [src/commands/agent/preview.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.0/src/commands/agent/preview.ts)_
408490

409491
## `sf agent test create`
410492

@@ -459,7 +541,7 @@ EXAMPLES
459541
$ sf agent test create --spec specs/Resort_Manager-testSpec.yaml --api-name Resort_Manager_Test --preview
460542
```
461543

462-
_See code: [src/commands/agent/test/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.23.8/src/commands/agent/test/create.ts)_
544+
_See code: [src/commands/agent/test/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.0/src/commands/agent/test/create.ts)_
463545

464546
## `sf agent test list`
465547

@@ -494,7 +576,7 @@ EXAMPLES
494576
$ sf agent test list --target-org my-org
495577
```
496578

497-
_See code: [src/commands/agent/test/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.23.8/src/commands/agent/test/list.ts)_
579+
_See code: [src/commands/agent/test/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.0/src/commands/agent/test/list.ts)_
498580

499581
## `sf agent test results`
500582

@@ -550,7 +632,7 @@ FLAG DESCRIPTIONS
550632
test results aren't written.
551633
```
552634

553-
_See code: [src/commands/agent/test/results.ts](https://github.com/salesforcecli/plugin-agent/blob/1.23.8/src/commands/agent/test/results.ts)_
635+
_See code: [src/commands/agent/test/results.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.0/src/commands/agent/test/results.ts)_
554636

555637
## `sf agent test resume`
556638

@@ -613,7 +695,7 @@ FLAG DESCRIPTIONS
613695
test results aren't written.
614696
```
615697

616-
_See code: [src/commands/agent/test/resume.ts](https://github.com/salesforcecli/plugin-agent/blob/1.23.8/src/commands/agent/test/resume.ts)_
698+
_See code: [src/commands/agent/test/resume.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.0/src/commands/agent/test/resume.ts)_
617699

618700
## `sf agent test run`
619701

@@ -677,6 +759,6 @@ FLAG DESCRIPTIONS
677759
test results aren't written.
678760
```
679761

680-
_See code: [src/commands/agent/test/run.ts](https://github.com/salesforcecli/plugin-agent/blob/1.23.8/src/commands/agent/test/run.ts)_
762+
_See code: [src/commands/agent/test/run.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.0/src/commands/agent/test/run.ts)_
681763

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

yarn.lock

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1290,7 +1290,7 @@
12901290
"@jridgewell/resolve-uri" "^3.1.0"
12911291
"@jridgewell/sourcemap-codec" "^1.4.14"
12921292

1293-
"@jsforce/jsforce-node@^3.10.0":
1293+
"@jsforce/jsforce-node@^3.9.1":
12941294
version "3.10.0"
12951295
resolved "https://registry.yarnpkg.com/@jsforce/jsforce-node/-/jsforce-node-3.10.0.tgz#1bf75e9d322434f99fc38a3b60738205051144c5"
12961296
integrity sha512-hNExEqzvJ/ixnsfZlrYh/FqEOYfn4vKmeBMqIdrEjeYciIsSaOeggghFl+1w0m2u7TNGr1+8jPUBvki3nebPSw==
@@ -1578,7 +1578,7 @@
15781578
resolved "https://registry.yarnpkg.com/@salesforce/prettier-config/-/prettier-config-0.0.3.tgz#ba648d4886bb38adabe073dbea0b3a91b3753bb0"
15791579
integrity sha512-hYOhoPTCSYMDYn+U1rlEk16PoBeAJPkrdg4/UtAzupM1mRRJOwEPMG1d7U8DxJFKuXW3DMEYWr2MwAIBDaHmFg==
15801580

1581-
"@salesforce/schemas@^1.9.1":
1581+
"@salesforce/schemas@^1.9.0":
15821582
version "1.9.1"
15831583
resolved "https://registry.yarnpkg.com/@salesforce/schemas/-/schemas-1.9.1.tgz#ea843c732068c4ac2dadbe1d22b44e714cfe661d"
15841584
integrity sha512-9I8kZBYT7HFXsbz2ukkSyZDRPjSsfRyx3pKGCsjWe2av8wuNm6tYUnmuXzMH5JoVSu3MvtOeIlwp5fFURdsNjg==

0 commit comments

Comments
 (0)