@@ -9,6 +9,35 @@ order: 1
99
1010This walkthrough will guide you through creating, testing, and publishing your first custom agent. We'll build a simple code reviewer agent from scratch.
1111
12+ ## Video Walkthrough
13+
14+ <div
15+ style = { {
16+ position: ' relative' ,
17+ paddingBottom: ' 56.25%' ,
18+ height: 0 ,
19+ overflow: ' hidden' ,
20+ maxWidth: ' 100%' ,
21+ }}
22+ >
23+ <iframe
24+ src = " https://www.youtube.com/embed/mR2OOHv5p_4"
25+ title = " Creating Your First Codebuff Agent"
26+ frameBorder = " 0"
27+ allow = " accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
28+ allowFullScreen
29+ style = { {
30+ position: ' absolute' ,
31+ top: 0 ,
32+ left: 0 ,
33+ width: ' 100%' ,
34+ height: ' 100%' ,
35+ }}
36+ ></iframe >
37+ </div >
38+
39+ _ Follow along with this video or continue reading below for the step-by-step guide._
40+
1241## Step 1: Install and Initialize
1342
1443First, install Codebuff globally:
@@ -60,6 +89,7 @@ const definition: AgentDefinition = {
6089 ],
6190
6291 // Other agents this agent can spawn
92+ // Browse https://www.codebuff.com/store to see available agents
6393 spawnableAgents: [' codebuff/file-explorer@0.0.2' ],
6494
6595 // When should other agents spawn this one?
@@ -195,9 +225,10 @@ const definition: AgentDefinition = {
195225 ],
196226
197227 // Use fully qualified agent names with publisher and version
228+ // Browse https://www.codebuff.com/store to see available agents
198229 spawnableAgents: [
199- ' codebuff/file-explorer@0.0.1 ' ,
200- ' codebuff/deep-thinker@0.0.4 ' ,
230+ ' codebuff/file-explorer@0.0.4 ' ,
231+ ' codebuff/deep-thinker@0.0.3 ' ,
201232 ],
202233
203234 instructionsPrompt: ` Review code changes comprehensively:
@@ -316,6 +347,35 @@ The `handleSteps` generator function gives you **precise control** over your age
316347- **Creative tasks** that benefit from LLM flexibility
317348- **Quick prototypes** that don't need complex logic
318349
350+ ## Spawnable Agents
351+
352+ Your agents can spawn other agents to help with specific tasks. This creates powerful workflows where specialized agents collaborate.
353+
354+ ### Agent Store vs Local Agents
355+
356+ **Agent Store Agents (Use Fully Qualified IDs):**
357+
358+ When spawning agents from the [Codebuff Agent Store](https://www.codebuff.com/store), always use the full ` publisher / agent - name @version ` format:
359+
360+ ` ` ` typescript
361+ spawnableAgents : [
362+ ' codebuff/file-explorer@0.0.4' , // ✅ Correct
363+ ' john-smith/security-scanner@2.1.4' , // ✅ Correct
364+ ]
365+ ` ` `
366+
367+ **Local Agents (Use Simple IDs):**
368+
369+ When spawning agents defined in your own ` .agents ` directory, use just the agent ID:
370+
371+ ` ` ` typescript
372+ spawnableAgents : [
373+ ' my-custom-reviewer' , // ✅ Correct for local agent
374+ ' database-migrator' , // ✅ Correct for local agent
375+ ' codebuff/file-explorer@0.0.4' , // ✅ Also correct: you can mix local and published agents.
376+ ]
377+ ` ` `
378+
319379---
320380
321381🎉 **Congratulations!** You've successfully:
@@ -328,3 +388,7 @@ The `handleSteps` generator function gives you **precise control** over your age
328388- ✅ Explored advanced programmatic control with ` handleSteps `
329389
330390You're now ready to build sophisticated agents and contribute to the Codebuff ecosystem!
391+
392+ ` ` `
393+
394+ ` ` `
0 commit comments