specweave 0.1.4 โ†’ 0.1.6

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 CHANGED
@@ -3,14 +3,18 @@
3
3
  > **Spec-Driven Development Framework** - Where specifications and documentation are the source of truth
4
4
 
5
5
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
6
- [![Version](https://img.shields.io/badge/version-0.1.0--beta.1-blue.svg)](https://github.com/specweave/specweave/releases/tag/v0.1.0-beta.1)
6
+ [![Version](https://img.shields.io/badge/version-0.1.6-blue.svg)](https://github.com/anton-abyzov/specweave/releases/tag/v0.1.6)
7
7
  [![Status](https://img.shields.io/badge/status-beta-blue.svg)]()
8
+ [![Website](https://img.shields.io/badge/website-spec--weave.com-green.svg)](https://spec-weave.com)
8
9
 
9
10
  ---
10
11
 
11
12
  ## Overview
12
13
 
13
- **SpecWeave** is an AI development framework that replaces "vibe coding" with **specification-first development**. Built on the principle that **specifications are the source of truth**, SpecWeave enables building software from solo projects to enterprise systems with confidence, precision, and 70%+ context reduction.
14
+ **SpecWeave** is an AI development framework that replaces "vibe coding" with **specification-first development**. Built on the principle that **specifications are the source of truth**, SpecWeave enables building software from solo projects to enterprise systems with confidence and precision.
15
+
16
+ **๐ŸŒ Website**: [spec-weave.com](https://spec-weave.com)
17
+ **๐Ÿ“ฆ npm**: [npmjs.com/package/specweave](https://www.npmjs.com/package/specweave)
14
18
 
15
19
  ### ๐ŸŽฏ Core Philosophy
16
20
 
@@ -18,16 +22,15 @@
18
22
  2. **Living Documentation** - Specs evolve with code, never diverge
19
23
  3. **Regression Prevention** - Document before modifying existing code
20
24
  4. **Test-Validated Features** - Every feature proven through automated tests
21
- 5. **Context Precision** - Load only relevant specs (70%+ token reduction)
22
- 6. **Auto-Role Routing** - Skills detect and delegate automatically
25
+ 5. **Ready Out of the Box** - All components pre-installed, no setup needed
23
26
 
24
27
  ---
25
28
 
26
29
  ## โœจ Key Features
27
30
 
28
- - ๐Ÿค– **19 Specialized Agents** - PM, Architect, DevOps, QA, Security, Backend, Frontend, and more
29
- - ๐ŸŽฏ **24 AI Skills** - Auto-detection, routing, context loading, orchestration
30
- - ๐Ÿ“Š **Context Manifests** - 70%+ token reduction by loading only relevant specs
31
+ - ๐Ÿค– **10 Specialized Agents** - PM, Architect, DevOps, QA, Security, SRE, Tech Lead, and more (all pre-installed!)
32
+ - ๐ŸŽฏ **35+ AI Skills** - Technology stacks, integrations, utilities (all pre-installed!)
33
+ - ๐Ÿ“ฆ **Pre-Installed Components** - Everything ready immediately after `specweave init`
31
34
  - ๐Ÿงช **4-Level Testing** - Specification โ†’ Feature โ†’ Component โ†’ Automated tests
32
35
  - ๐Ÿ“ **Living Documentation** - Auto-updates via Claude Code hooks
33
36
  - ๐ŸŽจ **Diagram Generation** - C4 Model diagrams (Context, Container, Component)
@@ -87,172 +90,126 @@ specweave init my-saas
87
90
  ### Available Commands
88
91
 
89
92
  ```bash
90
- specweave init [project] # Create new project
91
- specweave list # List all available components
92
- specweave list --installed # Show auto-installed components
93
+ specweave init [project] # Create new project with ALL components
93
94
  specweave --version # Show version
94
95
  specweave --help # Show help
95
96
  ```
96
97
 
97
- **Note**: Components (agents & skills) auto-install on-demand - no manual installation needed!
98
+ **Note**: All 10 agents and 35+ skills are copied to your project during `init` - ready to use immediately!
98
99
 
99
100
  ---
100
101
 
101
102
  ## ๐Ÿš€ Quick Example
102
103
 
103
104
  ```bash
104
- # SpecWeave auto-activates when .specweave/ detected
105
+ # Initialize project - ALL components pre-installed!
106
+ npx specweave init my-app
107
+ cd my-app
108
+
109
+ # Everything ready immediately:
110
+ # โœ… 10 agents in .claude/agents/
111
+ # โœ… 35+ skills in .claude/skills/
112
+ # โœ… 10 slash commands in .claude/commands/
113
+
114
+ # Open Claude Code and start building:
105
115
 
106
116
  User: "Create Next.js authentication with email and OAuth"
107
117
  โ†“
108
118
  SpecWeave: ๐Ÿ”ท SpecWeave Active
109
119
 
110
- ๐Ÿ“ฆ Installing required components...
111
- โœ… Installed nextjs skill
112
- โœ… Installed nodejs-backend skill
113
- โœ… Installed security agent
114
- โœ… Installed pm agent
115
- โœ… Installed architect agent
116
-
117
120
  ๐Ÿš€ Creating increment 0001-user-authentication...
121
+ ๐Ÿ“ Using nextjs skill (already installed!)
122
+ ๐Ÿค– PM agent creating requirements...
123
+ ๐Ÿ—๏ธ Architect agent designing system...
118
124
 
119
125
  โœ… Increment created: .specweave/increments/0001-user-authentication/
120
126
  โœ… Files: spec.md, plan.md, tasks.md, tests.md
121
127
 
122
128
  User: "Create C4 context diagram for authentication"
123
129
  โ†“
124
- SpecWeave: (coordinates diagrams-generator โ†’ diagrams-architect)
130
+ SpecWeave: ๐ŸŽจ Using diagrams-generator skill
131
+ ๐Ÿค– Coordinating with diagrams-architect agent
132
+
125
133
  โœ… Diagram saved: .specweave/docs/internal/architecture/diagrams/auth.c4-context.mmd
126
134
 
127
135
  User: "Implement authentication"
128
136
  โ†“
129
- SpecWeave: (orchestrates PM โ†’ Architect โ†’ Backend โ†’ QA โ†’ Docs)
137
+ SpecWeave: ๐Ÿค– Orchestrating: PM โ†’ Architect โ†’ Backend โ†’ QA โ†’ Docs
138
+
130
139
  โœ… Code: src/auth/
131
140
  โœ… Tests: tests/auth/
132
141
  โœ… Docs: Updated automatically
133
142
  ```
134
143
 
135
144
  **How it works**:
136
- 1. `.specweave/` detected โ†’ `specweave-detector` activates automatically
137
- 2. **User intent analyzed** โ†’ required components auto-installed (just-in-time)
138
- 3. Request parsed โ†’ routed to appropriate skills
145
+ 1. `specweave init` โ†’ ALL components pre-installed (10 agents + 35+ skills)
146
+ 2. `.specweave/` detected โ†’ `specweave-detector` activates automatically
147
+ 3. User request parsed โ†’ routed to appropriate pre-installed skills
139
148
  4. Skills coordinate agents โ†’ artifacts generated
140
- 5. Context loaded precisely โ†’ only relevant specs (70%+ reduction)
149
+ 5. All components ready - no waiting, no installation
141
150
 
142
151
  ---
143
152
 
144
- ## ๐Ÿค– Agents (19 Total)
145
-
146
- SpecWeave includes **19 specialized AI agents** that provide domain expertise:
147
-
148
- ### Strategic Layer
149
- | Agent | Role | Status |
150
- |-------|------|--------|
151
- | **pm** | Product Manager - requirements, user stories, roadmap | โœ… Implemented |
152
- | **architect** | System Architect - design, ADRs, technology decisions | โœ… Implemented |
153
- | **tech-lead** | Technical Lead - code review, best practices | โœ… Implemented |
154
-
155
- ### Implementation Layer
156
- | Agent | Role | Status |
157
- |-------|------|--------|
158
- | **nodejs-backend** | Node.js/TypeScript backend development | โœ… Implemented |
159
- | **python-backend** | Python/FastAPI backend development | โœ… Implemented |
160
- | **dotnet-backend** | C#/.NET/ASP.NET Core development | โœ… Implemented |
161
- | **frontend** | React/Vue frontend development | โœ… Implemented |
162
- | **nextjs** | Next.js App Router specialist | โœ… Implemented |
163
-
164
- ### Quality & Operations
165
- | Agent | Role | Status |
166
- |-------|------|--------|
167
- | **qa-lead** | QA Lead - test strategy, test cases, quality gates | โœ… Implemented |
168
- | **security** | Security Engineer - threat modeling, OWASP, compliance | โœ… Implemented |
169
- | **devops** | DevOps - CI/CD, infrastructure, deployment | โœ… Implemented |
170
- | **sre** | SRE - monitoring, incidents, reliability | โœ… Implemented |
171
- | **performance** | Performance Engineer - profiling, optimization | โœ… Implemented |
172
-
173
- ### Documentation & Design
174
- | Agent | Role | Status |
175
- |-------|------|--------|
176
- | **docs-writer** | Technical Writer - API docs, guides, tutorials | โœ… Implemented |
177
- | **diagrams-architect** | Diagram generation - C4 Model, Mermaid, architecture | โœ… Implemented |
178
- | **figma-designer** | Figma designer - design systems, UI/UX | โœ… Implemented |
179
- | **figma-implementer** | Figma to code - React/Angular components | โœ… Implemented |
180
-
181
- ### Integration
182
- | Agent | Role | Status |
183
- |-------|------|--------|
184
- | **specweave-jira-mapper** | JIRA โ†” SpecWeave bidirectional sync | โœ… Implemented |
185
- | **specweave-ado-mapper** | Azure DevOps โ†” SpecWeave bidirectional sync | โœ… Implemented |
186
-
187
- **All agents** have AGENT.md with YAML frontmatter and 3+ test cases.
153
+ ## ๐Ÿค– Agents (10 Total - All Pre-Installed!)
154
+
155
+ SpecWeave includes **10 specialized AI agents** that activate automatically based on your request:
156
+
157
+ | Agent | Role | When It Activates |
158
+ |-------|------|-------------------|
159
+ | **pm** | Product Manager - requirements, user stories | Planning features, creating increments |
160
+ | **architect** | System Architect - design, ADRs, decisions | Technical design, architecture |
161
+ | **security** | Security Engineer - threat modeling, OWASP | Security review, vulnerability assessment |
162
+ | **qa-lead** | QA Lead - test strategy, quality gates | Testing, quality assurance |
163
+ | **devops** | DevOps Engineer - CI/CD, infrastructure | Deployment, infrastructure needs |
164
+ | **tech-lead** | Technical Lead - code review, best practices | Code review, refactoring |
165
+ | **sre** | SRE - incident response, monitoring | Production incidents, troubleshooting |
166
+ | **docs-writer** | Technical Writer - documentation | Writing docs, API documentation |
167
+ | **performance** | Performance Engineer - optimization | Performance issues, profiling |
168
+ | **diagrams-architect** | Diagram Expert - C4 Model, Mermaid | Creating diagrams (via diagrams-generator skill) |
169
+
170
+ **All agents pre-installed** in `.claude/agents/` after `specweave init` - ready to use immediately!
188
171
 
189
172
  ---
190
173
 
191
- ## ๐ŸŽฏ Skills (24 Total)
192
-
193
- SpecWeave includes **24 AI skills** that coordinate agents and provide specialized capabilities:
194
-
195
- ### Core Orchestration
196
- | Skill | Purpose | Status |
197
- |-------|---------|--------|
198
- | **specweave-detector** | Auto-detect SpecWeave projects (proactive entry point) | โœ… Implemented |
199
- | **skill-router** | Route requests to appropriate skills/agents (>90% accuracy) | โœ… Implemented |
200
- | **context-loader** | Load specs selectively (70%+ token reduction) | โœ… Implemented |
201
- | **role-orchestrator** | Multi-agent coordinator (factory of agents) | โœ… Implemented |
202
-
203
- ### Feature Planning
204
- | Skill | Purpose | Status |
205
- |-------|---------|--------|
206
- | **increment-planner** | Plan features with context awareness | โœ… Implemented |
207
- | **task-builder** | Break features into executable tasks | โœ… Implemented |
208
- | **docs-updater** | Auto-update documentation via hooks | โœ… Implemented |
209
-
210
- ### Brownfield Tools
211
- | Skill | Purpose | Status |
212
- |-------|---------|--------|
213
- | **brownfield-analyzer** | Analyze existing codebases | โœ… Implemented |
214
- | **brownfield-onboarder** | Merge existing CLAUDE.md intelligently | โœ… Implemented |
215
-
216
- ### Integration
217
- | Skill | Purpose | Status |
218
- |-------|---------|--------|
219
- | **jira-sync** | Sync with JIRA (coordinates with specweave-jira-mapper) | โœ… Implemented |
220
- | **ado-sync** | Sync with Azure DevOps (coordinates with specweave-ado-mapper) | โœ… Implemented |
221
- | **github-sync** | Sync with GitHub issues | โœ… Implemented |
222
-
223
- ### Infrastructure
224
- | Skill | Purpose | Status |
225
- |-------|---------|--------|
226
- | **hetzner-provisioner** | Provision Hetzner Cloud infrastructure | โœ… Implemented |
227
- | **cost-optimizer** | Optimize cloud infrastructure costs | โœ… Implemented |
228
-
229
- ### Diagram & Design
230
- | Skill | Purpose | Status |
231
- |-------|---------|--------|
232
- | **diagrams-generator** | Generate C4 diagrams (coordinates with diagrams-architect) | โœ… Implemented |
233
- | **design-system-architect** | Design system creation (Atomic Design) | โœ… Implemented |
234
- | **figma-mcp-connector** | Connect to Figma MCP servers | โœ… Implemented |
235
- | **figma-to-code** | Convert Figma designs to code | โœ… Implemented |
236
-
237
- ### Product Features
238
- | Skill | Purpose | Status |
239
- |-------|---------|--------|
240
- | **calendar-system** | Calendar and scheduling features | โœ… Implemented |
241
- | **notification-system** | Email, push, SMS, in-app notifications | โœ… Implemented |
242
- | **stripe-integrator** | Stripe payment integration | โœ… Implemented |
243
-
244
- ### Framework Comparison
245
- | Skill | Purpose | Status |
246
- |-------|---------|--------|
247
- | **bmad-method-expert** | BMAD-METHOD comparison and gap analysis | โœ… Implemented |
248
- | **spec-kit-expert** | spec-kit comparison and gap analysis | โœ… Implemented |
249
-
250
- ### Meta
251
- | Skill | Purpose | Status |
252
- |-------|---------|--------|
253
- | **skill-creator** | Guide for creating new skills | โœ… Implemented |
254
-
255
- **All skills** have SKILL.md with YAML frontmatter and 3+ test cases.
174
+ ## ๐ŸŽฏ Skills (35+ Total - All Pre-Installed!)
175
+
176
+ SpecWeave includes **35+ AI skills** that activate automatically based on your request:
177
+
178
+ ### Core Framework Skills
179
+ - **specweave-detector** - Auto-detect SpecWeave projects
180
+ - **increment-planner** - Plan features and create specifications
181
+ - **skill-router** - Route requests to appropriate skills
182
+ - **context-loader** - Load relevant specifications
183
+ - **role-orchestrator** - Coordinate multiple agents
184
+
185
+ ### Technology Stack Skills
186
+ - **nextjs** - Next.js App Router, Server Components
187
+ - **nodejs-backend** - Node.js, Express, NestJS APIs
188
+ - **python-backend** - FastAPI, Django APIs
189
+ - **dotnet-backend** - ASP.NET Core APIs
190
+ - **frontend** - React, Vue, Angular components
191
+
192
+ ### Integration Skills
193
+ - **jira-sync** - Sync with JIRA issues
194
+ - **ado-sync** - Sync with Azure DevOps
195
+ - **github-sync** - Sync with GitHub issues
196
+
197
+ ### Design & Diagram Skills
198
+ - **diagrams-generator** - Generate C4 diagrams
199
+ - **figma-designer** - Create Figma designs
200
+ - **figma-implementer** - Convert Figma to code
201
+
202
+ ### Infrastructure Skills
203
+ - **hetzner-provisioner** - Deploy to Hetzner Cloud
204
+ - **cost-optimizer** - Optimize cloud costs
205
+
206
+ ### Brownfield Skills
207
+ - **brownfield-analyzer** - Analyze existing codebases
208
+ - **brownfield-onboarder** - Merge existing documentation
209
+
210
+ **And many more!** All skills pre-installed in `.claude/skills/` after `specweave init`.
211
+
212
+ **See**: [Complete skill list](https://spec-weave.com/docs/skills) on spec-weave.com
256
213
 
257
214
  ---
258
215
 
@@ -299,11 +256,10 @@ specweave/
299
256
  โ”‚ โ”œโ”€โ”€ hooks/ # Claude Code hooks
300
257
  โ”‚ โ””โ”€โ”€ templates/ # Project templates
301
258
  โ”‚
302
- โ”œโ”€โ”€ .claude/ # Installed components (gitignored)
303
- โ”‚ โ”œโ”€โ”€ agents/ # Installed from src/agents/
304
- โ”‚ โ”œโ”€โ”€ skills/ # Installed from src/skills/
305
- โ”‚ โ”œโ”€โ”€ commands/ # Installed from src/commands/
306
- โ”‚ โ””โ”€โ”€ hooks/ # Symlinks to src/hooks/
259
+ โ”œโ”€โ”€ .claude/ # Pre-installed components (user projects)
260
+ โ”‚ โ”œโ”€โ”€ agents/ # 10 agents (copied during init)
261
+ โ”‚ โ”œโ”€โ”€ skills/ # 35+ skills (copied during init)
262
+ โ”‚ โ””โ”€โ”€ commands/ # 10 slash commands (copied during init)
307
263
  โ”‚
308
264
  โ”œโ”€โ”€ tests/ # Framework tests
309
265
  โ”‚ โ”œโ”€โ”€ unit/
@@ -390,38 +346,6 @@ SpecWeave implements **4 Levels of Testing**:
390
346
 
391
347
  ---
392
348
 
393
- ## ๐Ÿ“Š Context Precision (70%+ Reduction)
394
-
395
- SpecWeave uses **context manifests** to load only relevant specifications:
396
-
397
- **Without context manifests** (traditional):
398
- - Load entire spec/ folder
399
- - 100,000+ tokens
400
- - Slow, expensive, context pollution
401
-
402
- **With context manifests** (SpecWeave):
403
- - Load only relevant sections
404
- - 10,000-30,000 tokens
405
- - **70%+ reduction**
406
- - Fast, efficient, focused
407
-
408
- **Example**:
409
- ```yaml
410
- # .specweave/increments/0001-auth/context-manifest.yaml
411
- spec_sections:
412
- - .specweave/docs/internal/strategy/auth/authentication-spec.md
413
- - .specweave/docs/internal/strategy/auth/authorization-spec.md
414
-
415
- documentation:
416
- - .specweave/docs/internal/architecture/auth-hld.md
417
- - CLAUDE.md#authentication
418
-
419
- max_context_tokens: 10000
420
- ```
421
-
422
- **See [CLAUDE.md#context-precision](CLAUDE.md#scalable-directory-structure)** for details.
423
-
424
- ---
425
349
 
426
350
  ## ๐ŸŽจ Diagram Generation
427
351
 
@@ -502,24 +426,22 @@ sync:
502
426
 
503
427
  ## ๐Ÿ“š Documentation
504
428
 
505
- - **[CLAUDE.md](CLAUDE.md)** - **START HERE** - Complete development guide (source of truth)
506
- - **[INSTALLATION.md](INSTALLATION.md)** - Detailed installation instructions
507
- - **[.specweave/docs/README.md](.specweave/docs/README.md)** - Documentation structure
508
- - **[Diagram Conventions](.specweave/docs/internal/delivery/guides/diagram-conventions.md)** - C4 Model conventions
509
- - **[Tool Concept Mapping](.specweave/docs/internal/delivery/guides/tool-concept-mapping.md)** - Tool mappings
510
- - **[.specweave/increments/README.md](.specweave/increments/README.md)** - Increments guide
429
+ - **[spec-weave.com](https://spec-weave.com)** - **START HERE** - Complete documentation website
430
+ - **[npm Package](https://www.npmjs.com/package/specweave)** - Installation and quick start
431
+ - **[GitHub](https://github.com/anton-abyzov/specweave)** - Source code and examples
432
+ - **[CLAUDE.md](CLAUDE.md)** - Complete development guide (created after `specweave init`)
511
433
 
512
434
  ---
513
435
 
514
436
  ## ๐Ÿค Contributing
515
437
 
516
- We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
438
+ We welcome contributions!
517
439
 
518
440
  ### Development Setup
519
441
 
520
442
  ```bash
521
443
  # Clone repository
522
- git clone https://github.com/specweave/specweave.git
444
+ git clone https://github.com/anton-abyzov/specweave.git
523
445
  cd specweave
524
446
 
525
447
  # Install dependencies
@@ -528,19 +450,14 @@ npm install
528
450
  # Build TypeScript
529
451
  npm run build
530
452
 
531
- # Install components
532
- npm run install:all
533
-
534
453
  # Run tests
535
454
  npm test
536
-
537
- # Restart Claude Code
538
455
  ```
539
456
 
540
457
  **To contribute**:
541
458
  1. Fork repository
542
- 2. Create feature branch: `git checkout -b features/001-new-feature`
543
- 3. Follow [CLAUDE.md](CLAUDE.md) conventions
459
+ 2. Create feature branch: `git checkout -b features/002-new-feature`
460
+ 3. Follow SpecWeave conventions (see CLAUDE.md after init)
544
461
  4. Add 3+ test cases (MANDATORY)
545
462
  5. Create PR to `develop` branch
546
463
 
@@ -548,75 +465,72 @@ npm test
548
465
 
549
466
  ## ๐Ÿท๏ธ Project Status
550
467
 
551
- **Version**: 0.1.0-beta.1
468
+ **Version**: 0.1.6
552
469
  **Status**: Public Beta
553
470
  **License**: MIT
554
- **Release Date**: 2025-10-27
471
+ **Release Date**: 2025-10-28
472
+ **Website**: [spec-weave.com](https://spec-weave.com)
555
473
 
556
- ### โœ… What Works (v0.1.0-beta.1)
474
+ ### โœ… What Works (v0.1.6)
557
475
 
558
- - โœ… **19 Agents** fully implemented with test cases
559
- - โœ… **24 Skills** fully implemented with test cases
560
- - โœ… **CLI Tool** - `specweave` command (`init`, `install`, `list`)
561
- - โœ… **Auto-detection** and intelligent routing (>90% accuracy)
562
- - โœ… **Context manifests** (70%+ token reduction)
476
+ - โœ… **10 Agents** fully implemented and pre-installed
477
+ - โœ… **35+ Skills** fully implemented and pre-installed
478
+ - โœ… **CLI Tool** - `specweave init` with complete component copying
479
+ - โœ… **Ready Out of the Box** - All components installed during init
480
+ - โœ… **Auto-detection** and intelligent routing (fixed in 0.1.6!)
563
481
  - โœ… **Diagram generation** (C4 Model with validation)
564
- - โœ… **Install scripts** (selective installation based on tech stack)
565
482
  - โœ… **4-level testing framework** (spec โ†’ feature โ†’ component โ†’ automated)
566
- - โœ… **JIRA/ADO/GitHub sync** agents
483
+ - โœ… **JIRA/ADO/GitHub sync** integration
567
484
  - โœ… **Brownfield analyzer** (retroactive specs, regression prevention)
568
485
  - โœ… **Increment lifecycle** (5 stages, WIP limits, leftover transfer)
569
486
  - โœ… **Increment validation** (120 rules, auto-validation on save)
570
487
  - โœ… **Hooks system** (auto-update docs, validations)
571
- - โœ… **Documentation** (CHANGELOG.md, INSTALL.md, comprehensive guides)
572
-
573
- ### โณ In Progress (v0.1.0-beta.2)
574
-
575
- - โณ NPM package publishing (beta.1 installable via GitHub only)
576
- - โณ Additional CLI commands (`audit`, `cleanup`)
577
- - โณ More project templates (currently: saas, api, fullstack)
578
- - โณ GitHub Actions CI/CD integration
579
- - โณ MkDocs documentation site deployment
488
+ - โœ… **Living Documentation** - Auto-updated via Claude Code hooks
489
+ - โœ… **npm Package** - Published and ready to use
580
490
 
581
491
  ### ๐Ÿ“… Planned (v0.2.0+)
582
492
 
583
- - ๐Ÿ“… Quality gates (inspired by BMAD `@qa *gate`)
584
- - ๐Ÿ“… Risk scoring (inspired by BMAD `@qa *risk`)
585
- - ๐Ÿ“… Clarification workflow (inspired by spec-kit `/speckit.clarify`)
586
- - ๐Ÿ“… Dependency tracking in tasks (inspired by spec-kit)
587
- - ๐Ÿ“… Agent-agnostic support (Copilot, Cursor, Gemini, etc.)
493
+ - ๐Ÿ“… Quality gates and risk scoring
588
494
  - ๐Ÿ“… Web UI for planning phase
589
495
  - ๐Ÿ“… VS Code extension
590
496
  - ๐Ÿ“… Homebrew formula
591
- - ๐Ÿ“… Test importer (import existing tests)
497
+ - ๐Ÿ“… Additional project templates
592
498
 
593
499
  ---
594
500
 
595
- ## ๐Ÿ“– Example Projects
501
+ ## ๐Ÿ“– Quick Start
596
502
 
597
- ### SaaS Application
503
+ ### Initialize New Project
598
504
 
599
505
  ```bash
600
- git clone https://github.com/specweave/specweave.git my-saas
506
+ # Create new project (all components pre-installed!)
507
+ npx specweave init my-saas
601
508
  cd my-saas
602
- npm install && npm run install:all
603
509
 
604
- # Create features
605
- /create-increment "user authentication"
606
- /create-increment "subscription billing"
607
- /create-increment "admin dashboard"
510
+ # Everything ready:
511
+ # โœ… 10 agents in .claude/agents/
512
+ # โœ… 35+ skills in .claude/skills/
513
+ # โœ… 10 slash commands in .claude/commands/
608
514
 
609
- # Implement
610
- "Implement all increments"
515
+ # Open Claude Code and start building:
516
+ # "Create user authentication with JWT"
517
+ # "Add subscription billing with Stripe"
518
+ # "Build admin dashboard with analytics"
611
519
  ```
612
520
 
613
- ### API Service
521
+ ### For Existing Projects
614
522
 
615
523
  ```bash
616
- # Similar setup, different increments
617
- /create-increment "REST API with OpenAPI"
618
- /create-increment "GraphQL endpoint"
619
- /create-increment "WebSocket real-time features"
524
+ # Add SpecWeave to existing project
525
+ cd my-existing-project
526
+ npx specweave init .
527
+
528
+ # Analyze existing code
529
+ # "Analyze my authentication module"
530
+ # SpecWeave creates retroactive specifications
531
+
532
+ # Safe to modify
533
+ # "Add OAuth to authentication"
620
534
  ```
621
535
 
622
536
  ---
@@ -630,7 +544,7 @@ npm install && npm run install:all
630
544
  | **Documentation** | Outdated, ignored | Living, auto-updated |
631
545
  | **Specifications** | Optional, vague | Source of truth, precise |
632
546
  | **Testing** | Manual, incomplete | 4-level, validated |
633
- | **Context** | Full codebase loaded | 70%+ reduction |
547
+ | **Components** | Manual setup | Pre-installed (10 agents + 35+ skills) |
634
548
  | **Regression** | Frequent breaks | Prevention-first |
635
549
  | **Onboarding** | Weeks | Hours (specs explain everything) |
636
550
  | **Brownfield** | Risky | Safe (document first) |
@@ -638,29 +552,34 @@ npm install && npm run install:all
638
552
  ### vs Other Frameworks
639
553
 
640
554
  **vs spec-kit** (GitHub):
641
- - โœ… SpecWeave: Auto-role routing, context precision
642
- - โœ… SpecWeave: Living documentation via hooks
643
- - โœ… SpecWeave: Brownfield analysis
644
- - โœ… SpecWeave: 19 agents + 24 skills
555
+ - โœ… SpecWeave: **Pre-installed agents** (10) and skills (35+) - spec-kit requires manual setup
556
+ - โœ… SpecWeave: **Living documentation** via Claude Code hooks - auto-updates on changes
557
+ - โœ… SpecWeave: **Brownfield analysis** - retroactive spec generation for existing code
558
+ - โœ… SpecWeave: **Tool integration** - JIRA, ADO, GitHub bidirectional sync
645
559
 
646
560
  **vs BMAD-METHOD**:
647
- - โœ… SpecWeave: Context manifests (70%+ reduction)
648
- - โœ… SpecWeave: 5-pillar documentation
649
- - โœ… SpecWeave: Tool integration (JIRA/ADO/GitHub)
650
- - โœ… SpecWeave: Diagram generation
561
+ - โœ… SpecWeave: **5-pillar documentation** - strategy, architecture, delivery, operations, governance
562
+ - โœ… SpecWeave: **Pre-installed components** - 10 agents + 35+ skills ready immediately
563
+ - โœ… SpecWeave: **Framework agnostic** - TypeScript, Python, Go, Rust, Java, C#
564
+ - โœ… SpecWeave: **Diagram generation** - C4 Model diagrams with validation
565
+ - โœ… SpecWeave: **Tool integration** - JIRA/ADO/GitHub sync built-in
566
+
567
+ **Both frameworks**:
568
+ - โœ… Specification-first development
569
+ - โœ… Automated testing
570
+ - โœ… Quality gates and validation
651
571
 
652
- **See skills**:
653
- - `bmad-method-expert` - Dynamic gap analysis vs BMAD
654
- - `spec-kit-expert` - Dynamic gap analysis vs spec-kit
572
+ **Learn more**: See `bmad-method-expert` and `spec-kit-expert` skills for detailed comparisons
655
573
 
656
574
  ---
657
575
 
658
576
  ## ๐Ÿ“ž Support & Community
659
577
 
660
- - **GitHub**: [github.com/specweave/specweave](https://github.com/specweave/specweave)
661
- - **Issues**: [github.com/specweave/specweave/issues](https://github.com/specweave/specweave/issues)
662
- - **Discussions**: [github.com/specweave/specweave/discussions](https://github.com/specweave/specweave/discussions)
663
- - **Documentation**: [CLAUDE.md](CLAUDE.md)
578
+ - **Website**: [spec-weave.com](https://spec-weave.com)
579
+ - **npm Package**: [npmjs.com/package/specweave](https://www.npmjs.com/package/specweave)
580
+ - **GitHub**: [github.com/anton-abyzov/specweave](https://github.com/anton-abyzov/specweave)
581
+ - **Issues**: [github.com/anton-abyzov/specweave/issues](https://github.com/anton-abyzov/specweave/issues)
582
+ - **Documentation**: See [CLAUDE.md](CLAUDE.md) after running `specweave init`
664
583
 
665
584
  ---
666
585
 
@@ -682,4 +601,4 @@ SpecWeave is inspired by and learns from:
682
601
 
683
602
  **SpecWeave** - Replace vibe coding with spec-driven development.
684
603
 
685
- **Get started**: See [INSTALLATION.md](INSTALLATION.md) | [CLAUDE.md](CLAUDE.md)
604
+ **Get started**: [spec-weave.com](https://spec-weave.com) | [npm install](https://www.npmjs.com/package/specweave) | [GitHub](https://github.com/anton-abyzov/specweave)
package/SPECWEAVE.md CHANGED
@@ -179,21 +179,23 @@ npx specweave list --installed # See what's installed
179
179
 
180
180
  ## Quick Reference: Slash Commands
181
181
 
182
- | Command | Purpose | Example |
183
- |---------|---------|---------|
184
- | `/create-project` | Bootstrap new SpecWeave project | `/create-project --type python` |
185
- | `/create-increment` | Create new feature/increment | `/create-increment "user auth"` |
186
- | `/start-increment` | Start working on an increment | `/start-increment 0001` |
187
- | `/add-tasks` | Add tasks to existing increment | `/add-tasks 0001 "implement login"` |
188
- | `/validate-increment` | Validate with rule-based + optional AI quality | `/validate-increment 0001 --quality` |
189
- | `/close-increment` | Close increment with leftover transfer | `/close-increment 0001` |
190
- | `/list-increments` | List all increments with status | `/list-increments` |
191
- | `/review-docs` | Review strategic docs vs code | `/review-docs --increment=0003` |
192
- | `/generate-docs` | Generate documentation site | `/generate-docs` |
193
- | `/sync-github` | Sync increment to GitHub issues | `/sync-github` |
182
+ | Command | Alias | Purpose | Example |
183
+ |---------|-------|---------|---------|
184
+ | `/create-project` | `/init` | Bootstrap new SpecWeave project | `/init my-saas --type python` |
185
+ | `/create-increment` | `/ci` | Create new feature/increment | `/ci "user authentication"` |
186
+ | `/start-increment` | `/si` | Start working on an increment | `/si 0001` |
187
+ | `/add-tasks` | `/at` | Add tasks to existing increment | `/at 0001 "implement login"` |
188
+ | `/validate-increment` | `/vi` | Validate with rule-based + optional AI quality | `/vi 0001 --quality` |
189
+ | `/close-increment` | `/done` | Close increment with leftover transfer | `/done 0001` |
190
+ | `/list-increments` | `/ls` | List all increments with status | `/ls --status=in-progress` |
191
+ | `/review-docs` | - | Review strategic docs vs code | `/review-docs --increment=0003` |
192
+ | `/generate-docs` | - | Generate documentation site | `/generate-docs` |
193
+ | `/sync-github` | - | Sync increment to GitHub issues | `/sync-github` |
194
194
 
195
195
  **All commands are framework-agnostic** (adapt to detected tech stack)
196
196
 
197
+ **๐Ÿ’ก Pro Tip**: Use short aliases (`/ci`, `/vi`, `/si`, `/done`, `/ls`, `/at`, `/init`) for speed during active development!
198
+
197
199
  **See**: [Command Reference](.claude/commands/) for all available commands
198
200
 
199
201
  ---
@@ -1 +1 @@
1
- {"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/init.ts"],"names":[],"mappings":"AAOA,UAAU,WAAW;IACnB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,wBAAsB,WAAW,CAC/B,WAAW,CAAC,EAAE,MAAM,EACpB,OAAO,GAAE,WAAkC,GAC1C,OAAO,CAAC,IAAI,CAAC,CAyFf"}
1
+ {"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/init.ts"],"names":[],"mappings":"AAOA,UAAU,WAAW;IACnB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,wBAAsB,WAAW,CAC/B,WAAW,CAAC,EAAE,MAAM,EACpB,OAAO,GAAE,WAAkC,GAC1C,OAAO,CAAC,IAAI,CAAC,CAgGf"}