Skip to content

Commit ac73f66

Browse files
committed
docs: fix /init command references (was init-agents)
- Update README.md, overview.mdx, creating-your-first-agent.mdx to use /init - Add comprehensive /init documentation to quick-start.mdx - Document what files /init creates and when to use it
1 parent 813de55 commit ac73f66

File tree

4 files changed

+54
-15
lines changed

4 files changed

+54
-15
lines changed

README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -76,23 +76,26 @@ Run `codebuff --help` for full details and examples.
7676

7777
## Create custom agents
7878

79-
To get started building your own agents, run:
79+
To get started building your own agents, start Codebuff and run the `/init` command:
8080

8181
```bash
82-
codebuff init-agents
82+
codebuff
8383
```
8484

85-
> 💡 **Tip**: This creates an agent development guide at `.agents/README.md` with examples and TypeScript types.
85+
Then inside the CLI:
86+
87+
```
88+
/init
89+
```
8690

8791
This creates:
8892
```
93+
knowledge.md # Project context for Codebuff
8994
.agents/
90-
├── README.md # Agent development guide
91-
├── my-custom-agent.ts # Working agent template
92-
├── package.json # NPM package config
93-
├── LICENSE # Apache-2.0 license
94-
├── examples/ # 3 example agents
95-
└── types/ # TypeScript definitions
95+
└── types/ # TypeScript type definitions
96+
├── agent-definition.ts
97+
├── tools.ts
98+
└── util-types.ts
9699
```
97100

98101
You can write agent definition files that give you maximum control over agent behavior.

web/src/content/agents/overview.mdx

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,16 @@ Agents coordinate through the `spawnerPrompt` field, which tells others when to
7979

8080
## Quick Start
8181

82+
Start Codebuff and run the `/init` command to set up your project:
83+
8284
```bash
83-
codebuff init-agents
85+
codebuff
86+
```
87+
88+
Then inside the CLI:
89+
90+
```
91+
/init
8492
```
8593

8694
1. **[Customize existing agents](/docs/agents#customizing-agents)** - Modify prompts and tools

web/src/content/help/quick-start.mdx

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,29 @@ codebuff
2929

3030
Codebuff has multiple [modes](/docs/tips#modes): `lite` for quick tasks, `max` for complex work, and `plan` for planning without file changes. You can invoke them in the slash menu with `/mode:`.
3131

32+
## 4. Initialize Your Project (Optional)
33+
34+
Run the `/init` command inside Codebuff to set up project-specific files:
35+
36+
```
37+
/init
38+
```
39+
40+
### What `/init` Creates
41+
42+
| File/Directory | Purpose |
43+
|---------------|----------|
44+
| `knowledge.md` | A starter file for documenting your project's setup commands, architecture, and coding conventions. Codebuff reads this to understand your project better. |
45+
| `.agents/types/` | TypeScript type definitions for creating custom agents. |
46+
47+
### When to Use `/init`
48+
49+
- **New projects** — Run `/init` once to create a `knowledge.md` file and get Codebuff familiar with your project.
50+
- **Building custom agents** — The `.agents/types/` directory provides TypeScript types for full IntelliSense when creating agents.
51+
- **Team onboarding** — Commit `knowledge.md` to your repo so Codebuff works consistently for all team members.
52+
53+
> **Note:** `/init` is safe to run multiple times. It skips files that already exist and only creates missing ones.
54+
3255
## Troubleshooting
3356

3457
If you run into issues during installation:

web/src/content/walkthroughs/creating-your-first-agent.mdx

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,17 +40,22 @@ order: 1
4040
npm install -g codebuff
4141
```
4242

43-
In your project:
43+
In your project, start Codebuff and run the `/init` command:
4444

4545
```bash
46-
codebuff init-agents
46+
codebuff
47+
```
48+
49+
Then inside the CLI:
50+
51+
```
52+
/init
4753
```
4854

4955
This creates:
5056

51-
- `.agents/types/` - type definitions
52-
- `.agents/examples/` - example agents
53-
- `.agents/my-custom-agent.ts` - starter template
57+
- `knowledge.md` - project context for Codebuff
58+
- `.agents/types/` - TypeScript type definitions for creating agents
5459

5560
## Create an Agent
5661

0 commit comments

Comments
 (0)