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
+17-6Lines changed: 17 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,13 +39,19 @@ Before you begin, you'll need to install a few tools:
39
39
4.**Set up secrets management**:
40
40
41
41
```bash
42
+
npm install -g @infisical/cli
42
43
infisical init
43
44
infisical login
44
45
# Select "US" region when prompted
45
-
infisical secrets # Verify setup works
46
46
```
47
47
48
-
You will need to populate all the secrets in the infisical UI at https://app.infisical.com. You can provide dummy values for the secrets if you get an error about missing secrets, but you will need to update them with real values in order to use the associated feature.
48
+
Follow the [Infisical Setup Guide](./INFISICAL_SETUP_GUIDE.md) for detailed setup instructions.
49
+
50
+
Load all environment variables at once:
51
+
```bash
52
+
infisical secrets set --file .env.example
53
+
infisical secrets set DATABASE_URL=postgresql://postgres:secretpassword_local@localhost:5432/codebuff
54
+
```
49
55
50
56
5.**Configure environment**:
51
57
@@ -62,16 +68,21 @@ Before you begin, you'll need to install a few tools:
62
68
7.**Start development services** (requires 3 terminals):
63
69
64
70
```bash
65
-
# Terminal 1 - Backend server
71
+
# Terminal 1 - Backend server (start first)
66
72
bun run start-server
73
+
# Expected: 🚀 Server is running on port 4242
67
74
68
-
# Terminal 2 - Web server
75
+
# Terminal 2 - Web server (start second)
69
76
bun run start-web
77
+
# Expected: Ready on http://localhost:3000
70
78
71
-
# Terminal 3 - CLI client
79
+
# Terminal 3 - CLI client (start last)
72
80
bun run start-bin
81
+
# Expected: Welcome to Codebuff! + agent list
73
82
```
74
83
84
+
**Note**: CLI requires both backend and web server running for authentication.
85
+
75
86
## Understanding the Codebase
76
87
77
88
Codebuff is organized as a monorepo with these main packages:
@@ -173,7 +184,7 @@ Level up the web interface in `web/` with better agent management, project templ
173
184
174
185
-**direnv problems?** Make sure it's hooked into your shell, run `direnv allow`, and restart your terminal
175
186
-**Script errors?** Double-check you're using bun for all commands
176
-
-**Can't find files?** See our [local development guide](./local-development.md) for more detailed setup
187
+
-**Infisical issues?** See our [Infisical Setup Guide](./INFISICAL_SETUP_GUIDE.md) for step-by-step instructions
177
188
178
189
**Questions?** Jump into our [Discord community](https://codebuff.com/discord) - we're friendly and always happy to help!
Quick 5-step setup to get Codebuff running with Infisical secrets.
4
+
5
+
## Setup Steps
6
+
7
+
### 1. Install & Setup
8
+
```bash
9
+
npm install -g @infisical/cli
10
+
infisical init
11
+
infisical login
12
+
# Select "US" region when prompted
13
+
infisical secrets # Verify setup works
14
+
```
15
+
16
+
### 2. Browser Login
17
+
- Browser opens automatically to https://app.infisical.com
18
+
- Login with **any email** (Gmail, etc.)
19
+
- Fill in any **name** and **organization name** when asked
20
+
- Copy the token from browser and paste in terminal
21
+
22
+
### 3. Select Project
23
+
- Use arrow keys to choose your organization
24
+
- Select or create a Codebuff project
25
+
26
+
### 4. Load Environment Variables
27
+
```bash
28
+
# Load all variables at once
29
+
infisical secrets set --file .env.example
30
+
31
+
# IMPORTANT: Fix the database password separately
32
+
infisical secrets set DATABASE_URL=postgresql://postgres:secretpassword_local@localhost:5432/codebuff
33
+
```
34
+
35
+
### 5. Done! Run Codebuff
36
+
```bash
37
+
bun run start-server # Backend (port 4242)
38
+
bun run start-web # Web (port 3000)
39
+
bun run start-bin # CLI
40
+
```
41
+
42
+
## Common Issues & Quick Fixes
43
+
44
+
**Token won't paste?** → Right-click → paste
45
+
**Database error?** → Run the DATABASE_URL command above
46
+
**Can't navigate menus?** → Use arrow keys ↓ ↑
47
+
48
+
## That's It!
49
+
50
+
The `.env.example` file contains all the dummy values needed for development. Only the database password needs to be fixed to match Docker's password.
51
+
52
+
You will need to populate all the secrets in the Infisical UI at https://app.infisical.com. You can provide dummy values for the secrets if you get an error about missing secrets, but you will need to update them with real values in order to use the associated feature.
0 commit comments