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: CONTRIBUTING.md
+14-11Lines changed: 14 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -76,19 +76,22 @@ Before you begin, you'll need to install a few tools:
76
76
infisical secrets set CODEBUFF_GITHUB_SECRET=<your-github-app-secret-here>
77
77
```
78
78
79
-
8.**Start development services** (requires 3 terminals):
79
+
8.**Start development services**:
80
80
81
+
**Option A: All-in-one (recommended)**
81
82
```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
+
```
85
86
86
-
# Terminal 2 - Web server (start second)
87
+
**Option B: Separate terminals (for more control)**
88
+
```bash
89
+
# Terminal 1 - Web server (start first)
87
90
bun run start-web
88
91
# Expected: Ready on http://localhost:3000
89
92
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
92
95
# Expected: Welcome to Codebuff! + agent list
93
96
```
94
97
@@ -121,27 +124,27 @@ In order to run the CLI from other directories, you need to first publish the ag
121
124
- Run:
122
125
123
126
```bash
124
-
bun run start-bin publish base
127
+
bun run start-cli publish base
125
128
```
126
129
127
130
- 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.:
128
131
129
132
```bash
130
-
bun run start-bin publish base context-pruner
133
+
bun run start-cli publish base context-pruner
131
134
```
132
135
133
136
- Repeat this until there are no more errors.
134
137
135
138
- As of the time of writing, the command required is:
136
139
137
140
```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
139
142
```
140
143
141
144
- Now, you can start the CLI in any directory by running:
0 commit comments