Skip to content

Commit

Permalink
chore(release): 1.1.1 [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
svc-cli-bot committed Oct 30, 2024
1 parent 37f1619 commit e9cf53e
Show file tree
Hide file tree
Showing 3 changed files with 91 additions and 2 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
## [1.1.1](https://github.com/salesforcecli/plugin-agent/compare/1.1.0...1.1.1) (2024-10-30)

### Bug Fixes

- add agent create stubs ([37f1619](https://github.com/salesforcecli/plugin-agent/commit/37f1619df66d3f30c664a61982479dc8b3ab87fc))
- add agent create stubs ([223704b](https://github.com/salesforcecli/plugin-agent/commit/223704ba0a5bc8d5d6c325149ece90d392e7ef49))

# [1.1.0](https://github.com/salesforcecli/plugin-agent/compare/1.0.2...1.1.0) (2024-10-29)

### Bug Fixes
Expand Down
84 changes: 83 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,90 @@ sf plugins

<!-- commands -->

- [`sf agent create`](#sf-agent-create)
- [`sf agent create spec`](#sf-agent-create-spec)
- [`sf agent run test`](#sf-agent-run-test)

## `sf agent create`

Create an Agent from an agent spec.

```
USAGE
$ sf agent create -o <value> -f <value> -p <value> [--json] [--flags-dir <value>] [--api-version <value>]
FLAGS
-f, --spec=<value> (required) The path to an agent spec file.
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
configuration variable is already set.
-p, --planner=<value> (required) The path to an agent spec file.
--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
Create an Agent from an agent spec.
Create an Agent from an agent spec. Agent metadata is created in the target org and retrieved to the local project.
EXAMPLES
Create an Agent:
$ sf agent create --planner MyAgentPlanner --spec ./agent-spec.json
FLAG DESCRIPTIONS
-f, --spec=<value> The path to an agent spec file.
The agent spec file defines job descriptions for the agent and can be created using the `sf agent create spec`
command.
```

_See code: [src/commands/agent/create.ts](https://github.com/salesforcecli/plugin-agent/blob/1.1.1/src/commands/agent/create.ts)_

## `sf agent create spec`

Create an Agent spec.

```
USAGE
$ sf agent create spec -o <value> --agent-type customer_facing|employee_facing --role <value> --company-name <value>
--company-description <value> [--json] [--flags-dir <value>] [--api-version <value>] [--company-website <value>] [-d
<value>]
FLAGS
-d, --output-dir=<value> [default: config] The location within the project where the agent spec will be
written.
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
configuration variable is already set.
--agent-type=<option> (required) The type of agent to create.
<options: customer_facing|employee_facing>
--api-version=<value> Override the api version used for api requests made by this command
--company-description=<value> (required) The description of the company, containing details to be used when
generating agent job descriptions.
--company-name=<value> (required) The name of the company.
--company-website=<value> The website URL for the company.
--role=<value> (required) The role of the agent.
GLOBAL FLAGS
--flags-dir=<value> Import flag values from a directory.
--json Format output as json.
DESCRIPTION
Create an Agent spec.
Create an Agent spec, which is a list of job descriptions for the agent.
EXAMPLES
Create an Agent spec in the default location:
$ sf agent create spec --agent-type customer-facing --role Support --company-name "Coral Cloud" \
--company-description "A meaningful description"
```

_See code: [src/commands/agent/create/spec.ts](https://github.com/salesforcecli/plugin-agent/blob/1.1.1/src/commands/agent/create/spec.ts)_

## `sf agent run test`

Start a test for an Agent.
Expand Down Expand Up @@ -103,6 +185,6 @@ FLAG DESCRIPTIONS
If the command continues to run after the wait period, the CLI returns control of the terminal window to you.
```

_See code: [src/commands/agent/run/test.ts](https://github.com/salesforcecli/plugin-agent/blob/1.1.0/src/commands/agent/run/test.ts)_
_See code: [src/commands/agent/run/test.ts](https://github.com/salesforcecli/plugin-agent/blob/1.1.1/src/commands/agent/run/test.ts)_

<!-- commandsstop -->
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@salesforce/plugin-agent",
"description": "Commands to interact with Salesforce agents",
"version": "1.1.0",
"version": "1.1.1",
"author": "Salesforce",
"bugs": "https://github.com/forcedotcom/cli/issues",
"dependencies": {
Expand Down

0 comments on commit e9cf53e

Please sign in to comment.