Skip to content

Commit e890203

Browse files
fix: edit messages for NGA commands
Updated metadata descriptions and command usage examples for clarity.
1 parent 3c49abf commit e890203

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

messages/agent.generate.authoring-bundle.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,23 @@ Authoring bundles are metadata components that contain an agent's Agent Script f
88

99
Use this command to generate a new authoring bundle based on an agent spec YAML file, which you create with the "agent generate agent-spec" command. The agent spec YAML file is a high-level description of the agent; it describes its essence rather than exactly what it can do.
1010

11-
The metadata type for authoring bundles is aiAuthoringBundle, which consist of a standard "<bundle-name>.bundle-meta.xml" metadata file and the Agent Script file (with extension ".agent"). When you run this command, the new authoring bundle is generated in the force-app/main/default/aiAuthoringBundles/<bundle-name> directory. Use the --output-dir flag to generate them elsewhere.
11+
The metadata type for authoring bundles is aiAuthoringBundle, which consist of a standard "<bundle-api-name>.bundle-meta.xml" metadata file and the Agent Script file (with extension ".agent"). When you run this command, the new authoring bundle is generated in the force-app/main/default/aiAuthoringBundles/<bundle-api-name> directory. Use the --output-dir flag to generate them elsewhere.
1212

13-
After you generate the initial authoring bundle, vibe code (modify using natural language) the Agent Script file so your agent behaves exactly as you want. The generated Agent Script file is just a first draft of your agent! Then publish the agent to your org with the "agent publish authoring-bundle" command.
13+
After you generate the initial authoring bundle, code the Agent Script file so your agent behaves exactly as you want. The Agent Script file generated by this command is just a first draft of your agent! Interactively test the agent by conversing with it using the "agent preview" command. Then publish the agent to your org with the "agent publish authoring-bundle" command.
1414

1515
This command requires an org because it uses it to access an LLM for generating the Agent Script file.
1616

1717
# flags.spec.summary
1818

19-
Path to the agent spec YAML file.
19+
Path to the agent spec YAML file; if not specified, the command provides a list that you can choose from.
2020

2121
# flags.output-dir.summary
2222

2323
Directory where the authoring bundle files are generated.
2424

2525
# flags.name.summary
2626

27-
Name (label) of the authoring bundle.
27+
Name (label) of the authoring bundle; if not specified, you're prompted for the name.
2828

2929
# flags.api-name.summary
3030

@@ -36,11 +36,15 @@ API name of the new authoring bundle
3636

3737
# examples
3838

39+
- Generate an authoring bundle by being prompted for all required values, such as the agent spec YAML file, the bundle name, and the API name; use your default org:
40+
41+
<%= config.bin %> <%= command.id %>
42+
3943
- Generate an authoring bundle from the "specs/agentSpec.yaml" agent spec YAML file and give it the label "My Authoring Bundle"; use your default org:
4044

4145
<%= config.bin %> <%= command.id %> --spec specs/agentSpec.yaml --name "My Authoring Bundle"
4246

43-
- Same as previous example, but generate the files in the "other-package-dir/main/default" package directory; use the org with alias "my-dev-org":
47+
- Similar to previous example, but generate the authoring bundle files in the "other-package-dir/main/default" package directory; use the org with alias "my-dev-org":
4448

4549
<%= config.bin %> <%= command.id %> --spec specs/agentSpec.yaml --name "My Authoring Bundle" --output-dir other-package-dir/main/default --target-org my-dev-org
4650

0 commit comments

Comments
 (0)