Skip to content

Commit 9f4dd40

Browse files
Clarify authoring bundle validation command documentation
Updated the documentation for the authoring bundle validation command to clarify usage and improve readability.
1 parent 8a83fdf commit 9f4dd40

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

messages/agent.validate.authoring-bundle.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,23 @@ Validate an authoring bundle to ensure its Agent Script file compiles successful
66

77
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.
88

9-
This command validates that the Agent Script file in the authoring bundle compiles without errors so that you can later publish the bundle to your org. Use this command while you vibe code (modify with natural language) the Agent Script file to ensure that it's always valid. If the validation fails, the command outputs the list of syntax errors, a brief description of the error, and the location in the Agent Script file where the error occurred.
9+
This command validates that the Agent Script file in the authoring bundle compiles without errors so that you can later publish the bundle to your org. Use this command while you code the Agent Script file to ensure that it's valid. If the validation fails, the command outputs the list of syntax errors, a brief description of the error, and the location in the Agent Script file where the error occurred.
1010

1111
This command uses the API name of the authoring bundle. If you don't provide an API name with the --api-name flag, the command searches the current DX project and outputs a list of authoring bundles that it found for you to choose from.
1212

1313
# examples
1414

15-
- Validate an authoring bundle with API name MyAuthoringBundle:
15+
- Validate an authoring bundle by being prompted for its API name; use your default org:
1616

17-
<%= config.bin %> <%= command.id %> --api-name MyAuthoringBundle
17+
<%= config.bin %> <%= command.id %>
18+
19+
- Validate an authoring bundle with API name MyAuthoringBundle; use the org with alias "my-dev-org":
20+
21+
<%= config.bin %> <%= command.id %> --api-name MyAuthoringBundle --target-org my-dev-org
1822

1923
# flags.api-name.summary
2024

21-
API name of the authoring bundle you want to validate.
25+
API name of the authoring bundle you want to validate; if not specified, the command provides a list that you can choose from.
2226

2327
# flags.api-name.prompt
2428

0 commit comments

Comments
 (0)