Get started with Codebuff
Follow these steps to install and run Codebuff in your project.
1. Install Codebuff
Enter the following in your terminal, which could be inside your favorite IDE (VSCode, Cursor, etc.).
bash
npm install -g codebuff
2. Navigate to your project directory
bash
cd /path/to/your-repo
3. Run Codebuff
bash
codebuff
Codebuff has multiple modes: --lite for quick tasks, --max for complex work, and /mode:plan for planning without file changes.
Troubleshooting
If you run into issues during installation:
-
Permission issues — On Mac/Linux try
sudo npm install -g codebuff, on Windows run as administrator -
Still Having Problems?
- Try reinstalling Node using nvm or fnm
- Run the Codebuff install command again
If you're still experiencing issues, check out our Troubleshooting guide or join our Discord community!