diff --git a/CHANGELOG.md b/CHANGELOG.md index dd370e4..b39dd99 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 diff --git a/README.md b/README.md index e1c0411..2041c30 100644 --- a/README.md +++ b/README.md @@ -61,8 +61,90 @@ sf plugins +- [`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 -f -p [--json] [--flags-dir ] [--api-version ] + +FLAGS + -f, --spec= (required) The path to an agent spec file. + -o, --target-org= (required) Username or alias of the target org. Not required if the `target-org` + configuration variable is already set. + -p, --planner= (required) The path to an agent spec file. + --api-version= Override the api version used for api requests made by this command + +GLOBAL FLAGS + --flags-dir= 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= 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 --agent-type customer_facing|employee_facing --role --company-name + --company-description [--json] [--flags-dir ] [--api-version ] [--company-website ] [-d + ] + +FLAGS + -d, --output-dir= [default: config] The location within the project where the agent spec will be + written. + -o, --target-org= (required) Username or alias of the target org. Not required if the `target-org` + configuration variable is already set. + --agent-type=