@salesforce/plugin-agent 1.23.8 → 1.24.1

package/README.md

@@ -59,7 +59,9 @@ sf plugins
 
 <!-- commands -->
 
+- [`sf agent activate`](#sf-agent-activate)
 - [`sf agent create`](#sf-agent-create)
+- [`sf agent deactivate`](#sf-agent-deactivate)
 - [`sf agent generate agent-spec`](#sf-agent-generate-agent-spec)
 - [`sf agent generate template`](#sf-agent-generate-template)
 - [`sf agent generate test-spec`](#sf-agent-generate-test-spec)
@@ -70,6 +72,45 @@ sf plugins
 - [`sf agent test resume`](#sf-agent-test-resume)
 - [`sf agent test run`](#sf-agent-test-run)
 
+## `sf agent activate`
+
+Activate an agent in an org.
+
+```
+USAGE
+  $ sf agent activate -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-n <value>]
+
+FLAGS
+  -n, --api-name=<value>     API name of the agent to activate.
+  -o, --target-org=<value>   (required) Username or alias of the target org. Not required if the `target-org`
+                             configuration variable is already set.
+      --api-version=<value>  Override the api version used for api requests made by this command
+
+GLOBAL FLAGS
+  --flags-dir=<value>  Import flag values from a directory.
+  --json               Format output as json.
+
+DESCRIPTION
+  Activate an agent in an org.
+
+  Activating an agent makes it immediately available to your users. An agent must be active before you can preview it
+  with the "agent preview" CLI command or VS Code.
+
+  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
+  --api-name flag. Find the agent's API name in its Agent Details page of your org's Agentforce Studio UI in Setup.
+
+EXAMPLES
+  Activate an agent in your default target org by being prompted:
+
+    $ sf agent activate
+
+  Activate an agent with API name Resort_Manager in the org with alias "my-org":
+
+    $ sf agent activate --api-name Resort_Manager --target-org my-org
+```
+
+_See code: [src/commands/agent/activate.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.1/src/commands/agent/activate.ts)_
+
 ## `sf agent create`
 
 Create an agent in your org using a local agent spec file.
@@ -130,7 +171,47 @@ EXAMPLES
     $ sf agent create --name "Resort Manager" --spec specs/resortManagerAgent.yaml --preview
 ```
 
-_See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.23.8/src/commands/agent/create.ts)_
+_See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.1/src/commands/agent/create.ts)_
+
+## `sf agent deactivate`
+
+Deactivate an agent in an org.
+
+```
+USAGE
+  $ sf agent deactivate -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-n <value>]
+
+FLAGS
+  -n, --api-name=<value>     API name of the agent to deactivate.
+  -o, --target-org=<value>   (required) Username or alias of the target org. Not required if the `target-org`
+                             configuration variable is already set.
+      --api-version=<value>  Override the api version used for api requests made by this command
+
+GLOBAL FLAGS
+  --flags-dir=<value>  Import flag values from a directory.
+  --json               Format output as json.
+
+DESCRIPTION
+  Deactivate an agent in an org.
+
+  Deactivating an agent makes it unavailable to your users. To make changes to an agent, such as adding or removing
+  topics or actions, you must deactivate it. You can't preview an agent with the "agent preview" CLI command or VS Code
+  if it's deactivated.
+
+  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
+  --api-name flag. Find the agent's API name in its Agent Details page of your org's Agentforce Studio UI in Setup.
+
+EXAMPLES
+  Deactivate an agent in your default target org by being prompted:
+
+    $ sf agent deactivate
+
+  Deactivate the agent Resort_Manager in the org with alias "my_org":
+
+    $ sf agent deactivate --api-name Resort_Manager --target-org my-org
+```
+
+_See code: [src/commands/agent/deactivate.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.1/src/commands/agent/deactivate.ts)_
 
 ## `sf agent generate agent-spec`
 
@@ -235,7 +316,7 @@ EXAMPLES
     $ sf agent generate agent-spec --tone formal --agent-user resortmanager@myorg.com
 ```
 
-_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)_
+_See code: [src/commands/agent/generate/agent-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.1/src/commands/agent/generate/agent-spec.ts)_
 
 ## `sf agent generate template`
 
@@ -283,7 +364,7 @@ EXAMPLES
       force-app/main/default/bots/My_Awesome_Agent/My_Awesome_Agent.bot-meta.xml --agent-version 1
 ```
 
-_See code: [src/commands/agent/generate/template.ts](https://github.com/salesforcecli/plugin-agent/blob/1.23.8/src/commands/agent/generate/template.ts)_
+_See code: [src/commands/agent/generate/template.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.1/src/commands/agent/generate/template.ts)_
 
 ## `sf agent generate test-spec`
 
@@ -318,6 +399,9 @@ DESCRIPTION
   - Expected topic: API name of the topic you expect the agent to use when responding to the utterance.
   - Expected actions: One or more API names of the expection actions the agent takes.
   - Expected outcome: Natural language description of the outcome you expect.
+  - (Optional) Custom evaluation: Test an agent's response for specific strings or numbers.
+  - (Optional) Conversation history: Boilerplate for additional context you can add to the test in the form of a
+  conversation history.
 
   When your test spec is ready, you then run the "agent test create" command to actually create the test in your org and
   synchronize the metadata with your DX project. The metadata type for an agent test is AiEvaluationDefinition.
@@ -341,7 +425,7 @@ EXAMPLES
       force-app//main/default/aiEvaluationDefinitions/Resort_Manager_Tests.aiEvaluationDefinition-meta.xml
 ```
 
-_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)_
+_See code: [src/commands/agent/generate/test-spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.1/src/commands/agent/generate/test-spec.ts)_
 
 ## `sf agent preview`
 
@@ -384,7 +468,8 @@ DESCRIPTION
   environment variable "SF_AGENT_PREVIEW_OUTPUT_DIR" to the directory. Or you can pass the directory to the --output-dir
   flag.
 
-  Find the agent's API name in its main details page in your org's Agent page in Setup.
+  Find the agent's API name in its Agent Details page of your org's Agentforce Studio UI in Setup. If your agent is
+  currently deactivated, use the "agent activate" CLI command to activate it.
 
   IMPORTANT: Before you use this command, you must complete a number of configuration steps in your org and your DX
   project. The examples in this help assume you've completed the steps. See "Preview an Agent" in the "Agentforce
@@ -392,7 +477,7 @@ DESCRIPTION
   https://developer.salesforce.com/docs/einstein/genai/guide/agent-dx-preview.html.
 
 EXAMPLES
-  Interact with an agent with API name "Resort_Manager" in the org with alias "my-org" and the linked "agent-app"
+  Interact with an agent with API name Resort_Manager in the org with alias "my-org" and the linked "agent-app"
   connected app:
 
     $ sf agent preview --api-name Resort_Manager --target-org my-org --client-app agent-app
@@ -404,7 +489,7 @@ EXAMPLES
       transcripts/my-preview
 ```
 
-_See code: [src/commands/agent/preview.ts](https://github.com/salesforcecli/plugin-agent/blob/1.23.8/src/commands/agent/preview.ts)_
+_See code: [src/commands/agent/preview.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.1/src/commands/agent/preview.ts)_
 
 ## `sf agent test create`
 
@@ -459,7 +544,7 @@ EXAMPLES
     $ sf agent test create --spec specs/Resort_Manager-testSpec.yaml --api-name Resort_Manager_Test --preview
 ```
 
-_See code: [src/commands/agent/test/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.23.8/src/commands/agent/test/create.ts)_
+_See code: [src/commands/agent/test/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.1/src/commands/agent/test/create.ts)_
 
 ## `sf agent test list`
 
@@ -494,7 +579,7 @@ EXAMPLES
     $ sf agent test list --target-org my-org
 ```
 
-_See code: [src/commands/agent/test/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.23.8/src/commands/agent/test/list.ts)_
+_See code: [src/commands/agent/test/list.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.1/src/commands/agent/test/list.ts)_
 
 ## `sf agent test results`
 
@@ -550,7 +635,7 @@ FLAG DESCRIPTIONS
     test results aren't written.
 ```
 
-_See code: [src/commands/agent/test/results.ts](https://github.com/salesforcecli/plugin-agent/blob/1.23.8/src/commands/agent/test/results.ts)_
+_See code: [src/commands/agent/test/results.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.1/src/commands/agent/test/results.ts)_
 
 ## `sf agent test resume`
 
@@ -613,7 +698,7 @@ FLAG DESCRIPTIONS
     test results aren't written.
 ```
 
-_See code: [src/commands/agent/test/resume.ts](https://github.com/salesforcecli/plugin-agent/blob/1.23.8/src/commands/agent/test/resume.ts)_
+_See code: [src/commands/agent/test/resume.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.1/src/commands/agent/test/resume.ts)_
 
 ## `sf agent test run`
 
@@ -677,6 +762,6 @@ FLAG DESCRIPTIONS
     test results aren't written.
 ```
 
-_See code: [src/commands/agent/test/run.ts](https://github.com/salesforcecli/plugin-agent/blob/1.23.8/src/commands/agent/test/run.ts)_
+_See code: [src/commands/agent/test/run.ts](https://github.com/salesforcecli/plugin-agent/blob/1.24.1/src/commands/agent/test/run.ts)_
 
 <!-- commandsstop -->

package/lib/agentActivation.d.ts

@@ -0,0 +1,22 @@
+import { Connection, Org } from '@salesforce/core';
+import { Agent, type BotMetadata } from '@salesforce/agents';
+type Choice<Value> = {
+    value: Value;
+    name?: string;
+    disabled?: boolean | string;
+};
+type AgentValue = {
+    Id: string;
+    DeveloperName: string;
+};
+export declare const UNSUPPORTED_AGENTS: string[];
+export declare const agentIsUnsupported: (devName: string) => boolean;
+export declare const validateAgent: (agent: BotMetadata) => boolean;
+export declare const getAgentChoices: (agents: BotMetadata[], status: "Active" | "Inactive") => Array<Choice<AgentValue>>;
+export declare const getAgentForActivation: (config: {
+    conn: Connection;
+    targetOrg: Org;
+    status: "Active" | "Inactive";
+    apiNameFlag?: string;
+}) => Promise<Agent>;
+export {};

package/lib/agentActivation.js

@@ -0,0 +1,74 @@
+/*
+ * Copyright (c) 2024, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import { Messages, SfError } from '@salesforce/core';
+import { Agent } from '@salesforce/agents';
+import { select } from '@inquirer/prompts';
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
+const messages = Messages.loadMessages('@salesforce/plugin-agent', 'agent.activation');
+export const UNSUPPORTED_AGENTS = ['Copilot_for_Salesforce'];
+export const agentIsUnsupported = (devName) => UNSUPPORTED_AGENTS.includes(devName);
+export const validateAgent = (agent) => {
+    if (agent.IsDeleted) {
+        throw messages.createError('error.agentIsDeleted', [agent.DeveloperName]);
+    }
+    if (agentIsUnsupported(agent.DeveloperName)) {
+        throw messages.createError('error.agentIsDefault', [agent.DeveloperName]);
+    }
+    return true;
+};
+export const getAgentChoices = (agents, status) => agents.map((agent) => {
+    let disabled = false;
+    const lastBotVersion = agent.BotVersions.records[agent.BotVersions.records.length - 1];
+    if (lastBotVersion.Status === status) {
+        disabled = `(Already ${status})`;
+    }
+    if (agentIsUnsupported(agent.DeveloperName)) {
+        disabled = '(Not Supported)';
+    }
+    return {
+        name: agent.DeveloperName,
+        value: {
+            Id: agent.Id,
+            DeveloperName: agent.DeveloperName,
+        },
+        disabled,
+    };
+});
+export const getAgentForActivation = async (config) => {
+    const { conn, targetOrg, status, apiNameFlag } = config;
+    let agentsInOrg = [];
+    try {
+        agentsInOrg = await Agent.listRemote(conn);
+    }
+    catch (error) {
+        throw SfError.create({
+            message: 'Error listing agents in org',
+            name: 'NoAgentsInOrgError',
+            cause: error,
+        });
+    }
+    if (!agentsInOrg.length) {
+        throw messages.createError('error.noAgentsInOrg', [targetOrg.getUsername()]);
+    }
+    let selectedAgent;
+    if (apiNameFlag) {
+        selectedAgent = agentsInOrg.find((agent) => agent.DeveloperName === apiNameFlag);
+        if (!selectedAgent) {
+            throw messages.createError('error.missingAgentInOrg', [apiNameFlag, targetOrg.getUsername()]);
+        }
+        validateAgent(selectedAgent);
+    }
+    else {
+        const agentChoice = await select({
+            message: 'Select an agent',
+            choices: getAgentChoices(agentsInOrg, status),
+        });
+        selectedAgent = agentsInOrg.find((agent) => agent.DeveloperName === agentChoice.DeveloperName);
+    }
+    return new Agent({ connection: conn, nameOrId: selectedAgent.Id });
+};
+//# sourceMappingURL=agentActivation.js.map

package/lib/agentActivation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"agentActivation.js","sourceRoot":"","sources":["../src/agentActivation.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAc,QAAQ,EAAO,OAAO,EAAE,MAAM,kBAAkB,CAAC;AACtE,OAAO,EAAE,KAAK,EAAoB,MAAM,oBAAoB,CAAC;AAC7D,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAY3C,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,0BAA0B,EAAE,kBAAkB,CAAC,CAAC;AAEvF,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,wBAAwB,CAAC,CAAC;AAC7D,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,OAAe,EAAW,EAAE,CAAC,kBAAkB,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AAErG,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,KAAkB,EAAW,EAAE;IAC3D,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;QACpB,MAAM,QAAQ,CAAC,WAAW,CAAC,sBAAsB,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;IAC5E,CAAC;IACD,IAAI,kBAAkB,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC;QAC5C,MAAM,QAAQ,CAAC,WAAW,CAAC,sBAAsB,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;IAC5E,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,MAAqB,EAAE,MAA6B,EAA6B,EAAE,CACjH,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;IACnB,IAAI,QAAQ,GAAqB,KAAK,CAAC;IAEvC,MAAM,cAAc,GAAG,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACvF,IAAI,cAAc,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;QACrC,QAAQ,GAAG,YAAY,MAAM,GAAG,CAAC;IACnC,CAAC;IACD,IAAI,kBAAkB,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC;QAC5C,QAAQ,GAAG,iBAAiB,CAAC;IAC/B,CAAC;IAED,OAAO;QACL,IAAI,EAAE,KAAK,CAAC,aAAa;QACzB,KAAK,EAAE;YACL,EAAE,EAAE,KAAK,CAAC,EAAE;YACZ,aAAa,EAAE,KAAK,CAAC,aAAa;SACnC;QACD,QAAQ;KACT,CAAC;AACJ,CAAC,CAAC,CAAC;AAEL,MAAM,CAAC,MAAM,qBAAqB,GAAG,KAAK,EAAE,MAK3C,EAAkB,EAAE;IACnB,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;IAExD,IAAI,WAAW,GAAkB,EAAE,CAAC;IACpC,IAAI,CAAC;QACH,WAAW,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,OAAO,CAAC,MAAM,CAAC;YACnB,OAAO,EAAE,6BAA6B;YACtC,IAAI,EAAE,oBAAoB;YAC1B,KAAK,EAAE,KAAK;SACb,CAAC,CAAC;IACL,CAAC;IAED,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;QACxB,MAAM,QAAQ,CAAC,WAAW,CAAC,qBAAqB,EAAE,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;IAC/E,CAAC;IAED,IAAI,aAAsC,CAAC;IAE3C,IAAI,WAAW,EAAE,CAAC;QAChB,aAAa,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,aAAa,KAAK,WAAW,CAAC,CAAC;QACjF,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,MAAM,QAAQ,CAAC,WAAW,CAAC,yBAAyB,EAAE,CAAC,WAAW,EAAE,SAAS,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QAChG,CAAC;QACD,aAAa,CAAC,aAAa,CAAC,CAAC;IAC/B,CAAC;SAAM,CAAC;QACN,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC;YAC/B,OAAO,EAAE,iBAAiB;YAC1B,OAAO,EAAE,eAAe,CAAC,WAAW,EAAE,MAAM,CAAC;SAC9C,CAAC,CAAC;QACH,aAAa,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,aAAa,KAAK,WAAW,CAAC,aAAa,CAAC,CAAC;IACjG,CAAC;IAED,OAAO,IAAI,KAAK,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,EAAE,aAAc,CAAC,EAAE,EAAE,CAAC,CAAC;AACtE,CAAC,CAAC"}

package/lib/commands/agent/activate.d.ts

@@ -0,0 +1,12 @@
+import { SfCommand } from '@salesforce/sf-plugins-core';
+export default class AgentActivate extends SfCommand<void> {
+    static readonly summary: string;
+    static readonly description: string;
+    static readonly examples: string[];
+    static readonly flags: {
+        'target-org': import("@oclif/core/interfaces").OptionFlag<import("@salesforce/core").Org, import("@oclif/core/interfaces").CustomOptions>;
+        'api-version': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'api-name': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}

package/lib/commands/agent/activate.js

@@ -0,0 +1,38 @@
+/*
+ * Copyright (c) 2024, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+import { Messages } from '@salesforce/core';
+import { getAgentForActivation } from '../../agentActivation.js';
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
+const messages = Messages.loadMessages('@salesforce/plugin-agent', 'agent.activate');
+export default class AgentActivate extends SfCommand {
+    static summary = messages.getMessage('summary');
+    static description = messages.getMessage('description');
+    static examples = messages.getMessages('examples');
+    static flags = {
+        'target-org': Flags.requiredOrg(),
+        'api-version': Flags.orgApiVersion(),
+        'api-name': Flags.string({
+            summary: messages.getMessage('flags.api-name.summary'),
+            char: 'n',
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(AgentActivate);
+        const apiNameFlag = flags['api-name'];
+        const targetOrg = flags['target-org'];
+        const conn = targetOrg.getConnection(flags['api-version']);
+        if (!apiNameFlag && this.jsonEnabled()) {
+            throw messages.createError('error.missingRequiredFlags', ['api-name']);
+        }
+        const agent = await getAgentForActivation({ conn, targetOrg, status: 'Active', apiNameFlag });
+        await agent.activate();
+        const agentName = (await agent.getBotMetadata()).DeveloperName;
+        this.log(`Agent ${agentName} activated.`);
+    }
+}
+//# sourceMappingURL=activate.js.map

package/lib/commands/agent/activate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"activate.js","sourceRoot":"","sources":["../../../src/commands/agent/activate.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AAEjE,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,0BAA0B,EAAE,gBAAgB,CAAC,CAAC;AAErF,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,SAAe;IACjD,MAAM,CAAU,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,CAAU,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAE5D,MAAM,CAAU,KAAK,GAAG;QAC7B,YAAY,EAAE,KAAK,CAAC,WAAW,EAAE;QACjC,aAAa,EAAE,KAAK,CAAC,aAAa,EAAE;QACpC,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC;YACvB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,wBAAwB,CAAC;YACtD,IAAI,EAAE,GAAG;SACV,CAAC;KACH,CAAC;IAEK,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAElD,MAAM,WAAW,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;QACtC,MAAM,SAAS,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC;QACtC,MAAM,IAAI,GAAG,SAAS,CAAC,aAAa,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;QAE3D,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACvC,MAAM,QAAQ,CAAC,WAAW,CAAC,4BAA4B,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;QACzE,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,qBAAqB,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC,CAAC;QAC9F,MAAM,KAAK,CAAC,QAAQ,EAAE,CAAC;QACvB,MAAM,SAAS,GAAG,CAAC,MAAM,KAAK,CAAC,cAAc,EAAE,CAAC,CAAC,aAAa,CAAC;QAE/D,IAAI,CAAC,GAAG,CAAC,SAAS,SAAS,aAAa,CAAC,CAAC;IAC5C,CAAC"}

package/lib/commands/agent/create.d.ts

@@ -12,8 +12,8 @@ export default class AgentCreate extends SfCommand<AgentCreateResult> {
         preview: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         'planner-id': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         name: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        spec: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         "api-name": import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        spec: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         'target-org': import("@oclif/core/interfaces").OptionFlag<import("@salesforce/core").Org, import("@oclif/core/interfaces").CustomOptions>;
         'api-version': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
     };

package/lib/commands/agent/deactivate.d.ts

@@ -0,0 +1,12 @@
+import { SfCommand } from '@salesforce/sf-plugins-core';
+export default class AgentDeactivate extends SfCommand<void> {
+    static readonly summary: string;
+    static readonly description: string;
+    static readonly examples: string[];
+    static readonly flags: {
+        'target-org': import("@oclif/core/interfaces").OptionFlag<import("@salesforce/core").Org, import("@oclif/core/interfaces").CustomOptions>;
+        'api-version': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'api-name': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}

package/lib/commands/agent/deactivate.js

@@ -0,0 +1,38 @@
+/*
+ * Copyright (c) 2024, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+import { Messages } from '@salesforce/core';
+import { getAgentForActivation } from '../../agentActivation.js';
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
+const messages = Messages.loadMessages('@salesforce/plugin-agent', 'agent.deactivate');
+export default class AgentDeactivate extends SfCommand {
+    static summary = messages.getMessage('summary');
+    static description = messages.getMessage('description');
+    static examples = messages.getMessages('examples');
+    static flags = {
+        'target-org': Flags.requiredOrg(),
+        'api-version': Flags.orgApiVersion(),
+        'api-name': Flags.string({
+            summary: messages.getMessage('flags.api-name.summary'),
+            char: 'n',
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(AgentDeactivate);
+        const apiNameFlag = flags['api-name'];
+        const targetOrg = flags['target-org'];
+        const conn = targetOrg.getConnection(flags['api-version']);
+        if (!apiNameFlag && this.jsonEnabled()) {
+            throw messages.createError('error.missingRequiredFlags', ['api-name']);
+        }
+        const agent = await getAgentForActivation({ conn, targetOrg, status: 'Inactive', apiNameFlag });
+        await agent.deactivate();
+        const agentName = (await agent.getBotMetadata()).DeveloperName;
+        this.log(`Agent ${agentName} deactivated.`);
+    }
+}
+//# sourceMappingURL=deactivate.js.map

package/lib/commands/agent/deactivate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deactivate.js","sourceRoot":"","sources":["../../../src/commands/agent/deactivate.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AAEjE,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,0BAA0B,EAAE,kBAAkB,CAAC,CAAC;AAEvF,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,SAAe;IACnD,MAAM,CAAU,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,CAAU,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAE5D,MAAM,CAAU,KAAK,GAAG;QAC7B,YAAY,EAAE,KAAK,CAAC,WAAW,EAAE;QACjC,aAAa,EAAE,KAAK,CAAC,aAAa,EAAE;QACpC,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC;YACvB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,wBAAwB,CAAC;YACtD,IAAI,EAAE,GAAG;SACV,CAAC;KACH,CAAC;IAEK,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QAEpD,MAAM,WAAW,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;QACtC,MAAM,SAAS,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC;QACtC,MAAM,IAAI,GAAG,SAAS,CAAC,aAAa,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;QAE3D,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACvC,MAAM,QAAQ,CAAC,WAAW,CAAC,4BAA4B,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;QACzE,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,qBAAqB,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,CAAC,CAAC;QAChG,MAAM,KAAK,CAAC,UAAU,EAAE,CAAC;QACzB,MAAM,SAAS,GAAG,CAAC,MAAM,KAAK,CAAC,cAAc,EAAE,CAAC,CAAC,aAAa,CAAC;QAE/D,IAAI,CAAC,GAAG,CAAC,SAAS,SAAS,eAAe,CAAC,CAAC;IAC9C,CAAC"}

package/lib/commands/agent/test/create.d.ts

@@ -14,8 +14,8 @@ export default class AgentTestCreate extends SfCommand<AgentTestCreateResult> {
         'api-version': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         preview: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         'force-overwrite': import("@oclif/core/interfaces").BooleanFlag<boolean>;
-        spec: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         "api-name": import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        spec: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
     };
     private mso?;
     run(): Promise<AgentTestCreateResult>;

package/messages/agent.activate.md

@@ -0,0 +1,27 @@
+# summary
+
+Activate an agent in an org.
+
+# description
+
+Activating an agent makes it immediately available to your users. An agent must be active before you can preview it with the "agent preview" CLI command or VS Code.
+
+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 --api-name flag. Find the agent's API name in its Agent Details page of your org's Agentforce Studio UI in Setup.
+
+# examples
+
+- Activate an agent in your default target org by being prompted:
+
+  <%= config.bin %> <%= command.id %>
+
+- Activate an agent with API name Resort_Manager in the org with alias "my-org":
+
+  <%= config.bin %> <%= command.id %> --api-name Resort_Manager --target-org my-org
+
+# flags.api-name.summary
+
+API name of the agent to activate.
+
+# error.missingRequiredFlags
+
+Missing required flags: %s.

package/messages/agent.activation.md

@@ -0,0 +1,15 @@
+# error.noAgentsInOrg
+
+No agents found in org %s.
+
+# error.missingAgentInOrg
+
+Agent %s not found in org %s.
+
+# error.agentIsDeleted
+
+Agent %s has been deleted and can't be activated.
+
+# error.agentIsDefault
+
+Agent %s is the default Agentforce agent in your org and you can't change its activation status. 

package/messages/agent.deactivate.md

@@ -0,0 +1,27 @@
+# summary
+
+Deactivate an agent in an org.
+
+# description
+
+Deactivating an agent makes it unavailable to your users. To make changes to an agent, such as adding or removing topics or actions, you must deactivate it. You can't preview an agent with the "agent preview" CLI command or VS Code if it's deactivated.
+
+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 --api-name flag. Find the agent's API name in its Agent Details page of your org's Agentforce Studio UI in Setup.
+
+# examples
+
+- Deactivate an agent in your default target org by being prompted:
+
+  <%= config.bin %> <%= command.id %>
+
+- Deactivate the agent Resort_Manager in the org with alias "my_org":
+
+  <%= config.bin %> <%= command.id %> --api-name Resort_Manager --target-org my-org
+
+# flags.api-name.summary
+
+API name of the agent to deactivate.
+
+# error.missingRequiredFlags
+
+Missing required flags: %s.

package/messages/agent.generate.test-spec.md

@@ -12,6 +12,8 @@ To generate a specific agent test case, this command prompts you for this inform
 - Expected topic: API name of the topic you expect the agent to use when responding to the utterance.
 - Expected actions: One or more API names of the expection actions the agent takes.
 - Expected outcome: Natural language description of the outcome you expect.
+- (Optional) Custom evaluation: Test an agent's response for specific strings or numbers.
+- (Optional) Conversation history: Boilerplate for additional context you can add to the test in the form of a conversation history.
 
 When your test spec is ready, you then run the "agent test create" command to actually create the test in your org and synchronize the metadata with your DX project. The metadata type for an agent test is AiEvaluationDefinition.
 

package/messages/agent.preview.md

@@ -10,7 +10,7 @@ This command is useful to test if the agent responds to your utterances as you e
 
 When the session concludes, the command asks if you want to save the API responses and chat transcripts. By default, the files are saved to the "./temp/agent-preview" directory. Specify a new default directory by setting the environment variable "SF_AGENT_PREVIEW_OUTPUT_DIR" to the directory. Or you can pass the directory to the --output-dir flag.
 
-Find the agent's API name in its main details page in your org's Agent page in Setup.
+Find the agent's API name in its Agent Details page of your org's Agentforce Studio UI in Setup. If your agent is currently deactivated, use the "agent activate" CLI command to activate it.
 
 IMPORTANT: Before you use this command, you must complete a number of configuration steps in your org and your DX project. The examples in this help assume you've completed the steps. See "Preview an Agent" in the "Agentforce Developer Guide" for complete documentation: https://developer.salesforce.com/docs/einstein/genai/guide/agent-dx-preview.html.
 
@@ -32,7 +32,7 @@ Enable Apex debug logging during the agent preview conversation.
 
 # examples
 
-- Interact with an agent with API name "Resort_Manager" in the org with alias "my-org" and the linked "agent-app" connected app:
+- Interact with an agent with API name Resort_Manager in the org with alias "my-org" and the linked "agent-app" connected app:
 
   <%= config.bin %> <%= command.id %> --api-name Resort_Manager --target-org my-org --client-app agent-app