You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: web/src/content/help/quick-start.mdx
+5-10Lines changed: 5 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,7 @@ cd /path/to/your-repo
27
27
codebuff
28
28
```
29
29
30
-
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:`.
30
+
Codebuff has multiple [modes](/docs/tips/modes): `plan` for planning without file changes, `max` for better results at higher cost and time. You can invoke them in the slash menu with `/mode`.
31
31
32
32
## 4. Initialize Your Project (Optional)
33
33
@@ -39,18 +39,13 @@ Run the `/init` command inside Codebuff to set up project-specific files:
39
39
40
40
### What `/init` Creates
41
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. |
42
+
-`knowledge.md` — A starter file for documenting your project's setup commands, architecture, and coding conventions. Codebuff reads this to understand your project better.
43
+
-`.agents/types/` — TypeScript type definitions for creating custom agents.
46
44
47
45
### When to Use `/init`
48
46
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.
47
+
-**New projects** — if you don't already have an AGENTS.md or CLAUDE.md (Codebuff will also read these files).
48
+
-**Building custom agents** — running /init is the first step to [creating your own agents](/docs/walkthroughs/creating-your-first-agent)!
0 commit comments