Skip to content

Commit 89a023f

Browse files
committed
docs: simplify dev setup with bun run dev, rename start-bin to start-cli
1 parent 3123110 commit 89a023f

File tree

2 files changed

+15
-14
lines changed

2 files changed

+15
-14
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -76,19 +76,22 @@ Before you begin, you'll need to install a few tools:
7676
infisical secrets set CODEBUFF_GITHUB_SECRET=<your-github-app-secret-here>
7777
```
7878

79-
8. **Start development services** (requires 3 terminals):
79+
8. **Start development services**:
8080

81+
**Option A: All-in-one (recommended)**
8182
```bash
82-
# Terminal 1 - Backend server (start first)
83-
bun run start-server
84-
# Expected: 🚀 Server is running on port 4242
83+
bun run dev
84+
# Starts the web server, builds the SDK, and launches the CLI automatically
85+
```
8586

86-
# Terminal 2 - Web server (start second)
87+
**Option B: Separate terminals (for more control)**
88+
```bash
89+
# Terminal 1 - Web server (start first)
8790
bun run start-web
8891
# Expected: Ready on http://localhost:3000
8992

90-
# Terminal 3 - CLI client (start last)
91-
bun run start-bin
93+
# Terminal 2 - CLI client (requires web server to be running first)
94+
bun run start-cli
9295
# Expected: Welcome to Codebuff! + agent list
9396
```
9497

@@ -121,27 +124,27 @@ In order to run the CLI from other directories, you need to first publish the ag
121124
- Run:
122125

123126
```bash
124-
bun run start-bin publish base
127+
bun run start-cli publish base
125128
```
126129

127130
- It will give you an error along the lines of `Invalid agent ID: [some agent ID]`, e.g. `Invalid agent ID: context-pruner`. You need to publish that agent at the same time, e.g.:
128131

129132
```bash
130-
bun run start-bin publish base context-pruner
133+
bun run start-cli publish base context-pruner
131134
```
132135

133136
- Repeat this until there are no more errors.
134137

135138
- As of the time of writing, the command required is:
136139

137140
```bash
138-
bun start-bin publish base context-pruner file-explorer file-picker researcher thinker reviewer
141+
bun start-cli publish base context-pruner file-explorer file-picker researcher thinker reviewer
139142
```
140143

141144
- Now, you can start the CLI in any directory by running:
142145

143146
```bash
144-
bun run start-bin --cwd [some/other/directory]
147+
bun run start-cli --cwd [some/other/directory]
145148
```
146149

147150
## Understanding the Codebase

INFISICAL_SETUP_GUIDE.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,7 @@ infisical secrets set DATABASE_URL=postgresql://manicode_user_local:secretpasswo
3434

3535
### 5. Done! Run Codebuff
3636
```bash
37-
bun run start-server # Backend (port 4242)
38-
bun run start-web # Web (port 3000)
39-
bun run start-bin # CLI
37+
bun run dev # Starts everything automatically
4038
```
4139

4240
## Common Issues & Quick Fixes

0 commit comments

Comments
 (0)