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
Install all workspace dependencies from the repository root:
39
40
40
41
```bash
41
42
bun install
42
43
```
43
44
44
45
### 2. Build the SDK
45
46
46
-
The CLI and other packages depend on the built SDK:
47
+
The CLI and other packages depend on the compiled SDK:
47
48
48
49
```bash
49
50
bun run build:sdk
50
51
```
51
52
52
-
### 3. Run the CLI in Development Mode
53
+
### 3. Build the Freebuff Binary
54
+
55
+
Compile the standalone Freebuff distribution binary into `cli/bin/freebuff`:
56
+
57
+
```bash
58
+
bun run build:freebuff
59
+
```
60
+
61
+
### 4. Run the CLI in Development Mode
53
62
54
63
Start the terminal UI directly from source:
55
64
56
65
```bash
57
66
# Standard CLI dev mode
58
67
bun start-cli
59
68
60
-
# Or run Freebuff mode
69
+
# Or run in Freebuff mode
61
70
bun run dev:freebuff
62
71
```
63
72
64
-
### 4. Build the Freebuff Binary
65
-
66
-
Compile the standalone Freebuff distribution binary:
67
-
68
-
```bash
69
-
bun run build:freebuff
70
-
```
73
+
> **Note**: Running the interactive CLI directly from source validates client environment configuration (`.env.local` or environment variables) on startup. See the [Contributing Guide](../CONTRIBUTING.md) and root [`README.md`](../README.md) for details on backend services.
71
74
72
75
---
73
76
@@ -83,7 +86,7 @@ Run all unit tests across the repository:
83
86
bun test
84
87
```
85
88
86
-
Or run tests for a specific workspace:
89
+
Or run tests for a specific workspace or file:
87
90
88
91
```bash
89
92
# Test common utilities
@@ -92,7 +95,7 @@ bun test common/src/
92
95
# Test SDK
93
96
bun test sdk/
94
97
95
-
# Test CLI
98
+
# Test CLI unit tests
96
99
bun test cli/
97
100
```
98
101
@@ -102,13 +105,28 @@ For testing terminal rendering, bracketed paste mode, and keyboard navigation, F
102
105
103
106
---
104
107
105
-
## 📋 Code Conventions & Pre-PR Checklist
108
+
## 📋 Available Root Scripts
109
+
110
+
The following scripts are defined in root [`package.json`](../package.json):
111
+
112
+
| Script | Command | Description |
113
+
|---|---|---|
114
+
|`bun run build:sdk`|`cd sdk && bun run build`| Builds `@codebuff/sdk` (ESM, CJS, types, WASM) |
115
+
|`bun run build:freebuff`|`bun freebuff/cli/build.ts 0.0.0-dev`| Compiles the standalone Freebuff binary |
116
+
|`bun run ci`|`bun run build:sdk && bun run build:freebuff`| Validates SDK and CLI builds for CI |
117
+
|`bun start-cli` / `bun dev`|`bun --cwd cli dev`| Launches CLI in development mode |
118
+
|`bun run dev:freebuff`|`FREEBUFF_MODE=true bun --cwd cli dev`| Launches CLI in Freebuff mode |
119
+
|`bun run buffbench`|`bun --cwd evals run-buffbench`| Runs evaluation benchmarks |
120
+
|`bun test`|`bun test`| Executes the test suite |
121
+
122
+
---
123
+
124
+
## 📋 Pre-PR Checklist
106
125
107
126
Before opening a pull request, ensure the following checks pass:
108
127
109
-
1.**Build the SDK**: `bun run build:sdk`
128
+
1.**Validate Monorepo CI**: `bun run ci` (runs `build:sdk` and `build:freebuff`)
0 commit comments