musubi-sdd 0.1.7 → 0.4.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/README.md +115 -0
- package/bin/musubi-onboard.js +670 -0
- package/bin/musubi-sync.js +546 -0
- package/package.json +7 -3
- package/src/templates/agents/claude-code/skills/steering/SKILL.md +443 -2
- package/src/templates/memories/README.md +25 -0
- package/src/templates/memories/architecture_decisions.md +33 -0
- package/src/templates/memories/development_workflow.md +40 -0
- package/src/templates/memories/domain_knowledge.md +30 -0
- package/src/templates/memories/lessons_learned.md +29 -0
- package/src/templates/memories/suggested_commands.md +59 -0
package/README.md
CHANGED
|
@@ -20,6 +20,8 @@ MUSUBI is a comprehensive SDD (Specification Driven Development) framework that
|
|
|
20
20
|
- 📝 **EARS Requirements Format** - Unambiguous requirements with complete traceability
|
|
21
21
|
- 🔄 **Delta Specifications** - Brownfield and greenfield project support
|
|
22
22
|
- 🧭 **Auto-Updating Project Memory** - Steering system maintains architecture, tech stack, and product context
|
|
23
|
+
- 🚀 **Automatic Onboarding** - `musubi-onboard` analyzes existing projects and generates steering docs (2-5 minutes)
|
|
24
|
+
- 🔄 **Auto-Sync** - `musubi-sync` detects codebase changes and keeps steering docs current
|
|
23
25
|
- ✅ **Complete Traceability** - Requirements → Design → Code → Tests mapping
|
|
24
26
|
- 🌐 **Bilingual Documentation** - All agent-generated documents created in both English and Japanese
|
|
25
27
|
|
|
@@ -76,6 +78,14 @@ npx musubi-sdd init --windsurf
|
|
|
76
78
|
# Or install globally
|
|
77
79
|
npm install -g musubi-sdd
|
|
78
80
|
musubi init --claude # or --copilot, --cursor, etc.
|
|
81
|
+
|
|
82
|
+
# Onboard existing project (automatic analysis)
|
|
83
|
+
musubi-onboard
|
|
84
|
+
|
|
85
|
+
# Synchronize steering docs with codebase
|
|
86
|
+
musubi-sync
|
|
87
|
+
musubi-sync --dry-run # Preview changes
|
|
88
|
+
musubi-sync --auto-approve # Auto-apply (CI/CD)
|
|
79
89
|
```
|
|
80
90
|
|
|
81
91
|
### Project Types
|
|
@@ -157,9 +167,17 @@ your-project/
|
|
|
157
167
|
│ ├── commands/ # Slash commands (/sdd-*)
|
|
158
168
|
│ └── CLAUDE.md # Claude Code guide
|
|
159
169
|
├── steering/ # Project memory (all agents)
|
|
170
|
+
│ ├── project.yml # Project configuration (v0.2.1+)
|
|
160
171
|
│ ├── structure.md # Architecture patterns
|
|
161
172
|
│ ├── tech.md # Technology stack
|
|
162
173
|
│ ├── product.md # Product context
|
|
174
|
+
│ ├── memories/ # Persistent knowledge (v0.2.0+)
|
|
175
|
+
│ │ ├── architecture_decisions.md
|
|
176
|
+
│ │ ├── development_workflow.md
|
|
177
|
+
│ │ ├── domain_knowledge.md
|
|
178
|
+
│ │ ├── lessons_learned.md
|
|
179
|
+
│ │ ├── suggested_commands.md
|
|
180
|
+
│ │ └── technical_debt.md
|
|
163
181
|
│ └── rules/
|
|
164
182
|
│ ├── constitution.md # 9 Constitutional Articles
|
|
165
183
|
│ ├── workflow.md # 8-Stage SDD workflow
|
|
@@ -194,6 +212,15 @@ your-project/
|
|
|
194
212
|
│
|
|
195
213
|
├── GEMINI.md (root, for Gemini) # 25 agents integrated into existing file
|
|
196
214
|
├── steering/ # Project memory (same for all)
|
|
215
|
+
│ ├── project.yml # Project configuration (v0.2.1+)
|
|
216
|
+
│ ├── memories/ # Persistent knowledge (v0.2.0+)
|
|
217
|
+
│ │ ├── architecture_decisions.md
|
|
218
|
+
│ │ ├── development_workflow.md
|
|
219
|
+
│ │ ├── domain_knowledge.md
|
|
220
|
+
│ │ ├── lessons_learned.md
|
|
221
|
+
│ │ ├── suggested_commands.md
|
|
222
|
+
│ │ └── technical_debt.md
|
|
223
|
+
│ └── ... (structure.md, tech.md, product.md, rules/)
|
|
197
224
|
├── templates/ # Document templates (same for all)
|
|
198
225
|
└── storage/ # Specs, changes, features (same for all)
|
|
199
226
|
```
|
|
@@ -232,6 +259,94 @@ musubi validate --all # Validate all features
|
|
|
232
259
|
|
|
233
260
|
# Initialize MUSUBI (interactive)
|
|
234
261
|
musubi init
|
|
262
|
+
|
|
263
|
+
# Onboard existing project (v0.3.0+)
|
|
264
|
+
musubi-onboard
|
|
265
|
+
musubi-onboard --auto-approve # Skip confirmation
|
|
266
|
+
musubi-onboard --skip-memories # Skip memory initialization
|
|
267
|
+
|
|
268
|
+
# Synchronize steering docs with codebase (v0.4.0+)
|
|
269
|
+
musubi-sync # Interactive mode
|
|
270
|
+
musubi-sync --dry-run # Preview changes only
|
|
271
|
+
musubi-sync --auto-approve # Auto-apply (CI/CD)
|
|
272
|
+
```
|
|
273
|
+
|
|
274
|
+
#### musubi-onboard
|
|
275
|
+
|
|
276
|
+
Automatically analyzes existing projects and generates steering documentation:
|
|
277
|
+
|
|
278
|
+
```
|
|
279
|
+
🚀 MUSUBI Onboarding Wizard
|
|
280
|
+
|
|
281
|
+
Analyzing your project...
|
|
282
|
+
|
|
283
|
+
✅ Project structure analyzed
|
|
284
|
+
✅ Technology stack detected
|
|
285
|
+
- Node.js, TypeScript, React, Jest
|
|
286
|
+
✅ Steering documents generated
|
|
287
|
+
- steering/structure.md (en + ja)
|
|
288
|
+
- steering/tech.md (en + ja)
|
|
289
|
+
- steering/product.md (en + ja)
|
|
290
|
+
✅ Memories initialized (6 files)
|
|
291
|
+
✅ Project configuration created
|
|
292
|
+
- steering/project.yml
|
|
293
|
+
|
|
294
|
+
⏱️ Onboarding completed in 2.5 minutes
|
|
295
|
+
|
|
296
|
+
💡 Next steps:
|
|
297
|
+
- Review generated steering docs
|
|
298
|
+
- Run: musubi-sync to keep docs current
|
|
299
|
+
- Create requirements: /sdd-requirements [feature]
|
|
300
|
+
```
|
|
301
|
+
|
|
302
|
+
**Features**:
|
|
303
|
+
- Automatic codebase analysis (package.json, directory structure)
|
|
304
|
+
- Technology stack detection (languages, frameworks)
|
|
305
|
+
- Bilingual steering docs generation (English + Japanese)
|
|
306
|
+
- Memory system initialization (6 memory files)
|
|
307
|
+
- Project configuration (project.yml)
|
|
308
|
+
- 96% time reduction (2-4 hours → 2-5 minutes)
|
|
309
|
+
|
|
310
|
+
#### musubi-sync
|
|
311
|
+
|
|
312
|
+
Detects codebase changes and keeps steering documents synchronized:
|
|
313
|
+
|
|
314
|
+
```
|
|
315
|
+
🔄 MUSUBI Steering Sync
|
|
316
|
+
|
|
317
|
+
Detected changes:
|
|
318
|
+
📦 Version: 0.3.0 → 0.4.0
|
|
319
|
+
➕ New framework: js-yaml@4.1.0
|
|
320
|
+
📁 New directory: bin/
|
|
321
|
+
|
|
322
|
+
? Apply these changes? (Y/n) Y
|
|
323
|
+
|
|
324
|
+
✅ Updated steering/project.yml
|
|
325
|
+
✅ Updated steering/tech.md (en + ja)
|
|
326
|
+
✅ Updated steering/structure.md (en + ja)
|
|
327
|
+
✅ Recorded change in memories/architecture_decisions.md
|
|
328
|
+
|
|
329
|
+
🎉 Steering synchronized successfully!
|
|
330
|
+
```
|
|
331
|
+
|
|
332
|
+
**Features**:
|
|
333
|
+
- Change detection (version, languages, frameworks, directories)
|
|
334
|
+
- Interactive mode (default): Show changes, ask confirmation
|
|
335
|
+
- Auto-approve mode (--auto-approve): CI/CD integration
|
|
336
|
+
- Dry-run mode (--dry-run): Preview only
|
|
337
|
+
- Bilingual updates (English + Japanese together)
|
|
338
|
+
- Memory recording (audit trail)
|
|
339
|
+
|
|
340
|
+
**Usage**:
|
|
341
|
+
```bash
|
|
342
|
+
# Interactive (default)
|
|
343
|
+
musubi-sync
|
|
344
|
+
|
|
345
|
+
# Preview changes without applying
|
|
346
|
+
musubi-sync --dry-run
|
|
347
|
+
|
|
348
|
+
# Auto-apply for CI/CD pipelines
|
|
349
|
+
musubi-sync --auto-approve
|
|
235
350
|
```
|
|
236
351
|
|
|
237
352
|
#### musubi status
|