ruvnet-kb-first 5.0.0
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/LICENSE +21 -0
- package/README.md +674 -0
- package/SKILL.md +740 -0
- package/bin/kb-first.js +123 -0
- package/install/init-project.sh +435 -0
- package/install/install-global.sh +257 -0
- package/install/kb-first-autodetect.sh +108 -0
- package/install/kb-first-command.md +80 -0
- package/install/kb-first-skill.md +262 -0
- package/package.json +87 -0
- package/phases/00-assessment.md +529 -0
- package/phases/01-storage.md +194 -0
- package/phases/01.5-hooks-setup.md +521 -0
- package/phases/02-kb-creation.md +413 -0
- package/phases/03-persistence.md +125 -0
- package/phases/04-visualization.md +170 -0
- package/phases/05-integration.md +114 -0
- package/phases/06-scaffold.md +130 -0
- package/phases/07-build.md +493 -0
- package/phases/08-verification.md +597 -0
- package/phases/09-security.md +512 -0
- package/phases/10-documentation.md +613 -0
- package/phases/11-deployment.md +670 -0
- package/phases/testing.md +713 -0
- package/scripts/1.5-hooks-verify.sh +252 -0
- package/scripts/8.1-code-scan.sh +58 -0
- package/scripts/8.2-import-check.sh +42 -0
- package/scripts/8.3-source-returns.sh +52 -0
- package/scripts/8.4-startup-verify.sh +65 -0
- package/scripts/8.5-fallback-check.sh +63 -0
- package/scripts/8.6-attribution.sh +56 -0
- package/scripts/8.7-confidence.sh +56 -0
- package/scripts/8.8-gap-logging.sh +70 -0
- package/scripts/9-security-audit.sh +202 -0
- package/scripts/init-project.sh +395 -0
- package/scripts/verify-enforcement.sh +167 -0
- package/src/commands/hooks.js +361 -0
- package/src/commands/init.js +315 -0
- package/src/commands/phase.js +372 -0
- package/src/commands/score.js +380 -0
- package/src/commands/status.js +193 -0
- package/src/commands/verify.js +286 -0
- package/src/index.js +56 -0
- package/src/mcp-server.js +412 -0
- package/templates/attention-router.ts +534 -0
- package/templates/code-analysis.ts +683 -0
- package/templates/federated-kb-learner.ts +649 -0
- package/templates/gnn-engine.ts +1091 -0
- package/templates/intentions.md +277 -0
- package/templates/kb-client.ts +905 -0
- package/templates/schema.sql +303 -0
- package/templates/sona-config.ts +312 -0
|
@@ -0,0 +1,277 @@
|
|
|
1
|
+
# Project Intentions Template
|
|
2
|
+
|
|
3
|
+
Updated: 2026-01-01 20:15:00 EST | Version 1.0.0
|
|
4
|
+
Created: 2026-01-01 20:15:00 EST
|
|
5
|
+
|
|
6
|
+
## Instructions
|
|
7
|
+
|
|
8
|
+
Fill out this template before starting a KB-First project. This ensures Claude understands your goals and can execute phases correctly.
|
|
9
|
+
|
|
10
|
+
**Save as:** `PROJECT_INTENTIONS.md` in your project root.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## 1. Project Overview
|
|
15
|
+
|
|
16
|
+
### Project Name
|
|
17
|
+
<!-- What is this project called? -->
|
|
18
|
+
|
|
19
|
+
```
|
|
20
|
+
Name:
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
### One-Liner
|
|
24
|
+
<!-- Describe in one sentence what this application does -->
|
|
25
|
+
|
|
26
|
+
```
|
|
27
|
+
Description:
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
### Problem Statement
|
|
31
|
+
<!-- What problem does this solve? Who has this problem? -->
|
|
32
|
+
|
|
33
|
+
```
|
|
34
|
+
Problem:
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Target Users
|
|
38
|
+
<!-- Who will use this application? -->
|
|
39
|
+
|
|
40
|
+
```
|
|
41
|
+
Users:
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
## 2. Intelligence Pattern
|
|
47
|
+
|
|
48
|
+
### Which pattern fits best?
|
|
49
|
+
|
|
50
|
+
Check ONE:
|
|
51
|
+
|
|
52
|
+
- [ ] **Decision Web (GNN)** — Changing one variable affects many others
|
|
53
|
+
- Examples: Retirement planning, medical diagnosis, investment portfolios
|
|
54
|
+
|
|
55
|
+
- [ ] **Combinatorial Routing (Attention)** — Route queries to different expert domains
|
|
56
|
+
- Examples: Travel optimizer, customer support, resource allocation
|
|
57
|
+
|
|
58
|
+
- [ ] **Scenario Learning (SONA)** — "What worked for people like me?" is core value
|
|
59
|
+
- Examples: Business simulator, strategy advisor, personalized coaching
|
|
60
|
+
|
|
61
|
+
- [ ] **Continuous Optimization** — Ongoing monitoring and adaptation loop
|
|
62
|
+
- Examples: SEO optimizer, trading system, adaptive marketing
|
|
63
|
+
|
|
64
|
+
- [ ] **Unsure** — Let Claude analyze and recommend
|
|
65
|
+
|
|
66
|
+
---
|
|
67
|
+
|
|
68
|
+
## 3. Knowledge Domain
|
|
69
|
+
|
|
70
|
+
### Primary Domain
|
|
71
|
+
<!-- What expertise area does this KB cover? -->
|
|
72
|
+
|
|
73
|
+
```
|
|
74
|
+
Domain:
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### Key Topics (list 5-10)
|
|
78
|
+
<!-- What specific topics must the KB include? -->
|
|
79
|
+
|
|
80
|
+
```
|
|
81
|
+
1.
|
|
82
|
+
2.
|
|
83
|
+
3.
|
|
84
|
+
4.
|
|
85
|
+
5.
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
### Known Experts (list 3-5)
|
|
89
|
+
<!-- Who are recognized experts in this domain? -->
|
|
90
|
+
|
|
91
|
+
```
|
|
92
|
+
1.
|
|
93
|
+
2.
|
|
94
|
+
3.
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
### Existing Resources
|
|
98
|
+
<!-- Do you have existing content to seed the KB? -->
|
|
99
|
+
|
|
100
|
+
- [ ] No existing content (start from scratch)
|
|
101
|
+
- [ ] Some documents/articles
|
|
102
|
+
- [ ] Substantial existing KB
|
|
103
|
+
- [ ] Access to APIs/databases with content
|
|
104
|
+
|
|
105
|
+
If yes, describe:
|
|
106
|
+
```
|
|
107
|
+
Resources:
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
---
|
|
111
|
+
|
|
112
|
+
## 4. Application Requirements
|
|
113
|
+
|
|
114
|
+
### Core Features (must have)
|
|
115
|
+
<!-- What MUST this application do? -->
|
|
116
|
+
|
|
117
|
+
```
|
|
118
|
+
1.
|
|
119
|
+
2.
|
|
120
|
+
3.
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
### Nice-to-Have Features
|
|
124
|
+
<!-- What would be good but not essential? -->
|
|
125
|
+
|
|
126
|
+
```
|
|
127
|
+
1.
|
|
128
|
+
2.
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
### User Interface
|
|
132
|
+
<!-- What kind of UI do you need? -->
|
|
133
|
+
|
|
134
|
+
- [ ] Web application (React/Next.js)
|
|
135
|
+
- [ ] API only (headless)
|
|
136
|
+
- [ ] CLI tool
|
|
137
|
+
- [ ] Chatbot interface
|
|
138
|
+
- [ ] Mobile app
|
|
139
|
+
- [ ] Other: _______________
|
|
140
|
+
|
|
141
|
+
### Performance Requirements
|
|
142
|
+
<!-- Any specific speed/scale requirements? -->
|
|
143
|
+
|
|
144
|
+
```
|
|
145
|
+
Response time target:
|
|
146
|
+
Expected users:
|
|
147
|
+
Data volume:
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
---
|
|
151
|
+
|
|
152
|
+
## 5. Technical Constraints
|
|
153
|
+
|
|
154
|
+
### Deployment Target
|
|
155
|
+
|
|
156
|
+
- [ ] Local development only
|
|
157
|
+
- [ ] Docker
|
|
158
|
+
- [ ] Railway
|
|
159
|
+
- [ ] Vercel
|
|
160
|
+
- [ ] AWS/GCP/Azure
|
|
161
|
+
- [ ] Other: _______________
|
|
162
|
+
|
|
163
|
+
### Database
|
|
164
|
+
|
|
165
|
+
- [ ] Use ruvector-postgres (recommended)
|
|
166
|
+
- [ ] Existing PostgreSQL
|
|
167
|
+
- [ ] Other: _______________
|
|
168
|
+
|
|
169
|
+
### Existing Tech Stack
|
|
170
|
+
<!-- What technologies are already in use? -->
|
|
171
|
+
|
|
172
|
+
```
|
|
173
|
+
Languages:
|
|
174
|
+
Frameworks:
|
|
175
|
+
Database:
|
|
176
|
+
Other:
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
---
|
|
180
|
+
|
|
181
|
+
## 6. Quality Requirements
|
|
182
|
+
|
|
183
|
+
### KB Quality Target
|
|
184
|
+
|
|
185
|
+
- [ ] Standard (≥98 score) — Recommended
|
|
186
|
+
- [ ] Higher (≥99 score) — Critical applications
|
|
187
|
+
- [ ] Lower (≥95 score) — MVP/prototype only
|
|
188
|
+
|
|
189
|
+
### Testing Requirements
|
|
190
|
+
|
|
191
|
+
- [ ] Full test suite (unit, integration, e2e)
|
|
192
|
+
- [ ] Basic tests (unit + integration)
|
|
193
|
+
- [ ] Minimal tests (critical paths only)
|
|
194
|
+
|
|
195
|
+
### Compliance Needs
|
|
196
|
+
|
|
197
|
+
- [ ] None
|
|
198
|
+
- [ ] HIPAA
|
|
199
|
+
- [ ] GDPR
|
|
200
|
+
- [ ] SOC2
|
|
201
|
+
- [ ] Other: _______________
|
|
202
|
+
|
|
203
|
+
---
|
|
204
|
+
|
|
205
|
+
## 7. Timeline & Effort
|
|
206
|
+
|
|
207
|
+
### Target Completion
|
|
208
|
+
<!-- When do you need this done? -->
|
|
209
|
+
|
|
210
|
+
```
|
|
211
|
+
Deadline:
|
|
212
|
+
```
|
|
213
|
+
|
|
214
|
+
### Effort Allocation
|
|
215
|
+
|
|
216
|
+
- [ ] Full build (9 phases, 29 sub-phases)
|
|
217
|
+
- [ ] MVP first, then iterate
|
|
218
|
+
- [ ] Phase 2 only (KB creation)
|
|
219
|
+
- [ ] Specific phases: _______________
|
|
220
|
+
|
|
221
|
+
---
|
|
222
|
+
|
|
223
|
+
## 8. Success Criteria
|
|
224
|
+
|
|
225
|
+
### How do you know it's done?
|
|
226
|
+
<!-- What must be true for this project to be successful? -->
|
|
227
|
+
|
|
228
|
+
```
|
|
229
|
+
1.
|
|
230
|
+
2.
|
|
231
|
+
3.
|
|
232
|
+
```
|
|
233
|
+
|
|
234
|
+
### How will you measure success?
|
|
235
|
+
<!-- Metrics, KPIs, user feedback? -->
|
|
236
|
+
|
|
237
|
+
```
|
|
238
|
+
Metrics:
|
|
239
|
+
```
|
|
240
|
+
|
|
241
|
+
---
|
|
242
|
+
|
|
243
|
+
## 9. Additional Context
|
|
244
|
+
|
|
245
|
+
### Any other information Claude should know?
|
|
246
|
+
|
|
247
|
+
```
|
|
248
|
+
Notes:
|
|
249
|
+
```
|
|
250
|
+
|
|
251
|
+
---
|
|
252
|
+
|
|
253
|
+
## Validation
|
|
254
|
+
|
|
255
|
+
Before proceeding, confirm:
|
|
256
|
+
|
|
257
|
+
- [ ] I have filled out all required sections
|
|
258
|
+
- [ ] I have chosen an intelligence pattern (or marked "Unsure")
|
|
259
|
+
- [ ] I have listed at least 5 key topics
|
|
260
|
+
- [ ] I have defined core features
|
|
261
|
+
- [ ] I understand this will take significant effort
|
|
262
|
+
|
|
263
|
+
**Signature:** __________________ **Date:** __________
|
|
264
|
+
|
|
265
|
+
---
|
|
266
|
+
|
|
267
|
+
## For Claude
|
|
268
|
+
|
|
269
|
+
When this file is present in the project root, Claude will:
|
|
270
|
+
|
|
271
|
+
1. Read and parse all sections
|
|
272
|
+
2. Confirm understanding with user
|
|
273
|
+
3. Recommend intelligence pattern if "Unsure" was selected
|
|
274
|
+
4. Proceed to Phase 1 with clear direction
|
|
275
|
+
5. Reference this document throughout all phases
|
|
276
|
+
|
|
277
|
+
**This file replaces the interactive questioning in Phase 0.1 for greenfield projects.**
|