@@ -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
75116Create 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
394476EXAMPLES
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 -->
0 commit comments