Skip to content

Commit 468918a

Browse files
authored
docs: add agent development guide reference to README (#333)
1 parent 9d6c5f9 commit 468918a

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,19 @@ To get started building your own agents, run:
8383
codebuff init-agents
8484
```
8585

86+
> 💡 **Tip**: This command creates a comprehensive agent development guide at `.agents/README.md` (293 lines) with detailed documentation, complete examples, and full TypeScript type definitions. Start there for complete guidance.
87+
88+
This creates:
89+
```
90+
.agents/
91+
├── README.md # Comprehensive 293-line agent guide
92+
├── my-custom-agent.ts # Working agent template to edit
93+
├── package.json # NPM package configuration
94+
├── LICENSE # Apache-2.0 license for publishing
95+
├── examples/ # 3 example agents (basic → advanced)
96+
└── types/ # Complete TypeScript definitions
97+
```
98+
8699
You can write agent definition files that give you maximum control over agent behavior.
87100

88101
Implement your workflows by specifying tools, which agents can be spawned, and prompts. We even have TypeScript generators for more programmatic control.

0 commit comments

Comments
 (0)