Skip to content

Commit 2494d02

Browse files
committed
Tweaks for readme, delete local-development.md, since we have CONTRIBUTING.md now
1 parent 8cefe7f commit 2494d02

File tree

3 files changed

+28
-128
lines changed

3 files changed

+28
-128
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,43 +22,49 @@ Before you begin, you'll need to install a few tools:
2222
### Setting Up Your Development Environment
2323

2424
1. **Hook direnv into your shell** (one-time setup):
25+
2526
- For zsh: `echo 'eval "$(direnv hook zsh)"' >> ~/.zshrc && source ~/.zshrc`
2627
- For bash: `echo 'eval "$(direnv hook bash)"' >> ~/.bashrc && source ~/.bashrc`
2728
- For fish: `echo 'direnv hook fish | source' >> ~/.config/fish/config.fish && source ~/.config/fish/config.fish`
2829

2930
2. **Restart your shell**: Run `exec $SHELL` or restart your terminal
3031

3132
3. **Clone the repository**:
33+
3234
```bash
3335
git clone https://github.com/CodebuffAI/codebuff.git
3436
cd codebuff
3537
```
3638

3739
4. **Set up secrets management**:
40+
3841
```bash
3942
infisical login
4043
# Select "US" region when prompted
4144
infisical secrets # Verify setup works
4245
```
4346

4447
5. **Configure environment**:
48+
4549
```bash
4650
direnv allow
4751
```
4852

4953
6. **Install dependencies**:
54+
5055
```bash
5156
bun install
5257
```
5358

5459
7. **Start development services** (requires 3 terminals):
60+
5561
```bash
5662
# Terminal 1 - Backend server
5763
bun run start-server
58-
64+
5965
# Terminal 2 - Web server
6066
bun run start-web
61-
67+
6268
# Terminal 3 - CLI client
6369
bun run start-bin
6470
```
@@ -98,7 +104,7 @@ Here's how we like to work together:
98104
4. **Type check** - Run `bun run typecheck` to catch any TypeScript issues
99105
5. **Submit a PR** - Open a pull request with a clear description of what you built and why
100106

101-
*Pro tip: Small, focused PRs are easier to review and merge quickly!*
107+
_Pro tip: Small, focused PRs are easier to review and merge quickly!_
102108

103109
### Code Style Guidelines
104110

@@ -139,23 +145,29 @@ test: add unit tests for file operations
139145
There are tons of ways to make Codebuff better! Here are some areas where your skills could really shine:
140146

141147
### 🤖 **Agent Development**
148+
142149
Build specialized agents in `.agents/` for different languages, frameworks, or workflows. Think React experts, Python debuggers, or Git wizards!
143150

144-
### 🔧 **Tool System**
151+
### 🔧 **Tool System**
152+
145153
Add new capabilities in `backend/src/tools.ts` - file operations, API integrations, development environment helpers. The sky's the limit!
146154

147155
### 📦 **SDK Improvements**
156+
148157
Make the SDK in `sdk/` even more powerful with new methods, better TypeScript support, or killer integration examples.
149158

150159
### 💻 **CLI Magic**
160+
151161
Enhance the user experience in `npm-app/` with smoother commands, better error messages, or interactive features that make developers smile.
152162

153163
### 🌐 **Web Dashboard**
164+
154165
Level up the web interface in `web/` with better agent management, project templates, analytics, or any UX improvements you can dream up.
155166

156167
## Getting Help
157168

158169
**Setup issues?**
170+
159171
- **direnv problems?** Make sure it's hooked into your shell, run `direnv allow`, and restart your terminal
160172
- **Script errors?** Double-check you're using bun for all commands
161173
- **Can't find files?** See our [local development guide](./local-development.md) for more detailed setup
@@ -164,7 +176,6 @@ Level up the web interface in `web/` with better agent management, project templ
164176

165177
## Resources
166178

167-
- **Detailed setup guide**: [local-development.md](./local-development.md)
168179
- **Documentation**: [codebuff.com/docs](https://codebuff.com/docs)
169180
- **Community Discord**: [codebuff.com/discord](https://codebuff.com/discord)
170-
- **Report issues**: [GitHub Issues](https://github.com/CodebuffAI/codebuff/issues)
181+
- **Report issues**: [GitHub Issues](https://github.com/CodebuffAI/codebuff/issues)

README.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,23 @@
11
# Codebuff
22

3-
**Open-source AI coding assistant** that edits your codebase through natural language instructions. Instead of using one model for everything, it coordinates specialized agents that work together to understand your project and make precise changes.
3+
Codebuff is an **open-source AI coding assistant** that edits your codebase through natural language instructions. Instead of using one model for everything, it coordinates specialized agents that work together to understand your project and make precise changes.
44

55
<div align="center">
66
<img src="./assets/codebuff-vs-claude-code.png" alt="Codebuff vs Claude Code" width="400">
77
</div>
88

99
Codebuff beats Claude Code at 61% vs 53% on [our evals](evals/README.md) across 175+ coding tasks over multiple open-source repos that simulate real-world tasks.
1010

11-
> **🎆 Built by the community, for the community** - Join us in making AI coding assistance better for everyone!
12-
1311
![Codebuff Demo](./assets/demo.gif)
1412

1513
## How it works
1614

1715
When you ask Codebuff to "add authentication to my API," it might invoke:
1816

19-
1. A **File Explorer Agent** scans your codebase to understand the architecture and find relevant files
20-
2. An **Planner Agent** plans which files need changes and in what order
21-
3. An **Implementation Agents** make precise edits
22-
4. A **Review Agents** validate changes
17+
1. A **File Explorer Agent** to scan your codebase to understand the architecture and find relevant files
18+
2. A **Planner Agent** to plan which files need changes and in what order
19+
3. An **Editor Agent** to make precise edits
20+
4. A **Reviewer Agent** to validate changes
2321

2422
<div align="center">
2523
<img src="./assets/multi-agents.png" alt="Codebuff Multi-Agents" width="250">
@@ -88,6 +86,7 @@ export default {
8886
## SDK: Run agents in production
8987

9088
Install the [SDK package](https://www.npmjs.com/package/@codebuff/sdk) -- note this is different than the CLI codebuff package.
89+
9190
```bash
9291
npm install @codebuff/sdk
9392
```
@@ -145,13 +144,14 @@ Learn more about the SDK [here](https://www.npmjs.com/package/@codebuff/sdk).
145144

146145
## Contributing to Codebuff
147146

148-
🚀 **Codebuff is open source!** We love contributions from the community - whether you're fixing bugs, building new agents, or improving documentation.
147+
We ❤️ contributions from the community - whether you're fixing bugs, tweaking our agents, or improving documentation.
149148

150149
**Want to contribute?** Check out our [Contributing Guide](./CONTRIBUTING.md) to get started.
151150

152151
Some ways you can help:
152+
153153
- 🐛 **Fix bugs** or add features
154-
- 🤖 **Create specialized agents** for different languages/frameworks
154+
- 🤖 **Create specialized agents** and publish them to the Agent Store
155155
- 📚 **Improve documentation** or write tutorials
156156
- 💡 **Share ideas** in our [GitHub Issues](https://github.com/CodebuffAI/codebuff/issues)
157157

@@ -165,14 +165,12 @@ Some ways you can help:
165165

166166
### Resources
167167

168-
**Contributing**: [CONTRIBUTING.md](./CONTRIBUTING.md) - Start here to contribute!
169-
170-
**Local Development**: [local-development.md](./local-development.md) - Detailed setup guide
171-
172168
**Documentation**: [codebuff.com/docs](https://codebuff.com/docs)
173169

174170
**Community**: [Discord](https://codebuff.com/discord) - Join our friendly community
175171

176172
**Issues & Ideas**: [GitHub Issues](https://github.com/CodebuffAI/codebuff/issues)
177173

174+
**Contributing**: [CONTRIBUTING.md](./CONTRIBUTING.md) - Start here to contribute!
175+
178176
**Support**: [support@codebuff.com](mailto:support@codebuff.com)

local-development.md

Lines changed: 0 additions & 109 deletions
This file was deleted.

0 commit comments

Comments
 (0)