cerber-core 1.1.0 → 1.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/team/README.md CHANGED
@@ -1,327 +1,327 @@
1
- # 🛡️ Cerber TEAM - Quick Start
2
-
3
- **Team collaboration layer for large codebases**
4
-
5
- Owner: Agata Ślęzak | Creator: Stefan Pitek
6
- Version: 2.0-team
7
-
8
- ---
9
-
10
- ## What is Cerber TEAM?
11
-
12
- Cerber TEAM adds module system and focus mode to help teams work on large codebases more efficiently.
13
-
14
- **Key Features:**
15
- - **📦 Module System** - Clear boundaries between components
16
- - **🎯 Focus Mode** - AI gets 500 LOC instead of 10,000 LOC (10x faster)
17
- - **🔗 Connection Contracts** - Explicit interfaces between modules
18
- - **📖 BIBLE.md** - Master project map
19
- - **✅ Validation** - Enforce module boundaries automatically
20
-
21
- ---
22
-
23
- ## Quick Start (5 minutes)
24
-
25
- ### 1. Setup
26
-
27
- ```bash
28
- # Create .cerber directory
29
- mkdir -p .cerber/modules
30
- mkdir -p .cerber/connections/contracts
31
-
32
- # Create project BIBLE
33
- cp team/templates/BIBLE_TEMPLATE.md .cerber/BIBLE.md
34
-
35
- # Edit BIBLE.md to describe your project
36
- nano .cerber/BIBLE.md
37
- ```
38
-
39
- ### 2. Create Your First Module
40
-
41
- ```bash
42
- # Create module
43
- bash team/scripts/cerber-add-module.sh my-first-module
44
-
45
- # Output:
46
- # ✅ Created .cerber/modules/my-first-module/
47
- # ✅ MODULE.md created from template
48
- # ✅ contract.json initialized
49
- # ✅ dependencies.json created
50
- # ✅ BIBLE.md updated
51
-
52
- # Edit module documentation
53
- nano .cerber/modules/my-first-module/MODULE.md
54
- ```
55
-
56
- ### 3. Use Focus Mode
57
-
58
- ```bash
59
- # Generate focus context (10x faster AI)
60
- bash team/scripts/cerber-focus.sh my-first-module
61
-
62
- # Output:
63
- # ✅ Focus context created: .cerber/FOCUS_CONTEXT.md
64
- # 📖 Context contains 500 LOC (vs 10,000 LOC for whole project)
65
- # 🤖 AI can now work 10x faster
66
-
67
- # View the context
68
- cat .cerber/FOCUS_CONTEXT.md
69
-
70
- # Share this with AI instead of entire codebase!
71
- ```
72
-
73
- ### 4. Validate
74
-
75
- ```bash
76
- # Validate module
77
- bash team/scripts/cerber-module-check.sh my-first-module
78
-
79
- # Output:
80
- # ✅ MODULE.md exists
81
- # ✅ contract.json valid
82
- # ✅ All dependencies declared
83
- # ✅ MODULE CHECK PASSED
84
-
85
- # Validate connections
86
- bash team/scripts/cerber-connections-check.sh
87
- ```
88
-
89
- ### 5. Daily Workflow
90
-
91
- ```bash
92
- # Morning dashboard
93
- bash team/scripts/cerber-team-morning.sh
94
-
95
- # Shows:
96
- # - All modules and their health
97
- # - Connection contracts status
98
- # - Recent activity
99
- # - Today's focus
100
-
101
- # Work on a module
102
- bash team/scripts/cerber-focus.sh my-module
103
- # [Share FOCUS_CONTEXT.md with AI]
104
- # [Make changes]
105
-
106
- # Validate before commit
107
- bash team/scripts/cerber-module-check.sh my-module
108
- git commit
109
- ```
110
-
111
- ---
112
-
113
- ## Scripts Reference
114
-
115
- ### cerber-add-module.sh
116
- Creates new module from template
117
-
118
- ```bash
119
- bash team/scripts/cerber-add-module.sh <module-name>
120
- ```
121
-
122
- ### cerber-focus.sh ⭐ MOST IMPORTANT
123
- Generates FOCUS_CONTEXT.md for a module (10x faster AI)
124
-
125
- ```bash
126
- bash team/scripts/cerber-focus.sh <module-name>
127
- ```
128
-
129
- ### cerber-module-check.sh
130
- Validates single module
131
-
132
- ```bash
133
- bash team/scripts/cerber-module-check.sh <module-name>
134
- ```
135
-
136
- ### cerber-connections-check.sh
137
- Validates all connection contracts
138
-
139
- ```bash
140
- bash team/scripts/cerber-connections-check.sh
141
- ```
142
-
143
- ### cerber-team-morning.sh
144
- Team morning dashboard
145
-
146
- ```bash
147
- bash team/scripts/cerber-team-morning.sh
148
- ```
149
-
150
- ---
151
-
152
- ## Module Structure
153
-
154
- Every module has:
155
-
156
- ```
157
- .cerber/modules/my-module/
158
- ├── MODULE.md # Complete documentation
159
- ├── contract.json # Public interface (versioned)
160
- └── dependencies.json # List of dependencies
161
- ```
162
-
163
- **MODULE.md** - Human-readable documentation:
164
- - Purpose and responsibilities
165
- - Public interface (functions, parameters, returns)
166
- - Dependencies and why
167
- - File structure
168
- - Testing instructions
169
-
170
- **contract.json** - Machine-readable interface:
171
- - Version (semver)
172
- - Public functions with types
173
- - Dependencies list
174
-
175
- **dependencies.json** - Explicit dependencies:
176
- - List of modules this module uses
177
- - Reason for each dependency
178
-
179
- ---
180
-
181
- ## Connection Contracts
182
-
183
- Document how modules communicate:
184
-
185
- ```json
186
- {
187
- "id": "module-a-to-module-b",
188
- "from": "module-a",
189
- "to": "module-b",
190
- "type": "function-call",
191
- "interface": {
192
- "function": "processData",
193
- "input": { "type": "ProcessParams", "fields": [...] },
194
- "output": { "type": "ProcessResult", "fields": [...] }
195
- },
196
- "version": "1.0.0",
197
- "breaking_changes": []
198
- }
199
- ```
200
-
201
- **Create contract:**
202
- ```bash
203
- cp team/templates/CONNECTION_TEMPLATE.json \
204
- .cerber/connections/contracts/module-a-to-module-b.json
205
-
206
- # Edit the contract
207
- nano .cerber/connections/contracts/module-a-to-module-b.json
208
-
209
- # Validate
210
- bash team/scripts/cerber-connections-check.sh
211
- ```
212
-
213
- ---
214
-
215
- ## BIBLE.md
216
-
217
- Master project map showing:
218
- - Architecture overview
219
- - All modules and owners
220
- - Connections between modules
221
- - Team responsibilities
222
- - Tech stack
223
-
224
- **Create BIBLE:**
225
- ```bash
226
- cp team/templates/BIBLE_TEMPLATE.md .cerber/BIBLE.md
227
- nano .cerber/BIBLE.md
228
- ```
229
-
230
- ---
231
-
232
- ## Integration with Guardian + Cerber + SOLO
233
-
234
- Cerber TEAM works alongside existing tools:
235
-
236
- ```
237
- Morning:
238
- bash team/scripts/cerber-team-morning.sh (TEAM dashboard)
239
-
240
- Development:
241
- bash team/scripts/cerber-focus.sh <module> (TEAM focus mode)
242
- git commit (Guardian validates)
243
-
244
- Pre-push:
245
- npm run cerber:pre-push (SOLO checks)
246
-
247
- Deploy:
248
- curl /api/health (Cerber 2.1 validates)
249
- ```
250
-
251
- ---
252
-
253
- ## Add to package.json
254
-
255
- ```json
256
- {
257
- "scripts": {
258
- "cerber:morning": "bash team/scripts/cerber-team-morning.sh",
259
- "cerber:focus": "bash team/scripts/cerber-focus.sh",
260
- "cerber:add-module": "bash team/scripts/cerber-add-module.sh",
261
- "cerber:check-module": "bash team/scripts/cerber-module-check.sh",
262
- "cerber:check-connections": "bash team/scripts/cerber-connections-check.sh"
263
- }
264
- }
265
- ```
266
-
267
- ---
268
-
269
- ## Example Project
270
-
271
- See `.cerber-example/` for complete working example:
272
- - BIBLE.md
273
- - CERBER_LAW.md
274
- - Two complete modules (pricing-engine, booking-calendar)
275
- - Connection contracts
276
-
277
- Study these files to understand best practices!
278
-
279
- ---
280
-
281
- ## Documentation
282
-
283
- **Full documentation:** [docs/TEAM.md](../docs/TEAM.md) (20+ KB)
284
-
285
- Topics covered:
286
- - Complete installation guide
287
- - Module system deep dive
288
- - Focus mode workflow
289
- - Connection contracts guide
290
- - Team collaboration workflows
291
- - Best practices
292
- - Troubleshooting
293
- - FAQ
294
-
295
- ---
296
-
297
- ## Benefits
298
-
299
- **Before TEAM:**
300
- - AI processes 10,000 LOC → 60 seconds
301
- - Unclear module boundaries
302
- - Hidden dependencies
303
- - Documentation drift
304
-
305
- **After TEAM:**
306
- - AI processes 500 LOC → 6 seconds (10x faster ⚡)
307
- - Clear module boundaries
308
- - Explicit dependencies
309
- - Living documentation
310
-
311
- ---
312
-
313
- ## License
314
-
315
- MIT © 2026 Stefan Pitek
316
-
317
- ---
318
-
319
- ## Support
320
-
321
- - **Documentation:** [docs/TEAM.md](../docs/TEAM.md)
322
- - **Examples:** `.cerber-example/`
323
- - **Issues:** https://github.com/Agaslez/cerber-core/issues
324
-
325
- ---
326
-
327
- **Built with ❤️ by Stefan Pitek**
1
+ # 🛡️ Cerber TEAM - Quick Start
2
+
3
+ **Team collaboration layer for large codebases**
4
+
5
+ Owner: Agata Ślęzak | Creator: Stefan Pitek
6
+ Version: 2.0-team
7
+
8
+ ---
9
+
10
+ ## What is Cerber TEAM?
11
+
12
+ Cerber TEAM adds module system and focus mode to help teams work on large codebases more efficiently.
13
+
14
+ **Key Features:**
15
+ - **📦 Module System** - Clear boundaries between components
16
+ - **🎯 Focus Mode** - AI gets 500 LOC instead of 10,000 LOC (10x faster)
17
+ - **🔗 Connection Contracts** - Explicit interfaces between modules
18
+ - **📖 CERBER.md** - Master project map
19
+ - **✅ Validation** - Enforce module boundaries automatically
20
+
21
+ ---
22
+
23
+ ## Quick Start (5 minutes)
24
+
25
+ ### 1. Setup
26
+
27
+ ```bash
28
+ # Create .cerber directory
29
+ mkdir -p .cerber/modules
30
+ mkdir -p .cerber/connections/contracts
31
+
32
+ # Create project CERBER
33
+ cp team/templates/CERBER_TEMPLATE.md .cerber/CERBER.md
34
+
35
+ # Edit CERBER.md to describe your project
36
+ nano .cerber/CERBER.md
37
+ ```
38
+
39
+ ### 2. Create Your First Module
40
+
41
+ ```bash
42
+ # Create module
43
+ bash team/scripts/cerber-add-module.sh my-first-module
44
+
45
+ # Output:
46
+ # ✅ Created .cerber/modules/my-first-module/
47
+ # ✅ MODULE.md created from template
48
+ # ✅ contract.json initialized
49
+ # ✅ dependencies.json created
50
+ # ✅ CERBER.md updated
51
+
52
+ # Edit module documentation
53
+ nano .cerber/modules/my-first-module/MODULE.md
54
+ ```
55
+
56
+ ### 3. Use Focus Mode
57
+
58
+ ```bash
59
+ # Generate focus context (10x faster AI)
60
+ bash team/scripts/cerber-focus.sh my-first-module
61
+
62
+ # Output:
63
+ # ✅ Focus context created: .cerber/FOCUS_CONTEXT.md
64
+ # 📖 Context contains 500 LOC (vs 10,000 LOC for whole project)
65
+ # 🤖 AI can now work 10x faster
66
+
67
+ # View the context
68
+ cat .cerber/FOCUS_CONTEXT.md
69
+
70
+ # Share this with AI instead of entire codebase!
71
+ ```
72
+
73
+ ### 4. Validate
74
+
75
+ ```bash
76
+ # Validate module
77
+ bash team/scripts/cerber-module-check.sh my-first-module
78
+
79
+ # Output:
80
+ # ✅ MODULE.md exists
81
+ # ✅ contract.json valid
82
+ # ✅ All dependencies declared
83
+ # ✅ MODULE CHECK PASSED
84
+
85
+ # Validate connections
86
+ bash team/scripts/cerber-connections-check.sh
87
+ ```
88
+
89
+ ### 5. Daily Workflow
90
+
91
+ ```bash
92
+ # Morning dashboard
93
+ bash team/scripts/cerber-team-morning.sh
94
+
95
+ # Shows:
96
+ # - All modules and their health
97
+ # - Connection contracts status
98
+ # - Recent activity
99
+ # - Today's focus
100
+
101
+ # Work on a module
102
+ bash team/scripts/cerber-focus.sh my-module
103
+ # [Share FOCUS_CONTEXT.md with AI]
104
+ # [Make changes]
105
+
106
+ # Validate before commit
107
+ bash team/scripts/cerber-module-check.sh my-module
108
+ git commit
109
+ ```
110
+
111
+ ---
112
+
113
+ ## Scripts Reference
114
+
115
+ ### cerber-add-module.sh
116
+ Creates new module from template
117
+
118
+ ```bash
119
+ bash team/scripts/cerber-add-module.sh <module-name>
120
+ ```
121
+
122
+ ### cerber-focus.sh ⭐ MOST IMPORTANT
123
+ Generates FOCUS_CONTEXT.md for a module (10x faster AI)
124
+
125
+ ```bash
126
+ bash team/scripts/cerber-focus.sh <module-name>
127
+ ```
128
+
129
+ ### cerber-module-check.sh
130
+ Validates single module
131
+
132
+ ```bash
133
+ bash team/scripts/cerber-module-check.sh <module-name>
134
+ ```
135
+
136
+ ### cerber-connections-check.sh
137
+ Validates all connection contracts
138
+
139
+ ```bash
140
+ bash team/scripts/cerber-connections-check.sh
141
+ ```
142
+
143
+ ### cerber-team-morning.sh
144
+ Team morning dashboard
145
+
146
+ ```bash
147
+ bash team/scripts/cerber-team-morning.sh
148
+ ```
149
+
150
+ ---
151
+
152
+ ## Module Structure
153
+
154
+ Every module has:
155
+
156
+ ```
157
+ .cerber/modules/my-module/
158
+ ├── MODULE.md # Complete documentation
159
+ ├── contract.json # Public interface (versioned)
160
+ └── dependencies.json # List of dependencies
161
+ ```
162
+
163
+ **MODULE.md** - Human-readable documentation:
164
+ - Purpose and responsibilities
165
+ - Public interface (functions, parameters, returns)
166
+ - Dependencies and why
167
+ - File structure
168
+ - Testing instructions
169
+
170
+ **contract.json** - Machine-readable interface:
171
+ - Version (semver)
172
+ - Public functions with types
173
+ - Dependencies list
174
+
175
+ **dependencies.json** - Explicit dependencies:
176
+ - List of modules this module uses
177
+ - Reason for each dependency
178
+
179
+ ---
180
+
181
+ ## Connection Contracts
182
+
183
+ Document how modules communicate:
184
+
185
+ ```json
186
+ {
187
+ "id": "module-a-to-module-b",
188
+ "from": "module-a",
189
+ "to": "module-b",
190
+ "type": "function-call",
191
+ "interface": {
192
+ "function": "processData",
193
+ "input": { "type": "ProcessParams", "fields": [...] },
194
+ "output": { "type": "ProcessResult", "fields": [...] }
195
+ },
196
+ "version": "1.0.0",
197
+ "breaking_changes": []
198
+ }
199
+ ```
200
+
201
+ **Create contract:**
202
+ ```bash
203
+ cp team/templates/CONNECTION_TEMPLATE.json \
204
+ .cerber/connections/contracts/module-a-to-module-b.json
205
+
206
+ # Edit the contract
207
+ nano .cerber/connections/contracts/module-a-to-module-b.json
208
+
209
+ # Validate
210
+ bash team/scripts/cerber-connections-check.sh
211
+ ```
212
+
213
+ ---
214
+
215
+ ## CERBER.md
216
+
217
+ Master project map showing:
218
+ - Architecture overview
219
+ - All modules and owners
220
+ - Connections between modules
221
+ - Team responsibilities
222
+ - Tech stack
223
+
224
+ **Create CERBER:**
225
+ ```bash
226
+ cp team/templates/CERBER_TEMPLATE.md .cerber/CERBER.md
227
+ nano .cerber/CERBER.md
228
+ ```
229
+
230
+ ---
231
+
232
+ ## Integration with Guardian + Cerber + SOLO
233
+
234
+ Cerber TEAM works alongside existing tools:
235
+
236
+ ```
237
+ Morning:
238
+ bash team/scripts/cerber-team-morning.sh (TEAM dashboard)
239
+
240
+ Development:
241
+ bash team/scripts/cerber-focus.sh <module> (TEAM focus mode)
242
+ git commit (Guardian validates)
243
+
244
+ Pre-push:
245
+ npm run cerber:pre-push (SOLO checks)
246
+
247
+ Deploy:
248
+ curl /api/health (Cerber 2.1 validates)
249
+ ```
250
+
251
+ ---
252
+
253
+ ## Add to package.json
254
+
255
+ ```json
256
+ {
257
+ "scripts": {
258
+ "cerber:morning": "bash team/scripts/cerber-team-morning.sh",
259
+ "cerber:focus": "bash team/scripts/cerber-focus.sh",
260
+ "cerber:add-module": "bash team/scripts/cerber-add-module.sh",
261
+ "cerber:check-module": "bash team/scripts/cerber-module-check.sh",
262
+ "cerber:check-connections": "bash team/scripts/cerber-connections-check.sh"
263
+ }
264
+ }
265
+ ```
266
+
267
+ ---
268
+
269
+ ## Example Project
270
+
271
+ See `.cerber-example/` for complete working example:
272
+ - CERBER.md
273
+ - CERBER_LAW.md
274
+ - Two complete modules (pricing-engine, booking-calendar)
275
+ - Connection contracts
276
+
277
+ Study these files to understand best practices!
278
+
279
+ ---
280
+
281
+ ## Documentation
282
+
283
+ **Full documentation:** [docs/TEAM.md](../docs/TEAM.md) (20+ KB)
284
+
285
+ Topics covered:
286
+ - Complete installation guide
287
+ - Module system deep dive
288
+ - Focus mode workflow
289
+ - Connection contracts guide
290
+ - Team collaboration workflows
291
+ - Best practices
292
+ - Troubleshooting
293
+ - FAQ
294
+
295
+ ---
296
+
297
+ ## Benefits
298
+
299
+ **Before TEAM:**
300
+ - AI processes 10,000 LOC → 60 seconds
301
+ - Unclear module boundaries
302
+ - Hidden dependencies
303
+ - Documentation drift
304
+
305
+ **After TEAM:**
306
+ - AI processes 500 LOC → 6 seconds (10x faster ⚡)
307
+ - Clear module boundaries
308
+ - Explicit dependencies
309
+ - Living documentation
310
+
311
+ ---
312
+
313
+ ## License
314
+
315
+ MIT © 2026 Stefan Pitek
316
+
317
+ ---
318
+
319
+ ## Support
320
+
321
+ - **Documentation:** [docs/TEAM.md](../docs/TEAM.md)
322
+ - **Examples:** `.cerber-example/`
323
+ - **Issues:** https://github.com/Agaslez/cerber-core/issues
324
+
325
+ ---
326
+
327
+ **Built with ❤️ by Stefan Pitek**