Publish an authoring bundle to your org, which results in a new agent or a new version of an existing agent.
Description for agent publish authoring-bundle
An authoring bundle is a metadata type (named aiAuthoringBundle) that provides the blueprint for an agent. The metadata type contains two files: the standard metatada XML file and an Agent Script file (extension ".agent") that fully describes the agent using the Agent Script language.
When you publish an authoring bundle to your org, a number of things happen. First, this command validates that the Agent Script file successfully compiles. If there are compilation errors, the command exits and you must fix the Agent Script file to continue. Once the Agent Script file compiles, then it's published to the org, which in turn creates new associated metadata (Bot, BotVersion, GenAiX), or new versions of the metadata if the agent already exists. The new or updated metadata is retrieved back to your DX project; specify the --skip-retrieve flag to skip this step. Finally, the authoring bundle metadata (AiAuthoringBundle) is deployed to your org.
This command uses the API name of the authoring bundle.
Flags
| Flag Name (Long) | Flag Name (Short) | Description |
|---|---|---|
| <code>‑‑api‑name</code> | <code>‑n</code> | Type: Value<br><br>API name of the authoring bundle you want to publish; if not specified, the command provides a list that you can choose from. |
| <code>‑‑api‑version</code> | N/A | Type: Value<br><br>Override the api version used for api requests made by this command |
| <code>‑‑concise</code> | N/A | Type: Boolean<br><br>Display minimal output with only essential information about the publish operation. |
| <code>‑‑flags‑dir</code> | N/A | Type: Value<br><br>Import flag values from a directory. |
| <code>‑‑json</code> | N/A | Type: Boolean<br><br>Format output as json. |
| <code>‑‑skip‑retrieve</code> | N/A | Type: Boolean<br><br>Don't retrieve the metadata associated with the agent to your DX project. |
| <code>‑‑target‑org</code> | <code>‑o</code> | Type: Value<br>Required<br><br>Username or alias of the target org. Not required if the target-org configuration variable is already set. |
| <code>‑‑verbose</code> | <code>‑v</code> | Type: Boolean<br><br>Display detailed output showing all metadata components retrieved and deployed during the publish process. |
Examples for agent publish authoring-bundle
Publish an authoring bundle by being prompted for its API name; use your default org:
sf agent publish authoring-bundle
Publish an authoring bundle with API name MyAuthoringBundle to the org with alias "my-dev-org":
sf agent publish authoring-bundle --api-name MyAuthoringbundle --target-org my-dev-org
Publish with verbose output to see all retrieved and deployed metadata components:
sf agent publish authoring-bundle --api-name MyAuthoringbundle --verbose
Publish with concise output showing only essential information:
sf agent publish authoring-bundle --api-name MyAuthoringbundle --concise