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-20Lines changed: 5 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,34 +27,19 @@ cd /path/to/your-repo
27
27
codebuff
28
28
```
29
29
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`.
30
+
Check out the[modes](/docs/tips/modes)for using Codebuff, such as Free, Max, or Plan.
31
31
32
32
## 4. Initialize Your Project (Optional)
33
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
-
-`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.
44
-
45
-
### When to Use `/init`
34
+
Run the `/init` command inside Codebuff to set up project-specific files. Useful for:
46
35
47
36
-**New projects** — if you don't already have an AGENTS.md or CLAUDE.md (Codebuff will also read these files).
48
37
-**Building custom agents** — running /init is the first step to [creating your own agents](/docs/walkthroughs/creating-your-first-agent)!
49
38
50
39
## Troubleshooting
51
40
52
-
If you run into issues during installation:
53
-
54
-
1.**Permission issues** — The best fix is to install Node.js using [nvm](https://github.com/nvm-sh/nvm) or [fnm](https://github.com/Schniz/fnm), which avoids permission problems entirely. Then run `npm install -g codebuff` again.
41
+
- Make sure you have [node installed](https://nodejs.org/en/download) (which includes npm).
55
42
56
-
2.**Still Having Problems?**
57
-
- On Mac/Linux, you can fix permissions with: `sudo chown -R $(whoami) $(npm config get prefix)/{lib/node_modules,bin,share}`
58
-
- On Windows, run your terminal as administrator
43
+
- Try deleting the downloaded binary at `~/.config/manicode/codebuff` and restarting codebuff.
0 commit comments